Kontakt.io Kio Cloud + Portal Lights + Portal Beams
This guide provides step-by-step instructions to deploy a Kontakt.io footfall occupancy solution, enabling accurate measurement of people entering and exiting a building or floor place. This solution leverages both Kontakt.io Portal Lights that serve as the BLE to Wi-Fi gateway infrastructure and Portal Beams. Portal Beams are set to footfall mode and installed at entrances or interior spaces to count people as they pass through an invisible threshold line.
This guide is intended for those responsible for Kio Cloud deployment and device installation.
Topics in this article:
Deploying a Kontakt.io solution involves two main activities: setting up the Kio Cloud platform and installing Kontakt.io infrastructure devices. Below is a simplified overview of the steps required to deploy a Kontakt.io occupancy solution. Make sure to review the deployment prerequisites before starting.
For those implementing multiple Kontakt.io solutions, please note that steps 1 through 3 are consistent across all solutions.
-
Step 1: Get Kio Cloud Account
The first step of any Kontakt.io deployment is to create or sign in to your Kio Cloud account, Kontakt.io's cloud-based platform.
-
Step 2: Add Devices
When you receive a Kontakt.io order, you’ll claim the Order ID to add the devices to your Kio Cloud account.
-
Step 3: Set up Smart Location
Kio Cloud Smart Location is designed for mapping indoor spaces. This includes creating campuses, buildings, and each floor within a building. It also involves mapping the rooms within each floor, providing a comprehensive digital twin of the indoor space.
Required to upload digital floor plan maps - supported files type include JPG, PNG, BMP, and TIFF.
This step is important for location and occupancy accuracy. Learn more about the Kontakt.io Location Engine Reference Architecture that highlights the importance of rooms and more.
-
Step 4: Install Infrastructure Devices
Each infrastructure device, Kontakt.io Portal Lights and Portal Beams, must be set up and installed using the Kio Setup Manager mobile app. This step is completed onsite at the device install locations.
For Footfall occupancy, a Portal Beam must be externally powered; battery power is for backup purposes only. Required AC power adapter: 110-220VAC to 12VDC power supply, DC jack 5.5mm.
-
Step 5: Explore Kio Cloud
Learn about the Kio Cloud apps and how to consume data through our APIs and SDKs.
Before you begin, be sure to review the below prerequisites that detail what's required for deployment. It's also recommended to have a site install plan that identifies the install locations of both Portal Lights and Portal Beams.
-
Digital floor plan for each building floor. Required for Smart Location setup. Supported files type include JPG, PNG, BMP, and TIFF.
-
Length of the building floors or longest section of the floors. During the floor plan setup in Smart Location, you will need to set reference points to allow the app to scale the floor plan to represent the size and layout of the actual floor space.
The longer the distance between the two reference points will result in a more accurate scale of the floor. It's recommended to set the two reference points using the entire floor length. Optionally, you can choose two reference points that are located on opposite walls and with a minimum distance of 5 feet (1.5 meters). This distance between the two reference points can be provided in feet or meters.
-
Portal Light network requirements are met.
-
Portal Light local Wi-Fi network settings (SSID and passphrase). The Wi-Fi network they will connect to at their installation locations.
Not required If Kontakt.io pre-configured the Portal Lights Wi-Fi network settings; requested when an order is placed.
-
Portal Light install locations meet the placement guidelines.
For Kontakt.io Infrastructure devices, those that remain in a fixed, stationary position, the app is required to it install the devices. The app guides you through the install steps. If you already have the app, be sure you have the latest version.
To download the app, go to the App Store or Google Play. Search for Kio Setup Manager . Already have the app? Be sure you have the latest version.
App requirements: Apple iPhone or iPad: iOS version 15 or later | Android phone or tablet: version 5.0 or later | Bluetooth enabled (on) | Internet connection
-
From a web browser, go to https://cloud.kontakt.io/register.
If you’re located in the UK/Europe, go to http://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 will be sent from hello@kontakt.io.
-
From the Kio Cloud account activation email, select VERIFY YOUR ACCOUNT.
If you did not receive the email, check your Junk/Spam folder - the email is sent from hello@kontakt.io. If you need additional assistance, submit a request to our support team.
Note
If you would like implement Single sign-on (SSO) with Kio Cloud, submit a request to our support team.
When you receive an order from Kontakt.io, you must add the devices to your Kio Cloud account. This process is commonly referred to as claiming an Order ID. An Order ID can only be claimed once by a single account. Once claimed, the devices are added to your Kio Cloud account.
Important
If you are integrating with Cisco Spaces, Kontakt.io orders are claimed in your Cisco Spaces account. Learn how to claim an Kontakt.io order in Cisco Spaces.
You'll need the Kontakt.io Order ID provided in the Quick Start Guide included in the order packaging and also in the order confirmation emails.
-
From a web browser, sign in to your Kio Cloud account.
For accounts in the United States or North America countries, go to https://cloud.kontakt.io.
For accounts in the UK, EU and other European countries, go to https://app.cloud.uk.kontakt.io
-
From the Launchpad, select Device Management 2.0.
-
From the Add Devices menu, select Claim Order > enter your Kontakt.io Order ID exactly as it appears (it's case sensitive) > select CLAIM ORDER.
All of the order's devices are added to the account at once.
Receive a wrong Order ID error?
First, verify the Order ID is entered exactly as it appears. It's case sensitive and must contain all characters.
If this does not work, verify the Order ID was not previously used. An Order ID is a one-time use code. From your Kio Cloud account, go to Device Management 2.0 > select Tags or Infrastructure. From the list, verify the Order ID does not already exist. If it does not exist, it may have already been claimed from a different Kio Cloud account.
If you continue to receive an error message, submit a request to our support team. They'll help resolve the issue.
Your Kontakt.io devices have been added to your Device Management inventory and are ready to be deployed and installed!
Applies to Portal Beams that measure people footfall traffic
During this deployment step, you'll set up your Smart Location to map the facility locations - including each campus and its buildings, and the building floors and rooms.
Complete this step in the following order:
A campus is a collection of buildings. Many organizations are different - you may have just one or many campuses. For example, when you have facility locations in multiple cities, you'll create a campus for each location. Or maybe you have multiple buildings that are unique to their business services, you may then choose to have a campus for each business service location. Regardless of your organization's facility structure, deploying a Kontakt.io solution requires a single campus with a minimum of one building.
Quick demo of adding a campus and building.
If you have more than one campus, complete this step for each campus.
-
From the Launchpad, select Smart Location > select + ADD CAMPUS.
-
Enter the below campus information > when complete, select ADD.
-
Address: where the campus is located
-
Name: unique name of the campus
-
Description: for information purposes only
-
Campus image (optional)
-
A building is located within a campus. You may have one or multiple buildings within a single campus. Complete this step for each building.
-
Select + ADD BUILDING.
-
Enter the following building information > when complete, select Add.
-
Address: where the building is located (by default set to the campus address)
-
Name: unique name of the building
-
Description: for information purposes only
-
Building image (optional)
-
After your buildings are added, you are now ready to add the building floors.
During this step, you'll first add a floor to a building that requires uploading a digital floor plan.
Important
Be sure that you have a floor plan image file, sometimes called an indoor map, for each building floor.
JPG, PNG, BMP, and TIFF files are supported. The file size cannot be larger than 800 kB.
Quick demo of adding a floor and its floor plan.
-
Go to the Building you are adding a floor to > select + ADD FLOOR.
-
Enter the following floor information. When complete, select Add Floor.
-
Level: what building level the floor is located on
-
Name: unique name of the floor
-
Floor Plan: select Browse to upload the floor plan file
-
You'll now set the floor plan one-time Reference Point and Floor Outline. This ensures the floor plan is scaled correctly.
Important
Once saved, the following settings cannot be changed.
-
From the list of floors, select the floor you created in the previous step.
-
Select Configure Floor.
-
From the Reference Points tab > select Set points.
Important
The longer the distance between the two reference points will result in a more accurate scale of the floor. It's recommended to set the two reference points using the entire floor length. Optionally, you can choose two reference points that are located on opposite walls and with a minimum distance of 5 feet (1.5 meters). This distance between the two reference points can be provided in feet or meters.
Set POINT A by clicking on the first reference point on the floor plan (purple X appears)
Set POINT B by clicking on the second reference point > enter the distance between the two reference points > select NEXT.
-
Next, you will draw the floor outline > select Draw floor outline.
Select either the rectangle or polygon tool, hold down your mouse pointer over the start point and release > then drag the points to outline the floor plan. A blue line appears around the floor outline.
-
From the Floor Plan, verify that the calculated floor width and length measurements are accurate. This is calculated by the reference point measurement provided and the floor outline.
-
When complete, from the upper-right corner select SAVE AND CONTINUE.
You can now draw and the floor's rooms.
When in Footfall mode, a Portal Beam counts people entering and exiting a space. Commonly, a Portal Beam is installed at an entrance or interior corridor and people are counted as they pass through the Portal Beam's invisible crossing line.
Unique to Portal Beam set to footfall mode, setup requires two locations - a Footfall location that is a virtual location and room that is the physical location where the Portal Beam is installed.
You will need to add a Footfall location to identify where people footfall traffic is being measured.
-
One room footfall traffic: if the Portal Beam is only measuring people entering and exiting one room, you'll create a single Footfall location where the Portal Beam is installed in (inbound room).
-
Two room traffic (adjacent spaces): if the Portal Beam is measuring the people traffic between two locations within a spaces, you'll create two Footfall location. One Footfall location where the Portal Beam is installed (inbound footfall) and the second location (outbound footfall).
For each Portal Beam set to Footfall, you will need to create a room that identifies its installation location within a floor.
-
From Smart Location, go to the floor where the Portal Beam will be installed > from the upper-right corner, select CONFIGURE FLOOR.
-
From the Room Outlines, select the type of room being added.
Room: an actual room with four interior walls (office, patient room, conference room).
Virtual Room: an open space or area with no walls. A workspace with sofas or other collaboration-type space or a workstation area with multiple seats or desks being measured by a Portal Beam.
Corridor: may also be referred to as a hallway or walkway.
-
Enter a Name: uniquely identifies the room.
-
Room Number: numerical value unique to the room; duplicates are not allowed and cannot be greater than 4095.
-
Select a drawing tool
or
> from the floor plan, place your mouse at the left upper-side of the room location > left click to begin drawing the room.
Now, you'll assign each Portal Beam to its room install location and Footfall location. During onsite installation with the Kio Setup Manager mobile app, a Portal Beam is re-assigned to its room.
-
From the Smart Location floor where the Portal Beam will be installed, select the Configure Floor.
-
Select the Infrastructure tab.
-
Select Assign device to room > from the floor plan, select the room where the Portal Beam will be installed.
-
Select Assign Footfall Portal Beam without device.
-
Assign a Footfall location.
For one room traffic: from Add Inbound Footfall > select the Footfall location > select ADD. The Outbound Space is not assigned.
For two room traffic (adjacent spaces): from Add Inbound Footfall, select the Footfall location, and then from Add Outbound Footfall, select the Footfall location, select ADD. The Portal Beam will measure both the inbound and outbound traffic between the two Spaces' assigned rooms.
-
Repeat the above steps for each location where you'll be installing a Portal Beam set to Footfall mode.
Deploying both Portal Lights and other Kontakt.io BLE-only Infrastructure devices such the Portal Beam, Beam Mini, Anchor Beacon, and Dispenser Beacon? First install the Portal Lights and then the BLE-only Infrastructure devices.
Be sure you have what's needed before you begin installing Kontakt.io Infrastructure devices.
-
Your Kio Cloud user account sign-in credentials.
-
Site install plan that identifies the device install locations.
-
Portal Light local Wi-Fi network settings (SSID and passphrase). The Wi-Fi network they will connect to at their installation locations.
Not required If Kontakt.io pre-configured the Portal Lights Wi-Fi network settings; requested when an order is placed.
-
Smartphone or tablet with internet and Bluetooth enabled/on.
Installing a Portal Light includes configuring it with the facility's Wi-Fi network settings and assigning it to its install location within Kio Cloud Smart Location. Once the install is complete, a Portal Light will scan for Kontakt.io IoT Bluetooth Low Energy (BLE) devices and transmit the collected data to Kio Cloud over its connection to local Wi-Fi network.
Important
For Enterprise Wi-Fi networks (TLS/TTLS/PEAP), submit a request to our support team. They will assist with the Portal Light network configuration.
For WPA (TKIP & AES), WP2, or Open Wi-Fi (WEP; Open & Shared) Wi-Fi networks, complete the following instructions.
Must be completed at the Portal Light install location and the Wi-Fi network must be online.
-
From your mobile device, open the Kio Setup Manager app
> tap Kio Cloud Account.
-
From the Region, select the location of your organization's Kio Cloud account.
United States: located in the U.S, other North America countries, or Japan-Asia Pacific locations.
United Kingdom: located in the UK, EU, and other European countries.
Do not select Other, unless directed by Kontakt.io.
-
Sign in with your Kio Cloud user credentials; either Login with SSO or email and password.
Login with SSO: for accounts that have integrated Kio Cloud with their SSO provider. Requires the account "Realm Name" located in your Kio Cloud URL: https://[Realm Name].app.cloud.[us or uk].kontakt.io). Tap Login with SSO > enter the Realm Name > tap Continue. > sign in with your SSO credentials.
-
Bring your mobile device close to the Portal Light > tap Install Devices > Portal Light > Next.
-
Tap the Portal Light model being installed > Next.
-
From Select the Installation Type, select an option:
End-to-end installation: select to configure its Wi-Fi network settings and assign its install location.
Assign location: select when Kontakt.io has pre-configured the Wi-Fi network settings prior to shipment or if you need to update its current assigned install location.
-
Follow the step-by-step instructions provided in the app.
Scan its QR code; located on the side of the device.
Power on the Portal Light; plug into an outlet.
End-to-end only: Configure its Wi-Fi network settings; these settings are case sensitive.
Select its install location including the Campus, Building, Floor, and room. From the map, move the Portal Light to its install location within its assigned room.
Note
Placing the Portal Light at its location within a room is very important - it allows the Kio Cloud Location Engine to accuracy compute the location of Kontakt.io Tags within range of a Portal Light.
The app automatically adds a Device Note with the install details and sets the Portal Light's Deployment Status to Deployed. When set to Deployed, it is monitored by Kio Cloud Device Health.
-
Verify that the Portal Light's LED status indicator is GREEN, indicating a successful connection to the Wi-Fi network, NTP time source, and Kio Cloud.
-
If its LED continues to be RED for more than a few minutes, retry the Installation steps to verify its Wi-Fi network settings The Wi-Fi settings are case sensitive.
If a Portal Light's LED remains RED, it could not connect to the local Wi-Fi network. For additional information, refer to the Portal Light LED indicators.
If you cannot resolve a connection issue, submit a support request.
The installation of a Portal Beam is completed with the Kio Setup Manager mobile app at the beam's install location. The app guides you through each step, including assigning its install location, mounting the Portal Beam, and capturing a thermal image to verify its field of view and people detection.
People are counted as they pass through the Portal Beam invisible barrier known as its crossing line that is set during installation with the Kio Setup Manager app.
When completing the onsite installation from with Kio Setup Manager app:
-
Be sure the crossing line is positioned perpendicular to the flow of people traffic.
-
Place the crossing line as close to the center of the image as possible.
-
Ensure the crossing line covers the doorway or corridor pathway.
-
Avoid setting the crossing line directly in the path of stationary objects that emit heat or other types of heat sources.
-
Avoid placing near large stationary objects right before or after the crossing line. For example, HVAC tubing or other large objects mounted to the ceiling.
-
Avoid setting the crossing line near sofas or other furniture where people can sit and continuously cross and pass through the crossing line.
Important
For Footfall occupancy, a Portal Beam must be externally powered; battery power is for backup purposes only. Required AC power adapter: 110-220VAC to 12VDC power supply, DC jack 5.5mm.
-
From the underside of the Portal Beam, switch its battery power to the ON position.
You will apply AC power during mounting.
-
From your mobile device, open the Kio Setup Manager app and sign in.
-
Once signed in, the app guides you through each step.
-
When you receive confirmation that the install is complete, continue to the next step.
Note
This step is required if you installed a Portal Beam using the iOS version of the Kio Setup Manager. The Android version already allows you to place the Portal Beam at its exact room location.
A future iOS release will included this feature.
During this step, you'll place the Portal Beam at its exact mounting location within its installed room in Kio Cloud Smart Location. When you assigned its location from the Kio Setup Manager app, the Portal Beam is automatically placed in the center of its assigned room location.
If the Portal Beam is installed at the center of the room, you can skip this step.
-
Sign in to Kio Cloud > from the Launchpad, select Smart Location.
-
Go to the Floor where the Portal Beam is installed and assigned to > from the upper-right corner, select CONFIGURE FLOOR > select the Infrastructure tab.
-
From the list, select the Portal Beam > select the edit (pencil) icon > from the floor plan, move the Portal Beam icon to its mounting location within its assigned room > select SAVE.
If you are responsible for the management and monitoring of the Kontakt.io solution and deployed devices, be sure to learn more about Kio Cloud. For our developer community, learn more about integrating with Kio Cloud APIs and SDKs.
Kio Cloud is Kontakt.io's cloud-based platform. It's where you can manage and monitor your Kontakt.io solutions and IoT devices. This include device management and monitoring, the mapping of the physical indoor environment, and managing user access.
Need to sign in to your Kio Cloud account? From a web browser, go to http://cloud.kontakt.io
If your account is located in the UK/Europe, please go to https://app.cloud.uk.kontakt.io
-
The app where you'll set up and manage the mapping of the indoor spaces where your Kontakt.io solutions and IoT devices will be deployed. This mapping includes campuses, buildings, floors, and rooms.
Smart Location is the location topology that is used by the Kio Cloud Location and Occupancy Engine that computes accurate, room-level data for Kontakt.io's RTLS, occupancy, and indoor navigation solutions.
-
The app where you'll monitor and manage your Kontakt.io devices - from adding devices with your Kontakt.io Order ID, getting insights into your device inventory and statuses, to keeping devices up to date with the latest firmware and applying configuration changes.
Note
Currently, there are two Device Management apps. Device Management is the legacy app that will be sunsetted soon. Use of Device Management 2.0 is recommended.
Devices can also be managed through our Device Management API and SDKs.
-
The app designed to keep you informed about the state of your deployed Kontakt.io IoT devices. The app has several features including three available alert types, optional mediums for receiving alerts (email or text messages), and elective monitoring of devices (specific devices, device types, or devices in a particular location).
-
The app where you'll manage who has access to your Kio Cloud account.
Users will also find their unique API Key required to integrate with our APIs and SDKs.
-
Policy Foundry(for those integrating Kontakt.io device events within their own apps)
The app where you can set policies that trigger events when a monitored condition set in a policy is reached and policy actions that serve as a notification method when an event occurs. The available types of policy actions include email and text messages, and stream events to an AWS Kinesis or Azure Event Hub Stream.
From a policy, you can set its monitored condition to trigger events for badge and tag button presses, occupancy thresholds, device battery levels, to device location events.
The Kio Cloud platform is the backbone of Kontakt.io solutions and offerings. It's open and flexible, allowing you to integrate with the platform data to build custom solutions unique to your requirements by using our APIs and SDKs alongside our IoT devices. Learn more about integrating with Kio Cloud.
Visit our Kontakt.io Developer Center explore our open APIs and SDKs.
-
Location & Occupancy API (REST & Streams). Real-time and historical Kio Cloud apps data including location tracking, occupancy, and the full spectrum of sensor data from Kontakt.io devices.
-
Device Management API (REST). Configure, monitor, and manage your Kontakt.io devices in Kio Cloud.
-
Mobile SDKs. Complete development libraries to power your own mobile apps.