Single WM

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 Name
API Label
UnitDescription
PULSES_PER_TALLY_PRIMARY
wu_p
pulsesNumber of pulses received from the primary meter per tally period
TOTAL_PULSE_COUNT_PRIMARY
tc_p
pulsesCumulative pulse count from the primary meter
BATTERY_VOLTAGE
vbat
mVRaw battery voltage of the device
RSRP
rsrp
dBmReference Signal Received Power — LTE signal strength indicator
CALIBRATION_HIGH
cal_h
µTeslaUpper magnetic calibration threshold
CALIBRATION_LOW
cal_l
µTeslaLower magnetic calibration threshold
ERROR_CODE
err
Device error code
FIRMWARE_VERSION
ver
Current firmware version running on the device
STATUS
status
General device status indicator
TALLY_INTERVAL
ti
minutesInterval at which the device tallies pulse counts
UPDATE_INTERVAL
ui
minutesInterval at which the device sends data to the platform
LTE_BAND
band
LTE frequency band in use

Measurement, Consumption and Analytics Variables

Computed variables derived from raw data for consumption analysis and reporting.

Variable Name
API Label
UnitDescription
ACTUAL_CONSUMPTION_PER_UPDATE
actual_consumption_per_update
LitersTotal actual water consumption in the last update interval
WATER_CONSUMPTION_PER_UPDATE
water_consumption_per_update
LitersWater consumption attributed to normal usage per update
LEAK_VOLUME_PER_UPDATE
leak_volume_per_update
LitersVolume of water identified as leak per update interval
TOTAL FLOW RATE
total_flow_rate
LPMTotal flow rate across all active flow paths
LOW_FLOW_SIDE_FLOW_RATE
low_flow_side_flow_rate
LPMFlow rate through the low-flow measurement path
GREY AREA FLOW RATE
grey_area_flow_rate
LPMFlow rate in the transitional range between low-flow and high-flow paths
RUN-OFF WATER FLOW RATE
run_off_water_flow_rate
LPMFlow rate detected as run-off or continuous background flow
LOW_FLOW_WATER_METER_READING
low_flow_water_meter_reading
Cumulative meter reading for the low-flow path
LOW_FLOW_PERCENTAGE
low_flow_percentage
%Percentage of total consumption routed through the low-flow path
LEAK_VOLUME_PERCENTAGE
leak_volume_percentage
%Leak volume as a percentage of total consumption
METRIC_AVERAGE_DAILY_L
metric_average_daily_l
l/dayRolling average daily consumption in liters
METRIC_MAX_DAILY_L
metric_max_daily_l
l/dayMaximum single-day consumption recorded in liters
METRIC_MIN_DAILY_L
metric_min_daily_l
l/dayMinimum single-day consumption recorded in liters
METRIC_WEEKLY_AVERAGE_VOLUME
metric_weekly_average_volume
l/updateAverage weekly consumption volume per update period
METRIC_WEEKLY_MAX_VOLUME
metric_weekly_max_volume
l/updateMaximum weekly consumption volume recorded
METRIC_WEEKLY_MIN_VOLUME
metric_weekly_min_volume
l/updateMinimum weekly consumption volume recorded
METRIC_WEEKLY_MAX_DAY
metric_weekly_max_day
l/updateDay of the week with the highest consumption
METRIC_WEEKLY_MIN_DAY
metric_weekly_min_day
l/updateDay of the week with the lowest consumption
CARBON_WATER_MASS
carbon_water_mass
kgCarbon footprint equivalent of water consumed
ACTUAL_COST_PER_UPDATE
actual_cost_per_update
$Estimated total water cost for the last update interval
WATER_COST_PER_UPDATE
water_cost_per_update
$Cost of normal water consumption per update interval
LEAK_COST_PER_UPDATE
leak_cost_per_update
$Estimated cost of leaked water per update interval
RSSI
rssi
dBmReceived Signal Strength Indicator (computed from RSRP)

Internal Configuration and Device Management Variables

Variables used for device configuration and remote management.

Variable Name
API Label
UnitDescription
METER_TYPE
meter_type
Meter configuration: 1 = single meter, 0 = compound meter
DEVICE_SHUTDOWN
shutdown
Triggers a remote device shutdown
OVER_THE_AIR_UPDATE
ota
Initiates an over-the-air firmware update
REMOTE_REBOOT
rb
Triggers a remote device reboot
REMOTE_RECALIBRATION
rc
Triggers a remote recalibration of the device
SECONDARY_ENABLE
se
Enables or disables the secondary meter input
FLOOD_CALIBRATION_ENABLE
fce
Enables flood detection calibration mode
DEVICE_OFFLINE_BIT
device_offline_bit
Bit flag indicating the device is currently offline
BATTERY_INDICATION_BIT
battery_indication_bit
Bit flag indicating low battery condition
RSSI_STATE_BIT
rssi_state_bit
Bit flag indicating poor signal strength

Alert Related Variables

Variables that control and report alert conditions.

Variable Name
API Label
UnitDescription
HIGH_USAGE_EVENT_ALERT
high_usage_event_alert
Triggered when consumption exceeds the configured high-usage threshold
LEAK_STATE_BIT
leak_state_bit
Bit flag indicating an active leak detection state
DEVICE_OFFLINE_ALERT_ENABLE
device_offline_alert_enable
Enables alerts when the device goes offline
HIGH_USAGE_ALERT_ENABLE
high_usage_alert_enable
Enables alerts for high water usage events
LEAK_ALERT_ENABLE
leak_alert_enable
Enables alerts when a leak is detected
LEAK_PERCENTAGE_ALERT_ENABLE
leak_percentage_alert_enable
Enables alerts when leak volume exceeds a configured percentage threshold