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

# Water Intelligence

> Connect Water Intelligence to KODE OS for leak detection data

> Connect Water Intelligence to KODE OS for leak detection data integration

## Overview

Use this integration to connect WINT water intelligence to KODE OS. You discover devices, collect leak and consumption signals, and pull historical data for monitoring and trend analysis.

| Property            | Value          |
| ------------------- | -------------- |
| **System Type**     | Leak Detection |
| **Communication**   | REST           |
| **Collection**      | Pull           |
| **Collection Mode** | SNAPSHOT       |

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data
* Collect Historical Data

## Prerequisites

* An active account with Water Intelligence and access to their API or developer portal
* Username and password credentials for the Water Intelligence system
* KODE OS environment with access to Data Sources

## Configure Connector in KODE OS

1. Navigate to **Data Sources** in your building
2. Click **API Catalog** and search for **Water Intelligence**
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        |
| **Username**        | Yes      | text     | The username for authenticating with the external system |
| **Password**        | Yes      | password | The password 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 Water Intelligence 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 Water Intelligence, KODE OS maps them to the following device types and data points:

### Leak Sensor

Canonical Type: `default`

| #  | Point                   | Description                                               | Unit    | Writable | Collection |
| -- | ----------------------- | --------------------------------------------------------- | ------- | -------- | ---------- |
| 1  | `power_source`          | Current power source type                                 | --      | No       | Polling    |
| 2  | `auto_water_shutoff`    | Automatic water shutoff status                            | --      | No       | Polling    |
| 3  | `leak_detection`        | Leak detection system status                              | --      | No       | Polling    |
| 4  | `valve_status`          | Current valve position status                             | --      | No       | Polling    |
| 5  | `leak_exist`            | **True** -- leak detected / **False** -- no leak detected | --      | No       | Polling    |
| 6  | `leak_type`             | Type of leak detected                                     | --      | No       | Polling    |
| 7  | `leak_level`            | Severity level of the detected leak                       | --      | No       | Polling    |
| 8  | `leak_amount`           | Volume of water lost from the leak                        | --      | No       | Polling    |
| 9  | `leak_duration`         | Duration of the detected leak (s)                         | seconds | No       | Polling    |
| 10 | `leak_flowrate`         | Flow rate of the detected leak                            | --      | No       | Polling    |
| 11 | `last_hour_consumption` | Water consumption in the last hour                        | --      | No       | Polling    |

## What Data You Get

### Point History

Time-series readings including power\_source, auto\_water\_shutoff, leak\_detection, valve\_status, leak\_exist, leak\_type, leak\_level, leak\_amount, and 3 more, 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:

* Receive real-time alerts when water leaks or abnormal flow is detected
* Track leak event history and response times for compliance reporting
* Correlate water consumption data with leak detection sensors

## 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 Water Intelligence system.
  </Accordion>

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