v1

Raw Data Variables

These are the variables sent directly by the device.

Variable Name `API Label`	Unit	Description
BATTERY_VOLTAGE `battery_voltage`	mV	Latest averaged battery level of the device.
CONSUMPTION_SINCE_LAST_TX_M3 `consumption_since_last_tx_m3`	m³	The consumption measured since the last transmission by the device in m³.
CONSUMPTION_VOLUME_UNIT `consumption_volume_unit`	—	Indicates the unit of total consumption as m³ (0), ft³ (1), gal (2) or unrecognised (3).
EXTERNAL_POWER_SOURCE_CONNECTED_BIT `external_power_source_connected_bit`	—	Indicates if the device is connected to an external power source (1) or running on battery (0).
FLOW_RATE_UNIT `flow_rate_unit`	—	Indicates the unit of flow rate as m³/h (0) or unrecognised (1).
FRAME_COUNT `frame_count`	—	Number of messages transmitted by the device since last reset.
INSTANT_FLOW_RATE `instant_flow_rate`	—	The instantaneous flow rate measured by the device. The unit is indicated in the `flow_rate_unit` variable.
RSSI `rssi`	dBm	How good the signal power (radio signal) is from the device to the closest gateway.
SNR `snr`	dBm	Signal-to-noise ratio from the device to the closest gateway.
SPREADING_FACTOR `spreading_factor`	—	LoRaWAN spreading factor — a lower value means lower transmit power and more battery efficient operation.
TOTAL_CONSUMPTION_M3 `total_consumption_m3`	m³	The total water consumption measured by the device in m³.
UPLINK_TRIGGERING_TYPE `uplink_triggering_type`	—	Indicates the triggering type for flow update messages. The type is explained in the variable context.
VALVE_CLOSE_ERROR_BIT `valve_close_error_bit`	—	Indicates if there was an error closing the valve (1) or not (0).
VALVE_OPEN_ERROR_BIT `valve_open_error_bit`	—	Indicates if there was an error opening the valve (1) or not (0).
VALVE_STATUS `valve_status`	—	Indicates the status of the valve as open (0), closed (2) or error (3).
WATER_TEMPERATURE_CELSIUS `water_temperature_celsius`	°C	The water temperature measured by the device with a resolution of 0.01 °C.

Measurement, Consumption and Analytics Variables

Computed variables derived from raw data for flow analysis and leak detection.

Variable Name `API Label`	Unit	Description
CF_CHECK `cf_check`	—	Indicates if a potential continuous flow event is underway (1 = event started, 0 = event stopped). If the value remains 1 for 2 hours, the event is validated.
EFFECTIVE_FLOW_RATE `effective_flow_rate`	m³/h	Instantaneous flow rate if greater than zero, otherwise the average flow rate calculated from delta consumption and delta time between the last two messages.
PB_CHECK `pb_check`	—	Indicates if a pipe burst event is underway (1 = event started, 0 = event stopped). The backend acts on this event to close valves.
PL_CHECK `pl_check`	—	Indicates if a potential pinhole leak event is underway (1 = event started, 0 = event stopped). If the value remains 1 for 72 hours, the event is validated.
SIGNAL_QUALITY_CHECK `signal_quality_check`	—	Indicates the signal quality seen by the device.
SVA_ALERT `sva_alert`	—	Indicates if a significant volume anomaly was detected that needs to be investigated (1 = investigate, 0 = no issue).

Internal Configuration and Device Management Variables

Variables used for device control, status monitoring, and remote management.

Variable Name `API Label`	Unit	Description
CLOSE_VALVE `close_valve`	—	Control variable for the valve (0 = open, 1 = closed).
CONFIRM_STATUS `confirm_status`	—	Acknowledges and confirms the current device status.
DEVICE_ALERT `device_alert`	—	Indicates that the device requires attention.
DEVICE_MISSED_UPDATE_BIT `device_missed_update_bit`	—	Set to 1 if the device has not sent a message in the past 30 minutes.
DEVICE_OFFLINE_BIT `device_offline_bit`	—	Set to 1 if the device has missed an update and DEVICE_MISSED_UPDATE_BIT is already set.
PENDING_VALVE_CLOSURE `pending_valve_closure`	—	Indicates that a valve closure command is pending execution.

Alert Related Variables

Variables that control and report alert conditions.

Variable Name `API Label`	Unit	Description
BATTERY_ALERT_ENABLED `battery_alert_enabled`	—	Controls whether battery alerts are sent on Ubidots (1 = on, 0 = off).
CONTINUOUS_FLOW_ALERT `continuous_flow_alert`	—	Indicates if the device is detecting a continuous flow (1) or not (0).
PINHOLE_LEAK_ALERT `pinhole_leak_alert`	—	Indicates if the device detected a pinhole leak (1) or not (0).
PIPE_BURST_ALERT `pipe_burst_alert`	—	Indicates if the device detected a pipe burst (1) or not (0) based on the latest flow rate value.
SEND_VALVE_ALERT `send_valve_alert`	—	Indicates if a valve alert needs to be sent for the device.
TEMPERATURE_ALERT_ENABLED `temperature_alert_enabled`	—	Controls whether temperature alerts are sent on Ubidots (1 = on, 0 = off).
TEMPERATURE_ALERT_HIGH_THRESHOLD `temperature_alert_high_threshold`	—	High temperature threshold for Ubidots alerts.
TEMPERATURE_ALERT_LOW_THRESHOLD `temperature_alert_low_threshold`	—	Low temperature threshold for Ubidots alerts.