matterbridge 1.6.7-dev.1 → 1.6.7-dev.3

package/CHANGELOG.md

@@ -18,7 +18,7 @@ Tamer (https://github.com/tammeryousef1006) has created the Matterbridge Discord
 In this release some device types and the OnOff, LevelControl and ColorControl have been updated to be fully compliant with Matter 1.3 specifications.
 It is possible that some controllers see them as new devices or need time to read the new clusters. It can be useful after the upgrade to power off the controller, wait a few minutes and power it on again.
 
-## [1.6.7-dev.1] - 2024-12-??
+## [1.6.7-dev.3] - 2024-12-15
 
 ### Added
 
@@ -27,12 +27,17 @@ It is possible that some controllers see them as new devices or need time to rea
 ### Changed
 
 - [Docker]: Add matterbridge-hass to Dockerfile for latest and main builds.
+- [edge]: Various fixes to edge mode.
 - [package]: Update dependencies.
 
 ### Fixed
 
 - [Device]: Fix addChildDeviceType methods to include debug parameter in MatterbridgeDevice instantiation.
 
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
+</a>
+
 ## [1.6.6] - 2024-12-12
 
 ### Added

package/README.md

@@ -226,14 +226,18 @@ It exposes:
 - a light with onOff
 - a light with onOff and levelControl (dimmer)
 - a light with onOff, levelControl and colorControl (with XY, HS and CT) clusters
-- a light with onOff, levelControl and colorControl (with HS only) clusters
-- a light with onOff, levelControl and colorControl (with XY only) clusters
+- a light with onOff, levelControl and colorControl (with HS and CT) clusters
+- a light with onOff, levelControl and colorControl (with XY and CT) clusters
 - a light with onOff, levelControl and colorControl (with CT only) clusters
 - an outlet (plug) with onOff cluster
 - a cover with windowCovering cluster
 - a lock with doorLock cluster
-- a thermo with thermostat cluster and 3 sub endpoints with flowMeasurement cluster, temperatureMeasurement cluster
+- a thermo autoMode (i.e. with Auto Heat and Cool features) with thermostat cluster and 3 sub endpoints with flowMeasurement cluster, temperatureMeasurement cluster
   and relativeHumidityMeasurement cluster (to show how to create a composed device with sub endpoints)
+- a thermo heat only with two external temperature sensors (tagged like Indoor and Outdoor)
+- a thermo cool only
+- an airConditioner device
+- an airPurifier device with temperature and humidity sensor (supported by Apple Home)
 - a fan with FanControl cluster
 - a rainSensor device
 - a waterFreezeDetector device

package/dist/matter/export.js

@@ -1,4 +1,5 @@
 export * from '@matter/main';
+export { AttributeElement, ClusterElement, ClusterModel, CommandElement, EventElement, FieldElement } from '@matter/main/model';
 export * from '../matterbridgeDeviceTypes.js';
 export * from '../matterbridgeEndpoint.js';
 export * from '../matterbridgeBehaviors.js';

package/dist/matterbridgeDevice.js

@@ -419,6 +419,7 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
     }
     createDefaultIdentifyClusterServer(identifyTime = 0, identifyType = Identify.IdentifyType.None) {
         this.addClusterServer(this.getDefaultIdentifyClusterServer(identifyTime, identifyType));
+        return this;
     }
     getDefaultGroupsClusterServer() {
         return ClusterServer(GroupsCluster, {
@@ -647,6 +648,48 @@ export class MatterbridgeDevice extends extendPublicHandlerMethods(Device) {
     createDefaultOnOffClusterServer(onOff = false, globalSceneControl = false, onTime = 0, offWaitTime = 0, startUpOnOff = null) {
         this.addClusterServer(this.getDefaultOnOffClusterServer(onOff, globalSceneControl, onTime, offWaitTime, startUpOnOff));
     }
+    getDeadFrontOnOffClusterServer(onOff = false) {
+        return ClusterServer(OnOffCluster.with(OnOff.Feature.DeadFrontBehavior), {
+            onOff,
+        }, {
+            on: async (data) => {
+                this.log.debug('Matter command: on');
+                await this.commandHandler.executeHandler('on', data);
+            },
+            off: async (data) => {
+                this.log.debug('Matter command: off');
+                await this.commandHandler.executeHandler('off', data);
+            },
+            toggle: async (data) => {
+                this.log.debug('Matter command: toggle');
+                await this.commandHandler.executeHandler('toggle', data);
+            },
+        }, {});
+    }
+    createDeadFrontOnOffClusterServer(onOff = false) {
+        this.addClusterServer(this.getDeadFrontOnOffClusterServer(onOff));
+    }
+    getOnOffClusterServer(onOff = false) {
+        return ClusterServer(OnOffCluster, {
+            onOff,
+        }, {
+            on: async (data) => {
+                this.log.debug('Matter command: on');
+                await this.commandHandler.executeHandler('on', data);
+            },
+            off: async (data) => {
+                this.log.debug('Matter command: off');
+                await this.commandHandler.executeHandler('off', data);
+            },
+            toggle: async (data) => {
+                this.log.debug('Matter command: toggle');
+                await this.commandHandler.executeHandler('toggle', data);
+            },
+        }, {});
+    }
+    createOnOffClusterServer(onOff = false) {
+        this.addClusterServer(this.getOnOffClusterServer(onOff));
+    }
     getDefaultLevelControlClusterServer(currentLevel = 254, minLevel = 1, maxLevel = 254, onLevel = null, startUpCurrentLevel = null) {
         return ClusterServer(LevelControlCluster.with(LevelControl.Feature.OnOff, LevelControl.Feature.Lighting), {
             currentLevel,

package/dist/matterbridgeDeviceTypes.js

@@ -92,8 +92,8 @@ export const fanDevice = DeviceTypeDefinition({
     code: 0x2b,
     deviceClass: DeviceClasses.Simple,
     revision: 2,
-    requiredServerClusters: [Identify.Cluster.id, FanControl.Cluster.id],
-    optionalServerClusters: [Groups.Cluster.id],
+    requiredServerClusters: [Identify.Cluster.id, Groups.Cluster.id, FanControl.Cluster.id],
+    optionalServerClusters: [],
 });
 export const thermostatDevice = DeviceTypeDefinition({
     name: 'MA-thermostat',

package/dist/matterbridgeEdge.js

@@ -77,45 +77,6 @@ export class MatterbridgeEdge extends Matterbridge {
         this.matterbridgeContext = undefined;
         this.log.info('Matter node storage closed');
     }
-    createMatterServer(storageManager) {
-        if (hasParameter('debug'))
-            this.log.warn('createMatterServer() => mock MatterServer.addCommissioningServer()');
-        const matterServer = {
-            addCommissioningServer: (commissioningServer, nodeOptions) => {
-                if (hasParameter('debug'))
-                    this.log.warn('MatterServer.addCommissioningServer() => do nothing');
-            },
-        };
-        return matterServer;
-    }
-    async startMatterServer() {
-        if (hasParameter('debug'))
-            this.log.warn('startMatterServer() => do nothing');
-    }
-    async stopMatterServer() {
-        if (hasParameter('debug'))
-            this.log.warn('stopMatterServer() => ...');
-        this.log.info(`Stopping matter server nodes in ${this.bridgeMode} mode...`);
-        if (this.bridgeMode === 'bridge') {
-            const serverNode = this.csToServerNode.get('Matterbridge')?.serverNode;
-            if (serverNode) {
-                await this.stopServerNode(serverNode);
-                this.log.info(`Stopped matter server node Matterbridge`);
-            }
-        }
-        if (this.bridgeMode === 'childbridge') {
-            this.plugins.forEach(async (plugin) => {
-                const serverNode = this.csToServerNode.get(plugin.name)?.serverNode;
-                if (serverNode) {
-                    await this.stopServerNode(serverNode);
-                    this.log.info(`Stopped matter server node ${plugin.name}`);
-                }
-            });
-        }
-        this.log.info('Stopped matter server nodes');
-        await this.environment.get(MdnsService)[Symbol.asyncDispose]();
-        this.log.info('Stopped MdnsService');
-    }
     async createServerNodeContext(pluginName, deviceName, deviceType, vendorId, vendorName, productId, productName, serialNumber) {
         if (!this.matterStorageService)
             throw new Error('No storage service initialized');
@@ -195,6 +156,14 @@ export class MatterbridgeEdge extends Matterbridge {
                 this.matterbridgeSessionInformations = [];
                 this.matterbridgePaired = true;
             }
+            if (this.bridgeMode === 'childbridge') {
+                const plugin = this.plugins.get(storeId);
+                if (plugin) {
+                    plugin.fabricInformations = sanitizedFabrics;
+                    plugin.sessionInformations = [];
+                    plugin.paired = true;
+                }
+            }
         };
         serverNode.lifecycle.commissioned.on(() => this.log.notice(`Server node for ${storeId} was initially commissioned successfully!`));
         serverNode.lifecycle.decommissioned.on(() => this.log.notice(`Server node for ${storeId} was fully decommissioned successfully!`));
@@ -213,6 +182,19 @@ export class MatterbridgeEdge extends Matterbridge {
                     this.log.notice(`QR Code URL: https://project-chip.github.io/connectedhomeip/qrcode.html?data=${qrPairingCode}`);
                     this.log.notice(`Manual pairing code: ${manualPairingCode}`);
                 }
+                if (this.bridgeMode === 'childbridge') {
+                    const plugin = this.plugins.get(storeId);
+                    if (plugin) {
+                        plugin.qrPairingCode = qrPairingCode;
+                        plugin.manualPairingCode = manualPairingCode;
+                        plugin.fabricInformations = [];
+                        plugin.sessionInformations = [];
+                        plugin.paired = false;
+                        plugin.connected = false;
+                        this.log.notice(`QR Code URL: https://project-chip.github.io/connectedhomeip/qrcode.html?data=${qrPairingCode}`);
+                        this.log.notice(`Manual pairing code: ${manualPairingCode}`);
+                    }
+                }
             }
             else {
                 this.log.notice(`Server node for ${storeId} is already commissioned. Waiting for controllers to connect ...`);
@@ -255,6 +237,12 @@ export class MatterbridgeEdge extends Matterbridge {
             if (this.bridgeMode === 'bridge') {
                 this.matterbridgeSessionInformations = sanitizedSessions;
             }
+            if (this.bridgeMode === 'childbridge') {
+                const plugin = this.plugins.get(storeId);
+                if (plugin) {
+                    plugin.sessionInformations = sanitizedSessions;
+                }
+            }
         };
         serverNode.events.sessions.opened.on((session) => {
             this.log.notice(`Session opened on server node for ${storeId}: ${debugStringify(session)}`);
@@ -300,8 +288,27 @@ export class MatterbridgeEdge extends Matterbridge {
             await aggregatorNode?.add(device);
         }
         else if (this.bridgeMode === 'childbridge') {
+            if (plugin.type === 'AccessoryPlatform') {
+                if (!plugin.locked && device.deviceName && device.vendorId && device.productId && device.vendorName && device.productName) {
+                    plugin.locked = true;
+                    plugin.storageContext = await this.createServerNodeContext(plugin.name, device.deviceName, DeviceTypeId(device.deviceType), device.vendorId, device.vendorName, device.productId, device.productName);
+                    plugin.commissioningServer = (await this.createServerNode(plugin.storageContext, this.port++, this.passcode ? this.passcode++ : undefined, this.discriminator ? this.discriminator++ : undefined));
+                    this.log.debug(`Adding matterbridge endpoint to server node for plugin ${plg}${plugin.name}${db}`);
+                    await plugin.commissioningServer.add(device);
+                    this.csToServerNode.set(plugin.name, { commissioningServer: plugin.commissioningServer, serverNode: plugin.commissioningServer });
+                }
+            }
             if (plugin.type === 'DynamicPlatform') {
-                this.log.info(`Adding ${pluginName}:${device.deviceName} to ${pluginName} aggregator node`);
+                if (!plugin.locked) {
+                    plugin.locked = true;
+                    plugin.storageContext = await this.createServerNodeContext(plugin.name, 'Matterbridge', bridge.code, this.aggregatorVendorId, 'Matterbridge', this.aggregatorProductId, plugin.description);
+                    plugin.commissioningServer = (await this.createServerNode(plugin.storageContext, this.port++, this.passcode ? this.passcode++ : undefined, this.discriminator ? this.discriminator++ : undefined));
+                    plugin.aggregator = (await this.createAggregatorNode(plugin.storageContext));
+                    this.log.debug(`Adding matter aggregator node to server node for plugin ${plg}${plugin.name}${db}`);
+                    await plugin.commissioningServer.add(plugin.aggregator);
+                    this.csToServerNode.set(plugin.name, { commissioningServer: plugin.commissioningServer, serverNode: plugin.commissioningServer });
+                    this.agToAggregatorEndpoint.set(plugin.name, { aggregator: plugin.aggregator, aggregatorNode: plugin.aggregator });
+                }
                 const aggregatorNode = this.agToAggregatorEndpoint.get(pluginName)?.aggregatorNode;
                 await aggregatorNode?.add(device);
             }
@@ -365,6 +372,45 @@ export class MatterbridgeEdge extends Matterbridge {
             await this.removeBridgedEndpoint(pluginName, device);
         }
     }
+    createMatterServer(storageManager) {
+        if (hasParameter('debug'))
+            this.log.warn('createMatterServer() => mock MatterServer.addCommissioningServer()');
+        const matterServer = {
+            addCommissioningServer: (commissioningServer, nodeOptions) => {
+                if (hasParameter('debug'))
+                    this.log.warn('MatterServer.addCommissioningServer() => do nothing');
+            },
+        };
+        return matterServer;
+    }
+    async startMatterServer() {
+        if (hasParameter('debug'))
+            this.log.warn('startMatterServer() => do nothing');
+    }
+    async stopMatterServer() {
+        if (hasParameter('debug'))
+            this.log.warn('stopMatterServer() => ...');
+        this.log.info(`Stopping matter server nodes in ${this.bridgeMode} mode...`);
+        if (this.bridgeMode === 'bridge') {
+            const serverNode = this.csToServerNode.get('Matterbridge')?.serverNode;
+            if (serverNode) {
+                await this.stopServerNode(serverNode);
+                this.log.info(`Stopped matter server node Matterbridge`);
+            }
+        }
+        if (this.bridgeMode === 'childbridge') {
+            for (const plugin of this.plugins.array()) {
+                const serverNode = this.csToServerNode.get(plugin.name)?.serverNode;
+                if (serverNode) {
+                    await this.stopServerNode(serverNode);
+                    this.log.info(`Stopped matter server node ${plugin.name}`);
+                }
+            }
+        }
+        this.log.info('Stopped matter server nodes');
+        await this.environment.get(MdnsService)[Symbol.asyncDispose]();
+        this.log.info('Stopped MdnsService');
+    }
     async createCommissioningServerContext(pluginName, deviceName, deviceType, vendorId, vendorName, productId, productName) {
         if (hasParameter('debug'))
             this.log.warn(`createCommissioningServerContext() for ${pluginName} => createServerNodeContext()`);

package/dist/matterbridgeEndpoint.js

@@ -165,7 +165,7 @@ export class MatterbridgeEndpoint extends Endpoint {
         if (clusterId === FlowMeasurement.Cluster.id)
             return FlowMeasurementServer;
         if (clusterId === BooleanState.Cluster.id)
-            return BooleanStateServer;
+            return BooleanStateServer.enable({ events: { stateChange: true } });
         if (clusterId === BooleanStateConfiguration.Cluster.id)
             return MatterbridgeBooleanStateConfigurationServer;
         if (clusterId === OccupancySensing.Cluster.id)
@@ -658,17 +658,14 @@ export class MatterbridgeEndpoint extends Endpoint {
             identifyType,
         }, {
             identify: async (data) => {
-                this.log.debug('Matter command: Identify');
-                await this.commandHandler.executeHandler('identify', data);
             },
             triggerEffect: async (data) => {
-                this.log.debug('Matter command: TriggerEffect');
-                await this.commandHandler.executeHandler('triggerEffect', data);
             },
         });
     }
     createDefaultIdentifyClusterServer(identifyTime = 0, identifyType = Identify.IdentifyType.None) {
         this.addClusterServer(this.getDefaultIdentifyClusterServer(identifyTime, identifyType));
+        return this;
     }
     getDefaultGroupsClusterServer() {
         return ClusterServer(GroupsCluster, {
@@ -858,6 +855,36 @@ export class MatterbridgeEndpoint extends Endpoint {
     createDefaultOnOffClusterServer(onOff = false, globalSceneControl = false, onTime = 0, offWaitTime = 0, startUpOnOff = null) {
         this.addClusterServer(this.getDefaultOnOffClusterServer(onOff, globalSceneControl, onTime, offWaitTime, startUpOnOff));
     }
+    getOnOffClusterServer(onOff = false) {
+        return ClusterServer(OnOffCluster, {
+            onOff,
+        }, {
+            on: async (data) => {
+            },
+            off: async (data) => {
+            },
+            toggle: async (data) => {
+            },
+        }, {});
+    }
+    createOnOffClusterServer(onOff = false) {
+        this.addClusterServer(this.getOnOffClusterServer(onOff));
+    }
+    getDeadFrontOnOffClusterServer(onOff = false) {
+        return ClusterServer(OnOffCluster.with(OnOff.Feature.DeadFrontBehavior), {
+            onOff,
+        }, {
+            on: async (data) => {
+            },
+            off: async (data) => {
+            },
+            toggle: async (data) => {
+            },
+        }, {});
+    }
+    createDeadFrontOnOffClusterServer(onOff = false) {
+        this.addClusterServer(this.getDeadFrontOnOffClusterServer(onOff));
+    }
     getDefaultLevelControlClusterServer(currentLevel = 254, minLevel = 1, maxLevel = 254, onLevel = null, startUpCurrentLevel = null) {
         return ClusterServer(LevelControlCluster.with(LevelControl.Feature.OnOff, LevelControl.Feature.Lighting), {
             currentLevel,

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge",
-  "version": "1.6.7-dev.1",
+  "version": "1.6.7-dev.3",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge",
-      "version": "1.6.7-dev.1",
+      "version": "1.6.7-dev.3",
       "license": "Apache-2.0",
       "dependencies": {
         "@matter/main": "0.11.9",
@@ -1952,9 +1952,9 @@
       }
     },
     "node_modules/text-decoder": {
-      "version": "1.2.2",
-      "resolved": "https://registry.npmjs.org/text-decoder/-/text-decoder-1.2.2.tgz",
-      "integrity": "sha512-/MDslo7ZyWTA2vnk1j7XoDVfXsGk3tp+zFEJHJGm0UjIlQifonVFwlVbQDFh8KJzTBnT8ie115TYqir6bclddA==",
+      "version": "1.2.3",
+      "resolved": "https://registry.npmjs.org/text-decoder/-/text-decoder-1.2.3.tgz",
+      "integrity": "sha512-3/o9z3X0X0fTupwsYvR03pJ/DjWuqqrfwBgTQzdWDiQSm9KitAyz/9WqsT2JQW7KV2m+bC2ol/zqpW37NHxLaA==",
       "license": "Apache-2.0",
       "dependencies": {
         "b4a": "^1.6.4"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge",
-  "version": "1.6.7-dev.1",
+  "version": "1.6.7-dev.3",
   "description": "Matterbridge plugin manager for Matter",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",