system-meta.proto#
version proto3
path system-meta.proto
package service-system-meta
Delivery#
Messages are published using AMQP 0.9.1 as protobuf 3 encoded messages with a unique topie per message type.
RtlsStation - Message Rates#
| Access Point Count | Associated Client Count | Report Only Associated | Report interval | Messages Received (per second) |
|---|---|---|---|---|
| 8 | 20 | Yes | 30s | 45 |
| 8 | 20 | No | 30s | 82 |
AMQP Topics#
| Message | Topic |
|---|---|
| Observation | OBSERVATION |
| AccessPointRadio | ACCESS_POINT_RADIO |
| WifiDevice | WIFI_DEVICE |
| WifiConnection | WIFI_CONNECTION |
| RtlsStation | RTLS_STATION |
Messages#
AccessPointRadio#
The AccessPointRadio message is the status of each attached radio to the access point. This is a scheduled event.
| Name | Type | Description |
|---|---|---|
timestamp | int32 | Unix timestamp of when the event occurs |
deviceId | string | Q2 Device Id - The target access point identifer |
channel | int32 | The channel the radio is listening |
name | int32 | The name of the radio |
noisefloor | int32 | The observed noisefloor of the radio |
power | int32 | The output power of the radio |
utilization | int32 | The overall utilization of the radio |
Example Output#
Observation#
An observation message is triggered when a device position changes This is an ondemand event, it will trigger on any combination of services in which the location of the device has changed.
| Name | Type | Description |
|---|---|---|
deviceId | string | Q2 Device Id |
lng | float | Longitude |
lat | float | Latitude |
timestamp | int32 | Unix Timestamp of when the event occurred |
userId | string | Q2 User Id - if a user is associated to the device this will be included |
Example Output#
RtlsStation#
| Name | Type | Description |
|---|---|---|
accessPointId | string | Q2 Device Id - The source access point that provided the information |
deviceId | string | Q2 Device Id - The target device observed |
rssi | int32 | The observed rssi of the device |
txPower | int32 | The observed transmission power |
channel | int32 | The wireless channel that the device was observed on |
noiseFloor | int32 | The noise floor of the target device |
dataRate | int32 | The data rate of the device |
radioBssid | string | The observed bssid used with the detecting the device |
monitorBssid | string | The bssid used with the detecting the device |
age | int32 | How long the device was seen for |
timestamp | int32 | The unix timestamp of when the device was observed |
userId | string | Q2 UserId - If an associated user is found this will be provided |
Example Output#
WifiConnection#
The WifiConnection message is a more detailed insight in the wireless connection between the access point and the device. This is a scheduled event.
| Name | Type | Description |
|---|---|---|
timestamp | int32 | Unix timestamp of when the event has occured |
signalDb | int32 | The signal db of the connection |
framesIn | int32 | The amount of incoming frames processed |
framesOut | int32 | The amount of outgoing frames processed |
frameRetriesIn | int32 | The amount of incoming frames the had to be resent |
frameRetriesOut | int32 | The amount of outgoing frames the had to be resent |
throughputIn | float | The amount of incoming throughput |
throughputOut | float | The amount of outgoing throughput |
capableSpeed | int32 | The detected capable speed |
associationStart | int32 | When the connection started |
associationTime | int32 | how long the connection has been active |
apMacAddress | string | The access points mac address |
macAddress | string | The devices mac address |
deviceId | string | Q2 Device Id - The devices id |
userId | string | Q2 User Id - The users id if found |
accessPointId | string | Q2 Device Id - The access point id |
Example Output#
WifiDevice#
The WifiDevice message is the status of each connected device to an access point. This is a scheduled event.
| Name | Type | Description |
|---|---|---|
timestamp | int32 | Unix timestamp of when the event has occured |
signalDb | int32 | The signal strength of the device |
capableSpeed | float | The detected capable speed |
connectionTime | int32 | The total time the device has been connected |
connectionStart | int32 | When the initial connection was created |
channel | int32 | What channel the device is connected on |
apMacAddress | string | The connected access point's mac address |
apIpAddress | string | This connected access point's ip address |
clientMatch | bool | is client match turned on |
essid | string | The essid of the connection |
infoTimestamp | string | The reported info timestamp from the access point |
ipAddress | string | The detected ip address of the device |
ip6Address | string | The detected ipov6 address of the device |
macAddress | string | The mac address of the device |
name | string | The detected name of the device |
os | string | The detected operating system of the device |
role | string | The role assigned by the access point |
type | string | The type of device assigned by the access point |
deviceId | string | Q2 Device Id - the devices id |
accessPointId | string | Q2 Device Id - the connected access point id |
userId | string | Q2 User Id - if found the associated users id |