matterbridge-example-dynamic-platform 1.3.0 → 1.3.1-dev-20250702-0cbab25

package/CHANGELOG.md

@@ -23,6 +23,22 @@ 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.1] - 2025-06-??
+
+### Added
+
+- [platform]: Added solarPower device type (not supported by the Home app).
+- [platform]: Added batteryStoraga device type (not supported by the Home app).
+
+### Changed
+
+- [platform]: Changed imports from matterbridge/devices.
+- [package]: Require matterbridge 3.1.1.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
 ## [1.3.0] - 2025-06-25
 
 ### Added

package/README.md

@@ -17,7 +17,7 @@
 
 Matterbridge dynamic platform example plugin is a template to develop your own plugin using the dynamic platform.
 
-It exposes 41 virtual devices:
+It exposes 44 virtual devices:
 
 - a switch with onOff cluster
 - a light with onOff
@@ -61,6 +61,9 @@ It exposes 41 virtual devices:
 - 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)
+- a solar power device
+- a battery storage device
+- a heat pump device
 
 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,4 +1,5 @@
-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 { 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, HeatPump, } from 'matterbridge';
+import { RoboticVacuumCleaner, LaundryWasher, WaterHeater, Evse, SolarPower, BatteryStorage, LaundryDryer } 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';
@@ -37,6 +38,11 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     vacuum;
     waterHeater;
     evse;
+    laundryWasher;
+    laundryDryer;
+    solarPower;
+    batteryStorage;
+    heatPump;
     switchInterval;
     lightInterval;
     outletInterval;
@@ -59,8 +65,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.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.`);
+        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.1.1')) {
+            throw new Error(`This plugin requires Matterbridge version >= "3.1.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)
@@ -992,75 +998,93 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             this.latchingSwitch = undefined;
         }
         if (this.config.enableRVC === true) {
-            const robot = new RoboticVacuumCleaner('Robot Vacuum', '1238777820');
+            const robot = new RoboticVacuumCleaner('Robot Vacuum', 'RVC1238777820');
             this.setSelectDevice(robot.serialNumber ?? '', robot.deviceName ?? '', undefined, 'hub');
             if (this.validateDevice(robot.deviceName ?? '')) {
                 await this.registerDevice(robot);
                 this.bridgedDevices.set(robot.deviceName ?? '', robot);
             }
         }
-        this.waterHeater = new WaterHeater('Water Heater', '3456177820');
+        this.waterHeater = new WaterHeater('Water Heater', 'WH3456177820', 50, 60, 20, 80, undefined, 85, 220_000, 1_000, 220_000, 12_000_000, 500_000, 3_000_000);
         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, [
+        this.evse = new Evse('Evse', 'EV3456127820', 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 }] },
-        ], EnergyEvse.State.PluggedInDemand, EnergyEvse.SupplyState.ChargingEnabled, EnergyEvse.FaultState.NoError, 8_000, 32_000);
+        ], EnergyEvse.State.PluggedInCharging, EnergyEvse.SupplyState.ChargingEnabled, EnergyEvse.FaultState.NoError, 220_000, 10_000, 2_200_000, 1_000_000, 500_000, 32_000_000);
         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');
