matterbridge-zigbee2mqtt 2.4.3 → 2.4.4-dev.2

package/dist/index.js

@@ -1,40 +1,5 @@
-/**
- * This file contains the entry point of Matterbridge.
- *
- * @file index.ts
- * @author Luca Liguori
- * @date 2023-12-29
- * @version 2.0.3
- *
- * Copyright 2023, 2024 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. *
- */
 import { ZigbeePlatform } from './platform.js';
 export * from './entity.js';
-/**
- * This is the standard interface for Matterbridge plugins.
- * Each plugin should export a default function that follows this signature.
- * Each plugin should return the platform.
- *
- * Initializes the Zigbee2mqtt plugin.
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
- * @param {AnsiLogger} log - The logger instance.
- * @param {PlatformConfig} config - The platform configuration.
- * @returns {ZigbeePlatform} The initialized Zigbee platform.
- */
 export default function initializePlugin(matterbridge, log, config) {
     return new ZigbeePlatform(matterbridge, log, config);
 }
-//# sourceMappingURL=index.js.map

package/dist/payloadTypes.js

@@ -1,24 +1 @@
-/**
- * This file contains the types for Payload.
- *
- * @file payloadTypes.ts
- * @author Luca Liguori
- * @date 2023-12-29
- * @version 1.0.1
- *
- * Copyright 2023, 2024 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. *
- */
 export {};
-//# sourceMappingURL=payloadTypes.js.map

package/dist/platform.js

@@ -1,40 +1,16 @@
-/**
- * This file contains the class ZigbeePlatform.
- *
- * @file platform.ts
- * @author Luca Liguori
- * @date 2023-12-29
- * @version 2.2.2
- *
- * Copyright 2023, 2024, 2025 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. *
- */
-import { BridgedDeviceBasicInformation, DoorLock, DoorLockCluster, MatterbridgeDynamicPlatform } from 'matterbridge';
+import { MatterbridgeDynamicPlatform } from 'matterbridge';
 import { dn, gn, db, wr, zb, payloadStringify, rs, debugStringify, CYAN, er, nf } from 'matterbridge/logger';
 import { isValidNumber, isValidString, waiter } from 'matterbridge/utils';
+import { BridgedDeviceBasicInformation, DoorLock } from 'matterbridge/matter/clusters';
 import path from 'path';
-import { ZigbeeDevice, ZigbeeGroup /* , BridgedBaseDevice*/ } from './entity.js';
+import { ZigbeeDevice, ZigbeeGroup } from './entity.js';
 import { Zigbee2MQTT } from './zigbee2mqtt.js';
 export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
-    // extension
     publishCallBack = undefined;
     permitJoinCallBack = undefined;
-    // platform
     bridgedDevices = [];
     zigbeeEntities = [];
     injectTimer;
-    // z2m
     mqttHost = 'localhost';
     mqttPort = 1883;
     mqttTopic = 'zigbee2mqtt';
@@ -47,7 +23,6 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
     featureBlackList = [];
     deviceFeatureBlackList = {};
     postfixHostname = true;
-    // zigbee2Mqtt
     debugEnabled;
     shouldStart;
     shouldConfigure;
@@ -62,11 +37,9 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
     availabilityTimer;
     constructor(matterbridge, log, config) {
         super(matterbridge, log, config);
-        // Verify that Matterbridge is the correct version
-        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('1.7.3')) {
-            throw new Error(`This plugin requires Matterbridge version >= "1.7.3". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend."`);
+        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('2.1.0')) {
+            throw new Error(`This plugin requires Matterbridge version >= "2.1.0". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend."`);
         }
-        // this.log.debug(`Config:')}${rs}`, config);
         this.debugEnabled = config.debug;
         this.shouldStart = false;
         this.shouldConfigure = false;
@@ -93,7 +66,6 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
         if (config.deviceFeatureBlackList)
             this.deviceFeatureBlackList = config.deviceFeatureBlackList;
         this.postfixHostname = config.postfixHostname ?? true;
