matterbridge-example-dynamic-platform 1.2.0 → 1.2.1

package/CHANGELOG.md

@@ -8,11 +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.1] - 2025-05-15
+
+### Changed
+
+- [package]: Require matterbridge 3.0.1.
+- [package]: Updated package.
+- [package]: Updated dependencies.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
 ## [1.2.0] - 2025-04-30
 
 ### Added
 
-- [platform]: Added Robot Vacuum Cleaner device (supported by SmartThings, Alexa, Home Assistant and partially by Apple Home). Read carefully the readme please.
+- [platform]: Added Robot Vacuum Cleaner device (supported by SmartThings, Alexa, Home Assistant and partially by Apple Home). Read carefully the readme please and also https://github.com/Luligu/matterbridge/discussions/264.
 - [platform]: Added OnOff Mounted Switch device (supported by SmartThings, Alexa, Home Assistant).
 - [platform]: Added Dimmer Mounted Switch device (supported by SmartThings, Alexa, Home Assistant).
 - [platform]: Added Laundry Washer device (supported by SmartThings, Alexa and Home Assistant).

package/README.md

@@ -43,7 +43,7 @@ It exposes 38 devices:
 - an airPurifier device with temperature and humidity sensor (supported by Apple Home)
 - a pumpDevice device
 - a waterValve device
-- an airQuality device with all concentration measurements clusters (supported by Apple Home only without the concentration measurements)
+- an airQuality device with all concentration measurements clusters (supported by Apple Home with the concentration measurements from version 18.5)
 - a momentary switch
 - a latching switch
 - a Robot Vacuum Cleaner device (supported by SmartThings, Alexa, Home Assistant and partially by Apple Home). Read also https://github.com/Luligu/matterbridge/discussions/264.

package/dist/appliances.js

@@ -1,7 +1,7 @@
-import { MatterbridgeEndpoint, MatterbridgeServer, MatterbridgeOnOffServer, RefrigeratorTag, PositionTag, laundryWasher, laundryDryer, dishwasher, refrigerator, temperatureControlledCabinetCooler, oven, temperatureControlledCabinetHeater, microwaveOven, extractorHood, cooktop, cookSurface, powerSource, } from 'matterbridge';
-import { ClusterBehavior } from 'matterbridge/matter';
+import { MatterbridgeEndpoint, MatterbridgeServer, MatterbridgeOnOffServer, laundryWasher, laundryDryer, dishwasher, refrigerator, temperatureControlledCabinetCooler, oven, temperatureControlledCabinetHeater, microwaveOven, extractorHood, cooktop, cookSurface, powerSource, } from 'matterbridge';
+import { ClusterBehavior, PositionTag, RefrigeratorTag } from 'matterbridge/matter';
 import { OperationalState, TemperatureControl, DishwasherMode, LaundryWasherControls, LaundryWasherMode, LaundryDryerControls, OvenMode, ModeBase, RefrigeratorAndTemperatureControlledCabinetMode, MicrowaveOvenMode, MicrowaveOvenControl, OvenCavityOperationalState, } from 'matterbridge/matter/clusters';
-import { DishwasherAlarmServer, LaundryDryerControlsServer, LaundryWasherControlsServer, MicrowaveOvenControlBehavior, MicrowaveOvenModeServer, OperationalStateBehavior, TemperatureControlBehavior, } from 'matterbridge/matter/behaviors';
+import { DishwasherAlarmServer, LaundryDryerControlsServer, LaundryWasherControlsServer, MicrowaveOvenControlBehavior, MicrowaveOvenModeServer, TemperatureControlBehavior, } from 'matterbridge/matter/behaviors';
 export class Appliances extends MatterbridgeEndpoint {
     constructor(deviceType, name, serial) {
         super([deviceType, powerSource], { uniqueStorageKey: `${name}-${serial}` }, true);
@@ -111,21 +111,6 @@ export class Appliances extends MatterbridgeEndpoint {
             });
         }
     }
