matterbridge 3.0.4 → 3.0.5-dev-20250526-422f029

package/dist/helpers.js

@@ -1,26 +1,3 @@
-/**
- * This file contains the helpers functions of Matterbridge.
- *
- * @file helpers.ts
- * @author Luca Liguori
- * @date 2025-05-12
- * @version 1.0.0
- *
- * Copyright 2025, 2026, 2027 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. *
- */
-// @matter module
 import { OnOff } from '@matter/main/clusters/on-off';
 import { Endpoint } from '@matter/node';
 import { BridgedDeviceBasicInformationServer } from '@matter/node/behaviors/bridged-device-basic-information';
@@ -30,22 +7,7 @@ import { hasParameter } from './utils/commandLine.js';
 import { MountedOnOffControlDevice } from '@matter/node/devices/mounted-on-off-control';
 import { OnOffLightDevice } from '@matter/node/devices/on-off-light';
 import { OnOffLightSwitchDevice } from '@matter/node/devices/on-off-light-switch';
-/**
- * Adds a virtual device to the provided endpoint, sets up an event listener for device state changes,
- * and ensures the device is initialized in the off state.
- *
- * @param {Endpoint<AggregatorEndpoint>} aggregatorEndpoint - The aggragator endpoint to which the virtual device will be added.
- * @param {string} name - The name of the virtual device. Spaces in the name are removed to form the device ID.
- * @param {'light' | 'outlet' | 'switch' | 'mounted_switch'} type - The type of the virtual device. Can be 'light', 'outlet', 'switch', or 'mounted_switch'.
- * @param {() => Promise<void>} callback - A callback function that gets executed when the device's on/off state changes to true.
- * @returns {Promise<Endpoint>} A promise that resolves with the created virtual device.
- * @remark The virtual device is created as an instance of `Endpoint` with the `OnOffPlugInUnitDevice` device type.
- * The onOff state always reverts to false when the device is turned on.
- */
 export async function addVirtualDevice(aggregatorEndpoint, name, type, callback) {
-    // Create a new virtual device by instantiating `Endpoint` with device information.
-    // The device ID is created by replacing all spaces in the name with an empty string.
-    // The node label of the bridged device basic information is set to the given name.
     let deviceType;
     switch (type) {
         case 'light':
@@ -66,9 +28,7 @@ export async function addVirtualDevice(aggregatorEndpoint, name, type, callback)
         bridgedDeviceBasicInformation: { nodeLabel: name.slice(0, 32) },
         onOff: { onOff: false, startUpOnOff: OnOff.StartUpOnOff.Off },
     });
-    // Set up an event listener for when the `onOff` state changes.
     device.events.onOff.onOff$Changed.on((value) => {
-        // If the `onOff` state becomes true, turn off the virtual device and execute the callback.
         if (value) {
             callback();
             process.nextTick(async () => {
@@ -76,24 +36,14 @@ export async function addVirtualDevice(aggregatorEndpoint, name, type, callback)
                     await device.setStateOf(OnOffBaseServer, { onOff: false });
                 }
                 catch (_error) {
-                    // Not necessary to handle the error
                 }
             });
         }
     });
-    // Add the created device to the given endpoint.
     await aggregatorEndpoint.add(device);
-    // Initially set the state of the virtual device's `OnOffBaseServer` to false (off).
     await device.setStateOf(OnOffBaseServer, { onOff: false });
     return device;
 }
-/**
- * Creates and add the virtual devices to the aggregator.
- *
- * @param {Matterbridge} matterbridge - The Matterbridge instance.
- * @param {Endpoint<AggregatorEndpoint>} aggregatorEndpoint - The aggregator node to add the virtual devices to.
- * @returns {Promise<void>} A promise that resolves when the virtual devices are added.
- */
 export async function addVirtualDevices(matterbridge, aggregatorEndpoint) {
     if (matterbridge.matterbridgeInformation.virtualMode !== 'disabled' && matterbridge.bridgeMode === 'bridge' && aggregatorEndpoint) {
         matterbridge.log.notice(`Creating virtual devices for Matterbridge server node...`);
@@ -139,4 +89,3 @@ export async function addVirtualDevices(matterbridge, aggregatorEndpoint) {
         }
     }
 }
-//# sourceMappingURL=helpers.js.map

package/dist/index.js

@@ -1,31 +1,6 @@
-/**
- * This file contains the entry point of Matterbridge.
- *
- * @file index.ts
- * @author Luca Liguori
- * @date 2023-12-29
- * @version 1.0.7
- *
- * Copyright 2023, 2024, 2025 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License. *
- */
-// Matterbridge
 import { Matterbridge } from './matterbridge.js';
 import { hasParameter } from './utils/export.js';
