API

Introduction

KloudInsights provides an easy way to connect with third-party applications through its Application Programming Interface (API). This documentation will guide you through the process of creating and testing APIs in KloudInsights.

Create a new API key on KloudInsights.

1. Log in to the KloudInsights.
2. Navigate to Settings > API keys

3. To create a new API key, click on the +New API Key button and enter a description in the ensuing popup window. Next, select the appropriate roles and click on the Add key button to finalize the process.

Test your API

1. Click on the API Docs button located in the API section.

2. In the window that opens, you can test the API you have created using the relevant tag.

You have successfully created and tested an API in KloudInsights. This API can now be used to connect KloudInsights with other third-party applications, enhancing its functionality and integration capabilities.

Integrating with KloudManage

Step 1: Create a new API key on KloudInsights.

Refer the API document to know how to create and test an API.

Step 2: Integrate KloudInsights into the KloudManage

1. Log in to KloudManage.
2. Navigate to Settings > Third Party Integration.
3. In the window that opens, click on the edit button next to Analytics Platform Setup. Then fill in the following.

Platform Base URL: Enter your company’s KloudInsights URL here.

Platform Probe URL: Enter your company’s KloudInsights URL and port code. The port code is available from the admin.

For example: https://jameson3.kloudspot.com:47078

Authentication ID: The authentication ID can be obtained from the Insights API key section.

Authentication Secret: The authentication secret also be obtained from the Insights API key section.

4. In the event of a successful connection, you will receive a notification confirming the same. However, if the connection is not successful, please recheck Step 3 for verification.

5. Finally, click the Save Analytics Settings button to save the changes.

Step 3: Integrate KoludManage into the KloudInsights

1. Log in to KloudInsights.

2. Navigate to Configuration > Integration > Application.

3. Then scroll down and find the Kloudspot Device Management Settings section.

4. Then check the Enable button and enter the following:

• Portal Base URL: Enter your company’s KloudManage URL here.
• API ID: The API ID can be obtained from the Vision’s “ Third Party Integration” tab.
• API Secret Key: The API Secret Key can also be obtained from the Vision’s “ Third Party Integration” tab.

5. To get an API ID and Secret Key follow the steps below.

• Log into KloudManage.
• Then navigate to Settings > Third Party Integration. Here you can find the API ID and API Secret Key.

6. Finally, click the Save and Test button to save and test the connection.

7. In the event of a successful connection, you will receive a notification confirming the same. However, if the connection is not successful, please recheck Step 4 for verification.

Meraki Integration

About this Document

The purpose of this document is to display how these various solutions offered by Kloudspot can be integrated with Meraki.

It covers the following Kloudspot solutions that can be integrated.

• KloudPortal - Wi-Fi Guest Portal
• KloudCampaign - Campaign management
• KloudVision- Camera Integration
• KloudInsights - Event Wi-Fi & BLE receivers

Guest Portal and Campaign Management

Guest Portal

Captive Portals or Guest Portal is a multi-channel platform that enables you to connect and engage with visitors on your premises.

Guest portal screen page allows to create and design a customizable portal from scratch.

A sample of templates will be given as an option to choose to create a portal, layout will be available as a part of the template.

Following are the steps to configure the Guest Portal.

Captive Guest Portal Configuration

The captive portal is designed with following terms that are described below:

• Social Authentication

Needs authentication using social platforms as Facebook, Twitter, Linked, Google and Instagram.

• Email Authentication

It will ask the user for their Name and Email address to be able to Authenticate.

• SMS Authentication

It asks the user for their contact number and authenticate over a SMS.

• Multi device Token

A token is generated by the admin. User can use this token for authentication. One or multiple devices can be configured to use a single token.

• Username/Password

A guest user can be created by generating a unique username and password which is used for authentication. One or multiple devices can be configured using individual username/password combination.

1. Third party

Kloudspot can integrate with various third-party applications such as,

• ERP
• PMS
• POS

• Enter ‘Wireless’ à ‘Access Control’
• Choose the SSID to which the Captive portal will be configured.

• In Network Access, Association requirement, Select ‘Open (no encryption)’.
• In Network Access, Splash page, Select ‘Click-through’.

• In Network Access, Captive portal strength, Select ‘Block all access until sign-on is complete’
• In Network Access, Walled garden ranges, Enter the following domains:

_.kloudspot.com _ .facebook.com _ .facebook.net _ .akamaihd.net _ .fbcdn.net _ .atdmt.com _ .fbsbx.com _. twitter.com \* .twimg.com

• In the end Save changes.

• Enter Wireless, click on ‘Splash page’.
• Choose the SSID to which the captive portal will be configured.

• On ‘Splash page’, Custom splash URL, enter the url below;

https://mx01.kloudspot.com/cp/lacomer/index.htm

• Save changes and Exit.

For more details on how to create template and workflow driven portal, please refer to the relevant Kloudspot documentation.

Campaign Management

Kloudspot has a powerful workflow and policy driven campaign management solution centered mostly around Wi-Fi which offers both online and offline campaigns. These online campaigns can be created and managed using Captive Guest Portals. Creation of Captive guest portals is extremely easy using one of many templates supported by KloudCampaign Editor. KloudCampaign Editor can help guide the user to create a captive portal for the hardware they have deployed on the network.

For more details on how to create Campaigns, resources and configure dynamic policies and workflows, please refer to relevant Kloudspot documentation.

Meraki WiFi and BLE Event Receivers

The Kloudspot Analytics Engine can receive events from many types of Meraki Wi-Fi network.

One or more of event sources can be configured in the ‘Configuration - > System -> System Configuration’ screen.

Validate the Receiver URLs

