matterbridge 3.4.0 → 3.4.1-dev-20251127-826b2bf

package/dist/devices/roboticVacuumCleaner.js

@@ -1,26 +1,3 @@
-/**
- * @description This file contains the RoboticVacuumCleaner class.
- * @file src/devices/roboticVacuumCleaner.ts
- * @author Luca Liguori
- * @created 2025-05-01
- * @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.
- */
-// Matter.js
 import { AreaNamespaceTag } from '@matter/node';
 import { PowerSource } from '@matter/types/clusters/power-source';
 import { RvcRunMode } from '@matter/types/clusters/rvc-run-mode';
@@ -32,30 +9,10 @@ import { OperationalState } from '@matter/types/clusters/operational-state';
 import { RvcRunModeServer } from '@matter/node/behaviors/rvc-run-mode';
 import { RvcOperationalStateServer } from '@matter/node/behaviors/rvc-operational-state';
 import { RvcCleanModeServer } from '@matter/node/behaviors/rvc-clean-mode';
-// Matterbridge
 import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
 import { powerSource, roboticVacuumCleaner } from '../matterbridgeDeviceTypes.js';
 import { MatterbridgeServer, MatterbridgeServiceAreaServer } from '../matterbridgeBehaviors.js';
 export class RoboticVacuumCleaner extends MatterbridgeEndpoint {
-    /**
-     * Creates an instance of the RoboticVacuumCleaner class.
-     *
-     * @param {string} name - The name of the robotic vacuum cleaner.
-     * @param {string} serial - The serial number of the robotic vacuum cleaner.
-     * @param {'server' | 'matter' | undefined} [mode] - The mode of the robotic vacuum cleaner. Defaults to undefined. Use 'server' or 'matter' if you want Apple Home compatibility.
-     * @param {number} [currentRunMode] - The current run mode of the robotic vacuum cleaner. Defaults to 1 (Idle).
-     * @param {RvcRunMode.ModeOption[]} [supportedRunModes] - The supported run modes for the robotic vacuum cleaner. Defaults to a predefined set of modes.
-     * @param {number} [currentCleanMode] - The current clean mode of the robotic vacuum cleaner. Defaults to 1 (Vacuum).
-     * @param {RvcCleanMode.ModeOption[]} [supportedCleanModes] - The supported clean modes for the robotic vacuum cleaner. Defaults to a predefined set of modes.
-     * @param {number | null} [currentPhase] - The current phase of the robotic vacuum cleaner. Defaults to null.
-     * @param {string[] | null} [phaseList] - The list of phases for the robotic vacuum cleaner. Defaults to null.
-     * @param {RvcOperationalState.OperationalState} [operationalState] - The current operational state of the robotic vacuum cleaner. Defaults to Docked.
-     * @param {RvcOperationalState.OperationalStateStruct[]} [operationalStateList] - The list of operational states for the robotic vacuum cleaner. Defaults to a predefined set of states.
-     * @param {ServiceArea.Area[]} [supportedAreas] - The supported areas for the robotic vacuum cleaner. Defaults to a predefined set of areas.
-     * @param {number[]} [selectedAreas] - The selected areas for the robotic vacuum cleaner. Defaults to an empty array (all areas allowed).
-     * @param {number} [currentArea] - The current area of the robotic vacuum cleaner. Defaults to 1 (Living).
-     * @param {ServiceArea.Map[]} [supportedMaps] - The supported maps for the robotic vacuum cleaner. Defaults to empty list.
-     */
     constructor(name, serial, mode = undefined, currentRunMode, supportedRunModes, currentCleanMode, supportedCleanModes, currentPhase = null, phaseList = null, operationalState, operationalStateList, supportedAreas, selectedAreas, currentArea, supportedMaps) {
         super([roboticVacuumCleaner, powerSource], { id: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}`, mode });
         this.createDefaultIdentifyClusterServer()
@@ -66,17 +23,6 @@ export class RoboticVacuumCleaner extends MatterbridgeEndpoint {
             .createDefaultRvcOperationalStateClusterServer(phaseList, currentPhase, operationalStateList, operationalState)
             .createDefaultServiceAreaClusterServer(supportedAreas, selectedAreas, currentArea, supportedMaps);
     }
-    /**
-     * Creates a default RvcRunMode Cluster Server.
-     *
-     * @param {number} [currentMode] - The current mode of the RvcRunMode cluster. Defaults to 1 (Idle).
-     * @param {RvcRunMode.ModeOption[]} [supportedModes] - The supported modes for the RvcRunMode cluster. Defaults to a predefined set of modes.
-     *
-     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
-     *
-     * @remarks
-     * - supportedModes is a fixed attribute that defines the run modes available for the robotic vacuum cleaner.
-     */
     createDefaultRvcRunModeClusterServer(currentMode, supportedModes) {
         this.behaviors.require(MatterbridgeRvcRunModeServer, {
             supportedModes: supportedModes ?? [
@@ -89,17 +35,6 @@ export class RoboticVacuumCleaner extends MatterbridgeEndpoint {
         });
         return this;
     }
-    /**
-     * Creates a default RvcCleanMode Cluster Server.
-     *
-     * @param {number} [currentMode] - The current mode of the RvcCleanMode cluster. Defaults to 1 (Vacuum).
-     * @param {RvcCleanMode.ModeOption[]} [supportedModes] - The supported modes for the RvcCleanMode cluster. Defaults to a predefined set of modes.
-     *
-     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
-     *
-     * @remarks
-     * - supportedModes is a fixed attribute that defines the clean modes available for the robotic vacuum cleaner.
-     */
     createDefaultRvcCleanModeClusterServer(currentMode, supportedModes) {
         this.behaviors.require(MatterbridgeRvcCleanModeServer, {
             supportedModes: supportedModes ?? [
@@ -111,15 +46,6 @@ export class RoboticVacuumCleaner extends MatterbridgeEndpoint {
         });
         return this;
     }
-    /**
-     * Creates a default ServiceArea Cluster Server.
-     *
-     * @param {ServiceArea.Area[]} [supportedAreas] - The supported areas for the ServiceArea cluster. Defaults to a predefined set of areas.
-     * @param {number[]} [selectedAreas] - The selected areas for the ServiceArea cluster. Defaults to an empty array (all areas allowed).
-     * @param {number} [currentArea] - The current areaId (not the index in the array!) of the ServiceArea cluster. Defaults to 1 (Living).
-     * @param {ServiceArea.Map[]} [supportedMaps] - The supported maps for the robotic vacuum cleaner. Defaults empty list.
-     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
-     */
     createDefaultServiceAreaClusterServer(supportedAreas, selectedAreas, currentArea, supportedMaps) {
         this.behaviors.require(MatterbridgeServiceAreaServer.with(ServiceArea.Feature.Maps), {
             supportedAreas: supportedAreas ?? [
@@ -144,28 +70,13 @@ export class RoboticVacuumCleaner extends MatterbridgeEndpoint {
                     areaInfo: { locationInfo: { locationName: 'Bathroom', floorNumber: 1, areaType: AreaNamespaceTag.Bathroom.tag }, landmarkInfo: null },
                 },
             ],
-            selectedAreas: selectedAreas ?? [], // Indicates the set of areas where the device SHOULD attempt to operate. If this attribute is empty, the device is not constrained to operate in any specific areas.
-            currentArea: currentArea ?? 1, // If not null, the value of this attribute shall match the AreaID field of an entry on the SupportedAreas attribute’s list. A null value indicates that the device is currently unable to provide this information.
-            supportedMaps: supportedMaps ?? [], // If empty, that indicates that the device is currently unable to provide this information
-            /**
-             * Indicates the estimated Epoch time for completing operating at the area indicated by the CurrentArea attribute, in seconds. A value of 0 means that the operation has completed.
-             * When this attribute is null, that represents that there is no time currently defined until operation completion.
-             * This attribute SHALL be null if the CurrentArea attribute is null.
-             */
+            selectedAreas: selectedAreas ?? [],
+            currentArea: currentArea ?? 1,
+            supportedMaps: supportedMaps ?? [],
             estimatedEndTime: null,
         });
         return this;
     }
-    /**
-     * Creates a default RvcOperationalState Cluster Server.
-     *
-     * @param {string[] | null} [phaseList] - The list of phases for the RvcOperationalState cluster. Defaults to null.
-     * @param {number | null} [currentPhase] - The current phase (the index of the phaseList) of the RvcOperationalState cluster. Defaults to null.
-     * @param {RvcOperationalState.OperationalStateStruct[]} [operationalStateList] - The list of operational states for the RvcOperationalState cluster. Defaults to a predefined set of states.
-     * @param {RvcOperationalState.OperationalState} [operationalState] - The current operationalStateId of the RvcOperationalState cluster. Defaults to Docked.
-     * @param {RvcOperationalState.ErrorStateStruct} [operationalError] - The current operational error of the RvcOperationalState cluster. Defaults to NoError.
-     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
-     */
     createDefaultRvcOperationalStateClusterServer(phaseList = null, currentPhase = null, operationalStateList, operationalState, operationalError) {
         this.behaviors.require(MatterbridgeRvcOperationalStateServer, {
             phaseList,
@@ -175,9 +86,9 @@ export class RoboticVacuumCleaner extends MatterbridgeEndpoint {
                 { operationalStateId: RvcOperationalState.OperationalState.Running },
                 { operationalStateId: RvcOperationalState.OperationalState.Paused },
                 { operationalStateId: RvcOperationalState.OperationalState.Error },
-                { operationalStateId: RvcOperationalState.OperationalState.SeekingCharger }, // Y RVC Pause Compatibility N RVC Resume Compatibility
-                { operationalStateId: RvcOperationalState.OperationalState.Charging }, // N RVC Pause Compatibility Y RVC Resume Compatibility
-                { operationalStateId: RvcOperationalState.OperationalState.Docked }, // N RVC Pause Compatibility Y RVC Resume Compatibility
+                { operationalStateId: RvcOperationalState.OperationalState.SeekingCharger },
+                { operationalStateId: RvcOperationalState.OperationalState.Charging },
+                { operationalStateId: RvcOperationalState.OperationalState.Docked },
             ],
             operationalState: operationalState ?? RvcOperationalState.OperationalState.Docked,
             operationalError: operationalError ?? { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateDetails: 'Fully operational' },
@@ -232,7 +143,7 @@ export class MatterbridgeRvcOperationalStateServer extends RvcOperationalStateSe
         device.log.info(`Pause (endpoint ${this.endpoint.maybeId}.${this.endpoint.maybeNumber})`);
         device.commandHandler.executeHandler('pause', { request: {}, cluster: RvcOperationalStateServer.id, attributes: this.state, endpoint: this.endpoint });
         device.log.debug('MatterbridgeRvcOperationalStateServer: pause called setting operational state to Paused and currentMode to Idle');
-        this.agent.get(MatterbridgeRvcRunModeServer).state.currentMode = 1; // RvcRunMode.ModeTag.Idle
+        this.agent.get(MatterbridgeRvcRunModeServer).state.currentMode = 1;
         this.state.operationalState = RvcOperationalState.OperationalState.Paused;
         this.state.operationalError = { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateDetails: 'Fully operational' };
         return {
@@ -244,7 +155,7 @@ export class MatterbridgeRvcOperationalStateServer extends RvcOperationalStateSe
         device.log.info(`Resume (endpoint ${this.endpoint.maybeId}.${this.endpoint.maybeNumber})`);
         device.commandHandler.executeHandler('resume', { request: {}, cluster: RvcOperationalStateServer.id, attributes: this.state, endpoint: this.endpoint });
         device.log.debug('MatterbridgeRvcOperationalStateServer: resume called setting operational state to Running and currentMode to Cleaning');
-        this.agent.get(MatterbridgeRvcRunModeServer).state.currentMode = 2; // RvcRunMode.ModeTag.Cleaning
+        this.agent.get(MatterbridgeRvcRunModeServer).state.currentMode = 2;
         this.state.operationalState = RvcOperationalState.OperationalState.Running;
         this.state.operationalError = { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateDetails: 'Fully operational' };
         return {
@@ -252,12 +163,11 @@ export class MatterbridgeRvcOperationalStateServer extends RvcOperationalStateSe
         };
     }
     goHome() {
-        // const device = this.agent.get(MatterbridgeServer).state.deviceCommand;
         const device = this.endpoint.stateOf(MatterbridgeServer);
         device.log.info(`GoHome (endpoint ${this.endpoint.maybeId}.${this.endpoint.maybeNumber})`);
         device.commandHandler.executeHandler('goHome', { request: {}, cluster: RvcOperationalStateServer.id, attributes: this.state, endpoint: this.endpoint });
         device.log.debug('MatterbridgeRvcOperationalStateServer: goHome called setting operational state to Docked and currentMode to Idle');
-        this.agent.get(MatterbridgeRvcRunModeServer).state.currentMode = 1; // RvcRunMode.ModeTag.Idle
+        this.agent.get(MatterbridgeRvcRunModeServer).state.currentMode = 1;
         this.state.operationalState = RvcOperationalState.OperationalState.Docked;
         this.state.operationalError = { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateDetails: 'Fully operational' };
         return {
@@ -265,4 +175,3 @@ export class MatterbridgeRvcOperationalStateServer extends RvcOperationalStateSe
         };
     }
 }
-//# sourceMappingURL=roboticVacuumCleaner.js.map

package/dist/devices/solarPower.js

@@ -1,45 +1,8 @@
-/**
- * @description This file contains the SolarPower class.
- * @file src/devices/solarPower.ts
- * @author Luca Liguori
- * @contributor Ludovic BOUÉ
- * @created 2025-06-14
- * @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 { PowerSourceTag } from '@matter/node';
 import { DeviceEnergyManagement } from '@matter/types/clusters/device-energy-management';
-// Matterbridge
 import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
 import { deviceEnergyManagement, electricalSensor, solarPower, powerSource } from '../matterbridgeDeviceTypes.js';
 export class SolarPower extends MatterbridgeEndpoint {
-    /**
-     * Creates an instance of the SolarPower class.
-     *
-     * @param {string} name - The name of the SolarPower.
-     * @param {string} serial - The serial number of the SolarPower.
-     * @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} energyExported - 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.
-     */
     constructor(name, serial, voltage = null, current = null, power = null, energyExported = null, absMinPower = 0, absMaxPower = 0) {
         super([solarPower, powerSource, electricalSensor, deviceEnergyManagement], {
             tagList: [{ mfgCode: null, namespaceId: PowerSourceTag.Solar.namespaceId, tag: PowerSourceTag.Solar.tag, label: null }],
@@ -56,4 +19,3 @@ export class SolarPower extends MatterbridgeEndpoint {
             .addRequiredClusterServers();
     }
 }
-//# sourceMappingURL=solarPower.js.map

package/dist/devices/speaker.js

@@ -1,60 +1,9 @@
-/**
- * @description Speaker device class controlling mute (On/Off) and volume level (Level Control).
- * @file src/devices/speaker.ts
- * @author Luca Liguori
- * @created 2025-09-04
- * @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 clusters
 import { OnOff } from '@matter/types/clusters/on-off';
 import { LevelControl } from '@matter/types/clusters/level-control';
-// matterbridge
 import { speakerDevice } from '../matterbridgeDeviceTypes.js';
 import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
-/**
- * Represents a Speaker endpoint (Device Type 0x0022) exposing mute (OnOff) and volume (LevelControl).
- *
- * Mapping:
- *  - OnOff TRUE  => audio unmuted
- *  - OnOff FALSE => audio muted
- *  - LevelControl.currentLevel (1..254) => volume (linear map to 0..100%)
- *
- * Edge cases:
- *  - Volume < 1 coerced to 1.
- *  - Volume > 254 coerced to 254.
- *  - Non‑finite volume falls back to 128 (≈ mid level).
- */
 export class Speaker extends MatterbridgeEndpoint {
-    /**
-     * Create Speaker endpoint.
-     *
-     * @param {string} name   Human readable device name.
-     * @param {string} serial Unique serial (used to derive storage key).
-     * @param {boolean} muted Initial muted state (true => unmuted, default true if omitted).
-     * @param {number} volume Initial volume (1..254, coerced; default 128 ≈ 50% if omitted).
-     * @returns {Speaker} New speaker instance.
-     *
-     * @remarks Supported by:
-     * - SmartThings (OnOff mute, LevelControl volume)
-     * - Google Home (OnOff mute, LevelControl volume)
-     */
     constructor(name, serial, muted = false, volume = 128) {
-        // sanitize volume
         if (!Number.isFinite(volume))
             volume = 128;
         if (volume < 1)
@@ -63,42 +12,15 @@ export class Speaker extends MatterbridgeEndpoint {
             volume = 254;
         super([speakerDevice], { id: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` });
         this.createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge Speaker');
-        // On/Off used for mute state (TRUE => unmuted) - using no features
         this.createOnOffClusterServer(!muted);
-        // LevelControl for volume - using no features
         this.createLevelControlClusterServer(volume);
     }
