matterbridge-test 1.0.4 → 1.0.7-dev.1

package/CHANGELOG.md

@@ -4,6 +4,39 @@ All notable changes to this project will be documented in this file.
 
 If you like this project and find it useful, please consider giving it a star on GitHub at https://github.com/Luligu/matterbridge-example-dynamic-platform and sponsoring it.
 
+## [1.0.7] - 2025-02-01
+
+### Changed
+
+- [package]: Updated dependencies.
+- [package]: Require matterbridge 2.1.0.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
+</a>
+
+## [1.0.6] - 2025-01-21
+
+### Changed
+
+- [package]: Updated dependencies.
+- [package]: Require matterbridge 2.0.0.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
+</a>
+
+## [1.0.5] - 2025-01-21
+
+### Changed
+
+- [package]: Updated dependencies.
+- [package]: Require matterbridge 2.0.0.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
+</a>
+
 ## [1.0.4] - 2025-01-20
 
 ### Changed
@@ -11,6 +44,10 @@ If you like this project and find it useful, please consider giving it a star on
 - [package]: Updated dependencies.
 - [package]: Updated package for production build.
 
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
+</a>
+
 ## [1.0.3] - 2024-12-21
 
 ### Added

package/dist/platform.js

@@ -1,4 +1,4 @@
-import { MatterbridgeDevice, MatterbridgeDynamicPlatform, bridgedNode, electricalSensor, onOffSwitch, onOffOutlet, colorTemperatureLight, OnOffCluster, powerSource, ElectricalPowerMeasurementCluster, ElectricalEnergyMeasurementCluster, ModeSelectCluster, PowerSourceCluster, modeSelect, MatterbridgeEndpoint, } from 'matterbridge';
+import { MatterbridgeDynamicPlatform, bridgedNode, electricalSensor, onOffSwitch, onOffOutlet, colorTemperatureLight, OnOffCluster, powerSource, ElectricalPowerMeasurementCluster, ElectricalEnergyMeasurementCluster, ModeSelectCluster, PowerSourceCluster, modeSelect, MatterbridgeEndpoint, } from 'matterbridge';
 import { waiter } from 'matterbridge/utils';
 export class TestPlatform extends MatterbridgeDynamicPlatform {
     noDevices = false;
@@ -16,18 +16,10 @@ export class TestPlatform extends MatterbridgeDynamicPlatform {
     enablePowerSource = false;
     interval;
     bridgedDevices = new Map();
-    async createMutableDevice(definition, options = {}, debug = false) {
-        let device;
-        if (this.matterbridge.edge === true)
-            device = new MatterbridgeEndpoint(definition, options, debug);
-        else
-            device = new MatterbridgeDevice(definition, options, debug);
-        return device;
-    }
     constructor(matterbridge, log, config) {
         super(matterbridge, log, config);
-        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('1.7.3')) {
-            throw new Error(`The test plugin requires Matterbridge version >= "1.7.3". Please update Matterbridge to the latest version in the frontend.`);
+        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('2.1.0')) {
+            throw new Error(`The test plugin requires Matterbridge version >= "2.1.0". Please update Matterbridge to the latest version in the frontend.`);
         }
         this.log.info('Initializing platform:', this.config.name);
         this.log.debug('- with matterbridge version ', matterbridge.matterbridgeVersion);
@@ -84,10 +76,15 @@ export class TestPlatform extends MatterbridgeDynamicPlatform {
         if (this.config.longDelayStart)
             await waiter('Delay start', () => false, false, 60000, 1000);
         for (let i = 0; i < this.loadSwitches; i++) {
-            const switchDevice = await this.createMutableDevice([onOffSwitch, bridgedNode], { uniqueStorageKey: 'Switch' + i }, this.config.debug);
+            const switchDevice = new MatterbridgeEndpoint([
+                onOffSwitch,
+                bridgedNode,
+                ...(this.enableElectrical ? [electricalSensor] : []),
+                ...(this.enablePowerSource ? [powerSource] : []),
+                ...(this.enableModeSelect ? [modeSelect] : []),
+            ], { uniqueStorageKey: 'Switch' + i }, this.config.debug);
             switchDevice.log.logName = 'Switch' + i;
             switchDevice.createDefaultBridgedDeviceBasicInformationClusterServer('Switch ' + i, 'serial_switch_' + i, 0xfff1, 'Matterbridge', 'Matterbridge test plugin', parseInt(this.version.replace(/\D/g, '')), this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion);
-            switchDevice.addDeviceTypeWithClusterServer([onOffSwitch], []);
             switchDevice.addCommandHandler('identify', async (data) => {
                 this.log.info(`Received identify command request ${data.request.identifyTime} for endpoint ${data.endpoint?.number}`);
             });
@@ -104,18 +101,24 @@ export class TestPlatform extends MatterbridgeDynamicPlatform {
             if (this.enableModeSelect) {
                 this.addModeSelect(switchDevice, 'Switch ' + i);
                 switchDevice.addCommandHandler('changeToMode', async (data) => {
-                    this.log.info(`Received command changeToMode with request ${data.request.newMode} for endpoint ${data.endpoint?.number}`);
+                    this.log.info(`Received changeToMode command with request ${data.request.newMode} for endpoint ${data.endpoint?.number}`);
                 });
             }
+            switchDevice.addRequiredClusterServers();
             if (this.noDevices === false)
                 await this.registerDevice(switchDevice);
             this.bridgedDevices.set('Switch' + i, switchDevice);
         }
         for (let i = 0; i < this.loadOutlets; i++) {
-            const outletDevice = await this.createMutableDevice([onOffOutlet, bridgedNode], { uniqueStorageKey: 'Outlet' + i }, this.config.debug);
+            const outletDevice = new MatterbridgeEndpoint([
+                onOffOutlet,
+                bridgedNode,
+                ...(this.enableElectrical ? [electricalSensor] : []),
+                ...(this.enablePowerSource ? [powerSource] : []),
+                ...(this.enableModeSelect ? [modeSelect] : []),
+            ], { uniqueStorageKey: 'Outlet' + i }, this.config.debug);
             outletDevice.log.logName = 'Outlet' + i;
             outletDevice.createDefaultBridgedDeviceBasicInformationClusterServer('Outlet ' + i, 'serial_outlet_' + i, 0xfff1, 'Matterbridge', 'Matterbridge test plugin', parseInt(this.version.replace(/\D/g, '')), this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion);
-            outletDevice.addDeviceTypeWithClusterServer([onOffOutlet], []);
             outletDevice.addCommandHandler('identify', async (data) => {
                 this.log.info(`Received identify command request ${data.request.identifyTime} for endpoint ${data.endpoint?.number}`);
             });
@@ -135,15 +138,21 @@ export class TestPlatform extends MatterbridgeDynamicPlatform {
                     this.log.info(`Received command changeToMode with request ${data.request.newMode} for endpoint ${data.endpoint?.number}`);
                 });
             }
+            outletDevice.addRequiredClusterServers();
             if (this.noDevices === false)
                 await this.registerDevice(outletDevice);
             this.bridgedDevices.set('Outlet' + i, outletDevice);
         }
         for (let i = 0; i < this.loadLights; i++) {
-            const lightDevice = await this.createMutableDevice([colorTemperatureLight, bridgedNode], { uniqueStorageKey: 'Light' + i }, this.config.debug);
+            const lightDevice = new MatterbridgeEndpoint([
+                colorTemperatureLight,
+                bridgedNode,
+                ...(this.enableElectrical ? [electricalSensor] : []),
+                ...(this.enablePowerSource ? [powerSource] : []),
+                ...(this.enableModeSelect ? [modeSelect] : []),
+            ], { uniqueStorageKey: 'Light' + i }, this.config.debug);
             lightDevice.log.logName = 'Light' + i;
             lightDevice.createDefaultBridgedDeviceBasicInformationClusterServer('Light ' + i, 'serial_light_' + i, 0xfff1, 'Matterbridge', 'Matterbridge test plugin', parseInt(this.version.replace(/\D/g, '')), this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion);
-            lightDevice.addDeviceTypeWithClusterServer([colorTemperatureLight], []);
             lightDevice.addCommandHandler('identify', async (data) => {
                 this.log.info(`Received identify command request ${data.request.identifyTime} for endpoint ${data.endpoint?.number}`);
             });
@@ -154,25 +163,25 @@ export class TestPlatform extends MatterbridgeDynamicPlatform {
                 this.log.info(`Received off command for endpoint ${data.endpoint?.number}`);
             });
             lightDevice.addCommandHandler('moveToLevel', async (data) => {
-                this.log.info(`Received moveTolevel command request ${data.request.level} for endpoint ${data.endpoint?.number}`);
+                this.log.info(`Received moveToLevel command request ${data.request.level} for endpoint ${data.endpoint?.number}`);
             });
             lightDevice.addCommandHandler('moveToLevelWithOnOff', async (data) => {
-                this.log.info(`Received moveTolevel command request ${data.request.level} for endpoint ${data.endpoint?.number}`);
+                this.log.info(`Received moveToLevelWithOnOff command request ${data.request.level} for endpoint ${data.endpoint?.number}`);
             });
             lightDevice.addCommandHandler('moveToColor', async ({ request: { colorX, colorY } }) => {
-                this.log.info(`Command moveToColor called request X ${colorX / 65536} Y ${colorY / 65536}`);
+                this.log.info(`Received moveToColor command request X ${colorX / 65536} Y ${colorY / 65536}`);
             });
             lightDevice.addCommandHandler('moveToHueAndSaturation', async ({ request: { hue, saturation } }) => {
-                this.log.info(`Command moveToHueAndSaturation called request hue ${hue} saturation ${saturation}`);
+                this.log.info(`Received moveToHueAndSaturation command request hue ${hue} saturation ${saturation}`);
             });
             lightDevice.addCommandHandler('moveToHue', async ({ request: { hue } }) => {
-                this.log.info(`Command moveToHue called request ${hue}`);
+                this.log.info(`Received moveToHue command request ${hue}`);
             });
             lightDevice.addCommandHandler('moveToSaturation', async ({ request: { saturation } }) => {
-                this.log.info(`Command moveToSaturation called request ${saturation}`);
+                this.log.info(`Received moveToSaturation command request ${saturation}`);
             });
             lightDevice.addCommandHandler('moveToColorTemperature', async ({ request }) => {
-                this.log.info(`Command moveToColorTemperature called request ${request.colorTemperatureMireds}`);
+                this.log.info(`Received moveToColorTemperature command request ${request.colorTemperatureMireds}`);
             });
             if (this.enableElectrical)
                 this.addElectricalMeasurements(lightDevice);
@@ -184,27 +193,25 @@ export class TestPlatform extends MatterbridgeDynamicPlatform {
                     this.log.info(`Received command changeToMode with request ${data.request.newMode} for endpoint ${data.endpoint?.number}`);
                 });
             }
