matterbridge-example-dynamic-platform 1.2.0-edge.3 → 1.2.0-edge.5

package/dist/appliances.js

@@ -1,7 +1,7 @@
-import { DeviceClasses, DeviceTypeDefinition, MatterbridgeEndpoint, Status, Matterbridge, VendorId, DeviceTypeId, MatterbridgeServer, smokeCoAlarm, } from 'matterbridge';
+import { DeviceClasses, DeviceTypeDefinition, MatterbridgeEndpoint, Status, Matterbridge, VendorId, DeviceTypeId, MatterbridgeServer, smokeCoAlarm, MatterbridgeOnOffServer, } from 'matterbridge';
 import { ClusterBehavior, LogLevel as MatterLogLevel, LogFormat as MatterLogFormat, EndpointServer, logEndpoint } from 'matterbridge/matter';
-import { Identify, OperationalState, OnOff, TemperatureControl, DishwasherAlarm, DishwasherMode, LaundryWasherControls, LaundryWasherMode, TemperatureMeasurement, OvenMode, RefrigeratorAndTemperatureControlledCabinetMode, } from 'matterbridge/matter/clusters';
-import { DishwasherAlarmServer, OperationalStateBehavior, TemperatureControlBehavior } from 'matterbridge/matter/behaviors';
+import { Identify, OperationalState, OnOff, TemperatureControl, DishwasherAlarm, DishwasherMode, LaundryWasherControls, LaundryWasherMode, LaundryDryerControls, TemperatureMeasurement, OvenMode, RefrigeratorAndTemperatureControlledCabinetMode, } from 'matterbridge/matter/clusters';
+import { DishwasherAlarmServer, LaundryDryerControlsServer, LaundryWasherControlsServer, OperationalStateBehavior, TemperatureControlBehavior, } from 'matterbridge/matter/behaviors';
 import { OvenCavityOperationalState } from './implementations/ovenCavityOperationalStateCluster.js';
 import { AnsiLogger } from 'matterbridge/logger';
 import { Robot } from './robot.js';
@@ -30,6 +30,14 @@ export class Appliances extends MatterbridgeEndpoint {
         requiredServerClusters: [OperationalState.Cluster.id],
         optionalServerClusters: [Identify.Cluster.id, LaundryWasherMode.Cluster.id, OnOff.Cluster.id, LaundryWasherControls.Cluster.id, TemperatureControl.Cluster.id],
     });
