Follow

Presence Northbound Notifications

Presence notification is a mechanism that sends information related to the presence of client devices at different sites of a business space to a destination address. This information can either be viewed on the Cisco CMX Cloud dashboard or used to build customer dashboards, reports or engagements. For instance, the information can display the most popular sites of the business space.

Types of Notifications

Received Signal Strength Indicator (RSSI) is a measurement of how well a wireless client can hear an access point. This is extracted from RSSI messages sent by the client to access points. Higher the RSSI value, better the signal. 

You can configure the triggering of Presence notifications based on the proximity of the wireless client device with respect to access points and sites.  (A business enterprise on Cisco CMX Cloud may be spread across multiple sites, each site comprising of one or more access points.)

Using the RSSI reports sent to access points, Cisco CMX Cloud can calculate the location of the client device, and hence the site at which a client device is currently residing at.  The client device is hence a passerby of this site.

When the client device continues its presence in a site, by either associating with a WiFI network OR simply crossing a threshold of RSSI value and dwell time, the client device state changes from passerby to visitor of the site.

  • Passerby Detected: The client device is detected as a passerby of a site.
  • Passerby Became Visitor: The client device state changes from passerby to visitor. This can happen when a client device is associated with a WiFI network, OR simply crosses a threshold of RSSI value and dwell time.
  • Visitor Went Away: The client device is no longer a visitor of a site.  This happens either when the RSSI of the client device falls below a configured value or a DISCONNECT message is received for the specific client device.
  • Device Absence: The client device has been absent for a predefined period of time.  The Cisco WLC has not sent any messages about this MAC Address for a minimum of twenty minutes.
  • Site Entry Change: The client device classified as either a passerby or a visitor of one site is now reporting a higher RSSI at a different access point belonging to a different site.

How to Configure a Presence Notification

  1. Log in to the Cisco CMX Cloud Web UI, and click Manage->Notifciations->New Notification.
  2. In the Create New Notification page that is displayed,  enter a name and select a value from the Type drop-down list. 
  3. In the Conditions field, enter the name of the site only if the notification is site specific.  If the notification is meant for all sites, you can leave the field blank. (Caveat: The site name is not verified.  Ensure that the site name is spelt correctly).
  4. In the Receiver field, configure the destination URL where the notification must to be sent to. To do this, select a protocol from the http/https drop-down list. Enter a host IP address, a port number, and API path. For example, http://10.19.28.160:8888/api. Note:  The destination URL receives a POST notification.
  5. Click MAC Hashing ON/OFF if you want to enable or disable MAC scrambling. Enable this feature to mask MAC addresses.   
  6. If MAC Hashing is enabled, enter a secret value that is used as the Hash Key.
  7. Select JSON or XML from the Message Format drop-down list.

How to Edit, Delete, Enable/Disable or View Details of a Configured Notification

  1. Log in to the Cisco CMX Cloud Web UI, and click Manage->Notifciations.
  2. Click Edit, Delete to edit or delete a notification.
  3. Enable or Disable a notification using the corresponding checkbox.
  4. Click Details to view the following details of a notification for the past fifteen minutes:
    1. Total Notifications Count: Total number of notifications sent
    2. Acknowledged Count: Total number of notifications successfully received and acknowledged by the remote receiver.
    3. Unacknowledged Count: Total number of notifications unacknowledged by the remote receiver.
    4. Last Successful Notification Sent: The timestamp of the last successful notification.
    5. Latency: Mean latency of notifications in milliseconds.

 

Sample Notification Payloads

Passerby Detected

{"notifications":[{"notificationType":"passerbydetected","subscriptionName":"Visitor Notification","entity":"WIRELESS_CLIENTS","deviceId":"00:00:1a:15:46:51","lastSeen":"2016-11-08T19:25:59.966+0000","accountId":"test","apMacAddress":"c8:f9:f9:1a:69:e0","siteName":"8.3 WLC","siteId":"1473570555936","status":"PASSERBY","ipAddress":null,"ssid":null,"siteChanged":false,"previousSiteId":null,"previousSiteName":null,"previousApMacAddress":null,"rssi":-65,"timestamp":1478633159966}]}

Passby Became Visitor

