v1

Raw Data Variables

These are the variables sent directly by the device.

Variable Name `API Label`	Unit	Description
AMBIENT_TEMPERATURE `ambient_temperature`	°C	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 `ambient_temperature_fahrenheit`	°F	Ambient temperature measured at the start of every two-hour sampling buffer. The temperature is measured with a resolution of 32.02 °F.
BAROMETRIC_PRESSURE `barometric_pressure`	hPa	Barometric pressure measured by the device.
BATTERY_PERCENTAGE `battery_percentage`	%	Latest averaged battery percentage level of the device.
BATTERY_VOLTAGE `battery_voltage`	mV	Latest averaged battery level of the device.
DEVICE_TIME `device_time`	ms	Device's time as an epoch timestamp in milliseconds GMT.
FIRMWARE_VERSION `firmware_version`	—	Current firmware version of the device.
FRAME_COUNT `frame_count`	—	Number of messages transmitted by the device since last reset.
GROUND_FLOOR_PRESSURE `ground_floor_pressure`	hPa	Pressure measured at the ground floor.
HUMIDITY `humidity`	%rH	Humidity measured by the device.
MIDDLE_FLOOR_PRESSURE `middle_floor_pressure`	hPa	Pressure measured at the middle floor.
PIPE_OUTER_DIAMETER `pipe_outer_diameter`	"	Pipe outer diameter, driven from the configuration tool.
RSSI `rssi`	—	Signal power (radio signal) from the device to the closest tower.
SNR `snr`	dBm	Signal-to-noise ratio from the device to the closest tower.
SPREADING_FACTOR `spreading_factor`	—	LoRaWAN spreading factor — a lower value means lower transmit power and more battery efficient operation.
STATUS `status`	—	Health status of the device (0 = healthy, -1 = reset unexpectedly).
TEMPERATURE_RATIO_INDEX `temperature_ratio_index`	—	Indexed ratio of current pipe ADC value vs rolling average, used to threshold water activity (0 = none, 1 = low, 2 = medium, 3 = high).
TOP_FLOOR_PRESSURE `top_floor_pressure`	hPa	Pressure measured at the top floor.
WATER_HARDNESS `water_hardness`	—	Water hardness value for the site.

Measurement, Consumption and Analytics Variables

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