Most of the receivers below ‘push’ to a specific URL. The protocol (HTTP/HTTPS) used varies depending on the source. We support both HTTP and HTTPS protocols using port 48082 and 48083. Refer to the specific data source below to determine the correct one to use.

If you have set a SSL certificate for the UI, that will be used instead of the self-signed one.

You can check access to both the HTTP and HTTPS urls with a ‘ping’:

Meraki Location Scanning API

To enable, the Meraki scanning API feed, follow the following steps:

1. First, follow the Meraki Standard instructions in the Meraki manual to set up the Scanning API on each Meraki account.

Location Analytics - Cisco Meraki

https://documentation.meraki.com/MR/Monitoring_and_Reporting/Location_Analytics

When enabling the API, set the following parameters:

• API Version : 2
• Post URL : https://{server}:48083/meraki/{name}
• Secret : for example - kloudspot12345678

For ‘{name}’ use a friendly alphanumeric label for the account.

• Next go to the Kloudspot Web UI and select ‘Cisco Meraki’ source in the Event Sources.
• Add an entry for each account (one is enabled by default) by clicking the ‘+’ sign.
• Enter the ’name’, ‘validation’ and secret’ from above for each account and click ‘Save’.

• Restart the stream processing job.

Integrating Meraki Cameras

Kloudspot supports integration with both RTSP (MV*2 cameras only) and MV Sense APIs. RTSP video stream from Meraki second generation camera’s can be streamed on-prem to Kloudspot vision controller for complex actionable use cases including Object detection, PPE, Mask, Social distancing, capacity counts and management, demographics, and fingerprinting.

Insights inferred from RTSP stream

For more details on KloudVision __ please check out the KloudVision document.

RTSP Integration

Please refer to Meraki documentation on how to setup Meraki RTSP configuration to stream live video

https://documentation.meraki.com/MV/Advanced_Configuration/External_RTSP

Also refer to Kloudspot documentation on how to setup Meraki RTSP configuration

Add cameras to the controller

MV Sense Integration

Step 1: Port number 6666(TCP) should be exposed to send Meraki camera payloads to the Insights.

Step 2: On UI, go to configurations and click on locations. Add the location (Region/site) where the cameras need to be deployed. Then navigate to the ‘Cameras’ section.

Step 3: Click on the ‘Cameras’, select the floor and the zone to which you want to add the camera and click on ‘add/edit a camera’ and then click on “Add a Camera” as shown in figure below.

Step 4: ‘Add/Update Cameras’ dialogue box needs to be filled with following information.

• Choose the vendor as ‘Third Party Camera’.

Enter the Unique Id of the Meraki Camera in ‘camera name’ section.

• Upload the image that is seen by the camera in “PNG” format in the “camera Image” section (Image size less than 2MB).
• Choose the grid resolution for the camera through the slider (default value is 50px) in the advance settings.
• Click on ‘Save’ to add the camera.

Adding widgets which use Meraki payloads to the dashboard

Step 1: On the homepage, navigate to ‘My Dashboards’ and select an existing dashboard or create a new dashboard.

Step 2: On the selected dashboard scroll down to the bottom and click on the ‘+’ symbol to add widgets to the dashboard.

‘Live Movement on a Camera Image’ Widget

Step 1: To add the ‘Live Movement on a Camera Image’ widget navigate to the ‘Camera’ section and select ‘Live Movement on a Camera Image’ widget.

Step 2: Select the location in which the camera is configured through the ‘Settings’ option by clicking on the gear symbol.

Step 3: Select the camera for which you want to see the live movements.

Step 4: Once the camera is selected the live movements of the objects are seen on the camera image in the form of rectangles. User can hover over the rectangle to get more details of the object.

‘Live user heatmap on floor camera image’ Widget

Step 1: To add the ‘Live User Heatmap On Floor Camera Image’ widget navigate to the ’Maps’ section and select ‘Live User Heatmap On Floor Camera Image’ widget.

Step 2: Select the location in which the camera is configured through the “Settings” option.

Step 3: Select the camera for which you want to see the heatmap.

Step 4: Clicking on the “Live Option” enables the user to view the live heatmap.

Step 5: Clicking on ‘history’, allows the user to view the heatmap for a specific day. The user can choose/pick any day from the date-picker.

Step 6: Clicking on the “Show Hour” checkbox enables the user to view the heatmap data for any hour of the day.

Step 7: A tooltip with the ‘count and dwell time’ can be seen when the user just hovers over the heatmap.

Mist Integration

• On the mist cloud, navigate to Organization -> Site Configuration

• Enable Webhooks and provide the URL – (KloudInsight deployment team should be able to provide this). It will be of format https://<host :[port]>/mist

Connected client webhook information (client-join)

To enable connected client data to be reported on KloudInsights, we need to enable “client-join” events on the Mist platform. One can get the Mist support team to enable this on the Mist platform or following instructions can be followed:

Please refer to the below document for further information:
https://api.mist.com/api/v1/docs/Site#webhooks
1. Please navigate to the below API to check the webhook id
/api/v1/sites/:site_id/webhooks

2. Add the “client-join” topic using the PUT operations for the below API:
   /api/v1/sites/:site_id/webhooks/:webhook_id/
   API payload:

{
“topics”: [ “client-join”, …. ]
}

KloudInsights configuration

Configure floor maps on the Insights using the same floor map image that is used on the Mist floor configuration. Make sure that the dimensions of the floor map match the dimensions of the floor map configured on the KloudInsights. To measure the dimensions of the floor map on Mist, you can use the Ruler (as show below).Configure floor maps on the Insights using the same floor map image that is used on the Mist floor configuration. Make sure that the dimensions of the floor map match the dimensions of the floor

