This guide provides instructions required to deploy a Kontakt.io occupancy solution. This deployment requires setting up Kio Cloud (Kontakt.io's cloud-app platform) and installing Kontakt.io Portal Lights and Portal Beams.
This guide is intended for those responsible for system setup and device installation.
The following provides an overview of the steps required to deploy a Kontakt.io occupancy solution. Before you begin, be sure also to review the Deployment Prerequisites.
If you are deploying a solution that consists of multiple use cases, such as both room and seat occupancy and asset tracking, steps 1 through 2 are the same for all use cases.
-
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 solution of apps. If you already have a Kio Cloud account, when you receive a Kontakt.io order you'll only need to add the devices to your account.
A Kio Cloud account is required to manage and monitor your Kontakt.io devices and configure Kio Cloud apps to meet your solution requirements.
For those integrating with our APIs and SDKs, your unique API Key is available from your Kio Cloud user profile.
-
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 the mapping of the deployment locations - from each campus, building, and building floors along with digital floor plans that map the rooms and spaces being monitored and the installation locations of Kontakt.io stationary devices.
Required to upload digital floor plan maps - supported files type include JPG, PNG, BMP, and TIFF.
This step is very important for location, occupancy, and tracking accuracy.
-
Step 4: Install Devices
Each device must be set up and installed with the Kio Setup Manager app. This step is completed onsite at the device install locations.
Portal Lights - configure WiFi settings for Kio Cloud connectivity, and place them at their install location from a Smart Location floor plan map.
Portal Beams - set occupancy mode (room, seat, or footfall traffic), assign to install location, complete the in-app configuration and connectivity tests, mount to ceiling, and place at exact install location within its assigned Smart Location room.
For Footfall Traffic, 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 monitoring and managing your deployed Kontakt.io devices and other system settings.
Device Management app - manage and monitor your Kontakt.io devices.
Users app - manage who has access to Kio Cloud.
Policy Foundry app - manage when and how alerts are triggered when a monitored condition is reached. Conditions monitored can include button press events, occupancy thresholds, to device health conditions.
Before you begin, be sure you have what's required for deployment.
Commonly completed by those responsible for system administration.
-
Kontakt.io Order ID - required to add devices to Kio Cloud.
-
Digital floor plan for each building floor - required for Smart Location setup.
Supported files type include JPG, PNG, BMP, and TIFF.
-
Site install plan - identifies each Kontakt.io device install location, along with Portal Beam modes.
-
Site install plan - identifies device install locations with Portal Beam modes. When installing Portal Beams, you will need to provide the ceiling height of their mounting locations.
-
Portal Light network requirements are met.
-
Portal Light gateways - local WiFi network settings they will connect to at their installation locations.
Not required If Kontakt.io pre-configured the Portal Lights WiFi network settings; requested when an order is placed.
-
Portal Light Install locations - meet the Portal Light placement guidelines.
-
Portal Beam install locations - meet the placement guidelines and best practices.
-
Your Kio Cloud user account sign-in credentials.
-
Smartphone or tablet with internet and Bluetooth enabled/on.
-
Computer with internet.
The following provides the instructions to successfully deploy a Kontakt.io solution.
-
From a web browser, go to https://cloud.kontakt.io/register > enter your account profile information > select CREATE ACCOUNT.
A Kio Cloud account activation is sent to your email address. It may take a few minutes for the email to arrive.
-
From the Kio Cloud account activation email, select VERIFY YOUR ACCOUNT.
If you did not receive the email, please check your Junk/Spam folder - the email is sent from hello@kontakt.io. If you need additional assistance, please submit a request to our support team.
When you receive an order from Kontakt.io, you must add the order's devices to your Kio Cloud account. This is also known as claiming an Order ID. An Order ID can only be claimed once by a single Kio Cloud account.
You'll need the Kontakt.io Order ID. You can find the Order ID on the Quick Start Guide card included in the order packaging and the order and shipment confirmation emails. Please do not add devices until the order shipment is received.
-
Sign in to Kio Cloud > from the launchpad, select Add Devices.
-
Enter your Kontakt.io Order ID exactly as it appears (it's case-sensitive) > select ADD DEVICES. All of the order's devices are added to your 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 > from the list of devices, see if the Order ID already exists. If it does not exist, the Order ID 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.
Portal Beam Footfall Traffic mode
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.
If you have more than one campus, complete this step for each campus.
-
From your Kio Cloud Launchpad, select Smart Location.
-
From the upper-right corner, select ADD CAMPUS.
-
Enter the below campus information > when complete, select Save.
-
Address: where the campus is located
-
Name: unique name of the campus
-
Description: for information purposes only
-
Campus image: (optional) click + to upload a file
-
A building is located in a campus and you may have one or multiple buildings in a single campus. Complete this step for each campus building.
-
Select ADD BUILDING.
-
Enter the following building information > when complete, select Save.
-
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): click + to upload a file
-
After buildings are added, you are now ready to add the building floors.
Complete the following steps for each floor in a building.
Important
A floor plan image file, sometimes called an indoor map, is required for each building floor.
JPG, PNG, BMP, and TIFF files are supported. The file size cannot be larger than 800 kB.
-
Go to the Building, select ADD FLOOR or add first floor here.
-
Enter the following floor information.
-
Level: what building level the floor is located on
-
Name: unique name of the floor
-
Floor Plan: select + to upload the floor plan file
-
You'll now set the floor plan's 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 Start Floor Configuration.
-
Select SET POINTS.
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.
-
Set 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 green line appears around the floor outline.
-
From the Floor Plan, verify that the calculated floor width and length measurements are accurate.
-
When complete, from the upper-right corner select SAVE AND CONTINUE.
After you've added all the floors, you can now add the rooms on each floor.
When in Footfall Traffic mode, a Portal Beam counts people entering and exiting a space. Commonly, a Portal Beam is installed at each entrance or interior corridor and people are counted as they pass through the Portal Beam's invisible threshold line.
Unique to Portal Beams set to footfall traffic mode, setup requires adding both rooms and spaces. A single Portal Beam can be used to measure traffic for one space or for adjacent spaces.
If your deployment includes IR beaconing location services, be sure that rooms are created for the entire floor area.
-
Go to the floor you're setting up > from the upper-right corner, select CONFIGURE FLOOR.
-
From Room outlines > select the type of room you're adding.
Room: an actual room with four interior walls (office, patient room, conference room).
Virtual Room: open space or area with no walls (workspace with sofas or other collaboration-type space) or for Portal Beams set to seat-level occupancy (workstation with multiple desks).
Corridor: location is a corridor, which 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. Essential for room-level location accuracy and tracking.
Location & Occupancy API property:
roomNumberand Device Management API property:irRoomNumberReference Beacon (Anchor Beacon):
roomID -
You'll now add the rooms, which is dependent if the Portal Beam is measuring traffic for one space (room) or two spaces (an inbound and outbound room).
One room traffic: if the Portal Beam is only measuring people entering and exiting one room, you'll create a single room 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 rooms, you'll create two rooms. One room where the Portal Beam is installed (inbound room) and the second room (outbound room).
-
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. -
Select the Spaces tab.
For one room traffic: select Create Space > give the space a Name > select the Space > from the left menu, select the Room and add it to the Space > select SAVE. The room should be listed within the Space.
For two room traffic (adjacent spaces): create two Spaces and assign each room to a Space. Select Create Space > give the space a Name > select the Space > from the left menu, select one of the Rooms and add it to the Space > select SAVE. Repeat this step for the second room.
-
Now, you'll assign a Portal Beam to the room install location. During installation, the unique Portal Beam is re-assigned to the room.
Select the Devices tab. Again, this step is dependent if you're measuring one room traffic or for two room traffic.
For one room traffic: select Assign Traffic Portal Beam > select the room where the Portal Beam will be installed > from the Add Inbound Space, select the Space that's being measured >select SAVE. The Outbound Space is not assigned.
For two room traffic (adjacent spaces): select Assign Traffic Portal Beam > select the room where the Portal Beam will be installed > from the Add Inbound Space, select the Space where the Portal Beam is installed > from the Add Outbound Space, select the second Space being measured > select SAVE. The Portal Beam will measure both the inbound and outbound traffic between the two Spaces' assigned rooms.
-
When you've added all rooms and spaces, select FINISH CONFIGURATION.
Deploying both Portal Lights and Portal Beams? First, configure and install each Portal Light and then the Portal Beams.
Be sure you have what's needed before you begin installing Kontakt.io devices.
-
Your Kio Cloud user account sign-in credentials.
-
Site install plan - identifies device install locations with Portal Beam modes. When installing Portal Beams, you will need to provide the ceiling height of their mounting locations.
-
Portal Light gateways - local WiFi network settings they will connect to at their installation locations.
Not required If Kontakt.io pre-configured the Portal Lights WiFi network settings; requested when an order is placed.
-
Smartphone or tablet with internet and Bluetooth enabled/on.
-
Computer with internet.
During installation, the app is required and walks you through the setup and installation steps. If you already have the app, be sure you have the latest version.
To download the app to your phone or tablet, go to the App Store or Google Play. Search for Kio Setup Manager 
.
App requirements: Apple iPhone or iPad: iOS version 11 or later | Android phone or tablet: version 5.0 or later | Bluetooth enabled (on) | Internet connection
These instructions provide the steps to get a Portal Light ready for use. A Portal Light is configured with the facility's WiFi network settings, and once configured they are ready to be installed with Kio Setup Manager app.
Tip
If you have a handful to hundreds of Portal Lights, we recommend completing the Portal Light bulk configure and install instructions.
When the following steps are complete, a Portal Light scans for Kontakt.io BLE beacons and devices and sends data to and downloads settings from Kio Cloud over its connection to the facility's local WiFi network.
If Kontakt.io pre-configured the Portal Light's WIFi network settings, go to the next step.
-
Sign in to Kio Cloud > select Device Management > select Gateways.
-
From the list, select the Portal Light by its MAC address - printed on the side of the device.
TIP: if you have multiple Portal Lights being configured, select each Portal Light and click Bulk Edit.
-
Enter the WiFi network properties - this is the network the Portal Light connects to at its install location.
-
Network Authentication: Personal (WPA; TKIP & AES), Enterprise (WPA2; TKIP & AES), Open WiFi (WEP; Open &Shared)
-
Network Name: SSID; case sensitive
-
Network Password: passphrase (network password); case sensitive
-
Alias: for information purposes only
-
-
Select Save Changes.
The Portal Light synchronizes with Kio Cloud during the next install step to download the WiFi settings.
Important
This step must be completed at the Portal Light install location.
During this step, the Portal Light synchronizes with Kio Cloud to download its WiFi network settings.
-
Power on the Portal Light - plug into a standard grounded outlet.
-
From your mobile device, open the Kio Setup Manager app
> sign in with your Kio Cloud username (email address) and password. -
Bring your mobile device close to the Portal Light > tap Install Devices > Portal Light Setup.
-
Follow the step-by-step instructions provided in the app.
Tip
Have a problem with the app not finding a device, shows out of range and you are nearby, or it's not allowing you to perform an action?
From your mobile device, turn Bluetooth OFF and then ON again. Wait for the app to establish its connection to the Portal Light.
-
Verify the Portal Light LED is a solid green, which indicates it's connected to the local WiFi network.
If its LED remains RED, it could not connect to the local WiFi network. From Kio Cloud, verify its network settings are correct.
You can also refer to the Portal Light LED indicators.
During this final step, you'll place the Portal Light onto a floor plan at its exact install location.
-
Sign in to Kio Cloud (https://app.cloud.us.kontakt.io/signin) > from the launchpad, select Smart Location.
-
Go to the Campus, Building, and Floor where Portal Light is installed > from the upper-right corner, select CONFIGURE FLOOR > select the Devices tab.
-
From the Deployed Devices list, select the Portal Light > select the edit icon (pencil) > from the floor plan, move the Portal Light icon to its exact location in the room > select SAVE > and select FINISH CONFIGURATION.
Footfall Traffic mode
You'll complete this step at the Portal Beam install location using the Kio Setup Manager app. The app guides you through each step, including configuring and mounting the Portal Beam.
People are counted as they pass through a Portal Beam's invisible barrier known as its crossing line. This crossing line appears in the thermal image captured during the Portal Beam 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 Traffic, 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 > sign in with your Kio Cloud username and password.
-
Once signed in, the app guides you through each step.
Step 4: Select Install Location
Step 5: Reconfigure
Step 6: Complete Tests
Step 7: Mount & Provide Install Height
Step 8: Capture Image
Step 9:
-
When you receive confirmation that the install is complete, continue to the next step.
During this final install step, you'll place the Portal Beam at its exact mounting location within its assigned room. 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.
-
Sign in to Kio Cloud (https://app.cloud.us.kontakt.io/signin) > from the launchpad, select Smart Location.
-
Go to the Campus, Building, and Floor where the Portal Beam is installed and assigned to > from the upper-right corner, select CONFIGURE FLOOR > select the Devices tab.
-
From the Deployed Devices list, select the Portal Beam > select the edit (pencil) icon > from the floor plan, move the Portal Beam icon to its mounting location in the room > select SAVE > and select FINISH CONFIGURATION.
If you are responsible for the management and monitoring of the Kontakt.io solution and devices deployed at the facility, be sure to learn more about the Kio Cloud apps. To integrate with our APIs or SDKs, visit the Kontakt.io Developer Center.
The following apps are commonly referred to as the Kio admin apps and are accessed by those responsible for deploying and managing your Kontakt.io solutions and devices.
-
When you receive an order from Kontakt.io, the order's devices must be added to your Kio Cloud account. From this launchpad option, you'll enter your Kontakt.io Order ID.
-
The app where you'll monitor and manage your Kontakt.io devices - from getting insights into your device inventory and statuses to keeping devices up to date with the latest firmware and applying configuration changes.
Devices can also be managed through our Device Management API and SDKs.
-
The app where you'll set up and manage your locations, including campuses, buildings, and floors. From each floor, you can view the real-time data received by your Kontakt.io devices, including location, occupancy, and telemetry data.
Smart Location is required for tracking, location, and occupancy-based services and solutions.
-
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.
-
A policy-based monitoring app that generates email and text notifications to alert staff of monitored condition excursion events or configure to send events to an AWS Kinesis or Azure Event Hub Stream.
From a policy, you can set its monitored condition to generate events for badges and tags button presses, occupancy thresholds, device battery levels, to device location events.
From 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.