matterbridge-example-dynamic-platform 1.3.12 → 1.3.13-dev-20250925-7d317a9

package/CHANGELOG.md

@@ -23,6 +23,24 @@ If you like this project and find it useful, please consider giving it a star on
   <img src="bmc-button.svg" alt="Buy me a coffee" width="120">
 </a>
 
+## [1.3.13] - 2025-09-??
+
+### Added
+
+- [jest]: Added jest helper module v. 1.0.6.
+- [platform]: Added a thermostat with auto mode and occupancy and outdoorTemperature.
+
+### Changed
+
+- [package]: Updated dependencies.
+- [workflows]: Ignore any .md anywhere in all workflows.
+- [package]: Updated to Automator v. 2.0.7.
+- [package]: Required matterbridge 3.2.9.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
 ## [1.3.12] - 2025-09-14
 
 ### Added

package/README.md

@@ -17,7 +17,7 @@
 
 Matterbridge dynamic platform example plugin is a template to develop your own plugin using the dynamic platform.
 
-It exposes 56 virtual devices:
+It exposes 58 virtual devices:
 
 - a door contact sensor
 - a motion sensor
@@ -39,10 +39,11 @@ It exposes 56 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 thermo autoMode (i.e. with Auto Heat and Cool features) with thermostat cluster and 3 sub endpoints with flowMeasurement cluster, temperatureMeasurement cluster
+- 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 thermo heat only with two external temperature sensors (tagged like Indoor and Outdoor)
-- a thermo cool only
+- a thermostat with auto mode (i.e. with Auto Heat and Cool features), occupancy and outdoorTemperature
+- a thermostat heat only with two external temperature sensors (tagged like Indoor and Outdoor)
+- a thermostat cool only
 - a fan with Off High presets
 - a fan with Off Low Med High presets
 - a fan with Off Low Med High Auto presets and step

package/dist/jestHelpers.js

