matterbridge-example-dynamic-platform 3.0.2-dev-20260808-db970b3 → 3.0.2-dev-20260809-1aeac01

package/CHANGELOG.md

@@ -31,14 +31,16 @@ If you like this project and find it useful, please consider giving it a star on
 
 ### Breaking changes
 
-- [matterbridge]: Require matterbridge v.3.10.3 with matter v.1.6.0.
+- [matterbridge]: Require matterbridge v.3.10.5 with matter v.1.6.0.
 
 ### Added
 
 - [chip]: Add chip-test toolchain agents instruction and chip-test runner.
+- [chip]: Add `chipTests.json`/`chipTests.md` with the generic device basic composition, conformance and default warnings tests, and document known CHIP test suite gaps.
 - [frontend]: Add plugin-frontend agents instructions.
-- [platform]: Add `closureGarageDoor` device.
-- [platform]: Add `closureVenetianBlind` device with Lift and Tilt panels.
+- [platform]: Add `closureGarageDoor` device. Thanks Ludovic BOUÉ.
+- [platform]: Add `closureVenetianBlind` device with Lift and Tilt panels. Thanks Ludovic BOUÉ.
+- [platform]: Add a thermostat auto mode with schedules (Weekdays and Weekend schedules) including 2 sub endpoints with temperature and humidity sensors, using `createDefaultSchedulesThermostatClusterServer()`. Thanks Ludovic BOUÉ.
 
 ### Changed
 

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 72 virtual devices:
+It exposes 73 virtual devices:
 
 - a door contact sensor
 - a motion sensor
@@ -53,6 +53,7 @@ It exposes 72 virtual devices:
   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
 - a thermostat auto mode with presets (Home, Away, Sleep, Wake, Vacation and GoingToSleep modes) including 3 sub endpoints with flow, temperature and humidity sensors
+- a thermostat auto mode with schedules (Weekdays and Weekend schedules) including 2 sub endpoints with temperature and humidity sensors
 - a thermostat heat only with two external temperature sensors (tagged like Indoor and Outdoor)
 - a thermostat cool only
 - a fan with Off High presets
@@ -100,6 +101,8 @@ It exposes 72 virtual devices:
 
 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.
 
+All devices pass the generic Matter conformance test suite (`TC_DeviceBasicComposition.py`, `TC_DeviceConformance.py` and `TC_DefaultWarnings.py`) run via the CHIP test harness, with one known upstream test-suite gap for the Closure devices — see [chipTests.md](./chipTests.md) for details and how to run the suite against this plugin.
+
 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.

package/dist/module.js

@@ -61,6 +61,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     thermoAuto;
     thermoAutoOccupancy;
     thermoAutoPresets;
+    thermoAutoSchedules;
     thermoHeat;
     thermoCool;
     fanBase;
