> ## 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.

# Aeroqual

> Connect Aeroqual to KODE OS for outdoor environmental quality, weather data

> Connect Aeroqual to KODE OS for outdoor environmental quality, weather data integration

## Overview

Use this integration to connect Aeroqual outdoor air and weather monitors to KODE OS. You discover devices and pull measurement history for air quality and meteorological metrics over REST.

| Property            | Value                                       |
| ------------------- | ------------------------------------------- |
| **System Type**     | Outdoor Environmental Quality, Weather Data |
| **Communication**   | REST                                        |
| **Collection**      | Pull                                        |
| **Collection Mode** | HISTORICAL                                  |

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data

## Prerequisites

To connect to the Specto API, there are two supported methods:

* Cloud API – connects via the Aeroqual Cloud platform
* Local API – connects directly through your local network
  You only need one of the following sets of credentials, depending on which method you choose:
  Cloud API
* An active account at [https://cloud.aeroqual.com](https://cloud.aeroqual.com) with the appropriate access permissions.
* Valid username and password credentials for the Aeroqual platform.
  Local API
* A valid proxy IP address provided by your local building engineer
* A valid username and password to authenticate with the local network
  Password\*
  API Organization ID\*
  Generated in Step 2
  Fields marked with an asterisk \* are mandatory for completing the integration.

## Generate API Credentials

Cloud API

* Log in to the Aeroqual platform at [https://cloud.aeroqual.com](https://cloud.aeroqual.com) using your username and password.
* From the top menu, select Dashboards.
* On the left side of the screen, you’ll see a list of organizations.
* Your API Organization ID is the name/title of the listed organization (e.g., KODE Laboratories Inc).
  Local API

## Configure Connector in KODE OS

1. Navigate to **Data Sources** in your building
2. Click **API Catalog** and search for **Aeroqual**
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        |
| **Version**         | Yes         | dropdown | The API or firmware version to use                       |
| **Organization ID** | Conditional | text     | The organization ID in the vendor's API                  |
| **Username**        | Yes         | text     | The username for authenticating with the external system |
| **Password**        | Yes         | password | The password for authenticating with the external system |

## Discover Devices and Points

After configuring the connector, click **Discover** on the connector detail page. KODE OS will query the Aeroqual 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).

## What Data You Get

### Point History

Time-series sensor readings such as temperature, humidity, CO2, occupancy counts, energy consumption, light levels, and other measurable values from physical sensors

### Polling Schedule

* **Point History** -- Default polling: 1 hours (min: 1 hours, 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:

* Incorporate external weather conditions into building optimization models
* Correlate energy consumption with outdoor temperature and humidity trends

## Troubleshooting

<AccordionGroup>
  <Accordion title="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. Verify the username and password are correct and the account has not been locked in the Aeroqual system.
  </Accordion>

  <Accordion title="Discovery returns no devices">
    Verify the connector credentials have sufficient permissions in the Aeroqual system to list devices. Run a test connection first to confirm connectivity. Some systems require specific API scopes or roles for device enumeration.
  </Accordion>

  <Accordion title="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 Aeroqual API.
  </Accordion>
</AccordionGroup>