matterbridge-example-dynamic-platform 1.3.9 → 1.3.10

package/CHANGELOG.md

@@ -23,6 +23,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.3.10] - 2025-09-06
+
+### Added
+
+- [platform]: Added AirConditioner device class from Matterbridge.
+- [platform]: Added a Speaker device type.
+- [platform]: Added estimatedEndTime to Rvc animation.
+
+### Changed
+
+- [package]: Updated dependencies.
+- [package]: Required matterbridge 3.2.6.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
 ## [1.3.9] - 2025-08-30
 
 ### Added

package/README.md

@@ -76,6 +76,7 @@ It exposes 56 virtual devices:
 - a solar power device
 - a battery storage device
 - a heat pump device
+- a speaker device (supported by SmartThings)
 
 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,5 +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, onOffMountedSwitch, dimmableMountedSwitch, extendedColorLight, pressureSensor, contactSensor, occupancySensor, lightSensor, modeSelect, } from 'matterbridge';
-import { RoboticVacuumCleaner, LaundryWasher, WaterHeater, Evse, SolarPower, BatteryStorage, LaundryDryer, HeatPump, Dishwasher, ExtractorHood, MicrowaveOven, Oven, Cooktop, Refrigerator, } 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, onOffMountedSwitch, dimmableMountedSwitch, extendedColorLight, pressureSensor, contactSensor, occupancySensor, lightSensor, modeSelect, } from 'matterbridge';
+import { RoboticVacuumCleaner, LaundryWasher, WaterHeater, Evse, SolarPower, BatteryStorage, LaundryDryer, HeatPump, Dishwasher, ExtractorHood, MicrowaveOven, Oven, Cooktop, Refrigerator, AirConditioner, Speaker, } from 'matterbridge/devices';
 import { isValidBoolean, isValidNumber, isValidObject, isValidString } from 'matterbridge/utils';
 import { debugStringify } from 'matterbridge/logger';
 import { AreaNamespaceTag, LocationTag, NumberTag, PositionTag, RefrigeratorTag, SwitchesTag, UINT16_MAX, UINT32_MAX } from 'matterbridge/matter';
@@ -56,7 +56,6 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     smokeOnly;
     coOnly;
     airQuality;
-    airConditioner;
     airPurifier;
     pump;
     valve;
@@ -77,6 +76,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     oven;
     cooktop;
     refrigerator;
+    airConditioner;
+    speaker;
     phaseInterval;
     phase = -1;
     sensorInterval;
@@ -103,8 +104,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     fanDirectionLookup = ['Forward', 'Reverse'];
     constructor(matterbridge, log, config) {
         super(matterbridge, log, config);
-        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.2.5')) {
-            throw new Error(`This plugin requires Matterbridge version >= "3.2.5". 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.2.6')) {
+            throw new Error(`This plugin requires Matterbridge version >= "3.2.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)
@@ -707,35 +708,6 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             if (isValidNumber(newValue, 0, 100))
                 this.airPurifier?.setAttribute(FanControl.Cluster.id, 'percentCurrent', newValue, this.airPurifier?.log);
         }, this.airPurifier.log);
-        this.airConditioner = new MatterbridgeEndpoint([airConditioner, bridgedNode, powerSource], { uniqueStorageKey: 'Air Conditioner' }, this.config.debug)
-            .createDefaultBridgedDeviceBasicInformationClusterServer('Air Conditioner', 'ACO00027', 0xfff1, 'Matterbridge', 'Matterbridge Air Conditioner')
-            .createDefaultIdentifyClusterServer()
-            .createDeadFrontOnOffClusterServer(true)
-            .createDefaultThermostatClusterServer(20, 18, 22)
-            .createDefaultThermostatUserInterfaceConfigurationClusterServer()
-            .createDefaultFanControlClusterServer(FanControl.FanMode.Auto)
-            .createDefaultTemperatureMeasurementClusterServer(20 * 100)
-            .createDefaultRelativeHumidityMeasurementClusterServer(50 * 100)
-            .createDefaultPowerSourceWiredClusterServer()
-            .addRequiredClusterServers();
-        this.airConditioner = await this.addDevice(this.airConditioner);
-        this.airConditioner?.addCommandHandler('identify', async ({ request: { identifyTime } }) => {
-            this.airConditioner?.log.info(`Command identify called identifyTime:${identifyTime}`);
-        });
-        this.airConditioner?.addCommandHandler('on', async () => {
-            this.airConditioner?.log.info('Command on called');
-            await this.airConditioner?.setAttribute(ThermostatCluster.id, 'localTemperature', 20 * 100, this.airConditioner?.log);
-            await this.airConditioner?.setAttribute(TemperatureMeasurement.Cluster.id, 'measuredValue', 20 * 100, this.airConditioner?.log);
-            await this.airConditioner?.setAttribute(RelativeHumidityMeasurementCluster.id, 'measuredValue', 50 * 100, this.airConditioner?.log);
-            await this.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentSetting', 50, this.airConditioner?.log);
-        });
-        this.airConditioner?.addCommandHandler('off', async () => {
-            this.airConditioner?.log.info('Command off called');
-            await this.airConditioner?.setAttribute(ThermostatCluster.id, 'localTemperature', null, this.airConditioner?.log);
-            await this.airConditioner?.setAttribute(TemperatureMeasurement.Cluster.id, 'measuredValue', null, this.airConditioner?.log);
-            await this.airConditioner?.setAttribute(RelativeHumidityMeasurementCluster.id, 'measuredValue', null, this.airConditioner?.log);
-            await this.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentSetting', null, this.airConditioner?.log);
-        });
         this.pump = new MatterbridgeEndpoint([pumpDevice, bridgedNode, powerSource], { uniqueStorageKey: 'Pump' }, this.config.debug)
             .createDefaultBridgedDeviceBasicInformationClusterServer('Pump', 'PUM00028', 0xfff1, 'Matterbridge', 'Matterbridge Pump')
             .createDefaultIdentifyClusterServer()
