matterbridge 3.0.7-dev-20250620-076b34c → 3.0.7

package/dist/devices/export.d.ts

@@ -0,0 +1,5 @@
+export * from '../roboticVacuumCleaner.js';
+export * from '../laundryWasher.js';
+export * from '../waterHeater.js';
+export * from '../evse.js';
+//# sourceMappingURL=export.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"export.d.ts","sourceRoot":"","sources":["../../src/devices/export.ts"],"names":[],"mappings":"AACA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC"}

package/dist/devices/export.js

@@ -1,4 +1,6 @@
+// Single class device types
 export * from '../roboticVacuumCleaner.js';
 export * from '../laundryWasher.js';
 export * from '../waterHeater.js';
 export * from '../evse.js';
+//# sourceMappingURL=export.js.map

package/dist/devices/export.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.js","sourceRoot":"","sources":["../../src/devices/export.ts"],"names":[],"mappings":"AAAA,4BAA4B;AAC5B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC"}

package/dist/evse.d.ts

@@ -0,0 +1,67 @@
+/**
+ * This file contains the Evse class.
+ *
+ * @file energy-evse.ts
+ * @author Luca Liguori
+ * @contributor Ludovic BOUÉ
+ * @date 2025-05-27
+ * @version 1.1.0
+ *
+ * Copyright 2025, 2026, 2027 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License. *
+ */
+import { MaybePromise } from '@matter/main';
+import { EnergyEvseServer } from '@matter/main/behaviors/energy-evse';
+import { EnergyEvseModeServer } from '@matter/main/behaviors/energy-evse-mode';
+import { EnergyEvse, EnergyEvseMode } from '@matter/main/clusters';
+import { ModeBase } from '@matter/main/clusters/mode-base';
+import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
+export declare class Evse extends MatterbridgeEndpoint {
+    /**
+     * Creates an instance of the EVSE class.
+     *
+     * @param {string} name - The name of the EVSE.
+     * @param {string} serial - The serial number of the EVSE.
+     * @param {number} [currentMode] - The current mode of the EnergyEvseMode cluster. Defaults to mode 1 (EnergyEvseMode.ModeTag.Manual).
+     * @param {EnergyEvseMode.ModeOption[]} [supportedModes] - The supported modes for the EnergyEvseMode cluster. This is a fixed attribute that defaults to a predefined set of EnergyEvseMode cluster modes.
+     * @param {EnergyEvse.State} [state] - The current state of the EVSE. Defaults to NotPluggedIn.
+     * @param {EnergyEvse.SupplyState} [supplyState] - The supply state of the EVSE. Defaults to Disabled.
+     * @param {EnergyEvse.FaultState} [faultState] - The fault state of the EVSE. Defaults to NoError.
+     * @param {number} [absMinPower=0] - Indicate the minimum electrical power that the ESA can consume when switched on. Defaults to `0` if not provided.
+     * @param {number} [absMaxPower=0] - Indicate the maximum electrical power that the ESA can consume when switched on. Defaults to `0` if not provided.
+     */
+    constructor(name: string, serial: string, currentMode?: number, supportedModes?: EnergyEvseMode.ModeOption[], state?: EnergyEvse.State, supplyState?: EnergyEvse.SupplyState, faultState?: EnergyEvse.FaultState, absMinPower?: number, absMaxPower?: number);
+    /**
+     * Creates a default EnergyEvseServer Cluster Server.
+     *
+     */
+    createDefaultEnergyEvseClusterServer(state?: EnergyEvse.State, supplyState?: EnergyEvse.SupplyState, faultState?: EnergyEvse.FaultState): this;
+    /**
+     * Creates a default EnergyEvseMode Cluster Server.
+     *
+     * @param {number} [currentMode] - The current mode of the EnergyEvseMode cluster. Defaults to mode 1 (EnergyEvseMode.ModeTag.Manual).
+     * @param {EnergyEvseMode.ModeOption[]} [supportedModes] - The supported modes for the EnergyEvseMode cluster. Defaults all EnergyEvseMode cluster modes.
+     *
+     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
+     */
+    createDefaultEnergyEvseModeClusterServer(currentMode?: number, supportedModes?: EnergyEvseMode.ModeOption[]): this;
+}
+export declare class MatterbridgeEnergyEvseServer extends EnergyEvseServer {
+    disable(): MaybePromise;
+    enableCharging(request: EnergyEvse.EnableChargingRequest): MaybePromise;
+}
+export declare class MatterbridgeEnergyEvseModeServer extends EnergyEvseModeServer {
+    changeToMode(request: ModeBase.ChangeToModeRequest): MaybePromise<ModeBase.ChangeToModeResponse>;
+}
+//# sourceMappingURL=evse.d.ts.map

