matterbridge 3.4.3-dev-20251209-e6cb85f → 3.4.3

package/dist/devices/roboticVacuumCleaner.js

@@ -1,3 +1,26 @@
+/**
+ * @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';
@@ -9,10 +32,30 @@ 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()
@@ -23,6 +66,17 @@ 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 ?? [
@@ -35,6 +89,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 ?? [
@@ -46,6 +111,15 @@ 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 ?? [
@@ -70,13 +144,28 @@ export class RoboticVacuumCleaner extends MatterbridgeEndpoint {
                     areaInfo: { locationInfo: { locationName: 'Bathroom', floorNumber: 1, areaType: AreaNamespaceTag.Bathroom.tag }, landmarkInfo: null },
                 },
             ],
-            selectedAreas: selectedAreas ?? [],
-            currentArea: currentArea ?? 1,
-            supportedMaps: supportedMaps ?? [],
+            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.
+             */
             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,
@@ -86,9 +175,9 @@ export class RoboticVacuumCleaner extends MatterbridgeEndpoint {
                 { operationalStateId: RvcOperationalState.OperationalState.Running },
                 { operationalStateId: RvcOperationalState.OperationalState.Paused },
                 { operationalStateId: RvcOperationalState.OperationalState.Error },
-                { operationalStateId: RvcOperationalState.OperationalState.SeekingCharger },
-                { operationalStateId: RvcOperationalState.OperationalState.Charging },
-                { operationalStateId: RvcOperationalState.OperationalState.Docked },
+                { 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
             ],
             operationalState: operationalState ?? RvcOperationalState.OperationalState.Docked,
             operationalError: operationalError ?? { errorStateId: RvcOperationalState.ErrorState.NoError, errorStateDetails: 'Fully operational' },
@@ -143,7 +232,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, errorStateDetails: 'Fully operational' };
         return {
@@ -155,7 +244,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, errorStateDetails: 'Fully operational' };
         return {
@@ -163,11 +252,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, errorStateDetails: 'Fully operational' };
         return {
@@ -175,3 +265,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;AAEH,YAAY;AACZ,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAC;AACnF,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EAAE,yBAAyB,EAAE,MAAM,8CAA8C,CAAC;AACzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,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;;;;;;;;;;;;;;;;;;OAkBG;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,EACpB,aAAiC;QAEjC,KAAK,CAAC,CAAC,oBAAoB,EAAE,WAAW,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QACtH,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,EAAE,aAAa,CAAC,CAAC;IACtG,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,WAAW,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,EAAE;aACvF;YACD,WAAW,EAAE,WAAW,IAAI,CAAC;SAC9B,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACH,qCAAqC,CAAC,cAAmC,EAAE,aAAwB,EAAE,WAAoB,EAAE,aAAiC;QAC1J,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,6BAA6B,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACnF,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,CAAC,EAAE,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE;iBACtI;gBACD;oBACE,MAAM,EAAE,CAAC;oBACT,KAAK,EAAE,IAAI;oBACX,QAAQ,EAAE,EAAE,YAAY,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,EAAE,QAAQ,EAAE,gBAAgB,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE;iBACpI;gBACD;oBACE,MAAM,EAAE,CAAC;oBACT,KAAK,EAAE,IAAI;oBACX,QAAQ,EAAE,EAAE,YAAY,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,EAAE,QAAQ,EAAE,gBAAgB,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE;iBACpI;gBACD;oBACE,MAAM,EAAE,CAAC;oBACT,KAAK,EAAE,IAAI;oBACX,QAAQ,EAAE,EAAE,YAAY,EAAE,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,EAAE,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE;iBACtI;aACF;YACD,aAAa,EAAE,aAAa,IAAI,EAAE,EAAE,qKAAqK;YACzM,WAAW,EAAE,WAAW,IAAI,CAAC,EAAE,oNAAoN;YACnP,aAAa,EAAE,aAAa,IAAI,EAAE,EAAE,2FAA2F;YAC/H;;;;eAIG;YACH,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;gBACpE,EAAE,kBAAkB,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,EAAE;gBACpE,EAAE,kBAAkB,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,MAAM,EAAE;gBACnE,EAAE,kBAAkB,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,KAAK,EAAE;gBAClE,EAAE,kBAAkB,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,cAAc,EAAE,EAAE,uDAAuD;gBACpI,EAAE,kBAAkB,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,EAAE,uDAAuD;gBAC9H,EAAE,kBAAkB,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,MAAM,EAAE,EAAE,uDAAuD;aAC7H;YACD,gBAAgB,EAAE,gBAAgB,IAAI,mBAAmB,CAAC,gBAAgB,CAAC,MAAM;YACjF,gBAAgB,EAAE,gBAAgB,IAAI,EAAE,YAAY,EAAE,mBAAmB,CAAC,UAAU,CAAC,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE;SACvI,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,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;QAC/H,OAAO;YACL,oBAAoB,EAAE,EAAE,YAAY,EAAE,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE;SACrE,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,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;QAC/H,OAAO;YACL,oBAAoB,EAAE,EAAE,YAAY,EAAE,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE;SACrE,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,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;QAC/H,OAAO;YACL,oBAAoB,EAAE,EAAE,YAAY,EAAE,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE;SACrE,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;CAgB1B"}

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/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 }],
@@ -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,iDAAiD,CAAC;AAEzF,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,CAAC,CAAC,UAAU,EAAE,WAAW,EAAE,gBAAgB,EAAE,sBAAsB,CAAC,EAAE;YACzE,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,CAAC,CAAC;QACH,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"}

