Device type API Label: snifferv2.0
Raw Data Variables
These are the variables sent directly by the device.
Variable NameAPI Label | Unit | Description |
|---|---|---|
AMBIENT_TEMPERATUREambient_temperature | °C | The ambient temperature measured by the device during every leak update and heartbeat message. The temperature is measured with a resolution of 0.01 °C. |
AMBIENT_TEMPERATURE_FAHRENHEITambient_temperature_fahrenheit | °F | The ambient temperature measured by the device during every leak update and heartbeat message. The temperature is measured with a resolution of 0.018 °F. |
BATTERY_PERCENTAGEbattery_percentage | % | Latest averaged battery percentage level of the device. |
BATTERY_VOLTAGEbattery_voltage | mV | Latest averaged battery level of the device. |
FIRMWARE_VERSIONfirmware_version | — | The current firmware version of the device. |
FRAME_COUNTframe_count | — | This is the number of messages transmitted by the device. This counter will reset when the device is reset. |
HIGH_HUMIDITY_ALERT_BIThigh_humidity_alert_bit | — | Indicates if the device measured humidity in excess of 80 %rH (1) or if the humidity is normal (0). |
HIGH_TEMPERATURE_ALERT_BIThigh_temperature_alert_bit | — | Indicates if the device measured temperature in excess of 35 °C / 95 °F (1) or if the temperature is normal (0). |
HUMIDITYhumidity | %rH | The humidity measured by the device during every leak update and heartbeat message. The humidity is measured with a resolution of 0.01 %rH. |
LIQUID_DETECTED_BITliquid_detected_bit | — | Indicates if the device detected liquid (1) or not (0), which can be a potential indication of a leak. |
MEASURED_VALUEmeasured_value | mV | The sensor's voltage measured by the device. |
PRESSUREpressure | hPa | The barometric pressure measured by the device during every heartbeat message. The pressure is measured with a resolution of 0.1 kPa. |
RSSIrssi | dBm | How good the signal power (radio signal) is from the device to the closest gateway. |
SENSOR_DETECTED_BITsensor_detected_bit | — | Indicates if a sensor is connected to the device (1) or not (0) as at the last message received from the device. |
SENSOR_DISCONNECTED_BITsensor_disconnected_bit | — | Indicates if the device's sensor was disconnected (1) or not (0) since the last transmission from the device. |
SNRsnr | dBm | Signal-to-noise ratio — used to determine signal quality from the device to the closest gateway. |
SPREADING_FACTORspreading_factor | — | The spreading factor is determined by the device's proximity to the gateway since ADR (adaptive data rate) is implemented on the device. A lower spreading factor means lower transmit power is used and it is more battery efficient. |
STATUSstatus | — | Indicates the health status of the device as healthy (0) or device has reset unexpectedly (-1). The variable's context will contain further information regarding the device's reset status. |
TAMPER_ALERT_BITtamper_alert_bit | — | Indicates if the device detected that it was tampered with (1) or not (0). |
Derived and Environmental Variables
Computed variables derived from raw sensor data.
Variable NameAPI Label | Unit | Description |
|---|---|---|
CALIBRATED_MOISTURE_VALUEcalibrated_moisture_value | mV | The voltage threshold used to determine if liquid was detected. Calibration takes place on boot, when a sensor gets connected, and at every heartbeat. Calibration is based on the sensor type. |
ELEVATIONelevation | m | Elevation of the device based on the ambient temperature and the pressure measured by the device. |
Internal Configuration and Device Management Variables
Variables used for device configuration, status monitoring, and remote management.
Variable NameAPI Label | Unit | Description |
|---|---|---|
BATTERY_INDICATION_BITbattery_indication_bit | — | Indicates the state of the battery as good (2), average (1) or bad (0) based on the battery voltage. |
DEVICE_ALERTdevice_alert | — | Indicates that the device requires attention. |
DEVICE_MISSED_UPDATE_BITdevice_missed_update_bit | — | Indicates if the device has missed an update. If the device hasn't sent a heartbeat message in the past 24 hours, this variable will be set to 1. |
DEVICE_OFFLINE_BITdevice_offline_bit | — | Indicates if the device is offline. Set to 1 if the device hasn't sent a heartbeat in the past 24 hours and DEVICE_MISSED_UPDATE_BIT is already set. |
GET_BLE_ENABLEget_ble_enable | — | Indicates if the device's Bluetooth is enabled (1) or disabled (0). Updated after a configuration change. |
GET_FLOOD_SENSOR_MOISTURE_CALIBRATION_PERCENTAGEget_flood_sensor_moisture_calibration_percentage | % | The percentage used to determine the Calibrated Moisture Value for the flood sensor during calibration. Updated after a configuration change. |
GET_FLOOD_SENSOR_VOLTAGE_VALUEget_flood_sensor_voltage_value | mV | The voltage level used to determine if the connected sensor is a flood sensor. Updated after a configuration change. |
GET_HEARTBEAT_INTERVAL_INDEXget_heartbeat_interval_index | — | The cloud update interval between heartbeat messages: 6 hours (0), 12 hours (1), 24 hours default (2), or 48 hours (3). Updated after a configuration change. |
GET_HIGH_HUMIDITY_ALERT_ENABLEget_high_humidity_alert_enable | — | Indicates if high humidity alerts are enabled (1) or disabled (0) on the device. Updated after a configuration change. |
GET_HIGH_TEMPERATURE_ALERT_ENABLEget_high_temperature_alert_enable | — | Indicates if high temperature alerts are enabled (1) or disabled (0) on the device. Updated after a configuration change. |
GET_LEAK_ALERT_TIMEOUT_ENABLEget_leak_alert_timeout_enable | — | Indicates if liquid detected alert timeouts are enabled (1) or disabled (0) on the device. Updated after a configuration change. |
GET_LEAK_ALERT_TIMEOUT_INTERVAL_INDEXget_leak_alert_timeout_interval_index | — | The liquid detected alert timeout: 30 minutes (0), 1 hour default (1), 2 hours (2), 3 hours (3), 4 hours (4), or 6 hours (5). Updated after a configuration change. |
GET_LEAK_CONFIRMATION_ENABLEget_leak_confirmation_enable | — | Indicates if liquid detection confirmations are enabled (1) or disabled (0). Updated after a configuration change. |
GET_LEAK_CONFIRMATION_TIMEOUT_VALUEget_leak_confirmation_timeout_value | s | Specifies the liquid detection confirmation period of the device. Updated after a configuration change. |
GET_LEAK_SENSOR_MOISTURE_CALIBRATION_PERCENTAGEget_leak_sensor_moisture_calibration_percentage | % | The percentage used to determine the Calibrated Moisture Value for the leak sensor during calibration. Updated after a configuration change. |
GET_LEAK_SENSOR_VOLTAGE_VALUEget_leak_sensor_voltage_value | mV | The voltage level used to determine if the connected sensor is a leak (rope) sensor. Updated after a configuration change. |
GET_LORAWAN_SUB_BANDget_lorawan_sub_band | — | The LoRaWAN frequency sub-band that the device is operating on. Updated after a configuration change. |
GET_MOISTURE_VOLTAGE_VALUEget_moisture_voltage_value | mV | The default voltage level used to determine if liquid is detected. Updated after a configuration change. |
GET_NO_SENSOR_VOLTAGE_VALUEget_no_sensor_voltage_value | mV | The voltage level used to determine if no sensor is connected. Updated after a configuration change. |
GET_SENSOR_MODE_INDEXget_sensor_mode_index | — | Indicates the connected sensor type: no sensor (0), leak sensor (1), flood sensor (2), or unrecognised sensor (3). Indicated with every message from the device. |
GET_SENSOR_MODE_OVERWRITEget_sensor_mode_overwrite | — | Indicates if sensor mode index override is enabled (1) or disabled (0). Updated after a configuration change. |
GET_TILT_SWITCH_VALID_TRIGGER_COUNTget_tilt_switch_valid_trigger_count | — | Specifies the number of tilt sensor triggers required for a valid tamper trigger. Updated after a configuration change. |
GET_VIBRATION_SENSOR_ENABLEget_vibration_sensor_enable | — | Indicates if the device's vibration sensor for tamper detection is enabled (1) or disabled (0). Updated after a configuration change. |
REJOINED_NETWORK_24_HOURrejoined_network_24_hour | — | Indicates if the device rejoined the network in the last 24 hours (1) or not (0). |
SIGNAL_QUALITY_CHECKsignal_quality_check | — | Indicates the signal quality seen by the device. |
Alert Related Variables
Variables that control and report alert conditions.
Variable NameAPI Label | Unit | Description |
|---|---|---|
BATTERY_ALERT_ENABLEDbattery_alert_enabled | — | Controls whether battery alerts are sent on Ubidots (1 = on, 0 = off). |
HUMIDITY_ALERT_ENABLEDhumidity_alert_enabled | — | Controls whether humidity alerts are sent on Ubidots (1 = on, 0 = off). |
HUMIDITY_ALERT_HIGH_THRESHOLDhumidity_alert_high_threshold | %rH | Sets the high threshold for humidity alerts on Ubidots. |
HUMIDITY_ALERT_LOW_THRESHOLDhumidity_alert_low_threshold | %rH | Sets the low threshold for humidity alerts on Ubidots. |
TAMPER_ALARMtamper_alarm | — | Triggered when the tamper alert bit and sensor disconnect bit is set. |
TEMPERATURE_ALERT_ENABLEDtemperature_alert_enabled | — | Controls whether temperature alerts are sent on Ubidots (1 = on, 0 = off). |
TEMPERATURE_ALERT_HIGH_THRESHOLDtemperature_alert_high_threshold | — | Sets the high threshold for temperature alerts on Ubidots. |
TEMPERATURE_ALERT_LOW_THRESHOLDtemperature_alert_low_threshold | — | Sets the low threshold for temperature alerts on Ubidots. |