-    createDefaultOperationalStateClusterServer(operationalState = OperationalState.OperationalStateEnum.Stopped) {
-        this.behaviors.require(MatterbridgeOperationalStateServer, {
-            phaseList: [],
-            currentPhase: null,
-            operationalStateList: [
-                { operationalStateId: OperationalState.OperationalStateEnum.Stopped, operationalStateLabel: 'Stopped' },
-                { operationalStateId: OperationalState.OperationalStateEnum.Running, operationalStateLabel: 'Running' },
-                { operationalStateId: OperationalState.OperationalStateEnum.Paused, operationalStateLabel: 'Paused' },
-                { operationalStateId: OperationalState.OperationalStateEnum.Error, operationalStateLabel: 'Error' },
-            ],
-            operationalState,
-            operationalError: { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' },
-        });
-        return this;
-    }
     createDefaultOvenCavityOperationalStateClusterServer(operationalState = OperationalState.OperationalStateEnum.Stopped) {
         this.behaviors.require(OvenCavityOperationalStateServer, {
             phaseList: [],
@@ -288,50 +273,6 @@ export class Appliances extends MatterbridgeEndpoint {
         return endpoint;
     }
 }
-class MatterbridgeOperationalStateServer extends OperationalStateBehavior {
-    initialize() {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
-        device.log.info('MatterbridgeOperationalStateServer initialized: setting operational state to Stopped');
-        this.state.operationalState = OperationalState.OperationalStateEnum.Stopped;
-        this.state.operationalError = { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' };
-    }
-    pause() {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
-        device.log.info('MatterbridgeOperationalStateServer: pause called setting operational state to Paused');
-        this.state.operationalState = OperationalState.OperationalStateEnum.Paused;
-        this.state.operationalError = { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' };
-        return {
-            commandResponseState: { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' },
-        };
-    }
-    stop() {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
-        device.log.info('MatterbridgeOperationalStateServer: stop called setting operational state to Stopped');
-        this.state.operationalState = OperationalState.OperationalStateEnum.Stopped;
-        this.state.operationalError = { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' };
-        return {
-            commandResponseState: { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' },
-        };
-    }
-    start() {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
-        device.log.info('MatterbridgeOperationalStateServer: start called setting operational state to Running');
-        this.state.operationalState = OperationalState.OperationalStateEnum.Running;
-        this.state.operationalError = { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' };
-        return {
-            commandResponseState: { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' },
-        };
-    }
-    resume() {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
-        device.log.info('MatterbridgeOperationalStateServer: resume called setting operational state to Running');
-        this.state.operationalState = OperationalState.OperationalStateEnum.Running;
-        this.state.operationalError = { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' };
-        return {
-            commandResponseState: { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' },
-        };
-    }
-}
 class MatterbridgeLevelTemperatureControlServer extends TemperatureControlBehavior.with(TemperatureControl.Feature.TemperatureLevel) {
     initialize() {
         if (this.state.supportedTemperatureLevels.length >= 2) {

package/dist/platform.js

@@ -57,16 +57,14 @@ 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.0')) {
-            throw new Error(`This plugin requires Matterbridge version >= "3.0.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.0.1')) {
+            throw new Error(`This plugin requires Matterbridge version >= "3.0.1". 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)
             config.whiteList = [];
         if (config.blackList === undefined)
             config.blackList = [];
-        if (config.enableConcentrationMeasurements === undefined)
-            config.enableConcentrationMeasurements = false;
         if (config.enableRVC === undefined)
             config.enableRVC = false;
     }
@@ -837,9 +835,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             .createDefaultBridgedDeviceBasicInformationClusterServer('SmokeCo alarm sensor', 'serial_94745631225', 0xfff1, 'Matterbridge', 'Matterbridge SmokeCoAlarm', parseInt(this.version.replace(/\D/g, '')), this.version === '' ? 'Unknown' : this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion)
             .createDefaultIdentifyClusterServer()
             .createDefaultSmokeCOAlarmClusterServer(SmokeCoAlarm.AlarmState.Normal, SmokeCoAlarm.AlarmState.Normal)
-            .createDefaultPowerSourceReplaceableBatteryClusterServer();
-        if (this.config.enableConcentrationMeasurements === true)
-            this.smokeCo.createDefaultCarbonMonoxideConcentrationMeasurementClusterServer(100);
+            .createDefaultPowerSourceReplaceableBatteryClusterServer()
+            .createDefaultCarbonMonoxideConcentrationMeasurementClusterServer(100);
         this.setSelectDevice(this.smokeCo.serialNumber ?? '', this.smokeCo.deviceName ?? '', undefined, 'hub');
         if (this.validateDevice(this.smokeCo.deviceName ?? '')) {
             await this.registerDevice(this.smokeCo);
@@ -865,9 +862,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             .createDefaultBridgedDeviceBasicInformationClusterServer('Co alarm sensor', 'serial_947456317488', 0xfff1, 'Matterbridge', 'Matterbridge SmokeCoAlarm', parseInt(this.version.replace(/\D/g, '')), this.version === '' ? 'Unknown' : this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion)
             .createDefaultIdentifyClusterServer()
             .createCoOnlySmokeCOAlarmClusterServer(SmokeCoAlarm.AlarmState.Normal)
-            .createDefaultPowerSourceReplaceableBatteryClusterServer();
-        if (this.config.enableConcentrationMeasurements === true)
-            this.coOnly.createDefaultCarbonMonoxideConcentrationMeasurementClusterServer(100);
+            .createDefaultPowerSourceReplaceableBatteryClusterServer()
+            .createDefaultCarbonMonoxideConcentrationMeasurementClusterServer(100);
         this.setSelectDevice(this.coOnly.serialNumber ?? '', this.coOnly.deviceName ?? '', undefined, 'hub');
         if (this.validateDevice(this.coOnly.deviceName ?? '')) {
             await this.registerDevice(this.coOnly);
@@ -880,19 +876,17 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             .createDefaultBridgedDeviceBasicInformationClusterServer('Air quality sensor', 'serial_987484318322', 0xfff1, 'Matterbridge', 'Matterbridge Air Quality Sensor', parseInt(this.version.replace(/\D/g, '')), this.version === '' ? 'Unknown' : this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion)
             .createDefaultPowerSourceReplaceableBatteryClusterServer(50, PowerSource.BatChargeLevel.Warning, 2900, 'CR2450', 1)
             .addRequiredClusterServers()
-            .addClusterServers([TemperatureMeasurement.Cluster.id, RelativeHumidityMeasurement.Cluster.id]);
-        if (this.config.enableConcentrationMeasurements === true) {
-            this.airQuality.createDefaultCarbonMonoxideConcentrationMeasurementClusterServer(10);
-            this.airQuality.createDefaultCarbonDioxideConcentrationMeasurementClusterServer(400);
-            this.airQuality.createDefaultNitrogenDioxideConcentrationMeasurementClusterServer(1);
-            this.airQuality.createDefaultOzoneConcentrationMeasurementClusterServer(1);
-            this.airQuality.createDefaultFormaldehydeConcentrationMeasurementClusterServer(1);
-            this.airQuality.createDefaultPm1ConcentrationMeasurementClusterServer(100);
-            this.airQuality.createDefaultPm25ConcentrationMeasurementClusterServer(100);
-            this.airQuality.createDefaultPm10ConcentrationMeasurementClusterServer(100);
-            this.airQuality.createDefaultRadonConcentrationMeasurementClusterServer(100);
-            this.airQuality.createDefaultTvocMeasurementClusterServer(100);
-        }
+            .addClusterServers([TemperatureMeasurement.Cluster.id, RelativeHumidityMeasurement.Cluster.id])
+            .createDefaultCarbonMonoxideConcentrationMeasurementClusterServer(10)
+            .createDefaultCarbonDioxideConcentrationMeasurementClusterServer(400)
+            .createDefaultNitrogenDioxideConcentrationMeasurementClusterServer(1)
+            .createDefaultOzoneConcentrationMeasurementClusterServer(1)
+            .createDefaultFormaldehydeConcentrationMeasurementClusterServer(1)
+            .createDefaultPm1ConcentrationMeasurementClusterServer(100)
+            .createDefaultPm25ConcentrationMeasurementClusterServer(100)
+            .createDefaultPm10ConcentrationMeasurementClusterServer(100)
+            .createDefaultRadonConcentrationMeasurementClusterServer(100)
+            .createDefaultTvocMeasurementClusterServer(100);
         this.setSelectDevice(this.airQuality.serialNumber ?? '', this.airQuality.deviceName ?? '', undefined, 'hub');
         if (this.validateDevice(this.airQuality.deviceName ?? '')) {
             await this.registerDevice(this.airQuality);

package/dist/robot.js

@@ -1,5 +1,5 @@
 import { Matterbridge, MatterbridgeServer, MatterbridgeEndpoint, roboticVacuumCleaner, dishwasher } from 'matterbridge';
-import { LogLevel as MatterLogLevel, LogFormat as MatterLogFormat, DeviceTypeId, VendorId, } from 'matterbridge/matter';
+import { LogLevel as MatterLogLevel, LogFormat as MatterLogFormat, DeviceTypeId, VendorId } from 'matterbridge/matter';
 import { ModeBase, OperationalState, PowerSource, RvcRunMode, RvcCleanMode, RvcOperationalState, ServiceArea } from 'matterbridge/matter/clusters';
 import { ActionsServer, RvcCleanModeBehavior, RvcOperationalStateBehavior, RvcRunModeBehavior, ServiceAreaBehavior } from 'matterbridge/matter/behaviors';
 import { AnsiLogger } from 'matterbridge/logger';

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

@@ -39,13 +39,8 @@
       "type": "boolean",
       "default": true
     },
-    "enableConcentrationMeasurements": {
-      "description": "Enable the ConcentrationMeasurements in the Air Quality device and SmokeCoSensor device (Apple Home 18.4 will discard these devices when enabled)",
-      "type": "boolean",
-      "default": false
-    },
     "enableRVC": {
-      "description": "Enable the Robot Vacuum Cleaner (Apple Home 18.4 will crash unless you use child bridge and put the rvc in the white list as a single device)",
+      "description": "Enable the Robot Vacuum Cleaner (Apple Home will crash unless you use child bridge and put the rvc in the white list as a single device)",
       "type": "boolean",
       "default": false
     },

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-example-dynamic-platform",
-      "version": "1.2.0",
+      "version": "1.2.1",
       "license": "MIT",
       "dependencies": {
         "node-ansi-logger": "3.0.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Matterbridge dynamic plugin",
   "author": "https://github.com/Luligu",
   "license": "MIT",