matterbridge 3.2.8 → 3.2.9-dev-20250922-517cae7

package/CHANGELOG.md

@@ -8,10 +8,33 @@ If you like this project and find it useful, please consider giving it a star on
   <img src="bmc-button.svg" alt="Buy me a coffee" width="120">
 </a>
 
-## [3.2.8] - 2025-09-20
+## [3.2.9] - Not released
 
 ### Breaking Changes
 
+- [profiles]: Profile management has changed. Now, each profile has its own independent directories under `profiles` with storage, matterstorage, plugin config, and plugin directory. This means that if you are using profiles, Matterbridge will not find the old profile data. This allows to run multiple instances of matterbridge (change the frontend port and the matter port for each profile) or to simply make a test of a new plugin without modifing your production setup.
+
+### Added
+
+- [frontend]: Bumped `frontend` version to 3.1.0. Fully typed with the backend.
+- [frontend]: Removed legacy `react-table` and created an autonomous component `MbfTable`. Features: unique UI for all tables with integrated column sorting and column selection.
+- [frontend]: Use MbfTable for Plugins, Devices, Registered devices and Clusters tables.
+
+### Changed
+
+- [matter]: Bumped `matter.js` version to 0.15.4. Thanks matter.js!
+- [package]: Updated dependencies.
+
+### Fixed
+
+- [frontend]: Fix default values for homePageMode in MatterbridgeSettings
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
+## [3.2.8] - 2025-09-20
+
 ### Added
 
 - [logger]: Set different color for log names to matterbridge, frontend and matter.js.

package/README-NGINX.md

@@ -18,9 +18,18 @@
 
 ## Run matterbridge with nginx
 
-### Create a basic nginx configuration file that redirect to http://yourhost:8283
+### Install nginx if it is not installed
 
+```bash
+sudo apt update
+sudo apt install nginx
 ```
+
+### Create a basic nginx configuration file that redirect from http://yourhost to http://yourhost:8283
+
+Create or edit the matterbridge configuration file
+
+```bash
 sudo nano /etc/nginx/sites-available/matterbridge
 ```
 
