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

# Kolo

> Connect Kolo to KODE OS for smart bathroom data

> Connect Kolo to KODE OS for smart bathroom data integration

## Overview

Use this integration to connect Kolo smart restroom dispensers and fixtures to KODE OS. You discover devices, monitor fill and fault points, and ingest hygiene-related records over REST.

| Property            | Value          |
| ------------------- | -------------- |
| **System Type**     | Smart Bathroom |
| **Communication**   | REST           |
| **Collection**      | Pull           |
| **Collection Mode** | SNAPSHOT       |

## Supported Capabilities

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

## Prerequisites

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

## Generate API Credentials

1. Log in to the Kolo 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 **Kolo**
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           |
| **Username**        | Yes      | text     | The username for authenticating with the external system |
| **Password**        | Yes      | password | The password for authenticating with the external system |
| **API Key**         | Yes      | password | The API key for authenticating with the external system  |
| **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 Kolo 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 Kolo, KODE OS maps them to the following device types and data points:

### Dispenser

Canonical Type: `sanitation`

| # | Point           | Description               | Unit | Writable | Collection |
| - | --------------- | ------------------------- | ---- | -------- | ---------- |
| 1 | `battery_level` | Device battery level (%)  | %    | No       | Polling    |
| 2 | `battery_state` | Current battery condition | --   | No       | Polling    |

## What Data You Get

### Point History

Time-series readings including battery\_level, battery\_state, collected at regular intervals from connected devices

### Alarms

Alert and fault notifications including alarm name, priority, status, timestamps, device association, and acknowledgment state

KODE OS maps Kolo data to these standard fields:

| KODE Field       | Source Field                    | Notes       |
| ---------------- | ------------------------------- | ----------- |
| **id**           | `alertId`                       | --          |
| **location**     | `deviceLocationId`              | --          |
| **deviceId**     | `String.join(", ", deviceMacId` | --          |
| **status**       | `alertStatus`                   | --          |
| **description**  | `alertType`                     | --          |
| **createdAt**    | `createdDate`                   | transformed |
| **completedAt**  | `resolvedDate`                  | transformed |
| **customFields** | `(custom fields)`               | --          |

### Polling Schedule

* **Point History** -- Default polling: 1 minutes (min: 1 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 restroom fixture usage and supply levels in real time
* Dispatch cleaning crews based on actual usage data rather than fixed schedules
* Track water consumption and identify fixtures requiring maintenance

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

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