+    static laundryDryer = DeviceTypeDefinition({
+        name: 'MA-laundrydryer',
+        code: 0x7c,
+        deviceClass: DeviceClasses.Simple,
+        revision: 1,
+        requiredServerClusters: [OperationalState.Cluster.id],
+        optionalServerClusters: [Identify.Cluster.id, LaundryWasherMode.Cluster.id, OnOff.Cluster.id, LaundryDryerControls.Cluster.id, TemperatureControl.Cluster.id],
+    });
     static dishwasher = DeviceTypeDefinition({
         name: 'MA-dishwasher',
         code: 0x75,
@@ -43,13 +51,25 @@ export class Appliances extends MatterbridgeEndpoint {
         if (deviceType.code === Appliances.laundryWasher.code) {
             this.createDefaultIdentifyClusterServer();
             this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Laundry Washer');
-            this.createLevelTemperatureControlClusterServer(1, ['Cold', '30°', '40°', '60°']);
+            this.createDeadFrontOnOffClusterServer();
+            this.createLevelTemperatureControlClusterServer(3, ['Cold', '30°', '40°', '60°', '80°']);
+            this.createDefaultLaundryWasherModeClusterServer();
+            this.createSpinLaundryWasherControlsClusterServer(3, ['400', '800', '1200', '1600']);
             this.createDefaultOperationalStateClusterServer(OperationalState.OperationalStateEnum.Stopped);
         }
-        else if (deviceType.code === Appliances.dishwasher.code) {
+        else if (deviceType.code === Appliances.laundryDryer.code) {
             this.createDefaultIdentifyClusterServer();
+            this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Laundry Dryer');
             this.createDeadFrontOnOffClusterServer();
+            this.createLevelTemperatureControlClusterServer(3, ['Cold', '30°', '40°', '60°', '80°']);
+            this.createDefaultLaundryWasherModeClusterServer();
+            this.createDefaultLaundryDryerControlsClusterServer(1);
+            this.createDefaultOperationalStateClusterServer(OperationalState.OperationalStateEnum.Stopped);
+        }
+        else if (deviceType.code === Appliances.dishwasher.code) {
+            this.createDefaultIdentifyClusterServer();
             this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Dishwasher');
+            this.createDeadFrontOnOffClusterServer();
             this.createLevelTemperatureControlClusterServer(1, ['Cold', '30°', '40°', '60°']);
             this.createDefaultDishwasherModeClusterServer();
             this.createDefaultDishwasherAlarmClusterServer();
@@ -121,6 +141,49 @@ export class Appliances extends MatterbridgeEndpoint {
         });
         return this;
     }
+    createDefaultLaundryWasherModeClusterServer(currentMode) {
+        this.behaviors.require(LaundryWasherModeServer, {
+            supportedModes: [
+                { label: 'Delicate', mode: 1, modeTags: [{ value: LaundryWasherMode.ModeTag.Delicate }] },
+                { label: 'Normal', mode: 2, modeTags: [{ value: LaundryWasherMode.ModeTag.Normal }] },
+                { label: 'Heavy', mode: 3, modeTags: [{ value: LaundryWasherMode.ModeTag.Heavy }] },
+                { label: 'Whites', mode: 4, modeTags: [{ value: LaundryWasherMode.ModeTag.Whites }] },
+            ],
+            currentMode,
+        });
+        return this;
+    }
+    createSpinLaundryWasherControlsClusterServer(spinSpeedCurrent, spinSpeeds) {
+        this.behaviors.require(LaundryWasherControlsServer.with(LaundryWasherControls.Feature.Spin), {
+            spinSpeeds: spinSpeeds ?? ['400', '800', '1200', '1600'],
+            spinSpeedCurrent,
+        });
+        return this;
+    }
+    createRinseLaundryWasherControlsClusterServer(numberOfRinses, supportedRinses) {
+        this.behaviors.require(LaundryWasherControlsServer.with(LaundryWasherControls.Feature.Rinse), {
+            supportedRinses: supportedRinses ?? [
+                LaundryWasherControls.NumberOfRinses.None,
+                LaundryWasherControls.NumberOfRinses.Normal,
+                LaundryWasherControls.NumberOfRinses.Extra,
+                LaundryWasherControls.NumberOfRinses.Max,
+            ],
+            numberOfRinses,
+        });
+        return this;
+    }
+    createDefaultLaundryDryerControlsClusterServer(selectedDrynessLevel, supportedDrynessLevels) {
+        this.behaviors.require(LaundryDryerControlsServer, {
+            supportedDrynessLevels: supportedDrynessLevels ?? [
+                LaundryDryerControls.DrynessLevel.Low,
+                LaundryDryerControls.DrynessLevel.Normal,
+                LaundryDryerControls.DrynessLevel.Extra,
+                LaundryDryerControls.DrynessLevel.Max,
+            ],
+            selectedDrynessLevel,
+        });
+        return this;
+    }
     createDefaultDishwasherAlarmClusterServer() {
         this.behaviors.require(DishwasherAlarmServer, {
             mask: { inflowError: true, drainError: true, doorError: true, tempTooLow: true, tempTooHigh: true, waterLevelError: true },
@@ -167,13 +230,13 @@ export class Appliances extends MatterbridgeEndpoint {
 class MatterbridgeOperationalStateServer extends OperationalStateBehavior {
     initialize() {
         const device = this.agent.get(MatterbridgeServer).state.deviceCommand;
-        device.log.info('MatterbridgeOperationalStateServer initialized: setting operational state to Docked');
+        device.log.info('MatterbridgeOperationalStateServer initialized: setting operational state to Stopped');
         this.state.operationalState = OperationalState.OperationalStateEnum.Stopped;
         this.state.operationalError = { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' };
     }
     pause() {
         const device = this.agent.get(MatterbridgeServer).state.deviceCommand;
-        device.log.info('MatterbridgeOperationalStateServer: pause called setting operational state to Paused and currentMode to Paused');
+        device.log.info('MatterbridgeOperationalStateServer: pause called setting operational state to Paused');
         this.state.operationalState = OperationalState.OperationalStateEnum.Paused;
         this.state.operationalError = { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' };
         return {
@@ -182,7 +245,7 @@ class MatterbridgeOperationalStateServer extends OperationalStateBehavior {
     }
     stop() {
         const device = this.agent.get(MatterbridgeServer).state.deviceCommand;
-        device.log.info('MatterbridgeOperationalStateServer: stop called setting operational state to Stopped and currentMode to Idle');
+        device.log.info('MatterbridgeOperationalStateServer: stop called setting operational state to Stopped');
         this.state.operationalState = OperationalState.OperationalStateEnum.Stopped;
         this.state.operationalError = { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' };
         return {
@@ -191,7 +254,7 @@ class MatterbridgeOperationalStateServer extends OperationalStateBehavior {
     }
     start() {
         const device = this.agent.get(MatterbridgeServer).state.deviceCommand;
-        device.log.info('MatterbridgeOperationalStateServer: start called setting operational state to Running and currentMode to Running');
+        device.log.info('MatterbridgeOperationalStateServer: start called setting operational state to Running');
         this.state.operationalState = OperationalState.OperationalStateEnum.Running;
         this.state.operationalError = { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' };
         return {
@@ -200,7 +263,7 @@ class MatterbridgeOperationalStateServer extends OperationalStateBehavior {
     }
     resume() {
         const device = this.agent.get(MatterbridgeServer).state.deviceCommand;
-        device.log.info('MatterbridgeOperationalStateServer: resume called setting operational state to Running and currentMode to Cleaning');
+        device.log.info('MatterbridgeOperationalStateServer: resume called setting operational state to Running');
         this.state.operationalState = OperationalState.OperationalStateEnum.Running;
         this.state.operationalError = { errorStateId: OperationalState.ErrorState.NoError, errorStateLabel: 'No error', errorStateDetails: 'Fully operational' };
         return {
@@ -218,7 +281,7 @@ class MatterbridgeLevelTemperatureControlServer extends TemperatureControlBehavi
     }
     setTemperature(request) {
         const device = this.agent.get(MatterbridgeServer).state.deviceCommand;
-        if (request.targetTemperatureLevel && request.targetTemperatureLevel >= 0 && request.targetTemperatureLevel < this.state.supportedTemperatureLevels.length) {
+        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;
         }
@@ -234,7 +297,7 @@ class MatterbridgeNumberTemperatureControlServer extends TemperatureControlBehav
     }
     setTemperature(request) {
         const device = this.agent.get(MatterbridgeServer).state.deviceCommand;
-        if (request.targetTemperature && request.targetTemperature >= this.state.minTemperature && request.targetTemperature <= this.state.maxTemperature) {
+        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;
         }
@@ -315,12 +378,21 @@ class DishwasherModeServer extends DishwasherModeBehavior {
     initialize() {
         const device = this.agent.get(MatterbridgeServer).state.deviceCommand;
         device.log.info('DishwasherModeServer initialized: setting currentMode to 3');
-        this.state.currentMode = 3;
+        this.state.currentMode = 2;
+        this.reactTo(this.agent.get(MatterbridgeOnOffServer).events.onOff$Changed, this.handleOnOffChange);
+    }
+    handleOnOffChange(onOff) {
+        const device = this.agent.get(MatterbridgeServer).state.deviceCommand;
+        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.agent.get(MatterbridgeServer).state.deviceCommand;
-        if (this.state.supportedModes.find((mode) => mode.mode === request.newMode)) {
-            device.log.info(`DishwasherModeServer: changeToMode called with mode ${request.newMode} = ${this.state.supportedModes[request.newMode].label}`);
+        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}`);
             this.state.currentMode = request.newMode;
             return { status: Status.Success, statusText: 'Success' };
         }
@@ -330,6 +402,35 @@ class DishwasherModeServer extends DishwasherModeBehavior {
         }
     }
 }
+export const LaundryWasherModeBehavior = ClusterBehavior.withInterface().for(LaundryWasherMode.Cluster);
+class LaundryWasherModeServer extends LaundryWasherModeBehavior {
+    initialize() {
+        const device = this.agent.get(MatterbridgeServer).state.deviceCommand;
+        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.agent.get(MatterbridgeServer).state.deviceCommand;
+        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.agent.get(MatterbridgeServer).state.deviceCommand;
+        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}`);
+            this.state.currentMode = request.newMode;
+            return { status: Status.Success, statusText: 'Success' };
+        }
+        else {
+            device.log.error(`LaundryWasherModeServer: changeToMode called with invalid mode ${request.newMode}`);
+            return { status: Status.InvalidCommand, statusText: 'Invalid mode' };
+        }
+    }
+}
 if (process.argv.includes('-testRobot')) {
     const matterbridge = await Matterbridge.loadInstance(false);
     matterbridge.log = new AnsiLogger({ logName: 'Matterbridge', logTimestampFormat: 4, logLevel: "debug" });

package/dist/platform.js

@@ -865,6 +865,12 @@ export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatf
             await this.registerDevice(laundryWasher);
             this.bridgedDevices.set(laundryWasher.deviceName ?? '', laundryWasher);
         }
+        const laundryDryer = new Appliances(Appliances.laundryDryer, 'Laundry Dryer', '1235227890');
+        this.setSelectDevice(laundryDryer.serialNumber ?? '', laundryDryer.deviceName ?? '', undefined, 'hub');
+        if (this.validateDevice(laundryDryer.deviceName ?? '')) {
+            await this.registerDevice(laundryDryer);
+            this.bridgedDevices.set(laundryDryer.deviceName ?? '', laundryDryer);
+        }
         const dishwasher = new Appliances(Appliances.dishwasher, 'Dishwasher', '0987654321');
         this.setSelectDevice(dishwasher.serialNumber ?? '', dishwasher.deviceName ?? '', undefined, 'hub');
         if (this.validateDevice(dishwasher.deviceName ?? '')) {

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "1.2.0-edge.3",
+  "version": "1.2.0-edge.5",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-example-dynamic-platform",
-      "version": "1.2.0-edge.3",
+      "version": "1.2.0-edge.5",
       "license": "MIT",
       "dependencies": {
         "node-ansi-logger": "3.0.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "1.2.0-edge.3",
+  "version": "1.2.0-edge.5",
   "description": "Matterbridge dynamic plugin",
   "author": "https://github.com/Luligu",
   "license": "MIT",