@@ -33,7 +42,7 @@ server {
     server_name _;
 
     location / {
-        # Redirect to Matterbridge frontend from http:/server_name:80
+        # Redirect to Matterbridge frontend from http:/yourhost:80
         proxy_pass http://localhost:8283/;
         proxy_set_header Host                 $host;
         proxy_set_header X-Real-IP            $remote_addr;
@@ -54,7 +63,16 @@ Add matterbridge to enabled sites
 sudo ln -s /etc/nginx/sites-available/matterbridge /etc/nginx/sites-enabled/
 ```
 
-### Create a basic nginx configuration file that redirect to http://yourhost:8283/matterbridge
+Restart nginx and test the configuration
+
+```bash
+sudo systemctl restart nginx
+sudo nginx -t
+```
+
+### Create a basic nginx configuration file that redirect from http://yourhost/matterbridge to http://yourhost:8283/matterbridge
+
+Create or edit the matterbridge configuration file
 
 ```bash
 sudo nano /etc/nginx/sites-available/matterbridge
@@ -69,7 +87,7 @@ server {
     server_name _;
 
     location /matterbridge/ {
-        # Redirect to Matterbridge frontend from http:/server_name/matterbridge:80
+        # Redirect to Matterbridge frontend from http:/yourhost/matterbridge:80
         proxy_pass http://localhost:8283/;
         proxy_set_header Host                     $host;
         proxy_set_header X-Real-IP                $remote_addr;
@@ -97,17 +115,19 @@ sudo systemctl restart nginx
 sudo nginx -t
 ```
 
-### Create an advanced nginx configuration file that redirect to http://yourhost:8283 with ssl
+### Create an advanced nginx configuration file that redirect from http://yourhost or https://yourhost to http://yourhost:8283 with ssl
+
+Add your certificates in /etc/nginx/certs: `cert.pem` and `key.pem`
+
+Create or edit the matterbridge configuration file
 
 ```bash
 sudo nano /etc/nginx/sites-available/matterbridge
 ```
 
-paste this configuration adding your certificates:
+paste this configuration:
 
 ```
-# Default server configuration
-
 # Redirect all HTTP requests to HTTPS
 server {
     listen 80 default_server;
@@ -134,7 +154,7 @@ server {
     ssl_prefer_server_ciphers on;
 
     location / {
-      # Redirect to Matterbridge frontend from https:/server_name:443
+      # Redirect to Matterbridge frontend from https:/yourhost:443
       proxy_pass http://localhost:8283/;
       proxy_set_header Host                 $host;
       proxy_set_header X-Real-IP            $remote_addr;
@@ -162,13 +182,17 @@ sudo systemctl restart nginx
 sudo nginx -t
 ```
 
-### Create an advanced nginx configuration file that redirect to http://yourhost/matterbridge with ssl
+### Create an advanced nginx configuration file that redirect from http://yourhost/matterbridge or https://yourhost/matterbridge to http://yourhost/matterbridge with ssl
+
+Add your certificates in /etc/nginx/certs: `cert.pem` and `key.pem`
+
+Create or edit the matterbridge configuration file
 
 ```bash
 sudo nano /etc/nginx/sites-available/matterbridge
 ```
 
-paste this configuration adding your certificates:
+paste this configuration:
 
 ```
 # Redirect all HTTP requests to HTTPS
@@ -205,19 +229,19 @@ server {
 		try_files $uri $uri/ =404;
 	}
 
-    location /matterbridge/ {
-	    # Redirect to Matterbridge frontend from https:/server_name/matterbridge:443
-        proxy_pass http://localhost:8283/;
-        proxy_set_header Host                       $host;
-        proxy_set_header X-Real-IP                  $remote_addr;
-        proxy_set_header X-Forwarded-For            $proxy_add_x_forwarded_for;
-        proxy_set_header X-Forwarded-Proto          $scheme;
+  location /matterbridge/ {
+    # Redirect to Matterbridge frontend from https:/yourhost/matterbridge:443
+      proxy_pass http://localhost:8283/;
+      proxy_set_header Host                       $host;
+      proxy_set_header X-Real-IP                  $remote_addr;
+      proxy_set_header X-Forwarded-For            $proxy_add_x_forwarded_for;
+      proxy_set_header X-Forwarded-Proto          $scheme;
 
-	    # WebSocket support
-        proxy_http_version 1.1;
-        proxy_set_header Upgrade                    $http_upgrade;
-        proxy_set_header Connection                 $http_connection;
-    }
+    # WebSocket support
+      proxy_http_version 1.1;
+      proxy_set_header Upgrade                    $http_upgrade;
+      proxy_set_header Connection                 $http_connection;
+  }
 }
 ```
 

package/dist/cli.js

@@ -1,44 +1,17 @@
-/**
- * This file contains the CLI entry point of Matterbridge.
- *
- * @file cli.ts
- * @author Luca Liguori
- * @created 2023-12-29
- * @version 2.0.1
- * @license Apache-2.0
- *
- * Copyright 2023, 2024, 2025 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 import os from 'node:os';
 import { inspect } from 'node:util';
-// AnsiLogger module
 import { AnsiLogger, BRIGHT, CYAN, db, YELLOW } from 'node-ansi-logger';
-// Matterbridge
 import { getIntParameter, hasParameter } from './utils/export.js';
 import { Matterbridge } from './matterbridge.js';
 import { cliEmitter, lastCpuUsage, setLastCpuUsage } from './cliEmitter.js';
 export let instance;
-// Inspectop
 let session;
 let snapshotInterval;
-// Cpu and memory check
 let memoryCheckInterval;
 let prevCpus;
 let peakCpu = 0;
 let peakRss = 0;
-const log = new AnsiLogger({ logName: 'Cli', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: hasParameter('debug') ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
+const log = new AnsiLogger({ logName: 'Cli', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
 const formatMemoryUsage = (bytes) => {
     if (bytes >= 1024 ** 3) {
         return `${(bytes / 1024 ** 3).toFixed(2)} GB`;
@@ -65,20 +38,14 @@ const formatOsUpTime = (seconds) => {
     }
     return `${seconds} second${seconds !== 1 ? 's' : ''}`;
 };
-/**
- * Starts the CPU and memory check interval.
- */
 async function startCpuMemoryCheck() {
-    // const os = await import('node:os');
     log.debug(`Cpu memory check started`);
     prevCpus = os.cpus();
     clearInterval(memoryCheckInterval);
     const interval = () => {
-        // Get the os uptime
         const systemUptime = formatOsUpTime(Math.floor(os.uptime()));
         const processUptime = formatOsUpTime(Math.floor(process.uptime()));
         cliEmitter.emit('uptime', systemUptime, processUptime);
-        // Get the memory usage
         const totalMememory = formatMemoryUsage(os.totalmem());
         const freeMemory = formatMemoryUsage(os.freemem());
         const memoryUsageRaw = process.memoryUsage();
@@ -90,12 +57,10 @@ async function startCpuMemoryCheck() {
         if (memoryUsageRaw.rss > peakRss)
             peakRss = memoryUsageRaw.rss;
         cliEmitter.emit('memory', totalMememory, freeMemory, rss, heapTotal, heapUsed, external, arrayBuffers);
-        // Get the cpu usage
         const currCpus = os.cpus();
-        // log.debug(`Cpus: ${JSON.stringify(currCpus)}`);
         let cpuUsageLog;
         if (currCpus.length !== prevCpus.length) {
-            prevCpus = currCpus; // Reset the previous cpus
+            prevCpus = currCpus;
             log.debug(`Cpu check length failed, resetting previous cpus`);
             return;
         }
@@ -121,29 +86,20 @@ async function startCpuMemoryCheck() {
             cliEmitter.emit('cpu', lastCpuUsage);
         }
         prevCpus = currCpus;
-        // Show the cpu and memory usage
         log.debug(`***${YELLOW}${BRIGHT}Cpu usage:${db} ${CYAN}${cpuUsageLog.padStart(6, ' ')} %${db} ${YELLOW}${BRIGHT}Memory usage:${db} rss ${CYAN}${rss}${db} heapTotal ${CYAN}${heapTotal}${db} heapUsed ${CYAN}${heapUsed}${db} external ${external} arrayBuffers ${arrayBuffers}`);
     };
     interval();
     clearInterval(memoryCheckInterval);
     memoryCheckInterval = setInterval(interval, getIntParameter('memoryinterval') ?? 10 * 1000).unref();
 }
-/**
- * Stops the CPU and memory check interval.
- */
 async function stopCpuMemoryCheck() {
     log.debug(`***Cpu memory check stopped. Peak cpu: ${CYAN}${peakCpu.toFixed(2)} %${db}. Peak rss: ${CYAN}${formatMemoryUsage(peakRss)}${db}.`);
     clearInterval(memoryCheckInterval);
 }
-/**
- * Starts the inspector for heap sampling.
- * This function is called when the -inspect parameter is passed.
- */
 async function startInspector() {
     const { Session } = await import('node:inspector');
     const { mkdirSync } = await import('node:fs');
     log.debug(`***Starting heap sampling...`);
-    // Create the heap snapshots directory if it doesn't exist
     mkdirSync('heap_profile', { recursive: true });
     try {
         session = new Session();
@@ -152,7 +108,6 @@ async function startInspector() {
             session?.post('HeapProfiler.startSampling', (err) => (err ? reject(err) : resolve()));
         });
         log.debug(`***Started heap sampling`);
-        // Set an interval to take heap snapshots
         const interval = getIntParameter('snapshotinterval');
         if (interval && interval >= 30000) {
             log.debug(`***Started heap snapshot interval of ${CYAN}${interval}${db} ms`);
@@ -170,19 +125,13 @@ async function startInspector() {
         return;
     }
 }
-/**
- * Stops the heap sampling and saves the profile to a file.
- * This function is called when the inspector is stopped.
- */
 async function stopInspector() {
     const { writeFileSync } = await import('node:fs');
     const path = await import('node:path');
     log.debug(`***Stopping heap sampling...`);
     if (snapshotInterval) {
         log.debug(`***Clearing heap snapshot interval...`);
-        // Clear the snapshot interval if it exists
         clearInterval(snapshotInterval);
-        // Take a final heap snapshot before stopping
         await takeHeapSnapshot();
     }
     if (!session) {
@@ -190,7 +139,6 @@ async function stopInspector() {
         return;
     }
     try {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const result = await new Promise((resolve, reject) => {
             session?.post('HeapProfiler.stopSampling', (err, result) => (err ? reject(err) : resolve(result)));
         });
@@ -208,13 +156,6 @@ async function stopInspector() {
         log.debug(`***Stopped heap sampling`);
     }
 }
-/**
- * Takes a heap snapshot and saves it to the file name Heap-snapshot-<timestamp>.heapsnapshot.
- * This function is called periodically based on the -snapshotinterval parameter.
- * The -snapshotinterval parameter must at least 30000 ms.
- * The snapshot is saved in the heap_profile directory that is created in the current working directory.
- * The snapshot can be analyzed using vscode or Chrome DevTools or other tools that support heap snapshots.
- */
 async function takeHeapSnapshot() {
     const { writeFileSync } = await import('node:fs');
     const path = await import('node:path');
@@ -246,10 +187,6 @@ async function takeHeapSnapshot() {
         });
     });
 }
-/**
- * Triggers a manual garbage collection.
- * This function is working only if the process is started with --expose-gc.
- */
 function triggerGarbageCollection() {
     if (typeof global.gc === 'function') {
         global.gc();
@@ -259,9 +196,6 @@ function triggerGarbageCollection() {
         log.debug('Garbage collection is not exposed. Start Node.js with --expose-gc to enable manual GC.');
     }
 }
-/**
- * Registers event handlers for the Matterbridge instance.
- */
 function registerHandlers() {
     log.debug('Registering event handlers...');
     if (instance)
@@ -284,52 +218,32 @@ function registerHandlers() {
         instance.on('triggergarbagecollection', async () => triggerGarbageCollection());
     log.debug('Registered event handlers');
 }
-/**
- * Shuts down the Matterbridge instance and exits the process.
- */
 async function shutdown() {
     log.debug('Received shutdown event, exiting...');
     if (hasParameter('inspect'))
         await stopInspector();
     await stopCpuMemoryCheck();
     cliEmitter.emit('shutdown');
-    // eslint-disable-next-line n/no-process-exit
     process.exit(0);
 }
-/**
- *
- */
 async function restart() {
     log.debug('Received restart event, loading...');
     instance = await Matterbridge.loadInstance(true);
     registerHandlers();
 }
-/**
- *
- */
 async function update() {
     log.debug('Received update event, updating...');
-    // TODO: Implement update logic outside of matterbridge
     instance = await Matterbridge.loadInstance(true);
     registerHandlers();
 }
-/**
- * Starts the CPU and memory check when the -startmemorycheck parameter is passed.
- */
 async function start() {
     log.debug('Received start memory check event');
     await startCpuMemoryCheck();
 }
-/**
- * Stops the CPU and memory check when the -stopmemorycheck parameter is passed.
- */
 async function stop() {
     log.debug('Received stop memory check event');
     await stopCpuMemoryCheck();
 }
-/**
- * Main function that initializes the Matterbridge instance and starts the CLI.
- */
 async function main() {
     log.debug(`Cli main() started`);
     await startCpuMemoryCheck();
@@ -338,7 +252,6 @@ async function main() {
     log.debug(`***Matterbridge.loadInstance(true) called`);
     instance = await Matterbridge.loadInstance(true);
     log.debug(`***Matterbridge.loadInstance(true) exited`);
-    // Check if the instance needs to shut down from parseCommandLine()
     if (!instance || instance.shutdown) {
         shutdown();
     }
@@ -347,11 +260,9 @@ async function main() {
         cliEmitter.emit('ready');
     }
 }
-// Run the main function
 process.title = 'matterbridge';
 main().catch((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}`);
 });
-//# sourceMappingURL=cli.js.map

package/dist/cliEmitter.js

@@ -1,36 +1,6 @@
-/**
- * This file contains the CLI emitter.
- *
- * @file cliEmitter.ts
- * @author Luca Liguori
- * @created 2025-07-04
- * @version 1.0.0
- * @license Apache-2.0
- *
- * Copyright 2025, 2026, 2027 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 import { EventEmitter } from 'node:events';
 export const cliEmitter = new EventEmitter();
 export let lastCpuUsage = 0;
-/**
- * Sets the last CPU usage.
- *
- * @param {number} val - The CPU usage percentage to set.
- * @returns {void}
- */
 export function setLastCpuUsage(val) {
     lastCpuUsage = val;
 }
-//# sourceMappingURL=cliEmitter.js.map

package/dist/clusters/export.js

@@ -1,3 +1 @@
 export {};
-// Nothing to export right now, but this file is here to make it easier to add exports in the future
-//# sourceMappingURL=export.js.map

package/dist/defaultConfigSchema.js

@@ -1,26 +1,3 @@
-/**
- * This file contains the default config for the plugins.
- *
- * @file defaultConfigSchema.ts
- * @author Luca Liguori
- * @created 2024-05-07
- * @version 1.0.1
- * @license Apache-2.0
- *
- * Copyright 2024, 2025, 2026 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 export const zigbee2mqtt_config = {
     name: 'matterbridge-zigbee2mqtt',
     type: 'DynamicPlatform',
@@ -82,4 +59,3 @@ export const shelly_config = {
     debugWs: false,
     unregisterOnShutdown: false,
 };
-//# sourceMappingURL=defaultConfigSchema.js.map

package/dist/deviceManager.js

@@ -1,87 +1,26 @@
-/**
- * This file contains the DeviceManager class.
- *
- * @file devices.ts
- * @author Luca Liguori
- * @created 2024-07-26
- * @version 1.0.11
- * @license Apache-2.0
- *
- * Copyright 2024, 2025, 2026 Luca Liguori.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-// AnsiLogger module
 import { AnsiLogger, BLUE, er } from 'node-ansi-logger';
 import { dev } from './matterbridgeTypes.js';
-/**
- * Manages Matterbridge devices.
- */
 export class DeviceManager {
     _devices = new Map();
     matterbridge;
     log;
-    /**
-     * Creates an instance of DeviceManager.
-     *
-     * @param {Matterbridge} matterbridge - The Matterbridge instance.
-     */
     constructor(matterbridge) {
         this.matterbridge = matterbridge;
-        this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: matterbridge.log.logLevel });
+        this.log = new AnsiLogger({ logName: 'DeviceManager', logTimestampFormat: 4, logLevel: matterbridge.log.logLevel });
         this.log.debug('Matterbridge device manager starting...');
     }
-    /**
-     * Gets the number of devices.
-     *
-     * @returns {number} The number of devices.
-     */
     get length() {
         return this._devices.size;
     }
-    /**
-     * Gets the number of devices.
-     *
-     * @returns {number} The number of devices.
-     */
     get size() {
         return this._devices.size;
     }
-    /**
-     * Checks if a device with the specified unique ID exists.
-     *
-     * @param {string} uniqueId - The unique ID of the device.
-     * @returns {boolean} True if the device exists, false otherwise.
-     */
     has(uniqueId) {
         return this._devices.has(uniqueId);
     }
-    /**
-     * Gets a device by its unique ID.
-     *
-     * @param {string} uniqueId - The unique ID of the device.
-     * @returns {MatterbridgeEndpoint | undefined} The device, or undefined if not found.
-     */
     get(uniqueId) {
         return this._devices.get(uniqueId);
     }
-    /**
-     * Adds a device to the manager.
-     *
-     * @param {MatterbridgeEndpoint} device - The device to add.
-     * @returns {MatterbridgeEndpoint} The added device.
-     * @throws {Error} If the device does not have a unique ID.
-     */
     set(device) {
         if (!device.uniqueId)
             throw new Error(`The device ${dev}${device.deviceName}${er} has not been initialized: uniqueId is required`);
@@ -90,13 +29,6 @@ export class DeviceManager {
         this._devices.set(device.uniqueId, device);
         return device;
     }
-    /**
-     * Removes a device from the manager.
-     *
-     * @param {MatterbridgeEndpoint} device - The device to remove.
-     * @returns {boolean} True if the device was removed, false otherwise.
-     * @throws {Error} If the device does not have a unique ID.
-     */
     remove(device) {
         if (!device.uniqueId)
             throw new Error(`The device ${dev}${device.deviceName}${er} has not been initialized: uniqueId is required`);
@@ -104,34 +36,15 @@ export class DeviceManager {
             this.log.error(`The device ${dev}${device.deviceName}${er} with uniqueId ${BLUE}${device.uniqueId}${er} serialNumber ${BLUE}${device.serialNumber}${er} is not registered in the device manager`);
         return this._devices.delete(device.uniqueId);
     }
-    /**
-     * Clears all devices from the manager.
-     */
     clear() {
         this._devices.clear();
     }
-    /**
-     * Gets an array of all devices.
-     *
-     * @returns {MatterbridgeEndpoint[]} An array of all devices.
-     */
     array() {
         return Array.from(this._devices.values());
     }
-    /**
-     * Iterates over all devices.
-     *
-     * @returns {IterableIterator<MatterbridgeEndpoint>} An iterator for the devices.
-     */
     [Symbol.iterator]() {
         return this._devices.values();
     }
-    /**
-     * Asynchronously iterates over each device and calls the provided callback function.
-     *
-     * @param {(device: MatterbridgeEndpoint) => Promise<void>} callback - The callback function to call with each device.
-     * @returns {Promise<void>} A promise that resolves when all callbacks have been called.
-     */
     async forEach(callback) {
         if (this.size === 0)
             return;
@@ -145,13 +58,7 @@ export class DeviceManager {
         });
         await Promise.all(tasks);
     }
-    /**
-     * Sets the log level.
-     *
-     * @param {LogLevel} logLevel - The log level to set.
-     */
     set logLevel(logLevel) {
         this.log.logLevel = logLevel;
     }
 }
-//# sourceMappingURL=deviceManager.js.map