Table of Contents
Request Example:
https://cs.api.ubidots.com/api/v1.6/devices/demo_device/battv/values
RESPONSE #
{
"count": true,
"next": "https://cs.api.ubidots.com/api/v1.6/devices/demodevice/battv/values?page=2",
"previous": null,
"results": [
{
"timestamp": 1651104961024,
"value": 95.627,
"context": {},
"created_at": 1651104961706
},
{
"timestamp": 1650622777568,
"value": 95.627,
"context": {},
"created_at": 1650622778201
},
{
"timestamp": 1650553894266,
"value": 95.627,
"context": {},
"created_at": 1650553895137
},
]
}
Device API Labels #
API Label # |
Description # |
| ambient_temperature | 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. |
| battery_percentage |
| Latest averaged battery percentage level of the device. |
| device_offline_bit |
| Returns a boolean bit indicating whether the device is online or not. (1 = offline, 0 = online) |
| get_sensor_mode_index |
| Device will indicate which type of sensor is connected (0 = no sensor, 1 = leak sensor, 2 = flood sensor). This is indicated with every message sent from the device. |
| high_humidity_alert_bit |
| Indicates if the device measured humidity in excess of 80 %rH (0 = humidity is normal, 1 = humidity is high). |
| high_temperature_alert_bit |
| Indicates if the device measured ambient temperature in excess of 35 °C (0 = temperature is normal, 1 = temperature is high). |
| humidity |
| The humidity measured by the device during every leak update and heartbeat message. The humidity is measured with a resolution of 0.01 %rH. |
| liquid_detected_bit |
| Indicates if the device detected liquid, which can be a potential indication of a leak (0 = no liquid detected, 1 = liquid detected). |
| pressure |
| The barometric pressure measured by the device during every heartbeat message. The pressure is measured with a resolution of 0.1 hPa. |
| rssi |
| How good the signal power (radio signal) is from the device to the closest gateway. |
| sensor_detected_bit |
| Indicates if a sensor is connected to the device (0 = no sensor detected, 1 = sensor detected). |
| tamper_alert_bit |
| Indicates if the device detected that it was tampered with (0 = not tampered with, 1 = tampered with). |
API Label # |
Description # |
| ambient_temperature | 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. |
| battery_percentage |
| Latest averaged battery percentage level of the device. |
| device_offline_bit |
| Returns a boolean bit indicating whether the device is online or not. (1 = offline, 0 = online) |
| get_sensor_mode_index |
| Device will indicate which type of sensor is connected (0 = no sensor, 1 = leak sensor, 2 = flood sensor). This is indicated with every message sent from the device. |
| high_humidity_alert_bit |
| Indicates if the device measured humidity in excess of 80 %rH (0 = humidity is normal, 1 = humidity is high). |
| high_temperature_alert_bit |
| Indicates if the device measured ambient temperature in excess of 35 °C (0 = temperature is normal, 1 = temperature is high). |
| humidity |
| The humidity measured by the device during every leak update and heartbeat message. The humidity is measured with a resolution of 0.01 %rH. |
| liquid_detected_bit |
| Indicates if the device detected liquid, which can be a potential indication of a leak (0 = no liquid detected, 1 = liquid detected). |
| pressure |
| The barometric pressure measured by the device during every heartbeat message. The pressure is measured with a resolution of 0.1 hPa. |
| rssi |
| How good the signal power (radio signal) is from the device to the closest gateway. |
| sensor_detected_bit |
| Indicates if a sensor is connected to the device (0 = no sensor detected, 1 = sensor detected). |
| tamper_alert_bit |
| Indicates if the device detected that it was tampered with (0 = not tampered with, 1 = tampered with). |
API Label # |
Description # |
| battv |
| Battery voltage as millivolts. |
| battpercent |
| The percentage of battery remaining. Anything equal to or below 20 is considered as an alert. |
| device_healthy_b |
| Returns a bit indicating whether the device is healthy or not. (1 = healthy, 0 = unhealthy) |
| device_offline_bit |
| Returns a boolean bit indicating whether the device is online or not. (1 = offline, 0 = online) |
| leak_detected_b |
| A state used to indicate an urgent alert if water has been detected. (1 = alert:water present, 0 = no water detected) |
| liquid_detected_b |
| Signals that water has been detected by the sensor. (1 = water detected, 0 = no water detected) |
| measuredval |
| The raw ADC value measured for the leak / flood sensor measured by the device. A nominal value of 130 represents a dry sensor and 0 represents a completely wet sensor. |
| noiselevel |
| How good the radio signal to radio noise is from the device to the closest tower. |
| signallevel |
| How good the signal power (radio signal) is from the device to the closest tower. |
| status |
| Indicates the health status of the device.(0 = device is healthy, -1 = device has reset unexpectedly) |
| temperature |
| Ambient temperature detected by device. |