[kermi] updated README.md & fixed typos from review

Signed-off-by: Kai Neuhaus <[email protected]>
openhab · Nov 8, 2024 · 4954570 · 4954570
1 parent 92db02f
commit 4954570
Show file tree

Hide file tree

Showing 14 changed files with 223 additions and 241 deletions.
diff --git a/bundles/org.openhab.binding.modbus.kermi/README.md b/bundles/org.openhab.binding.modbus.kermi/README.md
diff --git a/....kermi/src/main/java/org/openhab/binding/modbus/kermi/internal/KermiBindingConstants.java b/....kermi/src/main/java/org/openhab/binding/modbus/kermi/internal/KermiBindingConstants.java
@@ -31,11 +31,11 @@ public class KermiBindingConstants {
     static final String PV_READ_ERROR = "PV Modbus Read Error";
     public static final String ALARM_GROUP = "xcenter-alarm";
     public static final String STATE_GROUP = "xcenter-state";
-    public static final String ENERGYSOURCE_GROUP = "xcenter-energysource";
-    public static final String CHARGINGCIRCUIT_GROUP = "xcenter-chargingcircuit";
+    public static final String ENERGY_SOURCE_GROUP = "xcenter-energy-source";
+    public static final String CHARGING_CIRCUIT_GROUP = "xcenter-charging-circuit";
     public static final String POWER_GROUP = "xcenter-power";
     public static final String WORKHOURS_GROUP = "xcenter-workhours";
-    public static final String PV_GROUP = "xcenter-pvmodulation";
+    public static final String PV_GROUP = "xcenter-pv-modulation";
     private static final String BINDING_ID = ModbusBindingConstants.BINDING_ID;
 
     // Supported Thing Types

diff --git a/...main/java/org/openhab/binding/modbus/kermi/internal/handler/KermiXcenterThingHandler.java b/...main/java/org/openhab/binding/modbus/kermi/internal/handler/KermiXcenterThingHandler.java
diff --git a/bundles/org.openhab.binding.modbus.kermi/src/main/resources/OH-INF/i18n/kermi.properties b/bundles/org.openhab.binding.modbus.kermi/src/main/resources/OH-INF/i18n/kermi.properties
@@ -14,14 +14,14 @@ thing-type.config.modbus.kermi-xcenter.pvEnabled.description = Enabled reading o
 
 channel-group-type.modbus.xcenter-alarm-values.label = Alarm Values
 channel-group-type.modbus.xcenter-alarm-values.description = Alarm State of your Kermi Heatpump X-Center
-channel-group-type.modbus.xcenter-chargingcircuit-values.label = Charging Circuit
-channel-group-type.modbus.xcenter-chargingcircuit-values.description = Information about the charging circuit
-channel-group-type.modbus.xcenter-energysource-values.label = Energy-Source
-channel-group-type.modbus.xcenter-energysource-values.description = Information about the energy-source
+channel-group-type.modbus.xcenter-charging-circuit-values.label = Charging Circuit
+channel-group-type.modbus.xcenter-charging-circuit-values.description = Information about the charging circuit
+channel-group-type.modbus.xcenter-energy-source-values.label = Energy-Source
+channel-group-type.modbus.xcenter-energy-source-values.description = Information about the energy-source
 channel-group-type.modbus.xcenter-power-values.label = Power and efficency
 channel-group-type.modbus.xcenter-power-values.description = Information about power and efficiency
-channel-group-type.modbus.xcenter-pvmodulation-values.label = PV Modulation
-channel-group-type.modbus.xcenter-pvmodulation-values.description = PV Modulation Information and Settings for Kermi Heatpump X-Center
+channel-group-type.modbus.xcenter-pv-modulation-values.label = PV Modulation
+channel-group-type.modbus.xcenter-pv-modulation-values.description = PV Modulation Information and Settings for Kermi Heatpump X-Center
 channel-group-type.modbus.xcenter-state-values.label = Status
 channel-group-type.modbus.xcenter-state-values.description = Basic Information and State of your Kermi Heatpump X-Center
 channel-group-type.modbus.xcenter-workhours-values.label = Workhours

diff --git a/...org.openhab.binding.modbus.kermi/src/main/resources/OH-INF/thing/bridge-kermi-xcenter.xml b/...org.openhab.binding.modbus.kermi/src/main/resources/OH-INF/thing/bridge-kermi-xcenter.xml
@@ -11,18 +11,19 @@
 		<description>Provide Energy values, String Details and general Information of your Kermi Heat Pump</description>
 		<channel-groups>
 			<channel-group id="xcenter-state" typeId="xcenter-state-values"/>
-			<channel-group id="xcenter-energysource" typeId="xcenter-energysource-values"/>
-			<channel-group id="xcenter-chargingcircuit" typeId="xcenter-chargingcircuit-values"/>
+			<channel-group id="xcenter-energy-source" typeId="xcenter-energy-source-values"/>
+			<channel-group id="xcenter-charging-circuit" typeId="xcenter-charging-circuit-values"/>
 			<channel-group id="xcenter-power" typeId="xcenter-power-values"/>
 			<channel-group id="xcenter-workhours" typeId="xcenter-workhours-values"/>
 			<channel-group id="xcenter-alarm" typeId="xcenter-alarm-values"/>
-			<channel-group id="xcenter-pvmodulation" typeId="xcenter-pvmodulation-values"/>
+			<channel-group id="xcenter-pv-modulation" typeId="xcenter-pv-modulation-values"/>
 		</channel-groups>
 		<config-description>
 			<parameter name="refresh" type="integer" min="1000" unit="ms">
 				<label>Refresh Interval</label>
 				<description>Refresh Rate of Xcenter values in Milliseconds</description>
 				<default>5000</default>
+                <advanced>true</advanced>
 			</parameter>
 			<parameter name="pvEnabled" type="boolean">
 				<label>Read PV-Modulation States</label>

diff --git a/...center-chargingcircuit-channel-groups.xml → ...enter-charging-circuit-channel-groups.xml b/...center-chargingcircuit-channel-groups.xml → ...enter-charging-circuit-channel-groups.xml
@@ -3,7 +3,7 @@
 	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 	xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
 	xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
-	<channel-group-type id="xcenter-chargingcircuit-values">
+	<channel-group-type id="xcenter-charging-circuit-values">
 		<label>Charging Circuit</label>
 		<description>Information about the charging circuit</description>
 		<channels>

diff --git a/...xcenter-chargingcircuit-channel-types.xml → ...center-charging-circuit-channel-types.xml b/...xcenter-chargingcircuit-channel-types.xml → ...center-charging-circuit-channel-types.xml
@@ -18,7 +18,7 @@
 	<channel-type id="flow-speed-channel">
 		<item-type>Number:VolumetricFlowRate</item-type>
 		<label>Flow Speed</label>
-		<description>P13 - Flow speed in l/min</description>
+		<description>P13 - Flow speed</description>
 		<state pattern="%.1f %unit%"/>
 	</channel-type>
 </thing:thing-descriptions>
diff --git a/...g/xcenter-energysource-channel-groups.xml → .../xcenter-energy-source-channel-groups.xml b/...g/xcenter-energysource-channel-groups.xml → .../xcenter-energy-source-channel-groups.xml
@@ -3,7 +3,7 @@
 	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 	xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
 	xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
-	<channel-group-type id="xcenter-energysource-values">
+	<channel-group-type id="xcenter-energy-source-values">
 		<label>Energy-Source</label>
 		<description>Information about the energy-source</description>
 		<channels>

diff --git a/...ng/xcenter-energysource-channel-types.xml → ...g/xcenter-energy-source-channel-types.xml b/...ng/xcenter-energysource-channel-types.xml → ...g/xcenter-energy-source-channel-types.xml
diff --git a/...nhab.binding.modbus.kermi/src/main/resources/OH-INF/thing/xcenter-power-channel-types.xml b/...nhab.binding.modbus.kermi/src/main/resources/OH-INF/thing/xcenter-power-channel-types.xml
@@ -10,7 +10,7 @@
 	</channel-type>
 	<channel-type id="cop-heating-channel">
 		<item-type>Number</item-type>
-		<label>Current COP heating</label>
+		<label>Current COP Heating</label>
 		<state pattern="%d"/>
 	</channel-type>
 	<channel-type id="cop-drinkingwater-channel">
@@ -20,13 +20,13 @@
 	</channel-type>
 	<channel-type id="cop-cooling-channel">
 		<item-type>Number</item-type>
-		<label>Current COP cooling</label>
+		<label>Current COP Cooling</label>
 		<state pattern="%d"/>
 	</channel-type>
 
 	<channel-type id="power-channel">
 		<item-type>Number:Power</item-type>
-		<label>Current power</label>
+		<label>Current Power</label>
 		<state pattern="%.1f %unit%"/>
 	</channel-type>
 	<channel-type id="power-heating-channel">
@@ -36,7 +36,7 @@
 	</channel-type>
 	<channel-type id="power-drinkingwater-channel">
 		<item-type>Number:Power</item-type>
-		<label>Current power drinking water</label>
+		<label>Current Power Drinking Water</label>
 		<state pattern="%.1f %unit%"/>
 	</channel-type>
 	<channel-type id="power-cooling-channel">
@@ -47,12 +47,12 @@
 
 	<channel-type id="electric-power-channel">
 		<item-type>Number:Power</item-type>
-		<label>Current electric power</label>
+		<label>Current Electric Power</label>
 		<state pattern="%.1f %unit%"/>
 	</channel-type>
 	<channel-type id="electric-power-heating-channel">
 		<item-type>Number:Power</item-type>
-		<label>Current electric power heating</label>
+		<label>Current Electric Power Heating</label>
 		<state pattern="%.1f %unit%"/>
 	</channel-type>
 	<channel-type id="electric-power-drinkingwater-channel">
@@ -62,7 +62,7 @@
 	</channel-type>
 	<channel-type id="electric-power-cooling-channel">
 		<item-type>Number:Power</item-type>
-		<label>Current electric power cooling</label>
+		<label>Current Electric Power Cooling</label>
 		<state pattern="%.1f %unit%"/>
 	</channel-type>
 </thing:thing-descriptions>
diff --git a/...g/xcenter-pvmodulation-channel-groups.xml → .../xcenter-pv-modulation-channel-groups.xml b/...g/xcenter-pvmodulation-channel-groups.xml → .../xcenter-pv-modulation-channel-groups.xml
@@ -3,7 +3,7 @@
 	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 	xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
 	xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
-	<channel-group-type id="xcenter-pvmodulation-values">
+	<channel-group-type id="xcenter-pv-modulation-values">
 		<label>PV Modulation</label>
 		<description>PV Modulation Information and Settings for Kermi Heatpump X-Center</description>
 		<channels>

diff --git a/...ng/xcenter-pvmodulation-channel-types.xml → ...g/xcenter-pv-modulation-channel-types.xml b/...ng/xcenter-pvmodulation-channel-types.xml → ...g/xcenter-pv-modulation-channel-types.xml
@@ -4,7 +4,7 @@
 	xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
 	xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
 	<channel-type id="pv-state-channel">
-		<item-type>Contact</item-type>
+		<item-type>Switch</item-type>
 		<label>PV Modulation Active</label>
 		<description>State of PV-Modulation</description>
 	</channel-type>

diff --git a/...nhab.binding.modbus.kermi/src/main/resources/OH-INF/thing/xcenter-state-channel-types.xml b/...nhab.binding.modbus.kermi/src/main/resources/OH-INF/thing/xcenter-state-channel-types.xml
@@ -6,7 +6,7 @@
 	<channel-type id="global-state-id-channel">
 		<item-type>Number</item-type>
 		<label>Global State</label>
-		<description>Current mode of your heat pump</description>
+		<description>Current state of your heat pump</description>
 		<state readOnly="true" pattern="%d">
 			<options>
 				<option value="0">Standby</option>

diff --git a/....binding.modbus.kermi/src/main/resources/OH-INF/thing/xcenter-workhours-channel-types.xml b/....binding.modbus.kermi/src/main/resources/OH-INF/thing/xcenter-workhours-channel-types.xml
@@ -4,21 +4,21 @@
 	xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
 	xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
 	<channel-type id="workhours-fan-channel">
-		<item-type>Number:Time</item-type>
+		<item-type unitHint="h">Number:Time</item-type>
 		<label>Fan Workhours</label>
 		<description>Work hours of the fan</description>
-		<state pattern="%d h"/>
+		<state pattern="%d %unit%"/>
 	</channel-type>
 	<channel-type id="workhours-storage-loading-pump-channel">
-		<item-type>Number:Time</item-type>
+		<item-type unitHint="h">Number:Time</item-type>
 		<label>StorageLoadingPump Workhours</label>
 		<description>Work hours of the storage loading pump</description>
-		<state pattern="%d h"/>
+		<state pattern="%d %unit%"/>
 	</channel-type>
 	<channel-type id="workhours-compressor-channel">
-		<item-type>Number:Time</item-type>
+		<item-type unitHint="h">Number:Time</item-type>
 		<label>Compressor Workhours</label>
 		<description>Work hours of the compressor</description>
-		<state pattern="%d h"/>
+		<state pattern="%d %unit%"/>
 	</channel-type>
 </thing:thing-descriptions>