• Location -> Live view

• Click on the floor and select ruler and draw line using the mouse

On each floor on Kloudspot you need to update Floor ID with the map Id of the floor on the Mist system. The map Id can be obtained from the URL in the live view (Location -> Live view) of the floor on Mist system.

Ex: below is the live view url and the highlighted one is the map Id.

[https://manage.mist.com/admin/?org_id=f130d5df- fbb9-4c4b-b94d-9e231e9451e6#!cliLocation/view/ 1960172f-09e0-4658-95c2-11837a409f07 /251d2099-f69e-46c9-8cee-9caf16c0080f](https://manage.mist.com/admin/?org_id=f130d5df- fbb9-4c4b-b94d-9e231e9451e6#!cliLocation/view/1960172f-09e0-4658-95c2-11837a409f07/251d2099-f69e-46c9-8cee-9caf16c0080f “https://manage.mist.com/admin/?org_id=f130d5df- fbb9-4c4b-b94d-9e231e9451e6#!cliLocation/view/1960172f-09e0-4658-95c2-11837a409f07/251d2099-f69e-46c9-8cee-9caf16c0080f”)

Then map Id is 1960172f-09e0-4658-95c2-11837a409f07, it should be updated on KloudInsights floor as below:

Also enable Mist data processing on the WIFI as below:

• Navigate to Configuration -> Event Processing -> WFI and make sure “Mist” is enabled as below

Kontakt.IO IOT Sensor Integration

Overview:

Kontakt.io are a provider of ‘smart’ BLE tags/sensors.

They provide two main types of device:

• “Smart Badge A mobile tag, typically used for people tracking. The tag has 2 buttons and an IR sensor able to sense a room number transmitted by Portal Beams in rooms.
• ‘Portal Beam’ A static typically attached to ceilings, able to report:
• Counts/locations of IR sensed occupancy data
• Environmental information (light intensity, air quality, temperature, pressure …)
• It also has an IR transmitter able to send a room number to smart badges

In addition, they can provide dedicated asset tags and WiFi - BLE ‘gateways’ called Portal Lights.

The BLE devices can all be used with their own BLE gateways or also with BLE gateways on Meraki and Cisco APs.

Regardless of the gateway type used the data arrives in the Kontakt.IO cloud and is then available for processing/forwarding.

The main functions they provide are:

• Occupancy – de-duplicated counts of devices and/or people in rooms using the IR sensors. They provide functionality to deduplicate counts between multiple Portal Beams and can track down to seat occupancy with suitable setup.
• Position – location of BLE tags based on trilateration. One extra function they provide is the ability to determine which room a badge is in based on the IR sensor on the badge ‘seeing’ a portal beam and getting a room number. Since this information is available from the Telemetry feed and we do our our trilateration, we don’t need this feed setup.

Data feeds containing this information along with a raw BLE tag telemetry stream can be sent from the Kontakt.io cloud to AWS Kinesis. Our integration sets up and subscribes to this Kinesis feed

Integration

We have integrated the following features, based on the Kinesis data streams:

• BLE tag presence and trilateration (similar to existing functionality).
• ‘Smart Tag` button and room number reporting support
• Portal Beam environmental data reporting.

In addition, we will follow up with IR based room occupancy reporting.

Configuration:

The following needs to be configured:

AWS:

• Create an AWS Kinesis stream.

• Create an AWS User with Access Key access and the following permission policy:

  { “Version”: “2012-10-17”, “Statement”: [ { “Sid”: “VisualEditor0”, “Effect”: “Allow”, “Action”: [ “kinesis:DeregisterStreamConsumer”, “kinesis:SubscribeToShard”, “kinesis:DescribeStreamConsumer” ], “Resource”: “arn:aws:kinesis:us-west-2:xxx:stream/test-stream/consumer/*” }, { “Sid”: “VisualEditor1”, “Effect”: “Allow”, “Action”: [ “kinesis:DeregisterStreamConsumer”, “kinesis:SubscribeToShard”, “kinesis:DescribeStreamConsumer”, “kinesis:PutRecord”, “kinesis:DescribeStreamSummary”, “kinesis:SplitShard”, “kinesis:MergeShards”, “kinesis:PutRecords”, “kinesis:GetShardIterator”, “kinesis:GetRecords”, “kinesis:DescribeStream”, “kinesis:ListStreamConsumers”, “kinesis:RegisterStreamConsumer”, “kinesis:ListTagsForStream” ], “Resource”: “arn:aws:kinesis:us-west-2:xxx:stream/test-stream” }, { “Sid”: “VisualEditor2”, “Effect”: “Allow”, “Action”: “kinesis:ListShards”, “Resource”: “arn:aws:kinesis:us-west-2:xxx:stream/test-stream” } ] }

• The BLE and IOT stream processing jobs need to be running on KloudInsights

Configure the integration in Configuration -> Event Processing -> IOT/Rules

You will need the AWS information, as well as your Kontakt.IO API key. When configurated the integration will set up the Kinesis channel in Kontakt.IO and configure it to send data.

Setup

The final step is to configure the badges, sensors etc in Kloudinsights:

1. Upload BLE Tag information in the ‘Devices’ screen – you can assign user names, emails etc.
2. Add the Portal Beams as environment sensors in Configuration -> Locations. Note that use the ‘name’ of the beam as the name of the EnvSensor.
3. Add the gateways as ‘APs’, using there MAC addresses.
4. For each mapped zone, add the ‘roomNumber’ from the location.csv as an external identifier.

Teams Application Setup

This document outlines the steps required to set up and install Kloudspot App for Microsoft Teams.

• Login to Kloudspot Analytics Platform

• Navigate to “API Keys” section accessible from the top menubar under the gears icon

• Create a new Key. Make a note of the API Client Key and API Client Secret. You will need this later

• Navigate to “Configuration => System” in the left navigation bar

• Click on “External Integrations” tab

• Scroll to the “Teams App Settings” section

• Click on “Add Bot”

• Make a note of the URL that is displayed on the form. The next few steps are performed on Microsoft Teams and you will return to Kloudspot Analytics Platform to enter the rest of the form fields

Open Microsoft Teams app on your desktop and Navigate to “Apps”

• Search for “App Studio” and proceed to install it

• Once installed, navigate to “Manifest Editor” tab on the app

• Click on “Create a new app”

• Jump directly to the “Capabilities” section and click on “Bots”

• Click “Setup” to create a new bot

• Provide any meaningful name for your Bot

• Check all the options under “Scope” and click on “Create bot”

• The newly created bot shows up displaying an ID under the name. Please make a note of the ID. You will need this later

• Click on “Generate new password” and make a note of the Password. You will need this later

• Under “Messaging Endpoint”, please enter the URL noted from the Kloudspot Analytics Platform and tab out. This will save the URL and display a green checkmark to confirm that the URL is saved

• Head back to Kloudspot Analytics Platform to the Teams App Settings section

• Provide a meaningful name for the App

• Enter the Bot ID and Bot Password noted in earlier sections

• Enter the API Client Key and API Client Secret

• Check the “Enabled” checkbox to enable this bot

• Choose one or more services that the Bot and click on “Save”

• The Kloudspot Analytics App for Microsoft Teams is now complete

• Click on “Download App” button to download the app (as a zip file)

• To install the app, Navigate to “Apps” on your Teams client and click on “Upload a custom app”

• Use the downloaded zip file

• The app can be installed for the current user or for an entire team. If choosing to install for an entire team, select “Add to a team” option and choose the team

• The app is successfully installed and ready to use

• Type “hello” to test. The bot should respond back with a welcome message.

Aruba IoT Integration

OVERVIEW

This guide describes steps necessary to set-up an IoT information feed from Aruba Instant or ArubaOS to KloudInsights.

RELATED DOCUMENTS

Aruba Instant documentation

• Aruba Instant User Guide.pdf (chapter “BLE IoT for Data Communication”)
• Aruba Instant CLI Reference Guide.pdf (chapter “iot transportProfile”)

ArubaOS documentation

• ArubaOS User Guide (chapter “IoT”)
• ArubaOS CLI Reference Guide.pdf (chapter “iot transportProfile”)
• ArubaOS API Guide (IoT Telemetry Interface)

REQUIREMENTS

Hardware

Aruba access points with integrated Bluetooth radios, or Aruba access points equipped with an Aruba USB Bluetooth radio (LS-BT1USB, JW315A orJW316A), are required for integration with KloudInsights.

Software

The integration uses the Aruba IoT Telemetry Interface to forward Bluetooth device information that is collected by the access points to KloudInsights.The Aruba IoT Telemetry Interface is available in Aruba Instant/ArubaOS 8.4.0.0 or higher.

• Minimum required software version: Aruba Instant/ArubaOS 8.4.0.0

CONFIGURATION

GENERAL INFORMATION

Configuration of the Aruba IoT Telemetry Interface is achieved via IoT profiles. The full configuration of IoT profiles is currently supported via CLI on Aruba Instant (partly configurable via GUI) and ArubaOS and is described in detail in the referenced product documentation within the chapter “Related Documents.".

REQUIRED INFORMATION

Ask your Kloudspot support contact for the following information:

• endpointUrl : the URL to send data to. It will be of the form https:// :/aruba-iot
• endpointToken : A token to validate the payload.

ARUBA INSTANT

This chapter describes the configuration and verification steps necessary to setup Aruba Instant for KloudInsights/

Set-up

• Enter ‘config mode’:

  config
  

• Enable the Bluetooth radio on an Aruba Instant AP in standalone mode or on all APs in an Aruba Instant cluster.

  ble mode beaconing
  

• Add a new IoT transport profile using the set-up information collected in chapter “REQUIRED INFORMATION”

  iot transportProfile kloudspot
  endpointID kloudspot
  endpointToken <token>
  endpointType telemetry-https
  endpointURL <endpointUrl>
  accessID kloudspot
  transportInterval 10
  rssiReporting average
  exit
  

• Enable the configured IoT profile.

  iot useTransportProfile kloudspot
  

• Apply the new configuration to the Aruba Instant AP/Cluster

  exit
  

  commit apply

Verification and Troubleshooting

Once the IoT profile has been configured and enabled, Aruba Instant immediately connects to the backend server and starts sending telemetry information.The commands below can be used to validate and troubleshoot the IoT configuration and connectivity to the backend server.

The “show ap debug ble-config” command should show the BLE Operation Mode as “Beaconing,” and the configured IoT profile should be shown.

d0:d3:e0:c3:3b:e0# show ap debug ble-config
-----------------------------------------------
---------- IOT Radio Profiles -----------------
-----------------------------------------------
Profile Name        : ble
Radio Instance      : Internal
Radio Mode          : BLE
BLE Mode            : beaconing scanning
BLE Console         : On
BLE Tx Power (dBm)  : 0
-----------------------------------------------
Note: No Zigbee service profiles configured.


Radio Configuration
-------------------
Radio Information     TI ONBOARD Internal BLE
-----------------     ------------------------
Radio Profile Type    --
Zigbee Supported      No
APB MAC Address       b4:52:a9:34:07:53
Operational Mode      Persistent Console (APB: Persistent Console)
Bundled BluOS Images  Bank A(/aruba/bin/UpgradeImage_AP_OAD-A_1.2-37.bin) Bank B(/aruba/bin/Beacon_AP_OAD-B_1.2-37.bin)
-----------------
Miscellaneous Configuration
---------------------------
Item                            Value
----                            -----
FIPS Mode                       No
Master IP                       127.0.0.1
BLE Ready                       Yes
APB Info Update Intvl (in sec)  88 (1763/1716)
BLE debug log                   Enabled
Message Selector                0xffff (APB: 0xffff)
AP USB Power Override           Disabled (-1)
Uplink Status                   Up (APB: -NA-)
APB Connection Status           0
Time Last Message to APB        1970-01-01 00:00:00
Log Levels Available            { All(0xfffff), Info(0x04), Warning(0x02), Error(0x01), Ageout(0x08), BMReq(0x10), FW-Upgrade(0x20), FW-UpgradeErr(0x40), CfgUpdate(0x80), CfgUpdateErr(0x100), Beacon(0x200), BcnTLV(0x400), BcnErr(0x800), APB(0x1000), Tags(0x2000), ZF(0x4000), AMON(0x8000), IOT-GW(0x10000), AT-HTTPS-JSON(0x20000), AT-WEBSOCKET-PROTOBUF(0x40000), DevMgmt(0x80000), None(0x00) }
Current Log Level               { 0x901e1 : Error(0x0001), FW-Upgrade(0x0020), FW-UpgradeErr(0x0040), CfgUpdate(0x0080), CfgUpdateErr(0x0100), IOT-GW(0x10000), DevMgmt(0x80000) }
Log Mac Filter                  None
Bundled BluOS Upgrade           Enabled (-1)
OTA FW BluOS Upgrade            Disabled
-----------------
BLE IoT Transport Context Config ID: 1
Last Sync Time: 2020-07-08 21:50:00
BLE IoT Profile List
--------------------
Profile Name    EndpointType     Interval   Content                   Filter Attribute  Cell Size  Att Threshold  Out Range Ageout  NamespaceFilter  URLFilter  Last Update           RssiReporting  environmentType  customFadingFactor  deviceCountsOnly  rtlsDestMAC        vendorFilter
------------    ------------     --------   -------                   ----------------  ---------  -------------  ----------------  ---------------  ---------  -----------           -------------  ---------------  ------------------  ----------------  -----------        ------------
kloudspot (51)  Telemetry Https  10 second  iBeacon(8),Eddystone(10)  NA                NA         NA             NA                NA               NA         2020-07-08 21:57:31   Average        office           NA                  FALSE             00:00:00:00:00:00
-----------------
Note: Uplink status is applicable only for Controller with Dynamic Console operational mode.
      For APBs of type LS-BT1USB, applied operational mode is Beaconing if ap system profile setting is either Persistent or Dynamic.
Note: Setting Message Selector value to 0x0 will cause the APB to function improperly. Use the knob with caution.
Note: Message Selector Bits: All(0xffff), V0 Scan (0x01), V1 Scan (0x02), UI Scan (0x04), Proximity Advert (0x08), IBeacon (0x10), Heartbeat-1 (0x20),  Heartbeat-UI (0x40), Upg Ack (0x80), Heartbeat-2 (0x200), Generic Scan (0x400), Generic Advert (0x800), Tag V1 Scan (0x1000), Tag V1 Advert (0x2000)

Use the “show ap debug ble-table all” command to verify if - and which - Bluetooth devices can be seen by the AP.

d0:d3:e0:c3:3b:e0# show ap debug ble-table all

BLE Device Table [Aruba Beacons]
--------------------------------
MAC                HW_Type   FW_Ver        Flags   Status  Batt(%)  RSSI  Major#  Minor#  UUID                                  Meas. Pow.  Tx_Power  Last Update  Uptime
---                -------   ------        -----   ------  -------  ----  ------  ------  ----                                  ----------  --------  -----------  ------
b4:52:a9:34:07:53  BT-AP303  OAD B 1.2-37  0x01a3  LIA     ONBOARD  --    0       0       4152554E-F99B-4A3B-86D0-947070693A78  -56         14        I:4s         1h:40m:0s

BLE Device Table [Generic]
---------------------------
MAC                Address Type  RSSI  Last Update  Device Class
---                ------------  ----  -----------  ------------
5f:a3:0d:7c:fe:17  Private R     -56   I:0s         --
63:15:26:e9:98:1a  Private R     -50   I:1390s      --
58:cb:c4:25:90:2d  Private R     -42   I:338s       --
7b:67:2f:f0:46:4e  Private R     -42   I:1545s      --
01:5e:6a:46:34:79  Private NR    -87   I:0s         --
47:ad:f8:ff:2e:7c  Private R     -57   I:1s         --
d9:93:af:72:2e:8c  Static        -74   I:1s         --
60:81:33:46:98:91  Private R     -51   I:1390s      --
67:85:77:bb:9a:e8  Private R     -42   I:0s         --
46:b9:a9:5d:ca:eb  Private R     -53   I:0s         --
4e:0d:d5:6e:1c:fd  Private R     -52   I:901s       --
79:27:3f:15:ef:23  Private R     -84   I:0s         --
a4:83:e7:9c:39:2c  Public        -53   I:0s         --
7d:3c:66:1a:37:36  Private R     -94   I:1843s      --
44:54:ed:3a:b3:37  Private R     -51   I:1801s      --
74:5b:84:08:b7:64  Private R     -54   I:901s       --
5a:a9:82:c3:81:69  Private R     -66   I:244s       --
5c:9c:95:47:c5:a0  Private R     -52   I:1801s      --
cc:04:b4:02:51:af  Public        -89   I:0s         --
24:67:63:23:53:d5  Private NR    -83   I:589s       --
46:33:09:75:eb:ee  Private R     -57   I:1s         --
48:da:99:74:83:f4  Private R     -56   I:0s         --
ac:23:3f:5e:67:ff  Public        -41   I:0s         iBeacon, eddystone

Beacons:1
Generic BLE devices:23
Total BLE devices:24


Note: Battery level for LS-BT1USB devices is indicated as USB.
Note: Uptime is shown as Days hour:minute:second.
Note: Last Update is time in seconds since last heard update.
Note: Meas. Pow. is the averaged RSSI (in dBm) when the iBeacon is calibrated.
Status Flags:L:AP's local beacon; I:iBeacon; A:Beacon management capable
            :H:High power beacon; T:Asset Tag Beacon; U:Upgrade of firmware pending
            :u:Beacon management update received

The commands “show ap debug ble-relay iot-profile” can be used to check the IoT profile configuration and server connection status of the IoT profile. The state should be displayed as “Ready.”

d0:d3:e0:c3:3b:e0# show ap debug ble-relay iot-profile

ConfigID                                : 1

---------------------------Profile[kloudspot]---------------------------
serverURL                               : https://smoke.kloudspot.com:48083/aruba-iot
serverType                              : Telemetry Https
deviceClassFilter                       : iBeacon,Eddystone
reportingInterval                       : 10 second
accessToken                             : 12345
clientID                                : kloudspot
rssiReporting                           : Average
environmentType                         : office
accessID                                : kloudspot
Server Connection State
--------------------------
TransportContext                        : Ready
Last Data Update                        : 2020-07-08 22:01:42
Last Send Time                          : 2020-07-08 22:01:43
Last Receive Time                       : 2020-07-08 22:01:43
TransType                               : Https

If the server connection status does not show “Ready,” use the command “show ap debug ble-relay report ” for more detailed connection logs for troubleshooting purposes.

d0:d3:e0:c3:3b:e0# show ap debug ble-relay report kloudspot

---------------------------Profile[kloudspot]---------------------------
Last Send Time: 2020-07-08 22:03:03

Sent report to Endpoint server (6s) ago: success 84, failed 0, last curl result code 200

Timeout(-1):20 Jobs added: 84

Server: https://<server>/aruba-iot with proxy: NA

Proxy username: NA, password: NA

Vlan Interface                          : Not Configured
Request to Server:
{"meta": {"version": 1}, "reporter": {"name": "d0:d3:e0:c3:3b:e0", "mac": "D0:D3:E0:C3:3B:E0", "ipv4": "10.90.37.235", "hwType": "AP-303", "swVersion": "8.6.0.4-8.6.0.4", "swBuild": "74969", "time": 1594245782}, "reported": [{"deviceClass": ["iBeacon", "eddystone"], "model": "iBeacon", "vendorName": "Apple", "mac": "AC:23:3F:5E:67:FF", "stats": {"adv_cnt": 7641266, "frame_cnt": 12, "uptime": 78288870}, "beacons": [{"eddystone": {"uid": {"nid": "00112233445566778899", "bid": "ABCDE23A00E1"}, "url": {"prefix": 1, "urlBytes": "6D696E65770012"}, "power": -24}}, {"ibeacon": {"uuid": "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0", "major": 0, "minor": 0, "power": -59}}], "rssi": {"avg": -41}, "BeaconEvent": {"event": "update"}, "lastSeen": 7, "sensors": {"voltage": 3.12, "temperatureC": 25.0}}]}

Last Curl logs:
....
Host: <server>
Content-Type: application/json
Authorization: Bearer 12345
Accept: application/json
Content-Length: 792

* upload completely sent off: 792 out of 792 bytes
< HTTP/1.1 200 OK
< Server: nginx/1.14.0 (Ubuntu)
< Date: Wed, 08 Jul 2020 22:03:03 GMT
< Transfer-Encoding: chunked
< Connection: keep-alive
< Keep-Alive: timeout=5
< Vary: Accept-Encoding, User-Agent
<
* Curl_http_done: called premature == 0
* Connection #0 to host smoke.kloudspot.com left intact

ARUBAOS

This chapter describes the configuration and verification steps necessary to set-up the IoT feed to KloudInsights on controller-based installations running ArubaOS.

• In controller based set-ups the BLE radios and IoT profiles have to be enabled per AP groups.
• Mobility Master vs. Standalone ControllerThe configuration steps for IoT profiles in a mobility master and a standalone controller set-up are the same except that in a mobility master scenario the configuration is done on the mobility master using the configuration hierarchy.

Set-up

• Enable the Bluetooth radio on the desired AP groups by setting the ble-op-mode to Beaconing in the corresponding AP system profile.

• The deviceClassFilter all is enabled by default. The deviceClassFilter all has to be explicitly set to disable-dIn to send only telemetry updates for ibeacon and eddystone devices to the backed.
• Add a new IoT transport profile using the set-up information collected in chapter “REQUIRED INFORMATION”.

• Enable the configured IoT profile.

• Apply the new configuration to the Aruba controller/mobility master.

Verification and Troubleshooting

Mobility Master vs. Standalone ControllerThe verification and troubleshooting steps for IoT profiles in a mobility master and a standalone controller set-up are the same except that in a mobility master scenario the verification and troubleshooting is done on the managed devices.

After the IoT profile has been configured and enabled the Aruba controller will immediately connect to the backend server and start sending telemetry information.

The commands below can used be to validate and troubleshoot the IoT configuration and connectivity to the backend server.

Check first to ensure that the access points’ BLE radios have been enabled and if the APs can receive data form the BLE devices. The show ap debug ble- config [ap-name|ip-addr|ip6-addr] command should show the BLE Operation Mode as “Beaconing” and the configured IoT profile should be displayed.

Using the show ap debug ble-table [ap-name|ip-addr|ip6-addr] all command verify if - and which - Bluetooth devices are seen by the access points.

Use the command show ble_relay iot-profile to check the IoT profile configuration and server connection status of the IoT profile. The state of the response should show “Ready.”

If the server connection status does not show “Ready,” use the command show ble_relay report report [] to obtain more detailed connection logs for troubleshooting.

EnGenius Configuration

Introduction

Services such as CRM tools, presence analytics, or location-aware services need to constantly collect data. EnGenius Cloud Access Points are sufficient for this. EnGenius Presence Service, continuously gathers data and sends the data to KloudInsights.

For this, the device needs to be registered on the EnGenius portal and KloudInsights. This document describes how to do this.

Step 1: Register a device in the EnGenius portal

Before adding the access point to KloudInsights, the device needs to be registered in the Engenius portal. Refer to the Engenius help files to learn how to register a new device.

https://docs.engenius.ai/cloud-white-papers/presence-service

The server location requested during registration will be in the given format.

https:/engenius/events

Step 2: Add a new AP to the Insights location

1. After configuring the device in the EnGenius portal, the next step is to add the device to Insights. To do so Log in to KloudInsights.

2. Then navigate to Configuration > Location > (Select location) > Access Points.

3. Select the floor and zone to which you want to add the access point from the newly opened window.

4. Then click the Add AP button from the Add/Edit an AP dropdown menu.

5. In the popup window that appears, add the Name, Mac address and Logo.

6. Then click the Save button to save the changes.

Step 3: Enable Engenius in KloudInsights

1. Data analysis is only possible if EnGenius data processing is enabled. To do so, follow the steps below.
2. Navigate to Configuration > Event Processing > Wi-Fi tab.
3. Enable EnGenius under Event sources and click the Save button.
4. Once enabled, you can use the information received from the Access point to create a variety of widgets.

Milesight MQTT Broker Settings

This document provides a detailed guide on configuring Milesight MQTT Broker settings for IoT event processing. The setup involves defining crucial parameters such as the MQTT host, port, username, password, and protocol, as well as specifying uplink topics for sensor data transmission.

Overview

In this configuration, sensors transmit data in the form of payloads on specific topics. These topics are identified and set up in the Milesight platform. Subsequently, they are integrated into the user interface for data visualization.

To learn more about Milesight MQTT, click on the links provided in the References section.

Accessing MQTT Broker Settings

1. Navigate to the Configuration > Event Processing > Iot/Rules > Milesight MQTT Broker Settings.

2. Then scroll down and find the section called Milesight MQTT Broker Settings. Add the following parameters to it.

Configure Parameters

1. Host: Enter the MQTT Host Name provided by your MQTT broker service.

2. Port: Specify the MQTT Port Number.

3. Username: Provide the MQTT Username associated with your account.

4. Protocol: Enter the protocol used for MQTT communication.

5. Password: Input the MQTT Password corresponding to the provided username.

6. Uplink Topics: In this section, define the uplink topics through which the sensor transmits data to MQTT. These topics play a crucial role in the data transmission process.

References

1. https://support.milesight-iot.com/support/solutions/articles/73000514280-how-to-connectlorawan- nodes-to-milesight-gateway

2. https://support.milesight-iot.com/support/solutions/articles/73000514278-how-to-connectmilesight- gateway-to-the-internet#h_01F285VSXMTK9C3SSFTFTY5WF4

3. https://support.milesight-iot.com/support/solutions/articles/73000514193-how-to-connectlorawan- gateway-to-mqtt-broker-

4. https://resource.milesight-iot.com/milesight/document/am300-series-user-guide-en.pdf

5. https://resource.milesight-iot.com/milesight/document/ug63-user-guide-en.pdf

Milesight Sensor Integration

Milesight Sensors Model Document

Kloudspot currently supports various Milesight sensors, which capture data across diverse environments and use cases. Below is a list of the supported sensors along with their models.

Sensors we support:

1. Asset Tracker -> AT101

2. AirQualitySensors -> AM319, AM307 and AM308-868M

3. Bathroom Occupancy -> VS330

4. Bathroom Odor -> GS301

5. Sound Level Sensor -> WS302

6. Smart Button -> WS101

7. AI Workplace Occupancy -> VS121

8. Smart Trash Bin -> EM310-UDL

9. Mini Leak Detector -> WS303

10. TOF People Counting -> VS133

Payload Structure

1. AM308 – 868M, AT101, VS133

{
    "applicationID": "1",
    "applicationName": "ATAPP",
    "data": "A2f3AARocw==",
    "devEUI": "24e124136e146343",
    "deviceName": "AT-DEMO-EM300-915M",
    "fCnt": 10265,
    "fPort": 85,
    "rxInfo": [
        {
            "altitude": 0,
            "latitude": 0,
            "loRaSNR": 13.8,
            "longitude": 0,
            "mac": "24e124fffef9ff86",
            "name": "Local Gateway",
            "rssi": -68,
            "time": "2024-10-16T06:59:39.413137Z"
        }
    ],
    "time": "2024-10-16T06:59:39.413137Z",
    "txInfo": {
        "adr": true,
        "codeRate": "4/5",
        "dataRate": {
            "bandwidth": 125,
            "modulation": "LORA",
            "spreadFactor": 7
        },
        "frequency": 923200000
    }
}

2. AM319, VS330, GS301, WS302, WS101, VS121, EM310-UDL, WS303

{
    "end_device_ids": {
        "device_id": "iaq-sensor-06",
        "application_ids": { "application_id": "digitaltwin-moro-dewa-poc" },
        "dev_eui": "24E124725D328458",
        "join_eui": "24E124C0002A0001",
        "dev_addr": "27FF009B"
    },
    "correlation_ids": [
        "gs:uplink:01JAA193DYZYF49MFKAW7Z1THJ",
        "rpc:/ttn.lorawan.v3.GsNs/HandleUplink:01JAA193DZC3N4552952HA247C",
        "rpc:/ttn.lorawan.v3.NsAs/HandleUplink:01JAA193MH44RE59R7CMMB4HAJ"
    ],
    "received_at": "2024-10-16T06:47:08.177947508Z",
    "uplink_message": {
        "session_key_id": "AZJl5qQ10106KtlNloYGUQ==",
        "f_port": 85,
        "f_cnt": 863,
        "frm_payload": "AXVSA2fuAARofgd9MAI=",
        "rx_metadata": [
            {
                "gateway_ids": {
                    "gateway_id": "infrax-indoor-gf-office",
                    "eui": "647FDAFFFE014B81"
                },
                "timestamp": 3666444163,
                "rssi": -104,
                "channel_rssi": -104,
                "snr": 5,
                "location": {
                    "latitude": 25.244458434563974,
                    "longitude": 55.28138549822969,
                    "altitude": 10,
                    "source": "SOURCE_REGISTRY"
                },
                "uplink_token": "CiUKIwoXaW5mcmF4LWluZG9vci1nZi1vZmZpY2USCGR/2v/+AUuBEIP/pdQNGgwI68K9uAYQ04a5zAMguK/oyNqp5gE=",
                "received_at": "2024-10-16T06:47:07.935741349Z"
            }
        ],
        "settings": {
            "data_rate": {
                "lora": {
                    "bandwidth": 125000,
                    "spreading_factor": 7,
                    "coding_rate": "4/5"
                }
            },
            "frequency": "868100000",
            "timestamp": 3666444163
        },
        "received_at": "2024-10-16T06:47:07.967707605Z",
        "consumed_airtime": "0.066816s",
        "network_ids": { "net_id": "000013", "tenant_id": "infrax" }
    }
}

WhatsApp Meta Integration

This document provides instructions on how to configure WhatsApp Meta Settings to enable notifications and message sending via Meta authentication.

Accessing WhatsApp Meta setting

1. Navigate to Configuration > Integration > Communication.

2. Within the opened window, scroll down until you locate WhatsApp Meta Settings.

3. Please provide the following information in the settings section:

   MetaBase URL

   Meta Token

   Meta Graph API Version

   Meta Messaging Product: Select WhatsApp

   Meta Phone Number ID

   Phone Number to Send From

   Send Test WhatsApp Message: This option is for testing purposes.

Creating a WhatsApp Template

1. Visit the debug page at: https://jameson1.kloudspot.com/#/debug.

2. Enter template name and sample message in the window that opens and save the template.

   Note: Provide the exact name that has been approved by Meta and enter the payload information.

Setting up Action Templates

1. Refer to the Action Templates section to learn how to add an action template.

2. Choose “WhatsApp” as the template type. Additionally, tick the template checkbox and select the WhatsApp template you previously generated.

3. If you wish to send a personalized message, select the “Text” checkbox.

Options for Cisco WLC Connections

The Kloudspot Analytics platform can be configured to request and receive client session data from Cisco Wireless Lan Controllers (WLC).

In order to do this, the platform needs to be able to connect to the WLC on port 16113. This is easy to achieve in an on-premises installation where the WLC and the Kloudspot Analytics platform are on the same network. The data receiver (‘Rcv’) in the Kloudspot Analytics platform connects directly to the WLC using port 16113 to subscribe for a data feed.

However, it can be difficult to set up this configuration when using Amazon Web Services or another cloud provider for the following reasons:

• It can be difficult to persuade network administration to implement the necessary firewall rules:

• It opens an attack surface whereby a 3rd party might potentially be able to disable the WLC with a Denial Of Service attack. Often this clashes with companies cyber security rules.

For this reason, it is possible to reconfigure the Kloudspot Analytics platform so that the data receiver (‘Rcv’) is positioned on-premises in a small VM and acts as a ‘proxy’ with all connections outbound from the company to AWS:

In this configuration, the receiver, inside the customer’s DMZ or data center connects to the WLC on port 16113 and then sends the received data to AWS on port 9092 using an TLS secured connection.

High Availability/Scalability

For scalability and high availability, the receiver can be configured in a N+1 configuration whereby the load can be shared across multiple receiver instances, with the ability to rebalance the workload on failure.

In order to use this functionality an Apache Zookeeper cluster needs to be setup. This is then used to elect a ‘leader’ of the available Receiver instances. The leader shares out the work to the group of available receivers. If the leader fails, a new leader is elected. If any member of the group fails, the leader will rebalance the work across the remaining members.

An existing zookeeper cluster can be used or the same VMs used for the receivers can also be used to provide the zookeeper functionality.

To set up a zookeeper cluster at least three VM instances on physically separate hardware are required. So, if the same VMs are used as receivers, this is the minimum configuration.

Receiver VM System Requirements

Each VM instance has the following hardware requirements:

• 8 GB RAM

• 4 core processor

• 50 GB SSD

WiFi/BLE Event Recievers

• Aruba ALE
• Aruba RTLS
• Cambium
• Cisco CMX
• Cisco Meraki
• Cisco WLC
• Huawei
• Kloudspot Event Receiver
• NEC QX
• Ruckus virtual SmartZone
• Ruckus Zone Director
• Xirrus XPS