Raw Data Variables #
The following raw data variables are available for the Aquana 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 |
|---|---|---|---|
| AMBIENT_TEMPERATURE | ambient_temperature | °C | The ambient temperature measured by the device during every leak update and heartbeat message. The temperature is measured with a resolution of 0.01 °C. |
| TOTAL_CONSUMPTION_M3 | total_consumption_m3 | m³ | The total water consumption measured by the device. |
| TURN_COUNT | turn_count | Total number of valve position changes since birth | |
| VALVE_STATUS | valve_status | Indicates the status of the valve. (0 = open, 1= closed, 2 = reduced, 3 = unknown) |
Internal Configuration and Device Management Variables #
The following Aquana 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 |
|---|---|---|---|
| AC_POWER_BIT | ac_power_bit | Indicates if the device is connected to an external power source or running on battery. (0 = battery power, 1 = external power source) | |
| BATTERY_INDICATION_BIT | battery_indication_bit | Indicates the state of the battery based on the battery voltage. (2 = good, 1 = average, 0 = bad) | |
| BATTERY_PERCENTAGE | battery_percentage | % | Latest averaged battery percentage level of the device. |
| BATTERY_VOLTAGE | battery_voltage | mV | Latest averaged battery level of the device. |
| BOOT_COUNT | boot_count | Total number of system boots since birth | |
| CHECKIN_TYPE | checkin_type | Type of check-in from the device. (0 = periodic, 1 = alert, 2 = retry, 3 = command ACK/other) | |
| COMMAND_ID | command_id | Application-level Command ID from the cloud. Once a command is received and executed, the subsequent uplinks will carry the last-executed-command ID in each payload as an execution acknowledgement and confirmation. Can be any number the cloud generates. Defaults to 0x00000001 after boot. | |
| 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. | |
| CONSUMPTION_SINCE_LAST_ TX_M3 | consumption_since_last_ tx_m3 | m³ | The volumetric consumption measured since the last transmission by the device in. |
| DATA_VERSION | data_version | Can be used to distinguish between a valve only and a valve + meter device. | |
| FRAME_COUNT | frame_count | This is the number of messages transmitted by the device. This counter will reset when the device is reset. | |
| 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 20 to show the quality of the signal, based on RSSI, SNR, number of missed messages and number of rejoins. (0 – 5 = good, 5 – 10 = average, 10 – 20 = 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. |
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) | |
| 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. | |
| TEMPERATURE_ALERT_ENABLED | temperature_alert_enabled | Controls whether temperature alert should be sent on Ubidots. (0 = off, 1 = on) | |
| TEMPERATURE_ALERT_ HIGH_THRESHOLD | ptemperature_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 |
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, 2 = reduced, 3 = sediment turn) |
