matterbridge-example-dynamic-platform 2.0.14 → 2.0.15

package/CHANGELOG.md

@@ -26,6 +26,29 @@ If you like this project and find it useful, please consider giving it a star on
 
 <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="120"></a>
 
+## [2.0.15] - 2026-04-08
+
+### Added
+
+- [DoorLock]: Add a doorLock device with User and Pin features.
+- [Fan]: Implement Auto >>> percentSetting = null rule. Thanks Ludovic BOUÉ (https://github.com/Luligu/matterbridge-example-dynamic-platform/issues/54).
+
+### Changed
+
+- [package]: Bump package to `automator` v.3.1.5.
+- [package]: Bump `eslint` to v.10.2.0.
+- [package]: Bump `typescript` to v.6.0.2.
+- [package]: Bump `typescript-eslint` to v.8.58.1.
+- [devcontainer]: Fix pull of new image.
+- [devcontainer]: Update VS Code settings.
+- [devcontainer]: Leave matterbridge scripts in the cloned repo.
+- [scripts]: Update mb-run script.
+- [scripts]: Update package watch script.
+- [scripts]: Add prune-releases script.
+- [package]: Add `CODE_OF_CONDUCT.md`.
+
+<a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
+
 ## [2.0.14] - 2026-03-20
 
 ### Changed

package/README.md

@@ -24,7 +24,7 @@
 
 Matterbridge dynamic platform example plugin is a template to develop your own plugin using the dynamic platform.
 
-It exposes 68 virtual devices:
+It exposes 70 virtual devices:
 
 - a door contact sensor
 - a motion sensor
@@ -95,6 +95,7 @@ It exposes 68 virtual devices:
 - a speaker device (supported by SmartThings)
 - a soil sensor (Matter 1.5.0)
 - an irrigation system (Matter 1.5.0)
+- an irrigation system with four zones (Matter 1.5.0)
 
 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.
 

package/dist/module.js

@@ -3,7 +3,7 @@ import { AirConditioner, BasicVideoPlayer, BatteryStorage, Cooktop, Dishwasher,
 import { debugStringify } from 'matterbridge/logger';
 import { AreaNamespaceTag, LocationTag, NumberTag, PositionTag, RefrigeratorTag, SwitchesTag, UINT16_MAX, UINT32_MAX } from 'matterbridge/matter';
 import { AirQuality, BooleanState, BridgedDeviceBasicInformation, CarbonDioxideConcentrationMeasurement, CarbonMonoxideConcentrationMeasurement, ColorControl, Descriptor, DeviceEnergyManagement, DoorLock, ElectricalEnergyMeasurement, ElectricalPowerMeasurement, EnergyEvse, EnergyEvseMode, FanControl, FlowMeasurement, FormaldehydeConcentrationMeasurement, Identify, IlluminanceMeasurement, LevelControl, NitrogenDioxideConcentrationMeasurement, OccupancySensing, OnOff, OnOffCluster, OperationalState, OvenMode, OzoneConcentrationMeasurement, Pm1ConcentrationMeasurement, Pm10ConcentrationMeasurement, Pm25ConcentrationMeasurement, PowerSource, PressureMeasurement, RadonConcentrationMeasurement, RelativeHumidityMeasurement, RelativeHumidityMeasurementCluster, RvcCleanMode, RvcOperationalState, RvcRunMode, SmokeCoAlarm, TemperatureMeasurement, Thermostat, ThermostatCluster, TotalVolatileOrganicCompoundsConcentrationMeasurement, WindowCovering, } from 'matterbridge/matter/clusters';
-import { isValidBoolean, isValidNumber, isValidObject, isValidString } from 'matterbridge/utils';
+import { getEnumDescription, isValidBoolean, isValidNumber, isValidObject, isValidString } from 'matterbridge/utils';
 function luxToMatter(lux) {
     if (!Number.isFinite(lux) || lux <= 0)
         return 0;
@@ -55,6 +55,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     coverLift;
     coverLiftTilt;
     lock;
+    userPinLock;
     thermoAuto;
     thermoAutoOccupancy;
     thermoAutoPresets;
@@ -105,8 +106,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     constructor(matterbridge, log, config) {
         super(matterbridge, log, config);
         this.config = config;
-        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.7.0')) {
-            throw new Error(`This plugin requires Matterbridge version >= "3.7.0". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend.`);
+        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.7.2')) {
+            throw new Error(`This plugin requires Matterbridge version >= "3.7.2". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend.`);
         }
         this.log.info('Initializing platform:', this.config.name);
     }
@@ -700,22 +701,44 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             .createDefaultPowerSourceRechargeableBatteryClusterServer(30)
             .addRequiredClusterServers();
         this.lock = await this.addDevice(this.lock);
-        this.lock?.addCommandHandler('identify', async ({ request: { identifyTime } }) => {
+        this.lock?.addCommandHandler('Identify.identify', async ({ request: { identifyTime } }) => {
             this.lock?.log.info(`Command identify called identifyTime:${identifyTime}`);
         });
-        this.lock?.addCommandHandler('lockDoor', async () => {
+        this.lock?.addCommandHandler('DoorLock.lockDoor', async () => {
             this.lock?.log.info('Command lockDoor called');
         });
-        this.lock?.addCommandHandler('unlockDoor', async () => {
+        this.lock?.addCommandHandler('DoorLock.unlockDoor', async () => {
             this.lock?.log.info('Command unlockDoor called');
         });
         await this.lock?.subscribeAttribute(DoorLock.Cluster.id, 'operatingMode', (value) => {
-            const lookupOperatingMode = ['Normal', 'Vacation', 'Privacy', 'NoRemoteLockUnlock', 'Passage'];
-            this.lock?.log.info('Subscribe operatingMode called with:', lookupOperatingMode[value]);
-            const actuatorEnabled = value !== DoorLock.OperatingMode.NoRemoteLockUnlock;
-            this.lock?.setAttribute(DoorLock.Cluster.id, 'actuatorEnabled', actuatorEnabled);
-            this.lock?.log.info(`actuatorEnabled set to ${actuatorEnabled}`);
+            this.lock?.log.info(`Subscribe operatingMode called with: ${getEnumDescription(DoorLock.OperatingMode, value)}`);
         }, this.lock.log);
+        this.userPinLock = new MatterbridgeEndpoint([doorLockDevice, bridgedNode, powerSource], { id: 'UserPinLock' }, this.config.debug)
+            .createDefaultIdentifyClusterServer()
+            .createDefaultBridgedDeviceBasicInformationClusterServer('Lock with User and Pin', 'LUP00070', 0xfff1, 'Matterbridge', 'Matterbridge Lock')
+            .createUserPinDoorLockClusterServer()
+            .createDefaultPowerSourceRechargeableBatteryClusterServer(95)
+            .addRequiredClusterServers();
+        this.userPinLock = await this.addDevice(this.userPinLock);
+        await this.userPinLock?.setAttribute(PowerSource.Cluster.with(PowerSource.Feature.Rechargeable, PowerSource.Feature.Battery), 'batChargeState', PowerSource.BatChargeState.IsCharging);
+        this.userPinLock?.addCommandHandler('Identify.identify', async ({ request: { identifyTime } }) => {
+            this.userPinLock?.log.info(`Command identify called identifyTime:${identifyTime}`);
+        });
+        this.userPinLock?.addCommandHandler('DoorLock.lockDoor', async () => {
+            this.userPinLock?.log.info('Command lockDoor called');
+        });
+        this.userPinLock?.addCommandHandler('DoorLock.unlockDoor', async () => {
+            this.userPinLock?.log.info('Command unlockDoor called');
+        });
+        await this.userPinLock?.subscribeAttribute(DoorLock.Cluster, 'operatingMode', (value) => {
+            this.userPinLock?.log.info(`Subscribe operatingMode called with: ${getEnumDescription(DoorLock.OperatingMode, value)}`);
+        }, this.userPinLock.log);
+        await this.userPinLock?.subscribeAttribute(DoorLock.Complete, 'wrongCodeEntryLimit', (value) => {
+            this.userPinLock?.log.info(`Subscribe wrongCodeEntryLimit called with: ${value}`);
+        }, this.userPinLock.log);
+        await this.userPinLock?.subscribeAttribute(DoorLock.Complete, 'userCodeTemporaryDisableTime', (value) => {
+            this.userPinLock?.log.info(`Subscribe userCodeTemporaryDisableTime called with: ${value}`);
+        }, this.userPinLock.log);
         this.thermoAuto = new MatterbridgeEndpoint([thermostatDevice, bridgedNode, powerSource], { id: 'Thermostat (AutoMode)' }, this.config.debug)
             .createDefaultIdentifyClusterServer()
             .createDefaultBridgedDeviceBasicInformationClusterServer('Thermostat (Auto)', 'TAU00023', 0xfff1, 'Matterbridge', 'Matterbridge Thermostat')
@@ -1093,11 +1116,12 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
                 this.fanDefault?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 100, this.fanDefault?.log);
             }
             else if (newValue === FanControl.FanMode.On) {
+                this.fanDefault?.setAttribute(FanControl.Cluster.id, 'fanMode', FanControl.FanMode.High, this.fanDefault?.log);
                 this.fanDefault?.setAttribute(FanControl.Cluster.id, 'percentSetting', 100, this.fanDefault?.log);
                 this.fanDefault?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 100, this.fanDefault?.log);
             }
             else if (newValue === FanControl.FanMode.Auto) {
-                this.fanDefault?.setAttribute(FanControl.Cluster.id, 'percentSetting', 50, this.fanDefault?.log);
+                this.fanDefault?.setAttribute(FanControl.Cluster.id, 'percentSetting', null, this.fanDefault?.log);
                 this.fanDefault?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 50, this.fanDefault?.log);
             }
         }, this.fanDefault.log);
@@ -1135,11 +1159,12 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
                 this.fanBase?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 100, this.fanBase?.log);
             }
             else if (newValue === FanControl.FanMode.On) {
+                this.fanBase?.setAttribute(FanControl.Cluster.id, 'fanMode', FanControl.FanMode.High, this.fanBase?.log);
                 this.fanBase?.setAttribute(FanControl.Cluster.id, 'percentSetting', 100, this.fanBase?.log);
                 this.fanBase?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 100, this.fanBase?.log);
             }
             else if (newValue === FanControl.FanMode.Auto) {
-                this.fanBase?.setAttribute(FanControl.Cluster.id, 'percentSetting', 50, this.fanBase?.log);
+                this.fanBase?.setAttribute(FanControl.Cluster.id, 'percentSetting', null, this.fanBase?.log);
                 this.fanBase?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 50, this.fanBase?.log);
             }
         }, this.fanBase.log);
