matterbridge-zigbee2mqtt 2.5.0-dev.2 → 2.5.0-dev.3

package/CHANGELOG.md

@@ -19,7 +19,7 @@ New device types:
 
 If your controller has issues detecting the new device type, blacklist these devices, restart, wait 5 minutes, remove the blacklist and restart again. This will create a new endpoint on the controller.
 
-## [2.5.0] - 2025-05-21
+## [2.5.0] - 2025-05-23
 
 ### Added
 
@@ -27,7 +27,10 @@ If your controller has issues detecting the new device type, blacklist these dev
 - [waterLeak]: Added waterLeakDetector device type for zigbee property "water_leak". Default to false (i.e. no alarm) since is not possible to get the property.
 - [rainSensor]: Added rainSensor device type for zigbee property "rain". Default to false (i.e. no alarm) since is not possible to get the property.
 - [smokeSensor]: Added smokeSensor device type for zigbee property "smoke". Default to false (i.e. no alarm) since is not possible to get the property.
-- [colorTemp]: Added conversion from color temperature to rgb for the devices that doesn't support color temperature.
+- [colorTemp]: Added conversion from color temperature to rgb for the rgb devices that don't support color temperature.
+- [battery]: Set batChargeLevel to warning if battery is less than 40% and the device doesn't expose battery_low.
+- [battery]: Set batChargeLevel to critical if battery is less than 20% and the device doesn't expose battery_low.
+- [retain]: Send retained mqtt states at startup if z2m has retain enabled.
 
 ### Changed
 

package/README.md

