matterbridge 1.2.9 → 1.2.11

package/dist/matterbridge.js

@@ -55,6 +55,7 @@ export class Matterbridge extends EventEmitter {
         ipv6Address: '',
         nodeVersion: '',
         hostname: '',
+        user: '',
         osType: '',
         osRelease: '',
         osPlatform: '',
@@ -72,6 +73,7 @@ export class Matterbridge extends EventEmitter {
         matterbridgeVersion: '',
         matterbridgeLatestVersion: '',
         bridgeMode: '',
+        restartMode: '',
         debugEnabled: false,
     };
     homeDirectory = '';
@@ -82,6 +84,7 @@ export class Matterbridge extends EventEmitter {
     matterbridgeVersion = '';
     matterbridgeLatestVersion = '';
     bridgeMode = '';
+    restartMode = '';
     debugEnabled = false;
     port = 5540;
     log;
@@ -128,11 +131,11 @@ export class Matterbridge extends EventEmitter {
      *
      * @returns A Promise that resolves when the initialization is complete.
      */
-    async initializeAsExtension(dataPath, debugEnabled) {
+    async startExtension(dataPath, debugEnabled, extensionVersion, port = 5560) {
         // Set the bridge mode
         this.bridgeMode = 'bridge';
         // Set the first port to use
-        this.port = 5560;
+        this.port = port;
         // Set Matterbridge logger
         this.debugEnabled = debugEnabled;
         this.log = new AnsiLogger({ logName: 'Matterbridge', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logDebug: this.debugEnabled });
@@ -164,14 +167,16 @@ export class Matterbridge extends EventEmitter {
         Logger.format = Format.ANSI;
         // Start the storage and create matterbridgeContext
         await this.startStorage('json', path.join(this.matterbridgeDirectory, 'matterbridge.json'));
-        this.matterbridgeContext = await this.createCommissioningServerContext('Matterbridge', 'Matterbridge', DeviceTypes.AGGREGATOR.code, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge aggregator');
-        if (!this.storageManager || !this.matterbridgeContext)
-            return;
+        if (!this.storageManager)
+            return false;
+        this.matterbridgeContext = await this.createCommissioningServerContext('Matterbridge', 'Matterbridge zigbee2MQTT', DeviceTypes.AGGREGATOR.code, 0xfff1, 'Matterbridge', 0x8000, 'zigbee2MQTT Matter extension');
+        if (!this.matterbridgeContext)
+            return false;
         await this.matterbridgeContext.set('softwareVersion', 1);
         await this.matterbridgeContext.set('softwareVersionString', this.matterbridgeVersion);
-        await this.matterbridgeContext.set('hardwareVersion', 0);
-        await this.matterbridgeContext.set('hardwareVersionString', '1.0.0'); // Update with the extension version
-        this.createMatterServer(this.storageManager);
+        await this.matterbridgeContext.set('hardwareVersion', 1);
+        await this.matterbridgeContext.set('hardwareVersionString', extensionVersion); // Update with the extension version
+        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}`);
@@ -179,9 +184,7 @@ export class Matterbridge extends EventEmitter {
         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' });
-        this.log.debug(`Setting reachability to true for ${plg}Matterbridge${db}`);
-        this.commissioningServer.setReachability(true);
+        await this.matterServer.addCommissioningServer(this.commissioningServer, { uniqueStorageKey: 'Matterbridge' });
         await this.startMatterServer();
         this.log.info('Matter server started');
         await this.showCommissioningQRCode(this.commissioningServer, this.matterbridgeContext, this.nodeContext, 'Matterbridge');
@@ -193,17 +196,26 @@ export class Matterbridge extends EventEmitter {
             if (this.matterAggregator)
                 this.setAggregatorReachability(this.matterAggregator, true);
         }, 60 * 1000);
+        return this.commissioningServer.isCommissioned();
     }
     /**
      * Close the Matterbridge instance as extension for zigbee2mqtt.
      *
      * @returns A Promise that resolves when the initialization is complete.
      */
-    async closeAsExtension() {
+    async stopExtension() {
         // Closing matter
         await this.stopMatter();
+        // Clearing the session manager
+        // this.matterbridgeContext?.createContext('SessionManager').clear();
         // Closing storage
         await this.stopStorage();
+        this.log.info('Matter server stopped');
+    }
+    isExtensionCommissioned() {
+        if (!this.commissioningServer)
+            return false;
+        return this.commissioningServer.isCommissioned();
     }
     /**
      * Initializes the Matterbridge application.
@@ -243,6 +255,11 @@ export class Matterbridge extends EventEmitter {
         }
         // Set the first port to use
         this.port = getIntParameter('port') ?? 5540;
+        // Set the restart mode
+        if (hasParameter('service'))
+            this.restartMode = 'service';
+        if (hasParameter('docker'))
+            this.restartMode = 'docker';
         // Set Matterbridge logger
         if (hasParameter('debug'))
             this.debugEnabled = true;
@@ -277,7 +294,8 @@ export class Matterbridge extends EventEmitter {
         await this.logNodeAndSystemInfo();
         this.log.info(
         // eslint-disable-next-line max-len
-        `Matterbridge version ${this.matterbridgeVersion} mode ${hasParameter('bridge') ? 'bridge' : ''}${hasParameter('childbridge') ? 'childbridge' : ''}${hasParameter('controller') ? 'controller' : ''} running on ${this.systemInformation.osType} ${this.systemInformation.osRelease} ${this.systemInformation.osPlatform} ${this.systemInformation.osArch}`);
+        `Matterbridge version ${this.matterbridgeVersion} mode ${hasParameter('bridge') ? 'bridge' : ''}${hasParameter('childbridge') ? 'childbridge' : ''}${hasParameter('controller') ? 'controller' : ''} ` +
+            `${this.restartMode !== '' ? 'restart mode ' + this.restartMode + ' ' : ''}running on ${this.systemInformation.osType} ${this.systemInformation.osRelease} ${this.systemInformation.osPlatform} ${this.systemInformation.osArch}`);
         // Check node version and throw error
         requireMinNodeVersion(18);
         // Register SIGINT SIGTERM signal handlers
@@ -608,12 +626,17 @@ export class Matterbridge extends EventEmitter {
             this.log.debug('All listeners removed');
             // Calling the shutdown functions with a reason
             for (const plugin of this.registeredPlugins) {
-                if (!plugin.enabled)
+                if (!plugin.enabled || plugin.error)
                     continue;
                 this.log.info(`*Shutting down plugin ${plg}${plugin.name}${nf}`);
                 if (plugin.platform) {
-                    await plugin.platform.onShutdown('Matterbridge is closing: ' + message);
-                    await this.savePluginConfig(plugin);
+                    try {
+                        await plugin.platform.onShutdown('Matterbridge is closing: ' + message);
+                        await this.savePluginConfig(plugin);
+                    }
+                    catch (error) {
+                        this.log.error(`Plugin ${plg}${plugin.name}${er} shutting down error: ${error}`);
+                    }
                 }
                 else {
                     this.log.warn(`Plugin ${plg}${plugin.name}${wr} platform not found`);
@@ -983,12 +1006,7 @@ export class Matterbridge extends EventEmitter {
             return;
         }
         this.log.debug('Starting matterbridge in mode', this.bridgeMode);
-        this.createMatterServer(this.storageManager);
-        if (!this.matterServer) {
-            this.log.error('No matter server initialized');
-            await this.cleanup('No matter server initialized');
-            return;
-        }
+        this.matterServer = this.createMatterServer(this.storageManager);
         this.log.debug('***Starting startMatterbridge interval for Matterbridge');
         let failCount = 0;
         const startInterval = setInterval(async () => {
@@ -1164,7 +1182,7 @@ export class Matterbridge extends EventEmitter {
             return Promise.reject(new Error(`Plugin ${plg}${plugin.name}${er} not loaded or no platform`));
         }
         if (plugin.started) {
-            this.log.warn(`Plugin ${plg}${plugin.name}${wr} already started`);
+            this.log.debug(`Plugin ${plg}${plugin.name}${db} already started`);
             return Promise.resolve();
         }
         this.log.info(`Starting plugin ${plg}${plugin.name}${db} type ${typ}${plugin.type}${db}`);
@@ -1179,13 +1197,15 @@ export class Matterbridge extends EventEmitter {
                 return Promise.resolve();
             })
                 .catch((err) => {
+                plugin.error = true;
                 this.log.error(`Failed to start plugin ${plg}${plugin.name}${er}: ${err}`);
-                return Promise.reject(new Error(`Failed to start plugin ${plg}${plugin.name}${er}: ${err}`));
+                // return Promise.reject(new Error(`Failed to start plugin ${plg}${plugin.name}${er}: ${err}`));
             });
         }
         catch (err) {
+            plugin.error = true;
             this.log.error(`Failed to start plugin ${plg}${plugin.name}${er}: ${err}`);
-            return Promise.reject(new Error(`Failed to start plugin ${plg}${plugin.name}${er}: ${err}`));
+            // return Promise.reject(new Error(`Failed to start plugin ${plg}${plugin.name}${er}: ${err}`));
         }
     }
     /**
@@ -1213,13 +1233,15 @@ export class Matterbridge extends EventEmitter {
                 return Promise.resolve();
             })
                 .catch((err) => {
+                plugin.error = true;
                 this.log.error(`Failed to configure plugin ${plg}${plugin.name}${er}: ${err}`);
-                return Promise.reject(new Error(`Failed to configure plugin ${plg}${plugin.name}${er}: ${err}`));
+                // return Promise.reject(new Error(`Failed to configure plugin ${plg}${plugin.name}${er}: ${err}`));
             });
         }
         catch (err) {
+            plugin.error = true;
             this.log.error(`Failed to configure plugin ${plg}${plugin.name}${er}: ${err}`);
-            return Promise.reject(new Error(`Failed to configure plugin ${plg}${plugin.name}${er}: ${err}`));
+            // return Promise.reject(new Error(`Failed to configure plugin ${plg}${plugin.name}${er}: ${err}`));
         }
     }
     /**
@@ -1275,12 +1297,14 @@ export class Matterbridge extends EventEmitter {
             }
             else {
                 this.log.error(`Plugin ${plg}${plugin.name}${er} does not provide a default export`);
+                plugin.error = true;
                 return;
                 //return Promise.reject(new Error(`Plugin ${plg}${plugin.name}${er} does not provide a default export`));
             }
         }
         catch (err) {
             this.log.error(`Failed to load plugin ${plg}${plugin.name}${er}: ${err}`);
+            plugin.error = true;
             return;
             //return Promise.reject(new Error(`Failed to load plugin ${plg}${plugin.name}${er}: ${err}`));
         }
@@ -1304,12 +1328,7 @@ export class Matterbridge extends EventEmitter {
             return;
         }
         this.log.debug('Starting matterbridge in mode', this.bridgeMode);
-        this.createMatterServer(this.storageManager);
-        if (!this.matterServer) {
-            this.log.error('No matter server initialized');
-            await this.cleanup('No matter server initialized');
-            return;
-        }
+        this.matterServer = this.createMatterServer(this.storageManager);
         this.log.info('Creating matter commissioning controller');
         this.commissioningController = new CommissioningController({
             autoConnect: false,
@@ -1466,12 +1485,7 @@ export class Matterbridge extends EventEmitter {
             return;
         }
         this.log.debug('Starting matterbridge in mode', this.bridgeMode);
-        this.createMatterServer(this.storageManager);
-        if (!this.matterServer) {
-            this.log.error('No matter server initialized');
-            await this.cleanup('No matter server initialized');
-            return;
-        }
+        this.matterServer = this.createMatterServer(this.storageManager);
         if (this.bridgeMode === 'bridge') {
             // Plugins are loaded by loadPlugin on startup and plugin.loaded is set to true
             // Plugins are started and configured by callback when Matterbridge is commissioned
@@ -1479,10 +1493,10 @@ export class Matterbridge extends EventEmitter {
             let failCount = 0;
             const startInterval = setInterval(async () => {
                 for (const plugin of this.registeredPlugins) {
-                    if (!plugin.enabled)
+                    if (!plugin.enabled || plugin.error)
                         continue;
                     if (!plugin.loaded) {
-                        this.log.info(`***Waiting (failSafeCount=${failCount}/30) in startMatterbridge interval for plugin ${plg}${plugin.name}${db} loaded: ${plugin.loaded}...`);
+                        this.log.debug(`***Waiting (failSafeCount=${failCount}/30) in startMatterbridge interval for plugin ${plg}${plugin.name}${db} loaded: ${plugin.loaded}...`);
                         failCount++;
                         if (failCount > 30) {
                             this.log.error(`***Failed to load plugin ${plg}${plugin.name}${er}`);
@@ -1515,8 +1529,6 @@ export class Matterbridge extends EventEmitter {
                 this.commissioningServer.addDevice(this.matterAggregator);
                 this.log.debug('Adding matterbridge commissioning server to matter server');
                 await this.matterServer?.addCommissioningServer(this.commissioningServer, { uniqueStorageKey: 'Matterbridge' });
-                this.log.debug(`Setting reachability to true for ${plg}Matterbridge${db}`);
-                this.commissioningServer.setReachability(true);
                 await this.startMatterServer();
                 this.log.info('Matter server started');
                 await this.showCommissioningQRCode(this.commissioningServer, this.matterbridgeContext, this.nodeContext, 'Matterbridge');
@@ -1543,7 +1555,7 @@ export class Matterbridge extends EventEmitter {
                 let failCount = 0;
                 const startInterval = setInterval(async () => {
                     if (!plugin.loaded || !plugin.started /* || !plugin.configured*/) {
-                        this.log.info(`***Waiting (failSafeCount=${failCount}/30) in startMatterbridge interval for plugin ${plg}${plugin.name}${db} loaded: ${plugin.loaded} started: ${plugin.started}...`);
+                        this.log.debug(`***Waiting (failSafeCount=${failCount}/30) in startMatterbridge interval for plugin ${plg}${plugin.name}${db} loaded: ${plugin.loaded} started: ${plugin.started}...`);
                         failCount++;
                         if (failCount > 30) {
                             this.log.error(`***Failed to load plugin ${plg}${plugin.name}${er}`);
@@ -1727,8 +1739,8 @@ export class Matterbridge extends EventEmitter {
         if (!commissioningServer.isCommissioned()) {
             this.log.info(`***The commissioning server on port ${commissioningServer.getPort()} for ${plg}${pluginName}${nf} is not commissioned. Pair it scanning the QR code ...`);
             const { qrPairingCode, manualPairingCode } = commissioningServer.getPairingCode();
-            storageContext.set('qrPairingCode', qrPairingCode);
-            storageContext.set('manualPairingCode', manualPairingCode);
+            await storageContext.set('qrPairingCode', qrPairingCode);
+            await storageContext.set('manualPairingCode', manualPairingCode);
             await nodeContext.set('qrPairingCode', qrPairingCode);
             await nodeContext.set('manualPairingCode', manualPairingCode);
             const QrCode = new QrCodeSchema();
@@ -1861,7 +1873,7 @@ export class Matterbridge extends EventEmitter {
                 const info = commissioningServer.getActiveSessionInformation(fabricIndex);
                 let connected = false;
                 info.forEach((session) => {
-                    this.log.debug(`***Active session changed on fabric ${fabricIndex} ${session.fabric?.rootVendorId}/${session.fabric?.label} for ${plg}${pluginName}${nf}`, debugStringify(session));
+                    this.log.info(`***Active session changed on fabric ${fabricIndex} ${session.fabric?.rootVendorId}/${session.fabric?.label} for ${plg}${pluginName}${nf}`, debugStringify(session));
                     if (session.isPeerActive === true && session.secure === true && session.numberOfActiveSubscriptions >= 1) {
                         let controllerName = '';
                         if (session.fabric?.rootVendorId === 4937)
@@ -1870,7 +1882,7 @@ export class Matterbridge extends EventEmitter {
                             controllerName = 'SmartThings';
                         if (session.fabric?.rootVendorId === 4939)
                             controllerName = 'HomeAssistant';
-                        this.log.info(`***Controller ${session.fabric?.rootVendorId}${controllerName !== '' ? '(' + controllerName + ')' : ''}/${session.fabric?.label} connected to ${plg}${pluginName}${nf}`);
+                        this.log.info(`***Controller ${session.fabric?.rootVendorId}${controllerName !== '' ? '(' + controllerName + ')' : ''}/${session.fabric?.label} connected to ${plg}${pluginName}${nf} on session ${session.name}`);
                         connected = true;
                     }
                 });
@@ -1886,9 +1898,15 @@ export class Matterbridge extends EventEmitter {
                         if (this.bridgeMode === 'bridge') {
                             //Logger.defaultLogLevel = Level.INFO;
                             for (const plugin of this.registeredPlugins) {
-                                if (!plugin.enabled)
+                                if (!plugin.enabled || !plugin.loaded || plugin.error)
                                     continue;
-                                this.startPlugin(plugin, 'Matterbridge is commissioned and controllers are connected', true); // No await do it asyncronously with also configurePlugin
+                                try {
+                                    this.startPlugin(plugin, 'Matterbridge is commissioned and controllers are connected', true); // No await do it asyncronously with also configurePlugin
+                                }
+                                catch (error) {
+                                    plugin.error = true;
+                                    this.log.error(`Error starting plugin ${plg}${plugin.name}${er}`, error);
+                                }
                             }
                             Logger.defaultLogLevel = this.debugEnabled ? Level.DEBUG : Level.INFO;
                         }
@@ -1928,7 +1946,7 @@ export class Matterbridge extends EventEmitter {
                 const info = commissioningServer.getCommissionedFabricInformation(fabricIndex);
                 this.log.debug(`***Commissioning changed on fabric ${fabricIndex} for ${plg}${pluginName}${nf}`, debugStringify(info));
                 if (info.length === 0) {
-                    this.log.warn(`***Commissioning removed from fabric ${fabricIndex} for ${plg}${pluginName}${nf}. Resetting the commissioning server ...`);
+                    this.log.warn(`***Commissioning removed from fabric ${fabricIndex} for ${plg}${pluginName}${wr}. Resetting the commissioning server ...`);
                     await commissioningServer.factoryReset();
                     if (pluginName === 'Matterbridge') {
                         await this.matterbridgeContext?.clearAll();
@@ -1943,6 +1961,7 @@ export class Matterbridge extends EventEmitter {
                             }
                         }
                     }
+                    this.log.warn(`***Restart to activate the pairing for ${plg}${pluginName}${wr}`);
                 }
             },
         });
@@ -1956,8 +1975,9 @@ export class Matterbridge extends EventEmitter {
      */
     createMatterServer(storageManager) {
         this.log.debug('Creating matter server');
-        this.matterServer = new MatterServer(storageManager, { mdnsAnnounceInterface: undefined });
+        const matterServer = new MatterServer(storageManager, { mdnsAnnounceInterface: undefined });
         this.log.debug('Created matter server');
+        return matterServer;
     }
     /**
      * Creates a Matter Aggregator.
@@ -2075,6 +2095,7 @@ export class Matterbridge extends EventEmitter {
         const versionPatch = parseInt(this.systemInformation.nodeVersion.split('.')[2]);
         // Host system information
         this.systemInformation.hostname = os.hostname();
+        this.systemInformation.user = os.userInfo().username;
         this.systemInformation.osType = os.type(); // "Windows_NT", "Darwin", etc.
         this.systemInformation.osRelease = os.release(); // Kernel version
         this.systemInformation.osPlatform = os.platform(); // "win32", "linux", "darwin", etc.
@@ -2085,6 +2106,7 @@ export class Matterbridge extends EventEmitter {
         // Log the system information
         this.log.debug('Host System Information:');
         this.log.debug(`- Hostname: ${this.systemInformation.hostname}`);
+        this.log.debug(`- User: ${this.systemInformation.user}`);
         this.log.debug(`- IPv4 Address: ${this.systemInformation.ipv4Address}`);
         this.log.debug(`- IPv6 Address: ${this.systemInformation.ipv6Address}`);
         this.log.debug(`- Node.js: ${versionMajor}.${versionMinor}.${versionPatch}`);
@@ -2266,7 +2288,7 @@ export class Matterbridge extends EventEmitter {
             args.unshift(command);
             command = 'sudo';
         }
-        this.log.debug(`Spawning command ${command} with ${debugStringify(args)}`);
+        this.log.debug(`Spawn command ${command} with ${debugStringify(args)}`);
         return new Promise((resolve, reject) => {
             const childProcess = spawn(command, args, {
                 stdio: ['inherit', 'pipe', 'pipe'],
@@ -2430,6 +2452,7 @@ export class Matterbridge extends EventEmitter {
                 res.json({});
             }
             this.matterbridgeInformation.bridgeMode = this.bridgeMode;
+            this.matterbridgeInformation.restartMode = this.restartMode;
             this.matterbridgeInformation.debugEnabled = this.debugEnabled;
             const response = { wssHost, qrPairingCode, manualPairingCode, systemInformation: this.systemInformation, matterbridgeInformation: this.matterbridgeInformation };
             this.log.debug('The frontend sent /api/settings');
@@ -2495,7 +2518,7 @@ export class Matterbridge extends EventEmitter {
                             }
                             catch (error) {
                                 attributeValue = 'Unavailable';
-                                this.log.debug(`****${error} in clusterServer: ${clusterServer.name}(${clusterServer.id}) attribute: ${key}(${value.id})`);
+                                this.log.debug(`GetLocal value ${error} in clusterServer: ${clusterServer.name}(${clusterServer.id}) attribute: ${key}(${value.id})`);
                                 //console.log(error);
                             }
                             data.push({
@@ -2765,6 +2788,8 @@ export class Matterbridge extends EventEmitter {
                 attributes += `Humidity: ${clusterServer.getMeasuredValueAttribute() / 100}% `;
             if (clusterServer.name === 'PressureMeasurement')
                 attributes += `Pressure: ${clusterServer.getMeasuredValueAttribute()} `;
+            if (clusterServer.name === 'FlowMeasurement')
+                attributes += `Pressure: ${clusterServer.getMeasuredValueAttribute()} `;
         });
         return attributes;
     }
@@ -2781,34 +2806,22 @@ function restartProcess() {
     stdio: 'inherit',
   });
 
+  // Handle errors
+  newProcess.on('error', (err) => {
+    console.error('Failed to start new process:', err);
+  });
+
   // Unreference the new process so that the current process can exit
   newProcess.unref();
 
   // Exit the current process
+  cleanup();
   process.exit();
 }
 
-import * as WebSocket from 'ws';
-
-const wss = new WebSocket.Server({ port: 8080 });
-
-wss.on('connection', ws => {
-  ws.on('message', message => {
-    console.log(`Received message => ${message}`)
-  });
-
-  // Send a message to the frontend
-  ws.send('Hello from backend!');
-});
-
-const ws = new WebSocket('ws://localhost:8080');
 
-ws.onmessage = (event) => {
-  console.log(`Received message => ${event.data}`);
-};
-
-*/
 /*
+How frontend was created
 npx create-react-app matterbridge-frontend
 cd matterbridge-frontend
 npm install react-router-dom