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

# Avuity

> Connect Avuity to KODE OS for occupancy, indoor environmental quality data

> Connect Avuity to KODE OS for occupancy, indoor environmental quality data integration

## Overview

Use this integration to connect Avuity to KODE OS. You can discover space and sensor assets, then pull snapshot occupancy alongside indoor environmental quality points so workplace utilization and comfort signals stay aligned in one model.

| Property            | Value                                   |
| ------------------- | --------------------------------------- |
| **System Type**     | Occupancy, Indoor Environmental Quality |
| **Communication**   | REST                                    |
| **Collection**      | Pull                                    |
| **Collection Mode** | SNAPSHOT                                |

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data

## Prerequisites

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

## Generate API Credentials

1. Log in to the Avuity 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 **Avuity**
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         |
| **Token** | Yes      | password | The API token 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 Avuity 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 Avuity, KODE OS maps them to the following device types and data points:

### Presence / Occupancy Sensor

Canonical Type: `presenceDetection`

| # | Point       | Description                                                          | Unit  | Writable | Ontology Field              | Collection |
| - | ----------- | -------------------------------------------------------------------- | ----- | -------- | --------------------------- | ---------- |
| 1 | `occupancy` | Number of people currently detected in the space                     | count | No       | `occupancy_count`           | Polling    |
| 2 | `capacity`  | Maximum people capacity threshold                                    | count | No       | `threshold_people_capacity` | Polling    |
| 3 | `isActive`  | **True** -- isActive is active / **False** -- isActive is not active | --    | No       | --                          | Polling    |

### Air Quality Sensor

Canonical Type: `airQuality`

| # | Point         | Description                        | Unit     | Writable | Ontology Field                | Collection |
| - | ------------- | ---------------------------------- | -------- | -------- | ----------------------------- | ---------- |
| 1 | `temperature` | Current temperature reading (°F)   | °F       | No       | `zone_air_temperature_sensor` | Polling    |
| 2 | `humidity`    | Relative humidity level (humidity) | humidity | No       | `zone_air_humidity_sensor`    | Polling    |

## What Data You Get

### Point History

Time-series readings including occupancy, capacity, isActive, temperature, humidity, 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:

* Track real-time space utilization rates across floors and zones
* Optimize HVAC and lighting schedules based on actual occupancy patterns
* Generate utilization reports to inform space planning and real estate decisions
* Monitor air quality metrics (CO2, VOC, humidity, temperature) across all occupied spaces

## 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 Avuity platform.
  </Accordion>

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