matterbridge 3.1.4-dev-20250717-d36e252 → 3.1.4

package/dist/devices/laundryWasher.js

@@ -1,3 +1,25 @@
+/**
+ * @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/main/clusters/laundry-washer-controls';
 import { LaundryWasherMode } from '@matter/main/clusters/laundry-washer-mode';
 import { TemperatureControl } from '@matter/main/clusters/temperature-control';
@@ -5,10 +27,34 @@ 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, powerSource } 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, powerSource], { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
         this.createDefaultIdentifyClusterServer();
@@ -23,6 +69,14 @@ 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 }] },
@@ -30,20 +84,38 @@ export class LaundryWasher extends MatterbridgeEndpoint {
         { label: 'Whites', mode: 4, modeTags: [{ value: LaundryWasherMode.ModeTag.Whites }] },
     ]) {
         this.behaviors.require(MatterbridgeLaundryWasherModeServer, {
-            supportedModes,
-            currentMode,
+            supportedModes, // Fixed attribute.
+            currentMode, // Persistent attribute.
         });
         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,
+            spinSpeedCurrent, // Writable and nullable
             supportedRinses,
-            numberOfRinses,
+            numberOfRinses, // Writable
         });
         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,
@@ -51,12 +123,22 @@ 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,
-            maxTemperature,
-            step,
+            minTemperature, // Fixed attribute
+            maxTemperature, // Fixed attribute
+            step, // Fixed attribute
         });
         return this;
     }
@@ -105,6 +187,7 @@ 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})`);
@@ -129,3 +212,4 @@ export class MatterbridgeLaundryWasherModeServer extends LaundryWasherModeServer
         }
     }
 }
+//# sourceMappingURL=laundryWasher.js.map

package/dist/devices/laundryWasher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"laundryWasher.js","sourceRoot":"","sources":["../../src/devices/laundryWasher.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAKH,OAAO,EAAE,qBAAqB,EAAE,MAAM,+CAA+C,CAAC;AACtF,OAAO,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAC;AAC9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,4CAA4C,CAAC;AACtF,OAAO,EAAE,uBAAuB,EAAE,MAAM,4CAA4C,CAAC;AACrF,OAAO,EAAE,2BAA2B,EAAE,MAAM,gDAAgD,CAAC;AAE7F,eAAe;AACf,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAE1F,MAAM,OAAO,aAAc,SAAQ,oBAAoB;IACrD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,YACE,IAAY,EACZ,MAAc,EACd,WAAoB,EACpB,cAA+C,EAC/C,gBAAyB,EACzB,UAAqB,EACrB,cAAqD,EACrD,eAAwD,EACxD,wBAAiC,EACjC,0BAAqC,EACrC,mBAA4B,EAC5B,cAAuB,EACvB,cAAuB,EACvB,IAAa,EACb,gBAAwD;QAExD,KAAK,CAAC,CAAC,aAAa,EAAE,WAAW,CAAC,EAAE,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;QAC7H,IAAI,CAAC,kCAAkC,EAAE,CAAC;QAC1C,IAAI,CAAC,0CAA0C,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,6BAA6B,CAAC,CAAC;QAC7H,IAAI,CAAC,0CAA0C,EAAE,CAAC;QAClD,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,2CAA2C,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;QAC9E,IAAI,CAAC,+CAA+C,CAAC,gBAAgB,EAAE,UAAU,EAAE,cAAc,EAAE,eAAe,CAAC,CAAC;QACpH,IAAI,mBAAmB;YAAE,IAAI,CAAC,2CAA2C,CAAC,mBAAmB,EAAE,cAAc,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;;YAChI,IAAI,CAAC,0CAA0C,CAAC,wBAAwB,EAAE,0BAA0B,CAAC,CAAC;QAC3G,IAAI,CAAC,0CAA0C,CAAC,gBAAgB,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACH,2CAA2C,CACzC,WAAW,GAAG,CAAC,EACf,iBAAiD;QAC/C,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE;QACzF,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE;QACrF,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE;QACnF,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE;KACtF;QAED,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,mCAAmC,EAAE;YAC1D,cAAc,EAAE,mBAAmB;YACnC,WAAW,EAAE,wBAAwB;SACtC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACH,+CAA+C,CAC7C,gBAAgB,GAAG,CAAC,EACpB,aAAuB,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EACrD,iBAAuD,qBAAqB,CAAC,cAAc,CAAC,MAAM,EAClG,kBAA0D,CAAC,qBAAqB,CAAC,cAAc,CAAC,IAAI,EAAE,qBAAqB,CAAC,cAAc,CAAC,MAAM,EAAE,qBAAqB,CAAC,cAAc,CAAC,GAAG,EAAE,qBAAqB,CAAC,cAAc,CAAC,KAAK,CAAC;QAExO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,2BAA2B,CAAC,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAChI,UAAU;YACV,gBAAgB,EAAE,wBAAwB;YAC1C,eAAe;YACf,cAAc,EAAE,WAAW;SAC5B,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,0CAA0C,CAAC,wBAAwB,GAAG,CAAC,EAAE,0BAA0B,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QACvJ,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,yCAAyC,CAAC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE;YAClH,wBAAwB;YACxB,0BAA0B;SAC3B,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;;;;;OASG;IACH,2CAA2C,CAAC,mBAAmB,GAAG,EAAE,GAAG,GAAG,EAAE,cAAc,GAAG,EAAE,GAAG,GAAG,EAAE,cAAc,GAAG,EAAE,GAAG,GAAG,EAAE,IAAI,GAAG,EAAE,GAAG,GAAG;QAC/I,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,0CAA0C,CAAC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE;YAChK,mBAAmB;YACnB,cAAc,EAAE,kBAAkB;YAClC,cAAc,EAAE,kBAAkB;YAClC,IAAI,EAAE,kBAAkB;SACzB,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,MAAM,OAAO,yCAA0C,SAAQ,wBAAwB,CAAC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,gBAAgB,CAAC;IAC9H,UAAU;QACjB,IAAI,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACtD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;YACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,uFAAuF,IAAI,CAAC,KAAK,CAAC,wBAAwB,oCAAoC,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpO,CAAC;IACH,CAAC;IAEQ,cAAc,CAAC,OAAiD;QACvE,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,4BAA4B,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,CAAC;QACnG,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,gBAAgB,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,wBAAwB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC3J,IAAI,OAAO,CAAC,sBAAsB,KAAK,SAAS,IAAI,OAAO,CAAC,sBAAsB,IAAI,CAAC,IAAI,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAAC,MAAM,EAAE,CAAC;YACzK,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,wGAAwG,OAAO,CAAC,sBAAsB,KAAK,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAAC,OAAO,CAAC,sBAAsB,CAAC,EAAE,CAAC,CAAC;YACrO,IAAI,CAAC,KAAK,CAAC,wBAAwB,GAAG,OAAO,CAAC,sBAAsB,CAAC;QACvE,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,wGAAwG,OAAO,CAAC,sBAAsB,EAAE,CAAC,CAAC;QAC7J,CAAC;IACH,CAAC;CACF;AAED,MAAM,OAAO,0CAA2C,SAAQ,wBAAwB,CAAC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,OAAO,CAAC,eAAe,CAAC;IAC5K,UAAU;QACjB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,mFAAmF,IAAI,CAAC,KAAK,CAAC,mBAAmB,mBAAmB,IAAI,CAAC,KAAK,CAAC,cAAc,mBAAmB,IAAI,CAAC,KAAK,CAAC,cAAc,SAAS,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;IACvP,CAAC;IAEQ,cAAc,CAAC,OAAiD;QACvE,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,4BAA4B,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,CAAC;QACnG,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,gBAAgB,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,wBAAwB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC3J,IAAI,OAAO,CAAC,iBAAiB,KAAK,SAAS,IAAI,OAAO,CAAC,iBAAiB,IAAI,IAAI,CAAC,KAAK,CAAC,cAAc,IAAI,OAAO,CAAC,iBAAiB,IAAI,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC;YAChK,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,oGAAoG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAClJ,IAAI,CAAC,KAAK,CAAC,mBAAmB,GAAG,OAAO,CAAC,iBAAiB,CAAC;QAC7D,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,oGAAoG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACpJ,CAAC;IACH,CAAC;CACF;AAED,MAAM,OAAO,mCAAoC,SAAQ,uBAAuB;IACrE,UAAU;QACjB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,mEAAmE,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;QAC7G,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACrG,CAAC;IAED,2BAA2B;IACjB,iBAAiB,CAAC,KAAc;QACxC,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,+BAA+B,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,CAAC;QACtG,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;YACpB,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,+EAA+E,CAAC,CAAC;YACnG,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAEQ,YAAY,CAAC,OAAqC;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,0BAA0B,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,CAAC;QACjG,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,uBAAuB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACxJ,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;QAChH,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,sEAAsE,aAAa,CAAC,IAAI,OAAO,aAAa,CAAC,KAAK,EAAE,CAAC,CAAC;YACvI,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;YACzC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;QAC9E,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,8EAA8E,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;YAClH,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,aAAa,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC;QACzF,CAAC;IACH,CAAC;CACF"}

package/dist/devices/roboticVacuumCleaner.d.ts

@@ -0,0 +1,110 @@
+/**
+ * @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.
+ */
+import { MaybePromise } from '@matter/main';
+import { RvcRunModeServer } from '@matter/main/behaviors/rvc-run-mode';
+import { RvcOperationalStateServer } from '@matter/main/behaviors/rvc-operational-state';
+import { RvcCleanModeServer } from '@matter/main/behaviors/rvc-clean-mode';
+import { RvcRunMode } from '@matter/main/clusters/rvc-run-mode';
+import { RvcCleanMode } from '@matter/main/clusters/rvc-clean-mode';
+import { RvcOperationalState } from '@matter/main/clusters/rvc-operational-state';
+import { ServiceArea } from '@matter/main/clusters/service-area';
+import { ModeBase } from '@matter/main/clusters/mode-base';
+import { OperationalState } from '@matter/main/clusters/operational-state';
+import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
+export declare 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).
+     */
+    constructor(name: string, serial: string, mode?: 'server' | 'matter' | undefined, currentRunMode?: number, supportedRunModes?: RvcRunMode.ModeOption[], currentCleanMode?: number, supportedCleanModes?: RvcCleanMode.ModeOption[], currentPhase?: number | null, phaseList?: string[] | null, operationalState?: RvcOperationalState.OperationalState, operationalStateList?: RvcOperationalState.OperationalStateStruct[], supportedAreas?: ServiceArea.Area[], selectedAreas?: number[], currentArea?: number);
+    /**
+     * 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?: number, supportedModes?: RvcRunMode.ModeOption[]): 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?: number, supportedModes?: RvcCleanMode.ModeOption[]): 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).
+     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
+     */
+    createDefaultServiceAreaClusterServer(supportedAreas?: ServiceArea.Area[], selectedAreas?: number[], currentArea?: number): 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?: string[] | null, currentPhase?: number | null, operationalStateList?: RvcOperationalState.OperationalStateStruct[], operationalState?: RvcOperationalState.OperationalState, operationalError?: RvcOperationalState.ErrorStateStruct): this;
+}
+export declare class MatterbridgeRvcRunModeServer extends RvcRunModeServer {
+    changeToMode(request: ModeBase.ChangeToModeRequest): MaybePromise<ModeBase.ChangeToModeResponse>;
+}
+export declare class MatterbridgeRvcCleanModeServer extends RvcCleanModeServer {
+    changeToMode(request: ModeBase.ChangeToModeRequest): MaybePromise<ModeBase.ChangeToModeResponse>;
+}
+export declare class MatterbridgeRvcOperationalStateServer extends RvcOperationalStateServer {
+    pause(): MaybePromise<OperationalState.OperationalCommandResponse>;
+    resume(): MaybePromise<OperationalState.OperationalCommandResponse>;
+    goHome(): MaybePromise<OperationalState.OperationalCommandResponse>;
+}
+//# sourceMappingURL=roboticVacuumCleaner.d.ts.map

