[robonect] Add blade status channel (#15061)

* Add blade status channel in Robonect binding Signed-off-by: Christian Jonak-Möchel <[email protected]> Signed-off-by: Leo Siepel <[email protected]>
openhab · Oct 16, 2024 · 896abdb · 896abdb
1 parent 926f680
commit 896abdb
Show file tree

Hide file tree

Showing 9 changed files with 171 additions and 38 deletions.
diff --git a/bundles/org.openhab.binding.robonect/README.md b/bundles/org.openhab.binding.robonect/README.md
diff --git a/...obonect/src/main/java/org/openhab/binding/robonect/internal/RobonectBindingConstants.java b/...obonect/src/main/java/org/openhab/binding/robonect/internal/RobonectBindingConstants.java
@@ -54,6 +54,10 @@ public class RobonectBindingConstants {
     public static final String CHANNEL_HEALTH_TEMP = "health-temperature";
     public static final String CHANNEL_HEALTH_HUM = "health-humidity";
 
+    public static final String CHANNEL_BLADES_QUALITY = "blades-quality";
+    public static final String CHANNEL_BLADES_REPL_DAYS = "blades-replacement-days";
+    public static final String CHANNEL_BLADES_USAGE_HOURS = "blades-usage-hours";
+
     public static final String PROPERTY_COMPILED = "compiled";
     public static final String PROPERTY_COMMENT = "comment";
 }
diff --git a/...robonect/src/main/java/org/openhab/binding/robonect/internal/handler/RobonectHandler.java b/...robonect/src/main/java/org/openhab/binding/robonect/internal/handler/RobonectHandler.java
@@ -248,6 +248,11 @@ private void refreshMowerInfo() {
                         new QuantityType<>(info.getHealth().getTemperature(), SIUnits.CELSIUS));
                 updateState(CHANNEL_HEALTH_HUM, new QuantityType<>(info.getHealth().getHumidity(), Units.PERCENT));
             }
