matterbridge-example-dynamic-platform 1.3.2 → 1.3.4-dev-20250720-e338589

package/CHANGELOG.md

@@ -23,6 +23,36 @@ 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.4] - 2025-07-22
+
+### Added
+
+- [platform]: Changed to the new ExtratorHood() and Dishwasher() from Matterbridge.
+
+### Changed
+
+- [package]: Updated dependencies.
+- [package]: Required matterbridge 3.1.6.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
+## [1.3.3] - 2025-07-20
+
+### Added
+
+- [platform]: Add RVC supportedMaps attribute. Thanks Ludovic BOUÉ (#21).
+
+### Changed
+
+- [package]: Updated dependencies.
+- [package]: Required matterbridge 3.1.5.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
 ## [1.3.2] - 2025-07-06
 
 ### Added

package/dist/platform.js

@@ -1,8 +1,8 @@
-import { MatterbridgeEndpoint, MatterbridgeDynamicPlatform, airQualitySensor, bridgedNode, colorTemperatureLight, coverDevice, dimmableLight, doorLockDevice, fanDevice, flowSensor, humiditySensor, onOffLight, onOffOutlet, onOffSwitch, powerSource, rainSensor, smokeCoAlarm, temperatureSensor, thermostatDevice, waterFreezeDetector, waterLeakDetector, airPurifier, pumpDevice, waterValve, genericSwitch, airConditioner, cooktop, extractorHood, microwaveOven, oven, refrigerator, dishwasher, onOffMountedSwitch, dimmableMountedSwitch, extendedColorLight, } from 'matterbridge';
-import { RoboticVacuumCleaner, LaundryWasher, WaterHeater, Evse, SolarPower, BatteryStorage, LaundryDryer, HeatPump } from 'matterbridge/devices';
+import { MatterbridgeEndpoint, MatterbridgeDynamicPlatform, airQualitySensor, bridgedNode, colorTemperatureLight, coverDevice, dimmableLight, doorLockDevice, fanDevice, flowSensor, humiditySensor, onOffLight, onOffOutlet, onOffSwitch, powerSource, rainSensor, smokeCoAlarm, temperatureSensor, thermostatDevice, waterFreezeDetector, waterLeakDetector, airPurifier, pumpDevice, waterValve, genericSwitch, airConditioner, cooktop, microwaveOven, oven, refrigerator, onOffMountedSwitch, dimmableMountedSwitch, extendedColorLight, } from 'matterbridge';
+import { RoboticVacuumCleaner, LaundryWasher, WaterHeater, Evse, SolarPower, BatteryStorage, LaundryDryer, HeatPump, Dishwasher, ExtractorHood } from 'matterbridge/devices';
 import { isValidBoolean, isValidNumber } from 'matterbridge/utils';
-import { LocationTag, NumberTag, PositionTag } from 'matterbridge/matter';
-import { PowerSource, BooleanState, OnOff, LevelControl, AirQuality, CarbonDioxideConcentrationMeasurement, CarbonMonoxideConcentrationMeasurement, FlowMeasurement, ColorControl, DoorLock, FanControl, FormaldehydeConcentrationMeasurement, NitrogenDioxideConcentrationMeasurement, OzoneConcentrationMeasurement, Pm10ConcentrationMeasurement, Pm1ConcentrationMeasurement, Pm25ConcentrationMeasurement, RadonConcentrationMeasurement, RelativeHumidityMeasurement, RelativeHumidityMeasurementCluster, SmokeCoAlarm, TemperatureMeasurement, Thermostat, ThermostatCluster, TotalVolatileOrganicCompoundsConcentrationMeasurement, WindowCovering, EnergyEvseMode, EnergyEvse, } from 'matterbridge/matter/clusters';
+import { AreaNamespaceTag, LocationTag, NumberTag, PositionTag } from 'matterbridge/matter';
+import { PowerSource, BooleanState, OnOff, LevelControl, AirQuality, CarbonDioxideConcentrationMeasurement, CarbonMonoxideConcentrationMeasurement, FlowMeasurement, ColorControl, DoorLock, FanControl, FormaldehydeConcentrationMeasurement, NitrogenDioxideConcentrationMeasurement, OzoneConcentrationMeasurement, Pm10ConcentrationMeasurement, Pm1ConcentrationMeasurement, Pm25ConcentrationMeasurement, RadonConcentrationMeasurement, RelativeHumidityMeasurement, RelativeHumidityMeasurementCluster, SmokeCoAlarm, TemperatureMeasurement, Thermostat, ThermostatCluster, TotalVolatileOrganicCompoundsConcentrationMeasurement, WindowCovering, EnergyEvseMode, EnergyEvse, RvcRunMode, RvcCleanMode, } from 'matterbridge/matter/clusters';
 import { Appliances } from './appliances.js';
 export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatform {
     switch;
@@ -40,6 +40,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     evse;
     laundryWasher;
     laundryDryer;
+    dishwasher;
+    extractorHood;
     solarPower;
     batteryStorage;
     heatPump;
@@ -65,8 +67,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.1.2')) {
-            throw new Error(`This plugin requires Matterbridge version >= "3.1.2". 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.1.6')) {
+            throw new Error(`This plugin requires Matterbridge version >= "3.1.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)
@@ -1000,7 +1002,54 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         else {
             this.latchingSwitch = undefined;
         }
-        const robot = new RoboticVacuumCleaner('Robot Vacuum', 'RVC1238777820', this.config.enableServerRvc === true ? 'server' : undefined);
+        const robot = new RoboticVacuumCleaner('Robot Vacuum', 'RVC1238777820', this.config.enableServerRvc === true ? 'server' : undefined, 1, [
+            { label: 'Idle', mode: 1, modeTags: [{ value: RvcRunMode.ModeTag.Idle }] },
+            { label: 'Cleaning', mode: 2, modeTags: [{ value: RvcRunMode.ModeTag.Cleaning }] },
+            { label: 'Mapping', mode: 3, modeTags: [{ value: RvcRunMode.ModeTag.Mapping }] },
+            { label: 'SpotCleaning', mode: 4, modeTags: [{ value: RvcRunMode.ModeTag.Cleaning }, { value: RvcRunMode.ModeTag.Max }] },
+        ], 1, [
+            { label: 'Vacuum', mode: 1, modeTags: [{ value: RvcCleanMode.ModeTag.Vacuum }] },
+            { label: 'Mop', mode: 2, modeTags: [{ value: RvcCleanMode.ModeTag.Mop }] },
+            { label: 'Clean', mode: 3, modeTags: [{ value: RvcCleanMode.ModeTag.DeepClean }] },
+        ], null, null, undefined, undefined, [
+            {
+                areaId: 1,
+                mapId: 1,
+                areaInfo: { locationInfo: { locationName: 'Living', floorNumber: 0, areaType: AreaNamespaceTag.LivingRoom.tag }, landmarkInfo: null },
+            },
+            {
+                areaId: 2,
+                mapId: 2,
+                areaInfo: { locationInfo: { locationName: 'Kitchen', floorNumber: 0, areaType: AreaNamespaceTag.Kitchen.tag }, landmarkInfo: null },
+            },
+            {
+                areaId: 3,
+                mapId: 3,
+                areaInfo: { locationInfo: { locationName: 'Bedroom', floorNumber: 1, areaType: AreaNamespaceTag.Bedroom.tag }, landmarkInfo: null },
+            },
+            {
+                areaId: 4,
+                mapId: 4,
+                areaInfo: { locationInfo: { locationName: 'Bathroom', floorNumber: 1, areaType: AreaNamespaceTag.Bathroom.tag }, landmarkInfo: null },
+            },
+        ], [], 1, [
+            {
+                mapId: 1,
+                name: 'Ground floor',
+            },
+            {
+                mapId: 2,
+                name: 'First floor',
+            },
+            {
+                mapId: 3,
+                name: 'Bedroom',
+            },
+            {
+                mapId: 4,
+                name: 'Bathroom',
+            },
+        ]);
         if (this.config.enableServerRvc === true) {
             this.log.notice('RVC is in server mode');
         }
@@ -1056,11 +1105,17 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             await this.registerDevice(this.laundryDryer);
             this.bridgedDevices.set(this.laundryDryer.deviceName ?? '', this.laundryDryer);
         }
-        const dishwasherDevice = new Appliances(dishwasher, 'Dishwasher', 'DW0987654321');
-        this.setSelectDevice(dishwasherDevice.serialNumber ?? '', dishwasherDevice.deviceName ?? '', undefined, 'hub');
-        if (this.validateDevice(dishwasherDevice.deviceName ?? '')) {
-            await this.registerDevice(dishwasherDevice);
-            this.bridgedDevices.set(dishwasherDevice.deviceName ?? '', dishwasherDevice);
+        this.dishwasher = new Dishwasher('Dishwasher', 'DW1234567890');
+        this.setSelectDevice(this.dishwasher.serialNumber ?? '', this.dishwasher.deviceName ?? '', undefined, 'hub');
+        if (this.validateDevice(this.dishwasher.deviceName ?? '')) {
+            await this.registerDevice(this.dishwasher);
+            this.bridgedDevices.set(this.dishwasher.deviceName ?? '', this.dishwasher);
+        }
+        this.extractorHood = new ExtractorHood('Extractor Hood', 'EH1234567893');
+        this.setSelectDevice(this.extractorHood.serialNumber ?? '', this.extractorHood.deviceName ?? '', undefined, 'hub');
+        if (this.validateDevice(this.extractorHood.deviceName ?? '')) {
+            await this.registerDevice(this.extractorHood);
+            this.bridgedDevices.set(this.extractorHood.deviceName ?? '', this.extractorHood);
         }
         const refrigeratorDevice = new Appliances(refrigerator, 'Refrigerator', 'RE9987654322');
         refrigeratorDevice.addFixedLabel('composed', 'Refrigerator');
@@ -1082,12 +1137,6 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             await this.registerDevice(microwaveOvenDevice);
             this.bridgedDevices.set(microwaveOvenDevice.deviceName ?? '', microwaveOvenDevice);
         }
-        const extractorHoodDevice = new Appliances(extractorHood, 'Extractor Hood', 'EH1234567893');
-        this.setSelectDevice(extractorHoodDevice.serialNumber ?? '', extractorHoodDevice.deviceName ?? '', undefined, 'hub');
-        if (this.validateDevice(extractorHoodDevice.deviceName ?? '')) {
-            await this.registerDevice(extractorHoodDevice);
-            this.bridgedDevices.set(extractorHoodDevice.deviceName ?? '', extractorHoodDevice);
-        }
         const cooktopDevice = new Appliances(cooktop, 'Cooktop', 'CT1255887894');
         this.setSelectDevice(cooktopDevice.serialNumber ?? '', cooktopDevice.deviceName ?? '', undefined, 'hub');
         if (this.validateDevice(cooktopDevice.deviceName ?? '')) {

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

@@ -1,10 +1,10 @@
 {
   "name": "matterbridge-example-dynamic-platform",
   "type": "DynamicPlatform",
-  "version": "1.1.7",
   "whiteList": [],
   "blackList": [],
   "useInterval": true,
-  "debug": true,
+  "enableServerRvc": true,
+  "debug": false,
   "unregisterOnShutdown": false
 }

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "1.3.2",
+  "version": "1.3.4-dev-20250720-e338589",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-example-dynamic-platform",
-      "version": "1.3.2",
+      "version": "1.3.4-dev-20250720-e338589",
       "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.2",
+  "version": "1.3.4-dev-20250720-e338589",
   "description": "Matterbridge dynamic plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",