+            lightDevice.addRequiredClusterServers();
             if (this.noDevices === false)
                 await this.registerDevice(lightDevice);
             this.bridgedDevices.set('Light' + i, lightDevice);
         }
     }
     addElectricalMeasurements(device) {
-        device.addDeviceType(electricalSensor);
-        device.addClusterServer(device.getDefaultPowerTopologyClusterServer());
-        device.addClusterServer(device.getDefaultElectricalPowerMeasurementClusterServer(220 * 1000, 2.5 * 1000, 220 * 2.5 * 1000, 50 * 1000));
-        device.addClusterServer(device.getDefaultElectricalEnergyMeasurementClusterServer(1500 * 1000));
+        device.createDefaultPowerTopologyClusterServer();
+        device.createDefaultElectricalPowerMeasurementClusterServer(220 * 1000, 2.5 * 1000, 220 * 2.5 * 1000, 50 * 1000);
+        device.createDefaultElectricalEnergyMeasurementClusterServer(1500 * 1000);
     }
     addModeSelect(device, description) {
-        device.addDeviceType(modeSelect);
-        device.addClusterServer(device.getDefaultModeSelectClusterServer(description + ' Led Mode Select', [
+        device.createDefaultModeSelectClusterServer(description + ' Led Mode Select', [
             { label: 'Led ON', mode: 1, semanticTags: [] },
             { label: 'Led OFF', mode: 2, semanticTags: [] },
-        ], 1, 1));
+        ], 1, 1);
     }
     addPowerSource(device) {
-        device.addDeviceType(powerSource);
-        device.addClusterServer(device.getDefaultPowerSourceReplaceableBatteryClusterServer(100));
+        device.createDefaultPowerSourceReplaceableBatteryClusterServer(100);
     }
     async onConfigure() {
         await super.onConfigure();

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-test",
-  "version": "1.0.4",
+  "version": "1.0.7-dev.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-test",
-      "version": "1.0.4",
+      "version": "1.0.7-dev.1",
       "license": "Apache-2.0",
       "dependencies": {
         "node-ansi-logger": "3.0.0",
@@ -34,10 +34,13 @@
       }
     },
     "node_modules/node-persist": {
-      "version": "4.0.3",
-      "resolved": "https://registry.npmjs.org/node-persist/-/node-persist-4.0.3.tgz",
-      "integrity": "sha512-0gDy86TNShzfbpUKFbH8KJFjoovuUgVh/FqL4jrJWYz0cET76Uohl118utG/Ft6wl4sHOPXdRSY7eXH5kVY06w==",
+      "version": "4.0.4",
+      "resolved": "https://registry.npmjs.org/node-persist/-/node-persist-4.0.4.tgz",
+      "integrity": "sha512-8sPAz/7tw1mCCc8xBG4f0wi+flHkSSgQeX998iQ75Pu27evA6UUWCjSE7xnrYTg2q33oU5leJ061EKPDv6BocQ==",
       "license": "MIT",
+      "dependencies": {
+        "p-limit": "^3.1.0"
+      },
       "engines": {
         "node": ">=10.12.0"
       }
@@ -57,6 +60,33 @@
         "type": "buymeacoffee",
         "url": "https://www.buymeacoffee.com/luligugithub"
       }
+    },
+    "node_modules/p-limit": {
+      "version": "3.1.0",
+      "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz",
+      "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==",
+      "license": "MIT",
+      "dependencies": {
+        "yocto-queue": "^0.1.0"
+      },
+      "engines": {
+        "node": ">=10"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/sindresorhus"
+      }
+    },
+    "node_modules/yocto-queue": {
+      "version": "0.1.0",
+      "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz",
+      "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==",
+      "license": "MIT",
+      "engines": {
+        "node": ">=10"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/sindresorhus"
+      }
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-test",
-  "version": "1.0.4",
+  "version": "1.0.7-dev.1",
   "description": "Matterbridge test plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",