matterbridge 1.6.1 → 1.6.3-dev.1

package/dist/matterbridge.js

@@ -25,32 +25,32 @@ import { fileURLToPath } from 'url';
 import { promises as fs } from 'fs';
 import { exec, spawn } from 'child_process';
 import { createServer } from 'http';
-import https from 'https';
 import EventEmitter from 'events';
-import express from 'express';
 import os from 'os';
 import path from 'path';
+import { randomBytes } from 'crypto';
+// Package modules
+import https from 'https';
+import express from 'express';
 import WebSocket, { WebSocketServer } from 'ws';
 // NodeStorage and AnsiLogger modules
 import { NodeStorageManager } from 'node-persist-manager';
-import { AnsiLogger, UNDERLINE, UNDERLINEOFF, YELLOW, db, debugStringify, stringify, BRIGHT, RESET, er, nf, rs, wr, RED, GREEN, zb, hk, or, idn, BLUE, CYAN, nt } from 'node-ansi-logger';
+import { AnsiLogger, UNDERLINE, UNDERLINEOFF, YELLOW, db, debugStringify, stringify, BRIGHT, RESET, er, nf, rs, wr, RED, GREEN, zb, CYAN, nt, idn, or, hk, BLUE } from 'node-ansi-logger';
 // Matterbridge
 import { MatterbridgeDevice } from './matterbridgeDevice.js';
-import { logInterfaces, wait, waiter, createZip, copyDirectory } from './utils/utils.js';
+import { WS_ID_LOG, WS_ID_REFRESH_NEEDED, WS_ID_RESTART_NEEDED, wsMessageHandler } from './matterbridgeWebsocket.js';
+import { logInterfaces, wait, waiter, createZip, copyDirectory, getParameter, getIntParameter, hasParameter } from './utils/utils.js';
 import { PluginManager } from './pluginManager.js';
 import { DeviceManager } from './deviceManager.js';
-// @project-chip/matter-node.js
-import { CommissioningController, CommissioningServer, MatterServer } from '@project-chip/matter-node.js';
-import { BasicInformationCluster, BridgedDeviceBasicInformation, BridgedDeviceBasicInformationCluster, ClusterServer, FixedLabelCluster, GeneralCommissioning, PowerSourceCluster, SwitchCluster, ThreadNetworkDiagnosticsCluster, getClusterNameById, } from '@project-chip/matter-node.js/cluster';
-import { DeviceTypeId, VendorId } from '@project-chip/matter-node.js/datatype';
-import { Aggregator, DeviceTypes, NodeStateInformation } from '@project-chip/matter-node.js/device';
-import { Format, Level, Logger } from '@project-chip/matter-node.js/log';
-import { ManualPairingCodeCodec, QrCodeSchema } from '@project-chip/matter-node.js/schema';
-import { StorageBackendDisk, StorageBackendJsonFile, StorageManager } from '@project-chip/matter-node.js/storage';
-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';
+import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
+// @matter
+import { DeviceTypeId, Logger, LogLevel as MatterLogLevel, LogFormat as MatterLogFormat, VendorId, StorageManager } from '@matter/main';
+import { BasicInformationCluster, BridgedDeviceBasicInformation, BridgedDeviceBasicInformationCluster, FixedLabelCluster, GeneralCommissioning, PowerSourceCluster, SwitchCluster, ThreadNetworkDiagnosticsCluster } from '@matter/main/clusters';
+import { getClusterNameById, ManualPairingCodeCodec, QrCodeSchema } from '@matter/main/types';
+import { StorageBackendDisk, StorageBackendJsonFile } from '@matter/nodejs';
+// @project-chip
+import { CommissioningController, CommissioningServer, MatterServer } from '@project-chip/matter.js';
+import { Aggregator, DeviceTypes, NodeStateInformation } from '@project-chip/matter.js/device';
 // Default colors
 const plg = '\u001B[38;5;33m';
 const dev = '\u001B[38;5;79m';