@@ -224,6 +224,14 @@ The latest release also supports all clusters in the multi endpoints devices (e.
 
 Since the Matter support in the available ecosystems (controllers) is sometimes limited and, when available, only covers Matter 1.1 specifications, some z2m devices cannot be exposed properly or cannot be exposed at all.
 
+## Availability
+
+If the availability is enabled in zigbee2mqtt settings, it is exposed.
+
+## Retain
+
+If the retain option is enabled in zigbee2mqtt settings or device setting, at restart all retained states are updated.
+
 ## Unsupported devices
 
 If one of your devices is not supported out of the box, open an issue and we will try to support it if possible.

package/dist/entity.js

@@ -86,6 +86,17 @@ export class ZigbeeEntity extends EventEmitter {
                     return;
                 if (key === 'voltage' && this.isDevice && this.device?.power_source === 'Battery')
                     key = 'battery_voltage';
+                if (key === 'battery' && !('battery_low' in payload) && isValidNumber(value, 0, 100) && this.isDevice && this.device?.power_source === 'Battery') {
+                    if (value < 20) {
+                        this.updateAttributeIfChanged(this.bridgedDevice, undefined, PowerSource.Cluster.id, 'batChargeLevel', PowerSource.BatChargeLevel.Critical);
+                    }
+                    else if (value < 40) {
+                        this.updateAttributeIfChanged(this.bridgedDevice, undefined, PowerSource.Cluster.id, 'batChargeLevel', PowerSource.BatChargeLevel.Warning);
+                    }
+                    else {
+                        this.updateAttributeIfChanged(this.bridgedDevice, undefined, PowerSource.Cluster.id, 'batChargeLevel', PowerSource.BatChargeLevel.Ok);
+                    }
+                }
                 const propertyMap = this.propertyMap.get(key);
                 if (propertyMap) {
                     this.log.debug(`Payload entry ${CYAN}${key}${db} => name: ${CYAN}${propertyMap.name}${db} type: ${CYAN}${propertyMap.type === '' ? 'generic' : propertyMap.type}${db} ` +

package/dist/platform.js

@@ -34,7 +34,8 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
     z2mBridgeInfo;
     z2mBridgeDevices;
     z2mBridgeGroups;
-    z2mDeviceAvailability = new Map();
+    z2mEntityAvailability = new Map();
+    z2mEntityPayload = new Map();
     availabilityTimer;
     constructor(matterbridge, log, config) {
         super(matterbridge, log, config);
@@ -194,11 +195,14 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
             }
         });
         this.z2m.on('availability', (device, available) => {
-            this.z2mDeviceAvailability.set(device, available);
+            this.z2mEntityAvailability.set(device, available);
             if (available)
-                this.log.info(`zigbee2MQTT device ${device} is ${available ? 'online' : 'offline'}`);
+                this.log.info(`zigbee2MQTT entity ${device} is ${available ? 'online' : 'offline'}`);
             else
-                this.log.warn(`zigbee2MQTT device ${device} is ${available ? 'online' : 'offline'}`);
+                this.log.warn(`zigbee2MQTT entity ${device} is ${available ? 'online' : 'offline'}`);
+        });
+        this.z2m.on('message', (device, payload) => {
+            this.z2mEntityPayload.set(device, payload);
         });
         this.z2m.on('permit_join', async (device, time, status) => {
             this.log.info(`zigbee2MQTT sent permit_join device: ${device} time: ${time} status: ${status}`);
@@ -334,10 +338,6 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
         await super.onConfigure();
         this.log.info(`Requesting update for ${this.zigbeeEntities.length} zigbee entities.`);
         for (const bridgedEntity of this.zigbeeEntities) {
-            if (bridgedEntity.isDevice && bridgedEntity.device)
-                await this.requestDeviceUpdate(bridgedEntity.device);
-            if (bridgedEntity.isGroup && bridgedEntity.group)
-                await this.requestGroupUpdate(bridgedEntity.group);
             await bridgedEntity.configure();
             if (bridgedEntity.isRouter && bridgedEntity.bridgedDevice) {
                 this.log.info(`Configuring router ${bridgedEntity.bridgedDevice?.deviceName}.`);
@@ -352,15 +352,22 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
                         bridgedEntity.bridgedDevice?.triggerEvent(DoorLock.Cluster.id, 'lockOperation', { lockOperationType: DoorLock.LockOperationType.Lock, operationSource: DoorLock.OperationSource.Manual, userIndex: null, fabricIndex: null, sourceNode: null }, this.log);
                 }
             }
+            if (bridgedEntity.isDevice && bridgedEntity.device)
+                await this.requestDeviceUpdate(bridgedEntity.device);
+            if (bridgedEntity.isGroup && bridgedEntity.group)
+                await this.requestGroupUpdate(bridgedEntity.group);
         }
         this.availabilityTimer = setTimeout(() => {
-            for (const [device, available] of this.z2mDeviceAvailability) {
+            for (const [entity, available] of this.z2mEntityAvailability) {
                 if (available)
-                    this.z2m.emit('ONLINE-' + device);
+                    this.z2m.emit('ONLINE-' + entity);
                 else
-                    this.z2m.emit('OFFLINE-' + device);
+                    this.z2m.emit('OFFLINE-' + entity);
+            }
+            for (const [entity, payload] of this.z2mEntityPayload) {
+                this.z2m.emit('MESSAGE-' + entity, payload);
             }
-        }, 60 * 1000);
+        }, 10 * 1000).unref();
         if (this.config.injectPayloads) {
             this.injectTimer = setInterval(() => {
                 const data = this.z2m.readConfig(path.join(this.matterbridge.matterbridgeDirectory, this.config.injectPayloads));

package/dist/zigbee2mqtt.js

@@ -70,6 +70,8 @@ export class Zigbee2MQTT extends EventEmitter {
             await mkdir(dataPath, { recursive: true });
             this.mqttDataPath = dataPath;
             this.log.debug(`Data directory ${this.mqttDataPath} created successfully.`);
+            const filePath = path.join(this.mqttDataPath, 'bridge-payloads.txt');
+            fs.unlinkSync(filePath);
         }
         catch (e) {
             const error = e;
@@ -80,6 +82,13 @@ export class Zigbee2MQTT extends EventEmitter {
                 this.log.error('Error creating data directory:', error);
             }
         }
+        try {
+            const filePath = path.join(this.mqttDataPath, 'bridge-payloads.txt');
+            fs.unlinkSync(filePath);
+        }
+        catch (error) {
+            this.log.debug(`Error deleting bridge-payloads.txt: ${error}`);
+        }
     }
     getUrl() {
         return 'mqtt://' + this.mqttHost + ':' + this.mqttPort.toString();
@@ -613,6 +622,7 @@ export class Zigbee2MQTT extends EventEmitter {
         else if (service === 'set') {
         }
         else if (service === undefined) {
+            this.emit('message', entity, data);
             this.emit('MESSAGE-' + entity, data);
         }
         else {

package/npm-shrinkwrap.json

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

package/package.json

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