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

# Nimway

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

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

## Overview

Use this integration to connect Nimway smart-office data to KODE OS. You can discover desks, rooms, and sensors, combine scheduled polling with webhooks for fresher state, and unify occupancy with booking and navigation signals where the API exposes them.

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

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data
* Collect Non-Sensor Data
* Receive Webhook Data

## Prerequisites

* An active account with Nimway and access to their API or developer portal
* OAuth client credentials (Client ID and Client Secret) from the Nimway developer portal
* KODE OS environment with access to Data Sources

## Generate API Credentials

1. Log in to the Nimway developer portal or admin console
2. Navigate to the API or developer settings section
3. Create a new API application or client
4. Note the **Client ID** and **Client Secret** -- you will need these when configuring the connector in KODE OS
5. Note the **Auth URL** for OAuth token exchange

## Configure Webhook

This integration uses webhooks for real-time data delivery. After creating the connector in KODE OS:

1. Copy the webhook URL provided on the connector detail page
2. In the Nimway platform, navigate to the webhook or notification settings
3. Add a new webhook endpoint using the KODE OS URL
4. Configure the authentication header as specified on the connector detail page
5. Save and enable the webhook

## Configure Connector in KODE OS

1. Navigate to **Data Sources** in your building
2. Click **API Catalog** and search for **Nimway**
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          |
| **Auth URL**        | Yes      | text     | The OAuth authorization URL for token exchange             |
| **Client ID**       | Yes      | password | The OAuth client ID from the vendor's developer portal     |
| **Client Secret**   | Yes      | password | The OAuth client secret from the vendor's developer portal |
| **API Building ID** | Yes      | text     | The building or source identifier in the external system   |

## Discover Devices and Points

After configuring the connector, click **Discover** on the connector detail page. KODE OS will query the Nimway 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 Nimway, 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 | `occupancy`   | **free** -- space is available / **occupied** -- space is currently in use | --   | No       | `map`          | Webhook    |
| 2 | `peopleCount` | Number of people currently detected in the space                           | --   | No       | `map`          | Webhook    |
| 3 | `accuracy`    | Measurement accuracy confidence level                                      | --   | No       | --             | Webhook    |

### Presence / Occupancy Sensor

Canonical Type: `presenceDetection`

| # | Point   | Description             | Unit | Writable | Collection |
| - | ------- | ----------------------- | ---- | -------- | ---------- |
| 1 | `level` | Current occupancy level | --   | No       | Webhook    |

## What Data You Get

### Point History

Time-series readings including occupancy, peopleCount, accuracy, level, collected at regular intervals from connected devices

### Polling Schedule

* **Point History** -- Default polling: 30 minutes (min: 30 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 Client ID and Client Secret match the values from the Nimway developer portal.
  </Accordion>

  <Accordion title="Webhook data not arriving">
    Verify the webhook URL is correctly registered in the Nimway platform. Check that the authentication header matches the value from the KODE OS connector detail page. Ensure the Nimway system can reach the KODE OS webhook endpoint over the network.
  </Accordion>

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