@@ -91,9 +91,11 @@ export class Matterbridge extends EventEmitter {
         matterbridgeConnected: false,
         bridgeMode: '',
         restartMode: '',
+        edge: hasParameter('edge'),
+        profile: getParameter('profile'),
         loggerLevel: "info" /* LogLevel.INFO */,
         fileLogger: false,
-        matterLoggerLevel: Level.INFO,
+        matterLoggerLevel: MatterLogLevel.INFO,
         matterFileLogger: false,
         mattermdnsinterface: undefined,
         matteripv4address: undefined,
@@ -117,6 +119,7 @@ export class Matterbridge extends EventEmitter {
     bridgeMode = '';
     restartMode = '';
     profile = getParameter('profile');
+    edge = hasParameter('edge');
     log;
     matterbrideLoggerFile = 'matterbridge' + (getParameter('profile') ? '.' + getParameter('profile') : '') + '.log';
     matterLoggerFile = 'matter' + (getParameter('profile') ? '.' + getParameter('profile') : '') + '.log';
@@ -157,8 +160,8 @@ export class Matterbridge extends EventEmitter {
     matterAggregator;
     commissioningServer;
     commissioningController;
-    aggregatorVendorId = VendorId(0xfff1);
-    aggregatorProductId = 0x8000;
+    aggregatorVendorId = VendorId(getIntParameter('vendorId') ?? 0xfff1);
+    aggregatorProductId = getIntParameter('productId') ?? 0x8000;
     static instance;
     // We load asyncronously so is private
     constructor() {
@@ -315,39 +318,39 @@ export class Matterbridge extends EventEmitter {
         if (hasParameter('matterlogger')) {
             const level = getParameter('matterlogger');
             if (level === 'debug') {
-                Logger.defaultLogLevel = Level.DEBUG;
+                Logger.defaultLogLevel = MatterLogLevel.DEBUG;
             }
             else if (level === 'info') {
-                Logger.defaultLogLevel = Level.INFO;
+                Logger.defaultLogLevel = MatterLogLevel.INFO;
             }
             else if (level === 'notice') {
-                Logger.defaultLogLevel = Level.NOTICE;
+                Logger.defaultLogLevel = MatterLogLevel.NOTICE;
             }
             else if (level === 'warn') {
-                Logger.defaultLogLevel = Level.WARN;
+                Logger.defaultLogLevel = MatterLogLevel.WARN;
             }
             else if (level === 'error') {
-                Logger.defaultLogLevel = Level.ERROR;
+                Logger.defaultLogLevel = MatterLogLevel.ERROR;
             }
             else if (level === 'fatal') {
-                Logger.defaultLogLevel = Level.FATAL;
+                Logger.defaultLogLevel = MatterLogLevel.FATAL;
             }
             else {
                 this.log.warn(`Invalid matter.js logger level: ${level}. Using default level "info".`);
-                Logger.defaultLogLevel = Level.INFO;
+                Logger.defaultLogLevel = MatterLogLevel.INFO;
             }
         }
         else {
-            Logger.defaultLogLevel = await this.nodeContext.get('matterLogLevel', Level.INFO);
+            Logger.defaultLogLevel = await this.nodeContext.get('matterLogLevel', MatterLogLevel.INFO);
         }
-        Logger.format = Format.ANSI;
+        Logger.format = MatterLogFormat.ANSI;
         Logger.setLogger('default', this.createMatterLogger());
         // Create the file logger for matter.js (context: matterFileLog)
         if (hasParameter('matterfilelogger') || (await this.nodeContext.get('matterFileLog', false))) {
             this.matterbridgeInformation.matterFileLogger = true;
             Logger.addLogger('matterfilelogger', await this.createMatterFileLogger(path.join(this.matterbridgeDirectory, this.matterLoggerFile), true), {
                 defaultLogLevel: Logger.defaultLogLevel,
-                logFormat: Format.PLAIN,
+                logFormat: MatterLogFormat.PLAIN,
             });
         }
         this.log.debug(`Matter logLevel: ${Logger.defaultLogLevel} fileLoger: ${this.matterbridgeInformation.matterFileLogger}.`);
@@ -500,6 +503,8 @@ export class Matterbridge extends EventEmitter {
                     this.log.info(`  └─ endpoint ${RED}${device.endpoint}${nf} ${typ}${device.endpointName}${nf} ${debugStringify(device.clusterServersId)}`);
                 }
             });
+            await this.cleanup('Exiting...');
+            process.exit(0);
             this.emit('shutdown');
             return;
         }
@@ -510,36 +515,48 @@ export class Matterbridge extends EventEmitter {
                 this.log.info(`${plg}${plugin.name}${nf} storage log`);
                 await plugin.nodeContext?.logStorage();
             }
+            await this.cleanup('Exiting...');
+            process.exit(0);
             this.emit('shutdown');
             return;
         }
         if (hasParameter('loginterfaces')) {
             this.log.info(`${plg}Matterbridge${nf} network interfaces log`);
             logInterfaces();
+            await this.cleanup('Exiting...');
+            process.exit(0);
             this.emit('shutdown');
             return;
         }
         if (getParameter('add')) {
             this.log.debug(`Adding plugin ${getParameter('add')}`);
             await this.plugins.add(getParameter('add'));
+            await this.cleanup('Exiting...');
+            process.exit(0);
             this.emit('shutdown');
             return;
         }
         if (getParameter('remove')) {
             this.log.debug(`Removing plugin ${getParameter('remove')}`);
             await this.plugins.remove(getParameter('remove'));
+            await this.cleanup('Exiting...');
+            process.exit(0);
             this.emit('shutdown');
             return;
         }
         if (getParameter('enable')) {
             this.log.debug(`Enabling plugin ${getParameter('enable')}`);
             await this.plugins.enable(getParameter('enable'));
+            await this.cleanup('Exiting...');
+            process.exit(0);
             this.emit('shutdown');
             return;
         }
         if (getParameter('disable')) {
             this.log.debug(`Disabling plugin ${getParameter('disable')}`);
             await this.plugins.disable(getParameter('disable'));
+            await this.cleanup('Exiting...');
+            process.exit(0);
             this.emit('shutdown');
             return;
         }
@@ -563,6 +580,8 @@ export class Matterbridge extends EventEmitter {
             this.nodeStorage = undefined;
             this.plugins.clear();
             this.devices.clear();
+            await this.cleanup('Exiting...');
+            process.exit(0);
             this.emit('shutdown');
             return;
         }
@@ -579,6 +598,8 @@ export class Matterbridge extends EventEmitter {
             await this.matterbridgeContext?.clearAll();
             await this.stopMatterStorage();
             this.log.info('Reset done! Remove the device from the controller.');
+            await this.cleanup('Exiting...');
+            process.exit(0);
             this.emit('shutdown');
             return;
         }
@@ -598,6 +619,8 @@ export class Matterbridge extends EventEmitter {
                 this.log.warn(`Plugin ${plg}${getParameter('reset')}${wr} not registerd in matterbridge`);
             }
             await this.stopMatterStorage();
+            await this.cleanup('Exiting...');
+            process.exit(0);
             this.emit('shutdown');
             return;
         }
