matterbridge-example-dynamic-platform 1.2.3 → 1.2.4-dev-20250612-926c70e

package/CHANGELOG.md

@@ -8,6 +8,23 @@ 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.2.4] - 2025-06-11
+
+### Added
+
+- [npm]: The dev of matterbridge-example-dynamic-platform is published with tag **dev** on **npm** each day at 00:00 UTC if there is a new commit.
+
+### Changed
+
+- [package]: Require matterbridge 3.0.6.
+- [package]: Updated package.
+- [package]: Updated dependencies.
+- [subscribe]: Prevent attribute setting when offline for air purifier and fan.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
 ## [1.2.3] - 2025-05-25
 
 ### Added

package/dist/appliances.js

@@ -276,12 +276,12 @@ export class Appliances extends MatterbridgeEndpoint {
 class MatterbridgeLevelTemperatureControlServer extends TemperatureControlBehavior.with(TemperatureControl.Feature.TemperatureLevel) {
     initialize() {
         if (this.state.supportedTemperatureLevels.length >= 2) {
-            const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+            const device = this.endpoint.stateOf(MatterbridgeServer);
             device.log.info('MatterbridgeLevelTemperatureControlServer initialized');
         }
     }
     setTemperature(request) {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         if (request.targetTemperatureLevel !== undefined && request.targetTemperatureLevel >= 0 && request.targetTemperatureLevel < this.state.supportedTemperatureLevels.length) {
             device.log.info(`MatterbridgeLevelTemperatureControlServer: setTemperature called setting selectedTemperatureLevel to ${request.targetTemperatureLevel}: ${this.state.supportedTemperatureLevels[request.targetTemperatureLevel]}`);
             this.state.selectedTemperatureLevel = request.targetTemperatureLevel;
@@ -293,11 +293,11 @@ class MatterbridgeLevelTemperatureControlServer extends TemperatureControlBehavi
 }
 class MatterbridgeNumberTemperatureControlServer extends TemperatureControlBehavior.with(TemperatureControl.Feature.TemperatureNumber) {
     initialize() {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         device.log.info('MatterbridgeNumberTemperatureControlServer initialized');
     }
     setTemperature(request) {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         if (request.targetTemperature !== undefined && request.targetTemperature >= this.state.minTemperature && request.targetTemperature <= this.state.maxTemperature) {
             device.log.info(`MatterbridgeNumberTemperatureControlServer: setTemperature called setting temperatureSetpoint to ${request.targetTemperature}`);
             this.state.temperatureSetpoint = request.targetTemperature;
@@ -309,11 +309,11 @@ class MatterbridgeNumberTemperatureControlServer extends TemperatureControlBehav
 }
 class MatterbridgeMicrowaveOvenControlServer extends MicrowaveOvenControlBehavior.with(MicrowaveOvenControl.Feature.PowerInWatts) {
     initialize() {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         device.log.info('MatterbridgeMicrowaveOvenControlServer initialized');
     }
     setCookingParameters(request) {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         if (request.cookMode !== undefined) {
             device.log.info(`MatterbridgeMicrowaveOvenControlServer: setCookingParameters called setting cookMode to ${request.cookMode}`);
             this.endpoint.setStateOf(MicrowaveOvenModeServer, { currentMode: request.cookMode });
@@ -340,7 +340,7 @@ class MatterbridgeMicrowaveOvenControlServer extends MicrowaveOvenControlBehavio
         }
     }
     addMoreTime(request) {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         if (request.timeToAdd !== undefined && request.timeToAdd >= 0) {
             device.log.info(`MatterbridgeMicrowaveOvenControlServer: addMoreTime called setting cookTime to ${this.state.cookTime + request.timeToAdd}`);
             this.state.cookTime += request.timeToAdd;
@@ -352,13 +352,13 @@ class MatterbridgeMicrowaveOvenControlServer extends MicrowaveOvenControlBehavio
 }
 export class MatterbridgeOvenCavityOperationalStateServer extends OvenCavityOperationalStateBehavior {
     initialize() {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         device.log.info('OvenCavityOperationalStateServer initialized: setting operational state to Stopped and operational error to No error');
         this.state.operationalState = OperationalState.OperationalStateEnum.Stopped;
         this.state.operationalError = { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' };
     }
     stop() {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         device.log.info('OvenCavityOperationalStateServer: stop called setting operational state to Stopped and operational error to No error');
         this.state.operationalState = OperationalState.OperationalStateEnum.Stopped;
         this.state.operationalError = { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' };
@@ -367,7 +367,7 @@ export class MatterbridgeOvenCavityOperationalStateServer extends OvenCavityOper
         };
     }
     start() {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         device.log.info('OvenCavityOperationalStateServer: start called setting operational state to Running and operational error to No error');
         this.state.operationalState = OperationalState.OperationalStateEnum.Running;
         this.state.operationalError = { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' };
@@ -378,12 +378,12 @@ export class MatterbridgeOvenCavityOperationalStateServer extends OvenCavityOper
 }
 class MatterbridgeRefrigeratorAndTemperatureControlledCabinetModeServer extends RefrigeratorAndTemperatureControlledCabinetModeBehavior {
     initialize() {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         device.log.info('MatterbridgeRefrigeratorAndTemperatureControlledCabinetModeServer initialized: setting currentMode to 1');
         this.state.currentMode = 1;
     }
     changeToMode(request) {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         const supportedMode = this.state.supportedModes.find((supportedMode) => supportedMode.mode === request.newMode);
         if (supportedMode) {
             device.log.info(`MatterbridgeRefrigeratorAndTemperatureControlledCabinetModeServer: changeToMode called with mode ${supportedMode.mode} = ${supportedMode.label}`);
@@ -398,12 +398,12 @@ class MatterbridgeRefrigeratorAndTemperatureControlledCabinetModeServer extends
 }
 class MatterbridgeOvenModeServer extends OvenModeBehavior {
     initialize() {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         device.log.info('OvenModeServer initialized: setting currentMode to 3');
         this.state.currentMode = 3;
     }
     changeToMode(request) {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         const supportedMode = this.state.supportedModes.find((supportedMode) => supportedMode.mode === request.newMode);
         if (supportedMode) {
             device.log.info(`OvenModeServer: changeToMode called with mode ${supportedMode.mode} = ${supportedMode.label}`);
@@ -418,20 +418,20 @@ class MatterbridgeOvenModeServer extends OvenModeBehavior {
 }
 class MatterbridgeDishwasherModeServer extends DishwasherModeBehavior {
     initialize() {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         device.log.info('DishwasherModeServer initialized: setting currentMode to 3');
         this.state.currentMode = 2;
         this.reactTo(this.agent.get(MatterbridgeOnOffServer).events.onOff$Changed, this.handleOnOffChange);
     }
     handleOnOffChange(onOff) {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         if (onOff === false) {
             device.log.info('***OnOffServer changed to OFF: setting Dead Front state to Manufacturer Specific');
             this.state.currentMode = 2;
         }
     }
     changeToMode(request) {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         const supportedMode = this.state.supportedModes.find((supportedMode) => supportedMode.mode === request.newMode);
         if (supportedMode) {
             device.log.info(`DishwasherModeServer: changeToMode called with mode ${supportedMode.mode} = ${supportedMode.label}`);
@@ -446,20 +446,20 @@ class MatterbridgeDishwasherModeServer extends DishwasherModeBehavior {
 }
 class MatterbridgeLaundryWasherModeServer extends LaundryWasherModeBehavior {
     initialize() {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         device.log.info('LaundryWasherModeServer initialized: setting currentMode to 3');
         this.state.currentMode = 2;
         this.reactTo(this.agent.get(MatterbridgeOnOffServer).events.onOff$Changed, this.handleOnOffChange);
     }
     handleOnOffChange(onOff) {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         if (onOff === false) {
             device.log.notice('OnOffServer changed to OFF: setting Dead Front state to Manufacturer Specific');
             this.state.currentMode = 2;
         }
     }
     changeToMode(request) {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        const device = this.endpoint.stateOf(MatterbridgeServer);
         const supportedMode = this.state.supportedModes.find((supportedMode) => supportedMode.mode === request.newMode);
         if (supportedMode) {
             device.log.info(`LaundryWasherModeServer: changeToMode called with mode ${supportedMode.mode} = ${supportedMode.label}`);

package/dist/platform.js

@@ -59,8 +59,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     fanModeLookup = ['Off', 'Low', 'Medium', 'High', 'On', 'Auto', 'Smart'];
     constructor(matterbridge, log, config) {
         super(matterbridge, log, config);
-        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.0.5')) {
-            throw new Error(`This plugin requires Matterbridge version >= "3.0.5". 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.0.6')) {
+            throw new Error(`This plugin requires Matterbridge version >= "3.0.6". 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)
@@ -673,6 +673,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         });
         await this.airPurifier?.subscribeAttribute(FanControl.Cluster.id, 'fanMode', (newValue, oldValue, context) => {
             this.airPurifier?.log.info(`Fan mode changed from ${this.fanModeLookup[oldValue]} to ${this.fanModeLookup[newValue]} context: ${context.offline === true ? 'offline' : 'online'}`);
+            if (context.offline === true)
+                return;
             if (newValue === FanControl.FanMode.Off) {
                 this.airPurifier?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 0, this.airPurifier?.log);
             }
@@ -691,6 +693,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         }, this.airPurifier.log);
         await this.airPurifier?.subscribeAttribute(FanControl.Cluster.id, 'percentSetting', (newValue, oldValue, context) => {
             this.airPurifier?.log.info(`Percent setting changed from ${oldValue} to ${newValue} context: ${context.offline === true ? 'offline' : 'online'}`);
+            if (context.offline === true)
+                return;
             if (isValidNumber(newValue, 0, 100))
                 this.airPurifier?.setAttribute(FanControl.Cluster.id, 'percentCurrent', newValue, this.airPurifier?.log);
         }, this.airPurifier.log);
@@ -721,7 +725,6 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             await this.airConditioner?.setAttribute(ThermostatCluster.id, 'localTemperature', 20 * 100, this.airConditioner?.log);
             await this.airConditioner?.setAttribute(TemperatureMeasurement.Cluster.id, 'measuredValue', 20 * 100, this.airConditioner?.log);
             await this.airConditioner?.setAttribute(RelativeHumidityMeasurementCluster.id, 'measuredValue', 50 * 100, this.airConditioner?.log);
-            await this.airConditioner?.setAttribute(FanControl.Cluster.id, 'speedSetting', 50, this.airConditioner?.log);
             await this.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentSetting', 50, this.airConditioner?.log);
         });
         this.airConditioner?.addCommandHandler('off', async () => {
@@ -729,7 +732,6 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             await this.airConditioner?.setAttribute(ThermostatCluster.id, 'localTemperature', null, this.airConditioner?.log);
             await this.airConditioner?.setAttribute(TemperatureMeasurement.Cluster.id, 'measuredValue', null, this.airConditioner?.log);
             await this.airConditioner?.setAttribute(RelativeHumidityMeasurementCluster.id, 'measuredValue', null, this.airConditioner?.log);
-            await this.airConditioner?.setAttribute(FanControl.Cluster.id, 'speedSetting', null, this.airConditioner?.log);
             await this.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentSetting', null, this.airConditioner?.log);
         });
         this.pump = new MatterbridgeEndpoint([pumpDevice, bridgedNode, powerSource], { uniqueStorageKey: 'Pump' }, this.config.debug)
@@ -792,6 +794,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         }
         await this.fan?.subscribeAttribute(FanControl.Cluster.id, 'fanMode', (newValue, oldValue, context) => {
             this.fan?.log.info(`Fan mode changed from ${this.fanModeLookup[oldValue]} to ${this.fanModeLookup[newValue]} context: ${context.offline === true ? 'offline' : 'online'}`);
+            if (context.offline === true)
+                return;
             if (newValue === FanControl.FanMode.Off) {
                 this.fan?.setAttribute(FanControl.Cluster.id, 'percentSetting', 0, this.fan?.log);
                 this.fan?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 0, this.fan?.log);
@@ -819,14 +823,11 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         }, this.fan.log);
         await this.fan?.subscribeAttribute(FanControl.Cluster.id, 'percentSetting', (newValue, oldValue, context) => {
             this.fan?.log.info(`Percent setting changed from ${oldValue} to ${newValue} context: ${context.offline === true ? 'offline' : 'online'}`);
+            if (context.offline === true)
+                return;
             if (isValidNumber(newValue, 0, 100))
                 this.fan?.setAttribute(FanControl.Cluster.id, 'percentCurrent', newValue, this.fan?.log);
         }, this.fan.log);
-        await this.fan?.subscribeAttribute(FanControl.Cluster.id, 'speedSetting', (newValue, oldValue, context) => {
-            this.fan?.log.info(`Speed setting changed from ${oldValue} to ${newValue} context: ${context.offline === true ? 'offline' : 'online'}`);
-            if (isValidNumber(newValue, 0, 100))
-                this.fan?.setAttribute(FanControl.Cluster.id, 'speedCurrent', newValue, this.fan?.log);
-        }, this.fan.log);
         this.waterLeak = new MatterbridgeEndpoint([waterLeakDetector, bridgedNode, powerSource], { uniqueStorageKey: 'Water leak detector' }, this.config.debug)
             .createDefaultBridgedDeviceBasicInformationClusterServer('Water leak detector', 'serial_98745631222', 0xfff1, 'Matterbridge', 'Matterbridge WaterLeakDetector', parseInt(this.version.replace(/\D/g, '')), this.version === '' ? 'Unknown' : this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion)
             .createDefaultPowerSourceRechargeableBatteryClusterServer()
@@ -1209,12 +1210,10 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
                 }
             }, 60 * 1000 + 550);
         }
-        this.fan?.log.info('Set fan initial fanMode to Auto, percentCurrent and percentSetting to 50 and speedCurrent and speedSetting to 50');
+        this.fan?.log.info('Set fan initial fanMode to Auto, percentCurrent and percentSetting to 50');
         await this.fan?.setAttribute(FanControl.Cluster.id, 'fanMode', FanControl.FanMode.Auto, this.fan.log);
         await this.fan?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 50, this.fan.log);
         await this.fan?.setAttribute(FanControl.Cluster.id, 'percentSetting', 50, this.fan.log);
-        await this.fan?.setAttribute(FanControl.Cluster.id, 'speedCurrent', 50, this.fan.log);
-        await this.fan?.setAttribute(FanControl.Cluster.id, 'speedSetting', 50, this.fan.log);
         if (this.config.useInterval) {
             this.fanInterval = setInterval(async () => {
                 const mode = this.fan?.getAttribute(FanControl.Cluster.id, 'fanMode', this.fan.log);

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "1.2.3",
+  "version": "1.2.4-dev-20250612-926c70e",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-example-dynamic-platform",
-      "version": "1.2.3",
+      "version": "1.2.4-dev-20250612-926c70e",
       "license": "MIT",
       "dependencies": {
         "node-ansi-logger": "3.0.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "1.2.3",
+  "version": "1.2.4-dev-20250612-926c70e",
   "description": "Matterbridge dynamic plugin",
   "author": "https://github.com/Luligu",
   "license": "MIT",