matterbridge 1.5.10 → 1.6.0

package/dist/matterbridge.js

@@ -50,6 +50,7 @@ import { StorageBackendDisk, StorageBackendJsonFile, StorageManager } from '@pro
 import { getParameter, getIntParameter, hasParameter } from '@project-chip/matter-node.js/util';
 import { CryptoNode } from '@project-chip/matter-node.js/crypto';
 import { Specification } from '@project-chip/matter-node.js/model';
+import { WS_ID_LOG, WS_ID_REFRESH_NEEDED, WS_ID_RESTART_NEEDED, wsMessageHandler } from './matterbridgeWebsocket.js';
 // Default colors
 const plg = '\u001B[38;5;33m';
 const dev = '\u001B[38;5;79m';
@@ -130,8 +131,6 @@ export class Matterbridge extends EventEmitter {
     initialized = false;
     execRunningCount = 0;
     startMatterInterval;
-    cleanupTimeout1;
-    cleanupTimeout2;
     checkUpdateInterval;
     configureTimeout;
     reachabilityTimeout;
@@ -160,7 +159,10 @@ export class Matterbridge extends EventEmitter {
     // We load asyncronously so is private
     constructor() {
         super();
+        // Bind the handler to the instance
+        this.matterbridgeMessageHandler = wsMessageHandler.bind(this);
     }
+    matterbridgeMessageHandler;
     /** ***********************************************************************************************************************************/
     /**                                              loadInstance() and cleanup() methods                                                 */
     /** ***********************************************************************************************************************************/
@@ -521,8 +523,6 @@ export class Matterbridge extends EventEmitter {
         }
         // Start the matter storage and create the matterbridge context
         await this.startMatterStorage('json', path.join(this.matterbridgeDirectory, this.matterStorageName));
-        this.log.debug(`Creating commissioning server context for ${plg}Matterbridge${db}`);
-        this.matterbridgeContext = await this.createCommissioningServerContext('Matterbridge', 'Matterbridge', DeviceTypes.AGGREGATOR.code, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge aggregator');
         if (hasParameter('reset') && getParameter('reset') === undefined) {
             this.log.info('Resetting Matterbridge commissioning information...');
             await this.matterbridgeContext?.clearAll();
@@ -560,12 +560,13 @@ export class Matterbridge extends EventEmitter {
                 this.getPluginLatestVersion(plugin);
             }
         }, 60 * 60 * 1000);
+        // Start the matterbridge in mode test
         if (hasParameter('test')) {
             this.bridgeMode = 'bridge';
             MatterbridgeDevice.bridgeMode = 'bridge';
-            await this.startTest();
             return;
         }
+        // Start the matterbridge in mode controller
         if (hasParameter('controller')) {
             this.bridgeMode = 'controller';
             await this.startController();
@@ -576,91 +577,63 @@ export class Matterbridge extends EventEmitter {
             this.log.info('Setting default matterbridge start mode to bridge');
             await this.nodeContext?.set('bridgeMode', 'bridge');
         }
+        // Start matterbridge in bridge mode
         if (hasParameter('bridge') || (!hasParameter('childbridge') && (await this.nodeContext?.get('bridgeMode', '')) === 'bridge')) {
             this.bridgeMode = 'bridge';
             MatterbridgeDevice.bridgeMode = 'bridge';
-            if (!this.storageManager)
-                throw new Error('No storage manager initialized');
-            this.log.debug('Starting matterbridge in mode', this.bridgeMode);
-            this.matterServer = this.createMatterServer(this.storageManager);
-            this.log.debug(`Creating commissioning server for ${plg}Matterbridge${db}`);
-            this.commissioningServer = await this.createCommisioningServer(this.matterbridgeContext, 'Matterbridge');
-            this.log.debug(`Creating matter aggregator for ${plg}Matterbridge${db}`);
-            this.matterAggregator = await this.createMatterAggregator(this.matterbridgeContext, 'Matterbridge');
-            this.log.debug('Adding matterbridge aggregator to commissioning server');
-            this.commissioningServer.addDevice(this.matterAggregator);
-            this.log.debug('Adding matterbridge commissioning server to matter server');
-            await this.matterServer.addCommissioningServer(this.commissioningServer, { uniqueStorageKey: 'Matterbridge' });
-            for (const plugin of this.plugins) {
-                plugin.configJson = await this.plugins.loadConfig(plugin);
-                plugin.schemaJson = await this.plugins.loadSchema(plugin);
-                // Check if the plugin is available
-                if (!(await this.plugins.resolve(plugin.path))) {
-                    this.log.error(`Plugin ${plg}${plugin.name}${er} not found or not validated. Disabling it.`);
-                    plugin.enabled = false;
-                    plugin.error = true;
-                    continue;
-                }
-                // Check if the plugin has a new version
-                this.getPluginLatestVersion(plugin); // No await do it asyncronously
-                if (!plugin.enabled) {
-                    this.log.info(`Plugin ${plg}${plugin.name}${nf} not enabled`);
-                    continue;
-                }
-                plugin.error = false;
-                plugin.locked = false;
-                plugin.loaded = false;
-                plugin.started = false;
-                plugin.configured = false;
-                plugin.connected = undefined;
-                plugin.registeredDevices = undefined;
-                plugin.addedDevices = undefined;
-                plugin.qrPairingCode = undefined;
-                plugin.manualPairingCode = undefined;
-                this.plugins.load(plugin, true, 'Matterbridge is starting'); // No await do it asyncronously
-            }
+            this.log.debug(`Starting matterbridge in mode ${this.bridgeMode}`);
             await this.startBridge();
             return;
         }
+        // Start matterbridge in childbridge mode
         if (hasParameter('childbridge') || (!hasParameter('bridge') && (await this.nodeContext?.get('bridgeMode', '')) === 'childbridge')) {
             this.bridgeMode = 'childbridge';
             MatterbridgeDevice.bridgeMode = 'childbridge';
-            if (!this.storageManager)
-                throw new Error('No storage manager initialized');
-            this.log.debug('Starting matterbridge in mode', this.bridgeMode);
-            this.matterServer = this.createMatterServer(this.storageManager);
-            for (const plugin of this.plugins) {
-                plugin.configJson = await this.plugins.loadConfig(plugin);
-                plugin.schemaJson = await this.plugins.loadSchema(plugin);
-                // Check if the plugin is available
-                if (!(await this.plugins.resolve(plugin.path))) {
-                    this.log.error(`Plugin ${plg}${plugin.name}${er} not found or not validated. Disabling it.`);
-                    plugin.enabled = false;
-                    plugin.error = true;
-                    continue;
-                }
-                // Check if the plugin has a new version
-                this.getPluginLatestVersion(plugin); // No await do it asyncronously
-                if (!plugin.enabled) {
-                    this.log.info(`Plugin ${plg}${plugin.name}${nf} not enabled`);
-                    continue;
-                }
-                plugin.error = false;
-                plugin.locked = false;
-                plugin.loaded = false;
-                plugin.started = false;
-                plugin.configured = false;
-                plugin.connected = false;
-                plugin.registeredDevices = undefined;
-                plugin.addedDevices = undefined;
-                plugin.qrPairingCode = undefined;
-                plugin.manualPairingCode = undefined;
-                this.plugins.load(plugin, true, 'Matterbridge is starting'); // No await do it asyncronously
-            }
+            this.log.debug(`Starting matterbridge in mode ${this.bridgeMode}`);
             await this.startChildbridge();
             return;
         }
     }
+    /**
+     * 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.
+     */
+    async startPlugins() {
+        // Check, load and start the plugins
+        for (const plugin of this.plugins) {
+            plugin.configJson = await this.plugins.loadConfig(plugin);
+            plugin.schemaJson = await this.plugins.loadSchema(plugin);
+            // Check if the plugin is available
+            if (!(await this.plugins.resolve(plugin.path))) {
+                this.log.error(`Plugin ${plg}${plugin.name}${er} not found or not validated. Disabling it.`);
+                plugin.enabled = false;
+                plugin.error = true;
+                continue;
+            }
+            // Check if the plugin has a new version
+            this.getPluginLatestVersion(plugin); // No await do it asyncronously
+            if (!plugin.enabled) {
+                this.log.info(`Plugin ${plg}${plugin.name}${nf} not enabled`);
+                continue;
+            }
+            plugin.error = false;
+            plugin.locked = false;
+            plugin.loaded = false;
+            plugin.started = false;
+            plugin.configured = false;
+            plugin.connected = undefined;
+            plugin.registeredDevices = undefined;
+            plugin.addedDevices = undefined;
+            plugin.qrPairingCode = undefined;
+            plugin.manualPairingCode = undefined;
+            this.plugins.load(plugin, true, 'Matterbridge is starting'); // No await do it asyncronously
+        }
+        this.wssSendRefreshRequired();
+    }
     /**
      * Registers the signal handlers for SIGINT and SIGTERM.
      * When either of these signals are received, the cleanup method is called with an appropriate message.
@@ -1155,7 +1128,6 @@ export class Matterbridge extends EventEmitter {
                 });
                 this.webSocketServer = undefined;
             }
-            // this.cleanupTimeout1 = setTimeout(async () => {
             // Closing matter
             await this.stopMatterServer();
             // Closing matter storage
@@ -1201,9 +1173,6 @@ export class Matterbridge extends EventEmitter {
             }
             this.plugins.clear();
             this.devices.clear();
-            // this.registeredDevices = [];
-            // this.log.info('Waiting for matter to deliver last messages...');
-            // this.cleanupTimeout2 = setTimeout(async () => {
             if (restart) {
                 if (message === 'updating...') {
                     this.log.info('Cleanup completed. Updating...');
@@ -1238,8 +1207,6 @@ export class Matterbridge extends EventEmitter {
             }
             this.hasCleanupStarted = false;
             this.initialized = false;
-            // }, 2 * 1000);
-            // }, 3 * 1000);
         }
     }
     /**
@@ -1249,17 +1216,17 @@ export class Matterbridge extends EventEmitter {
      * @returns {Promise<void>} - A promise that resolves when the device is added.
      */
     async addBridgedDevice(pluginName, device) {
-        this.log.debug(`Adding bridged device ${dev}${device.deviceName}${db} (${dev}${device.name}${db}) for plugin ${plg}${pluginName}${db}`);
+        this.log.debug(`Adding bridged device ${dev}${device.deviceName}${db} (${zb}${device.name}${db}) for plugin ${plg}${pluginName}${db}`);
         // Check if the plugin is registered
         const plugin = this.plugins.get(pluginName);
         if (!plugin) {
-            this.log.error(`Error adding bridged device ${dev}${device.deviceName}${er} (${dev}${device.name}${er}) plugin ${plg}${pluginName}${er} not found`);
+            this.log.error(`Error adding bridged device ${dev}${device.deviceName}${er} (${zb}${device.name}${er}) plugin ${plg}${pluginName}${er} not found`);
             return;
         }
         // Register and add the device to matterbridge aggregator in bridge mode
         if (this.bridgeMode === 'bridge') {
             if (!this.matterAggregator) {
-                this.log.error(`Adding bridged device ${dev}${device.deviceName}${er} (${dev}${device.name}${er}) for plugin ${plg}${pluginName}${er} error: matterAggregator not found`);
+                this.log.error(`Adding bridged device ${dev}${device.deviceName}${er} (${zb}${device.name}${er}) for plugin ${plg}${pluginName}${er} error: matterAggregator not found`);
                 return;
             }
             this.matterAggregator.addBridgedDevice(device);
@@ -1314,17 +1281,17 @@ export class Matterbridge extends EventEmitter {
      * @returns A Promise that resolves when the device is successfully removed.
      */
     async removeBridgedDevice(pluginName, device) {
-        this.log.debug(`Removing bridged device ${dev}${device.deviceName}${db} (${dev}${device.name}${db}) for plugin ${plg}${pluginName}${db}`);
+        this.log.debug(`Removing bridged device ${dev}${device.deviceName}${db} (${zb}${device.name}${db}) for plugin ${plg}${pluginName}${db}`);
         // Check if the plugin is registered
         const plugin = this.plugins.get(pluginName);
         if (!plugin) {
-            this.log.error(`Error removing bridged device ${dev}${device.deviceName}${er} (${dev}${device.name}${er}) for plugin ${plg}${pluginName}${er}: plugin not found`);
+            this.log.error(`Error removing bridged device ${dev}${device.deviceName}${er} (${zb}${device.name}${er}) for plugin ${plg}${pluginName}${er}: plugin not found`);
             return;
         }
         // Remove the device from matterbridge aggregator in bridge mode
         if (this.bridgeMode === 'bridge') {
             if (!this.matterAggregator) {
-                this.log.error(`Error removing bridged device ${dev}${device.deviceName}${er} (${dev}${device.name}${er}) for plugin ${plg}${pluginName}${er}: matterAggregator not found`);
+                this.log.error(`Error removing bridged device ${dev}${device.deviceName}${er} (${zb}${device.name}${er}) for plugin ${plg}${pluginName}${er}: matterAggregator not found`);
                 return;
             }
             if (device.number !== undefined) {
@@ -1334,7 +1301,7 @@ export class Matterbridge extends EventEmitter {
             // device.getClusterServerById(BridgedDeviceBasicInformation.Cluster.id)?.triggerShutDownEvent({});
             // device.getClusterServerById(BridgedDeviceBasicInformation.Cluster.id)?.triggerLeaveEvent({});
             this.matterAggregator?.removeBridgedDevice(device);
-            this.log.info(`Removed bridged device(${plugin.registeredDevices}/${plugin.addedDevices}) ${dev}${device.deviceName}${nf} (${dev}${device.name}${nf}) for plugin ${plg}${pluginName}${nf}`);
+            this.log.info(`Removed bridged device(${plugin.registeredDevices}/${plugin.addedDevices}) ${dev}${device.deviceName}${nf} (${zb}${device.name}${nf}) for plugin ${plg}${pluginName}${nf}`);
             if (plugin.registeredDevices !== undefined)
                 plugin.registeredDevices--;
             if (plugin.addedDevices !== undefined)
@@ -1344,13 +1311,13 @@ export class Matterbridge extends EventEmitter {
         if (this.bridgeMode === 'childbridge') {
             if (plugin.type === 'AccessoryPlatform') {
                 if (!plugin.commissioningServer) {
-                    this.log.error(`Error removing bridged device ${dev}${device.deviceName}${er} (${dev}${device.name}${er}) for plugin ${plg}${pluginName}${er}: commissioning server not found`);
+                    this.log.error(`Error removing bridged device ${dev}${device.deviceName}${er} (${zb}${device.name}${er}) for plugin ${plg}${pluginName}${er}: commissioning server not found`);
                     return;
                 }
             }
             else if (plugin.type === 'DynamicPlatform') {
                 if (!plugin.aggregator) {
-                    this.log.error(`Error removing bridged device ${dev}${device.deviceName}${er} (${dev}${device.name}${er}) for plugin ${plg}${pluginName}${er}: aggregator not found`);
+                    this.log.error(`Error removing bridged device ${dev}${device.deviceName}${er} (${zb}${device.name}${er}) for plugin ${plg}${pluginName}${er}: aggregator not found`);
                     return;
                 }
                 if (device.number !== undefined) {
@@ -1359,7 +1326,7 @@ export class Matterbridge extends EventEmitter {
                 }
                 plugin.aggregator.removeBridgedDevice(device);
             }
-            this.log.info(`Removed bridged device(${plugin.registeredDevices}/${plugin.addedDevices}) ${dev}${device.deviceName}${nf} (${dev}${device.name}${nf}) for plugin ${plg}${pluginName}${nf}`);
+            this.log.info(`Removed bridged device(${plugin.registeredDevices}/${plugin.addedDevices}) ${dev}${device.deviceName}${nf} (${zb}${device.name}${nf}) for plugin ${plg}${pluginName}${nf}`);
             if (plugin.registeredDevices !== undefined)
                 plugin.registeredDevices--;
             if (plugin.addedDevices !== undefined)
@@ -1388,18 +1355,28 @@ export class Matterbridge extends EventEmitter {
             }
         });
     }
-    async startTest() {
-        // Start the Matterbridge test
-    }
     /**
      * Starts the Matterbridge in bridge mode.
      * @private
      * @returns {Promise<void>} A promise that resolves when the Matterbridge is started.
      */
     async startBridge() {
-        // Plugins are loaded and started by loadPlugin on startup and plugin.loaded and plugin.started are set to true
         // Plugins are configured by a timer when matter server is started and plugin.configured is set to true
-        this.log.debug('Starting startMatterInterval in bridge mode');
+        if (!this.storageManager)
+            throw new Error('No storage manager initialized');
+        if (!this.matterbridgeContext)
+            throw new Error('No storage context initialized');
+        this.matterServer = this.createMatterServer(this.storageManager);
+        this.log.debug(`Creating commissioning server for ${plg}Matterbridge${db}`);
+        this.commissioningServer = await this.createCommisioningServer(this.matterbridgeContext, 'Matterbridge');
+        this.log.debug(`Creating matter aggregator for ${plg}Matterbridge${db}`);
+        this.matterAggregator = await this.createMatterAggregator(this.matterbridgeContext, 'Matterbridge');
+        this.log.debug('Adding matterbridge aggregator to commissioning server');
+        this.commissioningServer.addDevice(this.matterAggregator);
+        this.log.debug('Adding matterbridge commissioning server to matter server');
+        await this.matterServer.addCommissioningServer(this.commissioningServer, { uniqueStorageKey: 'Matterbridge' });
+        await this.startPlugins();
+        this.log.debug('Starting start matter interval in bridge mode');
         let failCount = 0;
         this.startMatterInterval = setInterval(async () => {
             for (const plugin of this.plugins) {
@@ -1428,8 +1405,11 @@ export class Matterbridge extends EventEmitter {
             clearInterval(this.startMatterInterval);
             this.startMatterInterval = undefined;
             this.log.debug('Cleared startMatterInterval interval for Matterbridge');
+            // Start the Matter server
             await this.startMatterServer();
             this.log.notice('Matter server started');
+            // Show the QR code for commissioning or log the already commissioned message
+            await this.showCommissioningQRCode(this.commissioningServer, this.matterbridgeContext, this.nodeContext, 'Matterbridge');
             // Configure the plugins
             this.configureTimeout = setTimeout(async () => {
                 for (const plugin of this.plugins) {
@@ -1443,9 +1423,8 @@ export class Matterbridge extends EventEmitter {
                         this.log.error(`Error configuring plugin ${plg}${plugin.name}${er}`, error);
                     }
                 }
+                this.wssSendRefreshRequired();
             }, 30 * 1000);
-            // Show the QR code for commissioning or log the already commissioned message
-            await this.showCommissioningQRCode(this.commissioningServer, this.matterbridgeContext, this.nodeContext, 'Matterbridge');
             // Setting reachability to true
             this.reachabilityTimeout = setTimeout(() => {
                 this.log.info(`Setting reachability to true for ${plg}Matterbridge${db}`);
@@ -1462,9 +1441,12 @@ export class Matterbridge extends EventEmitter {
      * @returns {Promise<void>} A promise that resolves when the Matterbridge is started.
      */
     async startChildbridge() {
-        // Plugins are loaded and started by loadPlugin on startup and plugin.loaded and plugin.started are set to true
-        // addDevice and addBridgedDeevice create the commissionig servers and add the devices to the the commissioning server or to the aggregator
+        // Matterbridge.addBridgedDevice creates the commissionig servers and add the devices to the the commissioning server or to the aggregator
         // Plugins are configured by a timer when matter server is started and plugin.configured is set to true
+        if (!this.storageManager)
+            throw new Error('No storage manager initialized');
+        this.matterServer = this.createMatterServer(this.storageManager);
+        await this.startPlugins();
         this.log.debug('Starting start matter interval in childbridge mode...');
         let failCount = 0;
         this.startMatterInterval = setInterval(async () => {
@@ -1476,7 +1458,7 @@ export class Matterbridge extends EventEmitter {
                 if (plugin.error) {
                     clearInterval(this.startMatterInterval);
                     this.startMatterInterval = undefined;
-                    this.log.debug('Cleared startMatterInterval interval for Matterbridge for plugin in error state');
+                    this.log.debug('Cleared startMatterInterval interval for a plugin in error state');
                     this.log.error(`The plugin ${plg}${plugin.name}${er} is in error state.`);
                     this.log.error('The bridge will not start until the problem is solved to prevent the controllers from deleting all registered devices.');
                     this.log.error('If you want to start the bridge disable the plugin in error state and restart.');
@@ -1498,6 +1480,7 @@ export class Matterbridge extends EventEmitter {
             clearInterval(this.startMatterInterval);
             this.startMatterInterval = undefined;
             this.log.debug('Cleared startMatterInterval interval in childbridge mode');
+            // Start the Matter server
             await this.startMatterServer();
             this.log.notice('Matter server started');
             // Configure the plugins
@@ -1513,6 +1496,7 @@ export class Matterbridge extends EventEmitter {
                         this.log.error(`Error configuring plugin ${plg}${plugin.name}${er}`, error);
                     }
                 }
+                this.wssSendRefreshRequired();
             }, 30 * 1000);
             for (const plugin of this.plugins) {
                 if (!plugin.enabled || plugin.error)
@@ -1753,7 +1737,7 @@ export class Matterbridge extends EventEmitter {
             await this.storageManager.initialize();
             this.log.debug('Storage initialized');
             if (storageType === 'json') {
-                await this.backupJsonMatterStorage(storageName, storageName.replace('.json', '') + '.backup.json');
+                await this.backupMatterStorage(storageName, storageName.replace('.json', '') + '.backup.json');
             }
             // eslint-disable-next-line @typescript-eslint/no-unused-vars
         }
@@ -1762,6 +1746,8 @@ export class Matterbridge extends EventEmitter {
             this.log.error(`Please delete it and rename ${storageName.replace('.json', '.backup.json')} to ${storageName} and try to restart Matterbridge.`);
             await this.cleanup('Storage initialize() error!');
         }
+        this.log.debug(`Creating commissioning server context for ${plg}Matterbridge${db}`);
+        this.matterbridgeContext = await this.createCommissioningServerContext('Matterbridge', 'Matterbridge', DeviceTypes.AGGREGATOR.code, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge aggregator');
     }
     /**
      * Makes a backup copy of the specified matter JSON storage file.
@@ -1769,7 +1755,7 @@ export class Matterbridge extends EventEmitter {
      * @param storageName - The name of the JSON storage file to be backed up.
      * @param backupName - The name of the backup file to be created.
      */
-    async backupJsonMatterStorage(storageName, backupName) {
+    async backupMatterStorage(storageName, backupName) {
         try {
             this.log.debug(`Making backup copy of ${storageName}`);
             await fs.copyFile(storageName, backupName);
@@ -2010,6 +1996,7 @@ export class Matterbridge extends EventEmitter {
                         }
                     }
                 }
+                this.wssSendRefreshRequired();
             },
             commissioningChangedCallback: async (fabricIndex) => {
                 const fabricInfo = commissioningServer.getCommissionedFabricInformation(fabricIndex);
@@ -2052,6 +2039,7 @@ export class Matterbridge extends EventEmitter {
                         }
                     }
                 }
+                this.wssSendRefreshRequired();
             },
         });
         if (this.passcode !== undefined)
@@ -2211,6 +2199,7 @@ export class Matterbridge extends EventEmitter {
                 }
             }
         }
+        this.wssSendRefreshRequired();
     }
     /**
      * Sanitizes the fabric information by converting bigint properties to string cause res.json doesn't know bigint.
@@ -2333,6 +2322,9 @@ export class Matterbridge extends EventEmitter {
             case 4701:
                 vendorName = '(Tuya)';
                 break;
+            case 4718:
+                vendorName = '(Xiaomi)';
+                break;
             case 4742:
                 vendorName = '(eWeLink)';
                 break;
@@ -2508,7 +2500,33 @@ export class Matterbridge extends EventEmitter {
         // Send the message to all connected clients
         this.webSocketServer?.clients.forEach((client) => {
             if (client.readyState === WebSocket.OPEN) {
-                client.send(JSON.stringify({ level, time, name, message }));
+                client.send(JSON.stringify({ id: WS_ID_LOG, src: 'Matterbridge', level, time, name, message }));
+            }
+        });
+    }
+    /**
+     * Sends a need to refresh WebSocket message to all connected clients.
+     *
+     */
+    wssSendRefreshRequired() {
+        this.matterbridgeInformation.refreshRequired = true;
+        // Send the message to all connected clients
+        this.webSocketServer?.clients.forEach((client) => {
+            if (client.readyState === WebSocket.OPEN) {
+                client.send(JSON.stringify({ id: WS_ID_REFRESH_NEEDED, src: 'Matterbridge', dst: 'Matterbridge', method: 'refresh_required', params: {} }));
+            }
+        });
+    }
+    /**
+     * Sends a need to restart WebSocket message to all connected clients.
+     *
+     */
+    wssSendRestartRequired() {
+        this.matterbridgeInformation.restartRequired = true;
+        // Send the message to all connected clients
+        this.webSocketServer?.clients.forEach((client) => {
+            if (client.readyState === WebSocket.OPEN) {
+                client.send(JSON.stringify({ id: WS_ID_RESTART_NEEDED, src: 'Matterbridge', dst: 'Matterbridge', method: 'restart_required', params: {} }));
             }
         });
     }
@@ -2627,7 +2645,7 @@ export class Matterbridge extends EventEmitter {
         }
         if (initializeError)
             return;
-        // Createe a WebSocket server and attach it to the http server
+        // Createe a WebSocket server and attach it to the http or https server
         const wssPort = port;
         const wssHost = hasParameter('ssl') ? `wss://${this.systemInformation.ipv4Address}:${wssPort}` : `ws://${this.systemInformation.ipv4Address}:${wssPort}`;
         this.webSocketServer = new WebSocketServer(hasParameter('ssl') ? { server: this.httpsServer } : { server: this.httpServer });
@@ -2637,6 +2655,14 @@ export class Matterbridge extends EventEmitter {
             this.log.info(`WebSocketServer client "${clientIp}" connected to Matterbridge`);
             ws.on('message', (message) => {
                 this.log.debug(`WebSocket client message: ${message}`);
+                this.matterbridgeMessageHandler(ws, message);
+            });
+            ws.on('ping', () => {
+                this.log.debug('WebSocket client ping');
+                ws.pong();
+            });
+            ws.on('pong', () => {
+                this.log.debug('WebSocket client pong');
             });
             ws.on('close', () => {
                 this.log.info('WebSocket client disconnected');
@@ -2699,12 +2725,8 @@ export class Matterbridge extends EventEmitter {
             this.matterbridgeInformation.matterbridgeQrPairingCode = this.matterbridgeQrPairingCode;
             this.matterbridgeInformation.matterbridgeManualPairingCode = this.matterbridgeManualPairingCode;
             this.matterbridgeInformation.matterbridgeFabricInformations = this.matterbridgeFabricInformations;
-            // this.matterbridgeInformation.matterbridgeSessionInformations = this.matterbridgeSessionInformations;
             this.matterbridgeInformation.matterbridgeSessionInformations = Array.from(this.matterbridgeSessionInformations.values());
-            // console.log('this.matterbridgeSessionInformations:', this.matterbridgeSessionInformations);
-            if (this.profile)
-                this.matterbridgeInformation.profile = this.profile;
-            // const response = { wssHost, ssl: hasParameter('ssl'), qrPairingCode, manualPairingCode, systemInformation: this.systemInformation, matterbridgeInformation: this.matterbridgeInformation };
+            this.matterbridgeInformation.profile = this.profile;
             const response = { wssHost, ssl: hasParameter('ssl'), systemInformation: this.systemInformation, matterbridgeInformation: this.matterbridgeInformation };
             // this.log.debug('Response:', debugStringify(response));
             res.json(response);
@@ -2785,7 +2807,7 @@ export class Matterbridge extends EventEmitter {
                         });
                     });
                     device.getChildEndpoints().forEach((childEndpoint) => {
-                        const name = device.getChildEndpointName(childEndpoint);
+                        const name = childEndpoint.uniqueStorageKey;
                         const clusterServers = childEndpoint.getAllClusterServers();
                         clusterServers.forEach((clusterServer) => {
                             Object.entries(clusterServer.attributes).forEach(([key, value]) => {
@@ -2819,7 +2841,7 @@ export class Matterbridge extends EventEmitter {
             });
             res.json(data);
         });
-        // Endpoint to send the log
+        // Endpoint to view the log
         this.expressApp.get('/api/view-log', async (req, res) => {
             this.log.debug('The frontend sent /api/log');
             try {
@@ -2941,7 +2963,7 @@ export class Matterbridge extends EventEmitter {
             // Handle the command setbridgemode from Settings
             if (command === 'setbridgemode') {
                 this.log.debug(`setbridgemode: ${param}`);
-                this.matterbridgeInformation.restartRequired = true;
+                this.wssSendRestartRequired();
                 await this.nodeContext?.set('bridgeMode', param);
                 res.json({ message: 'Command received' });
                 return;
@@ -3121,7 +3143,7 @@ export class Matterbridge extends EventEmitter {
                     this.log.error('Error updating matterbridge');
                 }
                 await this.updateProcess();
-                this.matterbridgeInformation.restartRequired = true;
+                this.wssSendRestartRequired();
                 res.json({ message: 'Command received' });
                 return;
             }
@@ -3139,7 +3161,7 @@ export class Matterbridge extends EventEmitter {
                         return;
                     this.plugins.saveConfigFromJson(plugin, req.body);
                 }
-                this.matterbridgeInformation.restartRequired = true;
+                this.wssSendRestartRequired();
                 res.json({ message: 'Command received' });
                 return;
             }
@@ -3155,7 +3177,7 @@ export class Matterbridge extends EventEmitter {
                 catch (error) {
                     this.log.error(`Error installing plugin ${plg}${param}${er}`);
                 }
-                this.matterbridgeInformation.restartRequired = true;
+                this.wssSendRestartRequired();
                 // Also add the plugin to matterbridge so no return!
                 // res.json({ message: 'Command received' });
                 // return;
@@ -3168,6 +3190,7 @@ export class Matterbridge extends EventEmitter {
                     this.plugins.load(plugin, true, 'The plugin has been added', true); // No await do it in the background
                 }
                 res.json({ message: 'Command received' });
+                this.wssSendRefreshRequired();
                 return;
             }
             // Handle the command removeplugin from Home
@@ -3181,6 +3204,7 @@ export class Matterbridge extends EventEmitter {
                     await this.plugins.remove(param);
                 }
                 res.json({ message: 'Command received' });
+                this.wssSendRefreshRequired();
                 return;
             }
             // Handle the command enableplugin from Home
@@ -3205,6 +3229,7 @@ export class Matterbridge extends EventEmitter {
                     }
                 }
                 res.json({ message: 'Command received' });
+                this.wssSendRefreshRequired();
                 return;
             }
             // Handle the command disableplugin from Home
@@ -3220,6 +3245,7 @@ export class Matterbridge extends EventEmitter {
                     }
                 }
                 res.json({ message: 'Command received' });
+                this.wssSendRefreshRequired();
                 return;
             }
         });