matterbridge 1.2.11 → 1.2.12

package/dist/matterbridge.js

@@ -33,9 +33,7 @@ import os from 'os';
 import path from 'path';
 import WebSocket, { WebSocketServer } from 'ws';
 import { CommissioningController, CommissioningServer, MatterServer } from '@project-chip/matter-node.js';
-import { BasicInformationCluster, BooleanStateCluster, 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-BridgedDeviceBasicInformation, BridgedDeviceBasicInformationCluster, ClusterServer, GeneralCommissioning, PowerSourceCluster, ThreadNetworkDiagnosticsCluster, getClusterNameById, } from '@project-chip/matter-node.js/cluster';
+import { BasicInformationCluster, BooleanStateCluster, BridgedDeviceBasicInformation, BridgedDeviceBasicInformationCluster, ClusterServer, FixedLabelCluster, GeneralCommissioning, 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';
@@ -190,7 +188,7 @@ export class Matterbridge extends EventEmitter {
         await this.showCommissioningQRCode(this.commissioningServer, this.matterbridgeContext, this.nodeContext, 'Matterbridge');
         // Set reachability to true and trigger event after 60 seconds
         setTimeout(() => {
-            this.log.info(`*Setting reachability to true for ${plg}Matterbridge${db}`);
+            this.log.info(`Setting reachability to true for ${plg}Matterbridge${db}`);
             if (this.commissioningServer)
                 this.setCommissioningServerReachability(this.commissioningServer, true);
             if (this.matterAggregator)
@@ -367,7 +365,7 @@ export class Matterbridge extends EventEmitter {
             // Delete matter storage file
             await fs.unlink(path.join(this.matterbridgeDirectory, 'matterbridge.json'));
             // Delete node storage directory with its subdirectories
-            await fs.rmdir(path.join(this.matterbridgeDirectory, 'storage'), { recursive: true });
+            await fs.rm(path.join(this.matterbridgeDirectory, 'storage'), { recursive: true });
             this.log.info('Factory reset done! Remove all paired devices from the controllers.');
             this.emit('shutdown');
             process.exit(0);
@@ -611,6 +609,31 @@ export class Matterbridge extends EventEmitter {
         await this.cleanup('shutting down...', false);
         this.hasCleanupStarted = false;
     }
+    /**
+     * Shut down the process and reset.
+     */
+    async unregisterAndShutdownProcess() {
+        this.log.info('Unregistering all devices and shutting down...');
+        for (const plugin of this.registeredPlugins.filter((plugin) => plugin.enabled && !plugin.error)) {
+            await this.removeAllBridgedDevices(plugin.name);
+        }
+        await this.cleanup('unregistered all devices and shutting down...', false);
+        this.hasCleanupStarted = false;
+    }
+    /**
+     * Shut down the process and reset.
+     */
+    async shutdownProcessAndReset() {
+        await this.cleanup('shutting down with reset...', false);
+        this.hasCleanupStarted = false;
+    }
+    /**
+     * Shut down the process and factory reset.
+     */
+    async shutdownProcessAndFactoryReset() {
+        await this.cleanup('shutting down with factory reset...', false);
+        this.hasCleanupStarted = false;
+    }
     /**
      * Cleans up the Matterbridge instance.
      * @param message - The cleanup message.
@@ -628,7 +651,7 @@ export class Matterbridge extends EventEmitter {
             for (const plugin of this.registeredPlugins) {
                 if (!plugin.enabled || plugin.error)
                     continue;
-                this.log.info(`*Shutting down plugin ${plg}${plugin.name}${nf}`);
+                this.log.info(`Shutting down plugin ${plg}${plugin.name}${nf}`);
                 if (plugin.platform) {
                     try {
                         await plugin.platform.onShutdown('Matterbridge is closing: ' + message);
@@ -710,7 +733,7 @@ export class Matterbridge extends EventEmitter {
                 });
                 this.webSocketServer = undefined;
             }
-            /*const cleanupTimeout1 =*/ setTimeout(async () => {
+            setTimeout(async () => {
                 // Closing matter
                 await this.stopMatter();
                 // Closing storage
@@ -740,7 +763,7 @@ export class Matterbridge extends EventEmitter {
                 this.registeredPlugins = [];
                 this.registeredDevices = [];
                 this.log.info('Waiting for matter to deliver last messages...');
-                /*const cleanupTimeout2 =*/ setTimeout(async () => {
+                setTimeout(async () => {
                     if (restart) {
                         if (message === 'updating...') {
                             this.log.info('Cleanup completed. Updating...');
@@ -754,14 +777,27 @@ export class Matterbridge extends EventEmitter {
                         }
                     }
                     else {
+                        if (message === 'shutting down with reset...') {
+                            // Delete matter storage file
+                            this.log.info('Resetting Matterbridge commissioning information...');
+                            await fs.unlink(path.join(this.matterbridgeDirectory, 'matterbridge.json'));
+                            this.log.info('Reset done! Remove all paired devices from the controllers.');
+                        }
+                        if (message === 'shutting down with factory reset...') {
+                            // Delete matter storage file
+                            this.log.info('Resetting Matterbridge commissioning information...');
+                            await fs.unlink(path.join(this.matterbridgeDirectory, 'matterbridge.json'));
+                            // Delete node storage directory with its subdirectories
+                            this.log.info('Resetting Matterbridge storage...');
+                            await fs.rm(path.join(this.matterbridgeDirectory, 'storage'), { recursive: true });
+                            this.log.info('Factory reset done! Remove all paired devices from the controllers.');
+                        }
                         this.log.info('Cleanup completed. Shutting down...');
                         Matterbridge.instance = undefined;
                         this.emit('shutdown');
                     }
                 }, 2 * 1000);
-                //cleanupTimeout2.unref();
             }, 3 * 1000);
-            //cleanupTimeout1.unref();
         }
     }
     /**
@@ -911,7 +947,7 @@ export class Matterbridge extends EventEmitter {
     async removeAllBridgedDevices(pluginName) {
         const plugin = this.findPlugin(pluginName);
         if (this.bridgeMode === 'childbridge' && plugin?.type === 'AccessoryPlatform') {
-            this.log.info(`Removing devices for plugin ${plg}${pluginName}${nf}: AccessoryPlatform not supported in childbridge mode`);
+            this.log.info(`Removing devices for plugin ${plg}${pluginName}${nf} type AccessoryPlatform is not supported in childbridge mode`);
             return;
         }
         const devicesToRemove = [];
@@ -1534,7 +1570,7 @@ export class Matterbridge extends EventEmitter {
                 await this.showCommissioningQRCode(this.commissioningServer, this.matterbridgeContext, this.nodeContext, 'Matterbridge');
                 //if (hasParameter('advertise')) await this.commissioningServer.advertise();
                 setTimeout(() => {
-                    this.log.info(`*Setting reachability to true for ${plg}Matterbridge${db}`);
+                    this.log.info(`Setting reachability to true for ${plg}Matterbridge${db}`);
                     if (this.commissioningServer)
                         this.setCommissioningServerReachability(this.commissioningServer, true);
                     if (this.matterAggregator)
@@ -1637,7 +1673,7 @@ export class Matterbridge extends EventEmitter {
                     }
                     await this.showCommissioningQRCode(plugin.commissioningServer, plugin.storageContext, plugin.nodeContext, plugin.name);
                     // Setting reachability to true
-                    this.log.info(`*Setting reachability to true for ${plg}${plugin.name}${db}`);
+                    this.log.info(`Setting reachability to true for ${plg}${plugin.name}${db}`);
                     if (plugin.commissioningServer)
                         this.setCommissioningServerReachability(plugin.commissioningServer, true);
                     if (plugin.type === 'AccessoryPlatform' && plugin.device)
@@ -1756,7 +1792,7 @@ export class Matterbridge extends EventEmitter {
             await this.nodeContext?.set('plugins', this.getBaseRegisteredPlugins());
         }
         else {
-            this.log.info(`***The commissioning server on port ${commissioningServer.getPort()} for ${plg}${pluginName}${nf} is already commissioned . Waiting for controllers to connect ...`);
+            this.log.info(`*The commissioning server on port ${commissioningServer.getPort()} for ${plg}${pluginName}${nf} is already commissioned . Waiting for controllers to connect ...`);
             if (pluginName !== 'Matterbridge') {
                 const plugin = this.findPlugin(pluginName);
                 if (plugin) {
@@ -1805,7 +1841,7 @@ export class Matterbridge extends EventEmitter {
         if (basicInformationCluster && basicInformationCluster.triggerReachableChangedEvent)
             basicInformationCluster.triggerReachableChangedEvent({ reachableNewValue: reachable });
         matterAggregator.getBridgedDevices().forEach((device) => {
-            this.log.debug(`*Setting reachability to true for bridged device: ${dev}${device.name}${nf}`);
+            this.log.debug(`Setting reachability to true for bridged device: ${dev}${device.name}${nf}`);
             device.getClusterServer(BridgedDeviceBasicInformationCluster)?.setReachableAttribute(reachable);
             device.getClusterServer(BridgedDeviceBasicInformationCluster)?.triggerReachableChangedEvent({ reachableNewValue: reachable });
         });
@@ -1831,6 +1867,35 @@ export class Matterbridge extends EventEmitter {
      * @returns {CommissioningServer} The created commissioning server.
      */
     async createCommisioningServer(context, pluginName) {
+        const getVendorIdName = (vendorId) => {
+            if (!vendorId)
+                return '';
+            let vendorName = '';
+            switch (vendorId) {
+                case 4937:
+                    vendorName = '(AppleHome)';
+                    break;
+                case 4362:
+                    vendorName = '(SmartThings)';
+                    break;
+                case 4939:
+                    vendorName = '(HomeAssistant)';
+                    break;
+                case 24582:
+                    vendorName = '(GoogleHome)';
+                    break;
+                case 4701:
+                    vendorName = '(Tuya)';
+                    break;
+                case 4742:
+                    vendorName = '(eWeLink)';
+                    break;
+                default:
+                    vendorName = '(unknown)';
+                    break;
+            }
+            return vendorName;
+        };
         this.log.debug(`Creating matter commissioning server for plugin ${plg}${pluginName}${db}`);
         const deviceName = await context.get('deviceName');
         const deviceType = await context.get('deviceType');
@@ -1873,16 +1938,9 @@ export class Matterbridge extends EventEmitter {
                 const info = commissioningServer.getActiveSessionInformation(fabricIndex);
                 let connected = false;
                 info.forEach((session) => {
-                    this.log.info(`***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}${getVendorIdName(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)
-                            controllerName = 'AppleHome';
-                        if (session.fabric?.rootVendorId === 4362)
-                            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} on session ${session.name}`);
+                        this.log.info(`*Controller ${session.fabric?.rootVendorId}${getVendorIdName(session.fabric?.rootVendorId)}/${session.fabric?.label} connected to ${plg}${pluginName}${nf} on session ${session.name}`);
                         connected = true;
                     }
                 });
@@ -1944,9 +2002,9 @@ export class Matterbridge extends EventEmitter {
             },
             commissioningChangedCallback: async (fabricIndex) => {
                 const info = commissioningServer.getCommissionedFabricInformation(fabricIndex);
-                this.log.debug(`***Commissioning changed on fabric ${fabricIndex} for ${plg}${pluginName}${nf}`, debugStringify(info));
+                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}${wr}. 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();
@@ -1961,7 +2019,7 @@ export class Matterbridge extends EventEmitter {
                             }
                         }
                     }
-                    this.log.warn(`***Restart to activate the pairing for ${plg}${pluginName}${wr}`);
+                    this.log.warn(`*Restart to activate the pairing for ${plg}${pluginName}${wr}`);
                 }
             },
         });
@@ -2522,6 +2580,7 @@ export class Matterbridge extends EventEmitter {
                                 //console.log(error);
                             }
                             data.push({
+                                endpoint: registeredDevice.device.number ? registeredDevice.device.number.toString() : '...',
                                 clusterName: clusterServer.name,
                                 clusterId: '0x' + clusterServer.id.toString(16).padStart(2, '0'),
                                 attributeName: key,
@@ -2530,6 +2589,37 @@ export class Matterbridge extends EventEmitter {
                             });
                         });
                     });
+                    registeredDevice.device.getChildEndpoints().forEach((childEndpoint) => {
+                        const name = registeredDevice.device.getChildEndpointName(childEndpoint);
+                        const clusterServers = childEndpoint.getAllClusterServers();
+                        clusterServers.forEach((clusterServer) => {
+                            Object.entries(clusterServer.attributes).forEach(([key, value]) => {
+                                if (clusterServer.name === 'EveHistory')
+                                    return;
+                                //this.log.debug(`***--clusterServer: ${clusterServer.name}(${clusterServer.id}) attribute:${key}(${value.id}) ${value.isFixed} ${value.isWritable} ${value.isWritable}`);
+                                let attributeValue;
+                                try {
+                                    if (typeof value.getLocal() === 'object')
+                                        attributeValue = stringify(value.getLocal());
+                                    else
+                                        attributeValue = value.getLocal().toString();
+                                }
+                                catch (error) {
+                                    attributeValue = 'Unavailable';
+                                    this.log.debug(`GetLocal error ${error} in clusterServer: ${clusterServer.name}(${clusterServer.id}) attribute: ${key}(${value.id})`);
+                                    //console.log(error);
+                                }
+                                data.push({
+                                    endpoint: (childEndpoint.number ? childEndpoint.number.toString() : '...') + (name ? ' (' + name + ')' : ''),
+                                    clusterName: clusterServer.name,
+                                    clusterId: '0x' + clusterServer.id.toString(16).padStart(2, '0'),
+                                    attributeName: key,
+                                    attributeId: '0x' + value.id.toString(16).padStart(2, '0'),
+                                    attributeValue,
+                                });
+                            });
+                        });
+                    });
                 }
             });
             res.json(data);