-        if (this.validateDevice(laundryWasherDevice.deviceName ?? '')) {
-            await this.registerDevice(laundryWasherDevice);
-            this.bridgedDevices.set(laundryWasherDevice.deviceName ?? '', laundryWasherDevice);
-        }
-        const laundryDryerDevice = new Appliances(laundryDryer, 'Laundry Dryer', '1235227890');
-        this.setSelectDevice(laundryDryerDevice.serialNumber ?? '', laundryDryerDevice.deviceName ?? '', undefined, 'hub');
-        if (this.validateDevice(laundryDryerDevice.deviceName ?? '')) {
-            await this.registerDevice(laundryDryerDevice);
-            this.bridgedDevices.set(laundryDryerDevice.deviceName ?? '', laundryDryerDevice);
-        }
-        const dishwasherDevice = new Appliances(dishwasher, 'Dishwasher', '0987654321');
+        this.solarPower = new SolarPower('Solar Power', 'SP3456127821', 220_000, 10_000, 2200_000, 2_200_000, -10_000_000, 500_000);
+        this.setSelectDevice(this.solarPower.serialNumber ?? '', this.solarPower.deviceName ?? '', undefined, 'hub');
+        if (this.validateDevice(this.solarPower.deviceName ?? '')) {
+            await this.registerDevice(this.solarPower);
+            this.bridgedDevices.set(this.solarPower.deviceName ?? '', this.solarPower);
+        }
+        this.batteryStorage = new BatteryStorage('Battery Storage', 'BS3456127822', 75, PowerSource.BatChargeLevel.Ok, 220_000, 10_000, 2_200_000, 1_000_000, 2_000_000, -2_000_000, 3_000_000);
+        this.setSelectDevice(this.batteryStorage.serialNumber ?? '', this.batteryStorage.deviceName ?? '', undefined, 'hub');
+        if (this.validateDevice(this.batteryStorage.deviceName ?? '')) {
+            await this.registerDevice(this.batteryStorage);
+            this.bridgedDevices.set(this.batteryStorage.deviceName ?? '', this.batteryStorage);
+        }
+        this.heatPump = new HeatPump('Heat Pump', 'HP1234567890', 220_000, 10_000, 2_200_000, 1_000_000, 500_000, 3_000_000);
+        this.setSelectDevice(this.heatPump.serialNumber ?? '', this.heatPump.deviceName ?? '', undefined, 'hub');
+        if (this.validateDevice(this.heatPump.deviceName ?? '')) {
+            await this.registerDevice(this.heatPump);
+            this.bridgedDevices.set(this.heatPump.deviceName ?? '', this.heatPump);
+        }
+        this.laundryWasher = new LaundryWasher('Laundry Washer', 'LW1234567890');
+        this.setSelectDevice(this.laundryWasher.serialNumber ?? '', this.laundryWasher.deviceName ?? '', undefined, 'hub');
+        if (this.validateDevice(this.laundryWasher.deviceName ?? '')) {
+            await this.registerDevice(this.laundryWasher);
+            this.bridgedDevices.set(this.laundryWasher.deviceName ?? '', this.laundryWasher);
+        }
+        this.laundryDryer = new LaundryDryer('Laundry Dryer', 'LDW1235227890');
+        this.setSelectDevice(this.laundryDryer.serialNumber ?? '', this.laundryDryer.deviceName ?? '', undefined, 'hub');
+        if (this.validateDevice(this.laundryDryer.deviceName ?? '')) {
+            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);
         }
-        const refrigeratorDevice = new Appliances(refrigerator, 'Refrigerator', '9987654322');
+        const refrigeratorDevice = new Appliances(refrigerator, 'Refrigerator', 'RE9987654322');
         refrigeratorDevice.addFixedLabel('composed', 'Refrigerator');
         this.setSelectDevice(refrigeratorDevice.serialNumber ?? '', refrigeratorDevice.deviceName ?? '', undefined, 'hub');
         if (this.validateDevice(refrigeratorDevice.deviceName ?? '')) {
             await this.registerDevice(refrigeratorDevice);
             this.bridgedDevices.set(refrigeratorDevice.deviceName ?? '', refrigeratorDevice);
         }
-        const ovenDevice = new Appliances(oven, 'Oven', '1298867891');
+        const ovenDevice = new Appliances(oven, 'Oven', 'OV1298867891');
         ovenDevice.addFixedLabel('composed', 'Oven');
         this.setSelectDevice(ovenDevice.serialNumber ?? '', ovenDevice.deviceName ?? '', undefined, 'hub');
         if (this.validateDevice(ovenDevice.deviceName ?? '')) {
             await this.registerDevice(ovenDevice);
             this.bridgedDevices.set(ovenDevice.deviceName ?? '', ovenDevice);
         }
-        const microwaveOvenDevice = new Appliances(microwaveOven, 'Microwave Oven', '1234567892');
+        const microwaveOvenDevice = new Appliances(microwaveOven, 'Microwave Oven', 'MO1234567892');
         this.setSelectDevice(microwaveOvenDevice.serialNumber ?? '', microwaveOvenDevice.deviceName ?? '', undefined, 'hub');
         if (this.validateDevice(microwaveOvenDevice.deviceName ?? '')) {
             await this.registerDevice(microwaveOvenDevice);
             this.bridgedDevices.set(microwaveOvenDevice.deviceName ?? '', microwaveOvenDevice);
         }
-        const extractorHoodDevice = new Appliances(extractorHood, 'Extractor Hood', '1234567893');
+        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', '1255887894');
+        const cooktopDevice = new Appliances(cooktop, 'Cooktop', 'CT1255887894');
         this.setSelectDevice(cooktopDevice.serialNumber ?? '', cooktopDevice.deviceName ?? '', undefined, 'hub');
         if (this.validateDevice(cooktopDevice.deviceName ?? '')) {
             await this.registerDevice(cooktopDevice);

package/npm-shrinkwrap.json

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