...
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 the Cloud in UTC | Yes |
...
Code Block | ||||
---|---|---|---|---|
| ||||
{ "altitude": 6.642117096111178, "id": "10371225096882957496", "mac": "01:df:03:1b:ff:d3:2a", "latitude": 26.51778797917912, "location": "26.51778797917912, -80.07805554864944", "longitude": -80.07805554864944, "timestamp": 2015-07-06T20:03:33.909Z, "type": "location", "varianceX": 130.572249708236271697938520476767, "varianceY": 130.51133022296586511769351912090417, "varianceZ": 0.0, "variance": 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.
...
- WebSocket Client: A reference implementation can be found here: https://github.com/bluzone/consumer-service
- A project on the Bluzone Portal: https://bluzone.io
- The Web API Token from the project.
- The URL to the Location Stream endpoint: https://bluzone.io/portal/consumer/location
...