{"notifications":[{"notificationType":"passerbybecamevisitor","subscriptionName":"Visitor Notification","entity":"WIRELESS_CLIENTS","deviceId":"88:53:2e:3c:a3:f7","lastSeen":"2016-11-15T00:28:22.354+0000","accountId":"test","apMacAddress":"3c:ce:73:39:63:50","apName":"CloudTest-AP2","siteName":"AP2 Site","siteId":1478189850444,"status":"VISITOR","rssi":-65,"controller":"10.22.244.30","notificationId":"59-1479169702354","ipAddress":null,"ssid":null,"timestamp":1479169702354}]}

Visitor Went Away

{"notifications":[{"notificationType":"visitorwentaway","subscriptionName":"Went Away","entity":"WIRELESS_CLIENTS","deviceId":"00:18:de:4b:ba:1d","lastSeen":"2016-11-15T00:24:58.408+0000","accountId":"test","apMacAddress":"3c:ce:73:39:63:50","apName":"CloudTest-AP2","siteName":"AP2 Site","siteId":1478189850444,"status":"PASSERBY","rssi":-57,"controller":"10.22.244.30","notificationId":"59-1479169498408","timestamp":1479169498408}]}

Device Gone

{"notifications":[{"notificationType":"devicegone","subscriptionName":"Device Gone Notif","entity":"WIRELESS_CLIENTS","deviceId":"00:00:56:74:e9:b9","lastSeen":"2016-11-08T23:59:13.726+0000","accountId":"test","apMacAddress":"c8:f9:f9:1a:69:e0","siteName":"AP2 Site","siteId":"1478189850444","status":"GONE","rssi":-88,"timestamp":1478649553726}]}

Site Entry Change

{"notifications":[{"notificationType":"siteentrychanged","subscriptionName":"Site Change","entity":"WIRELESS_CLIENTS","deviceId":"e0:b9:a5:a1:d0:3d","lastSeen":"2016-11-15T00:28:58.356+0000","accountId":"test","apMacAddress":"3c:ce:73:39:63:50","apName":"CloudTest-AP2","siteName":"AP2 Site","siteId":1478189850444,"status":"PASSERBY","rssi":-72,"controller":"10.22.244.30","notificationId":"75-1479169738356","previousSiteId":1473570555936,"previousSiteName":"8.3 WLC","previousApMacAddress":"c8:f9:f9:1a:69:e0","timestamp":1479169738356}]}

Payload Attribue Descriptions

The table below describes attributes that are common to all notification payloads:

Attribute Content

Value

Example
notificationType One of the 5 notification types

passerbydetected

passerbybecamevisitor

visitorwentaway

deviceabsence

siteentrychange

 

subscriptionName

Use configured notification name   Visitor Notification

entity

Only "WIRELESS_CLIENTS" WIRELESS_CLIENTS  

deviceId

Client Device MAC address  

88:53:2e:3c:a3:f7

lastSeen

Human readable time stamp  

2016-11-15T00:28:22.354+0000

accountId

Tenant TLD   qeeuwu

apMacAddress

Reporting AP MAC address  

3c:ce:73:39:63:50

apName

Reporting AP name  

CloudTest-AP2

siteName

Site name  

8.3 WLC

siteId

Site ID which is used internally  

1478189850444

status

Client state

PASSERBY

VISITOR

CONNECTED

GONE

 

rssi

RSSI reported last time in dBm   -65

controller

Controller IP address  

10.22.244.30

notificationId

Internal unique ID  

59-1479169702354

timestamp

Binary time stamp  

1479169702354

The following table describes the attributes of the Passerby Became Visitor notification.

Attribute

Content Value Example

ipAddress

IP Address of client device Only available for connected client 10.30.2.14

ssid

SSID of the client device connected to Only available for connected client alpha

The following table describes the attributes of the Site Entry Change notification.

Attribute

Content Value

Example

previousApMacAddress

Previous AP MAC address AP name before the change

c8:f9:f9:1a:69:e0

previousSiteId

Previous site ID site ID before the change

1473570555936

previousSiteName

Previous site name site name before the change

8.3 WLC

0 Comments

Please sign in to leave a comment.