Beacon Payload Format

The beacon payload format uses JSON JavaScript Object Notation (JSON) and is aggregated per second (the default aggregation value). The following example shows an aggregated beacon payload.

{
  "gateway_euid": "EC:8C:A2:33:B6:30",
  "longitude": "-122.036346",
  "latitude": "37.36883",
  "altitude": "Floor 1",
  "timestamp": 1518421586,
  "meta_data":
    {
      "provider": "ruckus",
      "version": 1
    },
  "events": [
    {
      "rssi": "-51",
      "data": "010B20D304567AEFC3",
      "srData": "F01020304567AEBC3",
      "timestamp": 1518421585,
      "device_euid": "00:00:F9:10:E1:40:D4:F1"
    },
    {
      "rssi": "-55",
      "data": "01020304567AEFBC3",
      "timestamp": 1518421584,
      "device_euid": "00:00:F9:10:E1:40:D4:F1"
    }
  ]
}
Table 1. Beacon Payload Parameter Descriptions

Parameter

Type

Description

Optional

gateway_euid

String

Gateway MAC address which received the beacon packet

No

longitude1

String

Gateway Location Longitude

Yes

latitude1

String

Gateway Location Latitude

Yes

altitude1

String

Gateway Location Altitude

Yes

timestamp

Integer

Epoch timestamp, when the packet is sent to the vendor or connector

No

meta_data

Dictionary

Ruckus-related metadata

No

meta_data/provider

String

Provider name (Ruckus)

No

meta_data/version

Integer

Provider version (1)

No

events

List of Dict

Aggregated beacon content

No

events/rssi

String

RSSI of the beacon packet (extracted from the physical layer)

No

events/data

String (Hex)

Beacon data as-is received from the beacon source

No

events/srData

String (Hex)

Beacon srData as-is received from the beacon source

Yes

events/timestamp

Integer

Beacon timestamp when received by the IoT AP

No

events/device_euid

string

Device MAC address (8 bytes in length). First two bytes are reserved/proprietary

No

1These parameters can be configured per Gateway (IoT AP) from the vSZ controller.