A Portal Beam provides the current Air Quality Index (AQI) of its monitored area. The AQI is calculated based on the average concentration of volatile organic compounds (VOCs) readings taken by the Portal Beam air sensor.
By default, a Portal Beam's air sensor is enabled. You can manage its air sensor configuration from either Kio Cloud or the Kontakt.io Device Management API. Portal Beam AQI data is provided in the Location & Occupancy API (telemetry).
-
Sign in to Kio Cloud > select Device Management.
-
Select Beacons > from the list, select the Portal Beam.
-
From its profile, select Sensors.
-
From its Air Sensor settings, configure the following:
Air Sensor: enable or disable.
Air Sensor Probing Interval: how often a reading is taken.
-
You'll now need to synchronize the beacon to receive and apply the configuration update.
Alternatively, a configuration update can be made from the Device Management API.
-
Endpoint: Config >
POST Create a Config
-
Enable or disable:
AIR_QUALITY
-
Set reading interval:
airQualityInterval
. Air quality interval must be greater than 60000 milliseconds (one minute). -
You'll now need to synchronize the beacon to receive and apply the configuration update.
When a setting configuration change is made to a beacon from Kio Cloud or the Device Management API, the beacon is set to a Pending Update status and must be synchronized to receive the update. From the Beacons list view, a SYNC icon indicates a beacon has a pending update.
A beacon can synchronize to receive and apply Kio Cloud pending updates from either of the following methods. For complete details, see About synchronizing beacon and gateway pending updates.
-
Locally from the Kio Gateway Installer app.
-
From an in range Kontakt.io Portal Light.
-
From a third-party app integrated with Kontakt.io SDKs.