@@ -771,6 +743,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         this.fanDefault = new MatterbridgeEndpoint([fanDevice, bridgedNode, powerSource], { uniqueStorageKey: 'Fan off low medium high auto' }, this.config.debug)
             .createDefaultBridgedDeviceBasicInformationClusterServer('Fan', 'FAN00030', 0xfff1, 'Matterbridge', 'Matterbridge Fan')
             .createDefaultPowerSourceWiredClusterServer()
+            .createDefaultFanControlClusterServer()
             .addRequiredClusterServers();
         this.fanDefault = await this.addDevice(this.fanDefault);
         await this.fanDefault?.subscribeAttribute(FanControl.Cluster.id, 'fanMode', (newValue, oldValue, context) => {
@@ -1188,6 +1161,71 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             { label: 'RapidFreeze', mode: 2, modeTags: [{ value: RefrigeratorAndTemperatureControlledCabinetMode.ModeTag.RapidFreeze }] },
         ], undefined, undefined, -1000);
         this.refrigerator = (await this.addDevice(refrigerator));
+        this.airConditioner = new AirConditioner('Air Conditioner', 'ACO00027', {
+            localTemperature: 20,
+            occupiedCoolingSetpoint: 18,
+            occupiedHeatingSetpoint: 22,
+            fanMode: FanControl.FanMode.Auto,
+        })
+            .createDefaultTemperatureMeasurementClusterServer(20 * 100)
+            .createDefaultRelativeHumidityMeasurementClusterServer(50 * 100)
+            .addRequiredClusterServers();
+        this.airConditioner = await this.addDevice(this.airConditioner);
+        this.airConditioner?.addCommandHandler('identify', async ({ request: { identifyTime } }) => {
+            this.airConditioner?.log.info(`Command identify called identifyTime:${identifyTime}`);
+        });
+        this.airConditioner?.addCommandHandler('on', async () => {
+            this.airConditioner?.log.info('Command on called');
+            await this.airConditioner?.setAttribute(ThermostatCluster.id, 'localTemperature', 20 * 100, this.airConditioner?.log);
+            await this.airConditioner?.setAttribute(TemperatureMeasurement.Cluster.id, 'measuredValue', 20 * 100, this.airConditioner?.log);
+            await this.airConditioner?.setAttribute(RelativeHumidityMeasurementCluster.id, 'measuredValue', 50 * 100, this.airConditioner?.log);
+            await this.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentSetting', 50, this.airConditioner?.log);
+        });
+        this.airConditioner?.addCommandHandler('off', async () => {
+            this.airConditioner?.log.info('Command off called');
+            await this.airConditioner?.setAttribute(ThermostatCluster.id, 'localTemperature', null, this.airConditioner?.log);
+            await this.airConditioner?.setAttribute(TemperatureMeasurement.Cluster.id, 'measuredValue', null, this.airConditioner?.log);
+            await this.airConditioner?.setAttribute(RelativeHumidityMeasurementCluster.id, 'measuredValue', null, this.airConditioner?.log);
+            await this.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentSetting', null, this.airConditioner?.log);
+        });
+        await this.airConditioner?.subscribeAttribute(FanControl.Cluster.id, 'fanMode', (newValue, oldValue, context) => {
+            this.airConditioner?.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.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentSetting', 0, this.airConditioner?.log);
+                this.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 0, this.airConditioner?.log);
+            }
+            else if (newValue === FanControl.FanMode.Low) {
+                this.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentSetting', 33, this.airConditioner?.log);
+                this.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 33, this.airConditioner?.log);
+            }
+            else if (newValue === FanControl.FanMode.Medium) {
+                this.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentSetting', 66, this.airConditioner?.log);
+                this.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 66, this.airConditioner?.log);
+            }
+            else if (newValue === FanControl.FanMode.High) {
+                this.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentSetting', 100, this.airConditioner?.log);
+                this.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 100, this.airConditioner?.log);
+            }
+            else if (newValue === FanControl.FanMode.On) {
+                this.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentSetting', 100, this.airConditioner?.log);
+                this.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 100, this.airConditioner?.log);
+            }
+            else if (newValue === FanControl.FanMode.Auto) {
+                this.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentSetting', 50, this.airConditioner?.log);
+                this.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentCurrent', 50, this.airConditioner?.log);
+            }
+        }, this.airConditioner?.log);
+        await this.airConditioner?.subscribeAttribute(FanControl.Cluster.id, 'percentSetting', (newValue, oldValue, context) => {
+            this.airConditioner?.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.airConditioner?.setAttribute(FanControl.Cluster.id, 'percentCurrent', newValue, this.airConditioner?.log);
+        }, this.airConditioner?.log);
+        this.speaker = new Speaker('Speaker', 'SPE00057', false, 100);
+        this.speaker = (await this.addDevice(this.speaker));
     }
     async onConfigure() {
         await super.onConfigure();
@@ -1203,7 +1241,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
                     await this.laundryWasher?.setAttribute(OnOff.Cluster.id, 'onOff', true, this.laundryWasher.log);
                     await this.laundryDryer?.setAttribute(OnOff.Cluster.id, 'onOff', true, this.laundryDryer.log);
                     await this.dishwasher?.setAttribute(OnOff.Cluster.id, 'onOff', true, this.dishwasher.log);
-                    this.cooktop?.log.info(`Set Cooktop offOnly onOff clusters to on`);
+                    this.cooktop?.log.info(`Set Cooktop offOnly onOff clusters to true`);
                     await this.cooktop?.setAttribute(OnOff.Cluster.id, 'onOff', true, this.cooktop.log);
                     await this.cooktop?.getChildEndpointByName('SurfaceTopLeft')?.setAttribute(OnOff.Cluster.id, 'onOff', true, this.cooktop?.log);
                     await this.cooktop?.getChildEndpointByName('SurfaceTopRight')?.setAttribute(OnOff.Cluster.id, 'onOff', true, this.cooktop?.log);
@@ -1225,6 +1263,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
                         await this.roboticVacuum.setAttribute('RvcRunMode', 'currentMode', 2, this.roboticVacuum.log);
                         await this.roboticVacuum.setAttribute('RvcOperationalState', 'operationalState', RvcOperationalState.OperationalState.Running, this.roboticVacuum.log);
                         await this.roboticVacuum.setAttribute('ServiceArea', 'currentArea', 1, this.roboticVacuum.log);
+                        await this.roboticVacuum.setAttribute('ServiceArea', 'estimatedEndTime', Math.floor(Date.now() / 1000) + 300, this.roboticVacuum.log);
                     }
                     if (this.phase === 2) {
                         this.roboticVacuum.log.info(`RVC: pause cleaning...`);
@@ -1237,12 +1276,14 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
                         await this.roboticVacuum.setAttribute('RvcRunMode', 'currentMode', 2, this.roboticVacuum.log);
                         await this.roboticVacuum.setAttribute('RvcOperationalState', 'operationalState', RvcOperationalState.OperationalState.Running, this.roboticVacuum.log);
                         await this.roboticVacuum.setAttribute('ServiceArea', 'currentArea', 2, this.roboticVacuum.log);
+                        await this.roboticVacuum.setAttribute('ServiceArea', 'estimatedEndTime', Math.floor(Date.now() / 1000) + 180, this.roboticVacuum.log);
                     }
                     if (this.phase === 4) {
                         this.roboticVacuum.log.info(`RVC: stop cleaning...`);
                         await this.roboticVacuum.setAttribute('PowerSource', 'batPercentRemaining', 160, this.roboticVacuum.log);
                         await this.roboticVacuum.setAttribute('RvcRunMode', 'currentMode', 1, this.roboticVacuum.log);
                         await this.roboticVacuum.setAttribute('RvcOperationalState', 'operationalState', RvcOperationalState.OperationalState.Stopped, this.roboticVacuum.log);
+                        await this.roboticVacuum.setAttribute('ServiceArea', 'estimatedEndTime', 0, this.roboticVacuum.log);
                     }
                     if (this.phase === 5) {
                         this.roboticVacuum.log.info(`RVC: going home...`);

package/npm-shrinkwrap.json

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