matterbridge 3.0.0-edge.8 → 3.0.1-dev-20250430-a3ea2b7

package/CHANGELOG.md

@@ -13,10 +13,6 @@ If you like this project and find it useful, please consider giving it a star on
 If you want to run Matterbridge in Home Assistant please use the official add-on https://github.com/Luligu/matterbridge-home-assistant-addon that also has Ingress and side panel.
 It is also available the official Matterbridge Home Assistant plugin https://github.com/Luligu/matterbridge-hass.
 
-### Discord
-
-Tamer (https://github.com/tammeryousef1006) has created the Matterbridge Discord group: https://discord.gg/QX58CDe6hd.
-
 ## New plugin matterbridge-webhooks
 
 A new plugin has been added: https://github.com/Luligu/matterbridge-webhooks
@@ -31,7 +27,7 @@ Features:
 
 ## Breaking changes
 
-Matter 1.4
+This release brings Matter 1.4.
 
 New device types:
 
@@ -42,7 +38,7 @@ Modified clusters:
 
 - OccupancySensing cluster.
 
-## [3.0.0] - 2025-04-??
+## [3.0.0] - 2025-04-29
 
 ### Added
 
@@ -51,22 +47,69 @@ Modified clusters:
 - [endpoint]: Added createBaseFanControlClusterServer().
 - [endpoint]: Added createDefaultHepaFilterMonitoringClusterServer().
 - [endpoint]: Added createDefaultActivatedCarbonFilterMonitoringClusterServer().
-- [deviceTypes]: Added Robotic device type.
-- [deviceTypes]: Added Appliances device types.
+- [endpoint]: Added createDefaultThermostatUserInterfaceConfigurationClusterServer().
+- [deviceTypes]: Added Robotic device type (please read https://github.com/Luligu/matterbridge/discussions/264).
+- [deviceTypes]: Added Appliances device types (please read https://github.com/Luligu/matterbridge/discussions/264).
+- [frontend]: Added the matterbridge aggregator serialNumber in the QRDiv.
+- [frontend]: Added Power column in the Devices panel of the Home page.
+- [frontend]: Added support for appliances and robot in IconView.
+- [parameter]: Added getIntArrayParameter and getStringArrayParameter.
+- [frontend]: Added the view menu to load the logs directly in the browser.
+- [docker]: Optimized the dockerfiles and reduced the image size by 30%.
+- [docker]: The builder for the docker image with tag latest will run each day at 00:00 UTC. Inside the image all plugins with the latest release (as published on npm) are already loaded. You can just pull the new image and matterbridge with all plugins will be the latest.
 
 ### Changed
 
-- [deviceTypes]: Updated device types to Matter 1.4
+- [package]: Updated package.
+- [package]: Updated express to v5.1.0.
+- [package]: Updated dependencies.
+- [frontend]: Frontend v.2.6.3.
+- [frontend]: Changed icons with mdiIcons in IconView.
+- [package]: Added tsconfig.jest.json with "isolatedModules": true for ts-jest.
+- [deviceTypes]: Updated device types to Matter 1.4.
+- [clusters]: Updated cluster helpers to Matter 1.4.
 - [matter.js]: Update to 0.13.0-alpha.0-20250405-7fc7db48.
 - [matter.js]: Update to 0.13.0-alpha.0-20250408-c916c7e8.
 - [matter.js]: Update to 0.13.0-alpha.0-20250412-5fad64e7b.
 - [matter.js]: Update to 0.13.0-alpha.0-20250413-d5a27700d.
 - [matter.js]: Update to 0.13.0-alpha.0-20250415-475996bb5.
+- [matter.js]: Update to 0.13.0-alpha.0-20250418-8cfc0b832.
+- [matter.js]: Update to 0.13.0-alpha.0-20250420-9f45e4f77.
+- [matter.js]: Update to 0.13.0-alpha.0-20250422-0d27f26be.
+- [matter.js]: Update to 0.13.0-alpha.0-20250423-8917d1d1d.
+- [matter.js]: Update to 0.13.0-alpha.0-20250424-4760af1f3.
+- [matter.js]: Update to 0.13.0-alpha.0-20250425-94b33ff98.
+- [matter.js]: Update to 0.13.0-alpha.0-20250427-e7df8aa45.
+- [matter.js]: Update to 0.13.0.
+- [help]: Updated cli help screen.
+- [logger]: Improved frontend logger cleaning.
 
 ### Fixed
 
 - [doorLock]: Fixed supportedOperatingModes inverted bitmap (Thanks Apollon).
 - [DevicesIcon]: Fixed rendering of leak freeze and rain sensors.
+- [QRCode]: Fixed rendering of QRCode panel when advertising stops.
+- [matterbridge]: Fixed wrong message when advertising stops and the node has been paired.
+- [frontend]: Fixed download logs that broke with express v5.1.0.
+
+## [2.2.9] - 2025-04-18
+
+### Added
+
+- [deviceTypes]: Added extendedColorLight device type.
+
+### Changed
+
+- [package]: Update dependencies.
+
+### Fixed
+
+- [QRCode]: Fixed update when the server node is no more advertising.
+- [frontend]: Fixed wrong notification when the server node has been paired.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
 
 ## [2.2.8] - 2025-04-10
 

package/README-DEV.md

@@ -82,6 +82,10 @@ Matterbridge must be linked to the plugin in development only.
 }
 ```
 
+On the machine you use for development you should also have matterbridge installed globally or built locally and linked (npm link from the package root).
+
+Dev and edge branches of matterbridge are not suitable for developemnt cause they are published for production without types. If you want to develop a plugin using the dev or edge branch of matterbridge, you have to clone the dev or edge branch of matterbridge, build locally and link (npm run deepCleanBuild).
+
 # \***\*\*\*\*\***
 
 I added some error messages when a plugin has wrong imports or configurations and the plugin will be disabled to prevent instability and crashes.

package/README-DOCKER.md

@@ -38,7 +38,7 @@ docker exec -it matterbridge curl -v http://localhost:8283/health
 
 This will create the required directories in your home directory if they don't exist
 
-```
+```bash
 cd ~
 mkdir -p ./Matterbridge
 mkdir -p ./.matterbridge
@@ -51,7 +51,7 @@ You may need to adapt the script to your setup.
 
 If you don't want to use sudo with docker commands, run this command:
 
-```
+```bash
 sudo groupadd docker
 sudo usermod -aG docker $USER
 ```
@@ -62,7 +62,7 @@ After adding your user to the docker group, you need to log out and log back in
 
 The container must have full access to the host network (needed for mdns).
 
-```
+```bash
 sudo docker run --name matterbridge \
   -v /home/<USER>/Matterbridge:/root/Matterbridge \
   -v /home/<USER>/.matterbridge:/root/.matterbridge \
@@ -95,54 +95,63 @@ copy it in the home directory or edit the existing one to add the matterbridge s
 
 Then start docker compose with:
 
-```
+```bash
 docker compose up -d
 ```
 
 ### Stop with docker compose
 
-```
+```bash
 docker compose down
 ```
 
 ### Update with docker compose
 
-```
+```bash
 docker compose pull
 ```
 
 ### Inspect the container
 
-```
+```bash
 docker container inspect matterbridge
 ```
 
 ### Start the Docker container
 
-```
+```bash
 docker start matterbridge
 ```
 
 ### Stop the Docker container
 
-```
+```bash
 docker stop matterbridge
 ```
 
 ### Restart the Docker container
 
-```
+```bash
 docker restart matterbridge
 ```
 
 ### Shows the logs
 
-```
+```bash
 docker logs matterbridge
 ```
 
-### Shows the logs real time (tail)
+### Shows the logs for a time interval
 
+```bash
+docker logs \
+  --since "2025-04-19T00:00:00" \
+  --until "2025-04-19T00:02:00" \
+  matterbridge
 ```
+
+### Shows the logs real time (tail)
+
+```bash
 docker logs --tail 1000 -f matterbridge
 ```

package/README-SERVICE.md

@@ -20,7 +20,7 @@
 
 This will create the required directories if they don't exist
 
-```
+```bash
 cd ~
 mkdir -p ./Matterbridge
 mkdir -p ./.matterbridge
@@ -31,7 +31,7 @@ sudo chown -R $USER:$USER ./Matterbridge ./.matterbridge
 
 Create a systemctl configuration file for Matterbridge
 
-```
+```bash
 sudo nano /etc/systemd/system/matterbridge.service
 ```
 
@@ -53,8 +53,6 @@ WorkingDirectory=/home/<USER>/Matterbridge
 StandardOutput=inherit
 StandardError=inherit
 Restart=always
-RestartSec=10s
-TimeoutStopSec=30s
 User=<USER>
 Group=<USER>
 
@@ -70,45 +68,53 @@ add this:
 AmbientCapabilities=CAP_NET_BIND_SERVICE
 ```
 
-If you modify it after, then run:
+If you use the matterbridge-bthome plugin add this:
 
 ```
+[Service]
+AmbientCapabilities=CAP_NET_BIND_SERVICE CAP_NET_RAW CAP_NET_ADMIN
+```
+
+If you modify it after, then run:
+
+```bash
 sudo systemctl daemon-reload
+sudo systemctl restart matterbridge.service
 ```
 
 ### Start Matterbridge
 
-```
+```bash
 sudo systemctl start matterbridge
 ```
 
 ### Stop Matterbridge
 
-```
+```bash
 sudo systemctl stop matterbridge
 ```
 
 ### Show Matterbridge status
 
-```
+```bash
 sudo systemctl status matterbridge.service
 ```
 
 ### Enable Matterbridge to start automatically on boot
 
-```
+```bash
 sudo systemctl enable matterbridge.service
 ```
 
 ### Disable Matterbridge from starting automatically on boot
 
-```
+```bash
 sudo systemctl disable matterbridge.service
 ```
 
 ### View the log of Matterbridge in real time (this will show the log with colors)
 
-```
+```bash
 sudo journalctl -u matterbridge.service -n 1000 -f --output cat
 ```
 
@@ -116,13 +122,13 @@ sudo journalctl -u matterbridge.service -n 1000 -f --output cat
 
 Check the space used
 
-```
+```bash
 sudo journalctl --disk-usage
 ```
 
 remove all log older then 3 days
 
-```
+```bash
 sudo journalctl --rotate
 sudo journalctl --vacuum-time=3d
 ```
@@ -131,13 +137,13 @@ sudo journalctl --vacuum-time=3d
 
 If you want to make the setting permanent to prevent the journal logs to grow too much, run
 
-```
+```bash
 sudo nano /etc/systemd/journald.conf
 ```
 
 add
 
-```
+```bash
 Compress=yes            # Compress logs
 MaxRetentionSec=3days   # Keep logs for a maximum of 3 days.
 MaxFileSec=1day         # Rotate logs daily within the 3-day retention period.
@@ -148,7 +154,7 @@ RuntimeMaxUse=100M      # Limit runtime logs in /run/log/journal to 100 MB.
 
 save it and run
 
-```
+```bash
 sudo systemctl restart systemd-journald
 ```
 
@@ -156,7 +162,7 @@ sudo systemctl restart systemd-journald
 
 Run the following command to verify if you can install Matterbridge globally without being prompted for a password:
 
-```
+```bash
 sudo npm install -g matterbridge
 ```
 
@@ -164,7 +170,7 @@ If you are not prompted for a password, no further action is required.
 
 If that is not the case, open the sudoers file for editing using visudo
 
-```
+```bash
 sudo visudo
 ```
 
@@ -176,8 +182,8 @@ verify the presence of of a line
 
 exit and create a configuration file for sudoers
 
-```
-sudo nano  /etc/sudoers.d/matterbridge
+```bash
+sudo nano /etc/sudoers.d/matterbridge
 ```
 
 add this line replacing USER with your user name (e.g. radxa ALL=(ALL) NOPASSWD: ALL)
@@ -194,6 +200,6 @@ or if you prefers to only give access to npm without password try with (e.g. rad
 
 save the file and reload the settings with:
 
-```
+```bash
 sudo visudo -c
 ```

package/README.md

@@ -12,7 +12,7 @@
 
 ---
 
-Matterbridge is a matter.js plugin manager.
+Matterbridge 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 of each single device.
@@ -46,6 +46,22 @@ The project is build on top of https://github.com/project-chip/matter.js.
 
 A special thank to Apollon77 for his incredible work.
 
+## Discord
+
+Join us in the Matterbridge Discord group https://discord.gg/QX58CDe6hd created by Tamer (https://github.com/tammeryousef1006).
+
+## Videos
+
+https://www.youtube.com/watch?v=goNB9Cgh_Fk
+
+## Reviews
+
+https://www.matteralpha.com/how-to/how-to-configure-an-open-source-matter-bridge-at-home
+
+## Press
+
+https://matter-smarthome.de/en/interview/an-alternative-to-the-official-matter-sdk/
+
 ## Prerequisites
 
 To run Matterbridge, you need either a [Node.js](https://nodejs.org/en) environment or [Docker](https://docs.docker.com/get-started/get-docker/) installed on your system.
@@ -57,6 +73,10 @@ Nvm is not a good choice and should not be used for production.
 
 If you don't have Docker already install, please use this method to install it on a debian device: https://docs.docker.com/desktop/setup/install/linux/debian/.
 
+Since as stated in the Matter specifications "Matter aims to build a universal IPv6-based communication protocol for smart home devices", ipv6 should be enabled in the network.
+
+Avoid using VLAN and firewall blocking the communications between the controller and Matterbridge.
+
 ## Installation
 
 Follow these steps to install Matterbridge:
@@ -216,6 +236,38 @@ No hub or dedicated hardware needed.
 
 Matterbridge Somfy Tahoma is a matterbridge production-level plugin that expose the Somfy Tahoma screen devices to Matter.
 
+### Home Assistant
+
+<a href="https://github.com/Luligu/matterbridge-hass">
+  <img src="screenshot/HomeAssistant.svg" alt="Hass logo" width="100" />
+</a>
+
+Matterbridge Home Assistant plugin allows you to expose the Home Assistant devices and entities to Matter.
+
+It is the ideal companion of the official [Matterbridge Home Assistant Add-on](https://github.com/Luligu/matterbridge-home-assistant-addon/blob/main/README.md).
+
+### Webhooks
+
+<a href="https://github.com/Luligu/matterbridge-webhooks">
+  <img src="frontend/public/matterbridge.svg" alt="Matterbridge logo" width="100" />
+</a>
+
+Matterbridge Webhooks plugin allows you to expose any webhooks to Matter..
+
+### BTHome
+
+<a href="https://github.com/Luligu/matterbridge-webhooks">
+  <img src="frontend/public/matterbridge.svg" alt="Matterbridge logo" width="100" />
+</a>
+
+Matterbridge BTHome allows you to expose any BTHome device to Matter using the native bluetooth of the host machine.
+
+Features:
+
+- The bluetooth works correctly on all platforms and is based on the @stoprocent fork of noble.
+- The discovered BTHome devices are stored with all attributes to easily restart the plugin.
+- The plugin has also a command line to test and verify the bluetooth adapter and the ble network.
+
 ### Accessory platform example
 
 This is an example of an accessory platform plugin.
@@ -230,7 +282,7 @@ An Accessory platform plugin only exposes one device.
 
 This is an example of a dynamic platform plugin.
 
-It exposes:
+It exposes 38 devices:
 
 - a switch with onOff cluster
 - a light with onOff
@@ -246,13 +298,31 @@ It exposes:
   and relativeHumidityMeasurement cluster (to show how to create a composed device with sub endpoints)
 - a thermo heat only with two external temperature sensors (tagged like Indoor and Outdoor)
 - a thermo cool only
-- an airConditioner device
-- an airPurifier device with temperature and humidity sensor (supported by Apple Home)
 - a fan with FanControl cluster
 - a rainSensor device
 - a waterFreezeDetector device
 - a waterLeakDetector device
-- a smokeCoAlarm device
+- a smokeCoAlarm (with smoke and co features) sensor (supported by Apple Home)
+- a smokeCoAlarm (with smoke only feature) sensor (supported by Apple Home)
+- a smokeCoAlarm (with co only feature) sensor (supported by Apple Home)
+- an airConditioner device
+- an airPurifier device with temperature and humidity sensor (supported by Apple Home)
+- a pumpDevice device
+- a waterValve device
+- an airQuality device with all concentration measurements clusters (supported by Apple Home only without the concentration measurements)
+- a momentary switch
+- a latching switch
+- a Robot Vacuum Cleaner device (supported by SmartThings, Alexa, Home Assistant and partially by Apple Home). Read also https://github.com/Luligu/matterbridge/discussions/264.
+- a onOff Mounted Switch device (supported by SmartThings, Alexa, Home Assistant)
+- a dimmer Mounted Switch device (supported by SmartThings, Alexa, Home Assistant)
+- a laundry Washer device (supported by SmartThings, Alexa and Home Assistant)
+- a laundry Dryer device (supported by SmartThings, Alexa and Home Assistant)
+- a dishwasher device (supported by SmartThings, Alexa and Home Assistant)
+- a refrigerator device (supported by SmartThings, Alexa and Home Assistant)
+- an oven device (supported by SmartThings, Alexa and Home Assistant)
+- a microwave Oven device (supported by SmartThings, Alexa and Home Assistant)
+- an extractor Hood device (supported by SmartThings, Alexa and Home Assistant)
+- a cooktop device (supported by SmartThings, Alexa and Home Assistant)
 
 All these virtual devices continuously change state and position. The plugin also shows how to use all the command handlers (you can control all the devices).
 
@@ -276,6 +346,12 @@ The history works in both bridge and childbridge mode.
 
 The Eve app only shows the history when the plugins run like an AccessoryPlatform in childbridge mode (this means the plugin is paired directly).
 
+## Third-party plugins
+
+### [Loxone](https://github.com/andrasg/matterbridge-loxone)
+
+A matterbridge plugin that allows connecting Loxone devices to Matter.
+
 ## How to install and add a plugin with the frontend (best option)
 
 Just open the frontend on the link provided in the log, select a plugin and click install.
@@ -406,9 +482,29 @@ All issues have been solved from the version 17.5 of the HomePod/AppleTV. Now th
 
 If you have more then one Apple TV or Home Pod, you can herve better results setting to disabled "Automatic Selection" in "Home Setting", "Home Hubs & Bridges". When "Automatic selection" is disabled, select your Apple Tv if you have one or any of your Home Pod. In this way you should not have anymore more then one session for fabric.
 
+### Manufacturer Serial Number and Model
+
+The Home app forgets about them when you restart the node.
+
+### Appliances
+
+As of version 18.4.x, all Appliances device types are not supported by the Home app. They don't even appear like unsupported accessories.
+
+### Robot
+
+As of version 18.4.x, the Robot is supported by the Home app only as a single, non-bridged device or if it is the only device in the bridge.
+
+If a Robot is present alongside other devices in the bridge, the entire bridge becomes unstable in the Home app.
+
+### Concentration measurements clusters
+
+As of version 18.4.x, all cluster derived from the concentration measurement cluster hang the Home app while pairing and the entire bridge becomes unstable in the Home app.
+
+For example: air quality sensors with TVOC measurement or co sensors with CarbonMonoxide measurement.
+
 ## Home Assistant
 
-So far is the only controller supporting some Matter 1.2 and 1.3 device type:
+So far is the only controller supporting some Matter 1.2, 1.3 and 1.4 device type:
 
 - airQualitySensor code 0x002c (Matter 1.2)
 - smokesmokeCoAlarm code 0x0076 (Matter 1.2)

package/dist/cli.js

@@ -3,6 +3,7 @@ import { Matterbridge } from './matterbridge.js';
 import { getIntParameter, hasParameter } from './utils/export.js';
 import { AnsiLogger, BRIGHT, CYAN, db, YELLOW } from './logger/export.js';
 import { EventEmitter } from 'node:events';
+import { inspect } from 'node:util';
 export const cliEmitter = new EventEmitter();
 export let instance;
 let session;
@@ -186,5 +187,7 @@ async function main() {
 }
 process.title = 'matterbridge';
 main().catch((error) => {
-    log.error(`Matterbridge.loadInstance() failed with error: ${error instanceof Error ? error.message : error}`);
+    const errorMessage = error instanceof Error ? error.message : error;
+    const errorInspect = inspect(error, { depth: 10 });
+    log.error(`Matterbridge.loadInstance() failed with error: ${errorMessage}\nstack: ${errorInspect}`);
 });