[mqtt.homeassistant] JSON Attributes can exist on Climate

Signed-off-by: Cody Cutrer <cody@cutrer.us>
openhab · Oct 21, 2024 · f5adf76 · f5adf76
1 parent eac49a8
commit f5adf76
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 4 deletions.
diff --git a/...tant/src/main/java/org/openhab/binding/mqtt/homeassistant/internal/component/Climate.java b/...tant/src/main/java/org/openhab/binding/mqtt/homeassistant/internal/component/Climate.java
@@ -33,6 +33,7 @@
 import org.openhab.core.library.types.StringType;
 import org.openhab.core.library.unit.ImperialUnits;
 import org.openhab.core.library.unit.SIUnits;
+import org.openhab.core.thing.type.AutoUpdatePolicy;
 import org.openhab.core.types.Command;
 import org.openhab.core.types.State;
 
@@ -63,6 +64,7 @@ public class Climate extends AbstractComponent<Climate.ChannelConfiguration> {
     public static final String TEMPERATURE_LOW_CH_ID = "temperature-low";
     public static final String TEMPERATURE_LOW_CH_ID_DEPRECATED = "temperatureLow";
     public static final String POWER_CH_ID = "power";
+    public static final String JSON_ATTRIBUTES_CHANNEL_ID = "json-attributes";
 
     public enum TemperatureUnit {
         @SerializedName("C")
@@ -149,7 +151,7 @@ static class ChannelConfiguration extends AbstractChannelConfiguration {
                                                     // hold modes.
 
         @SerializedName("json_attributes_template")
-        protected @Nullable String jsonAttributesTemplate; // Attributes are not supported yet
+        protected @Nullable String jsonAttributesTemplate;
         @SerializedName("json_attributes_topic")
         protected @Nullable String jsonAttributesTopic;
 
@@ -295,6 +297,13 @@ ComponentChannelType.SWITCH, new OnOffValue(), updateListener, null,
 
         buildOptionalChannel(POWER_CH_ID, ComponentChannelType.SWITCH, new OnOffValue(), updateListener, null,
                 channelConfiguration.powerCommandTopic, null, null, null);
+
+        if (channelConfiguration.jsonAttributesTopic != null) {
+            buildChannel(JSON_ATTRIBUTES_CHANNEL_ID, ComponentChannelType.STRING, new TextValue(), "JSON Attributes",
+                    componentConfiguration.getUpdateListener())
+                    .stateTopic(channelConfiguration.jsonAttributesTopic, channelConfiguration.jsonAttributesTemplate)
+                    .withAutoUpdatePolicy(AutoUpdatePolicy.VETO).build();
+        }
         finalizeChannels();
     }
 

diff --git a/...src/test/java/org/openhab/binding/mqtt/homeassistant/internal/component/ClimateTests.java b/...src/test/java/org/openhab/binding/mqtt/homeassistant/internal/component/ClimateTests.java
@@ -70,7 +70,7 @@ public void testTS0601Climate() {
                          "unique_id": "0x847127fffe11dd6a_climate_zigbee2mqtt"}\
                         """);
 
-        assertThat(component.channels.size(), is(6));
+        assertThat(component.channels.size(), is(7));
         assertThat(component.getName(), is("th1"));
 
         assertChannel(component, Climate.ACTION_CH_ID, "zigbee2mqtt/th1", "", "th1", TextValue.class);
@@ -84,6 +84,8 @@ public void testTS0601Climate() {
                 TextValue.class);
         assertChannel(component, Climate.TEMPERATURE_CH_ID, "zigbee2mqtt/th1",
                 "zigbee2mqtt/th1/set/current_heating_setpoint", "th1", NumberValue.class);
+        assertChannel(component, Climate.JSON_ATTRIBUTES_CHANNEL_ID, "zigbee2mqtt/th1", "", "JSON Attributes",
+                TextValue.class);
 
         publishMessage("zigbee2mqtt/th1", """
                 {"running_state": "idle", "away_mode": "ON", \
@@ -140,7 +142,7 @@ public void testTS0601ClimateNotSendIfOff() {
                          "unique_id": "0x847127fffe11dd6a_climate_zigbee2mqtt", "send_if_off": "false"}\
                         """);
 
-        assertThat(component.channels.size(), is(7));
+        assertThat(component.channels.size(), is(8));
         assertThat(component.getName(), is("th1"));
 
         assertChannel(component, Climate.ACTION_CH_ID, "zigbee2mqtt/th1", "", "th1", TextValue.class);
@@ -154,6 +156,8 @@ public void testTS0601ClimateNotSendIfOff() {
                 TextValue.class);
         assertChannel(component, Climate.TEMPERATURE_CH_ID, "zigbee2mqtt/th1",
                 "zigbee2mqtt/th1/set/current_heating_setpoint", "th1", NumberValue.class);
+        assertChannel(component, Climate.JSON_ATTRIBUTES_CHANNEL_ID, "zigbee2mqtt/th1", "", "JSON Attributes",
+                TextValue.class);
 
         publishMessage("zigbee2mqtt/th1", """
                 {"running_state": "idle", "away_mode": "ON", \
@@ -244,7 +248,7 @@ public void testClimate() {
                  "temp_step": "1", "precision": "0.5", "send_if_off": "false" }\
                 """);
 
-        assertThat(component.channels.size(), is(12));
+        assertThat(component.channels.size(), is(13));
         assertThat(component.getName(), is("MQTT HVAC"));
 
         assertChannel(component, Climate.ACTION_CH_ID, "zigbee2mqtt/th1", "", "MQTT HVAC", TextValue.class);
@@ -269,6 +273,8 @@ public void testClimate() {
         assertChannel(component, Climate.TEMPERATURE_LOW_CH_ID_DEPRECATED, "zigbee2mqtt/th1",
                 "zigbee2mqtt/th1/temperature_low", "MQTT HVAC", NumberValue.class);
         assertChannel(component, Climate.POWER_CH_ID, "", "zigbee2mqtt/th1/power", "MQTT HVAC", OnOffValue.class);
+        assertChannel(component, Climate.JSON_ATTRIBUTES_CHANNEL_ID, "zigbee2mqtt/th1", "", "JSON Attributes",
+                TextValue.class);
 
         publishMessage("zigbee2mqtt/th1", """
                 { "action": "fan",  "aux": "ON",  "away_mode": "OFF", \