package/dist/devices/speaker.d.ts

@@ -0,0 +1,87 @@
+/**
+ * @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.
+ */
+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 declare 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: string, serial: string, muted?: boolean, volume?: number);
+    /**
+     * 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.
+     */
+    setMuted(muted: boolean): Promise<void>;
+    /**
+     * Get mute state.
+     *
+     * @returns {boolean} TRUE when muted, FALSE when unmuted.
+     */
+    isMuted(): boolean;
+    /**
+     * 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.
+     */
+    setVolume(level: number): Promise<void>;
+    /**
+     * Get current volume.
+     *
+     * @returns {number} Current level (1..254).
+     */
+    getVolume(): number;
+}
+//# sourceMappingURL=speaker.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"speaker.d.ts","sourceRoot":"","sources":["../../src/devices/speaker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAQH,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAElE;;;;;;;;;;;;GAYG;AACH,qBAAa,OAAQ,SAAQ,oBAAoB;IAC/C;;;;;;;;;;;;OAYG;gBACS,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,GAAE,OAAe,EAAE,MAAM,GAAE,MAAY;IActF;;;;;;;;OAQG;IACG,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7C;;;;OAIG;IACH,OAAO,IAAI,OAAO;IAIlB;;;;;;;;;;OAUG;IACG,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO7C;;;;OAIG;IACH,SAAS,IAAI,MAAM;CAGpB"}

package/dist/devices/speaker.js

@@ -1,9 +1,60 @@
+/**
+ * @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)
@@ -12,15 +63,42 @@ 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;
@@ -30,7 +108,13 @@ 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/speaker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"speaker.js","sourceRoot":"","sources":["../../src/devices/speaker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,kBAAkB;AAClB,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAEpE,eAAe;AACf,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAElE;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,OAAQ,SAAQ,oBAAoB;IAC/C;;;;;;;;;;;;OAYG;IACH,YAAY,IAAY,EAAE,MAAc,EAAE,QAAiB,KAAK,EAAE,SAAiB,GAAG;QACpF,kBAAkB;QAClB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;YAAE,MAAM,GAAG,GAAG,CAAC;QAC3C,IAAI,MAAM,GAAG,CAAC;YAAE,MAAM,GAAG,CAAC,CAAC;QAC3B,IAAI,MAAM,GAAG,GAAG;YAAE,MAAM,GAAG,GAAG,CAAC;QAE/B,KAAK,CAAC,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5F,IAAI,CAAC,0CAA0C,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,sBAAsB,CAAC,CAAC;QACtH,mEAAmE;QACnE,IAAI,CAAC,wBAAwB,CAAC,CAAC,KAAK,CAAC,CAAC;QACtC,8CAA8C;QAC9C,IAAI,CAAC,+BAA+B,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,QAAQ,CAAC,KAAc;QAC3B,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,OAAO;QACL,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,SAAS,CAAC,KAAa;QAC3B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO;QACpC,IAAI,KAAK,GAAG,CAAC;YAAE,KAAK,GAAG,CAAC,CAAC;QACzB,IAAI,KAAK,GAAG,GAAG;YAAE,KAAK,GAAG,GAAG,CAAC;QAC7B,MAAM,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;IACpE,CAAC;CACF"}