-    /**
-     * Set mute state (true => muted / audio off).
-     *
-     * Edge cases:
-     *  - Strict boolean; caller must pass boolean (TS enforces).
-     *
-     * @param {boolean} muted Desired mute state (true => muted, false => unmuted).
-     * @returns {Promise<void>} Resolves when attribute is updated.
-     */
     async setMuted(muted) {
         await this.setAttribute(OnOff.Cluster.id, 'onOff', !muted);
     }
-    /**
-     * Get mute state.
-     *
-     * @returns {boolean} TRUE when muted, FALSE when unmuted.
-     */
     isMuted() {
         return !this.getAttribute(OnOff.Cluster.id, 'onOff');
     }
-    /**
-     * Set volume level (1..254).
-     *
-     * Edge cases:
-     *  - Non‑finite input ignored.
-     *  - <1 coerced to 1.
-     *  - >254 coerced to 254.
-     *
-     * @param {number} level Raw level (1..254 recommended, coerced if outside range).
-     * @returns {Promise<void>} Resolves when attribute is updated.
-     */
     async setVolume(level) {
         if (!Number.isFinite(level))
             return;
@@ -108,13 +30,7 @@ export class Speaker extends MatterbridgeEndpoint {
             level = 254;
         await this.setAttribute(LevelControl.Cluster.id, 'currentLevel', level);
     }
-    /**
-     * Get current volume.
-     *
-     * @returns {number} Current level (1..254).
-     */
     getVolume() {
         return this.getAttribute(LevelControl.Cluster.id, 'currentLevel');
     }
 }
