matterbridge-example-dynamic-platform 1.2.1 → 1.2.2

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.2] - 2025-05-19
+
+### Changed
+
+- [package]: Added waterHeater device type (not supported by Alexa and Apple Home)
+
+### Changed
+
+- [package]: Changed the RVC from local implementation to the new RoboticVacuumCleaner class from matterbridge.
+- [package]: Require matterbridge 3.0.3.
+- [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.1] - 2025-05-15
 
 ### Changed

package/README.md

@@ -57,6 +57,7 @@ It exposes 38 devices:
 - a microwave Oven device (supported by SmartThings, Alexa and Home Assistant)
 - an extractor Hood device (supported by SmartThings, Alexa and Home Assistant)
 - a cooktop device (supported by SmartThings, Alexa and Home Assistant)
+- a water heater device (supported by SmartThings and Home Assistant)
 
 All these devices continuously change state and position. The plugin also shows how to use all the command handlers (you can control all the devices), how to subscribe to attributes and how to trigger events.
 

package/dist/platform.js

@@ -1,9 +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, laundryWasher, cooktop, extractorHood, microwaveOven, oven, refrigerator, dishwasher, laundryDryer, onOffMountedSwitch, dimmableMountedSwitch, extendedColorLight, } from 'matterbridge';
+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, laundryWasher, cooktop, extractorHood, microwaveOven, oven, refrigerator, dishwasher, laundryDryer, onOffMountedSwitch, dimmableMountedSwitch, extendedColorLight, RoboticVacuumCleaner, WaterHeater, } from 'matterbridge';
 import { isValidBoolean, isValidNumber } from 'matterbridge/utils';
 import { LocationTag } 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, } from 'matterbridge/matter/clusters';
 import { Appliances } from './appliances.js';
-import { Robot } from './robot.js';
 export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatform {
     switch;
     mountedOnOffSwitch;
@@ -35,6 +34,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     momentarySwitch;
     latchingSwitch;
     vacuum;
+    heater;
     switchInterval;
     lightInterval;
     outletInterval;
@@ -57,8 +57,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.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.`);
+        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.0.3')) {
+            throw new Error(`This plugin requires Matterbridge version >= "3.0.3". 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)
@@ -718,11 +718,15 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         });
         this.pump?.addCommandHandler('on', async () => {
             this.pump?.log.info('Command on called');
-            await this.pump?.setAttribute(OnOff.Cluster.id, 'onOff', true, this.pump?.log);
         });
         this.pump?.addCommandHandler('off', async () => {
             this.pump?.log.info('Command off called');
-            await this.pump?.setAttribute(OnOff.Cluster.id, 'onOff', false, this.pump?.log);
+        });
+        this.pump?.addCommandHandler('moveToLevel', async ({ request: { level } }) => {
+            this.pump?.log.info(`Command moveToLevel called request: ${level}`);
+        });
+        this.pump?.addCommandHandler('moveToLevelWithOnOff', async ({ request: { level } }) => {
+            this.pump?.log.info(`Command moveToLevelWithOnOff called request: ${level}`);
         });
         this.valve = new MatterbridgeEndpoint([waterValve, bridgedNode, powerSource], { uniqueStorageKey: 'Water valve' }, this.config.debug)
             .createDefaultBridgedDeviceBasicInformationClusterServer('Water valve', '0x96382864WV', 0xfff1, 'Matterbridge', 'Matterbridge Water valve', parseInt(this.version.replace(/\D/g, '')), this.version === '' ? 'Unknown' : this.version, parseInt(this.matterbridge.matterbridgeVersion.replace(/\D/g, '')), this.matterbridge.matterbridgeVersion)
@@ -922,13 +926,19 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             this.latchingSwitch = undefined;
         }
         if (this.config.enableRVC === true) {
-            const robot = new Robot('Robot Vacuum', '1238777820');
+            const robot = new RoboticVacuumCleaner('Robot Vacuum', '1238777820');
             this.setSelectDevice(robot.serialNumber ?? '', robot.deviceName ?? '', undefined, 'hub');
             if (this.validateDevice(robot.deviceName ?? '')) {
                 await this.registerDevice(robot);
                 this.bridgedDevices.set(robot.deviceName ?? '', robot);
             }
         }
