matterbridge 3.1.0 → 3.1.1-dev-20250629-f14b886

package/dist/globalMatterbridge.js

@@ -1,70 +1,23 @@
-/**
- * This file contains functions to set and get global instances of Matterbridge, Frontend, and Logger.
- *
- * @file globalMatterbridge.ts
- * @author Luca Liguori
- * @created 2025-06-01
- * @version 1.0.0
- * @license Apache-2.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.
- */
-/**
- * Store the Matterbridge instance globally for later retrieval.
- *
- * @param {Matterbridge} matterbridge An initialized Matterbridge instance
- */
 export function setGlobalMatterbridge(matterbridge) {
     globalThis.__matterbridge__ = matterbridge;
     globalThis.__frontend__ = matterbridge.frontend;
     globalThis.__log__ = matterbridge.log;
 }
-/**
- * Retrieve the globally stored Matterbridge instance.
- *
- * @returns {Matterbridge} The Matterbridge instance.
- * @throws {Error} If the Matterbridge instance is not set.
- */
 export function getGlobalMatterbridge() {
     if (!globalThis.__matterbridge__) {
         throw new Error('Global Matterbridge instance is not set.');
     }
     return globalThis.__matterbridge__;
 }
-/**
- * Retrieve the globally stored Frontend instance.
- *
- * @returns {Frontend} The Frontend instance.
- * @throws {Error} If the Frontend instance is not set.
- */
 export function getGlobalFrontend() {
     if (!globalThis.__frontend__) {
         throw new Error('Global Frontend instance is not set.');
     }
     return globalThis.__frontend__;
 }
-/**
- * Retrieve the globally stored Logger instance.
- *
- * @returns {AnsiLogger} The AnsiLogger instance.
- * @throws {Error} If the Logger instance is not set.
- */
 export function getGlobalLog() {
     if (!globalThis.__log__) {
         throw new Error('Global Logger instance is not set.');
     }
     return globalThis.__log__;
 }
-//# sourceMappingURL=globalMatterbridge.js.map

package/dist/helpers.js

@@ -1,27 +1,3 @@
-/**
- * This file contains the helpers functions of Matterbridge.
- *
- * @file helpers.ts
- * @author Luca Liguori
- * @created 2025-05-12
- * @version 1.0.0
- * @license Apache-2.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,24 +6,8 @@ import { OnOffPlugInUnitDevice } from '@matter/node/devices/on-off-plug-in-unit'
 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';
-// Matterbridge
 import { hasParameter } from './utils/commandLine.js';
-/**
- * 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.
- * @remarks 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':
@@ -68,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 () => {
@@ -78,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...`);
@@ -144,4 +92,3 @@ export async function addVirtualDevices(matterbridge, aggregatorEndpoint) {
         }
     }
 }
-//# sourceMappingURL=helpers.js.map

package/dist/index.js

@@ -1,32 +1,6 @@
-/**
- * This file contains the entry point of Matterbridge.
- *
- * @file index.ts
- * @author Luca Liguori
- * @created 2023-12-29
- * @version 1.0.7
- * @license Apache-2.0
- *
- * 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.
- */
-// AnsiLogger module
 import { AnsiLogger } from 'node-ansi-logger';
-// Matterbridge
 import { Matterbridge } from './matterbridge.js';
 import { hasParameter } from './utils/export.js';
-// Matterbridge
 export * from './matterbridge.js';
 export * from './matterbridgeTypes.js';
 export * from './matterbridgeEndpoint.js';
@@ -37,15 +11,11 @@ export * from './matterbridgePlatform.js';
 export * from './matterbridgeAccessoryPlatform.js';
 export * from './matterbridgeDynamicPlatform.js';
 export { addVirtualDevice } from './helpers.js';
-// Single class device types (these exports will be removed in the next release)
 export * from './roboticVacuumCleaner.js';
 export * from './laundryWasher.js';
 export * from './waterHeater.js';
 export * from './evse.js';
