...
Note: Not all packet types may be enabled for all projects, please contact customer support for more details.
| PacketType | Description | Status |
|---|---|---|
| sBv2 | Beeks V2 packet | Standard |
| iBeacon | iBeacon standard packets |
| Optional | ||
| sLight | Beeks light sensor packet | Optional |
| sSns | Beeks motion sensor | Optional |
| unknown | Raw BLE packets from generic devices | Optional |
Anatomy of a Packet
Messages in the Streaming API are "flattened" for easier processing. Consumers should parse the "packetType" property first and then handle the message accordingly.
| Property Name | Value Type | Description | Always Present |
|---|---|---|---|
| projectId | Number | The Project id of the Adapter and owner of this data. | Yes |
| adapterId | String | Unique identifier of the Adapter (BluFi) | Yes |
| adapterType | String | Defines the Adapter type (currently only BluFi) | Yes |
| version | String | Version of the message format | Yes |
| packetType | String | What type of data is being reported. | Yes |
| timestamp | String | The ISO 8601 format of the timestamp of when the packet was received by the Cloud in UTC | Yes |
| id | String | A unique identifier of the device where the BLE packet originated | No |
| time | Number | A timestamp relative to the device, useful for packet sequencing | No |
| battery | Number | The current voltage level of the device | No |
| temp | Number | The temperature observed by the device in Celsius (float value) | No |
| rssi | Number | Signal strength as observed by the Adapter | No |
| uuid | String | Standard iBeacon protocol UUID value | No |
| major | Number | Standard iBeacon protocol Major value | No |
| minor | Number | Standard iBeacon protocol Minor value | No |
| measuredPower | Number | Broadcast power as reported by the device | No |
| eventCounter | Array (Numeric) | Raw event data from motion sensor | No |
| xAccel | Number | Motion sensor accelleration on x axis | No |
| yAccel | Number | Motion sensor accelleration on y axis | No |
| zAccel | Number | Motion sensor accelleration on z axis | No |
| lums | Number | The lumens observed by the Light sensor | No |
| type | String | Raw BLE type found in an "unknown" packet type | No |
| raw | Array (bytes) | Raw BLE data encapsulated in a byte array | No |
| gid | String | GAT General Id, value depends on device implementation | No |
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.
...