Raw Data Variables #
The following raw data variables are available for the Odeus. These variables can be used to analyse the raw device data and create custom analytics depending on the application.
| API Label | Unit | Description |
|---|---|---|
| ambient_temperature | °C | The ambient temperature measured at the start of every two-hour sampling buffer. The temperature is measured with a resolution of 0.01 °C. |
| ambient_temperature_fahrenheit | °F | The ambient temperature measured at the start of every two-hour sampling buffer. The temperature is measured with a resolution of 0.018 °F. |
| barometric_pressure | hPa | The barometric pressure measured by the device. |
| humidity | %rH | The humidity measured by the device. The humidity is measured with a resolution of 0.01 %rH. |
| pipe_temperature | °C | The pipe temperature measured at the start of every two-hour sampling buffer. The temperature is measured with a resolution of 0.01 °C. |
| pipe_temperature_fahrenheit | °F | The pipe temperature measured at the start of every two-hour sampling buffer. The temperature is measured with a resolution of 0.018 °F. |
Measurement, Consumption and Analytics Variables #
The following variables on the Water Monkey device can be used directly or indirectly to evaluate the consumption patterns on site. These variables are useful for analytics and intelligence when determining the consumption and leak characteristics of a building.
| API Label | Unit | Description |
|---|---|---|
| consumption_cost_m3 | $ | Total cost of consumption for the selected time period. |
| elevation | m | The estimated elevation of the device above ground. |
| flow_activity_metric | Binary indicator of flow and no flow for continuous leak detection calculations and dashboard visuals. (1 = flow detected, 0 = no flow detected) | |
| lpi_activity | Leak Probability Indicator based on flow activity. Potential for leak is greater when higher activity is seen on a pipe, especially if continuous flow is simultaneously detected. This represents activity seen in the last 24 hours. (1 = low flow, 2 = medium flow, 3 = high flow) | |
| lpi_volume_cost | $ | Estimated cost of the volume of water consumed for the specified time period. This is based on the LPI_VOLUME_ESTIMATE. |
| lpi_volume_estimate | L | Estimated leak volume based on the calculated LPI. |
| lpi_volume_estimate_gallons | gal | Estimated leak volume based on the calculated LPI. |
| volume_flow | L | Instantaneous estimated volume through the given pipe. |
| volume_riser_cost_weekly | $ | The estimated cost associated with the volume of water calculated through the given pipe in the last 7 days. This is only applicable to an odeus device in riser mode. |
| volume_riser_daily | L | Daily sum of the estimated volumetric consumption through a riser. This is only applicable to an odeus device in riser mode. |
| volume_riser_flow | L | Instantaneous estimated volume estimation through the given riser pipe. This is only applicable to an odeus device in riser mode. |
| volume_riser_flow_m3 | m³ | Instantaneous estimated volume estimation through the given riser pipe. This is only applicable to an odeus device in riser mode. |
| volume_riser_flow_weekly | L | Weekly sum of the estimated volumetric consumption through a riser. This is only applicable to an odeus device in riser mode. |
| volume_riser_flow_weekly_gallons | gal | Weekly sum of the estimated volumetric consumption through a riser. This is only applicable to an odeus device in riser mode. |
| water_hardness | mg/L | Measure of the hardness of water in the location in which the device is installed. |
Internal Configuration and Device Management Variables #
The following Odeus variables are used to control the functionality of the device and monitor device behaviour. Variables describing device health and connectivity are also available.
| API Label | Unit | Description |
|---|---|---|
| battery_percentage | % | Latest averaged battery percentage level of the device. |
| battery_voltage | mV | Latest averaged battery level of the device. |
| device_missed_update_bit | Indicates if the device has missed an update. Devices typically transmit a message every two hours. If the device hasn't sent a message in the past four hours, then this variable will be set to 1. | |
| device_offline_bit | Indicates if the device is offline. Devices typically transmit a message every two hours. If the device hasn't sent a message in the past four hours and the DEVICE_MISSED_UPDATE_BIT is set to 1, then this variable will also be set to 1. | |
| device_time | s | Indicates the device's time as an epoch timestamp in seconds GMT. |
| firmware_version | The current firmware version of the device. | |
| frame_count | This is the number of messages transmitted by the device. This counter will reset when the device is reset. | |
| get_ble_enable | Device will indicate if its Bluetooth is enabled. This value will be updated after a configuration change took place on the device. (1 = enabled, 0 = not enabled) | |
| get_device_mode_index | Device will indicate what mode it is running in. This is automatically done at boot or during a downlink config confirmation message. (0 = riser mode, 1 = pou mode, 2 = logger mode) | |
| get_heartbeat_interval_index | Device will indicate what its cloud update interval between heartbeat messages is. This value will be updated after a configuration change took place on the device. (0 = 6 hours, 1 = 12 hours, 2 = 24 hours (default) and 3 = 48 hours) | |
| get_hot_water_pipe | Device will indicate what its hot water pipe value is. This value will be updated after a configuration change took place on the device. | |
| get_index_high_activity_value | Device will indicate what its high activity threshold value is. This value will be updated after a configuration change took place on the device. | |
| get_index_low_activity_value | Device will indicate what its low activity threshold value is. This value will be updated after a configuration change took place on the device. | |
| get_index_medium_activity_value | Device will indicate what its medium activity threshold value is. This value will be updated after a configuration change took place on the device. | |
| get_index_min_and_max_update_enable | Allows the tracking of the indexing min and max value to be reset at every interval. | |
| get_index_min_and_max_update_interval | Controls the interval at which the indexing min and max value will be reset, default is 24 hours (once a day). | |
| get_lorawan_sub_band_value | 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_pipe_adc_min_and_max_update_enable | Allows the tracking of the pipe ADC min and max value to be reset at every interval. | |
| get_pipe_adc_min_and_max_update_interval | Controls the interval at which the pipe ADC min and max value will be reset, default is 24 hours (once a day). | |
| get_send_pipe_temperature | Controls whether the pipe temperature should be sent every two hours along with the ambient temperature. (1 = send pipe temperature, 0 = DON’T send pipe temperature) | |
| get_tx_interval_index | Device will indicate what its cloud update interval between riser / logger mode data messages is. This value will be updated after a configuration change took place on the device. (0 = 15min, 1 = 20min, 2 = 30min, 3 = 1 hour, 4 = 2 hours (default), 5 = 3 hours and 6 = 6 hours) | |
| get_use_pipe_rolling_average | Controls whether the pipe average or rolling average should be used for the temperature indexing. (1 = use pipe rolling average, 0 = DON’T use pipe rolling average) | |
| get_vibration_sensor_enable | Device will indicate if its vibration sensor is enabled. This value will be updated after a configuration change took place on the device. (1 = enabled, 0 = not enabled). | |
| ground_floor_pressure | hPa | Pressure measured at the ground floor of the building in which the device is installed. |
| maximum_ambient_temperature | °C | Maximum ambient temperature measured by the device during the past 24 hours. |
| maximum_ambient_temperature_fahrenheit | °F | Maximum ambient temperature measured by the device during the past 24 hours in Fahrenheit. |
| maximum_calibration_ratio | Maximum calibration indexing ratio measured by the device during the last calibration run. | |
| maximum_index_ratio | Maximum indexing ratio used to calculate the temperature ratio index values. | |
| maximum_pipe_temperature | °C | Maximum pipe temperature measured by the device during the past 24 hours. |
| maximum_pipe_temperature_fahrenheit | °F | Maximum pipe temperature measured by the device during the past 24 hours in Fahrenheit. |
| middle_floor_pressure | hPa | Pressure measured at the middle floor of the building in which the device is installed. |
| minimum_ambient_temperature | °C | Minimum ambient temperature measured by the device during the past 24 hours. |
| minimum_ambient_temperature_fahrenheit | °F | Minimum ambient temperature measured by the device during the past 24 hours in Fahrenheit. |
| minimum_calibration_ratio | Minimum calibration indexing ratio measured by the device during the last calibration run. | |
| minimum_index_ratio | Minimum indexing ratio used to calculate the temperature ratio index values. | |
| minimum_pipe_temperature | °C | Minimum pipe temperature measured by the device during the past 24 hours. |
| minimum_pipe_temperature_fahrenheit | °F | Minimum pipe temperature measured by the device during the past 24 hours in Fahrenheit. |
| pipe_temperature_rolling | °C | The pipe temperature measured at the start of every two-hour sampling buffer using a rolling average. The temperature is measured with a resolution of 0.01 °C. |
| pipe_temperature_rolling_fahrenheit | °F | The pipe temperature measured at the start of every two-hour sampling buffer in Fahrenheit, using a rolling average. The temperature is measured with a resolution of 0.018 °F. |
| rssi | dBm | How good the signal power (radio signal) is from the device to the closest tower. 1 |
| 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 | 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. 1 |
| 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 | Indicates the health status of the device. The variable's context will contain for information regarding the device's status (0 = device is healthy, -1 = device has reset unexpectedly). | |
| temperature_ratio_index | This ratio of the current pipe ADC value and the rolling average pipe ADC value is indexed using an algorithm, with preset values used to calculate the thresholds for low, medium and high water activity. (0= none, 1 = low, 2 = medium, 3 = high) | |
| top_floor_pressure | hPa | Pressure measured at the top floor of the building in which the device is installed. |
| wdt_reset_code | Gives the reason for the WDT reset that can be seen in the status variable, helps to identify in which part of the code the WDT reset occurred or if it was due to a manual reset (unplug replug sequence). |
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:
| API Label | Unit | Description |
|---|---|---|
| battery_alert_enabled | Controls whether battery alerts should be sent on Ubidots. (0 = off, 1 = on) | |
| battery_indication_bit | Indicates the state of the battery. (0 = Bad, 1 = Average, 2 = Good ) | |
| device_alert | Indicates if any of the device alerts are triggered (1 = At least one device alert was triggered, 0 = No device alerts are triggered). | |
| flow_activity_metric_enabled | Binary indicator to select or deselect LPI Activity threshold alerts to be sent to the client. (0 = disabled, 1 = enabled) | |
| high_usage_alert | Binary indicator of high usage detected in the last 24 hours where the indicator shows usage greater than 60% of the total possible usage in the past 24 hours. (0 = normal usage, 1 = high usage detected) | |
| high_usage_alert_enabled | Binary indicator enabling or disabling high usage alert messages to be sent. (0 = disabled, 1 = enabled) | |
| lpi_activity_enabled | Binary indicator to select or deselect LPI Activity threshold alerts to be sent to the client. (0 = disabled, 1 = enabled) | |
| lpi_activity_min_alert_enabled | Value to replace the minimum LPI_ACTIVITY threshold value used to trigger LPI_ACTIVITY alerts. | |
| rejoined_network_24_hour | Variable indicates if the device rejoined the network in the last 24 hours. (0 = did not rejoin, 1 = rejoined) | |
| temperature_alert_enabled | Controls whether temperature alert should be sent on Ubidots. (0 = off, 1 = on) | |
| temperature_alert_high_threshold | Sets the high temperature threshold on Ubidots for alerts. | |
| temperature_alert_low_threshold | Sets the low temperature threshold on Ubidots for alerts. |
