matterbridge-example-dynamic-platform 3.0.2-dev-20260718-b033810 → 3.0.2-dev-20260719-bbce2ee

package/CHANGELOG.md

@@ -31,7 +31,11 @@ If you like this project and find it useful, please consider giving it a star on
 
 ### Breaking changes
 
-- [matterbridge]: Require matterbridge v.3.10.0 with matter v.1.6.0 and matter.js v.0.17.5.
+- [matterbridge]: Require matterbridge v.3.10.1 with matter v.1.6.0 and matter.js v.0.17.6.
+
+### Added
+
+- [platform]: Add `closureGarageDoor` device.
 
 <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
 

package/README.md

@@ -23,7 +23,7 @@
 
 Matterbridge dynamic platform example plugin is a template to develop your own plugin using the dynamic platform.
 
-It exposes 70 virtual devices:
+It exposes 71 virtual devices:
 
 - a door contact sensor
 - a motion sensor
@@ -95,6 +95,7 @@ It exposes 70 virtual devices:
 - a soil sensor (Matter 1.5.0)
 - an irrigation system (Matter 1.5.0)
 - an irrigation system with four zones (Matter 1.5.0)
+- a closure device (Matter 1.5.0, supported by SmartThings)
 
 All these devices continuously change their state and position. The plugin also shows how to use all the command handlers (so you can control all the devices), how to subscribe to attributes, and how to trigger events.
 

package/dist/module.js

@@ -1,8 +1,8 @@
 import { aggregator, airPurifier, airQualitySensor, bridgedNode, colorTemperatureLight, contactSensor, windowCovering, dimmableLight, mountedDimmableLoadControl, dimmablePlugInUnit, doorLock, electricalSensor, extendedColorLight, fan, flowSensor, genericSwitch, getSemtag, humiditySensor, lightSensor, MatterbridgeDynamicPlatform, MatterbridgeEndpoint, modeSelect, occupancySensor, onOffLight, mountedOnOffControl, onOffPlugInUnit, onOffLightSwitch, powerSource, pressureSensor, pump, rainSensor, smokeCoAlarm, temperatureSensor, thermostat, waterFreezeDetector, waterLeakDetector, waterValve, } from 'matterbridge';
-import { AirConditioner, BasicVideoPlayer, BatteryStorage, Cooktop, Dishwasher, Evse, ExtractorHood, HeatPump, IrrigationSystem, LaundryDryer, LaundryWasher, MicrowaveOven, Oven, Refrigerator, RoboticVacuumCleaner, SoilSensor, SolarPower, Speaker, WaterHeater, } from 'matterbridge/devices';
+import { AirConditioner, BasicVideoPlayer, BatteryStorage, Closure, Cooktop, Dishwasher, Evse, ExtractorHood, HeatPump, IrrigationSystem, LaundryDryer, LaundryWasher, MicrowaveOven, Oven, Refrigerator, RoboticVacuumCleaner, SoilSensor, SolarPower, Speaker, WaterHeater, } from 'matterbridge/devices';
 import { debugStringify } from 'matterbridge/logger';
