Raw Data Variables #
The following raw data variables are available for the Water Monkey. These variables can be used to analyse the raw device data and create custom analytics depending on the application.
| Variable Name | API Label | Unit | Description |
|---|---|---|---|
| AMBIENT_TEMPERATURE | ambient_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_FAHRENHEIT | ambient_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. |
| HUMIDITY | humidity | %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. |
| PRESSURE | pressure | hPa | The barometric pressure measured by the device during every heartbeat message. The pressure is measured with a resolution of 0.1 hPa. |
Internal Configuration and Device Management Variables #
The following Water Sniffer variables are used to control the functionality of the device and monitor device behaviour. Variables describing device health and connectivity are also available.
| Variable Name | API Label | Unit | Description |
|---|---|---|---|
| BATTERY_INDICATION_BIT | battery_indication_bit | An indication of whether the battery strength is good or bad. (1 = bad, 0 = good) | |
| BATTERY_PERCENTAGE | battery_percentage | % | Latest averaged battery percentage level of the device. |
| BATTERY_VOLTAGE | vbat | mV | Latest averaged battery level of the device. |
| CALIBRATED_MOISTURE_VALUE | calibrated_moisture_value | mV | The voltage threshold voltage 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. |
| FIRMWARE_VERSION | ver | The current firmware version of the device. | |
| FRAME_COUNT | frame_count | This is the number of messages transmitted by the device. This counter will reset when the device is reset. | |
| GET_BLE_ENABLE | get_ble_enable | Device will indicate if its Bluetooth is enabled or disabled. This value will be updated after a configuration change took place on the device. (1 = enabled, 2 = disabled) | |
| GET_FLOOD_SENSOR_MOISTURE_ CALIBRATION_PERCENTAGE | get_flood_sensor_moisture_ calibration_percentage | % | The percentage used to determine the Calibrated Moisture Value for the device during calibration. This value will be updated after a configuration change took place on the device. |
| GET_FLOOD_SENSOR_VOLTAGE_ VALUE | get_flood_sensor_voltage_ value | mV | The voltage level used to determine if the connected sensor is a flood sensor. This value will be updated after a configuration change took place on the device. |
| GET_HEARTBEAT_INTERVAL_INDEX | get_heartbeat_interval_index | Device will indicate what its cloud update interval between heartbeat messages. This value will be updated after a configuration change took place on the device. (0 = 6 hours, 1 = 12 hours, 2 = 24 hours (default), 3 = 48 hours) | |
| GET_LEAK_SENSOR_ MOISTURE_CALIBRATION_PERCENTAGE | get_leak_sensor_moisture_ calibration_percentage | % | The percentage used to determine the Calibrated Moisture Value for the device during calibration. This value will be updated after a configuration change took place on the device. |
| GET_LEAK_SENSOR_VOLTAGE_VALUE | get_leak_sensor_voltage_value | mV | The voltage level used to determine if the connected sensor is a leak (rope) sensor. This value will be updated after a configuration change took place on the device. |
| GET_LORAWAN_SUB_BAND | get_lorawan_sub_band | The LoRaWAN frequency sub-band that the device is operating on. This value will be updated after a configuration change took place on the device. | |
| GET_MOISTURE_VOLTAGE_VALUE | get_moisture_voltage_value | mV | The default voltage level used to determine if liquid is detected. This value will be updated after a configuration change took place on the device. |
| GET_NO_SENSOR_VOLTAGE_VALUE | get_no_sensor_voltage_value | mV | The voltage level used to determine if no sensor is connected. This value will be updated after a configuration change took place on the device. |
| GET_SENSOR_MODE_INDEX | get_sensor_mode_index | Device will indicate what type of is connected. This is indicated with every message sent from the device. (0 = no sensor, 1 = leak sensor, 2 = flood sensor, 3 = unrecognised sensor) | |
| GET_SENSOR_MODE_OVERWRITE | get_sensor_mode_overwrite | Indicates if sensor mode index override is enabled or disabled. This value will be updated after a configuration change took place on the device. (1 = enabled, 0 = disabled) | |
| GET_TILT_SWITCH_VALID_ TRIGGER_COUNT | get_tilt_switch_valid_ trigger_count | Specifies the amount of tilt sensor triggers required for a valid trigger. This value will be updated after a configuration change took place on the device. | |
| GET_VIBRATION_SENSOR_ENABLE | get_vibration_sensor_enable | Indicates if the device's vibration sensor for tamper detection is enabled or disabled. This value will be updated after a configuration change took place on the device. (1 = enabled, 0 = disabled) | |
| MEASURED_VALUE | measured_value | mV | The sensor's voltage measured by the device. |
| RSSI | rssi | dBm | How good the signal power (radio signal) is from the device to the closest gateway. 1 |
| SIGNAL_QUALITY_CHECK | signal_quality_check | Checking the signal quality seen by the device. The variable value ranges from 0 to 20 to show the quality of the signal, based on RSSI, SNR, number of missed messages and number of rejoins. (0 – 5 = good, 5 – 10 = average, 10 – 20 = bad) | |
| SNR | snr | dBm | (Signal to noise ratio) How good the radio signal to radio noise is from the device to the closest gateway. This is also used to determine signal quality and shouldn't be disregarded. 1dBm |
| SPREADING_FACTOR | spreading_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 that a lower transmit power is used and it is more battery efficient. | |
| STATUS | status | Indicates the health status of the device. The variable's context will contain further information regarding the device's reset status. (0 = healthy, -1 = device reset) |
1 Additional connectivity variables will also be available on the device depending on the number of gateways installed on site. These variables will be of the form rssi-cs-gt-XXX and/or snr-cs-gt-XXX. These variables will indicate which gateways (XXXX) can be seen by the device and the associated signal strength.
Alert Related Variables #
The following variables are related to the alert functionality and status of the device:
| Variable Name | API Label | Unit | Description |
|---|---|---|---|
| BATTERY_ALERT_ENABLED | battery_alert_enabled | Controls whether battery alerts should be sent on Ubidots. (1 = on, 0 = off) | |
| DEVICE_ALERT | device_alert | Indicates that the device requires attention. | |
| DEVICE_MISSED_UPDATE_BIT | device_missed_update_bit | Indicates if the device has missed an update. Devices typically transmit a message every 24 hours. If the device hasn't sent a heartbeat message in the past 24 hours, then this variable will be set to 1. | |
| DEVICE_OFFLINE_BIT | device_offline_bit | Indicates if the device is offline. Devices typically transmit a message every 24 hours. If the device hasn't sent a heartbeat message in the past 24 hours and the DEVICE_MISSED_UPDATE_BIT is set to 1, then this variable will also be set to 1. | |
| GET_HIGH_HUMIDITY_ALERT_ENABLE | get_high_humidity_alert_enable | Indicates if high humidity alerts are enabled (1) or disabled (0) on the device. This value will be updated after a configuration change took place on the device. | |
| GET_HIGH_TEMPERATURE_ALERT_ ENABLE | get_high_temperature_alert_ enable | Indicates if high temperature alerts are enabled or disabled on the device. This value will be updated after a configuration change took place on the device. (1 = enabled, 0 = disabled) | |
| GET_LEAK_ALERT_TIMEOUT_ENABLE | get_leak_alert_timeout_enable | Indicates if liquid detected alert timeouts are enabled or disabled on the device. This value will be updated after a configuration change took place on the device. (1 = enabled, 0 = disabled) | |
| GET_LEAK_ALERT_TIMEOUT_ INTERVAL_INDEX | get_leak_alert_timeout_interval_index | Specifies the liquid detected alert timeout of the device. This value will be updated after a configuration change took place on the device. (0 = 30 minutes, 1 = 1 hour (default), 2 = 2 hours, 3 = 3 hours, 4 = 4 hours, 5 = 6 hours) | |
| GET_LEAK_CONFIRMATION_ENABLE | get_leak_confirmation_enable | Indicates if liquid detection confirmations are enabled or disabled on the device. This value will be updated after a configuration change took place on the device. (1 = enabled, 0 = disabled) | |
| GET_LEAK_CONFIRMATION_ TIMEOUT_VALUE | get_leak_confirmation_ timeout_value | s | Specifies the liquid detection confirmation period of the device. This value will be updated after a configuration change took place on the device. |
| HIGH_HUMIDITY_ALERT_BIT | high_humidity_alert_bit | Indicates if the measured humidity is elevated or normal. (1 = excess of 80 %rH, 0 = normal) | |
| HIGH_TEMPERATURE_ALERT_BIT | high_temperature_alert_bit | Indicates if the measured temperature is elevated or normal. (1 = excess of 35 °C / 95 °F, 0 = normal) | |
| HUMIDITY_ALERT_ENABLED | humidity_alert_enabled | Controls whether humidity alert should be sent on Ubidots. (1 = on, 0 = off) | |
| HUMIDITY_ALERT_HIGH_THRESHOLD | humidity_alert_high_threshold | %rH | Sets the high threshold on Ubidots for alerts in %rH. |
| HUMIDITY_ALERT_LOW_THRESHOLD | humidity_alert_low_threshold | %rH | Sets the low threshold on Ubidots for alerts in %rH. |
| LIQUID_DETECTED_BIT | liquid_detected_bit | Indicates if the device detected liquid, which can be a potential indication of a leak. (1 = liquid detected, 0 = no liquid detected) | |
| REJOINED_NETWORK_24_HOUR | rejoined_network_24_hour | Variable indicates if the device rejoined the network in the last 24 hours. (1 = rejoined the network in the last 24 hours, 0 = not rejoined the network in the last 24 hours) | |
| SENSOR_DETECTED_BIT | sensor_detected_bit | Indicates if a sensor is connected to the device as at the last message received from the device. (1 = sensor connected, 0 = no sensor connected) | |
| SENSOR_DISCONNECTED_BIT | sensor_disconnected_bit | Indicates if the device's sensor was disconnected since the last transmission from the device. (1 = disconnected, 0 = not disconnected) | |
| TAMPER_ALERT_BIT | tamper_alert_bit | Indicates if the device was tampered with. (1 = tamper detected, 0 = no tamper detected) | |
| TEMPERATURE_ALERT_ENABLED | temperature_alert_enabled | Controls whether temperature alert should be sent on Ubidots. (1 = on, 0 = off) | |
| TEMPERATURE_ALERT_HIGH_ THRESHOLD | temperature_alert_high_ threshold | Sets the high threshold on Ubidots for alerts | |
| TEMPERATURE_ALERT_LOW_ THRESHOLD | temperature_alert_low_ threshold | Sets the low threshold on Ubidots for alerts |