-// AnsiLogger module
 import { AnsiLogger } from './logger/export.js';
-// Matterbridge
 export * from './matterbridge.js';
 export * from './matterbridgeTypes.js';
 export * from './matterbridgeEndpoint.js';
@@ -38,7 +13,7 @@ export * from './matterbridgeDynamicPlatform.js';
 export * from './roboticVacuumCleaner.js';
 export * from './waterHeater.js';
 export { addVirtualDevice } from './helpers.js';
-const log = new AnsiLogger({ logName: 'Main', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: hasParameter('debug') ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
+const log = new AnsiLogger({ logName: 'Main', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
 async function main() {
     log.debug('***Matterbridge.loadInstance() called');
     await Matterbridge.loadInstance();
@@ -47,4 +22,3 @@ async function main() {
 main().catch((error) => {
     log.error(`Matterbridge.loadInstance() failed with error: ${error instanceof Error ? error.message : error}`);
 });
-//# sourceMappingURL=index.js.map

package/dist/laundryWasher.js

@@ -0,0 +1,122 @@
+import { OperationalState } from '@matter/main/clusters/operational-state';
+import { LaundryWasherControls } from '@matter/main/clusters/laundry-washer-controls';
+import { LaundryWasherMode } from '@matter/main/clusters/laundry-washer-mode';
+import { TemperatureControl } from '@matter/main/clusters/temperature-control';
+import { ModeBase } from '@matter/main/clusters/mode-base';
+import { TemperatureControlServer } from '@matter/main/behaviors/temperature-control';
+import { LaundryWasherModeServer } from '@matter/main/behaviors/laundry-washer-mode';
+import { LaundryWasherControlsServer } from '@matter/main/behaviors/laundry-washer-controls';
+import { laundryWasher } from './matterbridgeDeviceTypes.js';
+import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
+import { MatterbridgeOnOffServer, MatterbridgeServer } from './matterbridgeBehaviors.js';
+export class LaundryWasher extends MatterbridgeEndpoint {
+    constructor(name, serial) {
+        super(laundryWasher, { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
+        this.createDefaultIdentifyClusterServer();
+        this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge Laundry Washer');
+        this.createDefaultPowerSourceWiredClusterServer();
+        this.createDeadFrontOnOffClusterServer();
+        this.createLevelTemperatureControlClusterServer(3, ['Cold', '30°', '40°', '60°', '80°']);
+        this.createDefaultLaundryWasherControlsClusterServer();
+        this.createDefaultLaundryWasherModeClusterServer();
+        this.createDefaultOperationalStateClusterServer(OperationalState.OperationalStateEnum.Stopped);
+    }
+    createDefaultLaundryWasherControlsClusterServer(spinSpeedCurrent = 3, spinSpeeds = ['400', '800', '1200', '1600'], numberOfRinses = LaundryWasherControls.NumberOfRinses.Normal, supportedRinses = [LaundryWasherControls.NumberOfRinses.None, LaundryWasherControls.NumberOfRinses.Normal, LaundryWasherControls.NumberOfRinses.Max, LaundryWasherControls.NumberOfRinses.Extra]) {
+        this.behaviors.require(LaundryWasherControlsServer.with(LaundryWasherControls.Feature.Spin, LaundryWasherControls.Feature.Rinse), {
+            spinSpeeds,
+            spinSpeedCurrent,
+            supportedRinses,
+            numberOfRinses,
+        });
+        return this;
+    }
+    createDefaultLaundryWasherModeClusterServer(currentMode = 2, 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 }] },
+    ]) {
+        this.behaviors.require(MatterbridgeLaundryWasherModeServer, {
+            supportedModes,
+            currentMode,
+        });
+        return this;
+    }
+    createLevelTemperatureControlClusterServer(selectedTemperatureLevel = 1, supportedTemperatureLevels = ['Cold', 'Warm', 'Hot']) {
+        this.behaviors.require(MatterbridgeLevelTemperatureControlServer.with(TemperatureControl.Feature.TemperatureLevel), {
+            selectedTemperatureLevel,
+            supportedTemperatureLevels,
+        });
+        return this;
+    }
+    createNumberTemperatureControlClusterServer(temperatureSetpoint = 40 * 100, minTemperature = 30 * 100, maxTemperature = 60 * 100, step = 10 * 100) {
+        this.behaviors.require(MatterbridgeNumberTemperatureControlServer.with(TemperatureControl.Feature.TemperatureNumber, TemperatureControl.Feature.TemperatureStep), {
+            temperatureSetpoint,
+            minTemperature,
+            maxTemperature,
+            step,
+        });
+        return this;
+    }
+}
+class MatterbridgeLevelTemperatureControlServer extends TemperatureControlServer.with(TemperatureControl.Feature.TemperatureLevel) {
+    initialize() {
+        if (this.state.supportedTemperatureLevels.length >= 2) {
+            const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+            device.log.info('MatterbridgeLevelTemperatureControlServer initialized');
+        }
+    }
+    setTemperature(request) {
+        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        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;
+        }
+        else {
+            device.log.error(`MatterbridgeLevelTemperatureControlServer: setTemperature called with invalid targetTemperatureLevel ${request.targetTemperatureLevel}`);
+        }
+    }
+}
+class MatterbridgeNumberTemperatureControlServer extends TemperatureControlServer.with(TemperatureControl.Feature.TemperatureNumber) {
+    initialize() {
+        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        device.log.info('MatterbridgeNumberTemperatureControlServer initialized');
+    }
+    setTemperature(request) {
+        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        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;
+        }
+        else {
+            device.log.error(`MatterbridgeNumberTemperatureControlServer: setTemperature called with invalid targetTemperature ${request.targetTemperature}`);
+        }
+    }
+}
+class MatterbridgeLaundryWasherModeServer extends LaundryWasherModeServer {
+    initialize() {
+        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        device.log.info(`LaundryWasherModeServer initialized: currentMode is ${this.state.currentMode}`);
+        this.reactTo(this.agent.get(MatterbridgeOnOffServer).events.onOff$Changed, this.handleOnOffChange);
+    }
+    handleOnOffChange(onOff) {
+        const device = this.endpoint.stateOf(MatterbridgeServer).deviceCommand;
+        if (onOff === false) {
+            device.log.notice('OnOffServer changed to OFF: setting Dead Front state to Manufacturer Specific');
+            this.state.currentMode = 2;
+        }
+    }
+    changeToMode(request) {
+        const device = this.endpoint.stateOf(MatterbridgeServer).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: ModeBase.ModeChangeStatus.Success, statusText: 'Success' };
+        }
+        else {
+            device.log.error(`LaundryWasherModeServer: changeToMode called with invalid mode ${request.newMode}`);
+            return { status: ModeBase.ModeChangeStatus.InvalidInMode, statusText: 'Invalid mode' };
+        }
+    }
+}

