matterbridge 1.2.22 → 1.3.1

package/dist/matterbridge.js

@@ -32,7 +32,7 @@ import express from 'express';
 import os from 'os';
 import path from 'path';
 import WebSocket, { WebSocketServer } from 'ws';
-import { BridgedDeviceBasicInformation, BridgedDeviceBasicInformationCluster } from './BridgedDeviceBasicInformationCluster.js';
+import { BridgedDeviceBasicInformation, BridgedDeviceBasicInformationCluster } from './cluster/BridgedDeviceBasicInformationCluster.js';
 import { CommissioningController, CommissioningServer, MatterServer } from '@project-chip/matter-node.js';
 import { BasicInformationCluster, ClusterServer, FixedLabelCluster, GeneralCommissioning, PowerSourceCluster, ThreadNetworkDiagnosticsCluster, getClusterNameById } from '@project-chip/matter-node.js/cluster';
 import { DeviceTypeId, VendorId } from '@project-chip/matter-node.js/datatype';
@@ -73,6 +73,9 @@ export class Matterbridge extends EventEmitter {
         globalModulesDirectory: '',
         matterbridgeVersion: '',
         matterbridgeLatestVersion: '',
+        matterbridgeFabricInfo: [],
+        matterbridgePaired: false,
+        matterbridgeConnected: false,
         bridgeMode: '',
         restartMode: '',
         debugEnabled: false,
@@ -133,6 +136,7 @@ export class Matterbridge extends EventEmitter {
     }
     /**
      * Initializes the Matterbridge instance as extension for zigbee2mqtt.
+     * @deprecated This method is deprecated and will be removed in a future version.
      *
      * @returns A Promise that resolves when the initialization is complete.
      */
@@ -205,6 +209,7 @@ export class Matterbridge extends EventEmitter {
     }
     /**
      * Close the Matterbridge instance as extension for zigbee2mqtt.
+     * @deprecated This method is deprecated and will be removed in a future version.
      *
      * @returns A Promise that resolves when the initialization is complete.
      */
@@ -217,6 +222,12 @@ export class Matterbridge extends EventEmitter {
         await this.stopStorage();
         this.log.info('Matter server stopped');
     }
+    /**
+     * Checks if the extension is commissioned.
+     * @deprecated This method is deprecated and will be removed in a future version.
+     *
+     * @returns {boolean} Returns true if the extension is commissioned, false otherwise.
+     */
     isExtensionCommissioned() {
         if (!this.commissioningServer)
             return false;
@@ -277,7 +288,7 @@ export class Matterbridge extends EventEmitter {
         this.nodeStorage = new NodeStorageManager({ dir: path.join(this.matterbridgeDirectory, 'storage'), logging: false });
         this.log.debug('Creating node storage context for matterbridge');
         this.nodeContext = await this.nodeStorage.createStorage('matterbridge');
-        // Get the plugins from node storage
+        // Get the plugins from node storage and create the plugin node storage contexts
         this.registeredPlugins = await this.nodeContext.get('plugins', []);
         for (const plugin of this.registeredPlugins) {
             this.log.debug(`Creating node storage context for plugin ${plugin.name}`);
@@ -300,7 +311,34 @@ export class Matterbridge extends EventEmitter {
         // Register SIGINT SIGTERM signal handlers
         this.registerSignalHandlers();
         // Set matter.js logger level and format
-        Logger.defaultLogLevel = this.debugEnabled ? Level.DEBUG : Level.INFO;
+        if (hasParameter('matterlogger')) {
+            const level = getParameter('matterlogger');
+            if (level === 'debug') {
+                Logger.defaultLogLevel = Level.DEBUG;
+            }
+            else if (level === 'info') {
+                Logger.defaultLogLevel = Level.INFO;
+            }
+            else if (level === 'notice') {
+                Logger.defaultLogLevel = Level.NOTICE;
+            }
+            else if (level === 'warn') {
+                Logger.defaultLogLevel = Level.WARN;
+            }
+            else if (level === 'error') {
+                Logger.defaultLogLevel = Level.ERROR;
+            }
+            else if (level === 'fatal') {
+                Logger.defaultLogLevel = Level.FATAL;
+            }
+            else {
+                this.log.warn(`Invalid matterlogger level: ${level}. Using default level ${this.debugEnabled ? 'debug' : 'info'}.`);
+                Logger.defaultLogLevel = this.debugEnabled ? Level.DEBUG : Level.INFO;
+            }
+        }
+        else {
+            Logger.defaultLogLevel = this.debugEnabled ? Level.DEBUG : Level.INFO;
+        }
         Logger.format = Format.ANSI;
         // Parse command line
         this.parseCommandLine();
@@ -458,6 +496,9 @@ export class Matterbridge extends EventEmitter {
             this.log.debug('Adding matterbridge commissioning server to matter server');
             await this.matterServer.addCommissioningServer(this.commissioningServer, { uniqueStorageKey: 'Matterbridge' });
             for (const plugin of this.registeredPlugins) {
+                plugin.configJson = await this.loadPluginConfig(plugin);
+                plugin.schemaJson = await this.loadPluginSchema(plugin);
+                this.getPluginLatestVersion(plugin);
                 if (!plugin.enabled) {
                     this.log.info(`Plugin ${plg}${plugin.name}${nf} not enabled`);
                     continue;
@@ -485,6 +526,9 @@ export class Matterbridge extends EventEmitter {
             this.log.debug('Starting matterbridge in mode', this.bridgeMode);
             this.matterServer = this.createMatterServer(this.storageManager);
             for (const plugin of this.registeredPlugins) {
+                plugin.configJson = await this.loadPluginConfig(plugin);
+                plugin.schemaJson = await this.loadPluginSchema(plugin);
+                this.getPluginLatestVersion(plugin);
                 if (!plugin.enabled) {
                     this.log.info(`Plugin ${plg}${plugin.name}${nf} not enabled`);
                     continue;
@@ -869,7 +913,7 @@ export class Matterbridge extends EventEmitter {
      * Adds a bridged device to the Matterbridge.
      * @param pluginName - The name of the plugin.
      * @param device - The bridged device to add.
-     * @returns {Promise<void>} - A promise that resolves when the storage process is started.
+     * @returns {Promise<void>} - A promise that resolves when the device is added.
      */
     async addBridgedDevice(pluginName, device) {
         if (this.bridgeMode === 'bridge' && !this.matterAggregator) {
@@ -1094,15 +1138,38 @@ export class Matterbridge extends EventEmitter {
     }
     /**
      * Loads the schema for a plugin.
-     * If the schema file exists, it reads the file and returns the parsed JSON data.
-     * If the schema file does not exist, it creates a new file with default configuration and returns it.
+     * If the schema file exists in the plugin directory, it reads the file and returns the parsed JSON data and delete the schema form .matterbridge.
+     * If the schema file exists in matterbridgeDirectory, it reads the file and returns the parsed JSON data.
+     * If the schema file does not exist, it creates a new schema with the default configuration and returns it.
      * If any error occurs during file access or creation, it logs an error and return an empty schema.
      *
      * @param plugin - The plugin for which to load the schema.
      * @returns A promise that resolves to the loaded or created schema.
      */
     async loadPluginSchema(plugin) {
-        const schemaFile = path.join(this.matterbridgeDirectory, `${plugin.name}.schema.json`);
+        let schemaFile = plugin.path.replace('package.json', `${plugin.name}.schema.json`);
+        try {
+            await fs.access(schemaFile);
+            const data = await fs.readFile(schemaFile, 'utf8');
+            const schema = JSON.parse(data);
+            schema.title = plugin.description;
+            schema.description = plugin.name + ' v. ' + plugin.version + ' by ' + plugin.author;
+            this.log.debug(`Schema file found: ${schemaFile}.`);
+            // this.log.debug(`Schema file found: ${schemaFile}.\nSchema:${rs}\n`, schema);
+            schemaFile = path.join(this.matterbridgeDirectory, `${plugin.name}.schema.json`);
+            try {
+                await fs.unlink(schemaFile);
+                this.log.debug(`Schema file ${schemaFile} deleted.`);
+            }
+            catch (err) {
+                this.log.debug(`Schema file ${schemaFile} to delete not found.`);
+            }
+            return schema;
+        }
+        catch (err) {
+            this.log.debug(`Schema file ${schemaFile} not found.`);
+        }
+        schemaFile = path.join(this.matterbridgeDirectory, `${plugin.name}.schema.json`);
         try {
             await fs.access(schemaFile);
             const data = await fs.readFile(schemaFile, 'utf8');
@@ -1140,22 +1207,28 @@ export class Matterbridge extends EventEmitter {
                                     type: 'string',
                                     readOnly: true,
                                 },
+                                debug: {
+                                    description: 'Enable the debug for the plugin (development only)',
+                                    type: 'boolean',
+                                },
                                 unregisterOnShutdown: {
                                     description: 'Unregister all devices on shutdown (development only)',
                                     type: 'boolean',
                                 },
                             },
                         };
+                    return schema;
+                    /*
                     try {
-                        await this.writeFile(schemaFile, JSON.stringify(schema, null, 2));
-                        this.log.debug(`Created schema file: ${schemaFile}.`);
-                        // this.log.debug(`Created schema file: ${schemaFile}.\nSchema:${rs}\n`, schema);
-                        return schema;
-                    }
-                    catch (err) {
-                        this.log.error(`Error creating schema file ${schemaFile}: ${err}`);
-                        return schema;
+                      await this.writeFile(schemaFile, JSON.stringify(schema, null, 2));
+                      this.log.debug(`Created schema file: ${schemaFile}.`);
+                      // this.log.debug(`Created schema file: ${schemaFile}.\nSchema:${rs}\n`, schema);
+                      return schema;
+                    } catch (err) {
+                      this.log.error(`Error creating schema file ${schemaFile}: ${err}`);
+                      return schema;
                     }
+                    */
                 }
                 else {
                     this.log.error(`Error accessing schema file ${schemaFile}: ${err}`);
@@ -1170,17 +1243,18 @@ export class Matterbridge extends EventEmitter {
      * Saves the plugin configuration to a JSON file.
      * @param plugin - The registered plugin.
      * @param config - The platform configuration.
-     * @returns A promise that resolves when the configuration is saved successfully, or rejects with an error.
+     * @returns A promise that resolves when the configuration is saved successfully, or with an error logged.
      */
     async savePluginConfigFromJson(plugin, config) {
         if (!config.name || !config.type || config.name !== plugin.name) {
-            this.log.error(`Error saving plugin ${plg}${plugin.name}${er} config`);
+            this.log.error(`Error saving plugin ${plg}${plugin.name}${er} config. Wrong config data content.`);
             return;
         }
         const configFile = path.join(this.matterbridgeDirectory, `${plugin.name}.config.json`);
         try {
             await this.writeFile(configFile, JSON.stringify(config, null, 2));
-            this.log.debug(`Saved config file: ${configFile}.\nConfig:${rs}\n`, config);
+            plugin.configJson = config;
+            this.log.debug(`Saved config file ${configFile} for plugin ${plg}${plugin.name}${db}.\nConfig:${rs}\n`, config);
         }
         catch (err) {
             this.log.error(`Error saving plugin ${plg}${plugin.name}${er} config: ${err}`);
@@ -1191,7 +1265,7 @@ export class Matterbridge extends EventEmitter {
      * Loads the configuration for a plugin.
      * If the configuration file exists, it reads the file and returns the parsed JSON data.
      * If the configuration file does not exist, it creates a new file with default configuration and returns it.
-     * If any error occurs during file access or creation, it logs an error and rejects the promise with the error.
+     * If any error occurs during file access or creation, it logs an error and return un empty config.
      *
      * @param plugin - The plugin for which to load the configuration.
      * @returns A promise that resolves to the loaded or created configuration.
@@ -1272,28 +1346,26 @@ export class Matterbridge extends EventEmitter {
      * @returns {Promise<void>} - A promise that resolves when the data is successfully written to the file.
      */
     async writeFile(filePath, data) {
-        // Write the data to a file
-        await fs
-            .writeFile(`${filePath}`, data, 'utf8')
-            .then(() => {
+        try {
+            await fs.writeFile(`${filePath}`, data, 'utf8');
             this.log.debug(`Successfully wrote to ${filePath}`);
-        })
-            .catch((error) => {
+        }
+        catch (error) {
             this.log.error(`Error writing to ${filePath}:`, error);
-        });
+        }
     }
     /**
      * Starts a plugin.
      *
      * @param {RegisteredPlugin} plugin - The plugin to start.
      * @param {string} [message] - Optional message to pass to the plugin's onStart method.
-     * @param {boolean} [configure=false] - Indicates whether to configure the plugin after starting.
+     * @param {boolean} [configure] - Indicates whether to configure the plugin after starting (default false).
      * @returns {Promise<void>} A promise that resolves when the plugin is started successfully, or rejects with an error if starting the plugin fails.
      */
     async startPlugin(plugin, message, configure = false) {
         if (!plugin.loaded || !plugin.platform) {
             this.log.error(`Plugin ${plg}${plugin.name}${er} not loaded or no platform`);
-            return Promise.reject(new Error(`Plugin ${plg}${plugin.name}${er} not loaded or no platform`));
+            return Promise.resolve();
         }
         if (plugin.started) {
             this.log.debug(`Plugin ${plg}${plugin.name}${db} already started`);
@@ -1313,13 +1385,13 @@ export class Matterbridge extends EventEmitter {
                 .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.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.resolve();
         }
     }
     /**
@@ -1331,7 +1403,7 @@ export class Matterbridge extends EventEmitter {
     async configurePlugin(plugin) {
         if (!plugin.loaded || !plugin.started || !plugin.platform) {
             this.log.error(`Plugin ${plg}${plugin.name}${er} not loaded (${plugin.loaded}) or not started (${plugin.started}) or not platform (${plugin.platform?.name})`);
-            return Promise.reject(new Error(`Plugin ${plg}${plugin.name}${er} not loaded or not started or not platform`));
+            return Promise.resolve();
         }
         if (plugin.configured) {
             this.log.info(`Plugin ${plg}${plugin.name}${nf} already configured`);
@@ -1350,13 +1422,13 @@ export class Matterbridge extends EventEmitter {
                 .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.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.resolve();
         }
     }
     /**
@@ -1370,7 +1442,7 @@ export class Matterbridge extends EventEmitter {
     async loadPlugin(plugin, start = false, message = '') {
         if (!plugin.enabled) {
             this.log.error(`Plugin ${plg}${plugin.name}${er} not enabled`);
-            return Promise.reject(new Error(`Plugin ${plg}${plugin.name}${er} not enabled`));
+            return Promise.resolve(undefined);
         }
         if (plugin.platform) {
             this.log.error(`Plugin ${plg}${plugin.name}${er} already loaded`);
@@ -1387,11 +1459,10 @@ export class Matterbridge extends EventEmitter {
             this.log.debug(`Importing plugin ${plg}${plugin.name}${db} from ${pluginUrl.href}`);
             const pluginInstance = await import(pluginUrl.href);
             this.log.debug(`Imported plugin ${plg}${plugin.name}${db} from ${pluginUrl.href}`);
-            // Call the default export function of the plugin, passing this MatterBridge instance
+            // Call the default export function of the plugin, passing this MatterBridge instance, the log and the config
             if (pluginInstance.default) {
                 const config = await this.loadPluginConfig(plugin);
                 const log = new AnsiLogger({ logName: plugin.description, logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logDebug: this.debugEnabled });
-                // log.setCallback(this.wssSendMessage.bind(this));
                 const platform = pluginInstance.default(this, log, config);
                 platform.name = packageJson.name;
                 platform.config = config;
@@ -1405,8 +1476,11 @@ export class Matterbridge extends EventEmitter {
                 plugin.loaded = true;
                 plugin.registeredDevices = 0;
                 plugin.addedDevices = 0;
+                plugin.configJson = config;
+                plugin.schemaJson = await this.loadPluginSchema(plugin);
+                // Save the updated plugin data in the node storage
                 await this.nodeContext?.set('plugins', await this.getBaseRegisteredPlugins());
-                await this.getPluginLatestVersion(plugin);
+                // this.getPluginLatestVersion(plugin); moved to parseCommandLine
                 this.log.info(`Loaded plugin ${plg}${plugin.name}${nf} type ${typ}${platform.type} ${db}(entrypoint ${UNDERLINE}${pluginEntry}${UNDERLINEOFF})`);
                 if (start)
                     this.startPlugin(plugin, message); // No await do it asyncronously
@@ -1415,15 +1489,13 @@ 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`));
+                return Promise.resolve(undefined);
             }
         }
         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}`));
+            return Promise.resolve(undefined);
         }
     }
     /**
@@ -1970,7 +2042,6 @@ export class Matterbridge extends EventEmitter {
                 vendorName = '(AppleKeyChain)';
                 break;
             case 4362:
-            case 65521:
                 vendorName = '(SmartThings)';
                 break;
             case 4939:
@@ -2496,8 +2567,10 @@ export class Matterbridge extends EventEmitter {
                 registeredDevices: plugin.registeredDevices,
                 qrPairingCode: plugin.qrPairingCode,
                 manualPairingCode: plugin.manualPairingCode,
-                configJson: includeConfigSchema ? await this.loadPluginConfig(plugin) : {},
-                schemaJson: includeConfigSchema ? await this.loadPluginSchema(plugin) : {},
+                // configJson: includeConfigSchema ? await this.loadPluginConfig(plugin) : {},
+                // schemaJson: includeConfigSchema ? await this.loadPluginSchema(plugin) : {},
+                configJson: includeConfigSchema ? plugin.configJson : {},
+                schemaJson: includeConfigSchema ? plugin.schemaJson : {},
             });
         }
         return baseRegisteredPlugins;
@@ -2723,11 +2796,14 @@ export class Matterbridge extends EventEmitter {
             }
             catch (error) {
                 if (this.bridgeMode === 'bridge')
-                    this.log.error('pairingCodes for /api/settings not found');
+                    this.log.warn('pairingCodes for /api/settings not found');
             }
             this.matterbridgeInformation.bridgeMode = this.bridgeMode;
             this.matterbridgeInformation.restartMode = this.restartMode;
             this.matterbridgeInformation.debugEnabled = this.debugEnabled;
+            this.matterbridgeInformation.matterbridgePaired = this.matterbridgePaired;
+            this.matterbridgeInformation.matterbridgeConnected = this.matterbridgeConnected;
+            // this.matterbridgeInformation.matterbridgeFabricInfo = this.matterbridgeFabricInfo;
             const response = { wssHost, qrPairingCode, manualPairingCode, systemInformation: this.systemInformation, matterbridgeInformation: this.matterbridgeInformation };
             this.log.debug('Response:', debugStringify(response));
             res.json(response);
@@ -2868,6 +2944,11 @@ export class Matterbridge extends EventEmitter {
                     this.debugEnabled = false;
                     Logger.defaultLogLevel = Level.INFO;
                 }
+                else if (param === 'Notice') {
+                    this.log.setLogDebug(false);
+                    this.debugEnabled = false;
+                    Logger.defaultLogLevel = Level.NOTICE;
+                }
                 else if (param === 'Warn') {
                     this.log.setLogDebug(false);
                     this.debugEnabled = false;
@@ -2878,6 +2959,11 @@ export class Matterbridge extends EventEmitter {
                     this.debugEnabled = false;
                     Logger.defaultLogLevel = Level.ERROR;
                 }
+                else if (param === 'Fatal') {
+                    this.log.setLogDebug(false);
+                    this.debugEnabled = false;
+                    Logger.defaultLogLevel = Level.FATAL;
+                }
                 this.registeredPlugins.forEach((plugin) => {
                     plugin.platform?.log.setLogDebug(this.debugEnabled);
                 });