-//# sourceMappingURL=speaker.js.map

package/dist/devices/temperatureControl.js

@@ -1,15 +1,6 @@
 import { TemperatureControl } from '@matter/types/clusters/temperature-control';
 import { TemperatureControlServer } from '@matter/node/behaviors/temperature-control';
 import { MatterbridgeServer } from '../matterbridgeBehaviors.js';
-/**
- * Creates a TemperatureControl Cluster Server with feature TemperatureLevel.
- *
- * @param {MatterbridgeEndpoint} endpoint - The Matterbridge endpoint instance.
- * @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°'].
- *
- * @returns {this} The current MatterbridgeEndpoint instance for chaining.
- */
 export function createLevelTemperatureControlClusterServer(endpoint, selectedTemperatureLevel = 1, supportedTemperatureLevels = ['Cold', 'Warm', 'Hot', '30°', '40°', '60°', '80°']) {
     endpoint.behaviors.require(MatterbridgeLevelTemperatureControlServer.with(TemperatureControl.Feature.TemperatureLevel), {
         selectedTemperatureLevel,
@@ -17,23 +8,12 @@ export function createLevelTemperatureControlClusterServer(endpoint, selectedTem
     });
     return endpoint;
 }
-/**
- * Creates a TemperatureControl Cluster Server with features TemperatureNumber and TemperatureStep.
- *
- * @param {MatterbridgeEndpoint} endpoint - The Matterbridge endpoint instance.
- * @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.
- */
 export function createNumberTemperatureControlClusterServer(endpoint, temperatureSetpoint = 40 * 100, minTemperature = 30 * 100, maxTemperature = 60 * 100, step = 10 * 100) {
     endpoint.behaviors.require(MatterbridgeNumberTemperatureControlServer.with(TemperatureControl.Feature.TemperatureNumber, TemperatureControl.Feature.TemperatureStep), {
         temperatureSetpoint,
-        minTemperature, // Fixed attribute
-        maxTemperature, // Fixed attribute
-        step, // Fixed attribute
+        minTemperature,
+        maxTemperature,
+        step,
     });
     return endpoint;
 }
@@ -75,4 +55,3 @@ export class MatterbridgeNumberTemperatureControlServer extends TemperatureContr
         }
     }
 }