package/dist/logger/export.js

@@ -1,2 +1 @@
 export * from 'node-ansi-logger';
-//# sourceMappingURL=export.js.map

package/dist/matter/behaviors.js

@@ -1,3 +1 @@
-// @matter
 export * from '@matter/node/behaviors';
-//# sourceMappingURL=behaviors.js.map

package/dist/matter/clusters.js

@@ -1,3 +1 @@
-// @matter
 export * from '@matter/types/clusters';
-//# sourceMappingURL=clusters.js.map

package/dist/matter/devices.js

@@ -1,3 +1 @@
-// @matter
 export * from '@matter/node/devices';
-//# sourceMappingURL=devices.js.map

package/dist/matter/endpoints.js

@@ -1,3 +1 @@
-// @matter
 export { AggregatorEndpoint, ElectricalSensorEndpoint, PowerSourceEndpoint, BridgedNodeEndpoint, RootEndpoint, DeviceEnergyManagementEndpoint, OtaProviderEndpoint, OtaRequestorEndpoint } from '@matter/node/endpoints';
-//# sourceMappingURL=endpoints.js.map

package/dist/matter/export.js

@@ -1,6 +1,4 @@
-// @matter
 export * from '@matter/main';
 export { SemanticNamespace, ClosureTag, CompassDirectionTag, CompassLocationTag, DirectionTag, ElectricalMeasurementTag, LaundryTag, LevelTag, LocationTag, NumberTag, PositionTag, PowerSourceTag, RefrigeratorTag, RoomAirConditionerTag, SwitchesTag, } from '@matter/main';
 export { AttributeElement, ClusterElement, ClusterModel, CommandElement, EventElement, FieldElement } from '@matter/main/model';
 export { MdnsService, Val } from '@matter/main/protocol';
-//# sourceMappingURL=export.js.map

package/dist/matter/types.js

@@ -1,4 +1,2 @@
-// @matter
 export * from '@matter/types';
 export { ClusterRegistry } from '@matter/types';
-//# sourceMappingURL=types.js.map