matterbridge-example-dynamic-platform 2.0.13-dev-20260302-e8d75fe → 2.0.13-dev-20260302-2a66e51

package/CHANGELOG.md

@@ -35,7 +35,9 @@ If you like this project and find it useful, please consider giving it a star on
 
 ### Added
 
-- [BridgedOutlet]: Add a bridged outlet with four individually controllable plugs.
+- [BridgedOutlet]: Add a bridged outlet with four individually controllable plugs that expose their names.
+- [onOffMountedLegacy]: Add an onOff Mounted Switch legacy device.
+- [dimmerMountedLegacy]: Add a dimmer Mounted Switch legacy device.
 
 ### Changed
 

package/README.md

@@ -24,13 +24,13 @@
 
 Matterbridge dynamic platform example plugin is a template to develop your own plugin using the dynamic platform.
 
-It exposes 64 virtual devices:
+It exposes 66 virtual devices:
 
 - a door contact sensor
 - a motion sensor
 - an illuminance sensor
 - a temperature sensor
-- an humidity sensor
+- a humidity sensor
 - a pressure sensor
 - a flow sensor
 - a climate sensor with temperature, humidity and pressure
@@ -46,7 +46,7 @@ It exposes 64 virtual devices:
 - an outlet (plug) with onOff cluster, energy measurements and power measurements
 - an outlet (plug) with onOff cluster, apparent energy measurements and power measurements
 - a smart outlet with an energy meter and four individually controllable sockets (with tagList 1, 2, 3 and 4)
-- a bridged outlet with four individually controllable plugs
+- a bridged outlet with four individually controllable plugs that expose their names
 - a cover with windowCovering cluster and lift feature
 - a cover with windowCovering cluster and both lift and tilt features
 - a lock with doorLock cluster
@@ -60,22 +60,24 @@ It exposes 64 virtual devices:
 - a fan with Off Low Med High presets
 - a fan with Off Low Med High Auto presets and step
 - a fan with all the features MultiSpeed, Auto, Step, Rock, Wind and AirflowDirection and mode Off Low Med High Auto.
-- a rainSensor device
-- a waterFreezeDetector device
-- a waterLeakDetector device
+- a rain sensor device
+- a water freeze detector device
+- a water leak detector device
 - a smokeCoAlarm (with smoke and co features) sensor (supported by Apple Home)
 - a smokeCoAlarm (with smoke only feature) sensor (supported by Apple Home)
 - a smokeCoAlarm (with co only feature) sensor (supported by Apple Home)
 - an airConditioner device
 - an airPurifier device with temperature and humidity sensor (supported by Apple Home)
-- a pumpDevice device
+- a pump device
 - a waterValve device
 - an airQuality device with all concentration measurements clusters (supported by Apple Home with the concentration measurements from version 18.5)
 - a momentary switch composed by three switches with Single Double Long (tagged with One Two Three and Top Middle Bottom) and three switches with Single only.
 - a latching switch
 - a Robot Vacuum Cleaner device (supported by SmartThings, Alexa, Home Assistant and partially by Apple Home). Read also <https://github.com/Luligu/matterbridge/discussions/264>.
-- a onOff Mounted Switch device (supported by SmartThings, Alexa, Home Assistant)
+- an onOff Mounted Switch device (supported by SmartThings, Alexa, Home Assistant)
+- a onOff Mounted Switch legacy device (supported by all controllers)
 - a dimmer Mounted Switch device (supported by SmartThings, Alexa, Home Assistant)
+- a dimmer Mounted Switch legacy device (supported by all controllers)
 - a laundry Washer device (supported by SmartThings, Alexa and Home Assistant)
 - a laundry Dryer device (supported by SmartThings, Alexa and Home Assistant)
 - a dishwasher device (supported by SmartThings, Alexa and Home Assistant)
@@ -92,9 +94,9 @@ It exposes 64 virtual devices:
 - a basic video player (supported by SmartThings)
 - a speaker device (supported by SmartThings)
 
-All these devices continuously change state and position. The plugin also shows how to use all the command handlers (you can control all the devices), how to subscribe to attributes and how to trigger events.
+All these devices continuously change their state and position. The plugin also shows how to use all the command handlers (so you can control all the devices), how to subscribe to attributes, and how to trigger events.
 
