matterbridge-zigbee2mqtt 2.4.5-dev.2 → 2.4.5-dev.4

package/CHANGELOG.md

@@ -6,13 +6,17 @@ All notable changes to this project will be documented in this file.
 
 ## [2.4.5] - 2025-02-04
 
+### Added
+
+- [thermostat]: Added fan_only mode (tested by https://github.com/robvanoostenrijk).
+
 ### Changed
 
 - [package]: Updated dependencies.
 
 ### Fixed
 
-- [endpoint]: Fix thermostat bug.
+- [thermostat]: Fix thermostat bug (thanks https://github.com/robvanoostenrijk).
 
 <a href="https://www.buymeacoffee.com/luligugithub">
   <img src="./yellow-button.png" alt="Buy me a coffee" width="120">

package/dist/entity.js

@@ -29,6 +29,7 @@ export class ZigbeeEntity extends EventEmitter {
     mutableDevice = new Map();
     colorTimeout = undefined;
     thermostatTimeout = undefined;
+    thermostatSystemModeLookup = ['off', 'auto', '', 'cool', 'heat', '', '', 'fan_only'];
     composedType = '';
     hasEndpoints = false;
     isRouter = false;
@@ -179,12 +180,18 @@ export class ZigbeeEntity extends EventEmitter {
         });
     }
     destroy() {
+        this.removeAllListeners();
         if (this.colorTimeout)
             clearTimeout(this.colorTimeout);
         this.colorTimeout = undefined;
         if (this.thermostatTimeout)
             clearTimeout(this.thermostatTimeout);
         this.thermostatTimeout = undefined;
+        this.device = undefined;
+        this.group = undefined;
+        this.bridgedDevice = undefined;
+        this.mutableDevice.clear();
+        this.propertyMap.clear();
     }
     addBridgedDeviceBasicInformation() {
         if (!this.bridgedDevice)
@@ -437,6 +444,7 @@ export class ZigbeeGroup extends ZigbeeEntity {
         zigbeeGroup.bridgedDevice.addRequiredClusterServers();
         if (!zigbeeGroup.bridgedDevice || !zigbeeGroup.verifyMutableDevice(zigbeeGroup.bridgedDevice))
             return zigbeeGroup;
+        zigbeeGroup.mutableDevice.clear();
         zigbeeGroup.logPropertyMap();
         if (isSwitch || isLight) {
             if (isSwitch && !isLight)
@@ -565,7 +573,7 @@ export class ZigbeeGroup extends ZigbeeEntity {
             zigbeeGroup.bridgedDevice.subscribeAttribute(ThermostatCluster.id, 'occupiedCoolingSetpoint', (newValue, oldValue) => {
                 zigbeeGroup.bridgedDevice?.log.info(`Thermostat occupiedCoolingSetpoint changed from ${oldValue / 100} to ${newValue / 100}`);
                 zigbeeGroup.bridgedDevice?.log.info(`Setting thermostat occupiedCoolingSetpoint to ${newValue / 100}`);
-                zigbeeGroup.publishCommand('CurrentCoolingSetpoint', group.friendly_name, { current_cooling_setpoint: Math.round(newValue / 100) });
+                zigbeeGroup.publishCommand('CurrentCoolingSetpoint', group.friendly_name, { current_heating_setpoint: Math.round(newValue / 100) });
                 zigbeeGroup.publishCommand('OccupiedCoolingSetpoint', group.friendly_name, { occupied_cooling_setpoint: Math.round(newValue / 100) });
                 zigbeeGroup.noUpdate = true;
                 zigbeeGroup.thermostatTimeout = setTimeout(() => {
@@ -600,7 +608,7 @@ export const z2ms = [
     { type: 'climate', name: 'unoccupied_heating_setpoint', property: 'unoccupied_heating_setpoint', deviceType: thermostatDevice, cluster: Thermostat.Cluster.id, attribute: 'occupiedHeatingSetpoint', converter: (value) => { return Math.max(-5000, Math.min(5000, value * 100)); } },
     { type: 'climate', name: 'unoccupied_cooling_setpoint', property: 'unoccupied_cooling_setpoint', deviceType: thermostatDevice, cluster: Thermostat.Cluster.id, attribute: 'occupiedCoolingSetpoint', converter: (value) => { return Math.max(-5000, Math.min(5000, value * 100)); } },
     { type: 'climate', name: 'running_state', property: 'running_state', deviceType: thermostatDevice, cluster: Thermostat.Cluster.id, attribute: 'thermostatRunningMode', valueLookup: ['idle', '', '', 'cool', 'heat'] },
-    { type: 'climate', name: 'system_mode', property: 'system_mode', deviceType: thermostatDevice, cluster: Thermostat.Cluster.id, attribute: 'systemMode', valueLookup: ['off', 'auto', '', 'cool', 'heat'] },
+    { type: 'climate', name: 'system_mode', property: 'system_mode', deviceType: thermostatDevice, cluster: Thermostat.Cluster.id, attribute: 'systemMode', valueLookup: ['off', 'auto', '', 'cool', 'heat', '', '', 'fan_only'] },
     { type: '', name: 'min_temperature_limit', property: 'min_temperature_limit', deviceType: thermostatDevice, cluster: Thermostat.Cluster.id, attribute: 'minHeatSetpointLimit', converter: (value) => { return Math.max(-5000, Math.min(5000, value * 100)); } },
     { type: '', name: 'max_temperature_limit', property: 'max_temperature_limit', deviceType: thermostatDevice, cluster: Thermostat.Cluster.id, attribute: 'maxHeatSetpointLimit', converter: (value) => { return Math.max(-5000, Math.min(5000, value * 100)); } },
     { type: '', name: 'min_heat_setpoint_limit', property: 'min_heat_setpoint_limit', deviceType: thermostatDevice, cluster: Thermostat.Cluster.id, attribute: 'minHeatSetpointLimit', converter: (value) => { return Math.max(-5000, Math.min(5000, value * 100)); } },
@@ -1179,11 +1187,9 @@ export class ZigbeeDevice extends ZigbeeEntity {
                     const setpoint = Math.round(t / 100 + request.amount / 10);
                     if (zigbeeDevice.propertyMap.has('current_heating_setpoint')) {
                         zigbeeDevice.publishCommand('OccupiedHeatingSetpoint', device.friendly_name, { current_heating_setpoint: setpoint });
-                        zigbeeDevice.log.debug('Command setpointRaiseLower sent:', debugStringify({ current_heating_setpoint: setpoint }));
                     }
                     else if (zigbeeDevice.propertyMap.has('occupied_heating_setpoint')) {
                         zigbeeDevice.publishCommand('OccupiedHeatingSetpoint', device.friendly_name, { occupied_heating_setpoint: setpoint });
-                        zigbeeDevice.log.debug('Command setpointRaiseLower sent:', debugStringify({ occupied_heating_setpoint: setpoint }));
                     }
                 }
                 if (request.mode === Thermostat.SetpointRaiseLowerMode.Cool || request.mode === Thermostat.SetpointRaiseLowerMode.Both) {
@@ -1191,22 +1197,22 @@ export class ZigbeeDevice extends ZigbeeEntity {
                     const setpoint = Math.round(t / 100 + request.amount / 10);
                     if (zigbeeDevice.propertyMap.has('current_heating_setpoint')) {
                         zigbeeDevice.publishCommand('OccupiedCoolingSetpoint', device.friendly_name, { current_heating_setpoint: setpoint });
-                        zigbeeDevice.log.debug('Command setpointRaiseLower sent:', debugStringify({ current_heating_setpoint: setpoint }));
                     }
                     else if (zigbeeDevice.propertyMap.has('occupied_cooling_setpoint')) {
                         zigbeeDevice.publishCommand('OccupiedCoolingSetpoint', device.friendly_name, { occupied_cooling_setpoint: setpoint });
-                        zigbeeDevice.log.debug('Command setpointRaiseLower sent:', debugStringify({ occupied_cooling_setpoint: setpoint }));
                     }
                 }
             });
             zigbeeDevice.bridgedDevice.subscribeAttribute(ThermostatCluster.id, 'systemMode', async (value) => {
-                zigbeeDevice.log.debug(`Subscribe systemMode called for ${zigbeeDevice.ien}${device.friendly_name}${rs}${db} with:`, value);
-                const system_mode = value === Thermostat.SystemMode.Off ? 'off' : value === Thermostat.SystemMode.Heat ? 'heat' : 'cool';
-                zigbeeDevice.publishCommand('SystemMode', device.friendly_name, { system_mode });
-                zigbeeDevice.noUpdate = true;
-                zigbeeDevice.thermostatTimeout = setTimeout(() => {
-                    zigbeeDevice.noUpdate = false;
-                }, 5 * 1000);
+                if (isValidNumber(value, Thermostat.SystemMode.Off, Thermostat.SystemMode.FanOnly) && zigbeeDevice.thermostatSystemModeLookup[value] !== '') {
+                    const system_mode = zigbeeDevice.thermostatSystemModeLookup[value];
+                    zigbeeDevice.log.debug(`Subscribe systemMode called for ${zigbeeDevice.ien}${device.friendly_name}${rs}${db} with ${value} => ${system_mode}`);
+                    zigbeeDevice.publishCommand('SystemMode', device.friendly_name, { system_mode });
+                    zigbeeDevice.noUpdate = true;
+                    zigbeeDevice.thermostatTimeout = setTimeout(() => {
+                        zigbeeDevice.noUpdate = false;
+                    }, 5 * 1000);
+                }
             }, zigbeeDevice.log);
             if (zigbeeDevice.bridgedDevice.hasAttributeServer(ThermostatCluster.id, 'occupiedHeatingSetpoint'))
                 zigbeeDevice.bridgedDevice.subscribeAttribute(ThermostatCluster.id, 'occupiedHeatingSetpoint', async (value) => {

package/dist/platform.js

@@ -223,7 +223,7 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
         this.z2m.on('device_interview', async (friendly_name, ieee_address, status, supported) => {
             this.log.info(`zigbee2MQTT sent device_interview device: ${friendly_name} ieee_address: ${ieee_address} status: ${status} supported: ${supported}`);
             if (status === 'successful' && supported) {
-                if (!this.validateDeviceWhiteBlackList(friendly_name))
+                if (!this.validateDevice(friendly_name))
                     return;
                 this.log.info(`Registering device: ${friendly_name}`);
                 const bridgedDevice = this.z2mBridgeDevices?.find((device) => device.friendly_name === friendly_name);
@@ -243,7 +243,7 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
         });
         this.z2m.on('group_add', async (friendly_name, id, status) => {
             this.log.info(`zigbee2MQTT sent group_add friendly_name: ${friendly_name} id ${id} status ${status}`);
-            if (!this.validateDeviceWhiteBlackList(friendly_name))
+            if (!this.validateDevice(friendly_name))
                 return;
             this.log.info(`Registering group: ${friendly_name}`);
             const bridgedGroup = this.z2mBridgeGroups?.find((group) => group.friendly_name === friendly_name);
@@ -479,6 +479,7 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
         if (entity) {
             this.log.info(`Removing device: ${friendly_name}`);
             await this.unregisterDevice(entity.bridgedDevice);
+            entity.destroy();
             this.zigbeeEntities = this.zigbeeEntities.filter((entity) => entity.entityName !== friendly_name);
             this.bridgedDevices = this.bridgedDevices.filter((device) => device.deviceName !== friendly_name);
         }

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-zigbee2mqtt",
-  "version": "2.4.5-dev.2",
+  "version": "2.4.5-dev.4",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-zigbee2mqtt",
-      "version": "2.4.5-dev.2",
+      "version": "2.4.5-dev.4",
       "license": "Apache-2.0",
       "dependencies": {
         "moment": "2.30.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-zigbee2mqtt",
-  "version": "2.4.5-dev.2",
+  "version": "2.4.5-dev.4",
   "description": "Matterbridge zigbee2mqtt plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",