matterbridge-example-dynamic-platform 3.0.3 → 3.0.4-dev-20260901-796d818

package/CHANGELOG.md

@@ -29,6 +29,14 @@ If you like this project and find it useful, please consider giving it a star on
 
 <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="120"></a>
 
+## [3.0.4] - Dev branch
+
+### Breaking changes
+
+- [matterbridge]: Require matterbridge v.3.10.8 with matter v.1.6.0.
+
+<a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
+
 ## [3.0.3] - 2026-08-30
 
 ### Breaking changes

package/dist/module.js

@@ -1,22 +1,9 @@
-import { aggregator, airPurifier, airQualitySensor, bridgedNode, closure, 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, Closure, Cooktop, Dishwasher, Evse, ExtractorHood, HeatPump, IrrigationSystem, LaundryDryer, LaundryWasher, MatterbridgeClosureControlServer, MicrowaveOven, Oven, Refrigerator, RoboticVacuumCleaner, SoilSensor, SolarPower, Speaker, WaterHeater, } from 'matterbridge/devices';
+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, 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 { ClosureCoveringTag, ClosurePanelTag, ClosureTag, ClosureWindowTag, CommonAreaNamespaceTag, CommonLocationTag, CommonNumberTag, CommonPositionTag, RefrigeratorTag, SwitchesTag, UINT16_MAX, UINT32_MAX, } from 'matterbridge/matter';
 import { AirQuality, BooleanState, BridgedDeviceBasicInformation, CarbonDioxideConcentrationMeasurement, CarbonMonoxideConcentrationMeasurement, ClosureControl, ClosureDimension, ColorControl, 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 { ThreeLevelAuto } from 'matterbridge/matter/types';
-import { fireAndForget, getEnumDescription, isValidBoolean, isValidNumber, isValidObject, isValidString, parseVersionString } from 'matterbridge/utils';
-function luxToMatter(lux) {
-    if (!Number.isFinite(lux) || lux < 1)
-        return 0;
-    const encoded = Math.round(10000 * Math.log10(lux) + 1);
-    return Math.min(encoded, 0xfffe);
-}
-function matterToLux(value) {
-    if (!Number.isFinite(value) || value <= 0)
-        return 0;
-    const v = Math.min(value, 0xfffe);
-    return Math.round(Math.pow(10, (v - 1) / 10000));
-}
+import { fireAndForget, getEnumDescription, isValidBoolean, isValidNumber, isValidObject, isValidString, luxToMatter, matterToLux, parseVersionString } from 'matterbridge/utils';
 export default function initializePlugin(matterbridge, log, config) {
     return new ExampleMatterbridgeDynamicPlatform(matterbridge, log, config);
 }
@@ -110,8 +97,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.7')) {
-            throw new Error(`This plugin requires Matterbridge version >= "3.10.7". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend.`);
+        if (typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.10.8')) {
+            throw new Error(`This plugin requires Matterbridge version >= "3.10.8". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend.`);
         }
         this.log.info('Initializing platform:', this.config.name);
     }
@@ -180,41 +167,42 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         this.irrigationSystem = await this.addDevice(this.irrigationSystem);
         this.closureGarageDoor = new Closure('Garage Door', 'GAR000071', {
             tagList: [getSemtag(ClosureTag.GarageDoor)],
+            movementDuration: 2000,
         });
         this.closureGarageDoor = await this.addDevice(this.closureGarageDoor);
