This guide provides instructions required to deploy a Kontakt.io occupancy solution. This deployment requires setting up the Kio 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 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
A Kio Cloud account is required to manage and monitor your Kontakt.io devices and configure Kio Cloud apps to meet your solution requirements.
-
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 physical environment - from each campus, building, and building floors along with digital floor plans.
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. Learn more about the Kontakt.io Location Engine Reference Architecture that highlights the importance of rooms and more.
-
Step 4: Install Devices
Each infrastructure device, Portal Lights and Portal Beams, must be set up and installed with the Kio Setup Manager app. This step is completed onsite at the device install locations.
-
Step 5: Explore Kio Cloud
Learn about monitoring and managing your deployed Kontakt.io devices and other system settings.
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 the order's devices to your Kio Cloud account.
-
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.
An Infrastructure device is a stationary device that is placed onto a ceiling or wall. These devices include Portal Lights that are BLE to Wi-Fi Gateways and Portal Beams that are room sensors providing occupancy measurements.
-
Site install plan that identifies the device install locations.
-
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 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.
-
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, 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.
When you receive an order from Kontakt.io, you must add the 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 that is located on the Quick Start Guide included in the order packaging and included in the order confirmation emails. Please do not add devices until the order shipment is received.
-
Sign in to Kio Cloud.
If you don't have an account yet, you'll need to register for one before you can proceed.
-
From the Launchpad, select Device Management 2.0.
-
From the left menu, click 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 2.0 > select Beacons or Gateways. 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 are ready to be deployed and installed!
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:
-
When you add rooms for Portal Beams set to seat-level occupancy, you'll also set up the seats being measured for occupancy.
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 in a campus. You may have one or multiple buildings in a single campus. Complete this step for each 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)
-
After 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 you to upload a 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, select + ADD FLOOR.
-
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 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.
-
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.
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.
-
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. 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 the floor's rooms.
Portal Beam seat-level occupancy installation room locations
This is one of the most important steps for accurate room-level location and occupancy data. For each floor, you'll draw and create rooms for each location where a Portal Beam and other Kontakt.io stationary infrastructure device will be installed.
If your deployment includes IR beaconing location services, be sure that rooms are created for the entire floor area.
-
Go to the floor > select Configure Floor > select Room Outlines > select Add Virtual Room.
Virtual Room: open space or area with no walls. A workspace with sofas or other collaboration-type space or a workstation area with multiple desks being measured by Portal Beam.
-
Enter a Name: this should uniquely identify the room location.
-
Room Number: numerical value unique to the room; duplicates are not allowed.
Location & Occupancy API property:
roomNumberand Device Management API property:irRoomNumberReference Beacon (Anchor Beacon):
roomId -
From Add Seats, select the number of seats in the room that will be measured > enter a Name/ID for each seat.
A single Portal Beam can measure up to six seats.
If there are multiple Portal Beams located in the same area, create a room for each Portal Beam install location and the seats.
IMPORTANT: take note of the room name and each seat name/ID - you'll need this when installing a Portal Beam into this room from the Kio Setup Manager app.
-
From the floor plan, move each seat (green square) to its approximate location within the room > select SAVE.
TIP You may need to zoom in on the floor plan to move the seats, select the + icon.
-
When all rooms are added, from the upper-right corner 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 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.
-
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, 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 Wi-Fi network settings, and once configured they are ready to be installed with Kio Setup Manager app.
When the following steps are complete, a Portal Light scans for Kontakt.io BLE tags and room sensors (Portal Beams, Anchor Beacons) and sends the data to and downloads settings from Kio Cloud over its connection to the facility's local Wi-Fi network.
If Kontakt.io pre-configured the Portal Light's WIFi network settings, go to the next step.
Tip
If you have a handful to hundreds of Portal Lights, we recommend completing the Portal Light bulk configure and install instructions to set the WiFi network for multiple devices at the same time.
-
Sign in to Kio Cloud > select Device Management 2.0 > select Gateways.
-
From the list, select the Portal Light ID. It's Unique ID and MAC address is printed on the device.
-
Select the WiFi Connectivity tab > enter its WiFi Settings. This is the local network the Portal Light connects to at its install location.
-
WIFI Network SSID: this is case sensitive.
-
WiFi User Name: only when applicable and required to connect to network.
-
WiFi Password: passphrase (network password); case sensitive
-
Proxy Settings: for use with a Proxy Server on the network the Portal Light connects to. Provide the Proxy URL (https://) and Proxy Port.
-
-
Select Save Changes.
The Portal Light synchronizes with Kio Cloud during the next step to download its Wi-Fi settings.
Note
Fallback WiFi Settings. This is the Kontakt.io factory network and cannot be changed.
When a Portal Light cannot connect to its configured WiFi Network, it attempts to connect to this Fallback WiFi network.
This network can be used during installation or troubleshooting as a means for a temporary network connection through a mobile hotspot or local network.
Important
This step must be completed at the Portal Light install location.
During this step, a Portal Light synchronizes with Kio Cloud to download its Wi-Fi 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 > tap Portal Light Setup.
-
Follow the step-by-step instructions.
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 Wi-Fi network.
If its LED remains RED, it could not connect to the local Wi-Fi network. From Device Management, verify its network settings are correct.
You can also refer to the Portal Light LED indicators.
During this final install step, you'll place a Portal Light at its exact mounting location within its Smart Location room. This step is very important and required for all installed Portal Lights.
-
Sign in to Kio Cloud > 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 Gateways tab.
-
Select ASSIGN NEW GATEWAY > from the list, select the Portal Light > select ADD.
The Portal Light is placed at the center of the visible floor plan.
-
Select its edit icon (pencil) > from the floor plan, move the Portal Light icon to its actual location in the room > select SAVE
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.
Note
Kio Cloud Smart Location setup must be complete. You'll be required to assign a Portal Beam to its room install location and seats.
-
From the underside of the Portal Beam, switch its battery power to the ON position.
-
From your mobile device, open the Kio Setup Manager app > sign in with your Kio Cloud username and password.
-
Tap Install Devices. The app guides you through the following steps.
Step 1: Select Portal Beam
Step 2: Select Specific Seats
Step 3: Scan QR Code
When scanned, the app verifies the device is within range to continue its installation.
Step 4: Select Install Location
Step 5: Reconfigure
Step 6: Complete Tests
The app detects and applies configuration updates required for the selected Portal Beam mode.
Step 7: Mount & Provide Install Height
Step 8: Capture Image
Step 9: Assign Seat Locations
When assigning a seat from the thermal image taken, be sure to position the green outlined box to cover the entire area that can be occupied by the seat. Do not limit a seat's outlined box to only the heat image detected.
-
When you receive confirmation that the install is complete, continue to the next step.
During this 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.
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 Beacons 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 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.
-
The app where you'll set up and manage the map of the physical indoor environment that includes campuses, buildings, floors, and rooms. From each floor, you can view the real-time data for your Kontakt.io devices, including their location, occupancy, and telemetry data.
Smart Location is required for tracking, location, and occupancy-based services and solutions. It represents the Location Topology that is used by the Kio Cloud Location Engine that computes accurate, room-level data.
-
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 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.
Devices can also be managed through our Device Management API and SDKs.
Note
Currently, there are two Device Management apps. Device Management is the legacy app that will soon be sunsetted. Use of Device Management 2.0 is recommended.
-
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.
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.