package/dist/evse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"evse.d.ts","sourceRoot":"","sources":["../src/evse.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAC/E,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEnE,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAG3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAIjE,qBAAa,IAAK,SAAQ,oBAAoB;IAC5C;;;;;;;;;;;;OAYG;gBAED,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,WAAW,CAAC,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,cAAc,CAAC,UAAU,EAAE,EAC5C,KAAK,CAAC,EAAE,UAAU,CAAC,KAAK,EACxB,WAAW,CAAC,EAAE,UAAU,CAAC,WAAW,EACpC,UAAU,CAAC,EAAE,UAAU,CAAC,UAAU,EAClC,WAAW,CAAC,EAAE,MAAM,EACpB,WAAW,CAAC,EAAE,MAAM;IAetB;;;OAGG;IACH,oCAAoC,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,UAAU,CAAC,UAAU,GAAG,IAAI;IAgB9I;;;;;;;OAOG;IACH,wCAAwC,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,cAAc,CAAC,UAAU,EAAE,GAAG,IAAI;CAYnH;AAED,qBAAa,4BAA6B,SAAQ,gBAAgB;IACvD,OAAO,IAAI,YAAY;IAavB,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,qBAAqB,GAAG,YAAY;CAgBjF;AAED,qBAAa,gCAAiC,SAAQ,oBAAoB;IAC/D,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,mBAAmB,GAAG,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC;CAa1G"}

package/dist/evse.js

@@ -1,12 +1,49 @@
+/**
+ * This file contains the Evse class.
+ *
+ * @file energy-evse.ts
+ * @author Luca Liguori
+ * @contributor Ludovic BOUÉ
+ * @date 2025-05-27
+ * @version 1.1.0
+ *
+ * Copyright 2025, 2026, 2027 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License. *
+ */
 import { EnergyEvseServer } from '@matter/main/behaviors/energy-evse';
 import { EnergyEvseModeServer } from '@matter/main/behaviors/energy-evse-mode';
 import { EnergyEvse, EnergyEvseMode } from '@matter/main/clusters';
 import { DeviceEnergyManagement } from '@matter/main/clusters/device-energy-management';
 import { ModeBase } from '@matter/main/clusters/mode-base';
