fix: Bosch BTH-RM: Expose all system_mode for compatibility (#10709)

Author: burmistrzak

src/devices/bosch.ts

@@ -701,6 +701,24 @@ export const definitions: DefinitionWithExtend[] = [
         model: "BTH-RA",
         vendor: "Bosch",
         description: "Radiator thermostat II",
+        meta: {
+            overrideHaDiscoveryPayload: (payload) => {
+                // Override climate discovery
+                // https://github.com/Koenkk/zigbee2mqtt/pull/23075#issue-2355829475
+                if (payload.mode_command_topic?.endsWith("/system_mode")) {
+                    payload.mode_command_topic = payload.mode_command_topic.substring(0, payload.mode_command_topic.lastIndexOf("/system_mode"));
+                    payload.mode_command_template =
+                        "{% set values = " +
+                        `{ 'auto':'schedule','heat':'manual','off':'pause'} %}` +
+                        `{"operating_mode": "{{ values[value] if value in values.keys() else 'pause' }}"}`;
+                    payload.mode_state_template =
+                        "{% set values = " +
+                        `{'schedule':'auto','manual':'heat','pause':'off'} %}` +
+                        `{% set value = value_json.operating_mode %}{{ values[value] if value in values.keys() else 'off' }}`;
+                    payload.modes = ["off", "heat", "auto"];
+                }
+            },
+        },
         extend: [
             boschThermostatExtend.customThermostatCluster(),
             boschThermostatExtend.customUserInterfaceCfgCluster(),
@@ -730,7 +748,6 @@ export const definitions: DefinitionWithExtend[] = [
             boschGeneralExtend.handleZclVersionReadRequest(),
             boschThermostatExtend.customThermostatCluster(),
             boschThermostatExtend.customUserInterfaceCfgCluster(),
-            boschThermostatExtend.customSystemMode(),
             boschThermostatExtend.operatingMode({enableReporting: true}),
             boschThermostatExtend.rmThermostat(),
             boschThermostatExtend.setpointChangeSource({enableReporting: true}),
@@ -758,7 +775,6 @@ export const definitions: DefinitionWithExtend[] = [
             boschThermostatExtend.customThermostatCluster(),
             boschThermostatExtend.customUserInterfaceCfgCluster(),
             boschThermostatExtend.relayState(),
-            boschThermostatExtend.customSystemMode(),
             boschThermostatExtend.operatingMode({enableReporting: true}),
             boschThermostatExtend.rmThermostat(),
             boschThermostatExtend.setpointChangeSource({enableReporting: true}),

src/lib/bosch.ts

@@ -11,20 +11,7 @@ import {logger} from "./logger";
 import type {ElectricityMeterArgs} from "./modernExtend";
 import {payload} from "./reporting";
 import * as globalStore from "./store";
-import type {
-    Configure,
-    DefinitionExposesFunction,
-    DefinitionMeta,
-    DummyDevice,
-    Expose,
-    Fz,
-    KeyValue,
-    KeyValueAny,
-    ModernExtend,
-    OnEvent,
-    Tz,
-    Zh,
-} from "./types";
+import type {Configure, DefinitionExposesFunction, DummyDevice, Expose, Fz, KeyValue, KeyValueAny, ModernExtend, OnEvent, Tz, Zh} from "./types";
 import * as utils from "./utils";
 import {sleep, toNumber} from "./utils";
 
@@ -3160,6 +3147,7 @@ const boschThermostatLookup = {
     systemModes: {
         heat: 0x04,
         cool: 0x03,
+        off: 0x00,
     },
     raRunningStates: <("idle" | "heat" | "cool" | "fan_only")[]>["idle", "heat"],
     heaterType: {
@@ -3255,6 +3243,16 @@ export const boschThermostatExtend = {
             entityCategory: "config",
         }),
     humidity: () => m.humidity({reporting: false}),
+    operatingMode: (args?: {enableReporting: boolean}) =>
+        m.enumLookup<"hvacThermostat", BoschThermostatCluster>({
+            name: "operating_mode",
+            cluster: "hvacThermostat",
+            attribute: "operatingMode",
+            description: "Bosch-specific operating mode",
+            lookup: {schedule: 0x00, manual: 0x01, pause: 0x05},
+            reporting: args?.enableReporting ? {min: "MIN", max: "MAX", change: null} : false,
+            entityCategory: "config",
+        }),
     windowOpenMode: (args?: {enableReporting: boolean}) =>
         m.binary<"hvacThermostat", BoschThermostatCluster>({
             name: "window_open_mode",
@@ -3389,7 +3387,7 @@ export const boschThermostatExtend = {
     rmThermostat: (): ModernExtend => {
         const thermostat = m.thermostat({
             localTemperature: {
-                configure: {reporting: false},
+                configure: {reporting: {min: 30, max: 900, change: 10}},
             },
             localTemperatureCalibration: {
                 values: {min: -5, max: 5, step: 0.1},
@@ -3403,121 +3401,25 @@ export const boschThermostatExtend = {
                 configure: {reporting: {min: "10_SECONDS", max: "MAX", change: 50}},
             },
             systemMode: {
-                values: ["heat", "cool"],
-                toZigbee: {skip: true},
-                configure: {skip: true},
+                values: ["off", "heat", "cool"],
+                configure: {reporting: {min: "MIN", max: "MAX", change: null}},
             },
             runningState: {
                 values: ["idle", "heat", "cool"],
                 configure: {reporting: {min: "MIN", max: "MAX", change: null}},
             },
         });
 
-        const expose: DefinitionExposesFunction = (device: Zh.Device | DummyDevice, options: KeyValue) => {
-            const returnedThermostat = <Expose[]>thermostat.exposes;
-
-            if (utils.isDummyDevice(device)) {
-                return returnedThermostat;
-            }
-
-            let currentSystemMode: string;
-            try {
-                currentSystemMode = utils.getFromLookupByValue(
-                    device.getEndpoint(1).getClusterAttributeValue("hvacThermostat", "systemMode"),
-                    boschThermostatLookup.systemModes,
-                );
-            } catch {
-                currentSystemMode = "heat";
-            }
-
-            // The thermostat is a singleton, thus the values must be set
-            // manually as filtering will lead to an array without
-            // heat/cool in them after two systemMode changes.
-            returnedThermostat[0].features.forEach((exposedAttribute, index, array) => {
-                if (exposedAttribute.type === "enum") {
-                    if (exposedAttribute.name === "system_mode") {
-                        exposedAttribute.label = "Active system mode";
-                        exposedAttribute.description =
-                            "Currently used system mode by the thermostat. This field is primarily " +
-                            "used to configure the thermostat in Home Assistant correctly.";
-                        exposedAttribute.values = [currentSystemMode];
-                        exposedAttribute.access = ea.STATE;
-                    }
-
-                    if (exposedAttribute.name === "running_state") {
-                        exposedAttribute.values = ["idle", currentSystemMode];
-                    }
-                }
-            });
-            return returnedThermostat;
-        };
+        const exposes: (Expose | DefinitionExposesFunction)[] = thermostat.exposes;
 
         return {
-            exposes: [expose],
+            exposes: exposes,
             fromZigbee: thermostat.fromZigbee,
             toZigbee: thermostat.toZigbee,
             configure: thermostat.configure,
             isModernExtend: true,
         };
     },
-    customSystemMode: (): ModernExtend => {
-        const exposes: Expose[] = [
-            e
-                .enum("custom_system_mode", ea.ALL, Object.keys(boschThermostatLookup.systemModes))
-                .withLabel("Available system modes")
-                .withDescription("Select if the thermostat is connected to a heating or a cooling device")
-                .withCategory("config"),
-        ];
-
-        const fromZigbee = [
-            {
-                cluster: "hvacThermostat",
-                type: ["attributeReport", "readResponse"],
-                convert: (model, msg, publish, options, meta) => {
-                    const result: KeyValue = {};
-                    const data = msg.data;
-
-                    if (data.systemMode !== undefined) {
-                        result.custom_system_mode = utils.getFromLookupByValue(data.systemMode, boschThermostatLookup.systemModes);
-                        meta.deviceExposesChanged();
-                    }
-
-                    return result;
-                },
-            } satisfies Fz.Converter<"hvacThermostat", undefined, ["attributeReport", "readResponse"]>,
-        ];
-
-        const toZigbee: Tz.Converter[] = [
-            {
-                key: ["custom_system_mode"],
-                convertSet: async (entity, key, value, meta) => {
-                    await entity.write("hvacThermostat", {
-                        systemMode: utils.toNumber(utils.getFromLookup(value, boschThermostatLookup.systemModes)),
-                    });
-
-                    return {state: {custom_system_mode: value}};
-                },
-                convertGet: async (entity, key, meta) => {
-                    await entity.read("hvacThermostat", ["systemMode"]);
-                },
-            },
-        ];
-
-        const configure: Configure[] = [
-            m.setupConfigureForReporting("hvacThermostat", "systemMode", {
-                config: false,
-                access: ea.ALL,
-            }),
-        ];
-
-        return {
-            exposes,
-            fromZigbee,
-            toZigbee,
-            configure,
-            isModernExtend: true,
-        };
-    },
     raThermostat: (): ModernExtend => {
         // Native thermostat
         const thermostat = m.thermostat({
@@ -3629,92 +3531,6 @@ export const boschThermostatExtend = {
             isModernExtend: true,
         };
     },
-    operatingMode: (args?: {enableReporting: boolean}): ModernExtend => {
-        const operatingModeLookup = {schedule: 0x00, manual: 0x01, pause: 0x05};
-
-        const operatingMode = m.enumLookup<"hvacThermostat", BoschThermostatCluster>({
-            name: "operating_mode",
-            cluster: "hvacThermostat",
-            attribute: "operatingMode",
-            description: "Bosch-specific operating mode. This is being used as mode on the exposed thermostat when using Home Assistant.",
-            lookup: operatingModeLookup,
-            reporting: args?.enableReporting ? {min: "MIN", max: "MAX", change: null} : false,
-            entityCategory: "config",
-        });
-
-        const exposes: (Expose | DefinitionExposesFunction)[] = operatingMode.exposes;
-        const fromZigbee = operatingMode.fromZigbee;
-        const toZigbee: Tz.Converter[] = operatingMode.toZigbee;
-        const configure: Configure[] = operatingMode.configure;
-
-        const removeLowAndHighTemperatureFields = (payload: KeyValueAny) => {
-            payload.temperature_high_command_topic = undefined;
-            payload.temperature_low_command_topic = undefined;
-
-            payload.temperature_high_state_template = undefined;
-            payload.temperature_low_state_template = undefined;
-
-            payload.temperature_high_state_topic = undefined;
-            payload.temperature_low_state_topic = undefined;
-        };
-
-        // Override the payload send to Home Assistant to achieve the following:
-        // 1. Use the Bosch operating mode instead of system modes
-        //    See: https://github.com/Koenkk/zigbee2mqtt/pull/23075#issue-2355829475
-        // 2. Remove setpoints not compatible with the currently used system mode
-        //    See: https://github.com/Koenkk/zigbee2mqtt/issues/28892
-        const meta: DefinitionMeta = {
-            overrideHaDiscoveryPayload: (payload) => {
-                if (payload.modes !== undefined) {
-                    if (payload.modes.includes("heat")) {
-                        payload.mode_command_template =
-                            `{% set values = { 'auto':'schedule', 'heat':'manual', 'off':'pause' } %}` +
-                            `{"operating_mode": "{{ values[value] if value in values.keys() else 'pause' }}"}`;
-                        payload.mode_state_template =
-                            `{% set values = { 'schedule':'auto', 'manual':'heat', 'pause':'off' } %}` +
-                            "{% set value = value_json.operating_mode %}" +
-                            `{{ values[value] if value in values.keys() else 'off' }}`;
-
-                        if (payload.temperature_low_command_topic !== undefined) {
-                            payload.temperature_command_topic = payload.temperature_low_command_topic;
-                            payload.temperature_state_template = payload.temperature_low_state_template;
-                            payload.temperature_state_topic = payload.temperature_low_state_topic;
-
-                            removeLowAndHighTemperatureFields(payload);
-                        }
-                    } else if (payload.modes.includes("cool")) {
-                        payload.mode_command_template =
-                            `{% set values = { 'auto':'schedule', 'cool':'manual', 'off':'pause' } %}` +
-                            `{"operating_mode": "{{ values[value] if value in values.keys() else 'pause' }}"}`;
-                        payload.mode_state_template =
-                            `{% set values = { 'schedule':'auto', 'manual':'cool', 'pause':'off' } %}` +
-                            "{% set value = value_json.operating_mode %}" +
-                            `{{ values[value] if value in values.keys() else 'off' }}`;
-
-                        if (payload.temperature_high_command_topic !== undefined) {
-                            payload.temperature_command_topic = payload.temperature_high_command_topic;
-                            payload.temperature_state_template = payload.temperature_high_state_template;
-                            payload.temperature_state_topic = payload.temperature_high_state_topic;
-
-                            removeLowAndHighTemperatureFields(payload);
-                        }
-                    }
-
-                    payload.modes = ["off", ...payload.modes, "auto"];
-                    payload.mode_command_topic = payload.mode_command_topic.replace("/system_mode", "");
-                }
-            },
-        };
-
-        return {
-            exposes,
-            fromZigbee,
-            toZigbee,
-            configure,
-            meta,
-            isModernExtend: true,
-        };
-    },
     boostHeating: (args?: {enableReporting: boolean}): ModernExtend => {
         const boostHeatingLookup: KeyValue = {
             OFF: 0x00,