matterbridge 3.3.4 → 3.3.5-dev-20251028-d89f93f

package/dist/devices/extractorHood.js

@@ -1,48 +1,7 @@
-/**
- * @description This file contains the ExtractorHood class.
- * @file src/devices/extractorHood.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 { ResourceMonitoring } from '@matter/types/clusters/resource-monitoring';
-// Matterbridge
 import { extractorHood, powerSource } from '../matterbridgeDeviceTypes.js';
 import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
 export class ExtractorHood extends MatterbridgeEndpoint {
-    /**
-     * Creates an instance of the ExtractorHood class.
-     *
-     * @param {string} name - The name of the extractor hood.
-     * @param {string} serial - The serial number of the extractor hood.
-     *
-     * @param {number} [hepaCondition] - The initial HEPA filter condition (range 0-100). Default is 100.
-     * @param {ResourceMonitoring.ChangeIndication} hepaChangeIndication - The initial HEPA filter change indication. Default is ResourceMonitoring.ChangeIndication.Ok.
-     * @param {boolean | undefined} hepaInPlaceIndicator - The HEPA filter in-place indicator. Default is true.
-     * @param {number | null | undefined} hepaLastChangedTime - The last time the HEPA filter was changed. Default is null.
-     * @param {ResourceMonitoring.ReplacementProduct[]} hepaReplacementProductList - The list of HEPA filter replacement products. Default is an empty array.
-     
-     * @param {number} [activatedCarbonCondition] - The initial activated carbon filter condition (range 0-100). Default is 100.
-     * @param {ResourceMonitoring.ChangeIndication} activatedCarbonChangeIndication - The initial activated carbon filter change indication. Default is ResourceMonitoring.ChangeIndication.Ok.
-     * @param {boolean | undefined} activatedCarbonInPlaceIndicator - The activated carbon filter in-place indicator. Default is true.
-     * @param {number | null | undefined} activatedCarbonLastChangedTime - The last time the activated carbon filter was changed. Default is null.
-     * @param {ResourceMonitoring.ReplacementProduct[]} activatedCarbonReplacementProductList - The list of activated carbon filter replacement products. Default is an empty array.
-     */
     constructor(name, serial, hepaCondition = 100, hepaChangeIndication = ResourceMonitoring.ChangeIndication.Ok, hepaInPlaceIndicator = true, hepaLastChangedTime = null, hepaReplacementProductList = [], activatedCarbonCondition = 100, activatedCarbonChangeIndication = ResourceMonitoring.ChangeIndication.Ok, activatedCarbonInPlaceIndicator = true, activatedCarbonLastChangedTime = null, activatedCarbonReplacementProductList = []) {
         super([extractorHood, powerSource], { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
         this.createDefaultIdentifyClusterServer();
@@ -74,4 +33,3 @@ export class ExtractorHood extends MatterbridgeEndpoint {
         });
     }
 }
-//# sourceMappingURL=extractorHood.js.map

package/dist/devices/heatPump.js

