Device type API Label: watermonkeyv3.0single
The Water Monkey Single is a water flow meter optimized for monitoring a single water meter. It provides minute-by-minute usage data for multi-residential and commercial properties, detecting leaks and tracking consumption in real time via LTE-M or NB-IoT connectivity.
Raw Data Variables
These are the variables sent directly by the device.
Variable NameAPI Label | Unit | Description |
|---|---|---|
PULSES_PER_TALLY_PRIMARYwu_p | pulses | Number of pulses received from the primary meter per tally period |
TOTAL_PULSE_COUNT_PRIMARYtc_p | pulses | Cumulative pulse count from the primary meter |
BATTERY_VOLTAGEvbat | mV | Raw battery voltage of the device |
RSRPrsrp | dBm | Reference Signal Received Power — LTE signal strength indicator |
CALIBRATION_HIGHcal_h | µTesla | Upper magnetic calibration threshold |
CALIBRATION_LOWcal_l | µTesla | Lower magnetic calibration threshold |
ERROR_CODEerr | — | Device error code |
FIRMWARE_VERSIONver | — | Current firmware version running on the device |
STATUSstatus | — | General device status indicator |
TALLY_INTERVALti | minutes | Interval at which the device tallies pulse counts |
UPDATE_INTERVALui | minutes | Interval at which the device sends data to the platform |
LTE_BANDband | — | LTE frequency band in use |
Measurement, Consumption and Analytics Variables
Computed variables derived from raw data for consumption analysis and reporting.
Variable NameAPI Label | Unit | Description |
|---|---|---|
ACTUAL_CONSUMPTION_PER_UPDATEactual_consumption_per_update | Liters | Total actual water consumption in the last update interval |
WATER_CONSUMPTION_PER_UPDATEwater_consumption_per_update | Liters | Water consumption attributed to normal usage per update |
LEAK_VOLUME_PER_UPDATEleak_volume_per_update | Liters | Volume of water identified as leak per update interval |
TOTAL FLOW RATEtotal_flow_rate | LPM | Total flow rate across all active flow paths |
LOW_FLOW_SIDE_FLOW_RATElow_flow_side_flow_rate | LPM | Flow rate through the low-flow measurement path |
GREY AREA FLOW RATEgrey_area_flow_rate | LPM | Flow rate in the transitional range between low-flow and high-flow paths |
RUN-OFF WATER FLOW RATErun_off_water_flow_rate | LPM | Flow rate detected as run-off or continuous background flow |
LOW_FLOW_WATER_METER_READINGlow_flow_water_meter_reading | m³ | Cumulative meter reading for the low-flow path |
LOW_FLOW_PERCENTAGElow_flow_percentage | % | Percentage of total consumption routed through the low-flow path |
LEAK_VOLUME_PERCENTAGEleak_volume_percentage | % | Leak volume as a percentage of total consumption |
METRIC_AVERAGE_DAILY_Lmetric_average_daily_l | l/day | Rolling average daily consumption in liters |
METRIC_MAX_DAILY_Lmetric_max_daily_l | l/day | Maximum single-day consumption recorded in liters |
METRIC_MIN_DAILY_Lmetric_min_daily_l | l/day | Minimum single-day consumption recorded in liters |
METRIC_WEEKLY_AVERAGE_VOLUMEmetric_weekly_average_volume | l/update | Average weekly consumption volume per update period |
METRIC_WEEKLY_MAX_VOLUMEmetric_weekly_max_volume | l/update | Maximum weekly consumption volume recorded |
METRIC_WEEKLY_MIN_VOLUMEmetric_weekly_min_volume | l/update | Minimum weekly consumption volume recorded |
METRIC_WEEKLY_MAX_DAYmetric_weekly_max_day | l/update | Day of the week with the highest consumption |
METRIC_WEEKLY_MIN_DAYmetric_weekly_min_day | l/update | Day of the week with the lowest consumption |
CARBON_WATER_MASScarbon_water_mass | kg | Carbon footprint equivalent of water consumed |
ACTUAL_COST_PER_UPDATEactual_cost_per_update | $ | Estimated total water cost for the last update interval |
WATER_COST_PER_UPDATEwater_cost_per_update | $ | Cost of normal water consumption per update interval |
LEAK_COST_PER_UPDATEleak_cost_per_update | $ | Estimated cost of leaked water per update interval |
RSSIrssi | dBm | Received Signal Strength Indicator (computed from RSRP) |
Internal Configuration and Device Management Variables
Variables used for device configuration and remote management.
Variable NameAPI Label | Unit | Description |
|---|---|---|
METER_TYPEmeter_type | — | Meter configuration: 1 = single meter, 0 = compound meter |
DEVICE_SHUTDOWNshutdown | — | Triggers a remote device shutdown |
OVER_THE_AIR_UPDATEota | — | Initiates an over-the-air firmware update |
REMOTE_REBOOTrb | — | Triggers a remote device reboot |
REMOTE_RECALIBRATIONrc | — | Triggers a remote recalibration of the device |
SECONDARY_ENABLEse | — | Enables or disables the secondary meter input |
FLOOD_CALIBRATION_ENABLEfce | — | Enables flood detection calibration mode |
DEVICE_OFFLINE_BITdevice_offline_bit | — | Bit flag indicating the device is currently offline |
BATTERY_INDICATION_BITbattery_indication_bit | — | Bit flag indicating low battery condition |
RSSI_STATE_BITrssi_state_bit | — | Bit flag indicating poor signal strength |
Alert Related Variables
Variables that control and report alert conditions.
Variable NameAPI Label | Unit | Description |
|---|---|---|
HIGH_USAGE_EVENT_ALERThigh_usage_event_alert | — | Triggered when consumption exceeds the configured high-usage threshold |
LEAK_STATE_BITleak_state_bit | — | Bit flag indicating an active leak detection state |
DEVICE_OFFLINE_ALERT_ENABLEdevice_offline_alert_enable | — | Enables alerts when the device goes offline |
HIGH_USAGE_ALERT_ENABLEhigh_usage_alert_enable | — | Enables alerts for high water usage events |
LEAK_ALERT_ENABLEleak_alert_enable | — | Enables alerts when a leak is detected |
LEAK_PERCENTAGE_ALERT_ENABLEleak_percentage_alert_enable | — | Enables alerts when leak volume exceeds a configured percentage threshold |