[mqtt] set the proper unit in the state description (#13604)

So that other pieces of openhab can know what unit it's going to be, without it having a value yet. Importantly, any necessary conversion that need to be applied to the other portion of the state description - min, max, and step. See also openhab/openhab-core#3132 Signed-off-by: Cody Cutrer <[email protected]>
openhab · Oct 27, 2022 · 26ad08c · 26ad08c
1 parent 234d354
commit 26ad08c
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/...nding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/values/NumberValue.java b/...nding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/values/NumberValue.java
@@ -149,6 +149,11 @@ public StateDescriptionFragmentBuilder createStateDescription(boolean readOnly)
         if (min != null) {
             builder = builder.withMinimum(min);
         }
-        return builder.withStep(step).withPattern("%s %unit%");
+        if (!unit.equals(Units.ONE)) {
+            builder.withPattern("%s " + unit);
+        } else {
+            builder.withPattern("%s %unit%");
+        }
+        return builder.withStep(step);
     }
 }
diff --git a/.../src/test/java/org/openhab/binding/mqtt/homeassistant/internal/component/SensorTests.java b/.../src/test/java/org/openhab/binding/mqtt/homeassistant/internal/component/SensorTests.java
@@ -75,7 +75,7 @@ public void test() throws InterruptedException {
         publishMessage("zigbee2mqtt/sensor/state", "20");
         assertState(component, Sensor.SENSOR_CHANNEL_ID, new QuantityType<>(20, Units.WATT));
         assertThat(component.getChannel(Sensor.SENSOR_CHANNEL_ID).getState().getCache().createStateDescription(true)
-                .build().getPattern(), is("%s %unit%"));
+                .build().getPattern(), is("%s W"));
 
         waitForAssert(() -> assertState(component, Sensor.SENSOR_CHANNEL_ID, UnDefType.UNDEF), 5000, 200);