Variable Name `API Label`	Unit	Description
AVERAGE_WATER_PRESSURE `average_water_pressure`	—	Average water pressure across ground, middle and top floors.
CONSUMPTION_COST_M3 `consumption_cost_m3`	$	Total cost of consumption (m³) for the selected time period.
CONSUMPTION_COST_WEEKLY `consumption_cost_weekly`	$	Total cost of consumption per device/riser over the past 7 days.
COST_PER_VOLUME `cost_per_volume`	$	Site-specific cost of water per m³.
ELEVATION `elevation`	m	Elevation of the device based on ambient temperature and pressure.
FLOW_ACTIVITY_METRIC `flow_activity_metric`	—	Binary indicator of flow (1) or no flow (0) for continuous leak detection and dashboard visuals.
FLOW_INDEX_HIGH `flow_index_high`	—	Binary indicator of high flow (1) or no flow (0).
FLOW_INDEX_MEDIUM `flow_index_medium`	—	Binary indicator of medium flow (1) or no flow (0).
FLOW_INDEX_LOW `flow_index_low`	—	Binary indicator of low flow (1) or no flow (0).
FLOW_INDICATOR_HIGH `flow_indicator_high`	—	Binary indicator of high flow (1) or no flow (0).
FLOW_INTERVAL_HIGH `flow_interval_high`	s	Seconds between each update for high volumetric flow calculation.
FLOW_INTERVAL_MEDIUM `flow_interval_medium`	s	Seconds between each update for medium volumetric flow calculation.
FLOW_INTERVAL_LOW `flow_interval_low`	s	Seconds between each update for low volumetric flow calculation.
INDEX_FLOW_TIME `index_flow_time`	s	Update time interval used for flow calculations.
LPI_ACTIVITY `lpi_activity`	—	Leak Probability Indicator — Activity. Represents the percentage of low, medium, and high activity seen in the last 24 hours. Higher continuous activity increases leak probability.
LPI_VOLUME_COST `lpi_volume_cost`	$	Estimated cost of leaked water based on the calculated LPI.
LPI_VOLUME_ESTIMATE `lpi_volume_estimate`	l	Estimated leak volume (litres) based on the calculated LPI.
MAXIMUM_AMBIENT_TEMPERATURE `maximum_ambient_temperature`	°C	Maximum ambient temperature measured in the past 24 hours.
MAXIMUM_CALIBRATION_RATIO `maximum_calibration_ratio`	—	Maximum calibration indexing ratio measured during the last calibration run.
MAXIMUM_PIPE_TEMPERATURE `maximum_pipe_temperature`	°C	Maximum pipe temperature measured in the past 24 hours.
MINIMUM_AMBIENT_TEMPERATURE `minimum_ambient_temperature`	°C	Minimum ambient temperature measured in the past 24 hours.
MINIMUM_CALIBRATION_RATIO `minimum_calibration_ratio`	—	Minimum calibration indexing ratio measured during the last calibration run.
MINIMUM_PIPE_TEMPERATURE `minimum_pipe_temperature`	°C	Minimum pipe temperature measured in the past 24 hours.
PIPE_AREA `pipe_area`	ft²	Calculated pipe area based on the measured pipe diameter during installation.
PIPE_PRESSURE `pipe_pressure`	Psi	Calculated pipe pressure based on measured pressure values and interpolated values.
PREDICTED_30_DAY_COST `predicted_30_day_cost`	$	Expected cost of consumed water over the next 30 days, calculated as a rolling average from the day of viewing.
PREDICTED_30_DAY_VOLUME `predicted_30_day_volume`	l	Expected volume of water (litres) over the next 30 days, calculated as a rolling average from the day of viewing.
SIGNAL_QUALITY_CHECK `signal_quality_check`	—	Signal quality seen by the device.
TEMP_RATIO_DURATION `temp_ratio_duration`	s	Time between each data point for the ambient-to-pipe temperature ratio variable.
VOLUME_FLOW `volume_flow`	l	Instantaneous volume estimation.
VOLUME_RISER_DAILY `volume_riser_daily`	l	Daily sum of volumetric consumption through the riser in litres.
VOLUME_RISER_FLOW `volume_riser_flow`	l	Instantaneous volume estimation per riser.
VOLUME_RISER_FLOW_M3 `volume_riser_flow_m3`	m³	Instantaneous volume estimation per riser in cubic metres.
VOLUME_RISER_WEEKLY `volume_riser_weekly`	l	Weekly sum of volumetric consumption through the riser in litres.

Internal Configuration and Device Management Variables

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