@@ -632,6 +655,7 @@ export class Matterbridge extends EventEmitter {
         if (hasParameter('bridge') || (!hasParameter('childbridge') && (await this.nodeContext?.get('bridgeMode', '')) === 'bridge')) {
             this.bridgeMode = 'bridge';
             MatterbridgeDevice.bridgeMode = 'bridge';
+            MatterbridgeEndpoint.bridgeMode = 'bridge';
             this.log.debug(`Starting matterbridge in mode ${this.bridgeMode}`);
             await this.startBridge();
             return;
@@ -640,6 +664,7 @@ export class Matterbridge extends EventEmitter {
         if (hasParameter('childbridge') || (!hasParameter('bridge') && (await this.nodeContext?.get('bridgeMode', '')) === 'childbridge')) {
             this.bridgeMode = 'childbridge';
             MatterbridgeDevice.bridgeMode = 'childbridge';
+            MatterbridgeEndpoint.bridgeMode = 'childbridge';
             this.log.debug(`Starting matterbridge in mode ${this.bridgeMode}`);
             await this.startChildbridge();
             return;
@@ -695,12 +720,12 @@ export class Matterbridge extends EventEmitter {
         process.removeAllListeners('unhandledRejection');
         this.exceptionHandler = async (error) => {
             this.log.fatal('Unhandled Exception detected at:', error.stack || error, rs);
-            await this.cleanup('Unhandled Exception detected, cleaning up...');
+            // await this.cleanup('Unhandled Exception detected, cleaning up...');
         };
         process.on('uncaughtException', this.exceptionHandler);
         this.rejectionHandler = async (reason, promise) => {
             this.log.fatal('Unhandled Rejection detected at:', promise, 'reason:', reason instanceof Error ? reason.stack : reason, rs);
-            await this.cleanup('Unhandled Rejection detected, cleaning up...');
+            // await this.cleanup('Unhandled Rejection detected, cleaning up...');
         };
         process.on('unhandledRejection', this.rejectionHandler);
         this.log.debug(`Registering SIGINT and SIGTERM signal handlers...`);
@@ -993,22 +1018,22 @@ export class Matterbridge extends EventEmitter {
             const message = formattedLog.slice(65);
             matterLogger.logName = logger;
             switch (_level) {
-                case Level.DEBUG:
+                case MatterLogLevel.DEBUG:
                     matterLogger.log("debug" /* LogLevel.DEBUG */, message);
                     break;
-                case Level.INFO:
+                case MatterLogLevel.INFO:
                     matterLogger.log("info" /* LogLevel.INFO */, message);
                     break;
-                case Level.NOTICE:
+                case MatterLogLevel.NOTICE:
                     matterLogger.log("notice" /* LogLevel.NOTICE */, message);
                     break;
-                case Level.WARN:
+                case MatterLogLevel.WARN:
                     matterLogger.log("warn" /* LogLevel.WARN */, message);
                     break;
-                case Level.ERROR:
+                case MatterLogLevel.ERROR:
                     matterLogger.log("error" /* LogLevel.ERROR */, message);
                     break;
-                case Level.FATAL:
+                case MatterLogLevel.FATAL:
                     matterLogger.log("fatal" /* LogLevel.FATAL */, message);
                     break;
                 default:
@@ -1050,22 +1075,22 @@ export class Matterbridge extends EventEmitter {
             const logger = parts[1];
             const finalMessage = parts.slice(2).join(' ') + os.EOL;
             switch (_level) {
-                case Level.DEBUG:
+                case MatterLogLevel.DEBUG:
                     await fs.appendFile(filePath, `[${timestamp}] [${logger}] [debug] ${finalMessage}`);
                     break;
-                case Level.INFO:
+                case MatterLogLevel.INFO:
                     await fs.appendFile(filePath, `[${timestamp}] [${logger}] [info] ${finalMessage}`);
                     break;
-                case Level.NOTICE:
+                case MatterLogLevel.NOTICE:
                     await fs.appendFile(filePath, `[${timestamp}] [${logger}] [notice] ${finalMessage}`);
                     break;
-                case Level.WARN:
+                case MatterLogLevel.WARN:
                     await fs.appendFile(filePath, `[${timestamp}] [${logger}] [warn] ${finalMessage}`);
                     break;
-                case Level.ERROR:
+                case MatterLogLevel.ERROR:
                     await fs.appendFile(filePath, `[${timestamp}] [${logger}] [error] ${finalMessage}`);
                     break;
-                case Level.FATAL:
+                case MatterLogLevel.FATAL:
                     await fs.appendFile(filePath, `[${timestamp}] [${logger}] [fatal] ${finalMessage}`);
                     break;
                 default:
@@ -1280,6 +1305,18 @@ export class Matterbridge extends EventEmitter {
             this.initialized = false;
         }
     }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async addBridgedEndpoint(pluginName, device) {
+        // Nothing to do here
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async removeBridgedEndpoint(pluginName, device) {
+        // Nothing to do here
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async removeAllBridgedEndpoints(pluginName) {
+        // Nothing to do here
+    }
     /**
      * Adds a bridged device to the Matterbridge.
      * @param pluginName - The name of the plugin.
@@ -1955,39 +1992,52 @@ export class Matterbridge extends EventEmitter {
      * @param {StorageContext} context - The storage context.
      * @returns {Aggregator} - The created Matter Aggregator.
      */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     async createMatterAggregator(context, pluginName) {
-        const random = 'AG' + CryptoNode.getRandomData(8).toHex();
+        /*
+        const random = randomBytes(8).toString('hex');
         await context.set('aggregatorSerialNumber', await context.get('aggregatorSerialNumber', random));
         await context.set('aggregatorUniqueId', await context.get('aggregatorUniqueId', random));
-        this.log.debug(`Creating matter aggregator for plugin ${plg}${pluginName}${db} with uniqueId ${await context.get('aggregatorUniqueId')} serialNumber ${await context.get('aggregatorSerialNumber')}`);
-        this.log.debug(`Creating matter aggregator for plugin ${plg}${pluginName}${db} with softwareVersion ${await context.get('softwareVersion', 1)} softwareVersionString ${await context.get('softwareVersionString', '1.0.0')}`);
-        this.log.debug(`Creating matter aggregator for plugin ${plg}${pluginName}${db} with hardwareVersion ${await context.get('hardwareVersion', 1)} hardwareVersionString ${await context.get('hardwareVersionString', '1.0.0')}`);
+    
+        this.log.debug(`Creating matter aggregator for plugin ${plg}${pluginName}${db} with uniqueId ${await context.get<string>('aggregatorUniqueId')} serialNumber ${await context.get<string>('aggregatorSerialNumber')}`);
+        this.log.debug(`Creating matter aggregator for plugin ${plg}${pluginName}${db} with softwareVersion ${await context.get<number>('softwareVersion', 1)} softwareVersionString ${await context.get<string>('softwareVersionString', '1.0.0')}`);
+        this.log.debug(`Creating matter aggregator for plugin ${plg}${pluginName}${db} with hardwareVersion ${await context.get<number>('hardwareVersion', 1)} hardwareVersionString ${await context.get<string>('hardwareVersionString', '1.0.0')}`);
+        */
         const matterAggregator = new Aggregator();
-        matterAggregator.addClusterServer(ClusterServer(BasicInformationCluster, {
-            dataModelRevision: 1,
-            location: 'FR',
-            vendorId: VendorId(0xfff1),
-            vendorName: 'Matterbridge',
-            productId: 0x8000,
-            productName: 'Matterbridge aggregator',
-            productLabel: 'Matterbridge aggregator',
-            nodeLabel: 'Matterbridge aggregator',
-            serialNumber: await context.get('aggregatorSerialNumber'),
-            uniqueId: await context.get('aggregatorUniqueId'),
-            softwareVersion: await context.get('softwareVersion', 1),
-            softwareVersionString: await context.get('softwareVersionString', '1.0.0'),
-            hardwareVersion: await context.get('hardwareVersion', 1),
-            hardwareVersionString: await context.get('hardwareVersionString', '1.0.0'),
-            reachable: true,
-            capabilityMinima: { caseSessionsPerFabric: 3, subscriptionsPerFabric: 3 },
-            specificationVersion: Specification.SPECIFICATION_VERSION,
-            maxPathsPerInvoke: 1,
-        }, {}, {
-            startUp: true,
-            shutDown: true,
-            leave: true,
-            reachableChanged: true,
-        }));
+        /*
+        matterAggregator.addClusterServer(
+          ClusterServer(
+            BasicInformationCluster,
+            {
+              dataModelRevision: 1,
+              location: 'FR',
+              vendorId: VendorId(0xfff1),
+              vendorName: 'Matterbridge',
+              productId: 0x8000,
+              productName: 'Matterbridge aggregator',
+              productLabel: 'Matterbridge aggregator',
+              nodeLabel: 'Matterbridge aggregator',
+              serialNumber: await context.get<string>('aggregatorSerialNumber'),
+              uniqueId: await context.get<string>('aggregatorUniqueId'),
+              softwareVersion: await context.get<number>('softwareVersion', 1),
+              softwareVersionString: await context.get<string>('softwareVersionString', '1.0.0'),
+              hardwareVersion: await context.get<number>('hardwareVersion', 1),
+              hardwareVersionString: await context.get<string>('hardwareVersionString', '1.0.0'),
+              reachable: true,
+              capabilityMinima: { caseSessionsPerFabric: 3, subscriptionsPerFabric: 3 },
+              specificationVersion: Specification.SPECIFICATION_VERSION,
+              maxPathsPerInvoke: 1,
+            },
+            {},
+            {
+              startUp: true,
+              shutDown: true,
+              leave: true,
+              reachableChanged: true,
+            },
+          ),
+        );
+        */
         return matterAggregator;
     }
     /**
@@ -2180,7 +2230,7 @@ export class Matterbridge extends EventEmitter {
         if (!this.storageManager)
             throw new Error('No storage manager initialized');
         this.log.debug(`Creating commissioning server storage context for ${plg}${pluginName}${db}`);
-        const random = 'CS' + CryptoNode.getRandomData(8).toHex();
+        const random = randomBytes(8).toString('hex');
         const storageContext = this.storageManager.createContext(pluginName);
         await storageContext.set('deviceName', deviceName);
         await storageContext.set('deviceType', deviceType);
@@ -3122,22 +3172,22 @@ export class Matterbridge extends EventEmitter {
             if (command === 'setmjloglevel') {
                 this.log.debug('Matter.js log level:', param);
                 if (param === 'Debug') {
-                    Logger.defaultLogLevel = Level.DEBUG;
+                    Logger.defaultLogLevel = MatterLogLevel.DEBUG;
                 }
                 else if (param === 'Info') {
-                    Logger.defaultLogLevel = Level.INFO;
+                    Logger.defaultLogLevel = MatterLogLevel.INFO;
                 }
                 else if (param === 'Notice') {
-                    Logger.defaultLogLevel = Level.NOTICE;
+                    Logger.defaultLogLevel = MatterLogLevel.NOTICE;
                 }
                 else if (param === 'Warn') {
-                    Logger.defaultLogLevel = Level.WARN;
+                    Logger.defaultLogLevel = MatterLogLevel.WARN;
                 }
                 else if (param === 'Error') {
-                    Logger.defaultLogLevel = Level.ERROR;
+                    Logger.defaultLogLevel = MatterLogLevel.ERROR;
                 }
                 else if (param === 'Fatal') {
-                    Logger.defaultLogLevel = Level.FATAL;
+                    Logger.defaultLogLevel = MatterLogLevel.FATAL;
                 }
                 await this.nodeContext?.set('matterLogLevel', Logger.defaultLogLevel);
                 res.json({ message: 'Command received' });
@@ -3191,8 +3241,8 @@ export class Matterbridge extends EventEmitter {
                 if (param === 'true') {
                     try {
                         Logger.addLogger('matterfilelogger', await this.createMatterFileLogger(path.join(this.matterbridgeDirectory, this.matterLoggerFile), true), {
-                            defaultLogLevel: Level.DEBUG,
-                            logFormat: Format.PLAIN,
+                            defaultLogLevel: MatterLogLevel.DEBUG,
+                            logFormat: MatterLogFormat.PLAIN,
                         });
                     }
                     catch (error) {
@@ -3480,8 +3530,8 @@ export class Matterbridge extends EventEmitter {
         await this.logNodeAndSystemInfo();
         this.matterbridgeDirectory = dataPath;
         // Set matter.js logger level and format
-        Logger.defaultLogLevel = Level.INFO;
-        Logger.format = Format.ANSI;
+        Logger.defaultLogLevel = MatterLogLevel.INFO;
+        Logger.format = MatterLogFormat.ANSI;
         // Start the storage and create matterbridgeContext
         await this.startMatterStorage('json', path.join(this.matterbridgeDirectory, this.matterStorageName));
         if (!this.storageManager)