Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property NameValue TypeDescriptionAlways Present
typeStringDefines packet type (e.g.: location)Yes
projectIdNumberThe project identifier this location was generated forYes
idStringThe unique identifier for the device (beacon) being trackedYes
macStringThe mac address of the device being trackedYes
floorNumberNumberThe floor number this location is determined to be on.Yes
deviceNameStringThe name of the deviceYes
latitudeNumberLatitude value (example: 25.774489)Yes
longitudeNumberLongitude value (example: -80.195160)Yes
altitudeNumberAltitude value in (tbd)Yes
varianceXNumberThe uncertainty in square meters of the X axisYes
varianceYNumberThe uncertainty in square meters of the Y axisYes
varianceZNumberThe uncertainty in square meters of the Z axis.Yes
varianceNumberThe uncertainty distance of the location. Example.. Use this for map display of variance circle.Yes
locationStringCombined latitude, longitude valuesYes
batteryNumberThe battery level of from the latest scan data. If we have not received a battery yet sample the value will be zero.Yes
timestampStringThe ISO 8601 format of the timestamp of when the packet was received by the Cloud in UTCYes

...

Code Block
languagejs
titleLocation Packet
{
    "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.  

...

  1. WebSocket Client:  A reference implementation can be found here:  https://github.com/bluzone/consumer-service
  2. A project on the Bluzone Portal:  https://bluzone.io
  3. The Web API Token from the project.
  4. The URL to the Location Stream endpoint:  https://bluzone.io/portal/consumer/location

 

 

 

...