Connect Awair to KODE OS for indoor environmental quality data integration
Overview
Use this integration to connect Awair to KODE OS. You can discover air quality devices and points, pull snapshot indoor environmental readings over REST, and track sensor history from Data Sources.Supported Capabilities
- Discover Devices & Points
- Collect Sensor Data
Prerequisites
To integrate with the Awair API, ensure you have the following details:- An active account in https://dashboard.getawair.com with the appropriate access permissions.
- Valid username and password credentials for the Awair platform.
Vendor Onboarding References
Use these official vendor resources to verify API access, credentials, and permission prerequisites:Generate API Credentials
- Log in to the https://dashboard.getawair.com/login using your username and password
- On the top-right, open the Dropdown and select Organizations.
- Choose the relevant Organization from the list.
- In the URL, you’ll find the Organization ID. For example:
- https://dashboard.getawair.com/orgs/11217/metrics
- Organization ID: 11217
- In the left-hand navigation menu, click on API KEY.
- Copy the displayed API Key. After completing these steps, you’ll have both the API Token and Organization ID, which will be used in the next step.
Configure Connector in KODE OS
- Navigate to Data Sources in your building
- Click API Catalog and search for Awair
- Click + Add Datasource
- Fill in the fields below and complete the three-page setup flow
Discover Devices and Points
After configuring the connector, click Discover on the connector detail page. KODE OS will query the Awair system and return a list of available devices and their data points. Review the discovered items and select the devices you want to register in KODE OS. For more details on the discovery process, see the Discovery guide.Devices and Points
When you discover devices from Awair, KODE OS maps them to the following device types and data points:Air Quality Sensor
Canonical Type:airQuality
What Data You Get
Point History
Time-series readings including plugged, battery, brightness, score, temperature, humidity, co2, voc, and 4 more, collected at regular intervals from connected devicesPolling Schedule
- Point History — Default polling: 5 minutes (min: 5 minutes, max: 1 hours)
Use Cases
Once connected, this integration enables you to:- Monitor air quality metrics (CO2, VOC, humidity, temperature) across all occupied spaces
- Generate compliance reports for indoor environmental quality standards
- Trigger ventilation adjustments when air quality thresholds are exceeded
Troubleshooting
Authentication or connection error
Authentication or connection error
Verify that the credentials are correct and have not expired. Check that the URL is reachable from the KODE OS environment. Double-check all credential fields match the values from the Awair platform.
Discovery returns no devices
Discovery returns no devices
Verify the connector credentials have sufficient permissions in the Awair system to list devices. Run a test connection first to confirm connectivity. Some systems require specific API scopes or roles for device enumeration.
Data collection stops or gaps appear
Data collection stops or gaps appear
Check the connector status on the Data Sources page. If the status shows an error, review the error logs on the connector detail page. Common causes include expired credentials, network changes, or rate limiting by the Awair API.