matterbridge 3.4.3-dev-20251209-e6cb85f → 3.4.3

package/dist/deviceManager.d.ts

@@ -0,0 +1,135 @@
+/**
+ * This file contains the DeviceManager class.
+ *
+ * @file devices.ts
+ * @author Luca Liguori
+ * @created 2024-07-26
+ * @version 1.1.2
+ * @license Apache-2.0
+ *
+ * Copyright 2024, 2025, 2026 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 { LogLevel } from 'node-ansi-logger';
+import type { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
+import { type BaseDevice } from './matterbridgeTypes.js';
+/**
+ * Converts a MatterbridgeEndpoint to a BaseDevice.
+ *
+ * @param {MatterbridgeEndpoint} device The MatterbridgeEndpoint to convert.
+ * @returns {BaseDevice} The converted BaseDevice.
+ */
+export declare function toBaseDevice(device: MatterbridgeEndpoint | BaseDevice): BaseDevice;
+/**
+ * Manages Matterbridge devices.
+ */
+export declare class DeviceManager {
+    private readonly _devices;
+    private readonly log;
+    private readonly server;
+    private readonly debug;
+    private readonly verbose;
+    /**
+     * Creates an instance of DeviceManager.
+     */
+    constructor();
+    destroy(): void;
+    private msgHandler;
+    /**
+     * Gets the number of devices.
+     *
+     * @returns {number} The number of devices.
+     */
+    get length(): number;
+    /**
+     * Gets the number of devices.
+     *
+     * @returns {number} The number of devices.
+     */
+    get size(): number;
+    /**
+     * Checks if a device with the specified unique ID exists.
+     *
+     * @param {string} uniqueId - The unique ID of the device.
+     * @returns {boolean} True if the device exists, false otherwise.
+     */
+    has(uniqueId: string): boolean;
+    /**
+     * Gets a device by its unique ID.
+     *
+     * @param {string} uniqueId - The unique ID of the device.
+     * @returns {MatterbridgeEndpoint | undefined} The device, or undefined if not found.
+     */
+    get(uniqueId: string): MatterbridgeEndpoint | undefined;
+    /**
+     * Adds a device to the manager.
+     *
+     * @param {MatterbridgeEndpoint} device - The device to add.
+     * @returns {MatterbridgeEndpoint} The added device.
+     * @throws {Error} If the device does not have a unique ID.
+     */
+    set(device: MatterbridgeEndpoint): MatterbridgeEndpoint;
+    /**
+     * Removes a device from the manager.
+     *
+     * @param {MatterbridgeEndpoint} device - The device to remove.
+     * @returns {boolean} True if the device was removed, false otherwise.
+     * @throws {Error} If the device does not have a unique ID.
+     */
+    remove(device: MatterbridgeEndpoint): boolean;
+    /**
+     * Clears all devices from the manager.
+     */
+    clear(): void;
+    /**
+     * Converts a MatterbridgeEndpoint to a BaseDevice.
+     *
+     * @param {MatterbridgeEndpoint} device The MatterbridgeEndpoint to convert.
+     * @returns {BaseDevice} The converted BaseDevice.
+     */
+    private toBaseDevice;
+    /**
+     * Gets an array of all devices.
+     *
+     * @returns {MatterbridgeEndpoint[]} An array of all devices.
+     */
+    array(): MatterbridgeEndpoint[];
+    /**
+     * Gets a base array of all devices suitable for serialization.
+     *
+     * @param {string} [pluginName] - Optional plugin name to filter devices.
+     * @returns {ApiDevices[]} A base array of all devices.
+     */
+    baseArray(pluginName?: string): BaseDevice[];
+    /**
+     * Iterates over all devices.
+     *
+     * @returns {IterableIterator<MatterbridgeEndpoint>} An iterator for the devices.
+     */
+    [Symbol.iterator](): MapIterator<MatterbridgeEndpoint>;
+    /**
+     * Asynchronously iterates over each device and calls the provided callback function.
+     *
+     * @param {(device: MatterbridgeEndpoint) => Promise<void>} callback - The callback function to call with each device.
+     * @returns {Promise<void>} A promise that resolves when all callbacks have been called.
+     */
+    forEach(callback: (device: MatterbridgeEndpoint) => Promise<void>): Promise<void>;
+    /**
+     * Sets the log level.
+     *
+     * @param {LogLevel} logLevel - The log level to set.
+     */
+    set logLevel(logLevel: LogLevel);
+}
+//# sourceMappingURL=deviceManager.d.ts.map

