...
| 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 was received by 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 |
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": 62.6421170961111783687698831781745,
"battery": 3630,
"idcalculatedTimestamp": "103712250968829574962017-12-15T17:06:13.793Z",
"deviceName": "bvTiTag",
"macfloorNumber": 1,
"01:df:03:1b:ff:d3:2aid": "6253758190942573046",
"latitude": 26.51778797917912205612363949143,
"location": "26.51778797917912205612, -80.07805554864944138235",
"longitude": -80.07805554864944,
13823502660985,
"mac": "01:fa:b5:26:24:cf:b2",
"projectId": 8,
"timestamp": 2015"2017-0712-06T2015T17:0306:3316.909Z555687791Z",
"type": "location",
"varianceXvariance": 0.1697938520476767,
"varianceYvarianceX": 0.11769351912090417,
"varianceZvarianceY": 0.0,
"variancevarianceZ": 0.41206049561645275
} |
Using The Service
The following section assumes familiarity with working with WebSockets. Bluvision has made a sample client available on Github (https://github.com/bluzone/consumer-service). The sample client will connect to a WebSocket at the provided URL and dump contents to the console.
...