@@ -2571,13 +2661,25 @@ export class Matterbridge extends EventEmitter {
                     plugin.platform?.log.setLogDebug(this.debugEnabled);
                 });
             }
-            // Handle the command shutdown from Header
+            // Handle the command reset from Settings
+            if (command === 'unregister') {
+                await this.unregisterAndShutdownProcess();
+            }
+            // Handle the command reset from Settings
+            if (command === 'reset') {
+                this.shutdownProcessAndReset(); // No await do it asyncronously
+            }
+            // Handle the command factoryreset from Settings
+            if (command === 'factoryreset') {
+                this.shutdownProcessAndFactoryReset(); // No await do it asyncronously
+            }
+            // Handle the command restart from Header
             if (command === 'shutdown') {
-                this.shutdownProcess();
+                this.shutdownProcess(); // No await do it asyncronously
             }
             // Handle the command restart from Header
             if (command === 'restart') {
-                this.restartProcess();
+                this.restartProcess(); // No await do it asyncronously
             }
             // Handle the command update from Header
             if (command === 'update') {
@@ -2665,10 +2767,13 @@ export class Matterbridge extends EventEmitter {
                 const plugin = plugins.find((plugin) => plugin.name === param);
                 if (plugin) {
                     plugin.enabled = true;
+                    plugin.error = undefined;
                     plugin.loaded = undefined;
                     plugin.started = undefined;
                     plugin.configured = undefined;
                     plugin.connected = undefined;
+                    plugin.platform = undefined;
+                    plugin.registeredDevices = undefined;
                     await this.nodeContext?.set('plugins', plugins);
                     this.log.info(`Enabled plugin ${plg}${param}${nf}`);
                 }
@@ -2679,7 +2784,6 @@ export class Matterbridge extends EventEmitter {
                         pluginToEnable.platform = await this.loadPlugin(pluginToEnable);
                         if (pluginToEnable.platform) {
                             await this.startPlugin(pluginToEnable, 'The plugin has been enabled', true);
-                            pluginToEnable.enabled = false;
                         }
                         else {
                             pluginToEnable.enabled = false;
@@ -2698,21 +2802,26 @@ export class Matterbridge extends EventEmitter {
                         await this.savePluginConfig(pluginToDisable);
                     }
                     pluginToDisable.enabled = false;
+                    pluginToDisable.error = undefined;
                     pluginToDisable.loaded = undefined;
                     pluginToDisable.started = undefined;
                     pluginToDisable.configured = undefined;
                     pluginToDisable.connected = undefined;
                     pluginToDisable.platform = undefined;
+                    pluginToDisable.registeredDevices = undefined;
                     const plugins = await this.nodeContext?.get('plugins');
                     if (!plugins)
                         return;
                     const plugin = plugins.find((plugin) => plugin.name === param);
                     if (plugin) {
                         plugin.enabled = false;
+                        plugin.error = undefined;
                         plugin.loaded = undefined;
                         plugin.started = undefined;
                         plugin.configured = undefined;
                         plugin.connected = undefined;
+                        plugin.platform = undefined;
+                        plugin.registeredDevices = undefined;
                         await this.nodeContext?.set('plugins', plugins);
                         this.log.info(`Disabled plugin ${plg}${param}${nf}`);
                     }
@@ -2728,7 +2837,7 @@ export class Matterbridge extends EventEmitter {
         if (!useHttps) {
             // Listen on HTTP
             this.expressServer = this.expressApp.listen(port, () => {
-                this.log.info(`The frontend is running on ${UNDERLINE}http://localhost:${port}${UNDERLINEOFF}${rs}`);
+                this.log.info(`The frontend is listening on ${UNDERLINE}http://${this.systemInformation.ipv4Address}:${port}${UNDERLINEOFF}${rs}`);
             });
         }
         else {
@@ -2742,7 +2851,7 @@ export class Matterbridge extends EventEmitter {
             // Specify the port to listen on, for example 443 for default HTTPS
             const PORT = 443;
             httpsServer.listen(PORT, () => {
-                this.log.info(`The frontend is running on ${UNDERLINE}https://localhost:${PORT}${UNDERLINEOFF}${rs}`);
+                this.log.info(`The frontend is listening on ${UNDERLINE}https://${this.systemInformation.ipv4Address}:${PORT}${UNDERLINEOFF}${rs}`);
             });
         }
         this.log.debug(`Frontend initialized on port ${YELLOW}${port}${db} static ${UNDERLINE}${path.join(this.rootDirectory, 'frontend/build')}${UNDERLINEOFF}${rs}`);
@@ -2753,6 +2862,16 @@ export class Matterbridge extends EventEmitter {
      * @returns The attributes of the cluster servers in the device.
      */
     getClusterTextFromDevice(device) {
+        const stringifyFixedLabel = (endpoint) => {
+            const labelList = endpoint.getClusterServer(FixedLabelCluster)?.getLabelListAttribute();
+            if (!labelList)
+                return;
+            const composed = labelList.find((entry) => entry.label === 'composed');
+            if (composed)
+                return 'Composed: ' + composed.value;
+            else
+                return ''; //'FixedLabel: ' + labelList.map((entry) => entry.label + ': ' + entry.value).join(' ');
+        };
         let attributes = '';
         //this.log.debug(`getClusterTextFromDevice: ${device.name}`);
         const clusterServers = device.getAllClusterServers();
@@ -2789,7 +2908,9 @@ export class Matterbridge extends EventEmitter {
             if (clusterServer.name === 'PressureMeasurement')
                 attributes += `Pressure: ${clusterServer.getMeasuredValueAttribute()} `;
             if (clusterServer.name === 'FlowMeasurement')
-                attributes += `Pressure: ${clusterServer.getMeasuredValueAttribute()} `;
+                attributes += `Flow: ${clusterServer.getMeasuredValueAttribute()} `;
+            if (clusterServer.name === 'FixedLabel')
+                attributes += `${stringifyFixedLabel(device)} `;
         });
         return attributes;
     }
@@ -2819,6 +2940,31 @@ function restartProcess() {
   process.exit();
 }
 
+import React from 'react';
+import Form from "@rjsf/core";
+
+const schema = {
+  title: "Todo",
+  type: "object",
+  required: ["title"],
+  properties: {
+    title: {type: "string", title: "Title", default: "A new task"},
+    done: {type: "boolean", title: "Done?", default: false}
+  }
+};
+
+const log = (type) => console.log.bind(console, type);
+
+function Todo() {
+  return (
+    <Form schema={schema}
+          onChange={log("changed")}
+          onSubmit={log("submitted")}
+          onError={log("errors")} />
+  );
+}
+
+export default Todo;
 
 /*
 How frontend was created