-        let closureGarageDoorMoveTimeout;
-        function closureTargetToCurrentPosition(position) {
-            if (position === ClosureControl.TargetPosition.MoveToFullyClosed)
-                return ClosureControl.CurrentPosition.FullyClosed;
-            if (position === ClosureControl.TargetPosition.MoveToFullyOpen)
-                return ClosureControl.CurrentPosition.FullyOpened;
-            if (position === ClosureControl.TargetPosition.MoveToPedestrianPosition)
-                return ClosureControl.CurrentPosition.OpenedForPedestrian;
-            if (position === ClosureControl.TargetPosition.MoveToVentilationPosition)
-                return ClosureControl.CurrentPosition.OpenedForVentilation;
-            return ClosureControl.CurrentPosition.OpenedAtSignature;
-        }
-        this.closureGarageDoor?.addCommandHandler('ClosureControl.moveTo', ({ request: { position, latch, speed }, attributes }) => {
+        this.closureGarageDoor?.addCommandHandler('ClosureControl.moveTo', ({ request: { position, latch, speed } }) => {
             this.closureGarageDoor?.log.info(`Command moveTo called position:${position} latch:${latch} speed:${speed}`);
-            attributes.countdownTime = 1;
-            closureGarageDoorMoveTimeout = setTimeout(() => {
-                const targetState = this.closureGarageDoor?.getAttribute(ClosureControl, 'overallTargetState');
-                if (targetState === undefined || targetState === null || targetState.position === undefined || targetState.position === null)
-                    return;
-                void this.closureGarageDoor?.setState({
-                    position: closureTargetToCurrentPosition(targetState.position),
-                    latch: targetState.latch,
-                    speed: targetState.speed,
-                    secureState: targetState.position === ClosureControl.TargetPosition.MoveToFullyClosed && targetState.latch === true,
-                }, targetState, ClosureControl.MainState.Stopped, 0, []);
-                void this.closureGarageDoor?.triggerMovementCompleted();
-            }, 1000).unref();
         });
-        this.closureGarageDoor?.addCommandHandler('ClosureControl.stop', ({ attributes }) => {
+        this.closureGarageDoor?.addCommandHandler('ClosureControl.stop', () => {
             this.closureGarageDoor?.log.info('Command stop called');
-            attributes.countdownTime = 0;
-            clearTimeout(closureGarageDoorMoveTimeout);
-            closureGarageDoorMoveTimeout = undefined;
+        });
+        this.closureSlidingGate = new Closure('Sliding Gate', 'GAT000073', {
+            tagList: [getSemtag(ClosureTag.Gate)],
+            movementDuration: 2000,
+            motionLatching: true,
+            speed: true,
+            pedestrian: true,
+        });
+        this.closureSlidingGate = await this.addDevice(this.closureSlidingGate);
+        this.closureSlidingGate?.addCommandHandler('ClosureControl.moveTo', ({ request: { position, latch, speed } }) => {
+            this.closureSlidingGate?.log.info(`Command moveTo called position:${position} latch:${latch} speed:${speed}`);
+        });
+        this.closureSlidingGate?.addCommandHandler('ClosureControl.stop', () => {
+            this.closureSlidingGate?.log.info('Command stop called');
+        });
+        this.closureRoofWindow = new Closure('Roof Window', 'ROO000074', {
+            tagList: [getSemtag(ClosureTag.Window), getSemtag(ClosureWindowTag.Roof)],
+            movementDuration: 2000,
+            motionLatching: true,
+            speed: true,
+            ventilation: true,
+        });
+        this.closureRoofWindow = await this.addDevice(this.closureRoofWindow);
+        this.closureRoofWindow?.addCommandHandler('ClosureControl.moveTo', ({ request: { position, latch, speed } }) => {
+            this.closureRoofWindow?.log.info(`Command moveTo called position:${position} latch:${latch} speed:${speed}`);
+        });
+        this.closureRoofWindow?.addCommandHandler('ClosureControl.stop', () => {
+            this.closureRoofWindow?.log.info('Command stop called');
         });
         this.closureVenetianBlind = new Closure('Venetian Blind', 'VEN000072', {
             tagList: [getSemtag(ClosureTag.Covering), getSemtag(ClosureCoveringTag.Venetian)],
@@ -222,13 +210,6 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         const closureVenetianBlindLift = this.closureVenetianBlind.addPanel('Lift', [getSemtag(ClosurePanelTag.Lift)], 'lift');
         const closureVenetianBlindTilt = this.closureVenetianBlind.addPanel('Tilt', [getSemtag(ClosurePanelTag.Tilt)], 'tilt');
         this.closureVenetianBlind = await this.addDevice(this.closureVenetianBlind);
-        const closurePanelTargetPercent = (position) => {
-            if (position === ClosureControl.TargetPosition.MoveToFullyOpen)
-                return 0;
-            if (position === ClosureControl.TargetPosition.MoveToFullyClosed)
-                return 10000;
-            return 5000;
-        };
         const closurePanelReachTimeouts = new Map();
         let closureVenetianBlindMoveTimeout;
         const clearClosureVenetianBlindTimeouts = () => {
@@ -253,7 +234,7 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
                     ? ClosureControl.CurrentPosition.FullyClosed
                     : ClosureControl.CurrentPosition.PartiallyOpened;
             void this.closureVenetianBlind?.setAttribute(ClosureControl, 'mainState', ClosureControl.MainState.Stopped, this.closureVenetianBlind.log);
-            void this.closureVenetianBlind?.setAttribute(ClosureControl, 'overallCurrentState', { position: overallPosition, latch: liftCurrent.latch ?? true, speed: liftCurrent.speed, secureState: liftCurrent.position === 10000 && liftCurrent.latch === true }, this.closureVenetianBlind?.log);
+            void this.closureVenetianBlind?.setAttribute(ClosureControl, 'overallCurrentState', { position: overallPosition, secureState: liftCurrent.position === 10000 }, this.closureVenetianBlind?.log);
         };
         const simulateClosurePanelReachingTarget = (panel) => {
             clearTimeout(closurePanelReachTimeouts.get(panel));
@@ -268,8 +249,8 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             }, 1000).unref();
             closurePanelReachTimeouts.set(panel, currentStateTimeout);
         };
-        const moveClosurePanelTo = (panel, position, latch, speed) => {
-            void panel.setAttribute(ClosureDimension, 'targetState', { position, latch: latch ?? true, speed }, panel.log);
+        const moveClosurePanelTo = (panel, position) => {
+            void panel.setAttribute(ClosureDimension, 'targetState', { position }, panel.log);
             simulateClosurePanelReachingTarget(panel);
         };
         this.closureVenetianBlind?.addCommandHandler('ClosureControl.moveTo', ({ request: { position, latch, speed }, attributes }) => {
@@ -282,9 +263,11 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
                 const targetState = this.closureVenetianBlind?.getAttribute(ClosureControl, 'overallTargetState');
                 if (targetState === undefined || targetState === null || targetState.position === undefined || targetState.position === null)
                     return;
-                const panelPercent = closurePanelTargetPercent(targetState.position);
-                moveClosurePanelTo(closureVenetianBlindLift, panelPercent, targetState.latch, targetState.speed);
-                moveClosurePanelTo(closureVenetianBlindTilt, panelPercent, targetState.latch, targetState.speed);
+                const panelPercent = this.closureVenetianBlind?.targetPositionToTargetPercent(targetState.position);
+                if (panelPercent === undefined)
+                    return;
+                moveClosurePanelTo(closureVenetianBlindLift, panelPercent);
+                moveClosurePanelTo(closureVenetianBlindTilt, panelPercent);
             }, 1000).unref();
         });
         this.closureVenetianBlind?.addCommandHandler('ClosureControl.stop', () => {
@@ -307,96 +290,6 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
         };
         addClosurePanelStepSimulation(closureVenetianBlindLift);
         addClosurePanelStepSimulation(closureVenetianBlindTilt);
-        this.closureSlidingGate = new MatterbridgeEndpoint([closure, powerSource], {
-            id: 'SlidingGate-GAT000073',
-            tagList: [getSemtag(ClosureTag.Gate)],
-        }, this.config.debug)
-            .createDefaultIdentifyClusterServer()
-            .createDefaultBasicInformationClusterServer('Sliding Gate', 'GAT000073', 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge Closure')
-            .createDefaultPowerSourceWiredClusterServer();
-        this.closureSlidingGate.behaviors.require(MatterbridgeClosureControlServer.with(ClosureControl.Feature.Positioning, ClosureControl.Feature.MotionLatching, ClosureControl.Feature.Speed, ClosureControl.Feature.Pedestrian), {
-            countdownTime: 0,
-            mainState: ClosureControl.MainState.Stopped,
-            currentErrorList: [],
-            overallCurrentState: { position: ClosureControl.CurrentPosition.FullyClosed, latch: true, speed: ThreeLevelAuto.Auto, secureState: true },
-            overallTargetState: { position: ClosureControl.TargetPosition.MoveToFullyClosed, latch: true, speed: ThreeLevelAuto.Auto },
-            latchControlModes: { remoteLatching: true, remoteUnlatching: true },
-        });
-        this.closureSlidingGate = await this.addDevice(this.closureSlidingGate);
-        let closureSlidingGateMoveTimeout;
-        this.closureSlidingGate?.addCommandHandler('ClosureControl.moveTo', ({ request: { position, latch, speed }, attributes }) => {
-            this.closureSlidingGate?.log.info(`Command moveTo called position:${position} latch:${latch} speed:${speed}`);
-            attributes.countdownTime = 1;
-            closureSlidingGateMoveTimeout = setTimeout(() => {
-                void (async () => {
-                    const targetState = this.closureSlidingGate?.getAttribute(ClosureControl, 'overallTargetState');
-                    if (targetState === undefined || targetState === null || targetState.position === undefined || targetState.position === null)
-                        return;
-                    await this.closureSlidingGate?.setAttribute(ClosureControl, 'countdownTime', 0, this.closureSlidingGate.log);
-                    await this.closureSlidingGate?.setAttribute(ClosureControl, 'mainState', ClosureControl.MainState.Stopped, this.closureSlidingGate.log);
-                    await this.closureSlidingGate?.setAttribute(ClosureControl, 'currentErrorList', [], this.closureSlidingGate.log);
-                    await this.closureSlidingGate?.setAttribute(ClosureControl, 'overallCurrentState', {
-                        position: closureTargetToCurrentPosition(targetState.position),
-                        latch: targetState.latch,
-                        speed: targetState.speed,
-                        secureState: targetState.position === ClosureControl.TargetPosition.MoveToFullyClosed && targetState.latch === true,
-                    }, this.closureSlidingGate.log);
-                    await this.closureSlidingGate?.setAttribute(ClosureControl, 'overallTargetState', targetState, this.closureSlidingGate.log);
-                    await this.closureSlidingGate?.triggerEvent(ClosureControl, 'movementCompleted', undefined, this.closureSlidingGate.log);
-                })();
-            }, 1000).unref();
-        });
-        this.closureSlidingGate?.addCommandHandler('ClosureControl.stop', ({ attributes }) => {
-            this.closureSlidingGate?.log.info('Command stop called');
-            attributes.countdownTime = 0;
-            clearTimeout(closureSlidingGateMoveTimeout);
-            closureSlidingGateMoveTimeout = undefined;
-        });
-        this.closureRoofWindow = new MatterbridgeEndpoint([closure, powerSource], {
-            id: 'RoofWindow-ROO000074',
-            tagList: [getSemtag(ClosureTag.Window), getSemtag(ClosureWindowTag.Roof)],
-        }, this.config.debug)
-            .createDefaultIdentifyClusterServer()
-            .createDefaultBasicInformationClusterServer('Roof Window', 'ROO000074', 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge Closure')
-            .createDefaultPowerSourceWiredClusterServer();
-        this.closureRoofWindow.behaviors.require(MatterbridgeClosureControlServer.with(ClosureControl.Feature.Positioning, ClosureControl.Feature.MotionLatching, ClosureControl.Feature.Speed, ClosureControl.Feature.Ventilation), {
-            countdownTime: 0,
-            mainState: ClosureControl.MainState.Stopped,
-            currentErrorList: [],
-            overallCurrentState: { position: ClosureControl.CurrentPosition.FullyClosed, latch: true, speed: ThreeLevelAuto.Auto, secureState: true },
-            overallTargetState: { position: ClosureControl.TargetPosition.MoveToFullyClosed, latch: true, speed: ThreeLevelAuto.Auto },
-            latchControlModes: { remoteLatching: true, remoteUnlatching: true },
-        });
-        this.closureRoofWindow = await this.addDevice(this.closureRoofWindow);
-        let closureRoofWindowMoveTimeout;
-        this.closureRoofWindow?.addCommandHandler('ClosureControl.moveTo', ({ request: { position, latch, speed }, attributes }) => {
-            this.closureRoofWindow?.log.info(`Command moveTo called position:${position} latch:${latch} speed:${speed}`);
-            attributes.countdownTime = 1;
-            closureRoofWindowMoveTimeout = setTimeout(() => {
-                void (async () => {
-                    const targetState = this.closureRoofWindow?.getAttribute(ClosureControl, 'overallTargetState');
-                    if (targetState === undefined || targetState === null || targetState.position === undefined || targetState.position === null)
-                        return;
-                    await this.closureRoofWindow?.setAttribute(ClosureControl, 'countdownTime', 0, this.closureRoofWindow.log);
-                    await this.closureRoofWindow?.setAttribute(ClosureControl, 'mainState', ClosureControl.MainState.Stopped, this.closureRoofWindow.log);
-                    await this.closureRoofWindow?.setAttribute(ClosureControl, 'currentErrorList', [], this.closureRoofWindow.log);
-                    await this.closureRoofWindow?.setAttribute(ClosureControl, 'overallCurrentState', {
-                        position: closureTargetToCurrentPosition(targetState.position),
-                        latch: targetState.latch,
-                        speed: targetState.speed,
-                        secureState: targetState.position === ClosureControl.TargetPosition.MoveToFullyClosed && targetState.latch === true,
-                    }, this.closureRoofWindow.log);
-                    await this.closureRoofWindow?.setAttribute(ClosureControl, 'overallTargetState', targetState, this.closureRoofWindow.log);
-                    await this.closureRoofWindow?.triggerEvent(ClosureControl, 'movementCompleted', undefined, this.closureRoofWindow.log);
-                })();
-            }, 1000).unref();
-        });
-        this.closureRoofWindow?.addCommandHandler('ClosureControl.stop', ({ attributes }) => {
-            this.closureRoofWindow?.log.info('Command stop called');
-            attributes.countdownTime = 0;
-            clearTimeout(closureRoofWindowMoveTimeout);
-            closureRoofWindowMoveTimeout = undefined;
-        });
         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.3",
+  "version": "3.0.4-dev-20260901-796d818",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-example-dynamic-platform",
-      "version": "3.0.3",
+      "version": "3.0.4-dev-20260901-796d818",
       "license": "Apache-2.0",
       "dependencies": {
         "node-ansi-logger": "3.3.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "3.0.3",
+  "version": "3.0.4-dev-20260901-796d818",
   "description": "Matterbridge dynamic plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",