-If you want to write your plugin, the easiest way to start create a new plugin is to clone the [Matterbridge Plugin Template](https://github.com/Luligu/matterbridge-plugin-template) which has **Dev Container support for instant development environment** and all tools and extensions (like Node.js, npm, TypeScript, ESLint, Prettier, Jest and Vitest) already loaded and configured.
+If you want to write your own plugin, the easiest way to get started is to clone the [Matterbridge Plugin Template](https://github.com/Luligu/matterbridge-plugin-template). It has **Dev Container support for an instant development environment**, with all tools and extensions (like Node.js, npm, TypeScript, ESLint, Prettier, Jest, and Vitest) already loaded and configured.
 
 If you like this project and find it useful, please consider giving it a star on [GitHub](https://github.com/Luligu/matterbridge-example-dynamic-platform) and sponsoring it.
 
@@ -108,4 +110,4 @@ See the guidelines on [Matterbridge](https://github.com/Luligu/matterbridge/blob
 
 ## Style guide
 
-See also the [Style Guide](./STYLE_GUIDE.md) for JSDoc, naming and logging conventions used in this repository.
+See also the [Style Guide](./STYLEGUIDE.md) for JSDoc, naming, and logging conventions used in this repository.

package/dist/module.js

@@ -36,6 +36,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     switch;
     mountedOnOffSwitch;
     mountedDimmerSwitch;
+    mountedOnOffSwitchLegacy;
+    mountedDimmerSwitchLegacy;
     lightOnOff;
     dimmer;
     light;
@@ -194,7 +196,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         this.switch?.addCommandHandler('off', async () => {
             this.switch?.log.info('Command off called');
         });
-        this.mountedOnOffSwitch = new MatterbridgeEndpoint([onOffMountedSwitch, onOffOutlet, bridgedNode, powerSource], { id: 'OnOffMountedSwitch' }, this.config.debug)
+        this.mountedOnOffSwitch = new MatterbridgeEndpoint([onOffMountedSwitch, bridgedNode, powerSource], { id: 'OnOffMountedSwitch' }, this.config.debug)
             .createDefaultIdentifyClusterServer()
             .createDefaultBridgedDeviceBasicInformationClusterServer('OnOff Mounted Switch', 'OMS00011', 0xfff1, 'Matterbridge', 'Matterbridge OnOff Mounted Switch')
             .createDefaultOnOffClusterServer()
@@ -210,7 +212,23 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         this.mountedOnOffSwitch?.addCommandHandler('off', async () => {
             this.mountedOnOffSwitch?.log.info('Command off called');
         });
-        this.mountedDimmerSwitch = new MatterbridgeEndpoint([dimmableMountedSwitch, dimmableOutlet, bridgedNode, powerSource], { id: 'DimmerMountedSwitch' }, this.config.debug)
+        this.mountedOnOffSwitchLegacy = new MatterbridgeEndpoint([onOffMountedSwitch, onOffOutlet, bridgedNode, powerSource], { id: 'OnOffMountedSwitchLegacy' }, this.config.debug)
+            .createDefaultIdentifyClusterServer()
+            .createDefaultBridgedDeviceBasicInformationClusterServer('OnOff Mounted Switch Legacy', 'OMSL00011', 0xfff1, 'Matterbridge', 'Matterbridge OnOff Mounted Switch Legacy')
+            .createDefaultOnOffClusterServer()
+            .createDefaultPowerSourceWiredClusterServer()
+            .addRequiredClusterServers();
+        this.mountedOnOffSwitchLegacy = await this.addDevice(this.mountedOnOffSwitchLegacy);
+        this.mountedOnOffSwitchLegacy?.addCommandHandler('identify', async ({ request: { identifyTime } }) => {
+            this.mountedOnOffSwitchLegacy?.log.info(`Command identify called identifyTime:${identifyTime}`);
+        });
+        this.mountedOnOffSwitchLegacy?.addCommandHandler('on', async () => {
+            this.mountedOnOffSwitchLegacy?.log.info('Command on called');
+        });
+        this.mountedOnOffSwitchLegacy?.addCommandHandler('off', async () => {
+            this.mountedOnOffSwitchLegacy?.log.info('Command off called');
+        });
+        this.mountedDimmerSwitch = new MatterbridgeEndpoint([dimmableMountedSwitch, bridgedNode, powerSource], { id: 'DimmerMountedSwitch' }, this.config.debug)
             .createDefaultIdentifyClusterServer()
             .createDefaultBridgedDeviceBasicInformationClusterServer('Dimmer Mounted Switch', 'DMS00012', 0xfff1, 'Matterbridge', 'Matterbridge Dimmer Mounted Switch')
             .createDefaultOnOffClusterServer()
@@ -233,6 +251,29 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         this.mountedDimmerSwitch?.addCommandHandler('moveToLevelWithOnOff', async ({ request: { level } }) => {
             this.mountedDimmerSwitch?.log.debug(`Command moveToLevelWithOnOff called request: ${level}`);
         });
+        this.mountedDimmerSwitchLegacy = new MatterbridgeEndpoint([dimmableMountedSwitch, dimmableOutlet, bridgedNode, powerSource], { id: 'DimmerMountedSwitchLegacy' }, this.config.debug)
+            .createDefaultIdentifyClusterServer()
+            .createDefaultBridgedDeviceBasicInformationClusterServer('Dimmer Mounted Switch Legacy', 'DMSL00012', 0xfff1, 'Matterbridge', 'Matterbridge Dimmer Mounted Switch Legacy')
+            .createDefaultOnOffClusterServer()
+            .createDefaultLevelControlClusterServer()
+            .createDefaultPowerSourceWiredClusterServer()
+            .addRequiredClusterServers();
+        this.mountedDimmerSwitchLegacy = await this.addDevice(this.mountedDimmerSwitchLegacy);
+        this.mountedDimmerSwitchLegacy?.addCommandHandler('identify', async ({ request: { identifyTime } }) => {
+            this.mountedDimmerSwitchLegacy?.log.info(`Command identify called identifyTime:${identifyTime}`);
+        });
+        this.mountedDimmerSwitchLegacy?.addCommandHandler('on', async () => {
+            this.mountedDimmerSwitchLegacy?.log.info('Command on called');
+        });
+        this.mountedDimmerSwitchLegacy?.addCommandHandler('off', async () => {
+            this.mountedDimmerSwitchLegacy?.log.info('Command off called');
+        });
+        this.mountedDimmerSwitchLegacy?.addCommandHandler('moveToLevel', async ({ request: { level } }) => {
+            this.mountedDimmerSwitchLegacy?.log.debug(`Command moveToLevel called request: ${level}`);
+        });
+        this.mountedDimmerSwitchLegacy?.addCommandHandler('moveToLevelWithOnOff', async ({ request: { level } }) => {
+            this.mountedDimmerSwitchLegacy?.log.debug(`Command moveToLevelWithOnOff called request: ${level}`);
+        });
         this.lightOnOff = new MatterbridgeEndpoint([onOffLight, bridgedNode, powerSource], { id: 'Light (on/off)' }, this.config.debug)
             .createDefaultIdentifyClusterServer()
             .createDefaultBridgedDeviceBasicInformationClusterServer('Light (on/off)', 'LON00013', 0xfff1, 'Matterbridge', 'Matterbridge Light on/off')
@@ -462,6 +503,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             .createDefaultElectricalEnergyMeasurementClusterServer(0, 0)
             .createDefaultElectricalPowerMeasurementClusterServer(220_000, 0, 0, 50_000)
             .addRequiredClusterServers();
+        this.smartOutlet.addFixedLabel('composed', 'Compound device');
         this.smartOutlet
             .addChildDeviceTypeWithClusterServer('Socket 1', onOffOutlet, [OnOffCluster.id], {
             id: 'Socket1',
@@ -1179,6 +1221,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         this.momentarySwitch = new MatterbridgeEndpoint([bridgedNode, powerSource], { id: 'Momentary switch composed' }, this.config.debug)
             .createDefaultBridgedDeviceBasicInformationClusterServer('Momentary switch', 'MOS00041', 0xfff1, 'Matterbridge', 'Matterbridge Momentary Switch')
             .createDefaultPowerSourceReplaceableBatteryClusterServer(50, PowerSource.BatChargeLevel.Ok, 2900, 'CR2450', 1);
+        this.momentarySwitch.addFixedLabel('composed', 'Compound device');
         this.momentarySwitch
             .addChildDeviceType('Momentary switch 1', [genericSwitch], {
             tagList: [
@@ -1770,11 +1813,13 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         }
         await this.switch?.setAttribute(OnOff.Cluster.id, 'onOff', this.intervalOnOff, this.switch.log);
         await this.mountedOnOffSwitch?.setAttribute(OnOff.Cluster.id, 'onOff', this.intervalOnOff, this.mountedOnOffSwitch.log);
+        await this.mountedOnOffSwitchLegacy?.setAttribute(OnOff.Cluster.id, 'onOff', this.intervalOnOff, this.mountedOnOffSwitchLegacy.log);
         this.switch?.log.info(`Set switch initial onOff to ${this.intervalOnOff}`);
         if (this.config.useInterval) {
             this.addInterval(async () => {
                 await this.switch?.setAttribute(OnOff.Cluster.id, 'onOff', this.intervalOnOff, this.switch.log);
                 await this.mountedOnOffSwitch?.setAttribute(OnOff.Cluster.id, 'onOff', this.intervalOnOff, this.mountedOnOffSwitch.log);
+                await this.mountedOnOffSwitchLegacy?.setAttribute(OnOff.Cluster.id, 'onOff', this.intervalOnOff, this.mountedOnOffSwitchLegacy.log);
                 this.log.info(`Set switches onOff to ${this.intervalOnOff}`);
                 this.intervalOnOff = !this.intervalOnOff;
             }, 60 * 1000 + 100);
@@ -1785,6 +1830,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         await this.dimmer?.setAttribute(LevelControl.Cluster.id, 'currentLevel', 1, this.dimmer.log);
         await this.mountedDimmerSwitch?.setAttribute(OnOff.Cluster.id, 'onOff', false, this.mountedDimmerSwitch.log);
         await this.mountedDimmerSwitch?.setAttribute(LevelControl.Cluster.id, 'currentLevel', 1, this.mountedDimmerSwitch.log);
+        await this.mountedDimmerSwitchLegacy?.setAttribute(OnOff.Cluster.id, 'onOff', false, this.mountedDimmerSwitchLegacy.log);
+        await this.mountedDimmerSwitchLegacy?.setAttribute(LevelControl.Cluster.id, 'currentLevel', 1, this.mountedDimmerSwitchLegacy.log);
         this.dimmer?.log.info(`Set dimmer initial onOff to false, currentLevel to 1.`);
         await this.light?.setAttribute(OnOff.Cluster.id, 'onOff', false, this.light.log);
         await this.light?.setAttribute(LevelControl.Cluster.id, 'currentLevel', 200, this.light.log);
@@ -1817,6 +1864,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
                     await this.lightOnOff?.setAttribute(OnOff.Cluster.id, 'onOff', false, this.lightOnOff.log);
                     await this.dimmer?.setAttribute(OnOff.Cluster.id, 'onOff', false, this.dimmer.log);
                     await this.mountedDimmerSwitch?.setAttribute(OnOff.Cluster.id, 'onOff', false, this.mountedDimmerSwitch.log);
+                    await this.mountedDimmerSwitchLegacy?.setAttribute(OnOff.Cluster.id, 'onOff', false, this.mountedDimmerSwitchLegacy.log);
                     await this.light?.setAttribute(OnOff.Cluster.id, 'onOff', false, this.light.log);
                     await this.lightXY?.setAttribute(OnOff.Cluster.id, 'onOff', false, this.lightXY.log);
                     await this.lightHS?.setAttribute(OnOff.Cluster.id, 'onOff', false, this.lightHS.log);
@@ -1827,6 +1875,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
                     await this.lightOnOff?.setAttribute(OnOff.Cluster.id, 'onOff', true, this.lightOnOff?.log);
                     await this.dimmer?.setAttribute(OnOff.Cluster.id, 'onOff', true, this.dimmer.log);
                     await this.mountedDimmerSwitch?.setAttribute(OnOff.Cluster.id, 'onOff', true, this.mountedDimmerSwitch.log);
+                    await this.mountedDimmerSwitchLegacy?.setAttribute(OnOff.Cluster.id, 'onOff', true, this.mountedDimmerSwitchLegacy.log);
                     await this.light?.setAttribute(OnOff.Cluster.id, 'onOff', true, this.light.log);
                     await this.lightXY?.setAttribute(OnOff.Cluster.id, 'onOff', true, this.lightXY.log);
                     await this.lightHS?.setAttribute(OnOff.Cluster.id, 'onOff', true, this.lightHS.log);
@@ -1834,6 +1883,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
                     this.log.info('Set lights onOff to true');
                     await this.dimmer?.setAttribute(LevelControl.Cluster.id, 'currentLevel', this.intervalLevel, this.dimmer.log);
                     await this.mountedDimmerSwitch?.setAttribute(LevelControl.Cluster.id, 'currentLevel', this.intervalLevel, this.mountedDimmerSwitch.log);
+                    await this.mountedDimmerSwitchLegacy?.setAttribute(LevelControl.Cluster.id, 'currentLevel', this.intervalLevel, this.mountedDimmerSwitchLegacy.log);
                     await this.light?.setAttribute(LevelControl.Cluster.id, 'currentLevel', this.intervalLevel, this.light.log);
                     await this.lightXY?.setAttribute(LevelControl.Cluster.id, 'currentLevel', this.intervalLevel, this.lightXY.log);
                     await this.lightHS?.setAttribute(LevelControl.Cluster.id, 'currentLevel', this.intervalLevel, this.lightHS.log);

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "2.0.13-dev-20260302-e8d75fe",
+  "version": "2.0.13-dev-20260302-2a66e51",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-example-dynamic-platform",
-      "version": "2.0.13-dev-20260302-e8d75fe",
+      "version": "2.0.13-dev-20260302-2a66e51",
       "license": "Apache-2.0",
       "dependencies": {
         "node-ansi-logger": "3.2.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "2.0.13-dev-20260302-e8d75fe",
+  "version": "2.0.13-dev-20260302-2a66e51",
   "description": "Matterbridge dynamic plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",