Variable Name `API Label`	Unit	Description
BATTERY_INDICATION_BIT `battery_indication_bit`	—	State of the battery (2 = good, 1 = average, 0 = bad).
DEVICE_ALERT `device_alert`	—	Indicates if any device alerts are triggered (1 = triggered, 0 = none).
DEVICE_MISSED_UPDATE_BIT `device_missed_update_bit`	—	Set to 1 if the device has not sent a message in the past 4 hours.
DEVICE_OFFLINE_BIT `device_offline_bit`	—	Set to 1 if the device has missed an update and DEVICE_MISSED_UPDATE_BIT is already set.
GET_BLE_ENABLE `get_ble_enable`	—	Indicates if Bluetooth is enabled (1) or disabled (0). Updated after configuration change.
GET_DEVICE_MODE_INDEX `get_device_mode_index`	—	Current operating mode: riser (0), POU (1), or logger (2).
GET_HEARTBEAT_INTERVAL_INDEX `get_heartbeat_interval_index`	—	Heartbeat interval: 6 h (0), 12 h (1), 24 h default (2), 48 h (3).
GET_HOT_WATER_PIPE `get_hot_water_pipe`	—	Pipe type: cold (0) or hot (1). Updated after configuration change.
GET_INDEX_HIGH_ACTIVITY_VALUE `get_index_high_activity_value`	—	Current high activity threshold value. Updated after configuration change.
GET_INDEX_MEDIUM_ACTIVITY_VALUE `get_index_medium_activity_value`	—	Current medium activity threshold value. Updated after configuration change.
GET_INDEX_LOW_ACTIVITY_VALUE `get_index_low_activity_value`	—	Current low activity threshold value. Updated after configuration change.
GET_TX_INTERVAL_INDEX `get_tx_interval_index`	—	Transmission interval for riser/logger data: 15 min (0), 20 min (1), 30 min (2), 1 h (3), 2 h default (4), 3 h (5), 6 h (6).
GET_VIBRATION_SENSOR_ENABLE `get_vibration_sensor_enable`	—	Indicates if the vibration sensor is enabled (1) or disabled (0). Updated after configuration change.
REJOINED_NETWORK_24_HOUR `rejoined_network_24_hour`	—	Indicates if the device rejoined the network in the last 24 hours (1) or not (0).
REJOIN_COUNT_SUM_MONTH `rejoin_count_sum_month`	—	Total number of network rejoins for the device in the current month.
RSSI_STATE_BIT `rssi_state_bit`	—	Normal (1) or low (0) signal strength indicator.
SET_BLE_ENABLE `set_ble_enable`	—	Sets Bluetooth enabled (1) or disabled (0) on next configuration update.
SET_DEVICE_MODE_INDEX `set_device_mode_index`	—	Sets the operating mode on next configuration update: riser (0), POU (1), logger (2).
SET_HEARTBEAT_INTERVAL_INDEX `set_heartbeat_interval_index`	—	Sets the heartbeat interval on next configuration update.
SET_HOT_WATER_PIPE `set_hot_water_pipe`	—	Sets pipe type to cold (0) or hot (1) on next configuration update.
SET_INDEX_HIGH_ACTIVITY_VALUE `set_index_high_activity_value`	—	Sets the high activity threshold on next configuration update.
SET_INDEX_MEDIUM_ACTIVITY_VALUE `set_index_medium_activity_value`	—	Sets the medium activity threshold on next configuration update.
SET_INDEX_LOW_ACTIVITY_VALUE `set_index_low_activity_value`	—	Sets the low activity threshold on next configuration update.
SET_TX_INTERVAL_INDEX `set_tx_interval_index`	—	Sets the transmission interval on next configuration update.
SET_VIBRATION_SENSOR_ENABLE `set_vibration_sensor_enable`	—	Enables (1) or disables (0) the vibration sensor on next configuration update (Riser mode only).
UPDATE_CONFIG `update_config`	—	Schedules a downlink configuration update after the next uplink (0 = do not update, 1 = update).

Alert Related Variables

Variables that control and report alert conditions.

Variable Name `API Label`	Unit	Description
BATTERY_ALERT `battery_alert`	—	Controls whether battery alerts are sent on Ubidots (1 = on, 0 = off).
ENABLE_FLOW_ACTIVITY_METRIC `enable_flow_activity_metric`	—	Enables (1) or disables (0) flow activity metric alerts.
ENABLE_HIGH_USAGE_ALERT `enable_high_usage_alert`	—	Enables (1) or disables (0) high usage alert messages.
ENABLE_LPI_ACTIVITY `enable_lpi_activity`	—	Enables (1) or disables (0) LPI activity threshold alerts.
ENABLE_LPI_ACTIVITY_MIN_ALERT `enable_lpi_activity_min_alert`	—	Minimum LPI activity threshold value used to trigger LPI alerts.
HIGH_USAGE_ALERT `high_usage_alert`	—	Binary indicator of high usage detected in the last 24 hours (1 = usage exceeded 60% of possible daily usage).
TEMPERATURE_ALERT `temperature_alert`	—	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.
TEMPERATURE_MEASUREMENT_UNIT `temperature_measurement_unit`	—	Controls temperature display unit (0 = °C, 1 = °F).