matterbridge 1.1.10 → 1.1.12

package/CHANGELOG.md

@@ -2,7 +2,24 @@
 
 All notable changes to this project will be documented in this file.
 
-## [1.1.10] - 2024-03-15
+## [1.1.12] - 2024-03-22
+
+### Added
+
+- [platform]: Added async loadConfig() and async saveConfig() to store plugin config.
+- [platform]: Added a config: Config (JSON) property to platforms to store plugin config.
+
+### Changed
+
+- [dependencies]: Updated dependencies.
+
+## [1.1.11] - 2024-03-19
+
+### Added
+
+- [frontend]: Frontend got updated to 0.8.3.
+
+## [1.1.10] - 2024-03-17
 
 ### Added
 
@@ -11,7 +28,7 @@ All notable changes to this project will be documented in this file.
 - [frontend]: Enable and disable plugin are now available. Restart Matteerbridge after.
 - [frontend]: Frontend got updated to 0.8.2.
 
-## [1.1.9] - 2024-03-15
+## [1.1.9] - 2024-03-16
 
 ### Added
 

package/README.md

@@ -96,9 +96,11 @@ Devices page:
 
 ### Accessory platform example
 
-This an example of an accessory platform plugin.
+This an example of an accessory platform plugin. 
 
-Accessory platform plugins only expose one device.
+It exposes a cover device that continouosly moves position and shows how to use the command handlers (you can control the device).
+
+An Accessory platform plugin only exposes one device.
 
 [See the plugin homepage here](https://github.com/Luligu/matterbridge-example-accessory-platform)
 
@@ -106,7 +108,11 @@ Accessory platform plugins only expose one device.
 
 This an example of a dynamic platform plugin.
 
-Dynamic platform plugins expose as many devices as you need (the limit for the Home app is 150 accessories for bridge).
+It exposes a switch with onOff, a light with onOff-levelControl-colorControl, an outlet with onOff and a cover device.
+
+All these devices continouosly change state and position. The plugin also shows how to use all the command handlers (you can control all the devices).
+
+A Dynamic platform plugin exposes as many devices as you need (the limit for the Home app is 150 accessories for bridge).
 
 Matterbridge can run as many plugins as you want.
 
@@ -124,10 +130,40 @@ Matterbridge can run as many plugins as you want.
 
 [Room plugin with history](https://github.com/Luligu/matterbridge-eve-room)
 
-## How to install a plugin
+## How to install and register a production-level plugin (from npm)
+
+To install i.e. https://github.com/Luligu/matterbridge-zigbee2mqtt
+
+On windows:
+```
+cd $HOME\Matterbridge
+npm install -g matterbridge-zigbee2mqtt
+matterbridge -add matterbridge-zigbee2mqtt
+```
+
+On linux:
+```
+cd ~/Matterbridge
+sudo npm install -g matterbridge-zigbee2mqtt
+matterbridge -add matterbridge-zigbee2mqtt
+```
+
+## How to install and register a plugin for development (from git)
 
 To install i.e. https://github.com/Luligu/matterbridge-example-accessory-platform
 
+On windows:
+```
+cd $HOME\Matterbridge
+```
+
+On linux:
+```
+cd ~/Matterbridge
+```
+
+then
+
 ```
 git clone https://github.com/Luligu/matterbridge-example-accessory-platform
 cd matterbridge-example-accessory-platform
@@ -139,28 +175,28 @@ Then add the plugin to Matterbridge
 matterbridge -add .\
 ```
 
-### How to add a plugin to Matterbridge
+## How to add a plugin to Matterbridge
 
 ```
-matterbridge -add .\
+matterbridge -add [plugin path]
 ```
 
-### How to remove a plugin from Matterbridge
+## How to remove a plugin from Matterbridge
 
 ```
-matterbridge -remove .\
+matterbridge -remove [plugin path]
 ```
 
-### How to disable a registerd plugin 
+## How to disable a registered plugin 
 
 ```
-matterbridge -disable .\
+matterbridge -disable [plugin path]
 ```
 
-### How to enable a registerd plugin 
+## How to enable a registered plugin 
 
 ```
-matterbridge -enable .\
+matterbridge -enable [plugin path]
 ```
 
 ## How to create your plugin
@@ -178,6 +214,15 @@ Add your plugin logic in platform.ts.
 
 ## MatterbridgeDynamicPlatform and MatterbridgeAccessoryPlatform api
 
+### name: string
+The plugin name.
+
+### type: string
+The plugin platform type.
+
+### config: object
+The plugin config (loaded before onStart() is called and save after onShutdown() is called).
+
 ### async onStart(reason?: string)
 The method onStart() is where you have to create your MatterbridgeDevice and add all needed clusters and command handlers. 
 
@@ -204,7 +249,7 @@ You can unregister one or more device.
 ### async unregisterAllDevices()
 You can unregister all devices you added.
 
-It can me be useful to call this method from onShutdown if you don't want to keep all the devices.
+It can be useful to call this method from onShutdown() if you don't want to keep all the devices during development.
 
 ## MatterbridgeDevice api
 

package/dist/matterbridge.d.ts

@@ -41,13 +41,24 @@ interface SystemInformation {
  */
 export declare class Matterbridge extends EventEmitter {
     systemInformation: SystemInformation;
+    matterbridgeInformation: {
+        homeDirectory: string;
+        rootDirectory: string;
+        matterbridgeDirectory: string;
+        matterbridgePluginDirectory: string;
+        globalModulesDirectory: string;
+        matterbridgeVersion: string;
+        matterbridgeLatestVersion: string;
+        bridgeMode: string;
+        debugEnabled: boolean;
+    };
     homeDirectory: string;
     rootDirectory: string;
     matterbridgeDirectory: string;
     matterbridgePluginDirectory: string;
+    globalModulesDirectory: string;
     matterbridgeVersion: string;
     matterbridgeLatestVersion: string;
-    globalModulesDir: string;
     bridgeMode: 'bridge' | 'childbridge' | 'controller' | '';
     debugEnabled: boolean;
     private log;
@@ -232,7 +243,7 @@ export declare class Matterbridge extends EventEmitter {
      * Creates a matter commissioning server.
      *
      * @param {StorageContext} context - The storage context.
-     * @param {string} name - The name of the commissioning server.
+     * @param {string} pluginName - The name of the commissioning server.
      * @returns {CommissioningServer} The created commissioning server.
      */
     private createCommisioningServer;

package/dist/matterbridge.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"matterbridge.d.ts","sourceRoot":"","sources":["../src/matterbridge.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;AAEH,OAAO,EAAE,kBAAkB,EAAgC,MAAM,yBAAyB,CAAC;AAQ3F,OAAO,YAAY,MAAM,QAAQ,CAAC;AAkElC,UAAU,iBAAiB;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB;AAMD;;GAEG;AACH,qBAAa,YAAa,SAAQ,YAAY;IACrC,iBAAiB,EAAE,iBAAiB,CAYzC;IACK,aAAa,EAAE,MAAM,CAAM;IAC3B,aAAa,EAAE,MAAM,CAAM;IAC3B,qBAAqB,EAAE,MAAM,CAAM;IACnC,2BAA2B,EAAE,MAAM,CAAM;IACzC,mBAAmB,EAAE,MAAM,CAAM;IACjC,yBAAyB,EAAE,MAAM,CAAM;IACvC,gBAAgB,EAAE,MAAM,CAAM;IAE9B,UAAU,EAAE,QAAQ,GAAG,aAAa,GAAG,YAAY,GAAG,EAAE,CAAM;IAC9D,YAAY,UAAS;IAE5B,OAAO,CAAC,GAAG,CAAc;IACzB,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,WAAW,CAAiC;IACpD,OAAO,CAAC,WAAW,CAA0B;IAC7C,OAAO,CAAC,UAAU,CAA8B;IAChD,OAAO,CAAC,aAAa,CAAqB;IAE1C,OAAO,CAAC,cAAc,CAA6B;IACnD,OAAO,CAAC,mBAAmB,CAA6B;IACxD,OAAO,CAAC,uBAAuB,CAA6B;IAE5D,OAAO,CAAC,YAAY,CAA2B;IAC/C,OAAO,CAAC,gBAAgB,CAAyB;IACjD,OAAO,CAAC,mBAAmB,CAAkC;IAC7D,OAAO,CAAC,uBAAuB,CAAsC;IAErE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA2B;IAElD,OAAO;IAKP;;;;OAIG;WACU,YAAY,CAAC,UAAU,UAAQ;IAa5C;;;;;;;;;OASG;IACU,UAAU;IAuEvB;;;;;OAKG;YACW,YAAY;IAmC1B;;;;OAIG;YACW,gBAAgB;YA6FhB,iBAAiB;IAoC/B;;;;;OAKG;YACW,kBAAkB;IA8DhC;;;OAGG;YACW,sBAAsB;IAUpC;;OAEG;YACW,cAAc;IAQ5B;;;OAGG;YACW,OAAO;IAoFrB;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAS7B;;;;;OAKG;IACG,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA+B9E;;;;;OAKG;IACG,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA+B/E,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuDxF;;;;;OAKG;IACG,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBhE;;;;;OAKG;YACW,YAAY;IA0B1B;;;;;OAKG;YACW,iBAAiB;IAkB/B;;;OAGG;YACW,WAAW;YASX,qBAAqB;YA+CrB,WAAW;YA6BX,eAAe;YA4Bf,UAAU;IA+CxB;;;;;;;;OAQG;YACW,iBAAiB;YAkIjB,iBAAiB;IAW/B;;;;;;OAMG;IACH,OAAO,CAAC,gCAAgC;IAwBxC;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CAAC,gCAAgC;IAuCxC;;;;;;;;;;OAUG;YACW,uBAAuB;IA4CrC;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IASlB;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;IAmHhC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAM1B;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAuC9B;;OAEG;YACW,UAAU;IAcxB;;;;OAIG;YACW,gBAAgB;IAY9B;;;OAGG;YACW,oBAAoB;IAYlC;;OAEG;YACW,oBAAoB;IAgIlC,OAAO,CAAC,wBAAwB;IAqBhC,OAAO,CAAC,wBAAwB;IAkBhC;;;;OAIG;IACG,kBAAkB,CAAC,IAAI,GAAE,MAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IA4L5D;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;CAsBjC"}
+{"version":3,"file":"matterbridge.d.ts","sourceRoot":"","sources":["../src/matterbridge.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;AAEH,OAAO,EAAE,kBAAkB,EAAgC,MAAM,yBAAyB,CAAC;AAQ3F,OAAO,YAAY,MAAM,QAAQ,CAAC;AAoElC,UAAU,iBAAiB;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB;AAMD;;GAEG;AACH,qBAAa,YAAa,SAAQ,YAAY;IACrC,iBAAiB,EAAE,iBAAiB,CAYzC;IAEK,uBAAuB;;;;;;;;;;MAU5B;IAEK,aAAa,EAAE,MAAM,CAAM;IAC3B,aAAa,EAAE,MAAM,CAAM;IAC3B,qBAAqB,EAAE,MAAM,CAAM;IACnC,2BAA2B,EAAE,MAAM,CAAM;IACzC,sBAAsB,EAAE,MAAM,CAAM;IACpC,mBAAmB,EAAE,MAAM,CAAM;IACjC,yBAAyB,EAAE,MAAM,CAAM;IAEvC,UAAU,EAAE,QAAQ,GAAG,aAAa,GAAG,YAAY,GAAG,EAAE,CAAM;IAC9D,YAAY,UAAS;IAE5B,OAAO,CAAC,GAAG,CAAc;IACzB,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,WAAW,CAAiC;IACpD,OAAO,CAAC,WAAW,CAA0B;IAC7C,OAAO,CAAC,UAAU,CAA8B;IAChD,OAAO,CAAC,aAAa,CAAqB;IAE1C,OAAO,CAAC,cAAc,CAA6B;IACnD,OAAO,CAAC,mBAAmB,CAA6B;IACxD,OAAO,CAAC,uBAAuB,CAA6B;IAE5D,OAAO,CAAC,YAAY,CAA2B;IAC/C,OAAO,CAAC,gBAAgB,CAAyB;IACjD,OAAO,CAAC,mBAAmB,CAAkC;IAC7D,OAAO,CAAC,uBAAuB,CAAsC;IAErE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA2B;IAElD,OAAO;IAKP;;;;OAIG;WACU,YAAY,CAAC,UAAU,UAAQ;IAa5C;;;;;;;;;OASG;IACU,UAAU;IAuEvB;;;;;OAKG;YACW,YAAY;IAmC1B;;;;OAIG;YACW,gBAAgB;YAoGhB,iBAAiB;IAoC/B;;;;;OAKG;YACW,kBAAkB;IA8DhC;;;OAGG;YACW,sBAAsB;IAUpC;;OAEG;YACW,cAAc;IAQ5B;;;OAGG;YACW,OAAO;IAyFrB;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAS7B;;;;;OAKG;IACG,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA+B9E;;;;;OAKG;IACG,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAiC/E,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA2DxF;;;;;OAKG;IACG,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBhE;;;;;OAKG;YACW,YAAY;IA0B1B;;;;;OAKG;YACW,iBAAiB;IAkB/B;;;OAGG;YACW,WAAW;YASX,qBAAqB;YA+CrB,WAAW;YA6BX,eAAe;YA4Bf,UAAU;IAgDxB;;;;;;;;OAQG;YACW,iBAAiB;YAwKjB,iBAAiB;IAW/B;;;;;;OAMG;IACH,OAAO,CAAC,gCAAgC;IAwBxC;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CAAC,gCAAgC;IAuCxC;;;;;;;;;;OAUG;YACW,uBAAuB;IA8BrC;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IASlB;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;IAwIhC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAM1B;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAuC9B;;OAEG;YACW,UAAU;IAcxB;;;;OAIG;YACW,gBAAgB;IAY9B;;;OAGG;YACW,oBAAoB;IAYlC;;OAEG;YACW,oBAAoB;IAuIlC,OAAO,CAAC,wBAAwB;IAqBhC,OAAO,CAAC,wBAAwB;IAkBhC;;;;OAIG;IACG,kBAAkB,CAAC,IAAI,GAAE,MAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAwM5D;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;CAsBjC"}