matterbridge 2.1.5-dev.8 → 2.1.6-dev.1

package/CHANGELOG.md

@@ -33,7 +33,24 @@ matterbridge-zigbee2mqtt v. 2.4.4
 matterbridge-somfy-tahoma v. 1.2.3
 matterbridge-hass v. 0.0.8
 
-## [2.1.5] - 2025-02-10
+## [2.1.6] - 2025-02-12
+
+### Added
+
+- [docker]: Added health check directly inside the docker image. No need to change configuration.
+- [platform]: Added saving to storage the selects for faster loading.
+- [icon]: Added matterbridge svg icon (thanks: https://github.com/robvanoostenrijk https://github.com/stuntguy3000).
+- [frontend]: Frontend v.2.4.2.
+
+### Changed
+
+- [package]: Update matter.js to 0.12.4-alpha.0-20250212-b2729c9eb
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
+</a>
+
+## [2.1.5] - 2025-02-11
 
 ### Added
 
@@ -42,15 +59,17 @@ matterbridge-hass v. 0.0.8
 - [frontend]: Added cpuUsed, rss and heapUsed to SystemInformation.
 - [frontend]: Added UiProvider.
 - [frontend]: Added wssSendCpuUpdate, wssSendMemoryUpdate and wssSendSnackbarMessage.
+- [docker]: Added health check to docker images. See README-DOCKER.md with the updated configuration.
 
 ### Changed
 
-- [matterbridge]: Calls getNpmPackageVersion() instead of npm to get latest version.
+- [matterbridge]: Calls getNpmPackageVersion() instead of npm to get latest version to optimize memory and cpu usage.
 - [matterbridge]: Memory optimization on MatterbridgeEndpoint.
 
 ### Fixed
 
 - [matterbridge]: Refactor shutdown sequences for reset and factory reset.
+- [matterbridge]: Refactor reset devices adding a wait of 1 sec to allow matter to deliver all messages before shutting down.
 
 <a href="https://www.buymeacoffee.com/luligugithub">
   <img src="./yellow-button.png" alt="Buy me a coffee" width="120">

package/README-DOCKER.md

@@ -18,6 +18,22 @@
 
 The Matterbridge Docker image, which includes a manifest list for the linux/amd64, linux/arm64 and linux/arm/v7 architectures, is published on Docker Hub.
 
+It is based on node:22-bookworm-slim and integrates the health check.
+
+How Health Checks Work in Different Scenarios
+
+With docker-compose
+
+Docker monitors the health check and can restart the container if needed.
+
+With docker run
+
+The health check still runs in the background, but:
+The container doesn’t restart automatically if it becomes unhealthy.
+You must manually check the health status:
+
+docker exec -it matterbridge curl -v http://localhost:8283/health
+
 ### First create the Matterbridge directories
 
 This will create the required directories in your home directory if they don't exist
@@ -73,7 +89,7 @@ services:
       - "/home/<USER>/.matterbridge:/root/.matterbridge"      # Mounts the Matterbridge storage directory
 ```
 
-Replace USER with your user name (i.e. ubuntu or pi).
+Replace USER with your user name (i.e. ubuntu or pi: "/home/ubuntu/Matterbridge:/root/Matterbridge").
 
 copy it in the home directory or edit the existing one to add the matterbridge service.
 

package/dist/frontend.js

@@ -9,7 +9,6 @@ import { promises as fs } from 'fs';
 import { AnsiLogger, CYAN, db, debugStringify, er, nf, rs, stringify, UNDERLINE, UNDERLINEOFF, wr, YELLOW } from './logger/export.js';
 import { createZip, deepCopy, getIntParameter, hasParameter, isValidNumber, isValidObject, isValidString } from './utils/utils.js';
 import { plg } from './matterbridgeTypes.js';
-import { MatterbridgeEndpoint } from './matterbridgeEndpoint.js';
 export const WS_ID_LOG = 0;
 export const WS_ID_REFRESH_NEEDED = 1;
 export const WS_ID_RESTART_NEEDED = 2;
@@ -255,8 +254,7 @@ export class Frontend {
         });
         this.expressApp.get('/api/plugins', async (req, res) => {
             this.log.debug('The frontend sent /api/plugins');
-            const response = this.getBaseRegisteredPlugins();
-            res.json(response);
+            res.json(this.getBaseRegisteredPlugins());
         });
         this.expressApp.get('/api/devices', (req, res) => {
             this.log.debug('The frontend sent /api/devices');
@@ -494,16 +492,7 @@ export class Frontend {
                     this.log.logLevel = "fatal";
                 }
                 await this.matterbridge.nodeContext?.set('matterbridgeLogLevel', this.log.logLevel);
-                this.matterbridge.log.logLevel = this.log.logLevel;
-                MatterbridgeEndpoint.logLevel = this.log.logLevel;
-                this.matterbridge.devices.logLevel = this.log.logLevel;
-                this.matterbridge.plugins.logLevel = this.log.logLevel;
-                for (const plugin of this.matterbridge.plugins) {
-                    if (!plugin.platform || !plugin.platform.config)
-                        continue;
-                    plugin.platform.log.logLevel = plugin.platform.config.debug ? "debug" : this.log.logLevel;
-                    await plugin.platform.onChangeLoggerLevel(plugin.platform.config.debug ? "debug" : this.log.logLevel);
-                }
+                await this.matterbridge.setLogLevel(this.log.logLevel);
                 res.json({ message: 'Command received' });
                 return;
             }
@@ -666,13 +655,17 @@ export class Frontend {
             if (command === 'installplugin') {
                 param = param.replace(/\*/g, '\\');
                 this.log.info(`Installing plugin ${plg}${param}${nf}...`);
+                this.wssSendSnackbarMessage(`Installing package ${param}`);
                 try {
                     await this.matterbridge.spawnCommand('npm', ['install', '-g', param, '--omit=dev', '--verbose']);
                     this.log.info(`Plugin ${plg}${param}${nf} installed. Full restart required.`);
+                    this.wssSendSnackbarMessage(`Installed package ${param}`);
                 }
                 catch (error) {
                     this.log.error(`Error installing plugin ${plg}${param}${er}`);
+                    this.wssSendSnackbarMessage(`Package ${param} not installed`);
                 }
+                this.wssSendSnackbarMessage(`Restart required`, 0);
                 this.wssSendRestartRequired();
                 param = param.split('@')[0];
                 if (param === 'matterbridge') {
@@ -687,10 +680,11 @@ export class Frontend {
                     if (this.matterbridge.bridgeMode === 'childbridge') {
                         this.matterbridge.createDynamicPlugin(plugin, true);
                     }
-                    this.matterbridge.plugins.load(plugin, true, 'The plugin has been added', true);
+                    this.matterbridge.plugins.load(plugin, true, 'The plugin has been added', true).then(() => {
+                        this.wssSendRefreshRequired();
+                    });
                 }
                 res.json({ message: 'Command received' });
-                this.wssSendRefreshRequired();
                 return;
             }
             if (command === 'removeplugin') {
@@ -725,7 +719,9 @@ export class Frontend {
                         if (this.matterbridge.bridgeMode === 'childbridge' && plugin.type === 'DynamicPlatform') {
                             this.matterbridge.createDynamicPlugin(plugin, true);
                         }
-                        this.matterbridge.plugins.load(plugin, true, 'The plugin has been enabled', true);
+                        this.matterbridge.plugins.load(plugin, true, 'The plugin has been enabled', true).then(() => {
+                            this.wssSendRefreshRequired();
+                        });
                     }
                 }
                 res.json({ message: 'Command received' });
@@ -1116,13 +1112,27 @@ export class Frontend {
                     client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, error: 'Wrong parameter packageName in /api/install' }));
                     return;
                 }
+                this.wssSendSnackbarMessage(`Installing package ${data.params.packageName}`);
                 this.matterbridge
                     .spawnCommand('npm', ['install', '-g', data.params.packageName, '--omit=dev', '--verbose'])
                     .then((response) => {
                     client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, response }));
+                    this.wssSendSnackbarMessage(`Installed package ${data.params.packageName}`);
+                    if (data.params.restart !== true) {
+                        this.wssSendSnackbarMessage(`Restart required`, 0);
+                    }
+                    else {
+                        if (this.matterbridge.restartMode !== '') {
+                            this.wssSendSnackbarMessage(`Restarting matterbridge...`, 0);
+                            this.matterbridge.shutdownProcess();
+                        }
+                        else
+                            this.wssSendSnackbarMessage(`Restart required`, 0);
+                    }
                 })
                     .catch((error) => {
                     client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, error: error instanceof Error ? error.message : error }));
+                    this.wssSendSnackbarMessage(`Package ${data.params.packageName} not installed`);
                 });
                 return;
             }
@@ -1131,6 +1141,7 @@ export class Frontend {
                     client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, error: 'Wrong parameter packageName in /api/uninstall' }));
                     return;
                 }
+                this.wssSendSnackbarMessage(`Uninstalling package ${data.params.packageName}`);
                 this.matterbridge
                     .spawnCommand('npm', ['uninstall', '-g', data.params.packageName, '--verbose'])
                     .then((response) => {
@@ -1138,14 +1149,18 @@ export class Frontend {
                 })
                     .catch((error) => {
                     client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, error: error instanceof Error ? error.message : error }));
+                    this.wssSendSnackbarMessage(`Uninstalled package ${data.params.packageName}`);
+                    this.wssSendSnackbarMessage(`Restart required`, 0);
                 });
                 return;
             }
             else if (data.method === '/api/restart') {
+                this.wssSendSnackbarMessage(`Restarting matterbridge...`, 0);
                 await this.matterbridge.restartProcess();
                 return;
             }
             else if (data.method === '/api/shutdown') {
+                this.wssSendSnackbarMessage(`Shutting down matterbridge...`, 0);
                 await this.matterbridge.shutdownProcess();
                 return;
             }

package/dist/matterbridge.js

@@ -132,6 +132,30 @@ export class Matterbridge extends EventEmitter {
     getPlugins() {
         return this.plugins.array();
     }
+    async setLogLevel(logLevel) {
+        if (this.log)
+            this.log.logLevel = logLevel;
+        this.matterbridgeInformation.loggerLevel = logLevel;
+        this.frontend.logLevel = logLevel;
+        MatterbridgeEndpoint.logLevel = logLevel;
+        if (this.devices)
+            this.devices.logLevel = logLevel;
+        if (this.plugins)
+            this.plugins.logLevel = logLevel;
+        for (const plugin of this.plugins) {
+            if (!plugin.platform || !plugin.platform.log || !plugin.platform.config)
+                continue;
+            plugin.platform.log.logLevel = plugin.platform.config.debug === true ? "debug" : this.log.logLevel;
+            await plugin.platform.onChangeLoggerLevel(plugin.platform.config.debug === true ? "debug" : this.log.logLevel);
+        }
+        let callbackLogLevel = "notice";
+        if (this.matterbridgeInformation.loggerLevel === "info" || this.matterbridgeInformation.matterLoggerLevel === MatterLogLevel.INFO)
+            callbackLogLevel = "info";
+        if (this.matterbridgeInformation.loggerLevel === "debug" || this.matterbridgeInformation.matterLoggerLevel === MatterLogLevel.DEBUG)
+            callbackLogLevel = "debug";
+        AnsiLogger.setGlobalCallback(this.frontend.wssSendMessage.bind(this.frontend), callbackLogLevel);
+        this.log.debug(`WebSocketServer logger global callback set to ${callbackLogLevel}`);
+    }
     static async loadInstance(initialize = false) {
         if (!Matterbridge.instance) {
             if (hasParameter('debug'))
@@ -248,6 +272,7 @@ export class Matterbridge extends EventEmitter {
         else {
             this.log.logLevel = await this.nodeContext.get('matterbridgeLogLevel', "info");
         }
+        this.frontend.logLevel = this.log.logLevel;
         MatterbridgeEndpoint.logLevel = this.log.logLevel;
         this.matterbridgeInformation.loggerLevel = this.log.logLevel;
         if (hasParameter('filelogger') || (await this.nodeContext.get('matterbridgeFileLog', false))) {
@@ -521,7 +546,6 @@ export class Matterbridge extends EventEmitter {
         }
         if (getIntParameter('frontend') !== 0 || getIntParameter('frontend') === undefined)
             await this.frontend.start(getIntParameter('frontend'));
-        this.frontend.logLevel = this.log.logLevel;
         this.getMatterbridgeLatestVersion();
         for (const plugin of this.plugins) {
             this.getPluginLatestVersion(plugin);
@@ -766,20 +790,6 @@ export class Matterbridge extends EventEmitter {
         const cmdArgs = process.argv.slice(2).join(' ');
         this.log.debug(`Command Line Arguments: ${cmdArgs}`);
     }
-    async getLatestVersion(packageName) {
-        return new Promise((resolve, reject) => {
-            this.execRunningCount++;
-            exec(`npm view ${packageName} version`, (error, stdout) => {
-                this.execRunningCount--;
-                if (error) {
-                    reject(error);
-                }
-                else {
-                    resolve(stdout.trim());
-                }
-            });
-        });
-    }
     async getGlobalNodeModules() {
         return new Promise((resolve, reject) => {
             this.execRunningCount++;
@@ -809,7 +819,7 @@ export class Matterbridge extends EventEmitter {
             this.frontend.wssSendRefreshRequired();
         })
             .catch((error) => {
-            this.log.error(`Error getting Matterbridge latest version: ${error.message}`);
+            this.log.warn(`Error getting Matterbridge latest version: ${error.message}`);
         });
     }
     async getPluginLatestVersion(plugin) {
@@ -822,7 +832,7 @@ export class Matterbridge extends EventEmitter {
                 this.log.debug(`The plugin ${plg}${plugin.name}${db} is up to date. Current version: ${plugin.version}. Latest version: ${plugin.latestVersion}.`);
         })
             .catch((error) => {
-            this.log.error(`Error getting ${plg}${plugin.name}${er} latest version: ${error.message}`);
+            this.log.warn(`Error getting ${plg}${plugin.name}${er} latest version: ${error.message}`);
         });
     }
     createMatterLogger() {

package/dist/matterbridgePlatform.js

@@ -20,7 +20,7 @@ export class MatterbridgePlatform {
         this.matterbridge = matterbridge;
         this.log = log;
         this.config = config;
-        if (!isValidString(this.config.name))
+        if (!isValidString(this.config.name) || this.config.name === '')
             return;
         this.log.debug(`Creating storage for plugin ${this.config.name} in ${path.join(this.matterbridge.matterbridgeDirectory, this.config.name)}`);
         this.storage = new NodeStorageManager({
@@ -30,6 +30,27 @@ export class MatterbridgePlatform {
             logging: false,
             forgiveParseErrors: true,
         });
+        this.log.debug(`Creating context for plugin ${this.config.name}`);
+        this.storage.createStorage('context').then((context) => {
+            this.context = context;
+            this.log.debug(`Created context for plugin ${this.config.name}`);
+        });
+        this.log.debug(`Loading selectDevice for plugin ${this.config.name}`);
+        this.storage.createStorage('selectDevice').then((context) => {
+            context.get('selectDevice', []).then((selectDevice) => {
+                for (const device of selectDevice)
+                    this.selectDevice.set(device.serial, device);
+            });
+            this.log.debug(`Loaded ${this.selectDevice.size} selectDevice for plugin ${this.config.name}`);
+        });
+        this.log.debug(`Loading selectEntity for plugin ${this.config.name}`);
+        this.storage.createStorage('selectEntity').then((context) => {
+            context.get('selectEntity', []).then((selectEntity) => {
+                for (const entity of selectEntity)
+                    this.selectEntity.set(entity.name, entity);
+            });
+            this.log.debug(`Loaded ${this.selectEntity.size} selectEntity for plugin ${this.config.name}`);
+        });
     }
     async onStart(reason) {
         this.log.error('Plugins must override onStart.', reason);
@@ -41,11 +62,22 @@ export class MatterbridgePlatform {
     }
     async onShutdown(reason) {
         this.log.debug(`Shutting down platform ${this.name}`, reason);
+        if (this.storage) {
+            this.log.debug(`Saving ${this.selectDevice.size} selectDevice...`);
+            const selectDevice = await this.storage.createStorage('selectDevice');
+            await selectDevice.set('selectDevice', Array.from(this.selectDevice.values()));
+            await selectDevice.close();
+            this.log.debug(`Saving ${this.selectEntity.size} selectEntity...`);
+            const selectEntity = await this.storage.createStorage('selectEntity');
+            await selectEntity.set('selectEntity', Array.from(this.selectEntity.values()));
+            await selectEntity.close();
+        }
         await this.checkEndpointNumbers();
         this.selectDevice.clear();
         this.selectEntity.clear();
         this.registeredEndpoints.clear();
         this.registeredEndpointsByName.clear();
+        this.log.debug('Saving context...');
         await this.context?.close();
         this.context = undefined;
         await this.storage?.close();
@@ -165,7 +197,7 @@ export class MatterbridgePlatform {
         if (!this.storage)
             return -1;
         this.log.debug('Checking endpoint numbers...');
-        const context = await this.storage.createStorage('context');
+        const context = await this.storage.createStorage('endpointNumbers');
         const separator = '|.|';
         const endpointMap = new Map(await context.get('endpointMap', []));
         for (const device of this.matterbridge.getDevices().filter((d) => d.plugin === this.name)) {
@@ -195,7 +227,9 @@ export class MatterbridgePlatform {
                 }
             }
         }
+        this.log.debug('Saving endpointNumbers...');
         await context.set('endpointMap', Array.from(endpointMap.entries()));
+        await context.close();
         this.log.debug('Endpoint numbers check completed.');
         return endpointMap.size;
     }

package/frontend/build/asset-manifest.json

@@ -1,7 +1,7 @@
 {
   "files": {
     "main.css": "./static/css/main.cf25d33e.css",
-    "main.js": "./static/js/main.cd192588.js",
+    "main.js": "./static/js/main.a241d4f0.js",
     "static/js/453.abd36b29.chunk.js": "./static/js/453.abd36b29.chunk.js",
     "static/media/roboto-latin-700-normal.woff2": "./static/media/roboto-latin-700-normal.4535474e1cf8598695ad.woff2",
     "static/media/roboto-latin-500-normal.woff2": "./static/media/roboto-latin-500-normal.7077203b1982951ecf76.woff2",
@@ -61,11 +61,11 @@
     "static/media/roboto-greek-ext-400-normal.woff": "./static/media/roboto-greek-ext-400-normal.16eb83b4a3b1ea994243.woff",
     "index.html": "./index.html",
     "main.cf25d33e.css.map": "./static/css/main.cf25d33e.css.map",
-    "main.cd192588.js.map": "./static/js/main.cd192588.js.map",
+    "main.a241d4f0.js.map": "./static/js/main.a241d4f0.js.map",
     "453.abd36b29.chunk.js.map": "./static/js/453.abd36b29.chunk.js.map"
   },
   "entrypoints": [
     "static/css/main.cf25d33e.css",
-    "static/js/main.cd192588.js"
+    "static/js/main.a241d4f0.js"
   ]
 }

package/frontend/build/index.html

@@ -1 +1 @@
-<!doctype html><html lang="en"><head><meta charset="utf-8"/><base href="./"><link rel="icon" href="./matterbridge 32x32.png"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><title>Matterbridge</title><link rel="manifest" href="./manifest.json"/><script defer="defer" src="./static/js/main.cd192588.js"></script><link href="./static/css/main.cf25d33e.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
+<!doctype html><html lang="en"><head><meta charset="utf-8"/><base href="./"><link rel="icon" href="./matterbridge 32x32.png"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><title>Matterbridge</title><link rel="manifest" href="./manifest.json"/><script defer="defer" src="./static/js/main.a241d4f0.js"></script><link href="./static/css/main.cf25d33e.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>