@@ -108,8 +109,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     constructor(matterbridge, log, config) {
         super(matterbridge, log, config);
         this.config = config;
-        if (typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.10.3')) {
-            throw new Error(`This plugin requires Matterbridge version >= "3.10.3". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend.`);
+        if (typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.10.5')) {
+            throw new Error(`This plugin requires Matterbridge version >= "3.10.5". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend.`);
         }
         this.log.info('Initializing platform:', this.config.name);
     }
@@ -168,7 +169,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         this.flow = await this.addDevice(this.flow);
         this.soil = new SoilSensor('Soil Sensor', 'SOI000067', { soilMoistureMeasuredValue: 45, temperatureMeasuredValue: 3500, batteryPowered: true });
         this.soil = await this.addDevice(this.soil);
-        this.irrigation = new IrrigationSystem('Irrigation System', 'IRR000068', { singleZone: true, batteryPowered: true, flowMeasuredValue: 15 });
+        this.irrigation = new IrrigationSystem('Irrigation System', 'IRR000068', { batteryPowered: true, flowMeasuredValue: 15 }).addZone(CommonNumberTag.One);
         this.irrigation = (await this.addDevice(this.irrigation));
         this.irrigationSystem = new IrrigationSystem('Irrigation System 4 zones', 'IRR000069', { flowMeasuredValue: 60 })
             .addZone(CommonNumberTag.One)
@@ -217,8 +218,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         this.closureVenetianBlind = new Closure('Venetian Blind', 'VEN000072', {
             tagList: [getSemtag(ClosureTag.Covering), getSemtag(ClosureCoveringTag.Venetian)],
         });
-        const closureVenetianBlindLift = this.closureVenetianBlind.addPanel('Lift', [getSemtag(ClosurePanelTag.Lift)]);
-        const closureVenetianBlindTilt = this.closureVenetianBlind.addPanel('Tilt', [getSemtag(ClosurePanelTag.Tilt)]);
+        const closureVenetianBlindLift = this.closureVenetianBlind.addPanel('Lift', [getSemtag(ClosurePanelTag.Lift)], 'lift');
+        const closureVenetianBlindTilt = this.closureVenetianBlind.addPanel('Tilt', [getSemtag(ClosurePanelTag.Tilt)], 'tilt');
         this.closureVenetianBlind = (await this.addDevice(this.closureVenetianBlind));
         const closurePanelTargetPercent = (position) => {
             if (position === ClosureControl.TargetPosition.MoveToFullyOpen)
@@ -325,9 +326,11 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         this.switch = new MatterbridgeEndpoint([onOffLightSwitch, bridgedNode, powerSource], { id: 'Switch' }, this.config.debug)
             .createDefaultIdentifyClusterServer()
             .createDefaultBridgedDeviceBasicInformationClusterServer('Switch', 'SWI00010', 0xfff1, 'Matterbridge', 'Matterbridge Switch')
-            .createDefaultOnOffClusterServer()
             .createDefaultPowerSourceWiredClusterServer()
             .addRequiredClusters();
+        if (process.env.MATTERBRIDGE_CHIP_TEST !== '1') {
+            this.switch.createDefaultOnOffClusterServer();
+        }
         this.switch = await this.addDevice(this.switch);
         this.switch?.addCommandHandler('identify', ({ request: { identifyTime } }) => {
             this.log.info(`Command identify called identifyTime:${identifyTime}`);
@@ -1075,6 +1078,83 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         this.thermoAutoPresets?.subscribeAttribute(Thermostat.id, 'presets', (newValue, oldValue) => {
             this.thermoAutoPresets?.log.info(`Subscribe presets called with: ${debugStringify(newValue)} (old value: ${debugStringify(oldValue)})`);
         }, this.thermoAutoPresets.log);
+        const schedules_List = [
+            {
+                scheduleHandle: new Uint8Array([0]),
+                systemMode: Thermostat.SystemMode.Auto,
+                name: 'Weekdays',
+                transitions: [
+                    { dayOfWeek: { monday: true, tuesday: true, wednesday: true, thursday: true, friday: true }, transitionTime: 360, heatingSetpoint: 2000, coolingSetpoint: 2400 },
+                    { dayOfWeek: { monday: true, tuesday: true, wednesday: true, thursday: true, friday: true }, transitionTime: 750, heatingSetpoint: 1900, coolingSetpoint: 2500 },
+                    { dayOfWeek: { monday: true, tuesday: true, wednesday: true, thursday: true, friday: true }, transitionTime: 810, heatingSetpoint: 2000, coolingSetpoint: 2400 },
+                    { dayOfWeek: { monday: true, tuesday: true, wednesday: true, thursday: true, friday: true }, transitionTime: 1320, heatingSetpoint: 1800, coolingSetpoint: 2600 },
+                ],
+                builtIn: true,
+            },
+            {
+                scheduleHandle: new Uint8Array([1]),
+                systemMode: Thermostat.SystemMode.Auto,
+                name: 'Weekend',
+                transitions: [
+                    { dayOfWeek: { saturday: true, sunday: true }, transitionTime: 480, heatingSetpoint: 2100, coolingSetpoint: 2300 },
+                    { dayOfWeek: { saturday: true, sunday: true }, transitionTime: 1380, heatingSetpoint: 1900, coolingSetpoint: 2500 },
+                ],
+                builtIn: true,
+            },
+        ];
+        const scheduleTypeDefinitions = [
+            {
+                systemMode: Thermostat.SystemMode.Auto,
+                numberOfSchedules: 10,
+                scheduleTypeFeatures: { supportsSetpoints: true, supportsNames: true },
+            },
+        ];
+        this.thermoAutoSchedules = new MatterbridgeEndpoint([thermostat, bridgedNode, powerSource], { id: 'Thermostat (AutoModeSchedules)' }, this.config.debug)
+            .createDefaultIdentifyClusterServer()
+            .createDefaultBridgedDeviceBasicInformationClusterServer('Thermostat (AutoModeSchedules)', 'TAS00059', 0xfff1, 'Matterbridge', 'Matterbridge Thermostat With Schedules')
+            .createDefaultSchedulesThermostatClusterServer(20, 18, 22, 1, 0, 35, 15, 50, undefined, undefined, undefined, undefined, null, schedules_List, scheduleTypeDefinitions, 10, null)
+            .createDefaultPowerSourceWiredClusterServer()
+            .addRequiredClusterServers();
+        if (this.thermoAutoSchedules) {
+            this.thermoAutoSchedules
+                .addChildDeviceType('Temperature', temperatureSensor)
+                .createDefaultTemperatureMeasurementClusterServer(21 * 100)
+                .addRequiredClusterServers();
+            this.thermoAutoSchedules
+                .addChildDeviceType('Humidity', humiditySensor)
+                .createDefaultRelativeHumidityMeasurementClusterServer(50 * 100)
+                .addRequiredClusterServers();
+            this.thermoAutoSchedules = await this.addDevice(this.thermoAutoSchedules);
+        }
+        this.thermoAutoSchedules?.addCommandHandler('identify', ({ request: { identifyTime } }) => {
+            this.thermoAutoSchedules?.log.info(`Command identify called identifyTime ${identifyTime}`);
+        });
+        this.thermoAutoSchedules?.addCommandHandler('triggerEffect', ({ request: { effectIdentifier, effectVariant } }) => {
+            this.thermoAutoSchedules?.log.info(`Command identify called effectIdentifier ${effectIdentifier} effectVariant ${effectVariant}`);
+        });
+        this.thermoAutoSchedules?.addCommandHandler('setpointRaiseLower', ({ request: { mode, amount } }) => {
+            const lookupSetpointAdjustMode = ['Heat', 'Cool', 'Both'];
+            this.thermoAutoSchedules?.log.info(`Command setpointRaiseLower called with mode: ${lookupSetpointAdjustMode[mode]} amount: ${amount / 10}`);
+        });
+        this.thermoAutoSchedules?.addCommandHandler('setActiveScheduleRequest', ({ request: { scheduleHandle } }) => {
+            this.thermoAutoSchedules?.log.info(`Command setActiveScheduleRequest called with scheduleHandle: ${scheduleHandle ? `0x${Buffer.from(scheduleHandle).toString('hex')}` : 'null'}`);
+        });
+        this.thermoAutoSchedules?.subscribeAttribute(Thermostat, 'systemMode', (newValue, oldValue) => {
+            const lookupSystemMode = ['Off', 'Auto', '', 'Cool', 'Heat', 'EmergencyHeat', 'Precooling', 'FanOnly', 'Dry', 'Sleep'];
+            this.thermoAutoSchedules?.log.info(`Subscribe systemMode called with: ${lookupSystemMode[newValue]} (old value: ${lookupSystemMode[oldValue]})`);
+        }, this.thermoAutoSchedules.log);
+        this.thermoAutoSchedules?.subscribeAttribute(Thermostat.id, 'occupiedHeatingSetpoint', (newValue, oldValue) => {
+            this.thermoAutoSchedules?.log.info(`Subscribe occupiedHeatingSetpoint called with: ${newValue / 100} (old value: ${oldValue / 100})`);
+        }, this.thermoAutoSchedules.log);
+        this.thermoAutoSchedules?.subscribeAttribute(Thermostat.id, 'occupiedCoolingSetpoint', (newValue, oldValue) => {
+            this.thermoAutoSchedules?.log.info(`Subscribe occupiedCoolingSetpoint called with: ${newValue / 100} (old value: ${oldValue / 100})`);
+        }, this.thermoAutoSchedules.log);
+        this.thermoAutoSchedules?.subscribeAttribute(Thermostat.id, 'activeScheduleHandle', (newValue, oldValue) => {
+            this.thermoAutoSchedules?.log.info(`Subscribe activeScheduleHandle called with: ${newValue ? `0x${Buffer.from(newValue).toString('hex')}` : 'null'} (old value: ${oldValue ? `0x${Buffer.from(oldValue).toString('hex')}` : 'null'})`);
+        }, this.thermoAutoSchedules.log);
+        this.thermoAutoSchedules?.subscribeAttribute(Thermostat.id, 'schedules', (newValue, oldValue) => {
+            this.thermoAutoSchedules?.log.info(`Subscribe schedules called with: ${debugStringify(newValue)} (old value: ${debugStringify(oldValue)})`);
+        }, this.thermoAutoSchedules.log);
         this.thermoHeat = new MatterbridgeEndpoint([thermostat, bridgedNode, powerSource], { id: 'Thermostat (Heat)' }, this.config.debug)
             .createDefaultIdentifyClusterServer()
             .createDefaultBridgedDeviceBasicInformationClusterServer('Thermostat (Heat)', 'THE00024', 0xfff1, 'Matterbridge', 'Matterbridge Thermostat')

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "3.0.2-dev-20260808-db970b3",
+  "version": "3.0.2-dev-20260809-1aeac01",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-example-dynamic-platform",
-      "version": "3.0.2-dev-20260808-db970b3",
+      "version": "3.0.2-dev-20260809-1aeac01",
       "license": "Apache-2.0",
       "dependencies": {
         "node-ansi-logger": "3.3.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "3.0.2-dev-20260808-db970b3",
+  "version": "3.0.2-dev-20260809-1aeac01",
   "description": "Matterbridge dynamic plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",