package/dist/devices/roboticVacuumCleaner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roboticVacuumCleaner.d.ts","sourceRoot":"","sources":["../../src/devices/roboticVacuumCleaner.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EAAE,yBAAyB,EAAE,MAAM,8CAA8C,CAAC;AACzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAE3E,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,6CAA6C,CAAC;AAClF,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yCAAyC,CAAC;AAG3E,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAIlE,qBAAa,oBAAqB,SAAQ,oBAAoB;IAC5D;;;;;;;;;;;;;;;;;OAiBG;gBAED,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,IAAI,GAAE,QAAQ,GAAG,QAAQ,GAAG,SAAqB,EACjD,cAAc,CAAC,EAAE,MAAM,EACvB,iBAAiB,CAAC,EAAE,UAAU,CAAC,UAAU,EAAE,EAC3C,gBAAgB,CAAC,EAAE,MAAM,EACzB,mBAAmB,CAAC,EAAE,YAAY,CAAC,UAAU,EAAE,EAC/C,YAAY,GAAE,MAAM,GAAG,IAAW,EAClC,SAAS,GAAE,MAAM,EAAE,GAAG,IAAW,EACjC,gBAAgB,CAAC,EAAE,mBAAmB,CAAC,gBAAgB,EACvD,oBAAoB,CAAC,EAAE,mBAAmB,CAAC,sBAAsB,EAAE,EACnE,cAAc,CAAC,EAAE,WAAW,CAAC,IAAI,EAAE,EACnC,aAAa,CAAC,EAAE,MAAM,EAAE,EACxB,WAAW,CAAC,EAAE,MAAM;IAYtB;;;;;;;;;;OAUG;IACH,oCAAoC,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,UAAU,CAAC,UAAU,EAAE,GAAG,IAAI;IAa1G;;;;;;;;;;OAUG;IACH,sCAAsC,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,YAAY,CAAC,UAAU,EAAE,GAAG,IAAI;IAY9G;;;;;;;OAOG;IACH,qCAAqC,CAAC,cAAc,CAAC,EAAE,WAAW,CAAC,IAAI,EAAE,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI;IA+BhI;;;;;;;;;OASG;IACH,6CAA6C,CAC3C,SAAS,GAAE,MAAM,EAAE,GAAG,IAAW,EACjC,YAAY,GAAE,MAAM,GAAG,IAAW,EAClC,oBAAoB,CAAC,EAAE,mBAAmB,CAAC,sBAAsB,EAAE,EACnE,gBAAgB,CAAC,EAAE,mBAAmB,CAAC,gBAAgB,EACvD,gBAAgB,CAAC,EAAE,mBAAmB,CAAC,gBAAgB,GACtD,IAAI;CAkBR;AAED,qBAAa,4BAA6B,SAAQ,gBAAgB;IACvD,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,mBAAmB,GAAG,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC;CAuB1G;AAED,qBAAa,8BAA+B,SAAQ,kBAAkB;IAC3D,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,mBAAmB,GAAG,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC;CAa1G;AAED,qBAAa,qCAAsC,SAAQ,yBAAyB;IACzE,KAAK,IAAI,YAAY,CAAC,gBAAgB,CAAC,0BAA0B,CAAC;IAalE,MAAM,IAAI,YAAY,CAAC,gBAAgB,CAAC,0BAA0B,CAAC;IAanE,MAAM,IAAI,YAAY,CAAC,gBAAgB,CAAC,0BAA0B,CAAC;CAa7E"}