@@ -164,7 +164,7 @@ export async function startServerNode(name, port) {
     expect(aggregator.lifecycle.isPartsReady).toBeTruthy();
     expect(aggregator.lifecycle.hasId).toBeTruthy();
     expect(aggregator.lifecycle.hasNumber).toBeTruthy();
-    await flushAsync();
+    await flushAsync(undefined, undefined, 200);
     return [server, aggregator];
 }
 export async function stopServerNode(server) {
@@ -177,7 +177,7 @@ export async function stopServerNode(server) {
     expect(server.lifecycle.isReady).toBeTruthy();
     expect(server.lifecycle.isOnline).toBeFalsy();
     await server.env.get(MdnsService)[Symbol.asyncDispose]();
-    await flushAsync();
+    await flushAsync(undefined, undefined, 200);
 }
 export async function addDevice(owner, device, pause = 10) {
     expect(owner).toBeDefined();

package/dist/platform.js

@@ -43,6 +43,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     coverLiftTilt;
     lock;
     thermoAuto;
+    thermoAutoOccupancy;
     thermoHeat;
     thermoCool;
     fanBase;
@@ -104,8 +105,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     fanDirectionLookup = ['Forward', 'Reverse'];
     constructor(matterbridge, log, config) {
         super(matterbridge, log, config);
-        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.2.6')) {
-            throw new Error(`This plugin requires Matterbridge version >= "3.2.6". 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.2.9')) {
+            throw new Error(`This plugin requires Matterbridge version >= "3.2.9". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend.`);
         }
         this.log.info('Initializing platform:', this.config.name);
         if (config.whiteList === undefined)
@@ -286,7 +287,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         this.dimmer?.addCommandHandler('moveToLevelWithOnOff', async ({ request: { level } }) => {
             this.dimmer?.log.debug(`Command moveToLevelWithOnOff called request: ${level}`);
         });
-        this.light = new MatterbridgeEndpoint([extendedColorLight, bridgedNode, powerSource], { uniqueStorageKey: 'Light (XY, HS and CT)' }, this.config.debug)
+        this.light = new MatterbridgeEndpoint([extendedColorLight, bridgedNode, powerSource], { uniqueStorageKey: 'Light (XY, HS, CT)' }, this.config.debug)
             .createDefaultIdentifyClusterServer()
             .createDefaultGroupsClusterServer()
             .createDefaultBridgedDeviceBasicInformationClusterServer('Light (XY, HS and CT)', 'LXC00015', 0xfff1, 'Matterbridge', 'Matterbridge Light')
@@ -509,7 +510,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         this.thermoAuto = new MatterbridgeEndpoint([thermostatDevice, bridgedNode, powerSource], { uniqueStorageKey: 'Thermostat (AutoMode)' }, this.config.debug)
             .createDefaultIdentifyClusterServer()
             .createDefaultGroupsClusterServer()
-            .createDefaultBridgedDeviceBasicInformationClusterServer('Thermostat (AutoMode)', 'TAU00023', 0xfff1, 'Matterbridge', 'Matterbridge Thermostat')
+            .createDefaultBridgedDeviceBasicInformationClusterServer('Thermostat (Auto)', 'TAU00023', 0xfff1, 'Matterbridge', 'Matterbridge Thermostat')
             .createDefaultThermostatClusterServer(20, 18, 22)
             .createDefaultPowerSourceRechargeableBatteryClusterServer(70, PowerSource.BatChargeLevel.Ok, 4700);
         this.thermoAuto
@@ -545,6 +546,29 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         await this.thermoAuto?.subscribeAttribute(ThermostatCluster.id, 'occupiedCoolingSetpoint', (value) => {
             this.thermoAuto?.log.info('Subscribe occupiedCoolingSetpoint called with:', value / 100);
         }, this.thermoAuto.log);
+        this.thermoAutoOccupancy = new MatterbridgeEndpoint([thermostatDevice, bridgedNode, powerSource], { uniqueStorageKey: 'Thermostat (AutoModeOccupancy)' }, this.config.debug)
+            .createDefaultIdentifyClusterServer()
+            .createDefaultGroupsClusterServer()
+            .createDefaultBridgedDeviceBasicInformationClusterServer('Thermostat (AutoOccupancy)', 'TAO00058', 0xfff1, 'Matterbridge', 'Matterbridge Thermostat')
+            .createDefaultThermostatClusterServer(20, 18, 22, 1, 0, 35, 15, 50, 10, 30, false, 20.5)
+            .createDefaultPowerSourceWiredClusterServer();
+        this.thermoAutoOccupancy = await this.addDevice(this.thermoAutoOccupancy);
+        await this.thermoAutoOccupancy?.subscribeAttribute(ThermostatCluster.id, 'systemMode', (value) => {
+            const lookupSystemMode = ['Off', 'Auto', '', 'Cool', 'Heat', 'EmergencyHeat', 'Precooling', 'FanOnly', 'Dry', 'Sleep'];
+            this.thermoAutoOccupancy?.log.info('Subscribe systemMode called with:', lookupSystemMode[value]);
+        }, this.thermoAutoOccupancy.log);
+        await this.thermoAutoOccupancy?.subscribeAttribute(ThermostatCluster.id, 'occupiedHeatingSetpoint', (value) => {
+            this.thermoAutoOccupancy?.log.info('Subscribe occupiedHeatingSetpoint called with:', value / 100);
+        }, this.thermoAutoOccupancy.log);
+        await this.thermoAutoOccupancy?.subscribeAttribute(ThermostatCluster.id, 'occupiedCoolingSetpoint', (value) => {
+            this.thermoAutoOccupancy?.log.info('Subscribe occupiedCoolingSetpoint called with:', value / 100);
+        }, this.thermoAutoOccupancy.log);
+        await this.thermoAutoOccupancy?.subscribeAttribute(ThermostatCluster.id, 'unoccupiedHeatingSetpoint', (value) => {
+            this.thermoAutoOccupancy?.log.info('Subscribe unoccupiedHeatingSetpoint called with:', value / 100);
+        }, this.thermoAutoOccupancy.log);
+        await this.thermoAutoOccupancy?.subscribeAttribute(ThermostatCluster.id, 'unoccupiedCoolingSetpoint', (value) => {
+            this.thermoAutoOccupancy?.log.info('Subscribe unoccupiedCoolingSetpoint called with:', value / 100);
+        }, this.thermoAutoOccupancy.log);
         this.thermoHeat = new MatterbridgeEndpoint([thermostatDevice, bridgedNode, powerSource], { uniqueStorageKey: 'Thermostat (Heat)' }, this.config.debug)
             .createDefaultIdentifyClusterServer()
             .createDefaultGroupsClusterServer()
@@ -1558,6 +1582,9 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         const flow = this.thermoAuto?.getChildEndpointByName('Flow');
         await flow?.setAttribute(FlowMeasurement.Cluster.id, 'measuredValue', 10, this.thermoAuto?.log);
         this.thermoAuto?.log.info('Set thermostat ext temperature to 16°C, ext humidity to 50% and ext valve flow to 10');
+        await this.thermoAutoOccupancy?.setAttribute(ThermostatCluster.id, 'occupancy', { occupied: true }, this.thermoAutoOccupancy.log);
+        await this.thermoAutoOccupancy?.setAttribute(ThermostatCluster.id, 'systemMode', Thermostat.SystemMode.Auto, this.thermoAutoOccupancy.log);
+        this.thermoAutoOccupancy?.log.info('Set thermostat occupancy to true and mode Auto');
         if (this.config.useInterval) {
             this.thermoInterval = setInterval(async () => {
                 let temperature = this.thermoAuto?.getAttribute(ThermostatCluster.id, 'localTemperature', this.thermoAuto.log);
@@ -1580,6 +1607,18 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
                     this.thermoHeat?.log.info(`Set thermostat localTemperature to ${temperature / 100}°C`);
                     this.thermoCool?.log.info(`Set thermostat localTemperature to ${temperature / 100}°C`);
                 }
+                let temperatureOccupancy = this.thermoAutoOccupancy?.getAttribute(ThermostatCluster.id, 'localTemperature', this.thermoAutoOccupancy.log);
+                if (isValidNumber(temperatureOccupancy, 1600, 2400)) {
+                    temperatureOccupancy = temperatureOccupancy + 100 > 2400 ? 1600 : temperatureOccupancy + 100;
+                    await this.thermoAutoOccupancy?.setAttribute(ThermostatCluster.id, 'localTemperature', temperatureOccupancy, this.thermoAutoOccupancy.log);
+                    await this.thermoAutoOccupancy?.setAttribute(ThermostatCluster.id, 'outdoorTemperature', temperatureOccupancy + 100, this.thermoAutoOccupancy.log);
+                    const occupancyValue = this.thermoAutoOccupancy?.getAttribute(Thermostat.Cluster.id, 'occupancy', this.thermoAutoOccupancy.log);
+                    if (isValidObject(occupancyValue, 1)) {
+                        occupancyValue.occupied = !occupancyValue.occupied;
+                        await this.thermoAutoOccupancy?.setAttribute(Thermostat.Cluster.id, 'occupancy', occupancyValue, this.thermoAutoOccupancy.log);
+                        this.thermoAutoOccupancy?.log.info(`Set thermostat occupancy to ${occupancyValue.occupied}`);
+                    }
+                }
             }, 60 * 1000 + 600);
         }
         await this.airConditioner?.setAttribute(OnOff.Cluster.id, 'onOff', true, this.airConditioner.log);

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "1.3.12",
+  "version": "1.3.13-dev-20250925-7d317a9",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-example-dynamic-platform",
-      "version": "1.3.12",
+      "version": "1.3.13-dev-20250925-7d317a9",
       "license": "Apache-2.0",
       "dependencies": {
         "node-ansi-logger": "3.1.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "1.3.12",
+  "version": "1.3.13-dev-20250925-7d317a9",
   "description": "Matterbridge dynamic plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",