matterbridge 3.0.7-dev-20250615-2a6da14 → 3.0.7-dev-20250616-cd7fd1c

package/CHANGELOG.md

@@ -16,11 +16,14 @@ If you like this project and find it useful, please consider giving it a star on
 
 ### Added
 
+- [template]: Added the [Matterbridge Plugin Template](https://github.com/Luligu/matterbridge-plugin-template).
+
 ### Changed
 
 - [package]: Updated dependencies.
 - [package]: Downgrade jest to 29.7.0.
 - [energy]: Added parameter for cumulativeEnergyExported to the helper. For solar power device.
+- [platform]: Removed long deprecated methods: validateEntityBlackList and validateDeviceWhiteBlackList. Use validateDevice and validateEntity.
 
 ### Fixed
 

package/README-DEV.md

@@ -14,6 +14,20 @@
 
 # Development
 
+## How to create your plugin
+
+The easiest way is to clone the [Matterbridge Plugin Template](https://github.com/Luligu/matterbridge-plugin-template) that has **Dev Container support for instant development environment** and all tools and extensions (like Node.js, npm, TypeScript, ESLint, Prettier, Jest) already loaded and configured.
+
+Then change the name (keep matterbridge- at the beginning of the name), version, description, author, homepage, repository, bugs and funding in the package.json.
+
+It is possible to add two custom properties to the package.json: **help** and **changelog** with a url that will be used in the frontend instead of the default (/blob/main/README.md and /blob/main/CHANGELOG.md).
+
+Add your plugin logic in module.ts.
+
+The Matterbridge Plugin Template has an already configured Jest test (coverage 100%) that you can expand while you add your own plugin logic.
+
+It also has a workflow configured to run on push and pull request that build, lint and test the plugin on node 18, 20, 22 and 24 with ubuntu, macOS and windows.
+
 ## Guidelines on imports/exports
 
 Matterbridge exports from:
@@ -66,13 +80,13 @@ Matterbridge exports from:
 
 - All matter.js types.
 
-# \***\*\*\*\*\***
+### WARNING \***\*\*\*\*\***
 
 A plugin must never install or import from `@matter` or `@project-chip` directly (neither as a dependency, devDependency, nor peerDependency), as this leads to a second instance of `matter.js`, causing instability and unpredictable errors such as "The only instance is Endpoint".
 
 Additionally, when Matterbridge updates the `matter.js` version, it should be consistent across all plugins.
 
-# \***\*\*\*\*\***
+### WARNING \***\*\*\*\*\***
 
 A plugin must never install Matterbridge (neither as a dependency, devDependency, nor peerDependency).
 
@@ -86,27 +100,15 @@ Matterbridge must be linked to the plugin in development only. At runtime the pl
 }
 ```
 
-On the machine you use for development of your plugin, you need to clone matterbridge, built it locally and link it globally (npm link from the matterbridge package root).
+If you don't use Dev Container from the Matterbridge Plugin Template, on the machine you use for development of your plugin, you need to clone matterbridge, built it locally and link it globally (npm link from the matterbridge package root).
 
-If you want to develop a plugin using the dev branch of matterbridge, you have to clone the dev branch of matterbridge, build it locally and link it (npm run deepCleanBuild).
+If you want to develop a plugin using the dev branch of matterbridge (I suggest you do it), you have to clone the dev branch of matterbridge, build it locally and link it (npm run deepCleanBuild does all necessary steps).
 
-# \***\*\*\*\*\***
+Always keep your local instance of matterbridge up to date.
 
-I added some error messages when a plugin has wrong imports or configurations and the plugin will be disabled to prevent instability and crashes.
+### WARNING \***\*\*\*\*\***
 
-## How to create your plugin
-
-The easiest way is to clone:
-
-- https://github.com/Luligu/matterbridge-example-accessory-platform if you want to create an Accessory Platform Plugin.
-
-- https://github.com/Luligu/matterbridge-example-dynamic-platform if you want to create a Dynamic Platform Plugin.
-
-Then change the name (keep matterbridge- at the beginning of the name), version, description, author and funding in the package.json.
-
-It is possible to add these custom properties to the package.json: help and changelog with a url that will be used in the frontend instead of the default (/blob/main/README.md and /blob/main/CHANGELOG.md).
-
-Add your plugin logic in platform.ts.
+Some error messages are logged on start when a plugin has wrong imports or configurations and the plugin will be disabled to prevent instability and crashes.
 
 ## How to install and register a plugin for development (from github)
 
@@ -197,6 +199,10 @@ It is called when a plugin config includes an action button or an action button
 
 It is called when the plugin config has been updated.
 
+### getDevices(): MatterbridgeEndpoint[]
+
+Retrieves the devices registered with the platform.
+
 ### hasDeviceName(deviceName: string): boolean
 
 Checks if a device with this name is already registered in the platform.
@@ -207,7 +213,7 @@ After you have created your device, add it to the platform.
 
 ### async unregisterDevice(device: MatterbridgeEndpoint)
 
-You can unregister one or more device.
+You can unregister a device.
 
 ### async unregisterAllDevices()
 
@@ -215,7 +221,7 @@ You can unregister all the devices you added.
 
 It can be useful to call this method from onShutdown() if you don't want to keep all the devices during development.
 
-## MatterbridgeDevice api
+## MatterbridgeEndpoint api
 
 Work in progress...
 

package/README.md

@@ -22,10 +22,10 @@ The developer just focuses on the device development extending the provided clas
 
 Just pair Matterbridge once, and it will load all your registered plugins.
 
-This project aims to allow the porting of homebridge plugins to matterbridge plugins without recoding everything.
+This project aims to allow the porting of homebridge plugins to matterbridge plugins without recoding everything ([Development](README-DEV.md)).
 
-It creates a device to pair in any ecosystem like Apple Home, Google Home, Amazon Alexa, or
-any other ecosystem supporting Matter like Home Assistant.
+It creates a device to pair in any ecosystem like Apple Home, Google Home, Amazon Alexa, Home Assistant or
+any other ecosystem supporting Matter.
 
 You don't need a hub or a dedicated new machine.
 

package/dist/matterbridge.js

@@ -1598,10 +1598,10 @@ export class Matterbridge extends EventEmitter {
     }
     startEndAdvertiseTimer(matterServerNode) {
         if (this.endAdvertiseTimeout) {
-            this.log.debug(`***Clear ${matterServerNode.id} server node end advertise timer`);
+            this.log.debug(`Clear ${matterServerNode.id} server node end advertise timer`);
             clearTimeout(this.endAdvertiseTimeout);
         }
-        this.log.debug(`***Starting ${matterServerNode.id} server node end advertise timer`);
+        this.log.debug(`Starting ${matterServerNode.id} server node end advertise timer`);
         this.endAdvertiseTimeout = setTimeout(() => {
             if (matterServerNode.lifecycle.isCommissioned)
                 return;

package/dist/matterbridgePlatform.js

@@ -20,7 +20,6 @@ export class MatterbridgePlatform {
     ready;
     _registeredEndpoints = new Map();
     _registeredEndpointsByName = new Map();
-    _storedDevices = new Map();
     constructor(matterbridge, log, config) {
         this.matterbridge = matterbridge;
         this.log = log;
@@ -76,7 +75,6 @@ export class MatterbridgePlatform {
         this.selectEntity.clear();
         this._registeredEndpoints.clear();
         this._registeredEndpointsByName.clear();
-        this._storedDevices.clear();
         await this.context?.close();
         this.context = undefined;
         await this.storage?.close();
@@ -90,6 +88,9 @@ export class MatterbridgePlatform {
     async onConfigChanged(config) {
         this.log.debug(`The plugin ${CYAN}${config.name}${db} doesn't override onConfigChanged. Received new config.`);
     }
