matterbridge 1.1.4 → 1.1.5

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.1.5] - 2024-03-11
+
+### Added
+
+- [debug]: Added public property enableDebug to Matterbridge. 
+- [debug]: Added parameter -debug to the command line. 
+
+### Fixed
+
+- [plugin]: Fixed the plugin.paired and plugin.commissioned in bridge mode.
+- [routes]: Fixed the plugin devices route.
+- [bridge]: Fixed the BasicInformationCluster in bridge mode.
+
 ## [1.1.4] - 2024-03-10
 
 ### Changed

package/README.md

@@ -1,11 +1,9 @@
-# Matterbridge
+# <img src="https://github.com/Luligu/matterbridge/blob/main/frontend/public/matterbridge%2064x64.png" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge
 
 [![npm version](https://img.shields.io/npm/v/matterbridge.svg)](https://www.npmjs.com/package/matterbridge)
 [![npm downloads](https://img.shields.io/npm/dt/matterbridge.svg)](https://www.npmjs.com/package/matterbridge)
 
-
 [![power by](https://img.shields.io/badge/powered%20by-node--ansi--logger-blue)](https://www.npmjs.com/package/node-ansi-logger)
-
 [![power by](https://img.shields.io/badge/powered%20by-node--persist--manager-blue)](https://www.npmjs.com/package/node-persist-manager)
 
 ---
@@ -27,16 +25,19 @@ any other ecosystem supporting Matter.
 
 The project is build on top of https://github.com/project-chip/matter.js. 
 
-A special thank to Apollon77 for is incredible work.
+A special thank to Apollon77 for his incredible work.
 
 ## Installation
 
 Follow these steps to install Matterbridge:
-```
+
+on Windows:
+``` powershell
 npm install -g matterbridge
 ```
-or
-```
+
+on Linux (you need the necessary permissions):
+``` bash
 sudo npm install -g matterbridge
 ```
 
@@ -73,7 +74,7 @@ matterbridge -help
 
 ## Frontend
 
-Matterbridge has a frontend (currently under development) available http://localhost:3000
+Matterbridge has a frontend available on http://localhost:3000
 
 You can change the default port by adding the frontend parameter when you launch it.
 Here's how to specify a different port number:
@@ -125,12 +126,13 @@ Matterbridge can run as many plugins as you want.
 ## How to install a plugin
 
 To install i.e. https://github.com/Luligu/matterbridge-example-accessory-platform
+
 ```
 git clone https://github.com/Luligu/matterbridge-example-accessory-platform
 cd matterbridge-example-accessory-platform
 npm install
-npm run build
 ```
+
 Then add the plugin to Matterbridge
 ```
 matterbridge -add .\

package/dist/matterbridge.d.ts

@@ -42,7 +42,9 @@ export declare class Matterbridge {
     homeDirectory: string;
     rootDirectory: string;
     matterbridgeDirectory: string;
+    matterbridgeVersion: string;
     bridgeMode: 'bridge' | 'childbridge' | 'controller' | '';
+    debugEnabled: boolean;
     private log;
     private hasCleanupStarted;
     private registeredPlugins;
@@ -61,7 +63,7 @@ export declare class Matterbridge {
     private constructor();
     /**
      * Loads an instance of the Matterbridge class.
-     * If an instance already exists, an error will be thrown.
+     * If an instance already exists, return that instance.
      * @returns The loaded instance of the Matterbridge class.
      */
     static loadInstance(cli?: boolean): Promise<Matterbridge>;
@@ -85,10 +87,10 @@ export declare class Matterbridge {
     /**
      * Loads a plugin from the specified package.json file path.
      * @param packageJsonPath - The path to the package.json file of the plugin.
-     * @param mode - The mode of operation. Possible values are 'load', 'add', 'remove', 'enable', 'disable'.
+     * @param mode - The mode of operation. Possible values are 'add', 'remove', 'enable', 'disable'.
      * @returns A Promise that resolves when the plugin is loaded successfully, or rejects with an error if loading fails.
      */
-    private loadPlugin;
+    private executeCommandLine;
     /**
      * Registers the signal handlers for SIGINT and SIGTERM.
      * When either of these signals are received, the cleanup method is called with an appropriate message.
@@ -110,12 +112,14 @@ export declare class Matterbridge {
      * Adds a device to the Matterbridge.
      * @param pluginName - The name of the plugin.
      * @param device - The device to be added.
+     * @returns A Promise that resolves when the device is added successfully.
      */
     addDevice(pluginName: string, device: MatterbridgeDevice): Promise<void>;
     /**
      * Adds a bridged device to the Matterbridge.
      * @param pluginName - The name of the plugin.
      * @param device - The bridged device to add.
+     * @returns {Promise<void>} - A promise that resolves when the storage process is started.
      */
     addBridgedDevice(pluginName: string, device: MatterbridgeDevice): Promise<void>;
     /**
@@ -137,6 +141,10 @@ export declare class Matterbridge {
      * @returns {Promise<void>} A promise that resolves when the storage is stopped.
      */
     private stopStorage;
+    private testStartMatterBridge;
+    private startPlugin;
+    private configurePlugin;
+    private loadPlugin;
     /**
      * Starts the Matterbridge based on the bridge mode.
      * If the bridge mode is 'bridge', it creates a commissioning server, matter aggregator,
@@ -222,7 +230,8 @@ export declare class Matterbridge {
      * Logs the node and system information.
      */
     private logNodeAndSystemInfo;
-    private getBaseRegisteredPlugin;
+    private getBaseRegisteredPlugins;
+    private getBaseRegisteredDevices;
     /**
      * Initializes the frontend of Matterbridge.
      *

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,EAAE,MAAM,yBAAyB,CAAC;AAsE7D,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;AAKD;;GAEG;AACH,qBAAa,YAAY;IAChB,iBAAiB,EAAE,iBAAiB,CAYzC;IACK,aAAa,EAAG,MAAM,CAAC;IACvB,aAAa,EAAG,MAAM,CAAC;IACvB,qBAAqB,EAAG,MAAM,CAAC;IAE/B,UAAU,EAAE,QAAQ,GAAG,aAAa,GAAG,YAAY,GAAG,EAAE,CAAM;IAErE,OAAO,CAAC,GAAG,CAAc;IACzB,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,WAAW,CAA6C;IAChE,OAAO,CAAC,WAAW,CAAsC;IACzD,OAAO,CAAC,GAAG,CAAmB;IAE9B,OAAO,CAAC,cAAc,CAAkB;IACxC,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,OAAO,CAAC,uBAAuB,CAAkB;IAEjD,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,gBAAgB,CAAc;IACtC,OAAO,CAAC,mBAAmB,CAAuB;IAClD,OAAO,CAAC,uBAAuB,CAA2B;IAE1D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAe;IAEtC,OAAO;IAIP;;;;OAIG;WACU,YAAY,CAAC,GAAG,UAAQ;IAerC;;;;;;;;;OASG;IACU,UAAU;IAoDvB;;;;OAIG;YACW,gBAAgB;IA6D9B;;;;;OAKG;YACW,UAAU;IA4FxB;;;OAGG;YACW,sBAAsB;IAUpC;;;OAGG;YACW,OAAO;IA6CrB;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAS7B;;;;OAIG;IACG,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB;IAyC9D;;;;OAIG;IACG,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB;IA2BrE;;;;;OAKG;YACW,YAAY;IAyB1B;;;;;OAKG;YACW,iBAAiB;IAkB/B;;;OAGG;YACW,WAAW;IAMzB;;;;;;;;OAQG;YACW,iBAAiB;YA2HjB,iBAAiB;IAK/B;;;;;;OAMG;IACH,OAAO,CAAC,gCAAgC;IAwBxC;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CAAC,gCAAgC;IAmCxC;;;;;;;;;;OAUG;IACH,OAAO,CAAC,uBAAuB;IAkB/B;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IASlB;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;IA2GhC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAK1B;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAuC9B;;OAEG;YACW,UAAU;IAUxB;;OAEG;YACW,oBAAoB;IA+ElC,OAAO,CAAC,uBAAuB;IAkB/B;;;;OAIG;IACG,kBAAkB,CAAC,IAAI,GAAE,MAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAgH5D;;;;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;AAuE3F,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,YAAY;IAChB,iBAAiB,EAAE,iBAAiB,CAYzC;IACK,aAAa,EAAE,MAAM,CAAM;IAC3B,aAAa,EAAE,MAAM,CAAM;IAC3B,qBAAqB,EAAE,MAAM,CAAM;IACnC,mBAAmB,EAAE,MAAM,CAAM;IAEjC,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,GAAG,CAAmB;IAE9B,OAAO,CAAC,cAAc,CAAkB;IACxC,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,OAAO,CAAC,uBAAuB,CAAkB;IAEjD,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,gBAAgB,CAAc;IACtC,OAAO,CAAC,mBAAmB,CAAuB;IAClD,OAAO,CAAC,uBAAuB,CAA2B;IAE1D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAe;IAEtC,OAAO;IAIP;;;;OAIG;WACU,YAAY,CAAC,GAAG,UAAQ;IAerC;;;;;;;;;OASG;IACU,UAAU;IA8DvB;;;;OAIG;YACW,gBAAgB;IAgE9B;;;;;OAKG;YACW,kBAAkB;IAyDhC;;;OAGG;YACW,sBAAsB;IAUpC;;;OAGG;YACW,OAAO;IAgDrB;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAS7B;;;;;OAKG;IACG,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA2B9E;;;;;OAKG;IACG,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA2BrF;;;;;OAKG;YACW,YAAY;IAyB1B;;;;;OAKG;YACW,iBAAiB;IAkB/B;;;OAGG;YACW,WAAW;YAMX,qBAAqB;YA+BrB,WAAW;YA6BX,eAAe;YA4Bf,UAAU;IA8CxB;;;;;;;;OAQG;YACW,iBAAiB;YA0GjB,iBAAiB;IAM/B;;;;;;OAMG;IACH,OAAO,CAAC,gCAAgC;IAwBxC;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CAAC,gCAAgC;IAmCxC;;;;;;;;;;OAUG;IACH,OAAO,CAAC,uBAAuB;IAkB/B;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IASlB;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;IA+GhC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAK1B;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAuC9B;;OAEG;YACW,UAAU;IAUxB;;OAEG;YACW,oBAAoB;IAoFlC,OAAO,CAAC,wBAAwB;IAkBhC,OAAO,CAAC,wBAAwB;IAkBhC;;;;OAIG;IACG,kBAAkB,CAAC,IAAI,GAAE,MAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IA+G5D;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;CAsBjC"}