-//# sourceMappingURL=temperatureControl.js.map

package/dist/devices/waterHeater.js

@@ -1,26 +1,3 @@
-/**
- * @description This file contains the WaterHeater class.
- * @file src/devices/waterHeater.ts
- * @author Luca Liguori
- * @contributor Ludovic BOUÉ
- * @created 2025-05-18
- * @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 { ModeBase } from '@matter/types/clusters/mode-base';
 import { WaterHeaterManagement } from '@matter/types/clusters/water-heater-management';
 import { WaterHeaterMode } from '@matter/types/clusters/water-heater-mode';
@@ -31,29 +8,6 @@ import { MatterbridgeServer } from '../matterbridgeBehaviors.js';
 import { electricalSensor, powerSource, waterHeater } from '../matterbridgeDeviceTypes.js';
 import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
 export class WaterHeater extends MatterbridgeEndpoint {
-    /**
-     * Creates an instance of the WaterHeater class.
-     *
-     * @param {string} name - The name of the water heater.
-     * @param {string} serial - The serial number of the water heater.
-     * @param {number} [waterTemperature] - The current water temperature. Defaults to 50.
-     * @param {number} [targetWaterTemperature] - The target water temperature. Defaults to 55.
-     * @param {number} [minHeatSetpointLimit] - The minimum heat setpoint limit. Defaults to 20.
-     * @param {number} [maxHeatSetpointLimit] - The maximum heat setpoint limit. Defaults to 80.
-     * @param {{ immersionElement1?: boolean; immersionElement2?: boolean; heatPump?: boolean; boiler?: boolean; other?: boolean }} [heaterTypes] - Indicates the heat sources that the water heater can call on for heating. Defaults to { immersionElement1: true }.
-     * @param {boolean} heaterTypes.immersionElement1 - Indicates if the water heater has an immersion element 1. Defaults to true.
-     * @param {boolean} heaterTypes.immersionElement2 - Indicates if the water heater has an immersion element 2.
-     * @param {boolean} heaterTypes.heatPump - Indicates if the water heater has a heat pump.
-     * @param {boolean} heaterTypes.boiler - Indicates if the water heater has a boiler.
-     * @param {boolean} heaterTypes.other - Indicates if the water heater has other types of heating sources.
-     * @param {number} [tankPercentage] - The current tank percentage of the WaterHeaterManagement cluster. Defaults to 90.
-     * @param {number} [voltage] - The voltage value in millivolts. Defaults to null if not provided.
-     * @param {number} [current] - The current value in milliamperes. Defaults to null if not provided.
-     * @param {number} [power] - The power value in milliwatts. Defaults to null if not provided.
-     * @param {number} [energy] - The total consumption value in mW/h. Defaults to null if not provided.
-     * @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.
-     */
     constructor(name, serial, waterTemperature = 50, targetWaterTemperature = 55, minHeatSetpointLimit = 20, maxHeatSetpointLimit = 80, heaterTypes = { immersionElement1: true }, tankPercentage = 90, voltage = null, current = null, power = null, energy = null, absMinPower = 0, absMaxPower = 0) {
         super([waterHeater, powerSource, electricalSensor], { id: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` });
         this.createDefaultIdentifyClusterServer()
@@ -68,42 +22,15 @@ export class WaterHeater extends MatterbridgeEndpoint {
             .createDefaultDeviceEnergyManagementClusterServer(DeviceEnergyManagement.EsaType.WaterHeating, true, DeviceEnergyManagement.EsaState.Online, absMinPower, absMaxPower)
             .createDefaultDeviceEnergyManagementModeClusterServer();
     }
-    /**
-     * Creates a default WaterHeaterManagement Cluster Server.
-     *
-     * @param {{ immersionElement1?: boolean; immersionElement2?: boolean; heatPump?: boolean; boiler?: boolean; other?: boolean }} [heaterTypes] - Indicates the heat sources that the water heater can call on for heating. Defaults to { immersionElement1: true }.
-     * @param {boolean} heaterTypes.immersionElement1 - Indicates if the water heater has an immersion element 1. Defaults to true.
-     * @param {boolean} heaterTypes.immersionElement2 - Indicates if the water heater has an immersion element 2.
-     * @param {boolean} heaterTypes.heatPump - Indicates if the water heater has a heat pump.
-     * @param {boolean} heaterTypes.boiler - Indicates if the water heater has a boiler.
-     * @param {boolean} heaterTypes.other - Indicates if the water heater has other types of heating sources.
-     * @param {{ immersionElement1?: boolean; immersionElement2?: boolean; heatPump?: boolean; boiler?: boolean; other?: boolean }} [heatDemand] - Indicates if the water heater is heating water. Defaults to all heat sources unset.
-     * @param {boolean} heatDemand.immersionElement1 - Indicates if the water heater is heating water with immersion element 1. Defaults to false.
-     * @param {boolean} heatDemand.immersionElement2 - Indicates if the water heater is heating water with immersion element 2.
-     * @param {boolean} heatDemand.heatPump - Indicates if the water heater is heating water with a heat pump.
-     * @param {boolean} heatDemand.boiler - Indicates if the water heater is heating water with a boiler.
-     * @param {boolean} heatDemand.other - Indicates if the water heater is heating water with other types of heating sources.
-     * @param {number} [tankPercentage] - The current tank percentage of the WaterHeaterManagement cluster. Defaults to 100.
-     * @param {WaterHeaterManagement.BoostState} [boostState] - The current boost state of the WaterHeaterManagement cluster. Defaults to Inactive.
-     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
-     */
     createDefaultWaterHeaterManagementClusterServer(heaterTypes, heatDemand, tankPercentage, boostState) {
         this.behaviors.require(MatterbridgeWaterHeaterManagementServer.with(WaterHeaterManagement.Feature.TankPercent), {
-            heaterTypes: heaterTypes ?? { immersionElement1: true }, // Fixed attribute
+            heaterTypes: heaterTypes ?? { immersionElement1: true },
             heatDemand: heatDemand ?? {},
             tankPercentage: tankPercentage ?? 100,
             boostState: boostState ?? WaterHeaterManagement.BoostState.Inactive,
         });
         return this;
     }
-    /**
-     * Creates a default WaterHeaterMode Cluster Server.
-     *
-     * @param {number} [currentMode] - The current mode of the WaterHeaterMode cluster. Defaults to mode 1 (WaterHeaterMode.ModeTag.Auto).
-     * @param {WaterHeaterMode.ModeOption[]} [supportedModes] - The supported modes for the WaterHeaterMode cluster. Defaults all cluster modes.
-     *
-     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
-     */
     createDefaultWaterHeaterModeClusterServer(currentMode, supportedModes) {
         this.behaviors.require(MatterbridgeWaterHeaterModeServer, {
             supportedModes: supportedModes ?? [
@@ -120,7 +47,7 @@ export class WaterHeater extends MatterbridgeEndpoint {
                 { label: 'Off', mode: 11, modeTags: [{ value: WaterHeaterMode.ModeTag.Off }] },
                 { label: 'Manual', mode: 12, modeTags: [{ value: WaterHeaterMode.ModeTag.Manual }] },
                 { label: 'Timed', mode: 13, modeTags: [{ value: WaterHeaterMode.ModeTag.Timed }] },
-            ], // Fixed attribute
+            ],
             currentMode: currentMode ?? 1,
         });
         return this;
@@ -133,9 +60,6 @@ export class MatterbridgeWaterHeaterManagementServer extends WaterHeaterManageme
         device.commandHandler.executeHandler('boost', { request, cluster: WaterHeaterManagementServer.id, attributes: this.state, endpoint: this.endpoint });
         device.log.debug(`MatterbridgeWaterHeaterManagementServer boost called with: ${JSON.stringify(request)}`);
         this.state.boostState = WaterHeaterManagement.BoostState.Active;
-        // The implementation is responsible for setting the device accordingly with the boostInfo of the boost command
-        // super.boost({ boostInfo });
-        // boost is not implemented in matter.js
     }
     cancelBoost() {
         const device = this.endpoint.stateOf(MatterbridgeServer);
@@ -143,9 +67,6 @@ export class MatterbridgeWaterHeaterManagementServer extends WaterHeaterManageme
         device.commandHandler.executeHandler('cancelBoost', { request: {}, cluster: WaterHeaterManagementServer.id, attributes: this.state, endpoint: this.endpoint });
         device.log.debug(`MatterbridgeWaterHeaterManagementServer cancelBoost called`);
         this.state.boostState = WaterHeaterManagement.BoostState.Inactive;
-        // The implementation is responsible for setting the device accordingly with the cancelBoost command
-        // super.cancelBoost();
-        // cancelBoost is not implemented in matter.js
     }
 }
 export class MatterbridgeWaterHeaterModeServer extends WaterHeaterModeServer {
@@ -163,4 +84,3 @@ export class MatterbridgeWaterHeaterModeServer extends WaterHeaterModeServer {
         return { status: ModeBase.ModeChangeStatus.Success, statusText: 'Success' };
     }
 }
-//# sourceMappingURL=waterHeater.js.map