...
Property Name | Value Type | Description | Always Present |
---|---|---|---|
type | String | Defines packet type (e.g.: location) | Yes |
projectId | Number | The project identifier this location was generated for | Yes |
id | String | The unique identifier for the device (beacon) being tracked | Yes |
mac | String | The mac address of the device being tracked | Yes |
floorNumber | Number | The floor number this location is determined to be on. | Yes |
deviceName | String | The name of the device | Yes |
latitude | Number | Latitude value (example: 25.774489) | Yes |
longitude | Number | Longitude value (example: -80.195160) | Yes |
altitude | Number | Altitude value in (tbd) | Yes |
varianceX | Number | The uncertainty in square meters of the X axis | Yes |
varianceY | Number | The uncertainty in square meters of the Y axis | Yes |
varianceZ | Number | The uncertainty in square meters of the Z axis. | Yes |
variance | Number | The uncertainty distance of the location. Example.. Use this for map display of variance circle. | Yes |
location | String | Combined latitude, longitude values | Yes |
battery | Number | The battery level of from the latest scan data. If we have not received a battery yet sample the value will be zero. | Yes |
timestamp | String | The ISO 8601 format of the timestamp of when the packet output from the Cloud in UTC | Yes |
calculatedTimestamp | String | The ISO 8601 format of the first packet received at server used to produce location | Yes |
maxTimestamp | String | The ISO 8601 format of the last packet received at server used to produce location | Yes |
windowCount | Number | The number of packets included in the location calculation | Yes |
Example Packets
Note: Properties not supported by the example packet type are omitted. Fields defined above as "Always Present" should never be null, other fields may be null.
...
Code Block | ||||
---|---|---|---|---|
| ||||
{ "altitude": 2.3687698831781745, "battery": 3630, "calculatedTimestamp": "2017-12-15T17:06:13.793Z", "maxTimestamp": "2017-12-15T17:06:16.793Z", "windowCount": 10, "deviceName": "bvTiTag", "floorNumber": 1, "id": "6253758190942573046", "latitude": 26.205612363949143, "location": "26.205612,-80.138235", "longitude": -80.13823502660985, "mac": "01:fa:b5:26:24:cf:b2", "projectId": 8, "timestamp": "2017-12-15T17:06:16.555687791Z", "type": "location", "variance": 0, "varianceX": 0, "varianceY": 0, "varianceZ": 0 } |
...