Field | Description | Data Type |
|---|
data
| Array of hardware sensor models. | Array of Hardware Sensor Models (see below) |
included
| Included relationships. | Building
Floor |
links
| Pagination links. | Links |
Hardware Sensor Model
Field | Description | Data Type |
|---|
id
| Unique identifier for the VergeSense hardware sensor. Ex: W00-123 | String
|
type
| sensor
| String
|
attributes.model
| VergeSense hardware model. Ex: L302, E105 | String
|
attributes.firmware
| Firmware version of the sensor (if available). | String
|
attributes.mac_address
| MAC address of the sensor. | String
|
attributes.state
| Current lifecycle state of the sensor. Can be one of the following:
pre_install
installed
partitioned
verified
operational
flagged | String
|
attributes.coordinates
| The latitude and longitude of the sensor location, if it exists. If it does not exist, this value will be null. This is an example of the result "coordinates": {
"lat": 11.1111,
"lng": 22.2222
}
| Object
|
attributes.network.status
| Current network status of the sensor. Can be one of the following:
online - the sensor has sent a report in the past hour
intermittent - the sensor has not sent a report in the past hour
offline - the sensor has not sent a report in the past 3 hours
asleep - the sensor is in a scheduled non-reporting state to save battery | String
|
attributes.network.last_message_timestamp
| Timestamp in UTC of last received sensor message. | String
|
attributes.battery.status
| Current battery health of the sensor. Can be one of the following:
healthy - over 6 months estimated remaining life
replace_soon- less than 6 months estimated remaining life
replace_now - less than 2 months estimated remaining life | String
|
relationships.building
| The building that the sensor is located within. Building details included in the included top level response key. | Object
|
relationships.floor
| The floor that the sensor is installed on. Floor details included in the included top level response key. | Object
|
