Raw Data Variables #
The following raw data variables are available for the Saya Valve. 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 |
|---|---|---|---|
| CONSUMPTION_SINCE_LAST_ TX_M3 | consumption_since_last_ tx_m3 | m³ | The consumption measured since the last transmission by the device. |
| CONSUMPTION_VOLUME_UNIT | consumption_volume_unit | Indicates the unit of total consumption for the device. (0 = m3, 1 = ft3, 2 = gal, 3 = unrecognised) | |
| INSTANT_FLOW_RATE | instant_flow_rate | The instantaneous flow rate measured by the device. The unit is displayed in the flow_volume_unit variable. | |
| TOTAL_CONSUMPTION_M3 | total_consumption_m3 | m³ | The total water consumption measured by the device. |
| WATER_TEMPERATURE_CELSIUS | water_temperature_celsius | °C | The water temperature measured by the device. The temperature is measured with a resolution of 0.01 °C. |
Internal Configuration and Device Management Variables #
The following Saya Valve 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_VOLTAGE | battery_voltage | mV | Latest averaged battery level of the device. |
| CF_PL_CHECK | cf_pl_check | Variable to indicate if a continuous flow event is underway and if the value stays 1 for 20 hours, then validation of the event will take place, to determine if it is a pinhole leak or normal continuous flow event. (0 =event stopped, 1 = event started) | |
| EXTERNAL_POWER_SOURCE_ CONNECTED_BIT | external_power_source_ connected_bit | Indicates if the device is connected to an external power source or running on battery. (0 = battery power, 1 = external power source) | |
| FLOW_RATE_UNIT | flow_rate_unit | Indicates the unit of flow rate for the device. (0 = m3/h, 1 = unrecognised) | |
| FRAME_COUNT | frame_count | This is the number of messages transmitted by the device. This counter will reset when the device is reset. | |
| PB_CHECK | pb_check | Variable to indicate if a pipe burst event is underway and so that the backend can act on the event, that is close the valves. (0 = event stopped, 1 = event started) | |
| PENDING_VALVE_CLOSURE | pending_valve_closure | Used as part of the Flow Based solution to ensure that the hot water valve closes first, followed by closure of the cold valve if the cold water triggered the pipe burst. | |
| RSSI | rssi | dBm | How good the signal power (radio signal) is from the device to the closest gateway.1 |
| SIGNAL_QUALITY_CHECK | signal_quality_check | Checking the signal quality seen by the device. The variable value ranges from 0 to 10 to show the quality of the signal, based on RSSI and SNR. (0 – 5 = good, 5 – 10 = bad) | |
| SNR | snr | dBm | (Signal to noise ratio) How good the radio signal to radio noise is from the device to the closest gateway. This is also used to determine signal quality and shouldn't be disregarded. 1 |
| SPREADING_FACTOR | spreading_factor | The spreading factor is determined by the device's proximity to the gateway since ADR (adaptive data rate) is implemented on the device. A lower spreading factor means that a lower transmit power is used and it is more battery efficient. | |
| UPLINK_TRIGGERING_TYPE | uplink_triggering_type | Some flow update messages contain extra information regarding the triggering type. The type will be explained in the context. | |
| VALVE_STATUS | valve_status | Indicates the status of the valve. (0 = open, 2 = closed, 3 = error) |
1 Additional connectivity variables will also be available on the device depending on the number of gateways installed on site. These variables will be of the form rssi-cs-gt-XXX and/or snr-cs-gt-XXX. These variables will indicate which gateways (XXXX) can be seen by the device and the associated signal strength.
Alert Related Variables #
The following variables are related to the alert functionality and status of the device:
| Variable Name | API Label | Unit | Description |
|---|---|---|---|
| BATTERY_ALERT_ENABLED | battery_alert_enabled | Controls whether battery alerts should be sent on Ubidots. (0 = off, 1 = on) | |
| CONTINUOUS_FLOW_ALERT | continuous_flow_alert | Indicates if the device is detecting a continuous flow. (0 = no continuous flow detected, 1 = continuous flow detected) | |
| DEVICE_ALERT | device_alert | Indicates that the device requires attention. | |
| DEVICE_MISSED_UPDATE_BIT | device_missed_update_bit | Indicates if the device has missed an update. Devices typically transmit a message every 30 minutes. If the device hasn't sent a message in the past 30 minutes, then this variable will be set to 1. | |
| DEVICE_OFFLINE_BIT | device_offline_bit | Indicates if the device is offline. Devices typically transmit a message every 30 minutes. If the device hasn't sent a message in the past 30 minutes and the DEVICE_MISSED_UPDATE_BIT is set to 1, then this variable will also be set to 1. | |
| INVESTIGATE_FLOW_ALERT | investigate_flow_alert | Variable to indicate if there is a potential continuous flow event that needs to be investigated. (0 = No need to investigate, 1 = Need to investigate) | |
| PINHOLE_LEAK_ALERT | pinhole_leak_alert | Indicates if the device detected a pinhole leak. (0 = no pinhole leak detected, 1 = pinhole leak detected) | |
| PIPE_BURST_ALERT | pipe_burst_alert | Indicates if the device detected a pipe burst based on the latest flow rate value. (0 = no pipe burst detected, 1 = pipe burst detected) | |
| SEND_VALVE_ALERT | send_valve_alert | Alert variable to send an alert if any of the valves failed to close in the case of a pipe burst | |
| TEMPERATURE_ALERT_ENABLED | temperature_alert_enabled | Controls whether temperature alert should be sent on Ubidots. (0 = off, 1 = on) | |
| TEMPERATURE_ALERT_ HIGH_THRESHOLD | temperature_alert_ high_threshold | Sets the high temperature threshold on Ubidots for alerts | |
| TEMPERATURE_ALERT_ LOW_THRESHOLD | temperature_alert_ low_threshold | Sets the low temperature threshold on Ubidots for alerts | |
| VALVE_CLOSE_ERROR_BIT | valve_close_error_bit | Indicates if there was an error closing the valve. (0 = no error, 1 = error in valve closure) | |
| VALVE_OPEN_ERROR_BIT | valve_open_error_bit | Indicates if there was an error opening the valve. (0 = no error, 1 = error in valve opening) |
Device Control Variables #
The following variables can be used to control certain functionalities of the device.
| Variable Name | API Label | Unit | Description |
|---|---|---|---|
| CLOSE_VALVE | close_valve | Control variable for the valve. (0 = open, 1 = closed) | |
| CONFIRM_STATUS | confirm_status | Control variable that can be used to force the device to send an update about its device status and more importantly its valve status. |
