Versions Compared

Key

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

...

Messages in the Streaming API are "flattened" for easier processing.  Consumers should parse the "packetType" property first and then handle the message accordingly. 

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 axisYes
locationStringCombined latitude, longitude valuesYes
timestampStringThe ISO 8601 format of the timestamp of when the packet was received by the Cloud in UTCYes

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.

...