Skip to content

Commit

Permalink
[kermi] updated README.md, fixed wording for X-Center
Browse files Browse the repository at this point in the history
Signed-off-by: Kai Neuhaus <[email protected]>
  • Loading branch information
KaaNee committed Nov 11, 2024
1 parent ad9c0ad commit fe73d96
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
14 changes: 8 additions & 6 deletions bundles/org.openhab.binding.modbus.kermi/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Kermi Heat pump

Integrates the X-Center Device (x-center pro) of Kermi Heat pump.
Integrates the X-Center Device (X-Center Pro) of Kermi Heat pump.
Kermi X-Center & other attached devices (in progress) are integrated into the Modbus Binding.

This binding was tested and developed with Kermi x-change dynamic pro heat pump (build 2023).

Hint: This binding _may_ also work with devices from "Bösch" in Austria, which is a sub-brand of Kermi, they are nearly identically.

## Prerequisite

Requirement is contacting Kermi Support to activate Modbus-TCP which can be connected directly by network.
Expand Down Expand Up @@ -40,8 +42,8 @@ The needed Bridge can be found in the **Modbus Binding** and have to be added ma

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.
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.
Expand All @@ -60,7 +62,7 @@ Select as Bridge your previously created Modbus TCP Slave.

| Parameter | Type | Description |
|-----------|---------|----------------------------------------------------------------|
| refresh | integer | Refresh Rate of x-center values in Milliseconds (default:5000) |
| refresh | integer | Refresh Rate of X-Center values in Milliseconds (default:5000) |
| pvEnabled | boolean | Read PV-Modulation (default:false) |


Expand All @@ -70,7 +72,7 @@ Select as Bridge a separate (second) Modbus TCP Slave.

| Parameter | Type | Description |
|-----------|---------|--------------------------------------------------------------------|
| host | text | IP Address or reachable hostname of your device (same as x-center) |
| 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 |

Expand Down Expand Up @@ -180,7 +182,7 @@ Bridge modbus:tcp:device "Kermi X-Center Modbus TCP" [ host="xcenter", port=502,
### Items

```java
Number XCenter_Global_State_Id "XCenter Global State ID" (kermi) { channel="modbus:tcp:device:heatpump:state#global-state-id" }
Number XCenter_Global_State_Id "X-Center Global State ID" (kermi) { channel="modbus:tcp:device:heatpump:state#global-state-id" }

Number:Temperature Heatpump_FlowTemperature "Flow Temperature" (kermi,persist) { channel="modbus:tcp:device:heatpump:charging-circuit#flow-temperature" }
Number:Temperature Heatpump_ReturnTemperature "Return Temperature" (kermi,persist) { channel="modbus:tcp:device:heatpump:charging-circuit#return-temperature" }
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# thing types

thing-type.modbus.kermi-xcenter.label = Kermi XCenter Heat Pump
thing-type.modbus.kermi-xcenter.label = Kermi X-Center Heat Pump
thing-type.modbus.kermi-xcenter.description = Provide Energy values, String Details and general Information of your Kermi Heat Pump

# thing types config
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<config-description>
<parameter name="refresh" type="integer" min="1000" unit="ms">
<label>Refresh Interval</label>
<description>Refresh Rate of Xcenter values in Milliseconds</description>
<description>Refresh Rate of X-Center values in Milliseconds</description>
<default>5000</default>
<advanced>true</advanced>
</parameter>
Expand Down

0 comments on commit fe73d96

Please sign in to comment.