Table of Contents
- RSSI
- RSSI_STATE_BIT
- WATER_CONSUMPTION_PER_UPDATE
- WATER_COST_PER_UPDATE
- WATER_METER_DISPLAY_TOTAL
- LEAK_VOLUME_PER_UPDATE
- LEAK_COST_PER_UPDATE
- LEAK_STATE_BIT
- ACTUAL_CONSUMPTION_PER_UPDATE
- ACTUAL_COST_PER_UPDATE
- LEAK_VOLUME_PERCENTAGE
- LOW_FLOW_PERCENTAGE
- LOW_FLOW_WATER_METER_READING
- HIGH_FLOW_WATER_METER_READING
- BATTERY_CAPACITY_REMAINING
- BATTERY_INDICATION_BIT
- DEVICE_OFFLINE_BIT
- TOTAL_FLOW_RATE
- GREY_AREA_FLOW_RATE
- RUN_OFF_WATER_FLOW_RATE
RSSI #
| API Label | Unit | Description |
|---|---|---|
| rssi | dBm | Signal strength based on the last received update from the device. |
RSSI_STATE_BIT #
| API Label | Unit | Description |
|---|---|---|
| rssi_state_bit | boolean | An indication of whether the signal is good or bad (1 = bad, 0 = good) |
WATER_CONSUMPTION_PER_UPDATE #
| API Label | Unit | Description |
|---|---|---|
| water_consumption_per_update | Liters | Water consumption per update as measured in 10 minutes intervals. (Water is measured in 10 minute intervals and is pushed to the cloud once every 6 hours, it is expected that the last 6 hours worth of data will be missing until the next 6 hour interval has lapsed) |
WATER_COST_PER_UPDATE #
| API Label | Unit | Description |
|---|---|---|
| water_cost_per_update | $ | Water cost per update as measured in 10 minutes intervals. (Water is measured in 10 minute intervals and is pushed to the cloud once every 6 hours, it is expected that the last 6 hours worth of data will be missing until the next 6 hour interval has lapsed) |
WATER_METER_DISPLAY_TOTAL #
| API Label | Unit | Description |
|---|---|---|
| water_meter_display_total | m3 | It is estimated to be accurate within 10% of the total water meter reading. |
LEAK_VOLUME_PER_UPDATE #
| API Label | Unit | Description |
|---|---|---|
| leak_volume_per_update | Liters | This parameter is calculated based on the assumption that water consumption is at its minimum in the early hours of the morning (1am to 5am). Therefore this parameter can be seen as the minimum continuous flow rate that was detected by the device within the last 24 hours and its assumed to be a leak. |
LEAK_COST_PER_UPDATE #
| API Label | Unit | Description |
|---|---|---|
| leak_cost_per_update | $ | This parameter is calculated based on the leak volume per update variable indicated above. It is calculated by multiplying the cost per m3 (received during device commissioning) with the leak volume per update. |
LEAK_STATE_BIT #
| API Label | Unit | Description |
|---|---|---|
| leak_state_bit | boolean | This parameter is based on the leak volume per update variable and indicates that the water usage value hasn't returned to 0 within the last 24 hours. |
ACTUAL_CONSUMPTION_PER_UPDATE #
| API Label | Unit | Description |
|---|---|---|
| actual_consumption_per_update | Liters | This parameter is calculated as the difference between the water consumption and leak volume. The variables value is calculated by subtracting the leak volume from the total water consumed. |
ACTUAL_COST_PER_UPDATE #
| API Label | Unit | Description |
|---|---|---|
| actual_cost_per_update | $ | This parameter is calculated as the difference between the water consumption cost and leak cost. The variables value is calculated by subtracting the leak cost from the total water cost. |
LEAK_VOLUME_PERCENTAGE #
| API Label | Unit | Description |
|---|---|---|
| leak_volume_percentage | % | The value for this parameter is calculated by dividing the volume of water leaked by the total water consumption. |
LOW_FLOW_PERCENTAGE #
| API Label | Unit | Description |
|---|---|---|
| low_flow_percentage | % | This variable is applicable to devices applied to a compound meter head. The value for this parameter is calculated by dividing the low flow water meters volume by the total water consumption. |
LOW_FLOW_WATER_METER_READING #
| API Label | Unit | Description |
|---|---|---|
| low_flow_water_meter_reading | m3 | This variable is applicable to devices applied to a compound meter head. It is estimated to be accurate within 10% of the low flow water meter heads reading. |
HIGH_FLOW_WATER_METER_READING #
| API Label | Unit | Description |
|---|---|---|
| high_flow_water_meter_reading | m3 | This variable is applicable to devices applied to a compound meter head. It is estimated to be accurate within 10% of the high flow water meter heads reading. |
BATTERY_CAPACITY_REMAINING #
| API Label | Unit | Description |
|---|---|---|
| battery_capacity_remaining | joules | This parameter is calculated by taking away the amount of energy used by the device from the total battery capacity. It is an estimate of the energy remaining in the battery pack. |
BATTERY_INDICATION_BIT #
| API Label | Unit | Description |
|---|---|---|
| battery_indication_bit | boolean | An indication of whether the battery strength is good or bad (1 = bad, 0 = good) |
DEVICE_OFFLINE_BIT #
| API Label | Unit | Description |
|---|---|---|
| device_offline_bit | boolean | Device offline indicator bit (1 = offline, 0 = online). |
TOTAL_FLOW_RATE #
| API Label | Unit | Description |
|---|---|---|
| flow_rate_per_update | LPM | The total water used within a given period. |
GREY_AREA_FLOW_RATE #
| API Label | Unit | Description |
|---|---|---|
| leak_rate_per_update_grey_area | LPM | The volume of water that could either be considered to be run-off or actual usage. |
RUN_OFF_WATER_FLOW_RATE #
| API Label | Unit | Description |
|---|---|---|
| leak_rate_per_update_min | LPM | The amount of water estimated to be run-off / leak water. |