> ## Documentation Index > Fetch the complete documentation index at: https://documentation.kodelabs.com/llms.txt > Use this file to discover all available pages before exploring further. # Awair > Connect Awair to KODE OS for indoor environmental quality data > 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. | Property | Value | | ------------------- | ---------------------------- | | **System Type** | Indoor Environmental Quality | | **Communication** | REST | | **Collection** | Pull | | **Collection Mode** | SNAPSHOT | ## 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](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: * [Awair developer API usage](https://support.getawair.com/hc/en-us/articles/360049982333-Using-Awair-Developer-APIs) ## Generate API Credentials * Log in to the [https://dashboard.getawair.com/login](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](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 1. Navigate to **Data Sources** in your building 2. Click **API Catalog** and search for **Awair** 3. Click **+ Add Datasource** 4. Fill in the fields below and complete the three-page setup flow | Field | Required | Type | Description | | ------------------- | ----------- | -------- | ------------------------------------------------- | | **URL** | Yes | text | The base URL or IP address of the external system | | **Protocol** | Yes | dropdown | The communication protocol to use | | **Organization ID** | No | text | | | **X-API-Key** | Conditional | password | | ## 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](/products/integrations/capabilities/discovery). ## 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` | # | Point | Description | Unit | Writable | Collection | | -- | ------------- | ------------------------------------------------------------------------------------- | ----------------------------- | -------- | ---------- | | 1 | `plugged` | **True** -- plugged is active / **False** -- plugged is not active | -- | No | Polling | | 2 | `battery` | Device battery level (%) | % | No | Polling | | 3 | `brightness` | Lighting brightness level (%) | % | No | Polling | | 4 | `score` | Composite air quality score (%) | % | No | Polling | | 5 | `temperature` | Current temperature reading (°C) | °C | No | Polling | | 6 | `humidity` | Relative humidity level (%RH) | %RH | No | Polling | | 7 | `co2` | Carbon dioxide (CO₂) concentration (ppm) | ppm | No | Polling | | 8 | `voc` | Volatile organic compound (VOC) level (ppb) | parts\_per\_billion | No | Polling | | 9 | `pm25` | Fine particulate matter (PM2.5) concentration (µg/m³) | micrograms\_per\_cubic\_meter | No | Polling | | 10 | `lux` | Ambient light level (lux) | lux | No | Polling | | 11 | `spl_a` | A-weighted sound pressure level (dB) | decibels | No | Polling | | 12 | `connected` | **True** -- device is connected and reporting / **False** -- device is not responding | -- | No | Polling | ## 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 devices ### Polling Schedule * **Point History** -- Default polling: 5 minutes (min: 5 minutes, max: 1 hours) For more details on collection modes, see the [Data Collection guide](/products/integrations/capabilities/data-collection). ## 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 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. 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. 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.