@@ -1168,6 +1193,11 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
                 this.fanOnHigh?.setAttribute(FanControl.Cluster.id, 'percentSetting', 100, this.fanOnHigh?.log);
                 this.fanOnHigh?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 100, this.fanOnHigh?.log);
             }
+            else if (newValue === FanControl.FanMode.On) {
+                this.fanBase?.setAttribute(FanControl.Cluster.id, 'fanMode', FanControl.FanMode.High, this.fanBase?.log);
+                this.fanBase?.setAttribute(FanControl.Cluster.id, 'percentSetting', 100, this.fanBase?.log);
+                this.fanBase?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 100, this.fanBase?.log);
+            }
         }, this.fanOnHigh.log);
         await this.fanOnHigh?.subscribeAttribute(FanControl.Cluster.id, 'percentSetting', (newValue, oldValue, context) => {
             this.fanOnHigh?.log.info(`Percent setting changed from ${oldValue} to ${newValue} context: ${context.offline === true ? 'offline' : 'online'}`);
@@ -1207,11 +1237,12 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
                 this.fanComplete?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 100, this.fanComplete?.log);
             }
             else if (newValue === FanControl.FanMode.On) {
+                this.fanComplete?.setAttribute(FanControl.Cluster.id, 'fanMode', FanControl.FanMode.High, this.fanComplete?.log);
                 this.fanComplete?.setAttribute(FanControl.Cluster.id, 'percentSetting', 100, this.fanComplete?.log);
                 this.fanComplete?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 100, this.fanComplete?.log);
             }
             else if (newValue === FanControl.FanMode.Auto) {
-                this.fanComplete?.setAttribute(FanControl.Cluster.id, 'percentSetting', 50, this.fanComplete?.log);
+                this.fanComplete?.setAttribute(FanControl.Cluster.id, 'percentSetting', null, this.fanComplete?.log);
                 this.fanComplete?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 50, this.fanComplete?.log);
             }
         }, this.fanComplete?.log);

