matterbridge-example-dynamic-platform 3.0.4-dev-20260901-796d818 → 3.0.4-dev-20260902-044750d

package/CHANGELOG.md

@@ -46,6 +46,7 @@ If you like this project and find it useful, please consider giving it a star on
 
 ### Added
 
+- [platform]: Add `ScheduleLock` device: a door lock with the User, PinCredential, and optional WeekDayAccessSchedules, YearDayAccessSchedules, and HolidaySchedules features.
 - [platform]: Add `closureSlidingGate` device with pedestrian opening support. Thanks Ludovic BOUÉ.
 - [platform]: Add `closureRoofWindow` device with ventilation opening support. Thanks Ludovic BOUÉ.
 - [devcontainer]: Upgrade the `Dev Container` to v.2.0.0, using the Node.js and Bun stack.

package/README.md

@@ -23,7 +23,7 @@
 
 Matterbridge dynamic platform example plugin is a template to develop your own plugin using the dynamic platform.
 
-It exposes 76 virtual devices:
+It exposes 77 virtual devices:
 
 - a door contact sensor
 - a motion sensor
@@ -49,6 +49,8 @@ It exposes 76 virtual devices:
 - a cover with windowCovering cluster and lift feature
 - a cover with windowCovering cluster and both lift and tilt features
 - a lock with doorLock cluster
+- a lock with doorLock cluster and User and PinCredential support (userPinLock)
+- a lock with doorLock cluster, User and PinCredential support, and WeekDay, YearDay and Holiday access schedules (scheduleLock)
 - a thermostat auto mode (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 thermostat with auto mode (i.e. with Auto Heat and Cool features), occupancy and outdoorTemperature

package/dist/module.js

@@ -45,6 +45,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     coverLiftTilt;
     lock;
     userPinLock;
+    scheduleLock;
     thermoAuto;
     thermoAutoOccupancy;
     thermoAutoPresets;
@@ -858,6 +859,34 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         this.userPinLock?.subscribeAttribute(DoorLock, 'userCodeTemporaryDisableTime', (value) => {
             this.userPinLock?.log.info(`Subscribe userCodeTemporaryDisableTime called with: ${value}`);
         }, this.userPinLock.log);
+        this.scheduleLock = new MatterbridgeEndpoint([doorLock, bridgedNode, powerSource], { id: 'ScheduleLock' }, this.config.debug)
+            .createDefaultIdentifyClusterServer()
+            .createDefaultBridgedDeviceBasicInformationClusterServer('Lock with Schedules', 'LSC00080', 0xfff1, 'Matterbridge', 'Matterbridge Lock')
+            .createUserPinDoorLockClusterServer(DoorLock.LockState.Locked, DoorLock.LockType.DeadBolt, 0, 4, 10, 2, 3, 4)
+            .createDefaultPowerSourceRechargeableBatteryClusterServer(95)
+            .addRequiredClusterServers();
+        this.scheduleLock = await this.addDevice(this.scheduleLock);
+        this.scheduleLock?.addCommandHandler('Identify.identify', ({ request: { identifyTime } }) => {
+            this.scheduleLock?.log.info(`Command identify called identifyTime:${identifyTime}`);
+        });
+        this.scheduleLock?.addCommandHandler('DoorLock.lockDoor', () => {
+            this.scheduleLock?.log.info('Command lockDoor called');
+        });
+        this.scheduleLock?.addCommandHandler('DoorLock.unlockDoor', () => {
+            this.scheduleLock?.log.info('Command unlockDoor called');
+        });
+        this.scheduleLock?.addCommandHandler('DoorLock.setWeekDaySchedule', ({ request: { weekDayIndex, userIndex } }) => {
+            this.scheduleLock?.log.info(`Command setWeekDaySchedule called for weekDayIndex:${weekDayIndex} userIndex:${userIndex}`);
+        });
+        this.scheduleLock?.addCommandHandler('DoorLock.setYearDaySchedule', ({ request: { yearDayIndex, userIndex } }) => {
+            this.scheduleLock?.log.info(`Command setYearDaySchedule called for yearDayIndex:${yearDayIndex} userIndex:${userIndex}`);
+        });
+        this.scheduleLock?.addCommandHandler('DoorLock.setHolidaySchedule', ({ request: { holidayIndex } }) => {
+            this.scheduleLock?.log.info(`Command setHolidaySchedule called for holidayIndex:${holidayIndex}`);
+        });
+        this.scheduleLock?.subscribeAttribute(DoorLock, 'operatingMode', (value) => {
+            this.scheduleLock?.log.info(`Subscribe operatingMode called with: ${getEnumDescription(DoorLock.OperatingMode, value)}`);
+        }, this.scheduleLock.log);
         this.thermoAuto = new MatterbridgeEndpoint([thermostat, bridgedNode, powerSource], { id: 'Thermostat (AutoMode)' }, this.config.debug)
             .createDefaultIdentifyClusterServer()
             .createDefaultBridgedDeviceBasicInformationClusterServer('Thermostat (Auto)', 'TAU00023', 0xfff1, 'Matterbridge', 'Matterbridge Thermostat')
@@ -2344,6 +2373,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
                 }
             }, 60 * 1000 + 500);
         }
+        await this.scheduleLock?.setAttribute(DoorLock.id, 'lockState', DoorLock.LockState.Locked, this.scheduleLock.log);
+        this.scheduleLock?.log.info('Set schedule lock initial lockState to Locked');
         await this.thermoAuto?.setAttribute(Thermostat.id, 'localTemperature', 16 * 100, this.thermoAuto.log);
         await this.thermoAuto?.setAttribute(Thermostat.id, 'systemMode', Thermostat.SystemMode.Auto, this.thermoAuto.log);
         if (this.thermoAuto?.hasAttributeServer(Thermostat.id, 'thermostatRunningState')) {

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "3.0.4-dev-20260901-796d818",
+  "version": "3.0.4-dev-20260902-044750d",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-example-dynamic-platform",
-      "version": "3.0.4-dev-20260901-796d818",
+      "version": "3.0.4-dev-20260902-044750d",
       "license": "Apache-2.0",
       "dependencies": {
         "node-ansi-logger": "3.3.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "3.0.4-dev-20260901-796d818",
+  "version": "3.0.4-dev-20260902-044750d",
   "description": "Matterbridge dynamic plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",