matterbridge-example-dynamic-platform 1.2.3-rc.1 → 1.2.4-dev-20250612-b04ef65

package/CHANGELOG.md

@@ -8,15 +8,28 @@ 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
+
+### Changed
+
+- [package]: Require matterbridge 3.0.6.
+- [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.3] - 2025-05-25
 
 ### Added
 
 - [platform]: Added a cover device with both lift and tilt (supported by the Home app).
+- [platform]: Added evse (EV charger) device type (not supported by the Home app).
 
 ### Changed
 
-- [package]: Require matterbridge 3.0.4.
+- [package]: Require matterbridge 3.0.5.
 - [package]: Updated package.
 - [package]: Updated dependencies.
 

package/README.md

@@ -16,7 +16,7 @@
 
 Matterbridge dynamic platform example plugin is a template to develop your own plugin using the dynamic platform.
 
-It exposes 40 virtual devices:
+It exposes 41 virtual devices:
 
 - a switch with onOff cluster
 - a light with onOff
@@ -59,6 +59,7 @@ It exposes 40 virtual devices:
 - 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)
+- a car charger device (supported by 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/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

@@ -1,7 +1,7 @@
-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 { 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, Evse, } 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 { 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, } from 'matterbridge/matter/clusters';
 import { Appliances } from './appliances.js';
 export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatform {
     switch;
@@ -35,7 +35,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     momentarySwitch;
     latchingSwitch;
     vacuum;
-    heater;
+    waterHeater;
+    evse;
     switchInterval;
     lightInterval;
     outletInterval;
@@ -58,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.4')) {
-            throw new Error(`This plugin requires Matterbridge version >= "3.0.4". 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)
@@ -672,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);
             }
@@ -690,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);
@@ -791,6 +796,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);
@@ -818,11 +825,15 @@ 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 (context.offline === true)
+                return;
             if (isValidNumber(newValue, 0, 100))
                 this.fan?.setAttribute(FanControl.Cluster.id, 'speedCurrent', newValue, this.fan?.log);
         }, this.fan.log);
@@ -966,11 +977,22 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
                 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);
+        this.waterHeater = new WaterHeater('Water Heater', '3456177820');
+        this.setSelectDevice(this.waterHeater.serialNumber ?? '', this.waterHeater.deviceName ?? '', undefined, 'hub');
+        if (this.validateDevice(this.waterHeater.deviceName ?? '')) {
+            await this.registerDevice(this.waterHeater);
+            this.bridgedDevices.set(this.waterHeater.deviceName ?? '', this.waterHeater);
+        }
+        this.evse = new Evse('Evse', '3456127820', 1, [
+            { label: 'On demand', mode: 1, modeTags: [{ value: EnergyEvseMode.ModeTag.Manual }] },
+            { label: 'Scheduled', mode: 2, modeTags: [{ value: EnergyEvseMode.ModeTag.TimeOfUse }] },
+            { label: 'Solar Charging', mode: 3, modeTags: [{ value: EnergyEvseMode.ModeTag.SolarCharging }] },
+            { label: 'Solar Charging Scheduled', mode: 4, modeTags: [{ value: EnergyEvseMode.ModeTag.SolarCharging }, { value: EnergyEvseMode.ModeTag.TimeOfUse }] },
+        ]);
+        this.setSelectDevice(this.evse.serialNumber ?? '', this.evse.deviceName ?? '', undefined, 'hub');
+        if (this.validateDevice(this.evse.deviceName ?? '')) {
+            await this.registerDevice(this.evse);
+            this.bridgedDevices.set(this.evse.deviceName ?? '', this.evse);
         }
         const laundryWasherDevice = new Appliances(laundryWasher, 'Laundry Washer', '1234567890');
         this.setSelectDevice(laundryWasherDevice.serialNumber ?? '', laundryWasherDevice.deviceName ?? '', undefined, 'hub');

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "1.2.3-rc.1",
+  "version": "1.2.4-dev-20250612-b04ef65",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-example-dynamic-platform",
-      "version": "1.2.3-rc.1",
+      "version": "1.2.4-dev-20250612-b04ef65",
       "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-rc.1",
+  "version": "1.2.4-dev-20250612-b04ef65",
   "description": "Matterbridge dynamic plugin",
   "author": "https://github.com/Luligu",
   "license": "MIT",