matterbridge 3.4.4-dev-20251215-216dfc3 → 3.4.4-dev-20251216-bf81437

package/CHANGELOG.md

@@ -32,11 +32,13 @@ Advantages:
 
 ### Added
 
-- [frontend]: Set autoScroll to false in mobileMode.
+- [frontend]: Set automatically autoScroll to false in mobileMode.
 - [frontend]: Added Log length: 100, 200, 500, 1000.
-- [frontend]: Added Log search with case-insensitive regex: use /text/ in the search field.
+- [frontend]: Added Log search with case-insensitive regex: use /text/ in the search field to activate the regex search mode.
 - [frontend]: Differentiated update icon color: primary color for latest and secondary color for dev.
-- [MbfTable]: Added ConditionalTooltip to show clipped column cells.
+- [frontend]: Added `Reset the frontend UI` in the Reset menu. It will reset the frontend local storage to the default and reload the page.
+- [MbfTable]: Added ConditionalTooltip to show clipped column cells. Used in the Cluster table for a better user experience.
+- [frontend]: Added battery level to Devices panel in the Home page. Thanks [Tamer Salah](https://github.com/tammeryousef1006).
 
 ### Changed
 
@@ -47,6 +49,7 @@ Advantages:
 
 - [doorLock]: Fixed DoorLock.supportedOperatingModes. Thanks Ludovic BOUÉ (https://github.com/Luligu/matterbridge/issues/454).
 - [frontend]: Fixed mobileMode menu navigation. Thanks Calimerorulez (https://github.com/Luligu/matterbridge/issues/457).
+- [matterbridge]: Fixed debug level of matter logger.
 
 <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
 

package/README-DOCKER.md

@@ -18,7 +18,7 @@
 
 ## Run matterbridge with docker and docker compose
 
-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**.
+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**](https://hub.docker.com/r/luligu/matterbridge).
 
 The image (tag **latest**) includes matterbridge and all official plugins with the latest release (as published on npm). You can just pull the new image and matterbridge with all plugins will be the latest release published on npm.
 
@@ -30,11 +30,11 @@ It is based on node:22-bookworm-slim and integrates the health check.
 
 How Health Checks Work in Different Scenarios
 
-With docker-compose
+With docker-compose:
 
 Docker monitors the health check and can restart the container if needed.
 
-With docker run
+With docker run:
 
 The health check still runs in the background, but:
 The container doesn’t restart automatically if it becomes unhealthy.
@@ -45,6 +45,8 @@ You can manually check the health status:
 docker exec -it matterbridge curl -v http://localhost:8283/health
 ```
 
+If you use the docker image, please consider giving it a star on [**Docker Hub**](https://hub.docker.com/r/luligu/matterbridge).
+
 ### First create the Matterbridge directories
 
 This will create the required directories in your home directory if they don't exist
@@ -84,11 +86,24 @@ sudo docker run --name matterbridge \
 
 You may need to adapt the script to your setup.
 
+### Run the Docker container and start it adding different parameters (i.e. frontend on port 8585)
+
+```bash
+sudo docker run --name matterbridge \
+  -v ~/Matterbridge:/root/Matterbridge \
+  -v ~/.matterbridge:/root/.matterbridge \
+  -v ~/.mattercert:/root/.mattercert \
+  --network host --restart always -d luligu/matterbridge:latest \
+  matterbridge --docker --frontend 8585
+```
+
+If you override, always use `matterbridge --docker` like first part of the command.
+
 ### Run with docker compose
 
 The docker-compose.yml file is available in the docker directory of the package
 
-```
+```yaml
 services:
   matterbridge:
     container_name: matterbridge
@@ -115,6 +130,17 @@ or start only the matterbridge container with:
 docker compose up -d matterbridge
 ```
 
+If you need to start matterbridge adding different parameters (i.e. frontend on port 8585), you can override the default command adding the line command to the service:
+
+```yaml
+services:
+  matterbridge:
+    ...
+    command: ["matterbridge", "--docker", "--frontend", "8585"]
+```
+
+If you override, always use `["matterbridge", "--docker"]` like first part of the command.
+
 ### Stop with docker compose
 
 ```bash

package/README.md

@@ -15,7 +15,7 @@
 
 ---
 
-Matterbridge is a Matter plugin manager.
+[Matterbridge](https://matterbridge.io) is a Matter plugin manager.
 
 It allows you to have all your Matter devices up and running in a couple of minutes without having to deal with the pairing process for each individual device.
 
@@ -27,7 +27,7 @@ This project aims to enable porting Homebridge plugins to Matterbridge plugins w
 
 The easiest way to start create a new plugin is to clone the [Matterbridge Plugin Template](https://github.com/Luligu/matterbridge-plugin-template) which has **Dev Container support for instant development environment** and all tools and extensions (like Node.js, npm, TypeScript, ESLint, Prettier, Jest and Vitest) already loaded and configured.
 
-Matterbridge creates a device that can be paired with any ecosystem, such as Apple Home, Google Home, Amazon Alexa, Home Assistant, or any other platform supporting Matter.
+Matterbridge creates a [Matter device](https://csa-iot.org/all-solutions/matter/) that can be paired with any ecosystem, such as Apple Home, Google Home, Amazon Alexa, Home Assistant, or any other platform supporting Matter.
 
 You don't need a hub or a dedicated new machine.
 

package/dist/frontend.js

@@ -163,11 +163,11 @@ export class Frontend extends EventEmitter {
                 this.wsMessageHandler(ws, message);
             });
             ws.on('ping', () => {
-                this.log.debug('WebSocket client ping');
+                this.log.debug('WebSocket client ping received');
                 ws.pong();
             });
             ws.on('pong', () => {
-                this.log.debug('WebSocket client pong');
+                this.log.debug('WebSocket client pong received');
             });
             ws.on('close', () => {
                 this.log.info('WebSocket client disconnected');
@@ -836,7 +836,7 @@ export class Frontend extends EventEmitter {
     }
     getPowerSource(endpoint) {
         if (this.matterbridge.hasCleanupStarted)
-            return;
+            return undefined;
         if (!endpoint.lifecycle.isReady || endpoint.construction.status !== Lifecycle.Status.Active)
             return undefined;
         const powerSource = (device) => {
@@ -858,6 +858,26 @@ export class Frontend extends EventEmitter {
                 return powerSource(child);
         }
     }
+    getBatteryLevel(endpoint) {
+        if (this.matterbridge.hasCleanupStarted)
+            return undefined;
+        if (!endpoint.lifecycle.isReady || endpoint.construction.status !== Lifecycle.Status.Active)
+            return undefined;
+        const batteryLevel = (device) => {
+            const featureMap = device.getAttribute(PowerSource.Cluster.id, 'featureMap');
+            if (featureMap.battery) {
+                const batChargeLevel = device.getAttribute(PowerSource.Cluster.id, 'batPercentRemaining');
+                return isValidNumber(batChargeLevel) ? batChargeLevel / 2 : undefined;
+            }
+            return undefined;
+        };
+        if (endpoint.hasClusterServer(PowerSource.Cluster.id))
+            return batteryLevel(endpoint);
+        for (const child of endpoint.getChildEndpoints()) {
+            if (child.hasClusterServer(PowerSource.Cluster.id))
+                return batteryLevel(child);
+        }
+    }
     getClusterTextFromDevice(device) {
         if (this.matterbridge.hasCleanupStarted)
             return '';
@@ -1030,6 +1050,7 @@ export class Frontend extends EventEmitter {
                 uniqueId: device.uniqueId,
                 reachable: this.getReachability(device),
                 powerSource: this.getPowerSource(device),
+                batteryLevel: this.getBatteryLevel(device),
                 matter: device.mode === 'server' && device.serverNode ? this.matterbridge.getServerNodeData(device.serverNode) : undefined,
                 cluster: this.getClusterTextFromDevice(device),
             });
@@ -1228,8 +1249,7 @@ export class Frontend extends EventEmitter {
                         this.wssSendSnackbarMessage(`Loaded plugin ${localData.params.pluginNameOrPath}`, 5, 'success');
                         return;
                     })
-                        .catch((_error) => {
-                    });
+                        .catch((_error) => { });
                 }
                 else {
                     sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, error: `Plugin ${data.params.pluginNameOrPath} not added` });
@@ -1277,8 +1297,7 @@ export class Frontend extends EventEmitter {
                         this.wssSendSnackbarMessage(`Started plugin ${localData.params.pluginName}`, 5, 'success');
                         return;
                     })
-                        .catch((_error) => {
-                    });
+                        .catch((_error) => { });
                 }
                 sendResponse({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true });
             }

package/dist/matterbridge.js

@@ -67,7 +67,7 @@ export class Matterbridge extends EventEmitter {
     log = new AnsiLogger({ logName: 'Matterbridge', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
     logLevel = this.log.logLevel;
     fileLogger = false;
-    matterLog = new AnsiLogger({ logName: 'Matter', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
+    matterLog = new AnsiLogger({ logName: 'Matter', logTimestampFormat: 4, logLevel: "debug" });
     matterLogLevel = this.matterLog.logLevel;
     matterFileLogger = false;
     readOnly = hasParameter('readonly') || hasParameter('shelly');
@@ -1147,6 +1147,7 @@ export class Matterbridge extends EventEmitter {
         await addVirtualDevices(this, this.aggregatorNode);
         await this.startPlugins();
         this.log.debug('Starting start matter interval in bridge mode...');
+        this.frontend.wssSendSnackbarMessage(`The bridge is starting...`, 0, 'info');
         let failCount = 0;
         this.startMatterInterval = setInterval(async () => {
             if (failCount && failCount % 10 === 0) {
@@ -1214,6 +1215,7 @@ export class Matterbridge extends EventEmitter {
             this.log.notice('Matterbridge bridge started successfully');
             this.frontend.wssSendRefreshRequired('settings');
             this.frontend.wssSendRefreshRequired('plugins');
+            this.frontend.wssSendCloseSnackbarMessage(`The bridge is starting...`);
         }, Number(process.env['MATTERBRIDGE_START_MATTER_INTERVAL_MS']) || this.startMatterIntervalMs);
     }
     async startChildbridge(delay = 1000) {
@@ -1229,6 +1231,7 @@ export class Matterbridge extends EventEmitter {
             this.plugins.start(plugin, 'Matterbridge is starting');
         }
         this.log.debug('Starting start matter interval in childbridge mode...');
+        this.frontend.wssSendSnackbarMessage(`The bridge is starting...`, 0, 'info');
         let failCount = 0;
         this.startMatterInterval = setInterval(async () => {
             if (failCount && failCount % 10 === 0) {
@@ -1322,6 +1325,7 @@ export class Matterbridge extends EventEmitter {
             this.log.notice('Matterbridge childbridge started successfully');
             this.frontend.wssSendRefreshRequired('settings');
             this.frontend.wssSendRefreshRequired('plugins');
+            this.frontend.wssSendCloseSnackbarMessage(`The bridge is starting...`);
         }, Number(process.env['MATTERBRIDGE_START_MATTER_INTERVAL_MS']) || this.startMatterIntervalMs);
     }
     async startController() {