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

# Kaiterra

> Connect Kaiterra to KODE OS for indoor environmental quality data

> Connect Kaiterra to KODE OS for indoor environmental quality data integration

## Overview

Use this integration to connect Kaiterra to KODE OS. You can discover air quality devices and points, receive IEQ readings through push collection with snapshot mode, and monitor healthy-building metrics from Data Sources.

| Property            | Value                        |
| ------------------- | ---------------------------- |
| **System Type**     | Indoor Environmental Quality |
| **Communication**   | REST                         |
| **Collection**      | Push                         |
| **Collection Mode** | SNAPSHOT                     |

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data
* File Validation

## Prerequisites

* An active account with Kaiterra and access to their API or developer portal
* API key or token from the Kaiterra platform
* KODE OS environment with access to Data Sources

## Generate API Credentials

1. Log in to the Kaiterra platform or admin console
2. Navigate to the API settings, developer section, or account settings
3. Generate a new API key or token
4. Copy the key and store it securely -- you will need it when configuring the connector in KODE OS

## Configure Connector in KODE OS

1. Navigate to **Data Sources** in your building
2. Click **API Catalog** and search for **Kaiterra**
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                         |
| **API Key** | Yes      | password | The API key for authenticating with the external system                   |
| **File**    | Yes      | file     | An upload file used during discovery (e.g., device whitelist spreadsheet) |

## Discover Devices and Points

After configuring the connector, click **Discover** on the connector detail page. KODE OS will query the Kaiterra 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 Kaiterra, KODE OS maps them to the following device types and data points:

### Air Quality Sensor

Canonical Type: `airQuality`

| # | Point    | Description                                            | Unit                          | Writable | Ontology Field                        | Collection |
| - | -------- | ------------------------------------------------------ | ----------------------------- | -------- | ------------------------------------- | ---------- |
| 1 | `rpm10c` | Coarse particulate matter (PM10) concentration (µg/m³) | micrograms\_per\_cubic\_meter | No       | `pm10_concentration_detection_sensor` | Polling    |
| 2 | `rpm25c` | Fine particulate matter (PM2.5) concentration (µg/m³)  | micrograms\_per\_cubic\_meter | No       | `pm25_concentration_detection_sensor` | Polling    |
| 3 | `rhumid` | Relative humidity level (%)                            | %                             | No       | `zone_air_humidity_sensor`            | Polling    |
| 4 | `rtemp`  | Current temperature reading (°C)                       | °C                            | No       | `zone_air_temperature_sensor`         | Polling    |
| 5 | `rco2`   | Carbon dioxide (CO₂) concentration (ppm)               | ppm                           | No       | `co2_concentration_detection_sensor`  | Polling    |
| 6 | `rtvoc`  | Volatile organic compound (VOC) level (ppb)            | parts\_per\_billion           | No       | `voc_concentration_detection_sensor`  | Polling    |

## What Data You Get

### Point History

Time-series readings including rpm10c, rpm25c, rhumid, rtemp, rco2, rtvoc, 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

<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. Ensure the API key or token is valid and has not been revoked or expired in the Kaiterra platform.
  </Accordion>

  <Accordion title="Discovery returns no devices">
    Verify the connector credentials have sufficient permissions in the Kaiterra 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 Kaiterra API.
  </Accordion>
</AccordionGroup>