+        const heater = new WaterHeater('Water Heater', '3456177820');
+        this.setSelectDevice(heater.serialNumber ?? '', heater.deviceName ?? '', undefined, 'hub');
+        if (this.validateDevice(heater.deviceName ?? '')) {
+            await this.registerDevice(heater);
+            this.bridgedDevices.set(heater.deviceName ?? '', heater);
+        }
         const laundryWasherDevice = new Appliances(laundryWasher, 'Laundry Washer', '1234567890');
         this.setSelectDevice(laundryWasherDevice.serialNumber ?? '', laundryWasherDevice.deviceName ?? '', undefined, 'hub');
         if (this.validateDevice(laundryWasherDevice.deviceName ?? '')) {

package/npm-shrinkwrap.json

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

package/package.json

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

package/dist/robot.js

@@ -1,210 +0,0 @@
-import { Matterbridge, MatterbridgeServer, MatterbridgeEndpoint, roboticVacuumCleaner, dishwasher } from 'matterbridge';
-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';
-export class Robot extends MatterbridgeEndpoint {
-    constructor(name, serial) {
-        super(roboticVacuumCleaner, { uniqueStorageKey: `${name}-${serial}` }, true);
-        this.createDefaultIdentifyClusterServer()
-            .createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge Robot Vacuum Cleaner')
-            .createDefaultRvcRunModeClusterServer()
-            .createDefaultRvcOperationalStateClusterServer()
-            .createDefaultRvcCleanModeClusterServer()
-            .createDefaultServiceAreaClusterServer()
-            .createDefaultPowerSourceRechargeableBatteryClusterServer(80, PowerSource.BatChargeLevel.Ok, 5900);
-    }
-    createDefaultRvcRunModeClusterServer(currentMode, supportedModes) {
-        this.behaviors.require(MatterbridgeRvcRunModeServer, {
-            supportedModes: supportedModes ?? [
-                { 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 }] },
-            ],
-            currentMode: currentMode ?? 1,
-        });
-        return this;
-    }
-    createDefaultRvcCleanModeClusterServer(currentMode, supportedModes) {
-        this.behaviors.require(MatterbridgeRvcCleanModeServer, {
-            supportedModes: supportedModes ?? [
-                { 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 }] },
-            ],
-            currentMode: currentMode ?? 1,
-        });
-        return this;
-    }
-    createDefaultServiceAreaClusterServer(supportedAreas, selectedAreas) {
-        this.behaviors.require(MatterbridgeServiceAreaServer, {
-            supportedAreas: supportedAreas ?? [
-                {
-                    areaId: 1,
-                    mapId: null,
-                    areaInfo: { locationInfo: { locationName: 'Living', floorNumber: null, areaType: null }, landmarkInfo: null },
-                },
-                {
-                    areaId: 2,
-                    mapId: null,
-                    areaInfo: { locationInfo: { locationName: 'Kitchen', floorNumber: null, areaType: null }, landmarkInfo: null },
-                },
-                {
-                    areaId: 3,
-                    mapId: null,
-                    areaInfo: { locationInfo: { locationName: 'Bedroom', floorNumber: null, areaType: null }, landmarkInfo: null },
-                },
-                {
-                    areaId: 4,
-                    mapId: null,
-                    areaInfo: { locationInfo: { locationName: 'Bathroom', floorNumber: null, areaType: null }, landmarkInfo: null },
-                },
-            ],
-            selectedAreas: selectedAreas ?? [],
-            currentArea: 1,
-            estimatedEndTime: null,
-        });
-        return this;
-    }
-    createDefaultRvcOperationalStateClusterServer(phaseList = null, currentPhase = null, operationalStateList, operationalState, operationalError) {
-        this.behaviors.require(MatterbridgeRvcOperationalStateServer, {
-            phaseList,
-            currentPhase,
-            operationalStateList: operationalStateList ?? [
-                { operationalStateId: RvcOperationalState.OperationalState.Stopped, operationalStateLabel: 'Stopped' },
-                { operationalStateId: RvcOperationalState.OperationalState.Running, operationalStateLabel: 'Running' },
-                { operationalStateId: RvcOperationalState.OperationalState.Paused, operationalStateLabel: 'Paused' },
-                { operationalStateId: RvcOperationalState.OperationalState.Error, operationalStateLabel: 'Error' },
-                { operationalStateId: RvcOperationalState.OperationalState.SeekingCharger, operationalStateLabel: 'SeekingCharger' },
-                { operationalStateId: RvcOperationalState.OperationalState.Charging, operationalStateLabel: 'Charging' },
-                { operationalStateId: RvcOperationalState.OperationalState.Docked, operationalStateLabel: 'Docked' },
-            ],
-            operationalState: operationalState ?? RvcOperationalState.OperationalState.Docked,
-            operationalError: operationalError ?? { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateLabel: 'No Error', errorStateDetails: 'Fully operational' },
-        });
-        return this;
-    }
-}
-export class MatterbridgeServiceAreaServer extends ServiceAreaBehavior {
-    initialize() {
-    }
-    selectAreas({ newAreas }) {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
-        for (const area of newAreas) {
-            const supportedArea = this.state.supportedAreas.find((supportedArea) => supportedArea.areaId === area);
-            if (!supportedArea) {
-                device.log.error('MatterbridgeServiceAreaServer selectAreas called with unsupported area:', area);
-                return { status: ServiceArea.SelectAreasStatus.UnsupportedArea, statusText: 'Unsupported areas' };
-            }
-        }
-        this.state.selectedAreas = newAreas;
-        this.state.currentArea = newAreas[0];
-        device.log.info(`***MatterbridgeServiceAreaServer selectAreas called with: ${newAreas.map((area) => area.toString()).join(', ')}`);
-        return { status: ServiceArea.SelectAreasStatus.Success, statusText: 'Succesfully selected new areas' };
-    }
-}
-export class MatterbridgeRvcRunModeServer extends RvcRunModeBehavior {
-    initialize() {
-        this.state.currentMode = 1;
-    }
-    changeToMode({ newMode }) {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
-        const changedMode = this.state.supportedModes.find((mode) => mode.mode === newMode);
-        if (!changedMode) {
-            device.log.error('MatterbridgeRvcRunModeServer changeToMode called with unsupported newMode:', newMode);
-            return { status: ModeBase.ModeChangeStatus.InvalidInMode, statusText: 'Invalid mode' };
-        }
-        device.changeToMode({ newMode });
-        this.state.currentMode = newMode;
-        if (changedMode.modeTags.find((tag) => tag.value === RvcRunMode.ModeTag.Cleaning)) {
-            device.log.info('***MatterbridgeRvcRunModeServer changeToMode called with newMode Cleaning => Running');
-            this.agent.get(MatterbridgeRvcOperationalStateServer).state.operationalState = RvcOperationalState.OperationalState.Running;
-            return { status: ModeBase.ModeChangeStatus.Success, statusText: 'Running' };
-        }
-        else if (changedMode.modeTags.find((tag) => tag.value === RvcRunMode.ModeTag.Idle)) {
-            device.log.info('***MatterbridgeRvcRunModeServer changeToMode called with newMode Idle => Docked');
-            this.agent.get(MatterbridgeRvcOperationalStateServer).state.operationalState = RvcOperationalState.OperationalState.Docked;
-            return { status: ModeBase.ModeChangeStatus.Success, statusText: 'Docked' };
-        }
-        device.log.info(`***MatterbridgeRvcRunModeServer changeToMode called with newMode ${newMode} => ${changedMode.label}`);
-        this.agent.get(MatterbridgeRvcOperationalStateServer).state.operationalState = RvcOperationalState.OperationalState.Running;
-        return { status: ModeBase.ModeChangeStatus.Success, statusText: 'Success' };
-    }
-}
-export class MatterbridgeRvcCleanModeServer extends RvcCleanModeBehavior {
-    initialize() {
-        this.state.currentMode = 1;
-    }
-    changeToMode({ newMode }) {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
-        const supported = this.state.supportedModes.find((mode) => mode.mode === newMode);
-        if (!supported) {
-            device.log.error('***MatterbridgeRvcCleanModeServer changeToMode called with unsupported newMode:', newMode);
-            return { status: ModeBase.ModeChangeStatus.InvalidInMode, statusText: 'Invalid mode' };
-        }
-        device.changeToMode({ newMode });
-        this.state.currentMode = newMode;
-        device.log.info(`***MatterbridgeRvcCleanModeServer changeToMode called with newMode ${newMode} => ${supported.label}`);
-        return { status: ModeBase.ModeChangeStatus.Success, statusText: 'Success' };
-    }
-}
-export class MatterbridgeRvcOperationalStateServer extends RvcOperationalStateBehavior {
-    initialize() {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
-        device.log.info('***MatterbridgeRvcOperationalStateServer initialized: setting operational state to Docked');
-        this.state.operationalState = RvcOperationalState.OperationalState.Docked;
-        this.state.operationalError = { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateLabel: 'No Error', errorStateDetails: 'Fully operational' };
-    }
-    pause() {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
-        device.log.info('MatterbridgeRvcOperationalStateServer: pause called setting operational state to Paused and currentMode to Idle');
-        this.agent.get(MatterbridgeRvcRunModeServer).state.currentMode = 1;
-        this.state.operationalState = RvcOperationalState.OperationalState.Paused;
-        this.state.operationalError = { errorStateId: RvcOperationalState.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('MatterbridgeRvcOperationalStateServer: resume called setting operational state to Running and currentMode to Cleaning');
-        this.agent.get(MatterbridgeRvcRunModeServer).state.currentMode = 2;
-        this.state.operationalState = RvcOperationalState.OperationalState.Running;
-        this.state.operationalError = { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateLabel: 'No Error', errorStateDetails: 'Fully operational' };
-        return {
-            commandResponseState: { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' },
-        };
-    }
-    goHome() {
-        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
-        device.log.info('MatterbridgeRvcOperationalStateServer: goHome called setting operational state to Docked and currentMode to Idle');
-        this.agent.get(MatterbridgeRvcRunModeServer).state.currentMode = 1;
-        this.state.operationalState = RvcOperationalState.OperationalState.Docked;
-        this.state.operationalError = { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateLabel: 'No Error', errorStateDetails: 'Fully operational' };
-        return {
-            commandResponseState: { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' },
-        };
-    }
-}
-function createEndpointActionsClusterServer(endpoint, endpointLists) {
-    endpoint.behaviors.require(ActionsServer, {
-        actionList: [],
-        endpointLists,
-    });
-    return endpoint;
-}
-if (process.argv.includes('-testRobot')) {
-    const matterbridge = await Matterbridge.loadInstance(false);
-    matterbridge.log = new AnsiLogger({ logName: 'Matterbridge', logTimestampFormat: 4, logLevel: "debug" });
-    matterbridge.environment.vars.set('log.level', MatterLogLevel.DEBUG);
-    matterbridge.environment.vars.set('log.format', MatterLogFormat.ANSI);
-    matterbridge.environment.vars.set('path.root', 'matterstorage');
-    matterbridge.environment.vars.set('runtime.signals', true);
-    matterbridge.environment.vars.set('runtime.exitcode', true);
-    matterbridge.environment.vars.set('mdns.networkInterface', 'Wi-Fi');
-    await matterbridge.startMatterStorage();
-    const deviceType = dishwasher;
-    const context = await matterbridge.createServerNodeContext('Matterbridge', deviceType.name, DeviceTypeId(deviceType.code), VendorId(0xfff1), 'Matterbridge', 0x8000, 'Matterbridge device');
-    const server = (await matterbridge.createServerNode(context));
-}