matterbridge 3.3.0 → 3.3.1-dev-20251008-e61b8db

package/CHANGELOG.md

@@ -23,7 +23,40 @@ Advantages:
 - isolation between threads;
 - individual plugin isolation in childbridge mode;
 
-## [3.3.0] - Not released
+## [3.3.1] - Not released
+
+### Breaking Changes
+
+- [frontend]: When a plugin is first installed, it will not be anymore started to allow to configure it before restarting.
+- [index]: Removed old plugin api compatibility since it was changed one year ago.
+
+### Added
+
+- [network]: Added getInterfaceDetails() function.
+- [network]: Added getInterfaceName() function.
+- [network]: Optimized code.
+- [matterbridge]: Added SharedMatterbridge readonly type.
+- [thread]: Add BroadcastServer to frontend, plugins and devices.
+
+### Changed
+
+- [package]: Updated dependencies.
+- [matterbridge]: Removed matterbridgeInformation. It will be recreated when the frontend requires it.
+- [frontend]: Bumped `frontend` version to 3.2.1.
+- [frontend]: Refactored InstallProgressDialog.
+- [spawn]: Refactored spawnCommand for compatibility with InstallProgressDialog.
+- [matter.js]: Bumped `matter.js` to 0.15.5. Thanks matter.js!
+- [backend]: Optimized imports.
+
+### Fixed
+
+- [frontend]: Fixed matter log on file not setting correctly.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
+## [3.3.0] - 2025-10-03
 
 ### Development Breaking Changes Notice
 
@@ -98,8 +131,6 @@ In this phase (matterbridge `3.4.x`) all plugins will not build and will not run
 - [package]: Updated dependencies.
 - [frontend]: General improvements and small bug fixes.
 
-### Fixed
-
 <a href="https://www.buymeacoffee.com/luligugithub">
   <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
 </a>

package/README.md

@@ -78,10 +78,14 @@ After follow the guidelines for the [Docker configurations](README-DOCKER.md).
 
 I suggest using Docker for its simplicity.
 
-Since as stated in the Matter specifications "Matter aims to build a universal IPv6-based communication protocol for smart home devices", ipv6 should be enabled in the network.
+Since Matter is designed as "a universal IPv6-based communication protocol for smart home devices" (per the Matter specifications), **IPv6 must be enabled on your local network (LAN)**.
+
+**Important:** You only need IPv6 on your local network - it doesn't matter if your internet provider doesn't provide IPv6 on the internet side (WAN).
 
 Avoid using VLAN and firewall blocking the communications between the controllers and Matterbridge.
 
+To pair matterbridge, you need a matter enabled controller (Apple Home, Smart Things, Google Home, Alexa, Hose Assistant etc.).
+
 ## Installation
 
 Follow these steps to install Matterbridge:
@@ -574,3 +578,7 @@ Click on the badge below to get started:
 </a>
 
 Thank you for your support!
+
+# Licensing
+
+Matterbridge is licensed under the [Apache License 2.0](./LICENSE).

package/dist/broadcastServer.js