package/matterbridge-example-dynamic-platform.schema.json

@@ -5,13 +5,13 @@
   "required": [],
   "properties": {
     "name": {
-      "description": "Plugin name",
+      "description": "Plugin Name",
       "type": "string",
       "readOnly": true,
       "ui:widget": "hidden"
     },
     "type": {
-      "description": "Plugin type",
+      "description": "Plugin Type",
       "type": "string",
       "readOnly": true,
       "ui:widget": "hidden"
@@ -49,13 +49,13 @@
       "default": true
     },
     "debug": {
-      "title": "Debug",
+      "title": "Enable Debug",
       "description": "Enable the debug for the plugin (development only)",
       "type": "boolean",
       "default": false
     },
     "unregisterOnShutdown": {
-      "title": "Unregister on Shutdown",
+      "title": "Unregister On Shutdown",
       "description": "Unregister all devices on shutdown (development only)",
       "type": "boolean",
       "default": false

package/npm-shrinkwrap.json

@@ -1,19 +1,19 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "2.0.14",
+  "version": "2.0.15",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-example-dynamic-platform",
-      "version": "2.0.14",
+      "version": "2.0.15",
       "license": "Apache-2.0",
       "dependencies": {
         "node-ansi-logger": "3.2.0",
         "node-persist-manager": "2.0.1"
       },
       "engines": {
-        "node": ">=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
+        "node": ">=20.19.0 <21.0.0 || >=22.13.0 <23.0.0 || >=24.0.0 <25.0.0"
       },
       "funding": {
         "type": "buymeacoffee",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "2.0.14",
+  "version": "2.0.15",
   "description": "Matterbridge dynamic plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",
@@ -56,7 +56,7 @@
     "ewelink"
   ],
   "engines": {
-    "node": ">=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
+    "node": ">=20.19.0 <21.0.0 || >=22.13.0 <23.0.0 || >=24.0.0 <25.0.0"
   },
   "files": [
     "bin",
@@ -71,7 +71,7 @@
     "node-persist-manager": "2.0.1"
   },
   "overrides": {
-    "eslint": "10.1.0",
+    "eslint": "10.2.0",
     "@eslint/js": "10.0.1"
   }
 }