package/dist/deviceManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deviceManager.d.ts","sourceRoot":"","sources":["../src/deviceManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAGH,OAAO,EAAkD,QAAQ,EAAmB,MAAM,kBAAkB,CAAC;AAG7G,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAAE,KAAK,UAAU,EAAO,MAAM,wBAAwB,CAAC;AAK9D;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,oBAAoB,GAAG,UAAU,GAAG,UAAU,CA0BlF;AAED;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA2C;IACpE,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAa;IACjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAkB;IACzC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAoD;IAC1E,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA2B;IAEnD;;OAEG;;IASH,OAAO,IAAI,IAAI;YAKD,UAAU;IA6CxB;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;;OAKG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAI9B;;;;;OAKG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,oBAAoB,GAAG,SAAS;IAIvD;;;;;;OAMG;IACH,GAAG,CAAC,MAAM,EAAE,oBAAoB,GAAG,oBAAoB;IAOvD;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO;IAM7C;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAIpB;;;;OAIG;IACH,KAAK,IAAI,oBAAoB,EAAE;IAI/B;;;;;OAKG;IACH,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,UAAU,EAAE;IAU5C;;;;OAIG;IACH,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIjB;;;;;OAKG;IACG,OAAO,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAavF;;;;OAIG;IACH,IAAI,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAE9B;CACF"}

package/dist/deviceManager.js

@@ -1,9 +1,40 @@
+/**
+ * This file contains the DeviceManager class.
+ *
+ * @file devices.ts
+ * @author Luca Liguori
+ * @created 2024-07-26
+ * @version 1.1.2
+ * @license Apache-2.0
+ *
+ * Copyright 2024, 2025, 2026 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.
+ */
+// AnsiLogger module
 import { AnsiLogger, BLUE, CYAN, db, debugStringify, er } from 'node-ansi-logger';
 import { dev } from './matterbridgeTypes.js';
 import { BroadcastServer } from './broadcastServer.js';
 import { hasParameter } from './utils/commandLine.js';