@@ -0,0 +1,73 @@
+import { EventEmitter } from 'node:events';
+import { BroadcastChannel } from 'node:worker_threads';
+import { debugStringify } from 'node-ansi-logger';
+export class BroadcastServer extends EventEmitter {
+    name;
+    log;
+    channel;
+    broadcastChannel;
+    constructor(name, log, channel = 'broadcast-channel') {
+        super();
+        this.name = name;
+        this.log = log;
+        this.channel = channel;
+        this.broadcastChannel = new BroadcastChannel(this.channel);
+        this.broadcastChannel.onmessage = this.broadcastMessageHandler.bind(this);
+    }
+    close() {
+        this.broadcastChannel.onmessage = null;
+        this.broadcastChannel.close();
+    }
+    getUniqueId() {
+        return Math.floor(Math.random() * (999999 - 100000 + 1)) + 100000;
+    }
+    isWorkerRequest(msg, type) {
+        return typeof msg === 'object' && msg !== null && 'id' in msg && 'type' in msg && msg.type === type && !('response' in msg) && 'src' in msg && 'dst' in msg;
+    }
+    isWorkerResponse(msg, type) {
+        return typeof msg === 'object' && msg !== null && 'id' in msg && 'type' in msg && msg.type === type && 'response' in msg && 'src' in msg && 'dst' in msg;
+    }
+    broadcastMessageHandler(event) {
+        const data = event.data;
+        this.log.debug(`*Received broadcast message: ${debugStringify(data)}`);
+        this.emit('broadcast_message', data);
+    }
+    request(message) {
+        if (message.id === undefined) {
+            message.id = this.getUniqueId();
+        }
+        if (!this.isWorkerRequest(message, message.type)) {
+            this.log.error(`Invalid request message format for broadcast: ${debugStringify(message)}`);
+            return;
+        }
+        this.log.debug(`*Broadcasting message: ${debugStringify(message)}`);
+        this.broadcastChannel.postMessage(message);
+    }
+    respond(message) {
+        if (!this.isWorkerResponse(message, message.type)) {
+            this.log.error(`Invalid response message format for broadcast: ${debugStringify(message)}`);
+            return;
+        }
+        this.log.debug(`*Broadcasting message: ${debugStringify(message)}`);
+        this.broadcastChannel.postMessage(message);
+    }
+    async fetch(message) {
+        this.log.debug(`*Fetching message: ${debugStringify(message)}`);
+        return new Promise((resolve, reject) => {
+            const responseHandler = (msg) => {
+                if (this.isWorkerResponse(msg, message.type) && msg.id === message.id) {
+                    clearTimeout(timeoutId);
+                    this.off('broadcast_message', responseHandler);
+                    this.log.debug(`*Fetch response: ${debugStringify(msg)}`);
+                    resolve(msg);
+                }
+            };
+            this.on('broadcast_message', responseHandler);
+            this.request(message);
+            const timeoutId = setTimeout(() => {
+                this.off('broadcast_message', responseHandler);
+                reject(new Error(`Fetch timeout after 100ms for message id ${message.id}`));
+            }, 100);
+        });
+    }
+}

package/dist/broadcastServerTypes.js

@@ -0,0 +1 @@
+export {};

package/dist/cli.js

@@ -1,44 +1,22 @@
-/**
- * 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.
- */
+if (process.argv.includes('--loader') || process.argv.includes('-loader'))
+    console.log('\u001B[32mCli loaded.\u001B[40;0m');
 import os from 'node:os';
 import { inspect } from 'node:util';
-// AnsiLogger module
-import { AnsiLogger, BRIGHT, CYAN, db, YELLOW } from 'node-ansi-logger';
-// Matterbridge
+import { AnsiLogger, BRIGHT, CYAN, db, RED, YELLOW } from 'node-ansi-logger';
 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 memoryPeakResetTimeout;
 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 */ });
+let peakHeapUsed = 0;
+let peakHeapTotal = 0;
+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 +43,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();
@@ -87,15 +59,26 @@ async function startCpuMemoryCheck() {
         const heapUsed = formatMemoryUsage(memoryUsageRaw.heapUsed);
         const external = formatMemoryUsage(memoryUsageRaw.external);
         const arrayBuffers = formatMemoryUsage(memoryUsageRaw.arrayBuffers);
-        if (memoryUsageRaw.rss > peakRss)
+        if (memoryUsageRaw.rss > peakRss) {
+            if (peakRss)
+                log.debug(`****${RED}${BRIGHT}Rss peak detected.${db} Peak rss from ${CYAN}${formatMemoryUsage(peakRss)}${db} to ${CYAN}${formatMemoryUsage(memoryUsageRaw.rss)}${db}`);
             peakRss = memoryUsageRaw.rss;
+        }
+        if (memoryUsageRaw.heapUsed > peakHeapUsed) {
+            if (peakHeapUsed)
+                log.debug(`****${RED}${BRIGHT}HeapUsed peak detected.${db} Peak heapUsed from ${CYAN}${formatMemoryUsage(peakHeapUsed)}${db} to ${CYAN}${formatMemoryUsage(memoryUsageRaw.heapUsed)}${db}`);
+            peakHeapUsed = memoryUsageRaw.heapUsed;
+        }
+        if (memoryUsageRaw.heapTotal > peakHeapTotal) {
+            if (peakHeapTotal)
+                log.debug(`****${RED}${BRIGHT}HeapTotal peak detected.${db} Peak heapTotal from ${CYAN}${formatMemoryUsage(peakHeapTotal)}${db} to ${CYAN}${formatMemoryUsage(memoryUsageRaw.heapTotal)}${db}`);
+            peakHeapTotal = memoryUsageRaw.heapTotal;
+        }
         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;
         }
