matterbridge 3.0.7 → 3.0.8-dev-20250622-f9e44a2

package/dist/waterHeater.js

@@ -1,48 +1,12 @@
-/**
- * This file contains the WaterHeater class.
- *
- * @file waterHeater.ts
- * @author Luca Liguori
- * @contributor Ludovic BOUÉ
- * @date 2025-05-18
- * @version 1.1.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. *
- */
-// Matterbridge
-import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
-import { waterHeater } from './matterbridgeDeviceTypes.js';
-import { MatterbridgeServer } from './matterbridgeBehaviors.js';
 import { ModeBase } from '@matter/main/clusters/mode-base';
 import { WaterHeaterManagement } from '@matter/main/clusters/water-heater-management';
 import { WaterHeaterMode } from '@matter/main/clusters/water-heater-mode';
 import { WaterHeaterManagementServer } from '@matter/main/behaviors/water-heater-management';
 import { WaterHeaterModeServer } from '@matter/main/behaviors/water-heater-mode';
+import { MatterbridgeServer } from './matterbridgeBehaviors.js';
+import { 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=50] - The current water temperature. Defaults to 50.
-     * @param {number} [targetWaterTemperature=55] - The target water temperature. Defaults to 55.
-     * @param {number} [minHeatSetpointLimit=20] - The minimum heat setpoint limit. Defaults to 20.
-     * @param {number} [maxHeatSetpointLimit=80] - 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 {number} [tankPercentage] - The current tank percentage of the WaterHeaterManagement cluster. Defaults to 90.
-     */
     constructor(name, serial, waterTemperature = 50, targetWaterTemperature = 55, minHeatSetpointLimit = 20, maxHeatSetpointLimit = 80, heaterTypes = { immersionElement1: true }, tankPercentage = 90) {
         super(waterHeater, { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
         this.createDefaultIdentifyClusterServer()
@@ -52,32 +16,15 @@ export class WaterHeater extends MatterbridgeEndpoint {
             .createDefaultWaterHeaterManagementClusterServer(heaterTypes, {}, tankPercentage)
             .createDefaultWaterHeaterModeClusterServer();
     }
-    /**
-     * 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 {{ 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 {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 ?? [
@@ -94,7 +41,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;
@@ -107,9 +54,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);
@@ -117,9 +61,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 {
@@ -137,4 +78,3 @@ export class MatterbridgeWaterHeaterModeServer extends WaterHeaterModeServer {
         return { status: ModeBase.ModeChangeStatus.Success, statusText: 'Success' };
     }
 }
-//# sourceMappingURL=waterHeater.js.map