matterbridge 1.2.12 → 1.2.13

package/dist/matterbridge.js

@@ -32,8 +32,9 @@ import express from 'express';
 import os from 'os';
 import path from 'path';
 import WebSocket, { WebSocketServer } from 'ws';
+import { BridgedDeviceBasicInformation, BridgedDeviceBasicInformationCluster } from './BridgedDeviceBasicInformationCluster.js';
 import { CommissioningController, CommissioningServer, MatterServer } from '@project-chip/matter-node.js';
-import { BasicInformationCluster, BooleanStateCluster, BridgedDeviceBasicInformation, BridgedDeviceBasicInformationCluster, ClusterServer, FixedLabelCluster, GeneralCommissioning, PowerSourceCluster, ThreadNetworkDiagnosticsCluster, getClusterNameById, } from '@project-chip/matter-node.js/cluster';
+import { BasicInformationCluster, BooleanStateCluster, ClusterServer, FixedLabelCluster, GeneralCommissioning, GeneralDiagnostics, GeneralDiagnosticsCluster, PowerSourceCluster, 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';
@@ -655,7 +656,7 @@ export class Matterbridge extends EventEmitter {
                 if (plugin.platform) {
                     try {
                         await plugin.platform.onShutdown('Matterbridge is closing: ' + message);
-                        await this.savePluginConfig(plugin);
+                        // await this.savePluginConfig(plugin);
                     }
                     catch (error) {
                         this.log.error(`Plugin ${plg}${plugin.name}${er} shutting down error: ${error}`);
@@ -1266,6 +1267,7 @@ export class Matterbridge extends EventEmitter {
                 .then(() => {
                 plugin.configured = true;
                 this.log.info(`Configured plugin ${plg}${plugin.name}${db} type ${typ}${plugin.type}${db}`);
+                this.savePluginConfig(plugin);
                 return Promise.resolve();
             })
                 .catch((err) => {
@@ -1297,7 +1299,7 @@ export class Matterbridge extends EventEmitter {
             this.log.error(`Plugin ${plg}${plugin.name}${er} already loaded`);
             return Promise.resolve(plugin.platform);
         }
-        this.log.info(`Loading plugin ${plg}${plugin.name}${db} type ${typ}${plugin.type}${db}`);
+        this.log.info(`Loading plugin ${plg}${plugin.name}${nf} type ${typ}${plugin.type}${nf}`);
         try {
             // Load the package.json of the plugin
             const packageJson = JSON.parse(await fs.readFile(plugin.path, 'utf8'));
@@ -1316,6 +1318,7 @@ export class Matterbridge extends EventEmitter {
                 const platform = pluginInstance.default(this, log, config);
                 platform.name = packageJson.name;
                 platform.config = config;
+                platform.version = packageJson.version;
                 plugin.name = packageJson.name;
                 plugin.description = packageJson.description;
                 plugin.version = packageJson.version;
@@ -1326,7 +1329,19 @@ export class Matterbridge extends EventEmitter {
                 plugin.registeredDevices = 0;
                 plugin.addedDevices = 0;
                 await this.nodeContext?.set('plugins', this.getBaseRegisteredPlugins());
-                this.log.info(`Loaded plugin ${plg}${plugin.name}${db} type ${typ}${platform.type}${db} (entrypoint ${UNDERLINE}${pluginEntry}${UNDERLINEOFF})`);
+                this.getLatestVersion(plugin.name)
+                    .then(async (latestVersion) => {
+                    plugin.latestVersion = latestVersion;
+                    await this.nodeContext?.set('plugins', this.getBaseRegisteredPlugins());
+                    if (plugin.version !== latestVersion)
+                        this.log.warn(`The plugin ${plg}${plugin.name}${wr} is out of date. Current version: ${plugin.version}, Latest version: ${latestVersion}`);
+                    else
+                        this.log.info(`The plugin ${plg}${plugin.name}${nf} is up to date. Current version: ${plugin.version}, Latest version: ${latestVersion}`);
+                })
+                    .catch((error) => {
+                    this.log.error(`Error getting ${plugin.name} latest version: ${error}`);
+                });
+                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
                 return Promise.resolve(platform);
@@ -1568,6 +1583,7 @@ export class Matterbridge extends EventEmitter {
                 await this.startMatterServer();
                 this.log.info('Matter server started');
                 await this.showCommissioningQRCode(this.commissioningServer, this.matterbridgeContext, this.nodeContext, 'Matterbridge');
+                // logEndpoint(this.commissioningServer.getRootEndpoint());
                 //if (hasParameter('advertise')) await this.commissioningServer.advertise();
                 setTimeout(() => {
                     this.log.info(`Setting reachability to true for ${plg}Matterbridge${db}`);
@@ -1773,14 +1789,14 @@ export class Matterbridge extends EventEmitter {
         if (!commissioningServer || !storageContext || !pluginName)
             return;
         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();
             await storageContext.set('qrPairingCode', qrPairingCode);
             await storageContext.set('manualPairingCode', manualPairingCode);
             await nodeContext.set('qrPairingCode', qrPairingCode);
             await nodeContext.set('manualPairingCode', manualPairingCode);
             const QrCode = new QrCodeSchema();
-            this.log.info(`Pairing code:\n\n${QrCode.encode(qrPairingCode)}\n${plg}${pluginName}${nf}\n\nqrPairingCode: ${qrPairingCode}\n\nManual pairing code: ${manualPairingCode}\n`);
+            this.log.info(`***The commissioning server on port ${commissioningServer.getPort()} for ${plg}${pluginName}${nf} is not commissioned. Pair it scanning the QR code:\n\n` +
+                `${QrCode.encode(qrPairingCode)}\n${plg}${pluginName}${nf}\n\nqrPairingCode: ${qrPairingCode}\n\nManual pairing code: ${manualPairingCode}\n`);
             if (pluginName !== 'Matterbridge') {
                 const plugin = this.findPlugin(pluginName);
                 if (plugin) {
@@ -1875,6 +1891,9 @@ export class Matterbridge extends EventEmitter {
                 case 4937:
                     vendorName = '(AppleHome)';
                     break;
+                case 4996:
+                    vendorName = '(AppleKeyChain)';
+                    break;
                 case 4362:
                     vendorName = '(SmartThings)';
                     break;
@@ -1996,7 +2015,7 @@ export class Matterbridge extends EventEmitter {
                             }
                             Logger.defaultLogLevel = this.debugEnabled ? Level.DEBUG : Level.INFO;
                         }
-                        //logEndpoint(commissioningServer.getRootEndpoint());
+                        // logEndpoint(commissioningServer.getRootEndpoint());
                     }, 2000);
                 }
             },
@@ -2023,6 +2042,23 @@ export class Matterbridge extends EventEmitter {
                 }
             },
         });
+        const gdcCluster = commissioningServer.getRootClusterServer(GeneralDiagnosticsCluster);
+        if (gdcCluster) {
+            gdcCluster.setNetworkInterfacesAttribute([
+                {
+                    name: 'eth0',
+                    isOperational: true,
+                    offPremiseServicesReachableIPv4: null,
+                    offPremiseServicesReachableIPv6: null,
+                    hardwareAddress: Uint8Array.fromString('00000000'),
+                    iPv4Addresses: [Uint8Array.fromString('0000')],
+                    iPv6Addresses: [Uint8Array.fromString('0000000000000000')],
+                    type: GeneralDiagnostics.InterfaceType.Ethernet,
+                },
+            ]);
+        }
+        else
+            this.log.warn(`*GeneralDiagnosticsCluster not found for ${plg}${pluginName}${wr}`);
         commissioningServer.addCommandHandler('testEventTrigger', async ({ request: { enableKey, eventTrigger } }) => this.log.info(`testEventTrigger called on GeneralDiagnostic cluster: ${enableKey} ${eventTrigger}`));
         return commissioningServer;
     }
@@ -2049,7 +2085,7 @@ export class Matterbridge extends EventEmitter {
         const matterAggregator = new Aggregator();
         matterAggregator.addClusterServer(ClusterServer(BasicInformationCluster, {
             dataModelRevision: 1,
-            location: 'XX',
+            location: 'FR',
             vendorId: VendorId(0xfff1),
             vendorName: 'Matterbridge',
             productId: 0x8000,
@@ -2286,6 +2322,7 @@ export class Matterbridge extends EventEmitter {
             type: plugin.type,
             name: plugin.name,
             version: plugin.version,
+            latestVersion: plugin.latestVersion,
             description: plugin.description,
             author: plugin.author,
             enabled: plugin.enabled,
@@ -2657,6 +2694,11 @@ export class Matterbridge extends EventEmitter {
                     this.debugEnabled = false;
                     Logger.defaultLogLevel = Level.WARN;
                 }
+                else if (param === 'Error') {
+                    this.log.setLogDebug(false);
+                    this.debugEnabled = false;
+                    Logger.defaultLogLevel = Level.ERROR;
+                }
                 this.registeredPlugins.forEach((plugin) => {
                     plugin.platform?.log.setLogDebug(this.debugEnabled);
                 });
@@ -2710,7 +2752,7 @@ export class Matterbridge extends EventEmitter {
                 }
             }
             // Handle the command addplugin from Home
-            if (command === 'addplugin') {
+            if (command === 'addplugin' || command === 'installplugin') {
                 param = param.replace(/\*/g, '\\');
                 if (this.registeredPlugins.find((plugin) => plugin.name === param)) {
                     this.log.warn(`Plugin ${plg}${param}${wr} already added to matterbridge`);
@@ -2749,7 +2791,7 @@ export class Matterbridge extends EventEmitter {
                 if (index !== -1) {
                     if (this.registeredPlugins[index].platform) {
                         await this.registeredPlugins[index].platform?.onShutdown('The plugin has been removed.');
-                        await this.savePluginConfig(this.registeredPlugins[index]);
+                        // await this.savePluginConfig(this.registeredPlugins[index]);
                     }
                     this.registeredPlugins.splice(index, 1);
                     await this.nodeContext?.set('plugins', this.getBaseRegisteredPlugins());
@@ -2799,7 +2841,7 @@ export class Matterbridge extends EventEmitter {
                 if (pluginToDisable) {
                     if (pluginToDisable.platform) {
                         await pluginToDisable.platform.onShutdown('The plugin has been removed.');
-                        await this.savePluginConfig(pluginToDisable);
+                        // await this.savePluginConfig(pluginToDisable);
                     }
                     pluginToDisable.enabled = false;
                     pluginToDisable.error = undefined;