@@ -109,41 +92,42 @@ async function startCpuMemoryCheck() {
         });
         const cpuUsage = 100 - (totalIdle / totalTick) * 100;
         if (totalTick === 0 || isNaN(cpuUsage) || !isFinite(cpuUsage) || cpuUsage <= 0) {
-            if (lastCpuUsage != 0)
-                log.debug(`Cpu check failed, using previous cpus`);
+            log.debug(`Cpu check failed, using previous cpus`);
             cpuUsageLog = lastCpuUsage.toFixed(2);
         }
         else {
             cpuUsageLog = cpuUsage.toFixed(2);
             setLastCpuUsage(cpuUsage);
-            if (lastCpuUsage > peakCpu)
+            if (lastCpuUsage > peakCpu) {
                 peakCpu = lastCpuUsage;
+                if (peakCpu)
+                    log.debug(`****${RED}${BRIGHT}Cpu peak detected.${db} Peak cpu from ${CYAN}${peakCpu.toFixed(2)}%${db} to ${CYAN}${lastCpuUsage.toFixed(2)}%${db}`);
+            }
             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}`);
+        log.debug(`***${YELLOW}${BRIGHT}Cpu usage:${db} ${CYAN}${cpuUsageLog.padStart(6, ' ')}%${db} (peak ${peakCpu.toFixed(2)}%) ${YELLOW}${BRIGHT}Memory usage:${db} rss ${CYAN}${rss}${db} (peak ${formatMemoryUsage(peakRss)}) heapUsed ${CYAN}${heapUsed}${db} (peak ${formatMemoryUsage(peakHeapUsed)}) heapTotal ${CYAN}${heapTotal}${db} (peak ${formatMemoryUsage(peakHeapTotal)}) external ${external} arrayBuffers ${arrayBuffers}`);
     };
-    interval();
     clearInterval(memoryCheckInterval);
     memoryCheckInterval = setInterval(interval, getIntParameter('memoryinterval') ?? 10 * 1000).unref();
+    clearTimeout(memoryPeakResetTimeout);
+    memoryPeakResetTimeout = setTimeout(() => {
+        log.debug(`****${RED}${BRIGHT}Cpu and memory peaks reset after first 5 minutes.${db}`);
+        peakCpu = 0;
+        peakRss = 0;
+        peakHeapUsed = 0;
+        peakHeapTotal = 0;
+    }, 5 * 60 * 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}.`);
+    log.debug(`***Cpu memory check stopped. Peak cpu: ${CYAN}${peakCpu.toFixed(2)} %${db}. Peak rss: ${CYAN}${formatMemoryUsage(peakRss)}${db}. Peak heapUsed: ${CYAN}${formatMemoryUsage(peakHeapUsed)}${db}. Peak heapTotal: ${CYAN}${formatMemoryUsage(peakHeapTotal)}${db}`);
     clearInterval(memoryCheckInterval);
+    clearTimeout(memoryPeakResetTimeout);
 }
-/**
- * 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 +136,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 +153,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 +167,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 +184,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 +215,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 +224,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 +246,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 +280,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 +288,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