package/dist/devices/roboticVacuumCleaner.js

@@ -1,3 +1,25 @@
+/**
+ * @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.
+ */
 import { RvcRunModeServer } from '@matter/main/behaviors/rvc-run-mode';
 import { RvcOperationalStateServer } from '@matter/main/behaviors/rvc-operational-state';
 import { RvcCleanModeServer } from '@matter/main/behaviors/rvc-clean-mode';
@@ -7,10 +29,29 @@ import { RvcCleanMode } from '@matter/main/clusters/rvc-clean-mode';
 import { RvcOperationalState } from '@matter/main/clusters/rvc-operational-state';
 import { ModeBase } from '@matter/main/clusters/mode-base';
 import { OperationalState } from '@matter/main/clusters/operational-state';
+// 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).
+     */
     constructor(name, serial, mode = undefined, currentRunMode, supportedRunModes, currentCleanMode, supportedCleanModes, currentPhase = null, phaseList = null, operationalState, operationalStateList, supportedAreas, selectedAreas, currentArea) {
         super([roboticVacuumCleaner, powerSource], { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}`, mode }, true);
         this.createDefaultIdentifyClusterServer()
@@ -21,6 +62,17 @@ export class RoboticVacuumCleaner extends MatterbridgeEndpoint {
             .createDefaultRvcOperationalStateClusterServer(phaseList, currentPhase, operationalStateList, operationalState)
             .createDefaultServiceAreaClusterServer(supportedAreas, selectedAreas, currentArea);
     }
+    /**
+     * 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 ?? [
@@ -33,6 +85,17 @@ 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 ?? [
@@ -44,6 +107,14 @@ 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).
+     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
+     */
     createDefaultServiceAreaClusterServer(supportedAreas, selectedAreas, currentArea) {
         this.behaviors.require(MatterbridgeServiceAreaServer, {
             supportedAreas: supportedAreas ?? [
@@ -74,6 +145,16 @@ export class RoboticVacuumCleaner extends MatterbridgeEndpoint {
         });
         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,
@@ -83,9 +164,9 @@ export class RoboticVacuumCleaner extends MatterbridgeEndpoint {
                 { operationalStateId: RvcOperationalState.OperationalState.Running, operationalStateLabel: 'Running' },
                 { operationalStateId: RvcOperationalState.OperationalState.Paused, operationalStateLabel: 'Paused' },
                 { operationalStateId: RvcOperationalState.OperationalState.Error, operationalStateLabel: 'Error' },
-                { operationalStateId: RvcOperationalState.OperationalState.SeekingCharger, operationalStateLabel: 'SeekingCharger' },
-                { operationalStateId: RvcOperationalState.OperationalState.Charging, operationalStateLabel: 'Charging' },
-                { operationalStateId: RvcOperationalState.OperationalState.Docked, operationalStateLabel: 'Docked' },
+                { operationalStateId: RvcOperationalState.OperationalState.SeekingCharger, operationalStateLabel: 'SeekingCharger' }, // Y RVC Pause Compatibility N RVC Resume Compatibility
+                { operationalStateId: RvcOperationalState.OperationalState.Charging, operationalStateLabel: 'Charging' }, // N RVC Pause Compatibility Y RVC Resume Compatibility
+                { operationalStateId: RvcOperationalState.OperationalState.Docked, operationalStateLabel: 'Docked' }, // N RVC Pause Compatibility Y RVC Resume Compatibility
             ],
             operationalState: operationalState ?? RvcOperationalState.OperationalState.Docked,
             operationalError: operationalError ?? { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateLabel: 'No Error', errorStateDetails: 'Fully operational' },
@@ -140,7 +221,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;
+        this.agent.get(MatterbridgeRvcRunModeServer).state.currentMode = 1; // RvcRunMode.ModeTag.Idle
         this.state.operationalState = RvcOperationalState.OperationalState.Paused;
         this.state.operationalError = { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateLabel: 'No Error', errorStateDetails: 'Fully operational' };
         return {
@@ -152,7 +233,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;
+        this.agent.get(MatterbridgeRvcRunModeServer).state.currentMode = 2; // RvcRunMode.ModeTag.Cleaning
         this.state.operationalState = RvcOperationalState.OperationalState.Running;
         this.state.operationalError = { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateLabel: 'No Error', errorStateDetails: 'Fully operational' };
         return {
@@ -160,11 +241,12 @@ 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;
+        this.agent.get(MatterbridgeRvcRunModeServer).state.currentMode = 1; // RvcRunMode.ModeTag.Idle
         this.state.operationalState = RvcOperationalState.OperationalState.Docked;
         this.state.operationalError = { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateLabel: 'No Error', errorStateDetails: 'Fully operational' };
         return {
@@ -172,3 +254,4 @@ export class MatterbridgeRvcOperationalStateServer extends RvcOperationalStateSe
         };
     }
 }
+//# sourceMappingURL=roboticVacuumCleaner.js.map

package/dist/devices/roboticVacuumCleaner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"roboticVacuumCleaner.js","sourceRoot":"","sources":["../../src/devices/roboticVacuumCleaner.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAIH,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EAAE,yBAAyB,EAAE,MAAM,8CAA8C,CAAC;AACzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAC3E,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,6CAA6C,CAAC;AAElF,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yCAAyC,CAAC;AAE3E,eAAe;AACf,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAClF,OAAO,EAAE,kBAAkB,EAAE,6BAA6B,EAAE,MAAM,6BAA6B,CAAC;AAEhG,MAAM,OAAO,oBAAqB,SAAQ,oBAAoB;IAC5D;;;;;;;;;;;;;;;;;OAiBG;IACH,YACE,IAAY,EACZ,MAAc,EACd,OAAwC,SAAS,EACjD,cAAuB,EACvB,iBAA2C,EAC3C,gBAAyB,EACzB,mBAA+C,EAC/C,eAA8B,IAAI,EAClC,YAA6B,IAAI,EACjC,gBAAuD,EACvD,oBAAmE,EACnE,cAAmC,EACnC,aAAwB,EACxB,WAAoB;QAEpB,KAAK,CAAC,CAAC,oBAAoB,EAAE,WAAW,CAAC,EAAE,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;QAC1I,IAAI,CAAC,kCAAkC,EAAE;aACtC,0CAA0C,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,mCAAmC,CAAC;aAC7H,wDAAwD,CAAC,EAAE,EAAE,WAAW,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC;aACjG,oCAAoC,CAAC,cAAc,EAAE,iBAAiB,CAAC;aACvE,sCAAsC,CAAC,gBAAgB,EAAE,mBAAmB,CAAC;aAC7E,6CAA6C,CAAC,SAAS,EAAE,YAAY,EAAE,oBAAoB,EAAE,gBAAgB,CAAC;aAC9G,qCAAqC,CAAC,cAAc,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;OAUG;IACH,oCAAoC,CAAC,WAAoB,EAAE,cAAwC;QACjG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,4BAA4B,EAAE;YACnD,cAAc,EAAE,cAAc,IAAI;gBAChC,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE;gBAC1E,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE;gBAClF,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,EAAE;gBAChF,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE;aAC1H;YACD,WAAW,EAAE,WAAW,IAAI,CAAC;SAC9B,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;OAUG;IACH,sCAAsC,CAAC,WAAoB,EAAE,cAA0C;QACrG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,8BAA8B,EAAE;YACrD,cAAc,EAAE,cAAc,IAAI;gBAChC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE;gBAChF,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE;gBAC1E,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,EAAE;aACnF;YACD,WAAW,EAAE,WAAW,IAAI,CAAC;SAC9B,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,qCAAqC,CAAC,cAAmC,EAAE,aAAwB,EAAE,WAAoB;QACvH,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,6BAA6B,EAAE;YACpD,cAAc,EAAE,cAAc,IAAI;gBAChC;oBACE,MAAM,EAAE,CAAC;oBACT,KAAK,EAAE,IAAI;oBACX,QAAQ,EAAE,EAAE,YAAY,EAAE,EAAE,YAAY,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE;iBAC9G;gBACD;oBACE,MAAM,EAAE,CAAC;oBACT,KAAK,EAAE,IAAI;oBACX,QAAQ,EAAE,EAAE,YAAY,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE;iBAC/G;gBACD;oBACE,MAAM,EAAE,CAAC;oBACT,KAAK,EAAE,IAAI;oBACX,QAAQ,EAAE,EAAE,YAAY,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE;iBAC/G;gBACD;oBACE,MAAM,EAAE,CAAC;oBACT,KAAK,EAAE,IAAI;oBACX,QAAQ,EAAE,EAAE,YAAY,EAAE,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE;iBAChH;aACF;YACD,aAAa,EAAE,aAAa,IAAI,EAAE;YAClC,WAAW,EAAE,WAAW,IAAI,CAAC;YAC7B,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACH,6CAA6C,CAC3C,YAA6B,IAAI,EACjC,eAA8B,IAAI,EAClC,oBAAmE,EACnE,gBAAuD,EACvD,gBAAuD;QAEvD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,qCAAqC,EAAE;YAC5D,SAAS;YACT,YAAY;YACZ,oBAAoB,EAAE,oBAAoB,IAAI;gBAC5C,EAAE,kBAAkB,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,EAAE,qBAAqB,EAAE,SAAS,EAAE;gBACtG,EAAE,kBAAkB,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,EAAE,qBAAqB,EAAE,SAAS,EAAE;gBACtG,EAAE,kBAAkB,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,MAAM,EAAE,qBAAqB,EAAE,QAAQ,EAAE;gBACpG,EAAE,kBAAkB,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,EAAE;gBAClG,EAAE,kBAAkB,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,cAAc,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,EAAE,uDAAuD;gBAC7K,EAAE,kBAAkB,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,qBAAqB,EAAE,UAAU,EAAE,EAAE,uDAAuD;gBACjK,EAAE,kBAAkB,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,MAAM,EAAE,qBAAqB,EAAE,QAAQ,EAAE,EAAE,uDAAuD;aAC9J;YACD,gBAAgB,EAAE,gBAAgB,IAAI,mBAAmB,CAAC,gBAAgB,CAAC,MAAM;YACjF,gBAAgB,EAAE,gBAAgB,IAAI,EAAE,YAAY,EAAE,mBAAmB,CAAC,UAAU,CAAC,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,iBAAiB,EAAE,mBAAmB,EAAE;SACpK,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,MAAM,OAAO,4BAA6B,SAAQ,gBAAgB;IACvD,YAAY,CAAC,OAAqC;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,OAAO,CAAC,OAAO,cAAc,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,CAAC;QACxH,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,gBAAgB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACjJ,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;QAC1F,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,8EAA8E,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;YAClH,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,CAAC;QAC/F,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;QACzC,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,KAAK,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChF,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,mFAAmF,CAAC,CAAC;YACtG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC,KAAK,CAAC,gBAAgB,GAAG,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,CAAC;YAC5H,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;QAC9E,CAAC;aAAM,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,KAAK,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACnF,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,8EAA8E,CAAC,CAAC;YACjG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC,KAAK,CAAC,gBAAgB,GAAG,mBAAmB,CAAC,gBAAgB,CAAC,MAAM,CAAC;YAC3H,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;QAC7E,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,iEAAiE,OAAO,CAAC,OAAO,OAAO,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;QAC3H,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC,KAAK,CAAC,gBAAgB,GAAG,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,CAAC;QAC5H,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;IAC9E,CAAC;CACF;AAED,MAAM,OAAO,8BAA+B,SAAQ,kBAAkB;IAC3D,YAAY,CAAC,OAAqC;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,OAAO,CAAC,OAAO,cAAc,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,CAAC;QACxH,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,kBAAkB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnJ,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;QAC1F,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,gFAAgF,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;YACpH,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,EAAE,kBAAkB,EAAE,CAAC;QAC/F,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;QACzC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,mEAAmE,OAAO,CAAC,OAAO,OAAO,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;QAC7H,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;IAC9E,CAAC;CACF;AAED,MAAM,OAAO,qCAAsC,SAAQ,yBAAyB;IACzE,KAAK;QACZ,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,CAAC;QAC1F,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,yBAAyB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACvJ,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,iHAAiH,CAAC,CAAC;QACpI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,0BAA0B;QAC9F,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,mBAAmB,CAAC,gBAAgB,CAAC,MAAM,CAAC;QAC1E,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,EAAE,YAAY,EAAE,mBAAmB,CAAC,UAAU,CAAC,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;QAC5J,OAAO;YACL,oBAAoB,EAAE,EAAE,YAAY,EAAE,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,iBAAiB,EAAE,mBAAmB,EAAE;SAClG,CAAC;IACnD,CAAC;IAEQ,MAAM;QACb,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,CAAC;QAC3F,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,yBAAyB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACxJ,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,uHAAuH,CAAC,CAAC;QAC1I,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,8BAA8B;QAClG,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,CAAC;QAC3E,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,EAAE,YAAY,EAAE,mBAAmB,CAAC,UAAU,CAAC,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;QAC5J,OAAO;YACL,oBAAoB,EAAE,EAAE,YAAY,EAAE,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,iBAAiB,EAAE,mBAAmB,EAAE;SAClG,CAAC;IACnD,CAAC;IAEQ,MAAM;QACb,yEAAyE;QACzE,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,CAAC;QAC3F,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,yBAAyB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACxJ,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,kHAAkH,CAAC,CAAC;QACrI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,0BAA0B;QAC9F,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,mBAAmB,CAAC,gBAAgB,CAAC,MAAM,CAAC;QAC1E,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,EAAE,YAAY,EAAE,mBAAmB,CAAC,UAAU,CAAC,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;QAC5J,OAAO;YACL,oBAAoB,EAAE,EAAE,YAAY,EAAE,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,iBAAiB,EAAE,mBAAmB,EAAE;SAClG,CAAC;IACnD,CAAC;CACF"}

package/dist/devices/solarPower.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @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.
+ */
+import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
+export declare 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: string, serial: string, voltage?: number | bigint | null, current?: number | bigint | null, power?: number | bigint | null, energyExported?: number | bigint | null, absMinPower?: number, absMaxPower?: number);
+}
+//# sourceMappingURL=solarPower.d.ts.map

package/dist/devices/solarPower.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"solarPower.d.ts","sourceRoot":"","sources":["../../src/devices/solarPower.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAOH,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAGlE,qBAAa,UAAW,SAAQ,oBAAoB;IAClD;;;;;;;;;;;OAWG;gBAED,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,MAAM,GAAG,MAAM,GAAG,IAAW,EACtC,OAAO,GAAE,MAAM,GAAG,MAAM,GAAG,IAAW,EACtC,KAAK,GAAE,MAAM,GAAG,MAAM,GAAG,IAAW,EACpC,cAAc,GAAE,MAAM,GAAG,MAAM,GAAG,IAAW,EAC7C,WAAW,GAAE,MAAU,EACvB,WAAW,GAAE,MAAU;CAoB1B"}

package/dist/devices/solarPower.js

@@ -1,8 +1,45 @@
+/**
+ * @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/main';
 import { DeviceEnergyManagement } from '@matter/main/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 }],
@@ -19,3 +56,4 @@ export class SolarPower extends MatterbridgeEndpoint {
             .addRequiredClusterServers();
     }
 }
+//# sourceMappingURL=solarPower.js.map

package/dist/devices/solarPower.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"solarPower.js","sourceRoot":"","sources":["../../src/devices/solarPower.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,UAAU;AACV,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,gDAAgD,CAAC;AAExF,eAAe;AACf,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAElH,MAAM,OAAO,UAAW,SAAQ,oBAAoB;IAClD;;;;;;;;;;;OAWG;IACH,YACE,IAAY,EACZ,MAAc,EACd,UAAkC,IAAI,EACtC,UAAkC,IAAI,EACtC,QAAgC,IAAI,EACpC,iBAAyC,IAAI,EAC7C,cAAsB,CAAC,EACvB,cAAsB,CAAC;QAEvB,KAAK,CACH,CAAC,UAAU,EAAE,WAAW,EAAE,gBAAgB,EAAE,sBAAsB,CAAC,EACnE;YACE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,cAAc,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;YACvH,EAAE,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE;SAChE,EACD,IAAI,CACL,CAAC;QACF,IAAI,CAAC,kCAAkC,EAAE;aACtC,0CAA0C,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,0BAA0B,CAAC;aACpH,0CAA0C,EAAE;aAC5C,uCAAuC,EAAE;aACzC,oDAAoD,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC;aAC7E,qDAAqD,CAAC,CAAC,EAAE,cAAc,CAAC;aACxE,gDAAgD,CAAC,sBAAsB,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,sBAAsB,CAAC,QAAQ,CAAC,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC;aAChK,oDAAoD,EAAE;aACtD,yBAAyB,EAAE,CAAC;IACjC,CAAC;CACF"}