> ## 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. # Eddy > Connect Eddy to KODE OS for leak detection data > Connect Eddy to KODE OS for leak detection data integration ## Overview Use this integration to connect Eddy leak detection to KODE OS. You discover sensors, pull consumption and leak events, and retain historical trends over REST. | Property | Value | | ------------------- | -------------- | | **System Type** | Leak Detection | | **Communication** | REST | | **Collection** | Pull | | **Collection Mode** | HISTORICAL | ## Supported Capabilities * Discover Devices & Points * Collect Sensor Data * Collect Non-Sensor Data ## Prerequisites * An active account with Eddy and access to their API or developer portal * Username and password credentials for the Eddy 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 **Eddy** 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 | ## Discover Devices and Points After configuring the connector, click **Discover** on the connector detail page. KODE OS will query the Eddy 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 Eddy, KODE OS maps them to the following device types and data points: ### Leak Sensor Canonical Type: `default` | # | Point | Description | Unit | Writable | Collection | | -- | ------------------------- | ---------------------------------------------------------------- | ---- | -------- | ---------- | | 1 | `temperature` | Current temperature reading | -- | No | Polling | | 2 | `relative_humidity` | Relative humidity level | -- | No | Polling | | 3 | `leak_detected` | **True** -- leak detected / **False** -- no leak detected | -- | No | Polling | | 4 | `alert_temperature` | Temperature alert threshold | -- | No | Polling | | 5 | `alert_relative_humidity` | Humidity alert threshold | -- | No | Polling | | 6 | `battery` | Device battery level | -- | No | Polling | | 7 | `signal_strength` | Wireless signal strength | -- | No | Polling | | 8 | `signal_quality` | Wireless signal quality indicator | -- | No | Polling | | 9 | `max_temperature` | Maximum recorded temperature | -- | No | Polling | | 10 | `min_temperature` | Minimum recorded temperature | -- | No | Polling | | 11 | `max_humidity` | Maximum recorded humidity level | -- | No | Polling | | 12 | `min_humidity` | Minimum recorded humidity level | -- | No | Polling | | 13 | `is_minor_leak` | **True** -- minor leak detected / **False** -- no minor leak | -- | No | Polling | | 14 | `is_major_leak` | **True** -- major leak detected / **False** -- no major leak | -- | No | Polling | | 15 | `is_extreme_leak` | **True** -- extreme leak detected / **False** -- no extreme leak | -- | No | Polling | | 16 | `valve_position` | **True** -- valve is open / **False** -- valve is closed | -- | No | Polling | | 17 | `valve_status` | Current valve position status | -- | No | Polling | | 18 | `odometer` | Cumulative flow measurement (odometer reading) | -- | No | Polling | | 19 | `volume` | Total volume measured | -- | No | Polling | | 20 | `pressure_out` | Outlet pressure reading | -- | No | Polling | | 21 | `pressure_in` | Inlet pressure reading | -- | No | Polling | ## What Data You Get ### Point History Time-series readings including temperature, relative\_humidity, leak\_detected, alert\_temperature, alert\_relative\_humidity, battery, signal\_strength, signal\_quality, and 13 more, 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 the collected data to these standard fields: | KODE Field | Description | | --------------- | ---------------------------------------------------------- | | **ID** | Unique alarm identifier | | **Name** | Alarm name or title | | **Description** | Detailed alarm description | | **Category** | Alarm category (e.g., Building Automation, Security, Fire) | | **Priority** | Alarm priority or severity level | | **Status** | Current alarm state (e.g., Active, Acknowledged, Cleared) | | **Device ID** | ID of the device that generated the alarm | | **Device Name** | Name of the device that generated the alarm | | **Location** | Physical location of the alarm source | | **Updated By** | Person who last updated the alarm | | **Created At** | Timestamp when the alarm was generated | | **Started At** | Timestamp when the alarm condition started | | **Cleared At** | Timestamp when the alarm was cleared or resolved | | **Updated At** | Timestamp of the last alarm state change | ### Polling Schedule * **Point History** -- Default polling: 10 minutes (min: 10 minutes, max: 1 hours) * **Alarm** -- Default polling: 1 hours (min: 1 hours, max: 1 days) 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 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 Eddy system. Verify the connector credentials have sufficient permissions in the Eddy system to list devices. Run a test connection first to confirm connectivity. Some systems require specific API scopes or roles for device enumeration. 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 Eddy API.