matterbridge 1.5.9 → 1.6.0

package/CHANGELOG.md

@@ -7,7 +7,8 @@ If you like this project and find it useful, please consider giving it a star on
 ### Home Assistant Community Add-ons
 
 The Home Assistant Community Add-ons and plugins are not verified to work with Matterbridge. I strongly advise against using them. If you do use them and encounter an issue (which is likely because some do not meet the Matterbridge guidelines), please do not open an issue in the Matterbridge repository.
-If you want to run Matterbridge in Home Assistant please use the official add-on https://github.com/Luligu/matterbridge-home-assistant-addon.
+
+If you want to run Matterbridge in Home Assistant please use the official add-on https://github.com/Luligu/matterbridge-home-assistant-addon that also has Ingress and side panel.
 
 ### New Apple firmware v. 18.0
 
@@ -15,9 +16,41 @@ Please read this: https://github.com/Luligu/matterbridge/discussions/135
 
 ### Discord
 
-Tamer (https://github.com/tammeryousef1006) has created the Matterbridge Discord group: https://discord.gg/raWywpD4.
+Tamer (https://github.com/tammeryousef1006) has created the Matterbridge Discord group: https://discord.gg/QX58CDe6hd.
+
+Feel free to join (the link is now permanent)!
+
+## [1.6.0] - 2024-10-28
+
+### Added
+
+- [matterbridge]: Added WebSocket for the Matetrbridge cockpit dashboard (Shelly gateway).
+
+### Changed
+
+- [discord]: Discord group link: https://discord.gg/QX58CDe6hd.
+- [matterbridge]: Completed phase 1 of transition to edge (matter.js new API).
+- [matterbridgeDevice]: Refactor Thermostat cluster method to accept minHeatSetpointLimit, maxHeatSetpointLimit, minCoolSetpointLimit and maxCoolSetpointLimit.
+- [config]: The plugins config is rewritten only after onStart and no more after onConfigure (after the plugin starts is possible to change the plugins config and it will not be rewritten after the plugin configuration).
+- [matterbridgeDevice]: Removed deprecated methods of ColorControl cluster.
+- [package]: Removed EveHistory (it will be used only by single plugins).
+- [package]: Update dependencies.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
+</a>
+
+## [1.5.10] - 2024-10-01
+
+### Changed
 
-Feel free to join!
+- [matterbridge]: Added '--omit=dev' to all install commands to save space and time on low powered devices.
+- [matterbridge]: Integrated the DeviceManager class and removed the old array.
+- [package]: Update dependencies.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
+</a>
 
 ## [1.5.9] - 2024-09-23
 

package/README-DEV.md

@@ -43,23 +43,27 @@ Matterbridge exports from:
 
 - NodeStorage classes.
 
-# ****\*\*****
+# \***\*\*\*\*\***
 
-A plugin must never install or import from `matter-node.js` or `matter.js` directly, as this leads to a second instance of `matter.js`, causing instability and unpredictable errors such as "The only instance is Endpoint". Additionally, when Matterbridge updates the `matter.js` version, it should be consistent across all plugins.
+A plugin must never install or import from `matter-node.js` or `matter.js` directly (neither as a dependency, devDependency, nor peerDependency), as this leads to a second instance of `matter.js`, causing instability and unpredictable errors such as "The only instance is Endpoint".
 
-# ****\*\*****
+Additionally, when Matterbridge updates the `matter.js` version, it should be consistent across all plugins.
 
-A plugin must never install Matterbridge (neither as dependencies nor as devDependencies). Matterbridge must be linked to the plugin:
+# \***\*\*\*\*\***
+
+A plugin must never install Matterbridge (neither as a dependency, devDependency, nor peerDependency).
+
+Matterbridge must be linked to the plugin in development only.
 
 ```json
 "scripts": {
     '''
-    "install": "node link-matterbridge-script.js",
+    "dev:link": "npm link matterbridge",
     '''
 }
 ```
 
-# ****\*\*****
+# \***\*\*\*\*\***
 
 In the next releases I will remove the duplicated exports so please update your plugins.
 

package/README-PODMAN.md

@@ -41,6 +41,7 @@ sudo chown -R $USER:$USER ./Matterbridge ./.matterbridge
 ```
 
 You may need to adapt the script to your setup:
+
 - ./Matterbridge is the position outside of the container of your matterbridge plugin directory (inside your home directory).
 - ./.matterbridge is the position outside of the container of your matterbridge storage directory (inside your home directory).
 
@@ -56,6 +57,7 @@ podman run --name matterbridge \
 ```
 
 You may need to adapt the script to your setup:
+
 - ~/Matterbridge is the position outside of the container of your matterbridge plugin directory.
 - ~/.matterbridge is the position outside of the container of your matterbridge storage directory.
 

package/README-SERVICE.md

@@ -100,53 +100,91 @@ sudo systemctl disable matterbridge.service
 ### View the log of Matterbridge in real time (this will show the log with colors)
 
 ```
-sudo journalctl -u matterbridge.service -f --output cat
+sudo journalctl -u matterbridge.service -n 1000 -f --output cat
 ```
 
 ### Delete the logs older then 3 days (all of them not only the ones of Matterbridge!)
 
+Check the space used
+
+```
+sudo journalctl --disk-usage
+```
+
+remove all log older then 3 days
+
 ```
+sudo journalctl --rotate
 sudo journalctl --vacuum-time=3d
 ```
 
-If you want to make the setting permanent edit
+## Prevent the journal logs to grow
+
+If you want to make the setting permanent to prevent the journal logs to grow too much, run
+
 ```
 sudo nano /etc/systemd/journald.conf
 ```
+
 add
+
 ```
-SystemMaxUse=3d
+Compress=yes            # Compress logs
+MaxRetentionSec=3days   # Keep logs for a maximum of 3 days.
+MaxFileSec=1day         # Rotate logs daily within the 3-day retention period.
+ForwardToSyslog=no      # Disable forwarding to syslog to prevent duplicate logging.
+SystemMaxUse=100M       # Limit persistent logs in /var/log/journal to 100 MB.
+RuntimeMaxUse=100M      # Limit runtime logs in /run/log/journal to 100 MB.
 ```
+
 save it and run
+
 ```
 sudo systemctl restart systemd-journald
 ```
 
-### Verify that with your distro you can run sudo npm install -g matterbridge without the password
+## Verify that with your distro you can run sudo npm install -g matterbridge without the password
 
 Run the following command to verify if you can install Matterbridge globally without being prompted for a password:
 
 ```
 sudo npm install -g matterbridge
 ```
+
 If you are not prompted for a password, no further action is required.
 
 If that is not the case, open the sudoers file for editing using visudo
+
 ```
 sudo visudo
 ```
 
+verify the presence of of a line
+
+```
+@includedir /etc/sudoers.d
+```
+
+exit and create a configuration file for sudoers
+
+```
+sudo nano  /etc/sudoers.d/matterbridge
+```
+
 add this line replacing USER with your user name (e.g. radxa ALL=(ALL) NOPASSWD: ALL)
 
 ```
 <USER> ALL=(ALL) NOPASSWD: ALL
 ```
 
-or if you prefers to only give access to npm without password try (e.g. radxa ALL=(ALL) NOPASSWD: /usr/bin/npm)
+or if you prefers to only give access to npm without password try with (e.g. radxa ALL=(ALL) NOPASSWD: /usr/bin/npm)
 
 ```
 <USER> ALL=(ALL) NOPASSWD: /usr/bin/npm
 ```
 
-save the file and restart the system.
+save the file and reload the settings with:
 
+```
+sudo visudo -c
+```

package/README.md

@@ -51,13 +51,13 @@ To run Matterbridge, you need either a [Node.js](https://nodejs.org/en/download/
 Follow these steps to install Matterbridge:
 
 ```
-npm install -g matterbridge
+npm install -g matterbridge --omit=dev
 ```
 
 on Linux you may need the necessary permissions:
 
 ```
-sudo npm install -g matterbridge
+sudo npm install -g matterbridge --omit=dev
 ```
 
 Test the installation with:
@@ -68,7 +68,7 @@ matterbridge
 
 Now it is possible to open the frontend at the link provided in the log (e.g. http://MATTERBIDGE-IPV4-ADDRESS:8283).
 
-You can then change the bridge mode from the frontend.
+You can then change the bridge mode and other parameters from the frontend.
 
 ## Usage
 
@@ -128,19 +128,19 @@ Config editor:
 
 ### Run matterbridge as a daemon with systemctl (Linux only)
 
-[Advanced configurations](https://github.com/Luligu/matterbridge/blob/main/README-SERVICE.md)
+[Service configurations](https://github.com/Luligu/matterbridge/blob/main/README-SERVICE.md)
 
 ### Run matterbridge with docker and docker compose
 
-[Advanced configurations](https://github.com/Luligu/matterbridge/blob/main/README-DOCKER.md)
+[Docker configurations](https://github.com/Luligu/matterbridge/blob/main/README-DOCKER.md)
 
 ### Run matterbridge with podman
 
-[Advanced configurations](https://github.com/Luligu/matterbridge/blob/main/README-PODMAN.md)
+[Podman configurations](https://github.com/Luligu/matterbridge/blob/main/README-PODMAN.md)
 
 ### Run matterbridge as an home assistant add-on with the official add-on
 
-[Advanced configurations](https://github.com/Luligu/matterbridge-home-assistant-addon)
+[Home assistant add-on configurations](https://github.com/Luligu/matterbridge-home-assistant-addon)
 
 ### Other Home Assistant Community Add-ons
 
@@ -320,6 +320,52 @@ matterbridge -factoryreset
 
 This will reset the internal storages. All commissioning informations will be lost. All plugins will be unregistered.
 
+# Frequently asked questions
+
+## How to enable HTTPS for the frontend
+
+### Provide your own certificates
+
+Place your own certificates in the `.matterbridge/cert` directory:
+
+- `cert.pem`
+- `key.pem`
+- `ca.pem` (optional)
+
+![image](https://github.com/user-attachments/assets/846785ca-6f5c-458b-b786-a6417a4da319)
+
+### Change the command line
+
+Add the **-ssl** parameter to the command line. If desired, you can also change the frontend port with **-frontend 443**.
+
+```sh
+matterbridge -ssl -frontend 443
+```
+
+### Restart
+
+If the certificate are correctly configured, you will be able to connect with https to the frontend.
+
+![image](https://github.com/user-attachments/assets/9c38776d-064f-4d91-9359-a2cd3319b1ff)
+
+## How to send the debug log files
+
+### Enable debug and log on file
+
+In the frontend, go to settings and enable debug mode as shown below:
+
+![Debug Matterbridge Settings](https://github.com/user-attachments/assets/83181dc2-969a-4b71-aff4-f1498fa1d665)
+
+![Debug Matter Settings](https://github.com/user-attachments/assets/617961a9-7cb0-46cf-9878-981f61738f8c)
+
+### Restart
+
+Wait a few minutes to allow the logs to to accumulate.
+
+Then, from the dots menu in the frontend, download the `matterbridge.log` and `matter.log` files.
+
+![image](https://github.com/user-attachments/assets/04ba65f6-594a-4ff8-9732-3df049f5a33e)
+
 # Known general issues
 
 ## Session XYZ does not exist

package/dist/cluster/export.js

@@ -1,3 +1,3 @@
 export {};
-// Nothing to export
+// Nothing to export right now
 //# sourceMappingURL=export.js.map

package/dist/cluster/export.js.map

@@ -1 +1 @@
-{"version":3,"file":"export.js","sourceRoot":"","sources":["../../src/cluster/export.ts"],"names":[],"mappings":";AAAA,oBAAoB"}
+{"version":3,"file":"export.js","sourceRoot":"","sources":["../../src/cluster/export.ts"],"names":[],"mappings":";AAAA,8BAA8B"}

package/dist/defaultConfigSchema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"defaultConfigSchema.d.ts","sourceRoot":"","sources":["../src/defaultConfigSchema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,eAAO,MAAM,kBAAkB,EAAE,cAiBhC,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,cAWhC,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,cAwB3B,CAAC"}
+{"version":3,"file":"defaultConfigSchema.d.ts","sourceRoot":"","sources":["../src/defaultConfigSchema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,eAAO,MAAM,kBAAkB,EAAE,cAiBhC,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,cAWhC,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,cAgC3B,CAAC"}

package/dist/defaultConfigSchema.js

@@ -56,11 +56,19 @@ export const shelly_config = {
     username: '',
     password: '',
     exposeSwitch: 'switch',
+    switchList: [],
+    lightList: [],
+    outletList: [],
     exposeInput: 'momentary',
+    inputContactList: [],
+    inputMomentaryList: [],
+    inputLatchingList: [],
     exposeInputEvent: 'momentary',
-    exposePowerMeter: 'disabled',
+    inputEventList: [],
+    exposePowerMeter: 'matter13',
     blackList: [],
     whiteList: [],
+    nocacheList: [],
     deviceIp: {},
     enableMdnsDiscover: true,
     enableStorageDiscover: true,

package/dist/defaultConfigSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"defaultConfigSchema.js","sourceRoot":"","sources":["../src/defaultConfigSchema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAIH,MAAM,CAAC,MAAM,kBAAkB,GAAmB;IAChD,IAAI,EAAE,0BAA0B;IAChC,IAAI,EAAE,iBAAiB;IACvB,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,EAAE;IACZ,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,aAAa;IACpB,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,EAAE;IACb,UAAU,EAAE,EAAE;IACd,SAAS,EAAE,EAAE;IACb,UAAU,EAAE,EAAE;IACd,gBAAgB,EAAE,EAAE;IACpB,sBAAsB,EAAE,EAAE;IAC1B,KAAK,EAAE,KAAK;IACZ,oBAAoB,EAAE,KAAK;CAC5B,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAmB;IAChD,IAAI,EAAE,2BAA2B;IACjC,IAAI,EAAE,iBAAiB;IACvB,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE,cAAc;IACvB,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,EAAE;IACb,gBAAgB,EAAE,EAAE;IACpB,KAAK,EAAE,KAAK;IACZ,oBAAoB,EAAE,KAAK;CAC5B,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAmB;IAC3C,IAAI,EAAE,qBAAqB;IAC3B,IAAI,EAAE,iBAAiB;IACvB,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,EAAE;IACZ,YAAY,EAAE,QAAQ;IACtB,WAAW,EAAE,WAAW;IACxB,gBAAgB,EAAE,WAAW;IAC7B,gBAAgB,EAAE,UAAU;IAC5B,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,EAAE;IACb,QAAQ,EAAE,EAAE;IACZ,kBAAkB,EAAE,IAAI;IACxB,qBAAqB,EAAE,IAAI;IAC3B,oBAAoB,EAAE,KAAK;IAC3B,oBAAoB,EAAE,KAAK;IAC3B,iBAAiB,EAAE,IAAI;IACvB,aAAa,EAAE,CAAC;IAChB,OAAO,EAAE,EAAE;IACX,KAAK,EAAE,KAAK;IACZ,SAAS,EAAE,KAAK;IAChB,SAAS,EAAE,KAAK;IAChB,OAAO,EAAE,KAAK;IACd,oBAAoB,EAAE,KAAK;CAC5B,CAAC"}
+{"version":3,"file":"defaultConfigSchema.js","sourceRoot":"","sources":["../src/defaultConfigSchema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAIH,MAAM,CAAC,MAAM,kBAAkB,GAAmB;IAChD,IAAI,EAAE,0BAA0B;IAChC,IAAI,EAAE,iBAAiB;IACvB,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,EAAE;IACZ,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,aAAa;IACpB,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,EAAE;IACb,UAAU,EAAE,EAAE;IACd,SAAS,EAAE,EAAE;IACb,UAAU,EAAE,EAAE;IACd,gBAAgB,EAAE,EAAE;IACpB,sBAAsB,EAAE,EAAE;IAC1B,KAAK,EAAE,KAAK;IACZ,oBAAoB,EAAE,KAAK;CAC5B,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAmB;IAChD,IAAI,EAAE,2BAA2B;IACjC,IAAI,EAAE,iBAAiB;IACvB,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE,cAAc;IACvB,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,EAAE;IACb,gBAAgB,EAAE,EAAE;IACpB,KAAK,EAAE,KAAK;IACZ,oBAAoB,EAAE,KAAK;CAC5B,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAmB;IAC3C,IAAI,EAAE,qBAAqB;IAC3B,IAAI,EAAE,iBAAiB;IACvB,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,EAAE;IACZ,YAAY,EAAE,QAAQ;IACtB,UAAU,EAAE,EAAE;IACd,SAAS,EAAE,EAAE;IACb,UAAU,EAAE,EAAE;IACd,WAAW,EAAE,WAAW;IACxB,gBAAgB,EAAE,EAAE;IACpB,kBAAkB,EAAE,EAAE;IACtB,iBAAiB,EAAE,EAAE;IACrB,gBAAgB,EAAE,WAAW;IAC7B,cAAc,EAAE,EAAE;IAClB,gBAAgB,EAAE,UAAU;IAC5B,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,EAAE;IACb,WAAW,EAAE,EAAE;IACf,QAAQ,EAAE,EAAE;IACZ,kBAAkB,EAAE,IAAI;IACxB,qBAAqB,EAAE,IAAI;IAC3B,oBAAoB,EAAE,KAAK;IAC3B,oBAAoB,EAAE,KAAK;IAC3B,iBAAiB,EAAE,IAAI;IACvB,aAAa,EAAE,CAAC;IAChB,OAAO,EAAE,EAAE;IACX,KAAK,EAAE,KAAK;IACZ,SAAS,EAAE,KAAK;IAChB,SAAS,EAAE,KAAK;IAChB,OAAO,EAAE,KAAK;IACd,oBAAoB,EAAE,KAAK;CAC5B,CAAC"}

package/dist/matterbridge.d.ts

@@ -21,9 +21,17 @@
  * limitations under the License. *
  */
 import EventEmitter from 'events';
+import WebSocket from 'ws';
+import { NodeStorageManager, NodeStorage } from 'node-persist-manager';
 import { AnsiLogger } from 'node-ansi-logger';
 import { MatterbridgeDevice } from './matterbridgeDevice.js';
-import { MatterbridgeInformation, SanitizedExposedFabricInformation, SanitizedSessionInformation, SystemInformation } from './matterbridgeTypes.js';
+import { BaseRegisteredPlugin, MatterbridgeInformation, SanitizedExposedFabricInformation, SanitizedSessionInformation, SystemInformation } from './matterbridgeTypes.js';
+import { PluginManager } from './pluginManager.js';
+import { DeviceManager } from './deviceManager.js';
+import { CommissioningController, CommissioningServer, MatterServer } from '@project-chip/matter-node.js';
+import { DeviceTypeId } from '@project-chip/matter-node.js/datatype';
+import { Aggregator } from '@project-chip/matter-node.js/device';
+import { StorageContext, StorageManager } from '@project-chip/matter-node.js/storage';
 /**
  * Represents the Matterbridge application.
  */
@@ -47,21 +55,18 @@ export declare class Matterbridge extends EventEmitter {
     restartMode: 'service' | 'docker' | '';
     profile: string | undefined;
     log: AnsiLogger;
-    private matterbrideLoggerFile;
-    private matterLoggerFile;
-    private plugins;
-    private devices;
-    private registeredDevices;
-    private nodeStorage;
-    private nodeContext;
-    private matterStorageName;
-    private nodeStorageName;
+    protected matterbrideLoggerFile: string;
+    protected matterLoggerFile: string;
+    protected plugins: PluginManager;
+    protected devices: DeviceManager;
+    protected nodeStorage: NodeStorageManager | undefined;
+    protected nodeContext: NodeStorage | undefined;
+    protected matterStorageName: string;
+    protected nodeStorageName: string;
     private hasCleanupStarted;
     private initialized;
     private execRunningCount;
     private startMatterInterval;
-    private cleanupTimeout1;
-    private cleanupTimeout2;
     private checkUpdateInterval;
     private configureTimeout;
     private reachabilityTimeout;
@@ -71,21 +76,22 @@ export declare class Matterbridge extends EventEmitter {
     private httpServer;
     private httpsServer;
     private webSocketServer;
-    private mdnsInterface;
-    private ipv4address;
-    private ipv6address;
-    private port;
-    private passcode?;
-    private discriminator?;
-    private storageManager;
-    private matterbridgeContext;
-    private mattercontrollerContext;
-    private matterServer;
-    private matterAggregator;
-    private commissioningServer;
-    private commissioningController;
-    private static instance;
-    private constructor();
+    protected mdnsInterface: string | undefined;
+    protected ipv4address: string | undefined;
+    protected ipv6address: string | undefined;
+    protected port: number;
+    protected passcode?: number;
+    protected discriminator?: number;
+    protected storageManager: StorageManager | undefined;
+    protected matterbridgeContext: StorageContext | undefined;
+    protected mattercontrollerContext: StorageContext | undefined;
+    protected matterServer: MatterServer | undefined;
+    protected matterAggregator: Aggregator | undefined;
+    protected commissioningServer: CommissioningServer | undefined;
+    protected commissioningController: CommissioningController | undefined;
+    protected static instance: Matterbridge | undefined;
+    protected constructor();
+    matterbridgeMessageHandler: (client: WebSocket, message: WebSocket.RawData) => Promise<void>;
     /** ***********************************************************************************************************************************/
     /**                                              loadInstance() and cleanup() methods                                                 */
     /** ***********************************************************************************************************************************/
@@ -120,6 +126,15 @@ export declare class Matterbridge extends EventEmitter {
      * @returns {Promise<void>} A promise that resolves when the command line arguments have been processed, or the process exits.
      */
     private parseCommandLine;
+    /**
+     * Asynchronously loads and starts the registered plugins.
+     *
+     * This method is responsible for initializing and staarting all enabled plugins.
+     * It ensures that each plugin is properly loaded and started before the ridge starts.
+     *
+     * @returns {Promise<void>} A promise that resolves when all plugins have been loaded and started.
+     */
+    private startPlugins;
     /**
      * Registers the signal handlers for SIGINT and SIGTERM.
      * When either of these signals are received, the cleanup method is called with an appropriate message.
@@ -205,7 +220,7 @@ export declare class Matterbridge extends EventEmitter {
      * @param restart - Indicates whether to restart the instance after cleanup. Default is `false`.
      * @returns A promise that resolves when the cleanup is completed.
      */
-    private cleanup;
+    protected cleanup(message: string, restart?: boolean): Promise<void>;
     /**
      * Adds a bridged device to the Matterbridge.
      * @param pluginName - The name of the plugin.
@@ -227,25 +242,24 @@ export declare class Matterbridge extends EventEmitter {
      * @returns A promise that resolves when all devices have been removed.
      */
     removeAllBridgedDevices(pluginName: string): Promise<void>;
-    private startTest;
     /**
      * Starts the Matterbridge in bridge mode.
      * @private
      * @returns {Promise<void>} A promise that resolves when the Matterbridge is started.
      */
-    private startBridge;
+    protected startBridge(): Promise<void>;
     /**
      * Starts the Matterbridge in childbridge mode.
      * @private
      * @returns {Promise<void>} A promise that resolves when the Matterbridge is started.
      */
-    private startChildbridge;
+    protected startChildbridge(): Promise<void>;
     /**
      * Starts the Matterbridge controller.
      * @private
      * @returns {Promise<void>} A promise that resolves when the Matterbridge is started.
      */
-    private startController;
+    protected startController(): Promise<void>;
     /** ***********************************************************************************************************************************/
     /**                                                     Matter.js methods                                                             */
     /** ***********************************************************************************************************************************/
@@ -255,40 +269,40 @@ export declare class Matterbridge extends EventEmitter {
      * @param {string} storageName - The name of the storage file.
      * @returns {Promise<void>} - A promise that resolves when the storage process is started.
      */
-    private startMatterStorage;
+    protected startMatterStorage(storageType: string, storageName: string): Promise<void>;
     /**
      * Makes a backup copy of the specified matter JSON storage file.
      *
      * @param storageName - The name of the JSON storage file to be backed up.
      * @param backupName - The name of the backup file to be created.
      */
-    private backupJsonMatterStorage;
+    protected backupMatterStorage(storageName: string, backupName: string): Promise<void>;
     /**
      * Stops the matter storage.
      * @returns {Promise<void>} A promise that resolves when the storage is stopped.
      */
-    private stopMatterStorage;
+    protected stopMatterStorage(): Promise<void>;
     /**
      * Creates a Matter server using the provided storage manager and the provided mdnsInterface.
      * @param storageManager The storage manager to be used by the Matter server.
      *
      */
-    private createMatterServer;
+    protected createMatterServer(storageManager: StorageManager): MatterServer;
     /**
      * Starts the Matter server.
      * If the Matter server is not initialized, it logs an error and performs cleanup.
      */
-    private startMatterServer;
+    protected startMatterServer(): Promise<void>;
     /**
      * Stops the Matter server, commissioningServer and commissioningController.
      */
-    private stopMatterServer;
+    protected stopMatterServer(): Promise<void>;
     /**
      * Creates a Matter Aggregator.
      * @param {StorageContext} context - The storage context.
      * @returns {Aggregator} - The created Matter Aggregator.
      */
-    private createMatterAggregator;
+    protected createMatterAggregator(context: StorageContext, pluginName: string): Promise<Aggregator>;
     /**
      * Creates a matter commissioning server.
      *
@@ -296,7 +310,7 @@ export declare class Matterbridge extends EventEmitter {
      * @param {string} pluginName - The name of the commissioning server.
      * @returns {CommissioningServer} The created commissioning server.
      */
-    private createCommisioningServer;
+    protected createCommisioningServer(context: StorageContext, pluginName: string): Promise<CommissioningServer>;
     /**
      * Creates a commissioning server storage context.
      *
@@ -315,7 +329,7 @@ export declare class Matterbridge extends EventEmitter {
      * @param hardwareVersionString - The hardware version string of the device (optional).
      * @returns The storage context for the commissioning server.
      */
-    private createCommissioningServerContext;
+    protected createCommissioningServerContext(pluginName: string, deviceName: string, deviceType: DeviceTypeId, vendorId: number, vendorName: string, productId: number, productName: string): Promise<StorageContext>;
     /**
      * Imports the commissioning server context for a specific plugin and device.
      * @param pluginName - The name of the plugin.
@@ -323,7 +337,7 @@ export declare class Matterbridge extends EventEmitter {
      * @returns The commissioning server context.
      * @throws Error if the BasicInformationCluster is not found.
      */
-    private importCommissioningServerContext;
+    protected importCommissioningServerContext(pluginName: string, device: MatterbridgeDevice): Promise<StorageContext>;
     /**
      * Shows the commissioning server QR code for a given plugin.
      * @param {CommissioningServer} commissioningServer - The commissioning server instance.
@@ -332,7 +346,7 @@ export declare class Matterbridge extends EventEmitter {
      * @param {string} pluginName - The name of the plugin of Matterbridge in bridge mode.
      * @returns {Promise<void>} - A promise that resolves when the QR code is shown.
      */
-    private showCommissioningQRCode;
+    protected showCommissioningQRCode(commissioningServer: CommissioningServer | undefined, storageContext: StorageContext | undefined, nodeContext: NodeStorage | undefined, pluginName: string): Promise<void>;
     /**
      * Sanitizes the fabric information by converting bigint properties to string cause res.json doesn't know bigint.
      *
@@ -353,26 +367,26 @@ export declare class Matterbridge extends EventEmitter {
      * @param {CommissioningServer} commissioningServer - The commissioning server to set the reachability for.
      * @param {boolean} reachable - The new reachability status.
      */
-    private setCommissioningServerReachability;
+    protected setCommissioningServerReachability(commissioningServer: CommissioningServer, reachable: boolean): void;
     /**
      * Sets the reachability of the specified matter aggregator and its bridged devices and trigger.
      * @param {Aggregator} matterAggregator - The matter aggregator to set the reachability for.
      * @param {boolean} reachable - A boolean indicating the reachability status to set.
      */
-    private setAggregatorReachability;
+    protected setAggregatorReachability(matterAggregator: Aggregator, reachable: boolean): void;
     /**
      * Sets the reachability of a device and trigger.
      *
      * @param {MatterbridgeDevice} device - The device to set the reachability for.
      * @param {boolean} reachable - The new reachability status of the device.
      */
-    private setDeviceReachability;
+    protected setDeviceReachability(device: MatterbridgeDevice, reachable: boolean): void;
     private getVendorIdName;
     /**
      * Retrieves the base registered plugins sanitized for res.json().
      * @returns {BaseRegisteredPlugin[]} A promise that resolves to an array of BaseRegisteredPlugin objects.
      */
-    private getBaseRegisteredPlugins;
+    protected getBaseRegisteredPlugins(): Promise<BaseRegisteredPlugin[]>;
     /**
      * Spawns a child process with the given command and arguments.
      * @param {string} command - The command to execute.
@@ -389,6 +403,16 @@ export declare class Matterbridge extends EventEmitter {
      * @param {string} message - The content of the message.
      */
     private wssSendMessage;
+    /**
+     * Sends a need to refresh WebSocket message to all connected clients.
+     *
+     */
+    private wssSendRefreshRequired;
+    /**
+     * Sends a need to restart WebSocket message to all connected clients.
+     *
+     */
+    private wssSendRestartRequired;
     /**
      * Initializes the frontend of Matterbridge.
      *
@@ -400,7 +424,7 @@ export declare class Matterbridge extends EventEmitter {
      * @param {MatterbridgeDevice} device - The MatterbridgeDevice object.
      * @returns {string} The attributes description of the cluster servers in the device.
      */
-    private getClusterTextFromDevice;
+    protected getClusterTextFromDevice(device: MatterbridgeDevice): string;
     /**
      * Initializes the Matterbridge instance as extension for zigbee2mqtt.
      * @deprecated This method is deprecated and will be removed in a future version.