🚧

Note

The Streaming API encoded message must be first decoded using CloudEvents proto file before decoding using the event specific proto file below

Endpoint

Connect to the following WebSocket endpoint to receive Location Analytics events:

wss://<host>/network-services/v1alpha1/rssi-events

Ensure that you replace host value with your Central Base URL. Please check out our Getting Started guide for more information.

Proto File

Event messages published by Central are encoded using Google Protocol Buffers and sent over the WebSocket connection in serialized form.

To deserialize these messages, clients must use the following .proto file, which defines the schema used by Central when encoding the Location Analytics Events payloads.

syntax = "proto3";

package network_services.location_analytics.v1alpha1;

message ClientRssi {
  optional string client_mac = 1;
  optional string ap_serial = 2;
  optional string ap_mac = 3;
  optional string radio_mac = 4;
  optional int32 rssi_val = 5;
  optional bool associated = 6;
  optional string assoc_bssid = 7;
  optional uint32 age = 8;
  optional uint32 noise_floor = 9;
  optional string ap_ip = 10;
  optional string ap_name = 11;
}

enum FirmwareVersion {
  FIRMWARE_VERSION_UNSPECIFIED = 0;
  FIRMWARE_VERSION_CLIENT_8X_RSSI = 1;
  FIRMWARE_VERSION_CLIENT_10X_RSSI = 2;
}

message RssiEvent {
  optional FirmwareVersion firmware_version = 1;
  optional ClientRssi raw_rssi = 2;
  optional ClientRssi proximity_rssi = 3;
}

Supported Event Types

Location Analytics supports multiple event types. These values can be used when filtering events at subscription time.