# Interface Mapping Documentation - Yellow Poolcontrol

This documentation describes the data points for the external interfaces **MQTT**, **BAOS (KNX)**, and **Modbus TCP/RTU**.

## Addressing Scheme
- **Modbus:** All addresses are holding registers (4xxxx).
- **BAOS (KNX):** IDs correspond to KNX object numbers.
- **MQTT:** The base topic is configurable (`mqtt_topic`, default: `Netplus`).
- **Scaling:** Analog values are transmitted as integers. A factor of 100 means the value must be divided by 100 (e.g., 720 -> 7.20).

## MQTT Behavior

### Topic Structure
- **baseTopic:** Please refer to the MQTT settings of your device for the base topic (default: `netplus`).
- **State topic (read):** `/`
- **Command topic (write):** `//set`
- Example: With `baseTopic=Netplus` and `topic=flag.system.enable`:
  - Read: `Netplus/flag.system.enable`
  - Write: `Netplus/flag.system.enable/set`

### Payload Format
- Encoding: UTF-8
- QoS: `1`
- Retain: `false`
- Boolean values: `true/false` or `1/0` (incoming `true` or `1` is interpreted as `True`).
---

### 1. System Status (General)
| Data Point | MQTT | BAOS ID | Modbus | Type | Scaling | Description |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- |
| `flag.system.enable` | `rw` | 1 | 40001 | Bool | - | Main system switch (On/Off) |
| `flag.system.ready` | `r` | 3 | 40002 | Bool | - | System ready for operation |
| `flag.error` | `r` | 2 | 40003 | Bool | - | Collective alarm active |

### 2. Measurements (Actual Values)
| Data Point | MQTT | BAOS ID | Modbus | Type | Scaling | Description |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- |
| `variable.temperature.actualValue` | `r` | 101 | 40101 | Int | 100 | Water temperature (°C) |
| `variable.ph.actualValue` | `r` | 102 | 40102 | Int | 100 | pH value |
| `variable.chlorine.actualValue` | `r` | 103 | 40103 | Int | 100 | Free chlorine (mg/l) |
| `variable.redox.actualValue` | `r` | 104 | 40104 | Int | 1 | Redox potential (mV) |
| `variable.activeChlorine.actualValue` | `r` | 105 | 40105 | Int | 100 | Active chlorine HOCl (mg/l) |
| `variable.flow.actualValue` | `r` | 106 | 40106 | Int | 1 | Measuring water flow (l/h) |

### 3. Setpoints (Settings)
| Data Point | MQTT | BAOS ID | Modbus | Type | Scaling | Description |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- |
| `setpoint.phLower.setpoint` | `rw` | 201 | 40201 | Int | 100 | pH lowering setpoint |
| `setpoint.phRaise.setpoint` | `rw` | 202 | 40202 | Int | 100 | pH raising setpoint |
| `setpoint.chlorine.setpoint` | `rw` | 203 | 40203 | Int | 100 | Chlorine setpoint |
| `setpoint.temperature.setpoint.normal` | `rw` | 204 | 40204 | Int | 100 | Temperature setpoint |
| `setpoint.redox.setpoint` | `rw` | 205 | 40205 | Int | 1 | Redox setpoint |

### 4. Control & Actuators
| Data Point | MQTT | BAOS ID | Modbus | Type | Scaling | Description |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- |
| `flag.disinfection.automatic` | `rw` | 301 | 40301 | Bool | - | Automatic disinfection |
| `flag.phLower.controller.mode` | `rw` | 302 | 40302 | Bool | - | Automatic pH control |
| `flag.temperature.automatic` | `rw` | 303 | 40303 | Bool | - | Automatic heating |
| `actuator.circulationPump` | `r` | 304 | 40304 | Bool | - | Circulation pump status |
| `variable.ecoTouch.stage` | `r` | 309 | 40309 | Int | 1 | Current pump stage (0-3) |
| `actuator.light1` | `rw` | 305 | 40305 | Bool | - | Pool lighting On/Off |
| `flag.partyMode.active` | `rw` | 306 | 40306 | Bool | - | Party mode On/Off |
| `flag.ecoMode.active` | `r` | 307 | 40307 | Bool | - | ECO mode active (status) |
| `flag.holidayMode.enable` | `rw` | 308 | 40308 | Bool | - | Holiday mode On/Off |
| `flag.frostProtection.enable` | `rw` | 310 | 40310 | Bool | - | Frost protection On/Off |

### 5. Alarms & Maintenance
| Data Point | MQTT | BAOS ID | Modbus | Type | Scaling | Description |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- |
| `flag.disinfection.containerEmpty.message` | `r` | 401 | 40401 | Bool | - | Disinfection container empty |
| `flag.phLower.containerEmpty.message` | `r` | 402 | 40402 | Bool | - | pH container empty |
| `flag.circulation.fault` | `r` | 403 | 40403 | Bool | - | Flow fault / circulation fault |
    

*Documentation created on: January 31, 2026*