Skip to main content

Papertrail Guide

Learn to use Papertrail

Updated this week

Summary

We are using Papertrail as logging system. Here is the user guide to main functionality of the system and description of our custom messages.

List of steps:

  1. After registration

  2. Check logs

  3. Search logs

  4. Status messagesKonec stránky

After registration

  1. To setup your account for the first time after registration, login into Papertrail.

  2. Set the local time zone for your account. Go to Settings → Profile → Timezone.

3. Be sure that you are logged into company account, not your personal one. This can be changed in the top right corner.

Check logs

The first page you will see is Dashboard. We are currently gathering information from single server which will be displayed there. To see logs from all systems go to the tab Events.

Logs are gathered for the last 24 hours, information received before might not be displayed.

You will see screen as shown above. We recommend to hide System and Program for better visibility in local Events settings. Each line in events is separate message from the sensors came through one of hubs connected to your account.

Note! Written message to the log system doesn't mean that the data is stored in our database. It will be stored only if device is deployed in the building (exists on the map).

The format of the line is as follows:

hub - serial number of the hub through which device sent the data

sn - serial number of the device, unique number written on the casing

id - internal identification number for our system

tenant - name of the building id to which hub is connected

Other identificators inside the message are optional for different types of sensors:

  • temp - temperature detected by the device in degrees Celsius

  • hum - relative humidity detected by the device in percent

  • co2 - calibrated CO2 value detected by the device in ppm

  • batt - battery voltage

  • rssi - signal strength between sensor and specified hub

  • opened - boolean value if the casing was opened

  • moved - boolean value with different meaning for different device types. For the different occupancy sensors it means that the person or object was detected. For the environmental sensors it means that the device detected movement.

  • falldown - boolean value if device detected falling from the wall

  • counter - incrementing value on sending message from device

Search logs

Papertrail has some tools for the event searching. It can be quite powerful and useful tool. For example you can:

1. Search for the specific device by serial number (e.g. SC20L2V100N0000666)

2. Search for data from all Environmental sensors (e.g. type:04)

3. Search for all data from Occupancy Chair sensors came through hub SHU0L1V100N0150 (e.g. type:02 AND SHU0L1V100N0150)

4. Search for all data from Location or Environmental sensors (e.g. type:01 OR type:04)

Status messages

On starting the device during deployment you will see status message from the device if it is in range of the hub. Here is the example of this message

Device sn:SCH1L2V100N0002535 id:5149013362493675 started. ver:1.2.7, SPI: OK, I2C: OK, UART1: OK, UART2: OK. tenant: None

You can see following fields:

  • sn - serial number of the device

  • id - id of the device

  • ver - firmware version of the device

  • SPI, I2C, UART1, UART2 - communication status with peripherals, should be OK

  • tenant - tenant to which device is deployed. None means device is not deployed to any of the tenant. ERROR means device is not in the database

Did this answer your question?