-        // Save back to create a default plugin config.json
         config.host = this.mqttHost;
         config.port = this.mqttPort;
         config.protocolVersion = this.mqttProtocol;
@@ -109,7 +81,6 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
         }
         this.log.info(`Initializing platform: ${CYAN}${this.config.name}${nf} version: ${CYAN}${this.config.version}${rs}`);
         this.log.info(`Loaded zigbee2mqtt parameters from ${CYAN}${path.join(matterbridge.matterbridgeDirectory, 'matterbridge-zigbee2mqtt.config.json')}${rs}`);
-        // this.log.debug(`Config:')}${rs}`, config);
         this.z2m = new Zigbee2MQTT(this.mqttHost, this.mqttPort, this.mqttTopic, this.mqttUsername, this.mqttPassword, this.mqttProtocol, this.debugEnabled);
         this.z2m.setLogDebug(this.debugEnabled);
         this.z2m.setDataPath(path.join(matterbridge.matterbridgePluginDirectory, 'matterbridge-zigbee2mqtt'));
@@ -139,13 +110,11 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
         this.z2m.on('online', () => {
             this.log.info('zigbee2MQTT is online');
             this.z2mBridgeOnline = true;
-            // TODO check single availability
             this.updateAvailability(true);
         });
         this.z2m.on('offline', () => {
             this.log.warn('zigbee2MQTT is offline');
             this.z2mBridgeOnline = false;
-            // TODO check single availability
             this.updateAvailability(false);
         });
         this.z2m.on('bridge-info', async (bridgeInfo) => {
@@ -222,15 +191,14 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
             this.log.info(`zigbee2MQTT sent permit_join device: ${device} time: ${time} status: ${status}`);
             for (const zigbeeEntity of this.zigbeeEntities) {
                 if (zigbeeEntity.isRouter && (device === undefined || device === zigbeeEntity.bridgedDevice?.deviceName)) {
-                    // Coordinator or dedicated routers
                     this.log.info(`*- ${zigbeeEntity.bridgedDevice?.deviceName} ${zigbeeEntity.bridgedDevice?.number} (${zigbeeEntity.bridgedDevice?.name})`);
                     if (zigbeeEntity.device && status) {
-                        zigbeeEntity.bridgedDevice?.setAttribute(DoorLockCluster.id, 'lockState', DoorLock.LockState.Unlocked, this.log);
+                        zigbeeEntity.bridgedDevice?.setAttribute(DoorLock.Cluster.id, 'lockState', DoorLock.LockState.Unlocked, this.log);
                         zigbeeEntity.bridgedDevice?.triggerEvent(DoorLock.Cluster.id, 'lockOperation', { lockOperationType: DoorLock.LockOperationType.Unlock, operationSource: DoorLock.OperationSource.Manual, userIndex: null, fabricIndex: null, sourceNode: null }, this.log);
                         this.log.info(`Device ${zigbeeEntity.entityName} unlocked`);
                     }
                     if (zigbeeEntity.device && !status) {
-                        zigbeeEntity.bridgedDevice?.setAttribute(DoorLockCluster.id, 'lockState', DoorLock.LockState.Locked, this.log);
+                        zigbeeEntity.bridgedDevice?.setAttribute(DoorLock.Cluster.id, 'lockState', DoorLock.LockState.Locked, this.log);
                         zigbeeEntity.bridgedDevice?.triggerEvent(DoorLock.Cluster.id, 'lockOperation', { lockOperationType: DoorLock.LockOperationType.Lock, operationSource: DoorLock.OperationSource.Manual, userIndex: null, fabricIndex: null, sourceNode: null }, this.log);
                         this.log.info(`Device ${zigbeeEntity.entityName} locked`);
                     }
@@ -239,11 +207,9 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
         });
         this.z2m.on('device_joined', async (friendly_name, ieee_address) => {
             this.log.info(`zigbee2MQTT sent device_joined device: ${friendly_name} ieee_address: ${ieee_address}`);
-            // Here nothing to do, we wait eventually device_interview
         });
         this.z2m.on('device_announce', async (friendly_name, ieee_address) => {
             this.log.info(`zigbee2MQTT sent device_announce device: ${friendly_name} ieee_address: ${ieee_address}`);
-            // Here nothing to do, we wait device_interview
         });
         this.z2m.on('device_leave', async (friendly_name, ieee_address) => {
             this.log.info(`zigbee2MQTT sent device_leave device: ${friendly_name} ieee_address: ${ieee_address}`);
@@ -360,14 +326,14 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
             if (bridgedEntity.isRouter && bridgedEntity.bridgedDevice) {
                 this.log.info(`Configuring router ${bridgedEntity.bridgedDevice?.deviceName}.`);
                 if (this.z2mBridgeInfo?.permit_join) {
-                    bridgedEntity.bridgedDevice?.setAttribute(DoorLockCluster.id, 'lockState', DoorLock.LockState.Unlocked, this.log);
+                    bridgedEntity.bridgedDevice?.setAttribute(DoorLock.Cluster.id, 'lockState', DoorLock.LockState.Unlocked, this.log);
                     if (bridgedEntity.bridgedDevice.number)
-                        bridgedEntity.bridgedDevice?.triggerEvent(DoorLockCluster.id, 'lockOperation', { lockOperationType: DoorLock.LockOperationType.Unlock, operationSource: DoorLock.OperationSource.Manual, userIndex: null, fabricIndex: null, sourceNode: null }, this.log);
+                        bridgedEntity.bridgedDevice?.triggerEvent(DoorLock.Cluster.id, 'lockOperation', { lockOperationType: DoorLock.LockOperationType.Unlock, operationSource: DoorLock.OperationSource.Manual, userIndex: null, fabricIndex: null, sourceNode: null }, this.log);
                 }
                 else {
-                    bridgedEntity.bridgedDevice?.setAttribute(DoorLockCluster.id, 'lockState', DoorLock.LockState.Locked, this.log);
+                    bridgedEntity.bridgedDevice?.setAttribute(DoorLock.Cluster.id, 'lockState', DoorLock.LockState.Locked, this.log);
                     if (bridgedEntity.bridgedDevice.number)
-                        bridgedEntity.bridgedDevice?.triggerEvent(DoorLockCluster.id, 'lockOperation', { lockOperationType: DoorLock.LockOperationType.Lock, operationSource: DoorLock.OperationSource.Manual, userIndex: null, fabricIndex: null, sourceNode: null }, this.log);
+                        bridgedEntity.bridgedDevice?.triggerEvent(DoorLock.Cluster.id, 'lockOperation', { lockOperationType: DoorLock.LockOperationType.Lock, operationSource: DoorLock.OperationSource.Manual, userIndex: null, fabricIndex: null, sourceNode: null }, this.log);
                 }
             }
         }
@@ -402,22 +368,15 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
         if (this.availabilityTimer)
             clearInterval(this.availabilityTimer);
         this.availabilityTimer = undefined;
-        // this.updateAvailability(false);
         if (this.config.unregisterOnShutdown === true)
             await this.unregisterAllDevices();
         this.z2m.stop();
         this.publishCallBack = undefined;
         this.log.info(`Shutdown zigbee2mqtt dynamic platform v${this.version}`);
     }
-    /**
-     * @deprecated
-     */
     setPublishCallBack(onPublish) {
         this.publishCallBack = onPublish;
     }
-    /**
-     * @deprecated
-     */
     setPermitJoinCallBack(onPermitJoin) {
         this.permitJoinCallBack = onPermitJoin;
     }
@@ -433,9 +392,6 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
             this.log.info(`MQTT publish topic: ${CYAN}${this.z2m.mqttTopic + '/' + topic + (subTopic === '' ? '' : '/' + subTopic)}${nf} payload: ${CYAN}${message}${nf}`);
         }
     }
-    /**
-     * @deprecated
-     */
     emit(eventName, data) {
         this.z2m.emit(eventName, data);
     }
@@ -538,4 +494,3 @@ export class ZigbeePlatform extends MatterbridgeDynamicPlatform {
         }
     }
 }
-//# sourceMappingURL=platform.js.map