+            if (info.getBlades() != null) {
+                updateState(CHANNEL_BLADES_QUALITY, new QuantityType<>(info.getBlades().getQuality(), Units.PERCENT));
+                updateState(CHANNEL_BLADES_REPL_DAYS, new QuantityType<>(info.getBlades().getDays(), Units.DAY));
+                updateState(CHANNEL_BLADES_USAGE_HOURS, new QuantityType<>(info.getBlades().getHours(), Units.HOUR));
+            }
             if (info.getTimer() != null) {
                 if (info.getTimer().getNext() != null) {
                     updateNextTimer(info);

diff --git a/...ab.binding.robonect/src/main/java/org/openhab/binding/robonect/internal/model/Blades.java b/...ab.binding.robonect/src/main/java/org/openhab/binding/robonect/internal/model/Blades.java
@@ -0,0 +1,51 @@
+/**
+ * Copyright (c) 2010-2024 Contributors to the openHAB project
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.openhab.binding.robonect.internal.model;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+
+/**
+ * Blade information from the mower.
+ *
+ * @author Christian Jonak-Moechel - Initial contribution
+ */
+@NonNullByDefault
+public class Blades {
+
+    private int quality;
+
+    private int hours;
+
+    private int days;
+
+    /**
+     * @return - the quality of the blades in %.
+     */
+    public int getQuality() {
+        return quality;
+    }
+
+    /**
+     * @return - the hours of how many days the blades have been actively in use
+     */
+    public int getHours() {
+        return hours;
+    }
+
+    /**
+     * @return - the days since the blades have been changed the last time
+     */
+    public int getDays() {
+        return days;
+    }
+}
diff --git a/...binding.robonect/src/main/java/org/openhab/binding/robonect/internal/model/MowerInfo.java b/...binding.robonect/src/main/java/org/openhab/binding/robonect/internal/model/MowerInfo.java
@@ -15,7 +15,7 @@
 /**
  * The mower information holds the main information from the majority of the available channels. This class is a POJO
  * to deserialize the JSON response from the module.
- * 
+ *
  * @author Marco Meyer - Initial contribution
  */
 public class MowerInfo extends RobonectAnswer {
@@ -25,6 +25,7 @@ public class MowerInfo extends RobonectAnswer {
     private Timer timer;
     private Wlan wlan;
     private Health health;
+    private Blades blades;
     private ErrorEntry error;
 
     /**
@@ -69,6 +70,13 @@ public Health getHealth() {
         return health;
     }
 
+    /**
+     * @return - the blades status information.
+     */
+    public Blades getBlades() {
+        return blades;
+    }
+
     public void setName(String name) {
         this.name = name;
     }
@@ -89,6 +97,10 @@ public void setHealth(Health health) {
         this.health = health;
     }
 
+    public void setBlades(Blades blades) {
+        this.blades = blades;
+    }
+
     public void setError(ErrorEntry error) {
         this.error = error;
     }

diff --git a/bundles/org.openhab.binding.robonect/src/main/resources/OH-INF/i18n/robonect.properties b/bundles/org.openhab.binding.robonect/src/main/resources/OH-INF/i18n/robonect.properties
@@ -31,6 +31,12 @@ thing-type.config.robonect.mower.user.description = The user id if authenticatio
 
 # channel types
 
+channel-type.robonect.blades-quality.label = Blade Quality
+channel-type.robonect.blades-quality.description = The quality of the blades
+channel-type.robonect.blades-replacement-days.label = Blade In Use Days
+channel-type.robonect.blades-replacement-days.description = The number of days since the blades have been replaced
+channel-type.robonect.blades-usage-hours.label = Blade Usage Hours
+channel-type.robonect.blades-usage-hours.description = The usage time in hours of the blades
 channel-type.robonect.commentType.label = Robonect Firmware Comment
 channel-type.robonect.compiledType.label = Robonect Version
 channel-type.robonect.distanceType.label = Status Distance

diff --git a/bundles/org.openhab.binding.robonect/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.robonect/src/main/resources/OH-INF/thing/thing-types.xml
@@ -45,13 +45,18 @@
 
 			<channel id="health-temperature" typeId="temperatureType"/>
 			<channel id="health-humidity" typeId="humidityType"/>
+
+			<channel id="blades-quality" typeId="blades-quality"/>
+			<channel id="blades-replacement-days" typeId="blades-replacement-days"/>
+			<channel id="blades-usage-hours" typeId="blades-usage-hours"/>
 		</channels>
 
 		<properties>
 			<property name="vendor">robonect.de</property>
 			<property name="firmwareVersion">N/A</property>
 			<property name="compiled">N/A</property>
 			<property name="serialNumber">N/A</property>
+			<property name="thingTypeVersion">1</property>
 		</properties>
 
 		<config-description>
@@ -155,6 +160,27 @@
 		<state readOnly="true" pattern="%d %%"/>
 	</channel-type>
 
+	<channel-type id="blades-quality">
+		<item-type unitHint="%">Number:Dimensionless</item-type>
+		<label>Blade Quality</label>
+		<description>The quality of the blades</description>
+		<state readOnly="true" pattern="%d %%"/>
+	</channel-type>
+
+	<channel-type id="blades-usage-hours">
+		<item-type unitHint="h">Number:Time</item-type>
+		<label>Blade Usage Hours</label>
+		<description>The usage time in hours of the blades</description>
+		<state readOnly="true" pattern="%d %unit%"/>
+	</channel-type>
+
+	<channel-type id="blades-replacement-days">
+		<item-type unitHint="d">Number:Time</item-type>
+		<label>Blade In Use Days</label>
+		<description>The number of days since the blades have been replaced</description>
+		<state readOnly="true" pattern="%d %unit%"/>
+	</channel-type>
+
 	<channel-type id="modeType">
 		<item-type>String</item-type>
 		<label>Mower Mode</label>

diff --git a/bundles/org.openhab.binding.robonect/src/main/resources/OH-INF/update/instructions.xml b/bundles/org.openhab.binding.robonect/src/main/resources/OH-INF/update/instructions.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
+<update:update-descriptions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xmlns:update="https://openhab.org/schemas/update-description/v1.0.0"
+	xsi:schemaLocation="https://openhab.org/schemas/update-description/v1.0.0 https://openhab.org/schemas/update-description-1.0.0.xsd">
+
+	<thing-type uid="robonect:mower">
+		<instruction-set targetVersion="1">
+			<add-channel id="blades-quality">
+				<type>robonect:blades-quality</type>
+			</add-channel>
+			<add-channel id="blades-usage-hours">
+				<type>robonect:blades-usage-hours</type>
+			</add-channel>
+			<add-channel id="blades-replacement-days">
+				<type>robonect:blades-replacement-days</type>
+			</add-channel>
+		</instruction-set>
+	</thing-type>
+
+</update:update-descriptions>
diff --git a/...g.robonect/src/test/java/org/openhab/binding/robonect/internal/model/ModelParserTest.java b/...g.robonect/src/test/java/org/openhab/binding/robonect/internal/model/ModelParserTest.java
@@ -79,7 +79,7 @@ public void shouldParseCorrectStatusModel() {
 
     @Test
     public void shouldParseCorrectStatusModelWithHealth() {
-        String correctModel = "{ \"successful\": true, \"name\": \"Rosenlund Automower\", \"status\": { \"status\": 4, \"stopped\": false, \"duration\": 47493, \"mode\": 0, \"battery\": 20, \"hours\": 991 }, \"timer\": { \"status\": 2, \"next\": { \"date\": \"30.07.2017\", \"time\": \"13:00:00\", \"unix\": 1501419600 } }, \"wlan\": { \"signal\": -66 }, \"health\": { \"temperature\": 28, \"humidity\": 32 } }";
+        String correctModel = "{ \"successful\": true, \"name\": \"Rosenlund Automower\", \"status\": { \"status\": 4, \"stopped\": false, \"duration\": 47493, \"mode\": 0, \"battery\": 20, \"hours\": 991 }, \"timer\": { \"status\": 2, \"next\": { \"date\": \"30.07.2017\", \"time\": \"13:00:00\", \"unix\": 1501419600 } }, \"blades\": {\"quality\": 9, \"hours\": 183, \"days\": 76}, \"wlan\": { \"signal\": -66 }, \"health\": { \"temperature\": 28, \"humidity\": 32 } }";
         MowerInfo mowerInfo = subject.parse(correctModel, MowerInfo.class);
         assertTrue(mowerInfo.isSuccessful());
         assertEquals("Rosenlund Automower", mowerInfo.getName());
@@ -98,6 +98,9 @@ public void shouldParseCorrectStatusModelWithHealth() {
         assertNotNull(mowerInfo.getHealth());
         assertEquals(28, mowerInfo.getHealth().getTemperature());
         assertEquals(32, mowerInfo.getHealth().getHumidity());
+        assertEquals(9, mowerInfo.getBlades().getQuality());
+        assertEquals(76, mowerInfo.getBlades().getDays());
+        assertEquals(183, mowerInfo.getBlades().getHours());
         // "health": { "temperature": 28, "humidity": 32 }
     }