-import { CommonAreaNamespaceTag, CommonLocationTag, CommonNumberTag, CommonPositionTag, RefrigeratorTag, SwitchesTag, UINT16_MAX, UINT32_MAX } from 'matterbridge/matter';
-import { AirQuality, BooleanState, BridgedDeviceBasicInformation, CarbonDioxideConcentrationMeasurement, CarbonMonoxideConcentrationMeasurement, ColorControl, Descriptor, DeviceEnergyManagement, DoorLock, ElectricalEnergyMeasurement, ElectricalPowerMeasurement, EnergyEvse, EnergyEvseMode, FanControl, FlowMeasurement, FormaldehydeConcentrationMeasurement, Identify, IlluminanceMeasurement, LevelControl, NitrogenDioxideConcentrationMeasurement, OccupancySensing, OnOff, OperationalState, OvenMode, OzoneConcentrationMeasurement, Pm1ConcentrationMeasurement, Pm10ConcentrationMeasurement, Pm25ConcentrationMeasurement, PowerSource, PressureMeasurement, RadonConcentrationMeasurement, RelativeHumidityMeasurement, RvcCleanMode, RvcOperationalState, RvcRunMode, SmokeCoAlarm, TemperatureMeasurement, Thermostat, TotalVolatileOrganicCompoundsConcentrationMeasurement, WindowCovering, } from 'matterbridge/matter/clusters';
+import { ClosureTag, CommonAreaNamespaceTag, CommonLocationTag, CommonNumberTag, CommonPositionTag, RefrigeratorTag, SwitchesTag, UINT16_MAX, UINT32_MAX, } from 'matterbridge/matter';
+import { AirQuality, BooleanState, BridgedDeviceBasicInformation, CarbonDioxideConcentrationMeasurement, CarbonMonoxideConcentrationMeasurement, ClosureControl, ColorControl, Descriptor, DeviceEnergyManagement, DoorLock, ElectricalEnergyMeasurement, ElectricalPowerMeasurement, EnergyEvse, EnergyEvseMode, FanControl, FlowMeasurement, FormaldehydeConcentrationMeasurement, Identify, IlluminanceMeasurement, LevelControl, NitrogenDioxideConcentrationMeasurement, OccupancySensing, OnOff, OperationalState, OvenMode, OzoneConcentrationMeasurement, Pm1ConcentrationMeasurement, Pm10ConcentrationMeasurement, Pm25ConcentrationMeasurement, PowerSource, PressureMeasurement, RadonConcentrationMeasurement, RelativeHumidityMeasurement, RvcCleanMode, RvcOperationalState, RvcRunMode, SmokeCoAlarm, TemperatureMeasurement, Thermostat, TotalVolatileOrganicCompoundsConcentrationMeasurement, WindowCovering, } from 'matterbridge/matter/clusters';
 import { fireAndForget, getEnumDescription, isValidBoolean, isValidNumber, isValidObject, isValidString } from 'matterbridge/utils';
 function luxToMatter(lux) {
     if (!Number.isFinite(lux) || lux <= 0)
@@ -34,6 +34,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     soil;
     irrigation;
     irrigationSystem;
+    closureGarageDoor;
     select;
     climate;
     switch;
@@ -106,8 +107,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
     constructor(matterbridge, log, config) {
         super(matterbridge, log, config);
         this.config = config;
-        if (typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.10.0')) {
-            throw new Error(`This plugin requires Matterbridge version >= "3.10.0". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend.`);
+        if (typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.10.1')) {
+            throw new Error(`This plugin requires Matterbridge version >= "3.10.1". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend.`);
         }
         this.log.info('Initializing platform:', this.config.name);
     }
@@ -174,6 +175,30 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             .addZone(CommonNumberTag.Three)
             .addZone(CommonNumberTag.Four);
         this.irrigationSystem = (await this.addDevice(this.irrigationSystem));
+        this.closureGarageDoor = new Closure('Garage Door', 'GAR000071', {
+            tagList: [getSemtag(ClosureTag.GarageDoor)],
+        });
+        this.closureGarageDoor = (await this.addDevice(this.closureGarageDoor));
+        this.closureGarageDoor?.addCommandHandler('ClosureControl.moveTo', ({ request: { position, latch, speed } }) => {
+            this.closureGarageDoor?.log.info(`Command moveTo called position:${position} latch:${latch} speed:${speed}`);
+            const currentStateTimeout = setTimeout(() => {
+                const targetState = this.closureGarageDoor?.getAttribute(ClosureControl.id, 'overallTargetState');
+                const currentState = this.closureGarageDoor?.getAttribute(ClosureControl.id, 'overallCurrentState');
+                if (targetState === undefined || targetState === null)
+                    return;
+                void this.closureGarageDoor?.setAttribute(ClosureControl.id, 'mainState', ClosureControl.MainState.Stopped, this.closureGarageDoor.log);
+                void this.closureGarageDoor?.setAttribute(ClosureControl.id, 'overallCurrentState', {
+                    position: targetState.position,
+                    latch: targetState.latch,
+                    speed: targetState.speed,
+                    secureState: targetState.position === ClosureControl.TargetPosition.MoveToFullyClosed ? true : (currentState?.secureState ?? false),
+                }, this.closureGarageDoor.log);
+            }, 1000);
+            currentStateTimeout.unref();
+        });
+        this.closureGarageDoor?.addCommandHandler('ClosureControl.stop', () => {
+            this.closureGarageDoor?.log.info('Command stop called');
+        });
         this.climate = new MatterbridgeEndpoint([bridgedNode, powerSource], { id: 'Climate' }, this.config.debug)
             .createDefaultBridgedDeviceBasicInformationClusterServer('Climate', 'CLI00008', 0xfff1, 'Matterbridge', 'Matterbridge Climate')
             .createDefaultPowerSourceReplaceableBatteryClusterServer(90, PowerSource.BatChargeLevel.Ok, 2990, '2 x AA', 2, PowerSource.BatReplaceability.UserReplaceable)

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "3.0.2-dev-20260718-b033810",
+  "version": "3.0.2-dev-20260719-bbce2ee",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-example-dynamic-platform",
-      "version": "3.0.2-dev-20260718-b033810",
+      "version": "3.0.2-dev-20260719-bbce2ee",
       "license": "Apache-2.0",
       "dependencies": {
         "node-ansi-logger": "3.3.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "3.0.2-dev-20260718-b033810",
+  "version": "3.0.2-dev-20260719-bbce2ee",
   "description": "Matterbridge dynamic plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",