From 314bb1ee7cd6dc81672a0b54a34b6d4ab114e4c6 Mon Sep 17 00:00:00 2001
From: Cody Cutrer <cody@cutrer.us>
Date: Sat, 25 Nov 2023 04:47:00 -0700
Subject: [PATCH] [mqtt.homeassistant] interpret a dimmable light as OFF
 properly from zigbee2mqtt (#15925)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* [mqtt.homeassistant] interpret a dimmable light as OFF properly from zigbee2mqtt

zigbee2mqtt can send a brightness of say 99, with a state of OFF, when a bulb is
off. make sure if state is sent, it overrides all other inferences

* handle brightness but not color bulbs

---------

Signed-off-by: Cody Cutrer <cody@cutrer.us>
Signed-off-by: Jørgen Austvik <jaustvik@acm.org>
---
 .../internal/component/JSONSchemaLight.java   | 31 ++++++++++++-------
 .../component/JSONSchemaLightTests.java       |  3 ++
 2 files changed, 23 insertions(+), 11 deletions(-)

diff --git a/bundles/org.openhab.binding.mqtt.homeassistant/src/main/java/org/openhab/binding/mqtt/homeassistant/internal/component/JSONSchemaLight.java b/bundles/org.openhab.binding.mqtt.homeassistant/src/main/java/org/openhab/binding/mqtt/homeassistant/internal/component/JSONSchemaLight.java
index 93dcd606a6958..a86f6488de5ba 100644
--- a/bundles/org.openhab.binding.mqtt.homeassistant/src/main/java/org/openhab/binding/mqtt/homeassistant/internal/component/JSONSchemaLight.java
+++ b/bundles/org.openhab.binding.mqtt.homeassistant/src/main/java/org/openhab/binding/mqtt/homeassistant/internal/component/JSONSchemaLight.java
@@ -253,26 +253,38 @@ public void updateChannelState(ChannelUID channel, State state) {
             }
         }
 
+        boolean off = false;
         if (jsonState.state != null) {
             onOffValue.update(onOffValue.parseCommand(new StringType(jsonState.state)));
+            off = onOffValue.getChannelState().equals(OnOffType.OFF);
             if (brightnessValue.getChannelState() instanceof UnDefType) {
-                brightnessValue.update(brightnessValue.parseCommand((OnOffType) onOffValue.getChannelState()));
+                brightnessValue.update(off ? PercentType.ZERO : PercentType.HUNDRED);
             }
             if (colorValue.getChannelState() instanceof UnDefType) {
-                colorValue.update(colorValue.parseCommand((OnOffType) onOffValue.getChannelState()));
+                colorValue.update(off ? HSBType.BLACK : HSBType.WHITE);
             }
         }
 
+        PercentType brightness;
+        if (off) {
+            brightness = PercentType.ZERO;
+        } else if (brightnessValue.getChannelState() instanceof PercentType percentValue) {
+            brightness = percentValue;
+        } else {
+            brightness = PercentType.HUNDRED;
+        }
+
         if (jsonState.brightness != null) {
-            brightnessValue.update(
-                    brightnessValue.parseCommand(new DecimalType(Objects.requireNonNull(jsonState.brightness))));
+            if (!off) {
+                brightness = (PercentType) brightnessValue
+                        .parseMessage(new DecimalType(Objects.requireNonNull(jsonState.brightness)));
+            }
+            brightnessValue.update(brightness);
             if (colorValue.getChannelState() instanceof HSBType) {
                 HSBType color = (HSBType) colorValue.getChannelState();
-                colorValue.update(new HSBType(color.getHue(), color.getSaturation(),
-                        (PercentType) brightnessValue.getChannelState()));
+                colorValue.update(new HSBType(color.getHue(), color.getSaturation(), brightness));
             } else {
-                colorValue.update(new HSBType(DecimalType.ZERO, PercentType.ZERO,
-                        (PercentType) brightnessValue.getChannelState()));
+                colorValue.update(new HSBType(DecimalType.ZERO, PercentType.ZERO, brightness));
             }
         }
 
@@ -284,9 +296,6 @@ public void updateChannelState(ChannelUID channel, State state) {
         }
 
         if (jsonState.color != null) {
-            PercentType brightness = brightnessValue.getChannelState() instanceof PercentType
-                    ? (PercentType) brightnessValue.getChannelState()
-                    : PercentType.HUNDRED;
             // This corresponds to "deprecated" color mode handling, since we're not checking which color
             // mode is currently active.
             // HS is highest priority, then XY, then RGB
diff --git a/bundles/org.openhab.binding.mqtt.homeassistant/src/test/java/org/openhab/binding/mqtt/homeassistant/internal/component/JSONSchemaLightTests.java b/bundles/org.openhab.binding.mqtt.homeassistant/src/test/java/org/openhab/binding/mqtt/homeassistant/internal/component/JSONSchemaLightTests.java
index e1c50de28992f..604836dfc4eef 100644
--- a/bundles/org.openhab.binding.mqtt.homeassistant/src/test/java/org/openhab/binding/mqtt/homeassistant/internal/component/JSONSchemaLightTests.java
+++ b/bundles/org.openhab.binding.mqtt.homeassistant/src/test/java/org/openhab/binding/mqtt/homeassistant/internal/component/JSONSchemaLightTests.java
@@ -119,6 +119,9 @@ public void testBrightnessAndOnOff() throws InterruptedException {
         assertState(component, Light.BRIGHTNESS_CHANNEL_ID,
                 new PercentType(new BigDecimal(128 * 100).divide(new BigDecimal(255), MathContext.DECIMAL128)));
 
+        publishMessage("zigbee2mqtt/light/state", "{ \"state\": \"OFF\", \"brightness\": 128 }");
+        assertState(component, Light.BRIGHTNESS_CHANNEL_ID, PercentType.ZERO);
+
         sendCommand(component, Light.BRIGHTNESS_CHANNEL_ID, PercentType.HUNDRED);
         assertPublished("zigbee2mqtt/light/set/state", "{\"state\":\"ON\",\"brightness\":255}");