Kontakt.io Plugin + Cisco Spaces
Troubleshooting with Kio Cloud delivers the capability to capture a Portal Beam's real-time thermal image. From the thermal image, you can validate its field of view ensuring people detection is within frame. The thermal image is also helpful to determine if there are hot objects within its field of view that may have resulted in a false count. The below setup steps are required to be completed to perform this troubleshooting.
Examples of the thermal image captured by a Portal Beam during troubleshooting.
|
|
|
Important
Prior to starting the below steps, be sure the Portal Beam room occupancy setup for Cisco Spaces has been completed.
Once the following steps are complete, you can perform troubleshooting from the Kio Setup Manager mobile app.
-
Laptop with an internet connection.
-
Mobile device with Bluetooth on/enabled and an internet connection.
If you already have a Kio Cloud account, proceed to the next step.
To create a new account, from a web browser go to https://cloud.kontakt.io/register
If you’re located in the United Kingdom/Europe, go to https://cloud.uk.kontakt.io/register
A Kio Cloud account activation is sent to your email address. It may take a few minutes for the email to arrive. Please be sure to check your junk/spam folder. The email is sent from hello@kontakt.io.
This is a one-time setup for a Cisco Spaces account. Once this setup is complete, Kio Cloud performs a daily device synchronization. Additionally, real-time synchronization can be performed on-demand through Kontakt.io's Device Federation API.
-
Sign in to Kio Cloud > go to https://cloud.kontakt.io or for a UK account https://cloud.uk.kontakt.io.
-
From the upper-right corner, select your initials icon, select Security.
-
Copy and save the Server API Key. You'll need this in the subsequent steps.
-
Log in to the Cisco Spaces account where the Portal Beams have been claimed.
-
Go to IoT Services > Device Management.
-
From the top menu, select Devices > select the Mac Address of a device > from the Beacon Configuration section, select Advance Configuration > select Confirm.
-
From the Server API Key section, select Copy to clipboard. You'll need this API Key in the next step.
This will create the synchronization of devices between the two accounts - Cisco Spaces (source) and Kio Cloud.
Run the below POST command with the Kio Cloud and Cisco API keys as noted. The Response will include the unique Device Federation ID
Important
The below varies by the account location: US or UK.
url value:
US: api.kontakt.io
UK: dm-api.cloud.uk.kontakt.io
source value:
Cisco US: prod-edm
Cisco UK: prod-edu-eu
curl --request POST \ --url https://"US" api.kontakt.io "UK" dm-api.cloud.uk.kontakt.io/device-federations \ --header 'Accept: application/vnd.com.kontakt+json;version=10' \ --header 'Api-Key: KIO CLOUD API KEY' \ --header 'Content-Type: application/json' \ --data '{ "displayName": "User-Defined Reference Value", "source": "prod-edm or prod-edu-eu", "sourceApiKey": "CISCO DEVICE MANAGEMENT SERVER API KEY" }'
Response example:
You will need the "id" provided in the response in the next step.
{
"id": "DEVICE FEDERATION ID,
"displayName": "string",
"source": "string",
"sourceApiKey": "string",
"lastSync": "2023-07-25T11:58:12.246+0000",
"status": "NEW"
}
This step triggers a complete real-time synchronization - all of the Cisco Spaces Devices will be added to the Kio Cloud account.
Run the below POST command to perform the real-time synchronization.
Note
The Device Federation's "id" is included in path (URL)
curl --request POST \ --url https://"US" api.kontakt.io "UK" dm-api.cloud.uk.kontakt.io/device-federations/DEVICE FEDERATION ID/sync \ --header 'Accept: application/vnd.com.kontakt+json;version=10' \ --header 'Api-Key: KIO CLOUD API KEY'
Response example:
{
"jobKey": "string",
"status": "IN_PROGRESS",
"result": {
"added": 0,
"updated": 0,
"failed": 0,
"removed": 0,
"errors": [
"string"
]
}
}
The amount of time to complete the synchronization varies by quantity of devices. You can also verify the status of the synchronization by running the following command.
curl --request GET \ --url https://"US" api.kontakt.io "UK" dm-api.cloud.uk.kontakt.io/device-federations/DEVICE FEDERATION ID/sync \ --header 'Accept: application/vnd.com.kontakt+json;version=10' \ --header 'Api-Key: KIO CLOUD API KEY'
Response example:
Statuses: IN_PROGRESS, COMPLETED, NOT_FOUND, FAILED
{
"jobKey": "string",
"status": "IN_PROGRESS",
"result": {
"added": 0,
"updated": 0,
"failed": 0,
"removed": 0,
"errors": [
"string"
] }
}
You will need a digital floor plan image file. This image does not need to be the actual floor plan where the Portal Beams are located - it's an arbitrary image to allow assigning a Portal Beam to a location from the Kio Setup Manager app.
If you don't have a file readily available, you can download a sample floor plan file.
-
Sign into Kio Cloud > from the Launchpad, select Smart Location.
-
Add a Campus > Building > Floor with digital floor plan > draw one room.
Example below.
With all three setup steps complete, you can now troubleshoot the Portal Beam with the Kio Setup Manager app.