matterbridge 3.5.3 → 3.5.4-dev-20260211-520e349

package/CHANGELOG.md

@@ -47,6 +47,53 @@ Advantages:
 - individual plugin isolation in childbridge mode;
 - ability to update the plugin in childbridge mode without restarting matterbridge;
 
+## [3.5.4] - Dev branch
+
+### Dev Breaking Changes
+
+- [exports]: Removed Matterbridge export from matterbridge.
+
+### Breaking Changes
+
+- [doorLock]: The default value for **DoorLock.actuatorEnabled** has been changed to true. Thanks Ludovic BOUÉ (https://github.com/Luligu/matterbridge/pull/509).
+- [ingress]: Removed the `--ingress` parameter used in the old Home Assisant add-on. Update the Matterbridge Home Assistant Application (formerly known as add-on) if you didn't.
+
+### Added
+
+- [packages]: Added **@matterbridge/types** monorepo scoped package.
+- [packages]: Added **@matterbridge/core** monorepo scoped package.
+- [apps]: Added **@matterbridge/frontend** monorepo scoped package.
+- [monorepo]: The transition to a modern monorepo setup with scoped packages is completed.
+- [addon]: Added two other s6-rc based images to be used in the next releases of the [Home Assistant Application](https://github.com/Luligu/matterbridge-home-assistant-addon).
+
+### Changed
+
+- [package]: Updated dependencies.
+- [matterbridge.io]: Updated docs and styles.
+- [docker]: Updated docker readme file to clarify which base image is used.
+- [frontend]: Bumped `frontend` version to v. 3.4.5.
+
+### Fixed
+
+- [worflows]: Fixed workflows that failed and dockerfiles.
+- [childbridge]: Fixed sequence of disabling a plugin in childbridge mode. Thanks [Tamer Salah](https://github.com/tammeryousef1006).
+
+### Security
+
+During installation you may see in the log a warning that looks scary, for example:
+
+```text
+npm warn deprecated glob@10.5.0: Old versions of glob are not supported, and contain widely publicized security vulnerabilities, which have been fixed in the current version. Please update. Support for old versions may be purchased (at exorbitant rates) by contacting i@izs.me
+```
+
+This warning does not come from Matterbridge code.
+
+It is emitted by a transitive dependency (the `archiver` package) that pulls in an older `glob` version. Matterbridge does not depend on this version of `glob` directly.
+
+In short: you can safely ignore this message; it is a dependency warning, not a Matterbridge vulnerability.
+
+<a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
+
 ## [3.5.3] - 2026-02-06
 
 ### Dev Breaking Changes

package/README-DEV.md

@@ -89,51 +89,51 @@ When you want to test your plugin with a paired controller and you cannot use na
 
 Matterbridge exports from:
 
-### "matterbridge"
+**"matterbridge"**
 
-- Matterbridge and all Matterbridge related classes.
+- Matterbridge related classes needed in a plugin.
 
-### "matterbridge/devices"
+**"matterbridge/devices"**
 
 - All single device classes like the Rvc, LaundryWasher, etc...
 
-### "matterbridge/clusters"
+**"matterbridge/clusters"**
 
-- All clusters not present in matter.js or modified.
+- All clusters not present in matter.js or modified. It can be empty.
 
-### "matterbridge/utils"
+**"matterbridge/utils"**
 
 - All general utils and colorUtils functions.
 
-### "matterbridge/logger"
+**"matterbridge/logger"**
 
 - AnsiLogger class.
 
-### "matterbridge/storage"
+**"matterbridge/storage"**
 
 - NodeStorageManager and NodeStorage classes.
 
-### "matterbridge/matter"
+**"matterbridge/matter"**
 
 - All relevant matter.js exports.
 
-### "matterbridge/matter/behaviors"
+**"matterbridge/matter/behaviors"**
 
 - All matter.js behaviors.
 
-### "matterbridge/matter/clusters"
+**"matterbridge/matter/clusters"**
 
 - All matter.js clusters.
 
-### "matterbridge/matter/devices"
+**"matterbridge/matter/devices"**
 
 - All matter.js devices.
 
-### "matterbridge/matter/endpoints"
+**"matterbridge/matter/endpoints"**
 
 - All matter.js endpoints.
 
-### "matterbridge/matter/types"
+**"matterbridge/matter/types"**
 
 - All matter.js types.
 
@@ -217,24 +217,24 @@ matterbridge -add .
 
 ## MatterbridgeDynamicPlatform and MatterbridgeAccessoryPlatform api
 
-### public name: string
+**public name: string**
 
 The plugin name.
 
-### public type: string
+**public type: string**
 
 The plugin platform type.
 
-### public config: object
+**public config: object**
 
 The plugin config (loaded before the platform constructor is called and saved after onShutdown() is called).
 Here you can store your plugin configuration (see matterbridge-zigbee2mqtt for example)
 
-### constructor(matterbridge: PlatformMatterbridge, log: AnsiLogger, config: PlatformConfig)
+**constructor(matterbridge: PlatformMatterbridge, log: AnsiLogger, config: PlatformConfig)**
 
 The contructor is called when is plugin is loaded.
 
-### async onStart(reason?: string)
+**async onStart(reason?: string)**
 
 The method onStart() is where you have to create your MatterbridgeEndpoint and add all needed clusters.
 
@@ -244,7 +244,7 @@ The MatterbridgeEndpoint class has the create cluster methods already done and a
 
 The method is called when Matterbridge load the plugin.
 
-### async onConfigure()
+**async onConfigure()**
 
 The method onConfigure() is where you can configure your matter device.
 
@@ -252,7 +252,7 @@ The method is called when the server node the platform belongs to is online.
 
 Since the persistent attributes are loaded from the storage when the server node goes online, you may need to set them in onConfigure().
 
-### async onShutdown(reason?: string)
+**async onShutdown(reason?: string)**
 
 The method onShutdown() is where you have to stop your platform and cleanup all the used resources.
 
@@ -260,51 +260,51 @@ The method is called when Matterbridge is shutting down or when the plugin is di
 
 Since the frontend can enable and disable the plugin many times, you need to clean all resources (i.e. handlers, intervals, timers...) here.
 
-### async onChangeLoggerLevel(logLevel: LogLevel)
+**async onChangeLoggerLevel(logLevel: LogLevel)**
 
 It is called when the user changes the logger level in the frontend.
 
-### async onAction(action: string, value?: string, id?: string, formData?: PlatformConfig)
+**async onAction(action: string, value?: string, id?: string, formData?: PlatformConfig)**
 
 It is called when a plugin config includes an action button or an action button with text field.
 
-### async onConfigChanged(config: PlatformConfig)
+**async onConfigChanged(config: PlatformConfig)**
 
 It is called when the plugin config has been updated.
 
-### getDevices(): MatterbridgeEndpoint[]
+**getDevices(): MatterbridgeEndpoint[]**
 
 Retrieves the devices registered with the platform.
 
-### getDeviceByName(deviceName: string): MatterbridgeEndpoint | undefined
+**getDeviceByName(deviceName: string): MatterbridgeEndpoint | undefined**
 
-### getDeviceByUniqueId(uniqueId: string): MatterbridgeEndpoint | undefined
+**getDeviceByUniqueId(uniqueId: string): MatterbridgeEndpoint | undefined**
 
-### getDeviceBySerialNumber(serialNumber: string): MatterbridgeEndpoint | undefined
+**getDeviceBySerialNumber(serialNumber: string): MatterbridgeEndpoint | undefined**
 
-### getDeviceById(id: string): MatterbridgeEndpoint | undefined
+**getDeviceById(id: string): MatterbridgeEndpoint | undefined**
 
-### getDeviceByOriginalId(originalId: string): MatterbridgeEndpoint | undefined
+**getDeviceByOriginalId(originalId: string): MatterbridgeEndpoint | undefined**
 
-### getDeviceByNumber(number: EndpointNumber | number): MatterbridgeEndpoint | undefined
+**getDeviceByNumber(number: EndpointNumber | number): MatterbridgeEndpoint | undefined**
 
 They all return MatterbridgeEndpoint or undefined if not found.
 
-### hasDeviceName(deviceName: string): boolean
+**hasDeviceName(deviceName: string): boolean**
 
-### hasDeviceUniqueId(deviceUniqueId: string): boolean
+**hasDeviceUniqueId(deviceUniqueId: string): boolean**
 
 Checks if a device with this name or uniqueId is already registered in the platform.
 
-### async registerDevice(device: MatterbridgeEndpoint)
+**async registerDevice(device: MatterbridgeEndpoint)**
 
 After you have created your device, add it to the platform.
 
-### async unregisterDevice(device: MatterbridgeEndpoint)
+**async unregisterDevice(device: MatterbridgeEndpoint)**
 
 You can unregister a device.
 
-### async unregisterAllDevices()
+**async unregisterAllDevices()**
 
 You can unregister all the devices you added.
 

package/README-DOCKER.md

@@ -25,13 +25,19 @@
 
 The Matterbridge Docker images (multi-arch manifest list for **linux/amd64** and **linux/arm64**) are published on [**Docker Hub**](https://hub.docker.com/r/luligu/matterbridge). If you use them, please consider starring the project on [**Docker Hub**](https://hub.docker.com/r/luligu/matterbridge).
 
-The image (tag **latest**) includes Matterbridge and all official plugins, using the latest release published on npm. It is based on `node:24-trixie-slim`. Since all official plugins are included, you can select and add a plugin without installing anything.
+The image (tag **latest** 92 MB) includes Matterbridge and all official plugins, using the latest release published on npm. It is based on `node:24-trixie-slim`. Since all official plugins are included, you can select and add a plugin without installing anything.
 
-The image (tag **dev**) includes Matterbridge and all official plugins from the latest push on GitHub. It is based on `node:24-trixie-slim`. Since all official plugins are included, you can select and add a plugin without installing anything. Note: if you update to the latest **dev** from the frontend, you will override the GitHub version with the latest **dev** published on npm. The frontend shows if you are currently running the GitHub release or the latest or dev npm release.
+The image (tag **dev** 93 MB) includes Matterbridge and all official plugins from the latest push on GitHub. It is based on `node:24-trixie-slim`. Since all official plugins are included, you can select and add a plugin without installing anything. Note: if you update to the latest **dev** from the frontend, you will override the GitHub version with the latest **dev** published on npm. The frontend shows if you are currently running the GitHub release or the latest or dev npm release.
 
-The image (tag **ubuntu**) includes only Matterbridge, using the latest release published on npm. This image (**for test and development only**) is based on `ubuntu:latest` with Node.js 24 from NodeSource. Plugins are not included in the image; they will be installed on first run. This image preinstalls `bluetooth`, `build-essential`, and `python` packages (useful for plugins that require native builds).
+The image (tag **ubuntu** 90 MB) includes only Matterbridge, using the latest release published on npm. This image (**for test and development only**) is based on `ubuntu:latest` with Node.js 24 from NodeSource. Plugins are not included in the image; they will be installed on first run. This image preinstalls `bluetooth`, `build-essential`, and `python` packages (useful for plugins that require native builds).
 
-The image (tag **alpine**) includes only Matterbridge, using the latest release published on npm. This image (**for test and development only**) is based on `node:24-alpine`. Plugins are not included in the image; they will be installed on first run.
+The image (tag **alpine** 58 MB) includes only Matterbridge, using the latest release published on npm. This image (**for test and development only**) is based on `node:24-alpine`. Plugins are not included in the image; they will be installed on first run.
+
+### Matterbridge docker base images
+
+The image (tag **24-ubuntu-slim** 86 MB) includes only `ubuntu:latest` -> Ubuntu 24.04.3 LTS (noble) with Node.js 24 from NodeSource. It is used to build the **ubuntu** image but can also be used to open a shell in ubuntu latest with node 24.
+
+The image (tag **s6-rc-base** 84 MB) includes only Matterbridge, using the latest release published on npm. This image is based on `node:24-trixie-slim` and integrates the s6-rc overlay system. Plugins are not included in the image; they will be installed on first run. It is used like base image for the [Matterbridge Home Assistant Application](https://github.com/Luligu/matterbridge-home-assistant-addon).
 
 ### Docker health check
 
@@ -78,6 +84,7 @@ After adding your user to the `docker` group, log out and log back in so your cu
 The container must have full access to the host network (needed for mDNS and the Matter protocol).
 
 ```bash
+sudo docker pull luligu/matterbridge:latest
 sudo docker run --name matterbridge \
   -v ~/Matterbridge:/root/Matterbridge \
   -v ~/.matterbridge:/root/.matterbridge \
@@ -90,6 +97,7 @@ You may need to adapt the paths to your setup.
 ### Run the container with extra parameters (e.g. frontend on port 8585)
 
 ```bash
+sudo docker pull luligu/matterbridge:latest
 sudo docker run --name matterbridge \
   -v ~/Matterbridge:/root/Matterbridge \
   -v ~/.matterbridge:/root/.matterbridge \
@@ -124,12 +132,14 @@ Copy it to your home directory or edit your existing compose file to add the Mat
 Then start Docker Compose with:
 
 ```bash
+docker compose pull matterbridge
 docker compose up -d
 ```
 
 Or start only the Matterbridge container with:
 
 ```bash
+docker compose pull matterbridge
 docker compose up -d matterbridge
 ```
 

package/README.md

@@ -219,7 +219,7 @@ or with user matterbridge and with private global node_modules and npm cache (no
 
 ### Run matterbridge as an home assistant add-on with the official add-on
 
-[Home assistant add-on configuration](https://github.com/Luligu/matterbridge-home-assistant-addon)
+[Home assistant application (formerly known as add-on) configuration](https://github.com/Luligu/matterbridge-home-assistant-addon)
 
 ### Other Home Assistant Community Add-ons