@@ -1,52 +1,8 @@
-/**
- * @description This file contains the HeatPump class.
- * @file src/devices/heatPump.ts
- * @author Luca Liguori
- * @created 2025-06-29
- * @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
 import { NumberTag, PowerSourceTag } from '@matter/node';
 import { DeviceEnergyManagement } from '@matter/types/clusters/device-energy-management';
-// Matterbridge
 import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
 import { deviceEnergyManagement, electricalSensor, powerSource, heatPump, temperatureSensor, thermostatDevice } from '../matterbridgeDeviceTypes.js';
 export class HeatPump extends MatterbridgeEndpoint {
-    /**
-     * Creates an instance of the HeatPump class.
-     *
-     * @param {string} name - The name of the HeatPump.
-     * @param {string} serial - The serial number of the HeatPump.
-     * @param {number} voltage - The voltage value in millivolts.
-     * @param {number} current - The current value in milliamperes.
-     * @param {number} power - The power value in milliwatts.
-     * @param {number} energyImported - The total production value in mW/h.
-     * @param {number} [absMinPower] - Indicate the minimum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
-     * @param {number} [absMaxPower] - Indicate the maximum electrical power in mw that the ESA can consume when switched on. Defaults to `0` if not provided.
-     *
-     * @remarks
-     * - The HeatPump includes clusters for power source, electrical power measurement, electrical energy measurement, and device energy management.
-     * - It also includes child devices for flow temperature, return temperature, and a thermostat.
-     * - The flow and return temperature sensors are set to default values of 45.00°C and 35.00°C respectively.
-     * - The heating only thermostat is set up with a default temperature setpoint of 21.00°C.
-     * - The device energy management cluster is set to `esaType` as `SpaceHeating`, `esaCanGenerate` as `false`, and `esaState` as `Online`.
-     * - The absolute minimum and maximum power values can be set to indicate the range of power consumption for the heat pump.
-     */
     constructor(name, serial, voltage = null, current = null, power = null, energyImported = null, absMinPower = 0, absMaxPower = 0) {
         super([heatPump, powerSource, electricalSensor, deviceEnergyManagement], {
             tagList: [{ mfgCode: null, namespaceId: PowerSourceTag.Grid.namespaceId, tag: PowerSourceTag.Grid.tag, label: null }],
@@ -61,19 +17,16 @@ export class HeatPump extends MatterbridgeEndpoint {
             .createDefaultDeviceEnergyManagementClusterServer(DeviceEnergyManagement.EsaType.SpaceHeating, false, DeviceEnergyManagement.EsaState.Online, absMinPower, absMaxPower)
             .createDefaultDeviceEnergyManagementModeClusterServer()
             .addRequiredClusterServers();
-        // Add the flow temperature sensor for the heat pump.
         this.addChildDeviceType('FlowTemperature', temperatureSensor, {
             tagList: [{ mfgCode: null, namespaceId: NumberTag.One.namespaceId, tag: NumberTag.One.tag, label: 'Flow' }],
         })
-            .createDefaultTemperatureMeasurementClusterServer(4500) // Default flow temperature setpoint in hundredths of degrees Celsius (45.00°C).
+            .createDefaultTemperatureMeasurementClusterServer(4500)
             .addRequiredClusterServers();
-        // Add the return temperature sensor for the heat pump.
         this.addChildDeviceType('ReturnTemperature', temperatureSensor, {
             tagList: [{ mfgCode: null, namespaceId: NumberTag.Two.namespaceId, tag: NumberTag.Two.tag, label: 'Return' }],
         })
-            .createDefaultTemperatureMeasurementClusterServer(3500) // Default return temperature setpoint in hundredths of degrees Celsius (35.00°C).
+            .createDefaultTemperatureMeasurementClusterServer(3500)
             .addRequiredClusterServers();
-        // Add the global thermostat for the heat pump.
         this.addChildDeviceType('Thermostat', thermostatDevice, {
             tagList: [{ mfgCode: null, namespaceId: NumberTag.One.namespaceId, tag: NumberTag.One.tag, label: 'Main Thermostat' }],
         })
@@ -81,4 +34,3 @@ export class HeatPump extends MatterbridgeEndpoint {
             .addRequiredClusterServers();
     }
 }
-//# sourceMappingURL=heatPump.js.map

package/dist/devices/laundryDryer.js

@@ -1,53 +1,11 @@
-/**
- * @description This file contains the LaundryDryer class.
- * @file src/devices/laundryDryer.ts
- * @author Luca Liguori
- * @created 2025-06-29
- * @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 { LaundryWasherMode } from '@matter/types/clusters/laundry-washer-mode';
 import { LaundryDryerControls } from '@matter/types/clusters/laundry-dryer-controls';
 import { LaundryDryerControlsServer } from '@matter/node/behaviors/laundry-dryer-controls';
-// Matterbridge
 import { laundryDryer, powerSource } from '../matterbridgeDeviceTypes.js';
 import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
 import { MatterbridgeLaundryWasherModeServer } from './laundryWasher.js';
 import { createLevelTemperatureControlClusterServer, createNumberTemperatureControlClusterServer } from './temperatureControl.js';
 export class LaundryDryer extends MatterbridgeEndpoint {
-    /**
-     * Creates an instance of the LaundryDryer class.
-     *
-     * @param {string} name - The name of the laundry dryer.
-     * @param {string} serial - The serial number of the laundry dryer.
-     * @param {number} [currentMode] - The current mode of the laundry dryer. 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 dryer. Defaults to a set of common modes (which include Delicate, Normal, Heavy, and Whites). Fixed attribute.
-     * @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, selectedTemperatureLevel, supportedTemperatureLevels, temperatureSetpoint, minTemperature, maxTemperature, step, operationalState) {
         super([laundryDryer, powerSource], { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
         this.createDefaultIdentifyClusterServer();
@@ -62,14 +20,6 @@ export class LaundryDryer extends MatterbridgeEndpoint {
             createLevelTemperatureControlClusterServer(this, 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 }] },
@@ -77,25 +27,16 @@ export class LaundryDryer 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 default Laundry Dryer Controls Cluster Server.
-     *
-     * @param {LaundryDryerControls.DrynessLevel} selectedDrynessLevel - The selected dryness level. Default is undefined.
-     * @param {LaundryDryerControls.DrynessLevel[]} supportedDrynessLevels - The supported dryness levels. Default is [Low, Normal, Extra, Max].
-     *
-     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
-     */
     createDefaultLaundryDryerControlsClusterServer(selectedDrynessLevel, supportedDrynessLevels) {
         this.behaviors.require(LaundryDryerControlsServer, {
             supportedDrynessLevels: supportedDrynessLevels ?? [LaundryDryerControls.DrynessLevel.Low, LaundryDryerControls.DrynessLevel.Normal, LaundryDryerControls.DrynessLevel.Extra, LaundryDryerControls.DrynessLevel.Max],
-            selectedDrynessLevel, // Writable
+            selectedDrynessLevel,
         });
         return this;
     }
 }
-//# sourceMappingURL=laundryDryer.js.map

package/dist/devices/laundryWasher.js

@@ -1,59 +1,13 @@
-/**
- * @description This file contains the LaundryWasher class.
- * @file src/devices/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/types/clusters/laundry-washer-controls';
 import { LaundryWasherMode } from '@matter/types/clusters/laundry-washer-mode';
 import { ModeBase } from '@matter/types/clusters/mode-base';
 import { LaundryWasherModeServer } from '@matter/node/behaviors/laundry-washer-mode';
 import { LaundryWasherControlsServer } from '@matter/node/behaviors/laundry-washer-controls';
-// Matterbridge
 import { laundryWasher, powerSource } from '../matterbridgeDeviceTypes.js';
 import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
 import { MatterbridgeOnOffServer, MatterbridgeServer } from '../matterbridgeBehaviors.js';
 import { createLevelTemperatureControlClusterServer, createNumberTemperatureControlClusterServer } from './temperatureControl.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, powerSource], { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
         this.createDefaultIdentifyClusterServer();
@@ -68,14 +22,6 @@ export class LaundryWasher extends MatterbridgeEndpoint {
             createLevelTemperatureControlClusterServer(this, 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 }] },
@@ -83,27 +29,17 @@ 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;
     }
@@ -114,7 +50,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})`);
@@ -139,4 +74,3 @@ export class MatterbridgeLaundryWasherModeServer extends LaundryWasherModeServer
         }
     }
 }
-//# sourceMappingURL=laundryWasher.js.map

package/dist/devices/microwaveOven.js

@@ -1,52 +1,12 @@
-/**
- * @description This file contains the MicrowaveOven class.
- * @file src/devices/microwaveOven.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 { OperationalState } from '@matter/types/clusters/operational-state';
 import { MicrowaveOvenMode } from '@matter/types/clusters/microwave-oven-mode';
 import { MicrowaveOvenControl } from '@matter/types/clusters/microwave-oven-control';
 import { MicrowaveOvenControlServer } from '@matter/node/behaviors/microwave-oven-control';
 import { MicrowaveOvenModeServer } from '@matter/node/behaviors/microwave-oven-mode';
-// Matterbridge
 import { microwaveOven, powerSource } from '../matterbridgeDeviceTypes.js';
 import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
 import { MatterbridgeServer, MatterbridgeOperationalStateServer } from '../matterbridgeBehaviors.js';
 export class MicrowaveOven extends MatterbridgeEndpoint {
-    /**
-     * Creates an instance of the MicrowaveOven class.
-     *
-     * @param {string} name - The name of the microwave oven.
-     * @param {string} serial - The serial number of the microwave oven.
-     * @param {number} currentMode - The current mode of the microwave oven. Default is 1 = Auto.
-     * @param {MicrowaveOvenMode.ModeOption[]} supportedModes - The supported modes of the microwave oven. Default is an array of all modes.
-     * @param {number} selectedWattIndex - The selected wattage index. Default is 5 (600W).
-     * @param {number[]} supportedWatts - The supported wattages. Default is an array of all standard microwave wattages.
-     * @param {number} cookTime - The initial cook time in seconds. Default is 60 seconds.
-     * @param {number} maxCookTime - The maximum cook time in seconds. Default is 3600 seconds (1 hour).
-     *
-     * @remarks
-     * - 8.12. Microwave Oven Mode Cluster
-     * - Exactly one entry in the SupportedModes attribute SHALL include the Normal mode tag in the ModeTags field.
-     * - The Normal and Defrost mode tags are mutually exclusive and SHALL NOT both be used together in a mode’s ModeTags.
-     */
     constructor(name, serial, currentMode = 1, supportedModes = [
         { label: 'Auto', mode: 1, modeTags: [{ value: MicrowaveOvenMode.ModeTag.Auto }] },
         { label: 'Quick', mode: 2, modeTags: [{ value: MicrowaveOvenMode.ModeTag.Quick }] },
@@ -55,8 +15,7 @@ export class MicrowaveOven extends MatterbridgeEndpoint {
         { label: 'Max', mode: 5, modeTags: [{ value: MicrowaveOvenMode.ModeTag.Max }] },
         { label: 'Normal', mode: 6, modeTags: [{ value: MicrowaveOvenMode.ModeTag.Normal }] },
         { label: 'Defrost', mode: 7, modeTags: [{ value: MicrowaveOvenMode.ModeTag.Defrost }] },
-    ], selectedWattIndex = 5, supportedWatts = [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000], cookTime = 60, // 1 minute
-    maxCookTime = 3600) {
+    ], selectedWattIndex = 5, supportedWatts = [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000], cookTime = 60, maxCookTime = 3600) {
         super([microwaveOven, powerSource], { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
         this.createDefaultIdentifyClusterServer();
         this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Microwave Oven');
@@ -65,69 +24,32 @@ export class MicrowaveOven extends MatterbridgeEndpoint {
         this.createDefaultMicrowaveOvenModeClusterServer(currentMode, supportedModes);
         this.createDefaultMicrowaveOvenControlClusterServer(selectedWattIndex, supportedWatts, cookTime, maxCookTime);
     }
-    /**
-     * Creates a default MicrowaveOvenMode Cluster Server.
-     * There is no changeToMode command in the spec, so this is not implemented.
-     * The Microwave is controlled by the MicrowaveOvenControl cluster.
-     *
-     * @param {number} currentMode - The current mode of the oven.
-     * @param {MicrowaveOvenMode.ModeOption[]} supportedModes - The supported modes.
-     *
-     * @returns {MatterbridgeEndpoint} The current MatterbridgeEndpoint instance for chaining.
-     *
-     * @remarks
-     * - 8.12. Microwave Oven Mode Cluster
-     * - the supported modes are fixed and cannot be changed at runtime.
-     * - the current mode is persistent among reboots.
-     * - Exactly one entry in the SupportedModes attribute SHALL include the Normal mode tag in the ModeTags field.
-     * - The Normal and Defrost mode tags are mutually exclusive and SHALL NOT both be used together in a mode’s ModeTags.
-     */
     createDefaultMicrowaveOvenModeClusterServer(currentMode, supportedModes) {
         this.behaviors.require(MicrowaveOvenModeServer, {
-            supportedModes, // Fixed attribute
-            currentMode, // Persistent attribute
+            supportedModes,
+            currentMode,
         });
         return this;
     }
-    /**
-     * Creates a default MicrowaveOvenControl Cluster Server.
-     *
-     * @param {number} selectedWattIndex - The selected watt index.
-     * @param {number[]} supportedWatts - The supported watt values.
-     * @param {number} cookTime - The initial cook time.
-     * @param {number} maxCookTime - The maximum cook time.
-     *
-     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
-     *
-     * @remarks
-     * - 8.13. Microwave Oven Control Cluster
-     * - the supported watt values are fixed and cannot be changed at runtime.
-     * - the maxCookTime is a fixed attribute and cannot be changed at runtime.
-     */
     createDefaultMicrowaveOvenControlClusterServer(selectedWattIndex, supportedWatts, cookTime, maxCookTime) {
         this.behaviors.require(MatterbridgeMicrowaveOvenControlServer.with(MicrowaveOvenControl.Feature.PowerInWatts), {
-            supportedWatts, // Fixed attribute
+            supportedWatts,
             selectedWattIndex,
             cookTime,
-            maxCookTime, // Fixed attribute
+            maxCookTime,
         });
         return this;
     }
 }
-/**
- * Matterbridge Microwave Oven Control Server
- */
 export class MatterbridgeMicrowaveOvenControlServer extends MicrowaveOvenControlServer.with(MicrowaveOvenControl.Feature.PowerInWatts) {
     initialize() {
         const device = this.endpoint.stateOf(MatterbridgeServer);
         device.log.info('MatterbridgeMicrowaveOvenControlServer initialized');
     }
-    // 8.13.6.2. SetCookingParameters Command
     setCookingParameters(request) {
         const device = this.endpoint.stateOf(MatterbridgeServer);
         device.log.info(`MatterbridgeMicrowaveOvenControlServer: setCookingParameters (endpoint ${this.endpoint.maybeId}.${this.endpoint.maybeNumber})`);
         device.commandHandler.executeHandler('setCookingParameters', { request, cluster: MicrowaveOvenControl.Cluster.id, attributes: this.state, endpoint: this.endpoint });
-        // 8.13.6.2.1. CookMode Field. Default to Normal mode if not present.
         if (request.cookMode !== undefined) {
             device.log.info(`MatterbridgeMicrowaveOvenControlServer: setCookingParameters called setting cookMode to ${request.cookMode}`);
             this.endpoint.setStateOf(MicrowaveOvenModeServer, { currentMode: request.cookMode });
@@ -138,7 +60,6 @@ export class MatterbridgeMicrowaveOvenControlServer extends MicrowaveOvenControl
             const normalMode = supportedModes.find((mode) => mode.modeTags.some((tag) => tag.value === MicrowaveOvenMode.ModeTag.Normal));
             this.endpoint.setStateOf(MicrowaveOvenModeServer, { currentMode: normalMode?.mode });
         }
-        // 8.13.6.2.2. CookTime Field. Default to 30 seconds.
         if (request.cookTime !== undefined && request.cookTime >= 0 && request.cookTime <= this.state.maxCookTime) {
             device.log.info(`MatterbridgeMicrowaveOvenControlServer: setCookingParameters called setting cookTime to ${request.cookTime}`);
             this.state.cookTime = request.cookTime;
@@ -147,7 +68,6 @@ export class MatterbridgeMicrowaveOvenControlServer extends MicrowaveOvenControl
             device.log.info(`MatterbridgeMicrowaveOvenControlServer: setCookingParameters called with no cookTime so set to 30sec.`);
             this.state.cookTime = 30;
         }
-        // 8.13.6.2.4. WattSettingIndex Field. Default the highest Watt setting for the selected CookMode.
         if (request.wattSettingIndex !== undefined && request.wattSettingIndex >= 0 && request.wattSettingIndex < this.state.supportedWatts.length) {
             device.log.info(`MatterbridgeMicrowaveOvenControlServer: setCookingParameters called setting selectedWattIndex to ${request.wattSettingIndex}`);
             this.state.selectedWattIndex = request.wattSettingIndex;
@@ -156,13 +76,11 @@ export class MatterbridgeMicrowaveOvenControlServer extends MicrowaveOvenControl
             device.log.info(`MatterbridgeMicrowaveOvenControlServer: setCookingParameters called with no wattSettingIndex so set to the highest Watt setting for the selected CookMode`);
             this.state.selectedWattIndex = this.state.supportedWatts.length - 1;
         }
-        // 8.13.6.2.5. StartAfterSetting Field. Default to false.
         if (request.startAfterSetting === true) {
             device.log.info(`MatterbridgeMicrowaveOvenControlServer: setCookingParameters called setting startAfterSetting = true`);
             this.endpoint.setStateOf(MatterbridgeOperationalStateServer, { operationalState: OperationalState.OperationalStateEnum.Running });
         }
     }
-    // 8.13.6.3. AddMoreTime Command
     addMoreTime(request) {
         const device = this.endpoint.stateOf(MatterbridgeServer);
         device.log.info(`MatterbridgeMicrowaveOvenControlServer: addMoreTime (endpoint ${this.endpoint.maybeId}.${this.endpoint.maybeNumber})`);
@@ -176,4 +94,3 @@ export class MatterbridgeMicrowaveOvenControlServer extends MicrowaveOvenControl
         }
     }
 }
-//# sourceMappingURL=microwaveOven.js.map