Complete the following steps to deploy a Portal Beam in Room Occupancy mode.
When you receive a Kontakt.io order, the first step is to create a Kio Cloud account or sign in to your account and then add the order's devices to your account.
If you already have a Kio Cloud account, you'll only need to add the devices to your account.
-
From your 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 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 need to add the order's devices to your Kio Cloud account. Which is also commonly referred to as claiming an order.
You'll need your Kontakt.io Order ID. You can find the Order ID on the Quick Start Guide card included in the order packaging and is also included in the order and shipment confirmation emails. Please do not add devices until you've received the order shipment.
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.
Note
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.
Now that your devices are added, the next step is to set up and install your Kontakt.io devices.
Room mode
During this step, you'll set up your Smart Location to mirror your organization's facilities - from the campus, buildings, and the floors and rooms of the buildings.
When you're installing each Portal Beam (Step 3), you'll assign the Portal Beams to their exact install location within your Smart Location, which is required to ensure location, occupancy, and tracking accuracy.
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, your organization may have facilities located in different cities, you'll then create a campus for each geographic 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
Buildings are located within 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 the 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.
-
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 below setup settings cannot be changed.
From the list of floors, select the floor you created in the above 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 (green line appears around the floor outline).
From the Floor Plan, verify the system 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 located on each floor.
Complete the below steps for each location within the floor where a Portal Beam or other Kontakt.io stationary device (Portal Light, Anchor Beacon) will be installed.
If your deployment includes IR beaconing location services for the entire floor, all floor locations must be added.
-
From Room outlines > select the type of room you're adding.
Room: select if the room location has four interior walls.
Virtual Room: select if the location is an open area with no walls. May also be referred to as an open space.
Corridor: select if the location is a corridor. May also be referred to as a hallway.
Enter a Name: uniquely identifies the room or corridor.
-
Room Number: unique numerical value to identify the room, virtual room, or corridor for room-level location accuracy and tracking.
Portal Beam with IR enabled: Location & Occupancy API property:
roomNumberand Device Management API property:irRoomNumberReference Beacon (Anchor Beacon):
roomID Select a drawing tool > from the floor plan, draw the room > select SAVE.
When all rooms are added, select FINISH CONFIGURATION.
When all floors are set up, the Portal Beams are ready to be installed at their permanent locations (Step 3).
When in Room Occupancy mode, a Portal Beam measures the number of people in a room.
You'll complete this step at the Portal Beam install location using the Kio Gateway Installer app.
-
Kio Gateway Installer app installed on your mobile device.
Download from the App Store or Google Play Store.
-
Kio Gateway Installer 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
Important
You'll be required to mount the Portal Beam to the ceiling and provide the ceiling height. Be sure to have the necessary equipment to measure and reach the ceiling.
This step is important to ensure all modes and features are available.
-
Turn on its battery power. From its underside, move the battery power switch towards the Reset button.
Portal Beam Footfall Traffic Counting mode: requires external power (battery power is for backup use only).
From your mobile device, open the Kio Gateway Installer app > from the first screen, tap Skip.
Log in with your Kio Cloud account credentials.
-
Tap BEACONS > select the Portal Beam - its Unique ID is printed on its underside.
Tip
Have a problem with the app not finding a Kontakt.io device 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 device. Also, be sure you have the latest app version. Allowing automatic app updates is recommended.
If this does not resolve the issue, close the Kio Gateway Installer app and any other open apps using Bluetooth. Then reopen the Kio Gateway Installer app.
-
Tap SETTINGS, scroll down to verify if a firmware update is available.
If an update is available, tap the firmware update option. Please wait until the Firmware Update confirmation window appears > tap OK > and proceed to the next step.
Tap the back arrow > tap Install devices.
-
Tap Portal Beam Setup > from the mode selections, tap Room Occupancy.
The app guides you step-by-step.
If the Portal Beam will also be used for IR room-level location beaconing, you'll need to enable its IR setting.
After a Portal Beam is installed, the next step is to verify its real-time data being sent to Kio Cloud. This data is viewable from its floor location in your Smart Location. (Step 4).
After you've completed the install steps from the Kio Gateway Installer, it's time to validate that Kio Cloud is receiving the Portal Beam's data.
It's recommended to complete this while you're located in the room or when others are occupying the space, which allows you to validate the real-time occupancy data.
From your Kio Cloud Smart Location > navigate to the floor where the Portal Beam is installed.
The real-time data available is dependent on the Portal Beam mode. For all data, visit the Kontakt.io Developer Center and refer to the Location & Occupancy API. Also, with your Kio Cloud API key you can send a request directly from an occupancy endpoint to validate data.
Verify the occupancy count from the room occupancy column or visually from the room located on the floor plan.
Verify the seat occupancy count from the room details (occupied | not occupied) or visually from the floor plan (occupied: red and not occupied: green).
People traffic measurements are available from the Space assigned to the Portal Beam room. As people enter and exit the space being monitored, the occupancy count continuously updates.