+/**
+ * Converts a MatterbridgeEndpoint to a BaseDevice.
+ *
+ * @param {MatterbridgeEndpoint} device The MatterbridgeEndpoint to convert.
+ * @returns {BaseDevice} The converted BaseDevice.
+ */
 export function toBaseDevice(device) {
     return {
+        // MatterbridgeEndpoint properties
         mode: device.mode,
         plugin: device.plugin,
         configUrl: device.configUrl,
@@ -23,18 +54,25 @@ export function toBaseDevice(device) {
         originalId: device.originalId,
         name: device.name,
         deviceType: device.deviceType,
+        // Endpoint properties
         number: device.number,
         id: device.id,
     };
 }
+/**
+ * Manages Matterbridge devices.
+ */
 export class DeviceManager {
     _devices = new Map();
     log;
     server;
     debug = hasParameter('debug') || hasParameter('verbose');
     verbose = hasParameter('verbose');
+    /**
+     * Creates an instance of DeviceManager.
+     */
     constructor() {
-        this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
+        this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: hasParameter('debug') ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
         this.log.debug('Matterbridge device manager starting...');
         this.server = new BroadcastServer('devices', this.log);
         this.server.on('broadcast_message', this.msgHandler.bind(this));
@@ -90,18 +128,47 @@ export class DeviceManager {
             }
         }
     }
+    /**
+     * Gets the number of devices.
+     *
+     * @returns {number} The number of devices.
+     */
     get length() {
         return this._devices.size;
     }
+    /**
+     * Gets the number of devices.
+     *
+     * @returns {number} The number of devices.
+     */
     get size() {
         return this._devices.size;
     }
+    /**
+     * Checks if a device with the specified unique ID exists.
+     *
+     * @param {string} uniqueId - The unique ID of the device.
+     * @returns {boolean} True if the device exists, false otherwise.
+     */
     has(uniqueId) {
         return this._devices.has(uniqueId);
     }
+    /**
+     * Gets a device by its unique ID.
+     *
+     * @param {string} uniqueId - The unique ID of the device.
+     * @returns {MatterbridgeEndpoint | undefined} The device, or undefined if not found.
+     */
     get(uniqueId) {
         return this._devices.get(uniqueId);
     }
+    /**
+     * Adds a device to the manager.
+     *
+     * @param {MatterbridgeEndpoint} device - The device to add.
+     * @returns {MatterbridgeEndpoint} The added device.
+     * @throws {Error} If the device does not have a unique ID.
+     */
     set(device) {
         if (!device.uniqueId)
             throw new Error(`The device ${dev}${device.deviceName}${er} has not been initialized: uniqueId is required`);
@@ -110,6 +177,13 @@ export class DeviceManager {
         this._devices.set(device.uniqueId, device);
         return device;
     }
+    /**
+     * Removes a device from the manager.
+     *
+     * @param {MatterbridgeEndpoint} device - The device to remove.
+     * @returns {boolean} True if the device was removed, false otherwise.
+     * @throws {Error} If the device does not have a unique ID.
+     */
     remove(device) {
         if (!device.uniqueId)
             throw new Error(`The device ${dev}${device.deviceName}${er} has not been initialized: uniqueId is required`);
@@ -117,27 +191,59 @@ export class DeviceManager {
             this.log.error(`The device ${dev}${device.deviceName}${er} with uniqueId ${BLUE}${device.uniqueId}${er} serialNumber ${BLUE}${device.serialNumber}${er} is not registered in the device manager`);
         return this._devices.delete(device.uniqueId);
     }
+    /**
+     * Clears all devices from the manager.
+     */
     clear() {
         this._devices.clear();
     }
+    /**
+     * Converts a MatterbridgeEndpoint to a BaseDevice.
+     *
+     * @param {MatterbridgeEndpoint} device The MatterbridgeEndpoint to convert.
+     * @returns {BaseDevice} The converted BaseDevice.
+     */
     toBaseDevice(device) {
         return toBaseDevice(device);
     }
+    /**
+     * Gets an array of all devices.
+     *
+     * @returns {MatterbridgeEndpoint[]} An array of all devices.
+     */
     array() {
         return Array.from(this._devices.values());
     }
+    /**
+     * Gets a base array of all devices suitable for serialization.
+     *
+     * @param {string} [pluginName] - Optional plugin name to filter devices.
+     * @returns {ApiDevices[]} A base array of all devices.
+     */
     baseArray(pluginName) {
         const devices = [];
         for (const device of Array.from(this._devices.values())) {
+            // Filter by pluginName if provided
             if (pluginName && pluginName !== device.plugin)
                 continue;
             devices.push(this.toBaseDevice(device));
         }
         return devices;
     }
+    /**
+     * Iterates over all devices.
+     *
+     * @returns {IterableIterator<MatterbridgeEndpoint>} An iterator for the devices.
+     */
     [Symbol.iterator]() {
         return this._devices.values();
     }
+    /**
+     * Asynchronously iterates over each device and calls the provided callback function.
+     *
+     * @param {(device: MatterbridgeEndpoint) => Promise<void>} callback - The callback function to call with each device.
+     * @returns {Promise<void>} A promise that resolves when all callbacks have been called.
+     */
     async forEach(callback) {
         if (this.size === 0)
             return;
@@ -151,7 +257,13 @@ export class DeviceManager {
         });
         await Promise.all(tasks);
     }
+    /**
+     * Sets the log level.
+     *
+     * @param {LogLevel} logLevel - The log level to set.
+     */
     set logLevel(logLevel) {
         this.log.logLevel = logLevel;
     }
 }
+//# sourceMappingURL=deviceManager.js.map

package/dist/deviceManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deviceManager.js","sourceRoot":"","sources":["../src/deviceManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,oBAAoB;AACpB,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAA6B,MAAM,kBAAkB,CAAC;AAI7G,OAAO,EAAmB,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,MAAyC;IACpE,OAAO;QACL,kCAAkC;QAClC,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,qBAAqB,EAAE,MAAM,CAAC,qBAAqB;QACnD,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,qBAAqB,EAAE,MAAM,CAAC,qBAAqB;QACnD,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,sBAAsB;QACtB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC,EAAE;KACd,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,aAAa;IACP,QAAQ,GAAG,IAAI,GAAG,EAAgC,CAAC;IACnD,GAAG,CAAa;IAChB,MAAM,CAAkB;IACxB,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC;IACzD,OAAO,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;IAEnD;;OAEG;IACH;QACE,IAAI,CAAC,GAAG,GAAG,IAAI,UAAU,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,kBAAkB,qCAA6B,EAAE,QAAQ,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,8BAAgB,CAAC,2BAAc,EAAE,CAAC,CAAC;QAC3K,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,GAAG,IAAI,eAAe,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QACvD,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,mBAAmB,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAChE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACxD,CAAC;IAED,OAAO;QACL,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACjE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,GAAkB;QACzC,IAAI,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;YACrC,IAAI,IAAI,CAAC,OAAO;gBAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4BAA4B,IAAI,GAAG,GAAG,CAAC,IAAI,GAAG,EAAE,SAAS,IAAI,GAAG,GAAG,CAAC,GAAG,GAAG,EAAE,KAAK,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAC9I,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;gBACjB,KAAK,eAAe;oBAClB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;oBACzE,MAAM;gBACR,KAAK,eAAe;oBAClB,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC;oBACxC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;oBACzE,MAAM;gBACR,KAAK,gBAAgB;oBACnB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;oBACjE,MAAM;gBACR,KAAK,cAAc;oBACjB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;oBAC7D,MAAM;gBACR,KAAK,aAAa;oBAChB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;oBAChF,MAAM;gBACR,KAAK,aAAa;oBAChB,CAAC;wBACC,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;wBAC/C,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;oBACrG,CAAC;oBACD,MAAM;gBACR,KAAK,aAAa;oBAChB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAoC,CAA0B,EAAE,EAAE,CAAC,CAAC;oBAC3J,MAAM;gBACR,KAAK,gBAAgB;oBACnB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAoC,CAAC,EAAE,EAAE,CAAC,CAAC;oBACtI,MAAM;gBACR,KAAK,eAAe;oBAClB,IAAI,CAAC,KAAK,EAAE,CAAC;oBACb,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;oBAC3D,MAAM;gBACR,KAAK,mBAAmB;oBACtB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC;oBAC5F,MAAM;gBACR;oBACE,IAAI,IAAI,CAAC,OAAO;wBAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,6BAA6B,IAAI,GAAG,GAAG,CAAC,IAAI,GAAG,EAAE,SAAS,IAAI,GAAG,GAAG,CAAC,GAAG,GAAG,EAAE,EAAE,CAAC,CAAC;YACtH,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC5B,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,QAAgB;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,QAAgB;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,MAA4B;QAC9B,IAAI,CAAC,MAAM,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,cAAc,GAAG,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,iDAAiD,CAAC,CAAC;QACnI,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC;YAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,GAAG,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,kBAAkB,IAAI,GAAG,MAAM,CAAC,QAAQ,GAAG,EAAE,iBAAiB,IAAI,GAAG,MAAM,CAAC,YAAY,GAAG,EAAE,mCAAmC,CAAC,CAAC;QACnO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC3C,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAA4B;QACjC,IAAI,CAAC,MAAM,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,cAAc,GAAG,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,iDAAiD,CAAC,CAAC;QACnI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC;YAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,GAAG,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,kBAAkB,IAAI,GAAG,MAAM,CAAC,QAAQ,GAAG,EAAE,iBAAiB,IAAI,GAAG,MAAM,CAAC,YAAY,GAAG,EAAE,0CAA0C,CAAC,CAAC;QAC3O,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACK,YAAY,CAAC,MAA4B;QAC/C,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,UAAmB;QAC3B,MAAM,OAAO,GAAiB,EAAE,CAAC;QACjC,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC;YACxD,mCAAmC;YACnC,IAAI,UAAU,IAAI,UAAU,KAAK,MAAM,CAAC,MAAM;gBAAE,SAAS;YACzD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1C,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,CAAC,MAAM,CAAC,QAAQ,CAAC;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CAAC,QAAyD;QACrE,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC;YAAE,OAAO;QAE5B,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACpE,IAAI,CAAC;gBACH,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;YACzB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mCAAmC,GAAG,GAAG,MAAM,CAAC,UAAU,GAAG,EAAE,iBAAiB,IAAI,GAAG,MAAM,CAAC,YAAY,GAAG,EAAE,cAAc,IAAI,GAAG,MAAM,CAAC,QAAQ,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;YACrL,CAAC;QACH,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,IAAI,QAAQ,CAAC,QAAkB;QAC7B,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC/B,CAAC;CACF"}

package/dist/devices/airConditioner.d.ts

@@ -0,0 +1,98 @@
+/**
+ * @description This file contains the AirConditioner class.
+ * @file src/devices/airConditioner.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 { ThermostatUserInterfaceConfiguration } from '@matter/types/clusters/thermostat-user-interface-configuration';
+import { FanControl } from '@matter/types/clusters/fan-control';
+import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
+/**
+ * Options for configuring an {@link AirConditioner} instance.
+ *
+ * All temperatures in °C. Typical valid range 0–50 unless otherwise noted.
+ */
+export interface AirConditionerOptions {
+    /** Local ambient temperature (°C). Default 23. */
+    localTemperature?: number;
+    /** Occupied heating setpoint (°C). Default 21. */
+    occupiedHeatingSetpoint?: number;
+    /** Occupied cooling setpoint (°C). Default 25. */
+    occupiedCoolingSetpoint?: number;
+    /** Minimum setpoint dead band (°C). Default 1. */
+    minSetpointDeadBand?: number;
+    /** Minimum heat setpoint limit (°C). Default 0. */
+    minHeatSetpointLimit?: number;
+    /** Maximum heat setpoint limit (°C). Default 50. */
+    maxHeatSetpointLimit?: number;
+    /** Minimum cool setpoint limit (°C). Default 0. */
+    minCoolSetpointLimit?: number;
+    /** Maximum cool setpoint limit (°C). Default 50. */
+    maxCoolSetpointLimit?: number;
+    /** Temperature display mode. Default Celsius. */
+    temperatureDisplayMode?: ThermostatUserInterfaceConfiguration.TemperatureDisplayMode;
+    /** Keypad lockout mode. Default NoLockout. */
+    keypadLockout?: ThermostatUserInterfaceConfiguration.KeypadLockout;
+    /** Schedule programming visibility. Default ScheduleProgrammingPermitted. */
+    scheduleProgrammingVisibility?: ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility;
+    /** Fan mode. Default Off. */
+    fanMode?: FanControl.FanMode;
+    /** Fan mode sequence. Default OffLowMedHighAuto. */
+    fanModeSequence?: FanControl.FanModeSequence;
+    /** Target fan percent setting (0–100). Default 0. */
+    percentSetting?: number;
+    /** Current fan percent (0–100). Default 0. */
+    percentCurrent?: number;
+}
+export declare class AirConditioner extends MatterbridgeEndpoint {
+    /**
+     * Creates an instance of the AirConditioner class.
+     *
+     * A Room Air Conditioner is a device which at a minimum is capable of being turned on and off and of controlling the temperature in the living space.
+     * A Room Air Conditioner MAY also support additional capabilities via endpoint composition.
+     * The DF (Dead Front) feature is required for the On/Off cluster in this device type.
+     *
+     * @param {string} name - The name of the air conditioner.
+     * @param {string} serial - The serial number of the air conditioner.
+     * @param {AirConditionerOptions} [options] - Optional configuration values. Missing fields use defaults.
+     *
+     * Options defaults:
+     *  - localTemperature: 23
+     *  - occupiedHeatingSetpoint: 21
+     *  - occupiedCoolingSetpoint: 25
+     *  - minSetpointDeadBand: 1
+     *  - minHeatSetpointLimit: 0
+     *  - maxHeatSetpointLimit: 50
+     *  - minCoolSetpointLimit: 0
+     *  - maxCoolSetpointLimit: 50
+     *  - temperatureDisplayMode: Celsius
+     *  - keypadLockout: NoLockout
+     *  - scheduleProgrammingVisibility: ScheduleProgrammingPermitted
+     *  - fanMode: Off
+     *  - fanModeSequence: OffLowMedHighAuto
+     *  - percentSetting: 0
+     *  - percentCurrent: 0
+     *
+     * @returns {AirConditioner} The AirConditioner instance.
+     *
+     * @remarks Not supported by Google Home.
+     */
+    constructor(name: string, serial: string, options?: AirConditionerOptions);
+}
+//# sourceMappingURL=airConditioner.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"airConditioner.d.ts","sourceRoot":"","sources":["../../src/devices/airConditioner.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,EAAE,oCAAoC,EAAE,MAAM,gEAAgE,CAAC;AACtH,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAIhE,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAElE;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,kDAAkD;IAClD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kDAAkD;IAClD,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,kDAAkD;IAClD,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,kDAAkD;IAClD,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,mDAAmD;IACnD,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,oDAAoD;IACpD,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,mDAAmD;IACnD,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,oDAAoD;IACpD,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,iDAAiD;IACjD,sBAAsB,CAAC,EAAE,oCAAoC,CAAC,sBAAsB,CAAC;IACrF,8CAA8C;IAC9C,aAAa,CAAC,EAAE,oCAAoC,CAAC,aAAa,CAAC;IACnE,6EAA6E;IAC7E,6BAA6B,CAAC,EAAE,oCAAoC,CAAC,6BAA6B,CAAC;IACnG,6BAA6B;IAC7B,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC;IAC7B,oDAAoD;IACpD,eAAe,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC;IAC7C,qDAAqD;IACrD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,8CAA8C;IAC9C,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,qBAAa,cAAe,SAAQ,oBAAoB;IACtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;gBACS,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B;CA2B9E"}

package/dist/devices/airConditioner.js

@@ -1,8 +1,64 @@
+/**
+ * @description This file contains the AirConditioner class.
+ * @file src/devices/airConditioner.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.
+ */
+// Imports from @matter
 import { ThermostatUserInterfaceConfiguration } from '@matter/types/clusters/thermostat-user-interface-configuration';
 import { FanControl } from '@matter/types/clusters/fan-control';
+// Matterbridge
 import { airConditioner, powerSource } from '../matterbridgeDeviceTypes.js';
 import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
 export class AirConditioner extends MatterbridgeEndpoint {
+    /**
+     * Creates an instance of the AirConditioner class.
+     *
+     * A Room Air Conditioner is a device which at a minimum is capable of being turned on and off and of controlling the temperature in the living space.
+     * A Room Air Conditioner MAY also support additional capabilities via endpoint composition.
+     * The DF (Dead Front) feature is required for the On/Off cluster in this device type.
+     *
+     * @param {string} name - The name of the air conditioner.
+     * @param {string} serial - The serial number of the air conditioner.
+     * @param {AirConditionerOptions} [options] - Optional configuration values. Missing fields use defaults.
+     *
+     * Options defaults:
+     *  - localTemperature: 23
+     *  - occupiedHeatingSetpoint: 21
+     *  - occupiedCoolingSetpoint: 25
+     *  - minSetpointDeadBand: 1
+     *  - minHeatSetpointLimit: 0
+     *  - maxHeatSetpointLimit: 50
+     *  - minCoolSetpointLimit: 0
+     *  - maxCoolSetpointLimit: 50
+     *  - temperatureDisplayMode: Celsius
+     *  - keypadLockout: NoLockout
+     *  - scheduleProgrammingVisibility: ScheduleProgrammingPermitted
+     *  - fanMode: Off
+     *  - fanModeSequence: OffLowMedHighAuto
+     *  - percentSetting: 0
+     *  - percentCurrent: 0
+     *
+     * @returns {AirConditioner} The AirConditioner instance.
+     *
+     * @remarks Not supported by Google Home.
+     */
     constructor(name, serial, options = {}) {
         const { localTemperature = 23, occupiedHeatingSetpoint = 21, occupiedCoolingSetpoint = 25, minSetpointDeadBand = 1, minHeatSetpointLimit = 0, maxHeatSetpointLimit = 50, minCoolSetpointLimit = 0, maxCoolSetpointLimit = 50, temperatureDisplayMode = ThermostatUserInterfaceConfiguration.TemperatureDisplayMode.Celsius, keypadLockout = ThermostatUserInterfaceConfiguration.KeypadLockout.NoLockout, scheduleProgrammingVisibility = ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility.ScheduleProgrammingPermitted, fanMode = FanControl.FanMode.Off, fanModeSequence = FanControl.FanModeSequence.OffLowMedHighAuto, percentSetting = 0, percentCurrent = 0, } = options;
         super([airConditioner, powerSource], { id: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` });
@@ -15,3 +71,4 @@ export class AirConditioner extends MatterbridgeEndpoint {
         this.createDefaultFanControlClusterServer(fanMode, fanModeSequence, percentSetting, percentCurrent);
     }
 }
+//# sourceMappingURL=airConditioner.js.map

package/dist/devices/airConditioner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"airConditioner.js","sourceRoot":"","sources":["../../src/devices/airConditioner.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,uBAAuB;AACvB,OAAO,EAAE,oCAAoC,EAAE,MAAM,gEAAgE,CAAC;AACtH,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAEhE,eAAe;AACf,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAwClE,MAAM,OAAO,cAAe,SAAQ,oBAAoB;IACtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,YAAY,IAAY,EAAE,MAAc,EAAE,UAAiC,EAAE;QAC3E,MAAM,EACJ,gBAAgB,GAAG,EAAE,EACrB,uBAAuB,GAAG,EAAE,EAC5B,uBAAuB,GAAG,EAAE,EAC5B,mBAAmB,GAAG,CAAC,EACvB,oBAAoB,GAAG,CAAC,EACxB,oBAAoB,GAAG,EAAE,EACzB,oBAAoB,GAAG,CAAC,EACxB,oBAAoB,GAAG,EAAE,EACzB,sBAAsB,GAAG,oCAAoC,CAAC,sBAAsB,CAAC,OAAO,EAC5F,aAAa,GAAG,oCAAoC,CAAC,aAAa,CAAC,SAAS,EAC5E,6BAA6B,GAAG,oCAAoC,CAAC,6BAA6B,CAAC,4BAA4B,EAC/H,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,EAChC,eAAe,GAAG,UAAU,CAAC,eAAe,CAAC,iBAAiB,EAC9D,cAAc,GAAG,CAAC,EAClB,cAAc,GAAG,CAAC,GACnB,GAAG,OAAO,CAAC;QACZ,KAAK,CAAC,CAAC,cAAc,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,CAAC,CAAC;QAC1G,IAAI,CAAC,kCAAkC,EAAE,CAAC;QAC1C,IAAI,CAAC,0CAA0C,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,8BAA8B,CAAC,CAAC;QAC9H,IAAI,CAAC,0CAA0C,EAAE,CAAC;QAClD,IAAI,CAAC,iCAAiC,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,oCAAoC,CAAC,gBAAgB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,oBAAoB,CAAC,CAAC;QAC3N,IAAI,CAAC,8DAA8D,CAAC,sBAAsB,EAAE,aAAa,EAAE,6BAA6B,CAAC,CAAC;QAC1I,IAAI,CAAC,oCAAoC,CAAC,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC;IACtG,CAAC;CACF"}

package/dist/devices/batteryStorage.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @description This file contains the BatteryStorage class.
+ * @file src/devices/batteryStorage.ts
+ * @author Luca Liguori
+ * @contributor Ludovic BOUÉ
+ * @created 2025-06-20
+ * @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 { PowerSource } from '@matter/types/clusters/power-source';
+import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
+export declare class BatteryStorage extends MatterbridgeEndpoint {
+    /**
+     * Creates an instance of the BatteryStorage class.
+     *
+     * @param {string} name - The name of the BatteryStorage.
+     * @param {string} serial - The serial number of the BatteryStorage.
+     * @param {number} [batPercentRemaining] - The percentage of battery remaining, defaults to `100` if not provided.
+     * @param {PowerSource.BatChargeLevel} [batChargeLevel] - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
+     * @param {number} voltage - The voltage value in millivolts.
+     * @param {number} current - The current value in milliamperes.
+     * @param {number} power - The power value in milliwatts.
+     * @param {number} energyImported - The total production value in mW/h.
+     * @param {number} 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.
+     *
+     * @remarks
+     * - A battery storage inverter that can charge its battery at a maximum power of 2000W and can
+     * discharge the battery at a maximum power of 3000W, would have a absMinPower: -3000W, absMaxPower: 2000W.
+     */
+    constructor(name: string, serial: string, batPercentRemaining?: number, batChargeLevel?: PowerSource.BatChargeLevel, voltage?: number | bigint | null, current?: number | bigint | null, power?: number | bigint | null, energyImported?: number | bigint | null, energyExported?: number | bigint | null, absMinPower?: number, absMaxPower?: number);
+}
+//# sourceMappingURL=batteryStorage.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"batteryStorage.d.ts","sourceRoot":"","sources":["../../src/devices/batteryStorage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAKH,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAGlE,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAGlE,qBAAa,cAAe,SAAQ,oBAAoB;IACtD;;;;;;;;;;;;;;;;;;OAkBG;gBAED,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,mBAAmB,GAAE,MAAY,EACjC,cAAc,GAAE,WAAW,CAAC,cAA8C,EAC1E,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,cAAc,GAAE,MAAM,GAAG,MAAM,GAAG,IAAW,EAC7C,WAAW,GAAE,MAAU,EACvB,WAAW,GAAE,MAAU;CA0B1B"}

package/dist/devices/batteryStorage.js

@@ -1,9 +1,53 @@
+/**
+ * @description This file contains the BatteryStorage class.
+ * @file src/devices/batteryStorage.ts
+ * @author Luca Liguori
+ * @contributor Ludovic BOUÉ
+ * @created 2025-06-20
+ * @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';
 import { PowerSource } from '@matter/types/clusters/power-source';
+// Matterbridge
 import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
 import { deviceEnergyManagement, electricalSensor, batteryStorage, powerSource } from '../matterbridgeDeviceTypes.js';
 export class BatteryStorage extends MatterbridgeEndpoint {
+    /**
+     * Creates an instance of the BatteryStorage class.
+     *
+     * @param {string} name - The name of the BatteryStorage.
+     * @param {string} serial - The serial number of the BatteryStorage.
+     * @param {number} [batPercentRemaining] - The percentage of battery remaining, defaults to `100` if not provided.
+     * @param {PowerSource.BatChargeLevel} [batChargeLevel] - The battery charge level (default: PowerSource.BatChargeLevel.Ok).
+     * @param {number} voltage - The voltage value in millivolts.
+     * @param {number} current - The current value in milliamperes.
+     * @param {number} power - The power value in milliwatts.
+     * @param {number} energyImported - The total production value in mW/h.
+     * @param {number} 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.
+     *
+     * @remarks
+     * - A battery storage inverter that can charge its battery at a maximum power of 2000W and can
+     * discharge the battery at a maximum power of 3000W, would have a absMinPower: -3000W, absMaxPower: 2000W.
+     */
     constructor(name, serial, batPercentRemaining = 100, batChargeLevel = PowerSource.BatChargeLevel.Ok, voltage = null, current = null, power = null, energyImported = null, energyExported = null, absMinPower = 0, absMaxPower = 0) {
         super([batteryStorage, electricalSensor, deviceEnergyManagement], { id: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` });
         this.createDefaultIdentifyClusterServer()
@@ -14,10 +58,12 @@ export class BatteryStorage extends MatterbridgeEndpoint {
             .createDefaultDeviceEnergyManagementClusterServer(DeviceEnergyManagement.EsaType.BatteryStorage, true, DeviceEnergyManagement.EsaState.Online, absMinPower, absMaxPower)
             .createDefaultDeviceEnergyManagementModeClusterServer()
             .addRequiredClusterServers();
+        // Add separate PowerSource child devices cause in matter.js the PowerSource cluster is not supported with both features Wired and Battery.
+        // Probably this is also an error in the specification...
         this.addChildDeviceType('BatteryPowerSource', powerSource, {
             tagList: [{ mfgCode: null, namespaceId: PowerSourceTag.Battery.namespaceId, tag: PowerSourceTag.Battery.tag, label: null }],
         })
-            .createDefaultPowerSourceRechargeableBatteryClusterServer(batPercentRemaining, batChargeLevel, 24_000)
+            .createDefaultPowerSourceRechargeableBatteryClusterServer(batPercentRemaining, batChargeLevel, 24_000) // Battery voltage in mV (24V).
             .addRequiredClusterServers();
         this.addChildDeviceType('GridPowerSource', powerSource, {
             tagList: [{ mfgCode: null, namespaceId: PowerSourceTag.Grid.namespaceId, tag: PowerSourceTag.Grid.tag, label: null }],
@@ -26,3 +72,4 @@ export class BatteryStorage extends MatterbridgeEndpoint {
             .addRequiredClusterServers();
     }
 }
+//# sourceMappingURL=batteryStorage.js.map