From 49545708766d8320ed42dc0443fd34f14590cb43 Mon Sep 17 00:00:00 2001 From: Kai Neuhaus Date: Fri, 8 Nov 2024 21:43:15 +0100 Subject: [PATCH] [kermi] updated README.md & fixed typos from review Signed-off-by: Kai Neuhaus --- .../README.md | 181 ++++++++------ .../kermi/internal/KermiBindingConstants.java | 6 +- .../handler/KermiXcenterThingHandler.java | 220 +++++++----------- .../resources/OH-INF/i18n/kermi.properties | 12 +- .../OH-INF/thing/bridge-kermi-xcenter.xml | 7 +- ...enter-charging-circuit-channel-groups.xml} | 2 +- ...center-charging-circuit-channel-types.xml} | 2 +- ... xcenter-energy-source-channel-groups.xml} | 2 +- ...> xcenter-energy-source-channel-types.xml} | 0 .../thing/xcenter-power-channel-types.xml | 14 +- ... xcenter-pv-modulation-channel-groups.xml} | 2 +- ...> xcenter-pv-modulation-channel-types.xml} | 2 +- .../thing/xcenter-state-channel-types.xml | 2 +- .../thing/xcenter-workhours-channel-types.xml | 12 +- 14 files changed, 223 insertions(+), 241 deletions(-) rename bundles/org.openhab.binding.modbus.kermi/src/main/resources/OH-INF/thing/{xcenter-chargingcircuit-channel-groups.xml => xcenter-charging-circuit-channel-groups.xml} (92%) rename bundles/org.openhab.binding.modbus.kermi/src/main/resources/OH-INF/thing/{xcenter-chargingcircuit-channel-types.xml => xcenter-charging-circuit-channel-types.xml} (94%) rename bundles/org.openhab.binding.modbus.kermi/src/main/resources/OH-INF/thing/{xcenter-energysource-channel-groups.xml => xcenter-energy-source-channel-groups.xml} (93%) rename bundles/org.openhab.binding.modbus.kermi/src/main/resources/OH-INF/thing/{xcenter-energysource-channel-types.xml => xcenter-energy-source-channel-types.xml} (100%) rename bundles/org.openhab.binding.modbus.kermi/src/main/resources/OH-INF/thing/{xcenter-pvmodulation-channel-groups.xml => xcenter-pv-modulation-channel-groups.xml} (94%) rename bundles/org.openhab.binding.modbus.kermi/src/main/resources/OH-INF/thing/{xcenter-pvmodulation-channel-types.xml => xcenter-pv-modulation-channel-types.xml} (96%) diff --git a/bundles/org.openhab.binding.modbus.kermi/README.md b/bundles/org.openhab.binding.modbus.kermi/README.md index 632938819eff5..7cfa85d7ac86f 100644 --- a/bundles/org.openhab.binding.modbus.kermi/README.md +++ b/bundles/org.openhab.binding.modbus.kermi/README.md @@ -26,20 +26,19 @@ This binding does not support autodiscovery. | Device | Device ID | Comment | |---------------------|-----------|-------------------------------------------------| -| X-Center | 40 | on cascade-circuits: slave1: 41, slave2: 42, ... | - +| X-Center | 40 | on cascade-circuits: slave1: 41, slave2: 42, ...| ## Thing Configuration -The needed Things can be found in the **Modbus Binding** and have to be added manually without Discovery +The needed Bridge can be found in the **Modbus Binding** and have to be added manually without Discovery. -1. Create _Modbus TCP Slave (Bridge)_ with matching Settings of your Kermi Device +1. Create _Modbus TCP Slave (Bridge)_ with matching Settings of your Kermi Device: - **IP Address** - IP Address or hostname of your heatpump - **Port** - Port of modbus on your heatpump (normally 502) - **Device ID** - ID on modbus, 40 is default for Kermi (see [Device IDs](#device-ids)) -2. Create _Kermi Heat Pump X-Center_ and attach it to the previous installed _Modbus TCP Slave (Bridge)_. Configuration requires an appropriate Data Refresh Interval with more than 2000 Milliseconds, default is 5000. If it's too fast, you may experience errors in openhab or your x-center ! (Reboot if x-center stops responding on network access). You can enable "PV Modulation" if you want to read the values (default: disabled) +1. Create _Kermi Heat Pump X-Center_ and attach it to the previous installed _Modbus TCP Slave (Bridge)_. Configuration requires an appropriate Data Refresh Interval with more than 2000 Milliseconds, default is 5000. If it's too fast, you may experience errors in openhab or your x-center ! (Reboot if x-center stops responding on network access). You can enable "PV Modulation" if you want to read the values (default: disabled) Details on Configurations explained below. @@ -49,15 +48,17 @@ Details on Configurations explained below. |-----------|---------|---------------------------------------------------------------| | host | text | IP Address or reachable hostname of your device | | port | integer | TCP Port of your Kermi device Modbus Settings. Default is 502 | -| deviceid | integer | Modbus ID of your Kermi device Modbus Settings. Default is 40 | +| deviceId | integer | Modbus ID of your Kermi device Modbus Settings. Default is 40 | ### Kermi Heat Pump X-Center Select as Bridge your previously created Modbus TCP Slave. -| Parameter | Type | Description | -|-----------------|---------|-------------------------------------------------------------------------| -| refresh | integer | Refresh Rate of x-center values in Milliseconds | +| Parameter | Type | Description | +|-----------|---------|----------------------------------------------------------------| +| refresh | integer | Refresh Rate of x-center values in Milliseconds (default:5000) | +| pvEnabled | boolean | Read PV-Modulation (default:false) | + ### Kermi StorageSystemModule (support planned in future releases) @@ -67,20 +68,7 @@ Select as Bridge a separate (second) Modbus TCP Slave. |-----------|---------|--------------------------------------------------------------------| | host | text | IP Address or reachable hostname of your device (same as x-center) | | port | integer | TCP Port of your Kermi device Modbus Settings. Default is 502 | -| deviceid | integer | Modbus ID of your Kermi device Modbus Settings. Default is 50 | - - -## Full Example - -Attention: Configuration by file is not recommended. You can configure everything in the main UI. - -### kermi.things - -```java -Bridge modbus:tcp:device "Kermi X-Center Modbus TCP" [ host="xcenter", port=502, id=40 ] { - Bridge kermi-xcenter heatpump "Kermi X-Center Heat Pump" [ refresh=5000 ] -} -``` +| deviceId | integer | Modbus ID of your Kermi device Modbus Settings. Default is 50 | ### Channel-Groups @@ -95,14 +83,13 @@ They are grouped into 7 channel-groups: - Alarm - PV Modulation - ### Channels #### Status -| Channel | Type | Description | -|-----------------|--------|----------------------------------------------------------------------| -| Global State ID | Number | State of heat pump as Number, displayed as readable State-Text in UI | +| Channel Id | Channel | Type | Description | +|-----------------|-----------------|--------|----------------------------------------------------------------------| +| global-state-id | Global State ID | Number | State of heat pump as Number, displayed as readable State-Text in UI | Possible states: @@ -116,81 +103,127 @@ Possible states: - EVU Blocktime - Unavailable - #### Energy-Source -| Channel | Type | Description | -|----------------------|---------------------|-------------------------------------------------| -| Exit temperature | Number | in °C - Air temperature exiting heat pump | -| Incoming temperature | Number | in °C - Air temperature incoming into heat pump | -| Temperature Outside | Number | in °C - Outside Air Temperature (if connected) | +| Channel Id | Channel Label | Channnel Id | Type | Description | +|----------------------------|----------------------|-------------|---------------------|-------------------------------------------------| +| exit-temperature | Exit temperature | | Number | in °C - Air temperature exiting heat pump | +| incoming-temperature | Incoming temperature | | Number | in °C - Air temperature incoming into heat pump | +| temperature-sensor-outside | Temperature Outside | | Number | in °C - Outside Air Temperature (if connected) | #### Charging Circuit -| Channel | Type | Description | -|--------------------|----------------------------|-----------------------------------------------------------------------------------| -| Flow temperature | Number | in °C - Water temperature **from** heat pump to drinking water or heating circuit | -| Return temperature | Number | in °C - Water temperature returning back **to** heat pump | -| Flow speed | Number | in l/min - Flow speed of the water | +| Channel Id | Channel Label | Type | Description | +|--------------------|--------------------|----------------------------|-----------------------------------------------------------------------------------| +| flow-temperature | Flow temperature | Number | in °C - Water temperature **from** heat pump to drinking water or heating circuit | +| return-temperature | Return temperature | Number | in °C - Water temperature returning back **to** heat pump | +| flow-speed | Flow speed | Number | in l/min - Flow speed of the water | #### Power and efficiency -| Channel | Type | Description | -|---------------------------------------|---------------|--------------------------------------------------| -| Current COP | Number | current cop overall (Coefficient Of Performance) | -| Current COP heating | Number | cop for heating | -| Current COP drinking water | Number | cop for drinking water | -| Current COP cooling | Number | cop for cooling | -| | | | -| Current power | Number | in W (Watt) - Power overall | -| Current power heating | Number | in W (Watt) - Power for heating | -| Current power drinking water | Number | in W (Watt) - Power for drinking water | -| Current power cooling | Number | in W (Watt) - Power for cooling | -| | | | -| Current electric power | Number | in W (Watt) - electric Power overall | -| Current electric power heating | Number | in W (Watt) - electric Power for heating | -| Current electric power drinking water | Number | in W (Watt) - electric Power for drinking water | -| Current electric power cooling | Number | in W (Watt) - electric Power for cooling | +| Channel Id | Channel Label | Type | Description | +|--------------------------------|---------------------------------------|---------------|--------------------------------------------------| +| cop | Current COP | Number | current cop overall (Coefficient Of Performance) | +| cop-heating | Current COP heating | Number | cop for heating | +| cop-drinkingwater | Current COP drinking water | Number | cop for drinking water | +| cop-cooling | Current COP cooling | Number | cop for cooling | +| | | | | +| power | Current power | Number | in W (Watt) - Power overall | +| power-heating | Current power heating | Number | in W (Watt) - Power for heating | +| power-drinkingwater | Current power drinking water | Number | in W (Watt) - Power for drinking water | +| power-cooling | Current power cooling | Number | in W (Watt) - Power for cooling | +| | | | | +| electrical-power | Current electric power | Number | in W (Watt) - electric Power overall | +| electrical-power-heating | Current electric power heating | Number | in W (Watt) - electric Power for heating | +| electrical-power-drinkingwater | Current electric power drinking water | Number | in W (Watt) - electric Power for drinking water | +| electrical-power-cooling | Current electric power cooling | Number | in W (Watt) - electric Power for cooling | #### Workhours -| Channel | Type | Description | -|--------------------------------|--------------|--------------------------------------------------------| -| Fan workhours | Number