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

# Walchem Fluent

> Connect Walchem Fluent to KODE OS for meters data

> Connect Walchem Fluent to KODE OS for meters data integration

## Overview

Use this integration to connect Walchem Fluent cloud controllers to KODE OS. You can discover treatment assets and collect snapshot sensor readings plus alarm streams—for example flow-related points—so water-treatment performance appears next to your other facility telemetry.

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

## Supported Capabilities

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

## Prerequisites

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

## Generate API Credentials

1. Log in to the Walchem Fluent 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 **Walchem Fluent**
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 |
| **API Key**  | Yes      | password | The API key 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 Walchem Fluent 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

| Point              | Display Name     |
| ------------------ | ---------------- |
| `RELAY_FLOW_TIMER` | Relay Flow Timer |
| `Flow`             | Flow             |
| `No Flow`          | No Flow          |

## What Data You Get

### Point History

Time-series sensor readings such as temperature, humidity, CO2, occupancy counts, energy consumption, light levels, and other measurable values from physical sensors

### 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: 1 minutes (min: 1 minutes, max: 1 hours)
* **Alarm** -- 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:

* Aggregate utility consumption data (electricity, gas, water, steam) in a unified dashboard
* Detect abnormal consumption patterns and potential waste or leaks
* Generate utility cost reports and benchmark buildings in your portfolio

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

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