+// Matterbridge
 import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
 import { MatterbridgeServer } from './matterbridgeBehaviors.js';
 import { deviceEnergyManagement, electricalSensor, evse, powerSource } from './matterbridgeDeviceTypes.js';
 export class Evse extends MatterbridgeEndpoint {
+    /**
+     * Creates an instance of the EVSE class.
+     *
+     * @param {string} name - The name of the EVSE.
+     * @param {string} serial - The serial number of the EVSE.
+     * @param {number} [currentMode] - The current mode of the EnergyEvseMode cluster. Defaults to mode 1 (EnergyEvseMode.ModeTag.Manual).
+     * @param {EnergyEvseMode.ModeOption[]} [supportedModes] - The supported modes for the EnergyEvseMode cluster. This is a fixed attribute that defaults to a predefined set of EnergyEvseMode cluster modes.
+     * @param {EnergyEvse.State} [state] - The current state of the EVSE. Defaults to NotPluggedIn.
+     * @param {EnergyEvse.SupplyState} [supplyState] - The supply state of the EVSE. Defaults to Disabled.
+     * @param {EnergyEvse.FaultState} [faultState] - The fault state of the EVSE. Defaults to NoError.
+     * @param {number} [absMinPower=0] - Indicate the minimum electrical power that the ESA can consume when switched on. Defaults to `0` if not provided.
+     * @param {number} [absMaxPower=0] - Indicate the maximum electrical power that the ESA can consume when switched on. Defaults to `0` if not provided.
+     */
     constructor(name, serial, currentMode, supportedModes, state, supplyState, faultState, absMinPower, absMaxPower) {
         super([evse, powerSource, electricalSensor, deviceEnergyManagement], { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
         this.createDefaultIdentifyClusterServer()
@@ -20,29 +57,42 @@ export class Evse extends MatterbridgeEndpoint {
             .createDefaultEnergyEvseModeClusterServer(currentMode, supportedModes)
             .addRequiredClusterServers();
     }
+    /**
+     * Creates a default EnergyEvseServer Cluster Server.
+     *
+     */
     createDefaultEnergyEvseClusterServer(state, supplyState, faultState) {
         this.behaviors.require(MatterbridgeEnergyEvseServer, {
             state: state ?? EnergyEvse.State.NotPluggedIn,
             supplyState: supplyState ?? EnergyEvse.SupplyState.ChargingEnabled,
             faultState: faultState ?? EnergyEvse.FaultState.NoError,
-            chargingEnabledUntil: 0,
-            circuitCapacity: 0,
-            minimumChargeCurrent: 6000,
-            maximumChargeCurrent: 0,
-            sessionId: null,
-            sessionDuration: 0,
-            sessionEnergyCharged: 0,
+            chargingEnabledUntil: 0, // Persistent attribute
+            circuitCapacity: 0, // Persistent attribute in mA
+            minimumChargeCurrent: 6000, // Persistent attribute in mA
+            maximumChargeCurrent: 0, // Persistent attribute in mA
+            sessionId: null, // Persistent attribute
+            sessionDuration: 0, // Persistent attribute
+            sessionEnergyCharged: 0, // Persistent attribute
         });
         return this;
     }
+    /**
+     * Creates a default EnergyEvseMode Cluster Server.
+     *
+     * @param {number} [currentMode] - The current mode of the EnergyEvseMode cluster. Defaults to mode 1 (EnergyEvseMode.ModeTag.Manual).
+     * @param {EnergyEvseMode.ModeOption[]} [supportedModes] - The supported modes for the EnergyEvseMode cluster. Defaults all EnergyEvseMode cluster modes.
+     *
+     * @returns {this} The current MatterbridgeEndpoint instance for chaining.
+     */
     createDefaultEnergyEvseModeClusterServer(currentMode, supportedModes) {
         this.behaviors.require(MatterbridgeEnergyEvseModeServer, {
             supportedModes: supportedModes ?? [
                 { label: 'On demand', mode: 1, modeTags: [{ value: EnergyEvseMode.ModeTag.Manual }] },
                 { label: 'Scheduled', mode: 2, modeTags: [{ value: EnergyEvseMode.ModeTag.TimeOfUse }] },
                 { label: 'Solar charging', mode: 3, modeTags: [{ value: EnergyEvseMode.ModeTag.SolarCharging }] },
-            ],
-            currentMode: currentMode ?? 1,
+                // { label: 'Home to vehicle and Vehicle to home', mode: 4, modeTags: [{ value: EnergyEvseMode.ModeTag.V2X }] }, // This mode is not valid in charging only EVSEs
+            ], // FixedAttribute
+            currentMode: currentMode ?? 1, // Persistent attribute
         });
         return this;
     }
@@ -58,6 +108,8 @@ export class MatterbridgeEnergyEvseServer extends EnergyEvseServer {
             this.state.state = EnergyEvse.State.PluggedInDemand;
         }
         this.state.chargingEnabledUntil = 0;
+        // super.disable();
+        // disable is not implemented in matter.js
     }
     enableCharging(request) {
         const device = this.endpoint.stateOf(MatterbridgeServer);
@@ -71,6 +123,9 @@ export class MatterbridgeEnergyEvseServer extends EnergyEvseServer {
         this.state.chargingEnabledUntil = request.chargingEnabledUntil;
         this.state.minimumChargeCurrent = request.minimumChargeCurrent;
         this.state.maximumChargeCurrent = request.maximumChargeCurrent;
+        // The implementation should also stop the charging session at the required time and update the sessionId, sessionDuration, and sessionEnergyCharged attributes if needed.
+        // super.enableCharging();
+        // enableCharging is not implemented in matter.js
     }
 }
 export class MatterbridgeEnergyEvseModeServer extends EnergyEvseModeServer {
@@ -88,3 +143,4 @@ export class MatterbridgeEnergyEvseModeServer extends EnergyEvseModeServer {
         return { status: ModeBase.ModeChangeStatus.Success, statusText: 'Success' };
     }
 }
+//# sourceMappingURL=evse.js.map

package/dist/evse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"evse.js","sourceRoot":"","sources":["../src/evse.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAIH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAC/E,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,gDAAgD,CAAC;AACxF,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAE3D,eAAe;AACf,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3G,MAAM,OAAO,IAAK,SAAQ,oBAAoB;IAC5C;;;;;;;;;;;;OAYG;IACH,YACE,IAAY,EACZ,MAAc,EACd,WAAoB,EACpB,cAA4C,EAC5C,KAAwB,EACxB,WAAoC,EACpC,UAAkC,EAClC,WAAoB,EACpB,WAAoB;QAEpB,KAAK,CAAC,CAAC,IAAI,EAAE,WAAW,EAAE,gBAAgB,EAAE,sBAAsB,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;QAC9J,IAAI,CAAC,kCAAkC,EAAE;aACtC,0CAA0C,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,mBAAmB,CAAC;aAC7G,0CAA0C,EAAE;aAC5C,uCAAuC,EAAE;aACzC,oDAAoD,EAAE;aACtD,qDAAqD,EAAE;aACvD,gDAAgD,CAAC,sBAAsB,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,sBAAsB,CAAC,QAAQ,CAAC,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC;aAC9J,oCAAoC,CAAC,KAAK,EAAE,WAAW,EAAE,UAAU,CAAC;aACpE,wCAAwC,CAAC,WAAW,EAAE,cAAc,CAAC;aACrE,yBAAyB,EAAE,CAAC;IACjC,CAAC;IAED;;;OAGG;IACH,oCAAoC,CAAC,KAAwB,EAAE,WAAoC,EAAE,UAAkC;QACrI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,4BAA4B,EAAE;YACnD,KAAK,EAAE,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,YAAY;YAC7C,WAAW,EAAE,WAAW,IAAI,UAAU,CAAC,WAAW,CAAC,eAAe;YAClE,UAAU,EAAE,UAAU,IAAI,UAAU,CAAC,UAAU,CAAC,OAAO;YACvD,oBAAoB,EAAE,CAAC,EAAE,uBAAuB;YAChD,eAAe,EAAE,CAAC,EAAE,6BAA6B;YACjD,oBAAoB,EAAE,IAAI,EAAE,6BAA6B;YACzD,oBAAoB,EAAE,CAAC,EAAE,6BAA6B;YACtD,SAAS,EAAE,IAAI,EAAE,uBAAuB;YACxC,eAAe,EAAE,CAAC,EAAE,uBAAuB;YAC3C,oBAAoB,EAAE,CAAC,EAAE,uBAAuB;SACjD,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,wCAAwC,CAAC,WAAoB,EAAE,cAA4C;QACzG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,gCAAgC,EAAE;YACvD,cAAc,EAAE,cAAc,IAAI;gBAChC,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE;gBACrF,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,EAAE;gBACxF,EAAE,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,EAAE;gBACjG,iKAAiK;aAClK,EAAE,iBAAiB;YACpB,WAAW,EAAE,WAAW,IAAI,CAAC,EAAE,uBAAuB;SACvD,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,MAAM,OAAO,4BAA6B,SAAQ,gBAAgB;IACvD,OAAO;QACd,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,8BAA8B,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,CAAC;QACrG,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,gBAAgB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAChJ,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAC;QAChE,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC;QACzD,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,KAAK,UAAU,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC5D,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,eAAe,CAAC;QACtD,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,oBAAoB,GAAG,CAAC,CAAC;QACpC,mBAAmB;QACnB,0CAA0C;IAC5C,CAAC;IACQ,cAAc,CAAC,OAAyC;QAC/D,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,gBAAgB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnJ,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACvE,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC,eAAe,CAAC;QAChE,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,KAAK,UAAU,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC;YAC1D,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,iBAAiB,CAAC;QACxD,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;QAC/D,IAAI,CAAC,KAAK,CAAC,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;QAC/D,IAAI,CAAC,KAAK,CAAC,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;QAC/D,0KAA0K;QAC1K,0BAA0B;QAC1B,iDAAiD;IACnD,CAAC;CACF;AAED,MAAM,OAAO,gCAAiC,SAAQ,oBAAoB;IAC/D,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,oBAAoB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACrJ,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,kFAAkF,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;YACtH,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,qEAAqE,OAAO,CAAC,OAAO,OAAO,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;QAC/H,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;IAC9E,CAAC;CACF"}

package/dist/frontend.d.ts

@@ -0,0 +1,256 @@
+/**
+ * This file contains the class Frontend.
+ *
+ * @file frontend.ts
+ * @author Luca Liguori
+ * @date 2025-01-13
+ * @version 1.0.2
+ *
+ * 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 { LogLevel } from './logger/export.js';
+import { Matterbridge } from './matterbridge.js';
+/**
+ * Websocket message ID for logging.
+ * @constant {number}
+ */
+export declare const WS_ID_LOG = 0;
+/**
+ * Websocket message ID indicating a refresh is needed.
+ * @constant {number}
+ */
+export declare const WS_ID_REFRESH_NEEDED = 1;
+/**
+ * Websocket message ID indicating a restart is needed.
+ * @constant {number}
+ */
+export declare const WS_ID_RESTART_NEEDED = 2;
+/**
+ * Websocket message ID indicating a cpu update.
+ * @constant {number}
+ */
+export declare const WS_ID_CPU_UPDATE = 3;
+/**
+ * Websocket message ID indicating a memory update.
+ * @constant {number}
+ */
+export declare const WS_ID_MEMORY_UPDATE = 4;
+/**
+ * Websocket message ID indicating an uptime update.
+ * @constant {number}
+ */
+export declare const WS_ID_UPTIME_UPDATE = 5;
+/**
+ * Websocket message ID indicating a snackbar message.
+ * @constant {number}
+ */
+export declare const WS_ID_SNACKBAR = 6;
+/**
+ * Websocket message ID indicating matterbridge has un update available.
+ * @constant {number}
+ */
+export declare const WS_ID_UPDATE_NEEDED = 7;
+/**
+ * Websocket message ID indicating a state update.
+ * @constant {number}
+ */
+export declare const WS_ID_STATEUPDATE = 8;
+/**
+ * Websocket message ID indicating to close a permanent snackbar message.
+ * @constant {number}
+ */
+export declare const WS_ID_CLOSE_SNACKBAR = 9;
+/**
+ * Websocket message ID indicating a shelly system update.
+ * check:
+ * curl -k http://127.0.0.1:8101/api/updates/sys/check
+ * perform:
+ * curl -k http://127.0.0.1:8101/api/updates/sys/perform
+ * @constant {number}
+ */
+export declare const WS_ID_SHELLY_SYS_UPDATE = 100;
+/**
+ * Websocket message ID indicating a shelly main update.
+ * check:
+ * curl -k http://127.0.0.1:8101/api/updates/main/check
+ * perform:
+ * curl -k http://127.0.0.1:8101/api/updates/main/perform
+ * @constant {number}
+ */
+export declare const WS_ID_SHELLY_MAIN_UPDATE = 101;
+export declare class Frontend {
+    private matterbridge;
+    private log;
+    private port;
+    private initializeError;
+    private expressApp;
+    private httpServer;
+    private httpsServer;
+    private webSocketServer;
+    constructor(matterbridge: Matterbridge);
+    set logLevel(logLevel: LogLevel);
+    start(port?: number): Promise<void>;
+    stop(): Promise<void>;
+    private formatMemoryUsage;
+    private formatOsUpTime;
+    /**
+     * Retrieves the api settings data.
+     *
+     * @returns {Promise<{ matterbridgeInformation: MatterbridgeInformation, systemInformation: SystemInformation }>} A promise that resolve in the api settings object.
+     */
+    private getApiSettings;
+    /**
+     * Retrieves the reachable attribute.
+     * @param {MatterbridgeDevice} device - The MatterbridgeDevice object.
+     * @returns {boolean} The reachable attribute.
+     */
+    private getReachability;
+    /**
+     * Retrieves the power source attribute.
+     * @param {MatterbridgeEndpoint} endpoint - The MatterbridgeDevice object.
+     * @returns {'ac' | 'dc' | 'ok' | 'warning' | 'critical' | undefined} The power source attribute.
+     */
+    private getPowerSource;
+    /**
+     * Retrieves the cluster text description from a given device.
+     * @param {MatterbridgeDevice} device - The MatterbridgeDevice object.
+     * @returns {string} The attributes description of the cluster servers in the device.
+     */
+    private getClusterTextFromDevice;
+    /**
+     * Retrieves the base registered plugins sanitized for res.json().
+     * @returns {BaseRegisteredPlugin[]} An array of BaseRegisteredPlugin.
+     */
+    private getBaseRegisteredPlugins;
+    /**
+     * Retrieves the devices from Matterbridge.
+     * @param {string} [pluginName] - The name of the plugin to filter devices by.
+     * @returns {Promise<ApiDevices[]>} A promise that resolves to an array of ApiDevices.
+     */
+    private getDevices;
+    /**
+     * Retrieves the clusters from a given plugin and endpoint number.
+     *
+     * Response for /api/clusters
+     *
+     * @param {string} pluginName - The name of the plugin.
+     * @param {number} endpointNumber - The endpoint number.
+     * @returns {Promise<ApiClustersResponse | undefined>} A promise that resolves to the clusters or undefined if not found.
+     */
+    private getClusters;
+    /**
+     * Handles incoming websocket messages for the Matterbridge frontend.
+     *
+     * @param {WebSocket} client - The websocket client that sent the message.
+     * @param {WebSocket.RawData} message - The raw data of the message received from the client.
+     * @returns {Promise<void>} A promise that resolves when the message has been handled.
+     */
+    private wsMessageHandler;
+    /**
+     * Sends a WebSocket log message to all connected clients. The function is called by AnsiLogger.setGlobalCallback.
+     *
+     * @param {string} level - The logger level of the message: debug info notice warn error fatal...
+     * @param {string} time - The time string of the message
+     * @param {string} name - The logger name of the message
+     * @param {string} message - The content of the message.
+     *
+     * @remark
+     * The function removes ANSI escape codes, leading asterisks, non-printable characters, and replaces all occurrences of \t and \n.
+     * It also replaces all occurrences of \" with " and angle-brackets with &lt; and &gt;.
+     * The function sends the message to all connected clients.
+     */
+    wssSendMessage(level: string, time: string, name: string, message: string): void;
+    /**
+     * Sends a need to refresh WebSocket message to all connected clients.
+     *
+     * @param {string} changed - The changed value. If null, the whole page will be refreshed.
+     * possible values:
+     * - 'matterbridgeLatestVersion'
+     * - 'matterbridgeAdvertise'
+     * - 'online'
+     * - 'offline'
+     * - 'reachability'
+     * - 'settings'
+     * - 'plugins'
+     * - 'pluginsRestart'
+     * - 'devices'
+     * - 'fabrics'
+     * - 'sessions'
+     */
+    wssSendRefreshRequired(changed?: string | null): void;
+    /**
+     * Sends a need to restart WebSocket message to all connected clients.
+     *
+     */
+    wssSendRestartRequired(snackbar?: boolean): void;
+    /**
+     * Sends a need to update WebSocket message to all connected clients.
+     *
+     */
+    wssSendUpdateRequired(): void;
+    /**
+     * Sends a cpu update message to all connected clients.
+     *
+     */
+    wssSendCpuUpdate(cpuUsage: number): void;
+    /**
+     * Sends a memory update message to all connected clients.
+     *
+     */
+    wssSendMemoryUpdate(totalMemory: string, freeMemory: string, rss: string, heapTotal: string, heapUsed: string, external: string, arrayBuffers: string): void;
+    /**
+     * Sends an uptime update message to all connected clients.
+     *
+     */
+    wssSendUptimeUpdate(systemUptime: string, processUptime: string): void;
+    /**
+     * Sends an open snackbar message to all connected clients.
+     * @param {string} message - The message to send.
+     * @param {number} timeout - The timeout in seconds for the snackbar message.
+     * @param {'info' | 'warning' | 'error' | 'success'} severity - The severity of the snackbar message (default info).
+     *
+     */
+    wssSendSnackbarMessage(message: string, timeout?: number, severity?: 'info' | 'warning' | 'error' | 'success'): void;
+    /**
+     * Sends a close snackbar message to all connected clients.
+     * @param {string} message - The message to send.
+     *
+     */
+    wssSendCloseSnackbarMessage(message: string): void;
+    /**
+     * Sends an attribute update message to all connected WebSocket clients.
+     *
+     * @param {string | undefined} plugin - The name of the plugin.
+     * @param {string | undefined} serialNumber - The serial number of the device.
+     * @param {string | undefined} uniqueId - The unique identifier of the device.
+     * @param {string} cluster - The cluster name where the attribute belongs.
+     * @param {string} attribute - The name of the attribute that changed.
+     * @param {number | string | boolean} value - The new value of the attribute.
+     *
+     * @remarks
+     * This method logs a debug message and sends a JSON-formatted message to all connected WebSocket clients
+     * with the updated attribute information.
+     */
+    wssSendAttributeChangedMessage(plugin: string | undefined, serialNumber: string | undefined, uniqueId: string | undefined, cluster: string, attribute: string, value: number | string | boolean): void;
+    /**
+     * Sends a message to all connected clients.
+     * @param {number} id - The message id.
+     * @param {string} method - The message method.
+     * @param {Record<string, string | number | boolean>} params - The message parameters.
+     *
+     */
+    wssBroadcastMessage(id: number, method?: string, params?: Record<string, string | number | boolean>): void;
+}
+//# sourceMappingURL=frontend.d.ts.map

package/dist/frontend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frontend.d.ts","sourceRoot":"","sources":["../src/frontend.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAmBH,OAAO,EAAc,QAAQ,EAA6G,MAAM,oBAAoB,CAAC;AAKrK,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAOjD;;;GAGG;AACH,eAAO,MAAM,SAAS,IAAI,CAAC;AAE3B;;;GAGG;AACH,eAAO,MAAM,oBAAoB,IAAI,CAAC;AAEtC;;;GAGG;AACH,eAAO,MAAM,oBAAoB,IAAI,CAAC;AAEtC;;;GAGG;AACH,eAAO,MAAM,gBAAgB,IAAI,CAAC;AAElC;;;GAGG;AACH,eAAO,MAAM,mBAAmB,IAAI,CAAC;AAErC;;;GAGG;AACH,eAAO,MAAM,mBAAmB,IAAI,CAAC;AAErC;;;GAGG;AACH,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC;;;GAGG;AACH,eAAO,MAAM,mBAAmB,IAAI,CAAC;AAErC;;;GAGG;AACH,eAAO,MAAM,iBAAiB,IAAI,CAAC;AAEnC;;;GAGG;AACH,eAAO,MAAM,oBAAoB,IAAI,CAAC;AAEtC;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,MAAM,CAAC;AAE3C;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAE5C,qBAAa,QAAQ;IACnB,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,GAAG,CAAa;IACxB,OAAO,CAAC,IAAI,CAAQ;IACpB,OAAO,CAAC,eAAe,CAAS;IAEhC,OAAO,CAAC,UAAU,CAA8B;IAChD,OAAO,CAAC,UAAU,CAAyB;IAC3C,OAAO,CAAC,WAAW,CAA2B;IAC9C,OAAO,CAAC,eAAe,CAA8B;gBAEzC,YAAY,EAAE,YAAY;IAKtC,IAAI,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAE9B;IAEK,KAAK,CAAC,IAAI,SAAO;IA8fjB,IAAI;IAiFV,OAAO,CAAC,iBAAiB,CAQvB;IAGF,OAAO,CAAC,cAAc,CAcpB;IAEF;;;;OAIG;YACW,cAAc;IAoC5B;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAQvB;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAwBtB;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;IAkHhC;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IAuChC;;;;OAIG;YACW,UAAU;IAyBxB;;;;;;;;OAQG;IACH,OAAO,CAAC,WAAW;IA2EnB;;;;;;OAMG;YACW,gBAAgB;IAynB9B;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAyCzE;;;;;;;;;;;;;;;;OAgBG;IACH,sBAAsB,CAAC,OAAO,GAAE,MAAM,GAAG,IAAW;IAUpD;;;OAGG;IACH,sBAAsB,CAAC,QAAQ,UAAO;IAYtC;;;OAGG;IACH,qBAAqB;IAWrB;;;OAGG;IACH,gBAAgB,CAAC,QAAQ,EAAE,MAAM;IAUjC;;;OAGG;IACH,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAUrJ;;;OAGG;IACH,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IAU/D;;;;;;OAMG;IACH,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,SAAI,EAAE,QAAQ,GAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAkB;IAUhH;;;;OAIG;IACH,2BAA2B,CAAC,OAAO,EAAE,MAAM;IAU3C;;;;;;;;;;;;;OAaG;IACH,8BAA8B,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,YAAY,EAAE,MAAM,GAAG,SAAS,EAAE,QAAQ,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO;IAU/L;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CASpG"}