-const log = new AnsiLogger({ logName: 'Main', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: hasParameter('debug') ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
-/**
- * Main function to load the Matterbridge instance.
- */
+const log = new AnsiLogger({ logName: 'Main', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
 async function main() {
     log.debug('***Matterbridge.loadInstance() called');
     await Matterbridge.loadInstance();
@@ -54,4 +24,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

@@ -1,26 +1,3 @@
-/**
- * This file contains the LaundryWasher class.
- *
- * @file laundryWasher.ts
- * @author Luca Liguori
- * @created 2025-05-25
- * @version 1.1.0
- * @license Apache-2.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.
- */
 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';
@@ -28,34 +5,10 @@ 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';
-// Matterbridge
 import { laundryWasher } from './matterbridgeDeviceTypes.js';
 import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
 import { MatterbridgeOnOffServer, MatterbridgeServer } from './matterbridgeBehaviors.js';
 export class LaundryWasher extends MatterbridgeEndpoint {
-    /**
-     * Creates an instance of the LaundryWasher class.
-     *
-     * @param {string} name - The name of the laundry washer.
-     * @param {string} serial - The serial number of the laundry washer.
-     * @param {number} [currentMode] - The current mode of the laundry washer. Defaults to 2 (Normal mode). Dead Front OnOff Cluster will set this to 2 when turned off. Persistent attribute.
-     * @param {LaundryWasherMode.ModeOption[]} [supportedModes] - The supported modes of the laundry washer. Defaults to a set of common modes (which include Delicate, Normal, Heavy, and Whites). Fixed attribute.
-     * @param {number} [spinSpeedCurrent] - The current spin speed as index of the spinSpeeds array. Defaults to 2 (which corresponds to '1200').
-     * @param {string[]} [spinSpeeds] - The supported spin speeds. Defaults to ['400', '800', '1200', '1600'].
-     * @param {LaundryWasherControls.NumberOfRinses} [numberOfRinses] - The number of rinses. Defaults to LaundryWasherControls.NumberOfRinses.Normal (which corresponds to 1 rinse).
-     * @param {LaundryWasherControls.NumberOfRinses[]} [supportedRinses] - The supported rinses. Defaults to [NumberOfRinses.None, NumberOfRinses.Normal, NumberOfRinses.Max, NumberOfRinses.Extra].
-     * @param {number} [selectedTemperatureLevel] - The selected temperature level as an index of the supportedTemperatureLevels array. Defaults to 1 (which corresponds to 'Warm').
-     * @param {string[]} [supportedTemperatureLevels] - The supported temperature levels. Defaults to ['Cold', 'Warm', 'Hot', '30°', '40°', '60°', '80°']. Fixed attribute.
-     * @param {number} [temperatureSetpoint] - The temperature setpoint * 100. Defaults to 40 * 100 (which corresponds to 40°C).
-     * @param {number} [minTemperature] - The minimum temperature * 100. Defaults to 30 * 100 (which corresponds to 30°C). Fixed attribute.
-     * @param {number} [maxTemperature] - The maximum temperature * 100. Defaults to 60 * 100 (which corresponds to 60°C). Fixed attribute.
-     * @param {number} [step] - The step size for temperature changes. Defaults to 10 * 100 (which corresponds to 10°C). Fixed attribute.
-     * @param {OperationalState.OperationalStateEnum} [operationalState] - The operational state of the laundry washer. Defaults to OperationalState.OperationalStateEnum.Off.
-     *
-     * Remarks:
-     * - If `temperatureSetpoint` is provided, the `createNumberTemperatureControlClusterServer` method will be used to create the TemperatureControl Cluster Server with features TemperatureNumber and TemperatureStep.
-     * - If `temperatureSetpoint` is not provided, the `createLevelTemperatureControlClusterServer` method will be used to create the TemperatureControl Cluster Server with feature TemperatureLevel.
-     */
     constructor(name, serial, currentMode, supportedModes, spinSpeedCurrent, spinSpeeds, numberOfRinses, supportedRinses, selectedTemperatureLevel, supportedTemperatureLevels, temperatureSetpoint, minTemperature, maxTemperature, step, operationalState) {
         super(laundryWasher, { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
         this.createDefaultIdentifyClusterServer();
@@ -70,14 +23,6 @@ export class LaundryWasher extends MatterbridgeEndpoint {
             this.createLevelTemperatureControlClusterServer(selectedTemperatureLevel, supportedTemperatureLevels);
         this.createDefaultOperationalStateClusterServer(operationalState);
     }
-    /**
-     * Creates a default Laundry Washer Mode Cluster Server.
-     *
-     * @param {number} currentMode - The current mode of the laundry washer. Defaults to 2 (Normal mode). Dead Front OnOff Cluster will set this to 2 when turned off. Persistent attribute.
-     * @param {LaundryWasherMode.ModeOption[]} supportedModes - The supported modes of the laundry washer. Defaults to a set of common modes (which include Delicate, Normal, Heavy, and Whites). Fixed attribute.
-     *
-     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
-     */
     createDefaultLaundryWasherModeClusterServer(currentMode = 2, supportedModes = [
         { label: 'Delicate', mode: 1, modeTags: [{ value: LaundryWasherMode.ModeTag.Delicate }] },
         { label: 'Normal', mode: 2, modeTags: [{ value: LaundryWasherMode.ModeTag.Normal }] },
@@ -85,38 +30,20 @@ export class LaundryWasher extends MatterbridgeEndpoint {
         { label: 'Whites', mode: 4, modeTags: [{ value: LaundryWasherMode.ModeTag.Whites }] },
     ]) {
         this.behaviors.require(MatterbridgeLaundryWasherModeServer, {
-            supportedModes, // Fixed attribute.
-            currentMode, // Persistent attribute.
+            supportedModes,
+            currentMode,
         });
         return this;
     }
-    /**
-     * Creates a Laundry Washer Controls Cluster Server with feature Spin for selecting the spin speed and feature Rinse for selecting the number of rinses.
-     *
-     * @param {number} spinSpeedCurrent - The current spin speed as index of the spinSpeeds array. Default to 2 (which corresponds to '1200').
-     * @param {string[]} spinSpeeds - The supported spin speeds. Default to ['400', '800', '1200', '1600'].
-     * @param {LaundryWasherControls.NumberOfRinses} numberOfRinses - The number of rinses. Default to LaundryWasherControls.NumberOfRinses.Normal (which corresponds to 1 rinse).
-     * @param {LaundryWasherControls.NumberOfRinses[]} supportedRinses - The supported rinses. Default to [NumberOfRinses.None, NumberOfRinses.Normal, NumberOfRinses.Max, NumberOfRinses.Extra].
-     *
-     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
-     */
     createDefaultLaundryWasherControlsClusterServer(spinSpeedCurrent = 2, 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, // Writable and nullable
+            spinSpeedCurrent,
             supportedRinses,
-            numberOfRinses, // Writable
+            numberOfRinses,
         });
         return this;
     }
-    /**
-     * Creates a TemperatureControl Cluster Server with feature TemperatureLevel.
-     *
-     * @param {number} selectedTemperatureLevel - The selected temperature level as an index of the supportedTemperatureLevels array. Defaults to 1 (which corresponds to 'Warm').
-     * @param {string[]} supportedTemperatureLevels - The supported temperature levels. Defaults to ['Cold', 'Warm', 'Hot', '30°', '40°', '60°', '80°']. Fixed attribute.
-     *
-     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
-     */
     createLevelTemperatureControlClusterServer(selectedTemperatureLevel = 1, supportedTemperatureLevels = ['Cold', 'Warm', 'Hot', '30°', '40°', '60°', '80°']) {
         this.behaviors.require(MatterbridgeLevelTemperatureControlServer.with(TemperatureControl.Feature.TemperatureLevel), {
             selectedTemperatureLevel,
@@ -124,22 +51,12 @@ export class LaundryWasher extends MatterbridgeEndpoint {
         });
         return this;
     }
-    /**
-     * Creates a TemperatureControl Cluster Server with features TemperatureNumber and TemperatureStep.
-     *
-     * @param {number} temperatureSetpoint - The temperature setpoint * 100. Defaults to 40 * 100 (which corresponds to 40°C).
-     * @param {number} minTemperature - The minimum temperature * 100. Defaults to 30 * 100 (which corresponds to 30°C). Fixed attribute.
-     * @param {number} maxTemperature - The maximum temperature * 100. Defaults to 60 * 100 (which corresponds to 60°C). Fixed attribute.
-     * @param {number} [step] - The step size for temperature changes. Defaults to 10 * 100 (which corresponds to 10°C). Fixed attribute.
-     *
-     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
-     */
     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, // Fixed attribute
-            maxTemperature, // Fixed attribute
-            step, // Fixed attribute
+            minTemperature,
+            maxTemperature,
+            step,
         });
         return this;
     }
@@ -188,7 +105,6 @@ export class MatterbridgeLaundryWasherModeServer extends LaundryWasherModeServer
         device.log.info(`MatterbridgeLaundryWasherModeServer initialized: currentMode is ${this.state.currentMode}`);
         this.reactTo(this.agent.get(MatterbridgeOnOffServer).events.onOff$Changed, this.handleOnOffChange);
     }
-    // Dead Front OnOff Cluster
     handleOnOffChange(onOff) {
         const device = this.endpoint.stateOf(MatterbridgeServer);
         device.log.info(`HandleOnOffChange (endpoint ${this.endpoint.maybeId}.${this.endpoint.maybeNumber})`);
@@ -213,4 +129,3 @@ export class MatterbridgeLaundryWasherModeServer extends LaundryWasherModeServer
         }
     }
 }
-//# sourceMappingURL=laundryWasher.js.map

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,7 +1,4 @@
-/* eslint-disable import/export */
-// @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,5 +1,2 @@
-/* eslint-disable import/export */
-// @matter
 export * from '@matter/types';
 export { ClusterRegistry } from '@matter/types';
-//# sourceMappingURL=types.js.map