+    getDevices() {
+        return Array.from(this._registeredEndpoints.values());
+    }
     hasDeviceName(deviceName) {
         return this._registeredEndpointsByName.has(deviceName);
     }
@@ -207,9 +208,6 @@ export class MatterbridgePlatform {
             return false;
         return true;
     }
-    validateDeviceWhiteBlackList(device, log = true) {
-        return this.validateDevice(device, log);
-    }
     validateDevice(device, log = true) {
         if (!Array.isArray(device))
             device = [device];
@@ -239,9 +237,6 @@ export class MatterbridgePlatform {
             this.log.info(`Skipping device ${CYAN}${device.join(', ')}${nf} because not in whitelist`);
         return false;
     }
-    validateEntityBlackList(device, entity, log = true) {
-        return this.validateEntity(device, entity, log);
-    }
     validateEntity(device, entity, log = true) {
         if (isValidArray(this.config.entityBlackList, 1) && this.config.entityBlackList.find((e) => e === entity)) {
             if (log)

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge",
-  "version": "3.0.7-dev-20250615-2a6da14",
+  "version": "3.0.7-dev-20250616-cd7fd1c",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge",
-      "version": "3.0.7-dev-20250615-2a6da14",
+      "version": "3.0.7-dev-20250616-cd7fd1c",
       "license": "Apache-2.0",
       "dependencies": {
         "@matter/main": "0.14.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge",
-  "version": "3.0.7-dev-20250615-2a6da14",
+  "version": "3.0.7-dev-20250616-cd7fd1c",
   "description": "Matterbridge plugin manager for Matter",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",