Renamed channel manual_fan_speed to manual_fan_step for consistency. (o…

…penhab#11147) Fixes openhab#10621 Signed-off-by: Jacob Laursen <[email protected]> Signed-off-by: Dave J Schoepel <[email protected]>
dschoepel · Nov 9, 2021 · 448d917 · 448d917
1 parent 2bf5330
commit 448d917
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 9 deletions.
diff --git a/bundles/org.openhab.binding.danfossairunit/README.md b/bundles/org.openhab.binding.danfossairunit/README.md
@@ -24,7 +24,7 @@ These are the available configuration parameters:
 |---|---|---|---|---|
 | current_time | main | DateTime | RO | Current time reported by the air unit.  |
 | mode | main | String | RW | Value to control the operation mode of the air unit. One of DEMAND, PROGRAM, MANUAL and OFF  |
-| manual_fan_speed | main | Dimmer | RW | Value to control the fan speed when in MANUAL mode (10 steps) |
+| manual_fan_step | main | Dimmer | RW | Value to control the fan step when in MANUAL mode (10 steps) |
 | supply_fan_speed | main | Number | RO | Current rotation of the fan supplying air to the rooms (in rpm) |
 | extract_fan_speed | main | Number | RO | Current rotation of the fan extracting air from the rooms (in rpm) |
 | supply_fan_step | main | Dimmer | RO | Current step setting of the fan supplying air to the rooms |
@@ -34,7 +34,7 @@ These are the available configuration parameters:
 | room_temp | temps | Number:Temperature | RO | Temperature of the air in the room of the Air Dial  |
 | room_temp_calculated | temps | Number:Temperature | RO | Calculated Room Temperature  |
 | outdoor_temp | temps | Number:Temperature | RO | Temperature of the air outside  |
-| humidity | humidity | Number:Dimensionless | RO | Current relative humidity measured by the unit  |
+| humidity | humidity | Number:Dimensionless | RO | Current relative humidity measured by the air unit  |
 | bypass | recuperator | Switch | RW | Disables the heat exchange. Useful in summer when room temperature is above target and outside temperature is below target.  |
 | supply_temp | recuperator | Number | RO | Temperature of air which is passed to the rooms  |
 | extract_temp | recuperator | Number | RO | Temperature of the air as extracted from the rooms  |

diff --git a/...ing.danfossairunit/src/main/java/org/openhab/binding/danfossairunit/internal/Channel.java b/...ing.danfossairunit/src/main/java/org/openhab/binding/danfossairunit/internal/Channel.java
@@ -28,8 +28,11 @@ public enum Channel {
 
     CHANNEL_CURRENT_TIME("current_time", ChannelGroup.MAIN, DanfossAirUnit::getCurrentTime),
     CHANNEL_MODE("mode", ChannelGroup.MAIN, DanfossAirUnit::getMode, DanfossAirUnit::setMode),
-    CHANNEL_MANUAL_FAN_SPEED("manual_fan_speed", ChannelGroup.MAIN, DanfossAirUnit::getManualFanSpeed,
-            DanfossAirUnit::setManualFanSpeed),
+    // Backwards compatibility as channel was renamed from manual_fan_speed to manual_fan_step.
+    CHANNEL_MANUAL_FAN_SPEED("manual_fan_speed", ChannelGroup.MAIN, DanfossAirUnit::getManualFanStep,
+            DanfossAirUnit::setManualFanStep),
+    CHANNEL_MANUAL_FAN_STEP("manual_fan_step", ChannelGroup.MAIN, DanfossAirUnit::getManualFanStep,
+            DanfossAirUnit::setManualFanStep),
     CHANNEL_EXTRACT_FAN_SPEED("extract_fan_speed", ChannelGroup.MAIN, DanfossAirUnit::getExtractFanSpeed),
     CHANNEL_SUPPLY_FAN_SPEED("supply_fan_speed", ChannelGroup.MAIN, DanfossAirUnit::getSupplyFanSpeed),
     CHANNEL_EXTRACT_FAN_STEP("extract_fan_step", ChannelGroup.MAIN, DanfossAirUnit::getExtractFanStep),

diff --git a/...fossairunit/src/main/java/org/openhab/binding/danfossairunit/internal/DanfossAirUnit.java b/...fossairunit/src/main/java/org/openhab/binding/danfossairunit/internal/DanfossAirUnit.java
@@ -161,7 +161,7 @@ public StringType getMode() throws IOException {
         return new StringType(Mode.values()[getByte(REGISTER_1_READ, MODE)].name());
     }
 
-    public PercentType getManualFanSpeed() throws IOException {
+    public PercentType getManualFanStep() throws IOException {
         return new PercentType(BigDecimal.valueOf(getByte(REGISTER_1_READ, MANUAL_FAN_SPEED_STEP) * 10));
     }
 
@@ -242,7 +242,7 @@ public DateTimeType getCurrentTime() throws IOException, UnexpectedResponseValue
         return new DateTimeType(timestamp);
     }
 
-    public PercentType setManualFanSpeed(Command cmd) throws IOException {
+    public PercentType setManualFanStep(Command cmd) throws IOException {
         return setPercentTypeRegister(cmd, MANUAL_FAN_SPEED_STEP);
     }
 

diff --git a/bundles/org.openhab.binding.danfossairunit/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.danfossairunit/src/main/resources/OH-INF/thing/thing-types.xml
@@ -48,6 +48,7 @@
 		<channels>
 			<channel id="current_time" typeId="currentTime"/>
 			<channel id="mode" typeId="mode"/>
+			<channel id="manual_fan_step" typeId="manualFanStep"/>
 			<channel id="manual_fan_speed" typeId="manualFanSpeed"/>
 			<channel id="supply_fan_speed" typeId="supplyFanSpeed"/>
 			<channel id="extract_fan_speed" typeId="extractFanSpeed"/>
@@ -85,7 +86,7 @@
 		<label>Humidity</label>
 		<channels>
 			<channel id="humidity" typeId="humidity">
-				<description>Current relative humidity measured by the unit</description>
+				<description>Current relative humidity measured by the air unit</description>
 			</channel>
 		</channels>
 	</channel-group-type>
@@ -147,13 +148,20 @@
 			</options>
 		</state>
 	</channel-type>
-	<channel-type id="manualFanSpeed">
+	<channel-type id="manualFanStep">
 		<item-type>Dimmer</item-type>
-		<label>Manual Fan Speed</label>
+		<label>Manual Fan Step</label>
 		<description>Controls 10-step setting of the fan when operation mode is manual</description>
 		<category>Fan</category>
 		<state step="10" min="0" max="100"/>
 	</channel-type>
+	<channel-type id="manualFanSpeed" advanced="true">
+		<item-type>Dimmer</item-type>
+		<label>Manual Fan Speed</label>
+		<description>Deprecated, please use Manual Fan Step instead. This channel will be removed in a later version.</description>
+		<category>Fan</category>
+		<state step="10" min="0" max="100"/>
+	</channel-type>
 	<channel-type id="supplyFanSpeed">
 		<item-type>Number</item-type>
 		<label>Supply Fan Speed</label>