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 |
|---|---|---|---|
| METER_TYPE | meter_type | Single or compound meter as indicated by input. (1 = single, 0 = compound) | |
| PULSES_PER_TALLY_PRIMARY | wu_p | pulses | Number of pulses received per tally since the last update for the primary sensor. Default scale is 1:10. The default tally interval is 10 minutes, which means pulses are saved to memory every 10 minutes for the primary sensor. |
| PULSES_PER_TALLY_SECONDARY | wu_s | pulses | Number of pulses received per tally since the last update for the secondary sensor (if enabled). Default scale is 1:10. The default tally interval is 10 minutes, which means pulses are saved to memory every 10 minutes for the secondary sensor. |
| TOTAL_PULSE_COUNT_PRIMARY | tc_p | pulses | Primary sensor total pulse count since device start-up. |
| TOTAL_PULSE_COUNT_SECONDARY | tc_s | pulses | Secondary sensor total pulse count since device start-up. |
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.
| Variable Name | API Label | Unit | Description |
|---|---|---|---|
| ACTUAL_CONSUMPTION_PER_UPDATE | actual_consumption_per_update | L | This parameter is calculated as the difference between the water consumption and leak volume. The variable’s value is calculated by subtracting the leak volume from the total water consumed and it is available in both metric and imperial units |
| ACTUAL_CONSUMPTION_PER_UPDATE | actual_consumption_per_update_g | gal | |
| ACTUAL_COST_PER_UPDATE | actual_cost_per_update | $ | This parameter is calculated as the difference between the water consumption cost and leak cost. The variables value is calculated by subtracting the leak cost from the total water cost. |
| CARBON_WATER_MASS | carbon_water_mass | kg | The estimated amount of carbon associated with the volumetric consumption of water. |
| GREY AREA FLOW RATE | grey_area_flow_rate | LPM | Total flow rate of water that cannot be classified as leaked or actually consumed and it is available in both metric and imperial units. |
| GREY AREA FLOW RATE | grey_area_flow_rate_g | GPM | |
| HIGH_FLOW_PERCENTAGE | high_flow_percentage | % | Percentage of high flow side water volume in comparison to total water consumption. |
| HIGH_FLOW_SIDE_FLOW_RATE | high_flow_side_flow_rate | LPM | This variable is applicable to devices applied to a compound meter head. Flow rate on the high/secondary side of the meter. It is available in both metric and imperial units. |
| HIGH_FLOW_SIDE_FLOW_RATE | high_flow_side_flow_rate_g | GPM | |
| HIGH_FLOW_WATER_METER_READING | high_flow_water_meter_reading | m³ | The cumulative volume of water seen through the hide side of the meter. This variable is applicable to devices applied to a compound meter head. It is estimated to be accurate within 10% of the high flow water meter heads reading. |
| LEAK_COST_PER_UPDATE | leak_cost_per_update | $ | This parameter is calculated based on the leak volume per update variable indicated above. It is calculated by multiplying the cost per m3 (received during device commissioning) with the leak volume per update. |
| LEAK_VOLUME_PER_UPDATE | leak_volume_per_update | L | This parameter is calculated based on the assumption that water consumption is at its minimum between 1am and 5am. Therefore, this parameter can be seen as the minimum continuous flow rate that was detected by the device within the last 24 hours and it’s assumed to be a leak. This value is available in both metric and imperial units. |
| LEAK_VOLUME_PER_UPDATE | leak_volume_per_update_g | gal | |
| LEAK_VOLUME_PERCENTAGE | leak_volume_percentage | % | The value for this parameter is calculated by dividing the volume of water leaked by the total water consumption. |
| LOW_FLOW_PERCENTAGE | low_flow_percentage | % | This variable is applicable to devices applied to a compound meter head. The value for this parameter is calculated by dividing the low flow water meters volume by the total water consumption. |
| LOW_FLOW_SIDE_FLOW_RATE | low_flow_side_flow_rate | LPM | Flow rate on the low/primary side of the meter. It is available in both metric and imperial units. |
| LOW_FLOW_SIDE_FLOW_RATE | low_flow_side_flow_rate_g | GPM | |
| LOW_FLOW_WATER_METER_READING | low_flow_water_meter_reading | m³ | The cumulative volume of water seen through the low side of the meter. It is estimated to be accurate within 10% of the low flow water meter heads reading. |
| METRIC_AVERAGE_DAILY_GAL | metric_average_daily_gal | gal | |
| METRIC_AVERAGE_DAILY_L | metric_average_daily_l | L | The estimated average daily consumption. It is available in both metric and imperial units. |
| METRIC_MAX_DAILY_GAL | metric_max_daily_gal | gal | |
| METRIC_MAX_DAILY_L | metric_max_daily_l | L | The estimated maximum daily consumption. It is available in both metric and imperial units. |
| METRIC_MIN_DAILY_GAL | metric_min_daily_gal | gal | |
| METRIC_MIN_DAILY_L | metric_min_daily_l | L | The estimated minimum daily consumption. It is available in both metric and imperial units. |
| RUN-OFF WATER FLOW RATE | run_off_water_flow_rate | LPM | The estimated flow rate of run-off / leak water. It is available in both metric and imperial units. |
| RUN-OFF WATER FLOW RATE | run_off_water_flow_rate_g | GPM | |
| TOTAL FLOW RATE | total_flow_rate | LPM | The total flow rate associated with the total WATER_CONSUMPTION_PER_UPDATE. It is available in both metric and imperial units. |
| TOTAL FLOW RATE | total_flow_rate_g | GPM | |
| WATER_CONSUMPTION_PER_UPDATE | water_consumption_per_update | L | Water consumption per update as measured in 10 minutes intervals (default). It is available in both metric and imperial units. (Water is measured in 10-minute intervals and is pushed to the cloud once every 6 hours, it is expected that the last 6 hours’ worth of data will be missing until the next 6-hour interval has lapsed). |
| WATER_CONSUMPTION_PER_UPDATE | water_consumption_per_update_g | gal | |
| WATER_COST_PER_UPDATE | water_cost_per_update | $ | Water cost per update as measured in 10 minutes intervals (default). (Water is measured in 10-minute intervals and is pushed to the cloud once every 6 hours, it is expected that the last 6 hours’ worth of data will be missing until the next 6-hour interval has lapsed). |
Internal Configuration and Device Management Variables #
The following Water Monkey 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_VOLTAGE | vbat | mV | Latest averaged battery level of the device. |
| CALIBRATION_HIGH | cal_h | µT | Calibrated high threshold for water activity detection. |
| CALIBRATION_LOW | cal_l | µT | Calibrated low threshold for water activity detection. |
| FIRMWARE_VERSION | ver | The current firmware version of the device. | |
| LEAK_STATE_BIT | leak_state_bit | This parameter is based on the leak volume per update variable and indicates that the water usage value hasn't returned to 0 within the last 24 hours. (0 = water usage returned to zero in the last 24 hours, 1 = water usage returned to zero in the last 24 hours) | |
| LTE_BAND | band | The LTE-M/NB-IOT frequency band the device has selected as the strongest/available band. | |
| OVER_THE_AIR_UPDATE | ota | To indicate that a new firmware version is available for download | |
| RSRP | rsrp | dBm | How good the signal power (radio signal) is from the device to the closest tower. |
| RSSI | rssi | dBm | Signal strength based on the last received update from the device. |
| RSSI_STATE_BIT | rssi_state_bit | An indication of whether the signal is good or bad. (1 = bad, 0 = good) | |
| SECONDARY_ENABLE | se | Controls if the secondary sensor is enabled on the device. (1 = enabled, 0 = disabled) | |
| STATUS | status | System health check. (1 = error, 0 = healthy) | |
| TALLY_INTERVAL | ti | min | The interval on the device for saving the pulse counts to memory. |
| UPDATE_INTERVAL | ui | min | The cloud update interval, between data dumps. |
Alert Related Variables #
The following variables are related to the alert functionality and status of the device:
| Variable Name | API Label | Unit | Description |
|---|---|---|---|
| DEVICE_OFFLINE_ALERT_ENABLE | device_offline_alert_enable | Controls whether device offline alerts should be sent on Ubidots. (1 = on, 0 = off) | |
| DEVICE_OFFLINE_BIT | device_offline_bit | Device offline indicator bit. (1 = offline, 0 = online) | |
| ERROR_CODE | err | Errors detected on the device as the system performs health checks. (0 = exception_unknown, 1 = exception_connection_error, 2 = exception_battery_low, 3 = exception_sensor_error, 4 = exception_fota_error, 5 = exception_rsrp_low, 6 = exception_min_max_flood (Possible flood event occured)) | |
| HIGH_USAGE_ALERT_ENABLE | high_usage_alert_enable | Controls whether high usage alerts should be sent on Ubidots. (1 = on, 0 = off) | |
| HIGH_USAGE_EVENT_ALERT | high_usage_event_alert | The high usage alert indicates an event that was outside the normal usage patterns. This alert can be generated by the actual hardware or post update software alert | |
| LEAK_ALERT_ENABLE | leak_alert_enable | Controls whether leak alerts should be sent on Ubidots. (1 = on, 0 = off) | |
| LEAK_PERCENTAGE_ALERT_ENABLE | leak_percentage_alert_enable | Controls whether leak percentage alerts should be sent on Ubidots. (1 = on, 0 = off |
Device Control Variables #
The following variables can be used to control certain functionalities of the device.
| Variable Name | API Label | Unit | Description |
|---|---|---|---|
| DEVICE_SHUTDOWN | shutdown | Use this Variable to remotely turnoff the device | |
| FLOOD_CALIBRATION_ENABLE | fce | Controls if the flood calibration run should be started on the device after the next update (1 = start, 0 = DO NOT start). The flood calibration run should be performed over a 24-hour period. | |
| REMOTE_REBOOT | rb | Controls if the device should be rebooted after the next update (1 = reboot, 0 = DO NOT reboot). | |
| REMOTE_RECALIBRATION | rc | Controls if the device should recalibrate after the next update (1 = recalibrate, 0 = DO NOT recalibrate). |
