matterbridge 3.2.6-dev-20250904-a79f653 → 3.2.6-dev-20250906-4b022a0

package/CHANGELOG.md

@@ -8,7 +8,7 @@ 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.6] - 2025-09-??
+## [3.2.6] - 2025-09-05
 
 ### Added
 
@@ -27,6 +27,8 @@ If you like this project and find it useful, please consider giving it a star on
 - [AirConditioner]: Added AirConditioner() class and Jest test. It is not supported by the Home app. Improved createDefaultThermostatUserInterfaceConfigurationClusterServer().
 - [DeviceTypes]: Add Chapter 10. Media Device Types.
 - [Speaker]: Added Speaker() class and Jest test. Supported only by SmartThings.
+- [mb_mdns]: Added help screen and the ability to filter mDNS packets. Useful to see all paired and commissionable Matter devices on the network.
+- [matter.js]: Removed legacy and deprecated calls to Logger.setLogger etc. and use Logger.destinations.
 
 ### Changed
 

package/README.md

@@ -291,7 +291,7 @@ An Accessory platform plugin only exposes one device.
 
 This is an example of a dynamic platform plugin.
 
-It exposes 56 virtual devices.
+It exposes 57 virtual devices.
 
 All these virtual devices continuously change state and position. The plugin also shows how to use all the command handlers (you can control all the devices).
 

package/dist/dgram/dgram.js

@@ -171,9 +171,11 @@ export class Dgram extends EventEmitter {
         }
         return interfaceNames;
     }
-    getIpv6ScopeIdForAllInterfacesAddress() {
+    getIpv6ScopeId(interfaceName) {
         const interfaces = os.networkInterfaces();
         for (const name in interfaces) {
+            if (interfaceName && name !== interfaceName)
+                continue;
             const iface = interfaces[name];
             if (iface) {
                 const ipv6Address = iface.find((addr) => addr.family === 'IPv6' && !addr.internal && addr.scopeid);

package/dist/dgram/mb_mdns.js

@@ -1,9 +1,53 @@
+import { getParameter, getStringArrayParameter, hasParameter } from '../utils/commandLine.js';
 import { MDNS_MULTICAST_IPV4_ADDRESS, MDNS_MULTICAST_IPV6_ADDRESS, MDNS_MULTICAST_PORT } from './multicast.js';
 import { Mdns } from './mdns.js';
 {
-    const mdnsIpv4 = new Mdns('mDNS Server udp4', MDNS_MULTICAST_IPV4_ADDRESS, MDNS_MULTICAST_PORT, 'udp4', true, undefined, '0.0.0.0');
-    const mdnsIpv6 = new Mdns('mDNS Server udp6', MDNS_MULTICAST_IPV6_ADDRESS, MDNS_MULTICAST_PORT, 'udp6', true, undefined, '::');
+    if (hasParameter('h') || hasParameter('help')) {
+        console.log(`Usage: mb_mdns [options]
+
+Options:
+  -h, --help                                Show this help message and exit.
+  --interfaceName <name>                    Network interface name to bind to (default all interfaces).
+  --ipv4InterfaceAddress <address>          IPv4 address of the network interface to bind to (default: 0.0.0.0).
+  --ipv6InterfaceAddress <address>          IPv6 address of the network interface to bind to (default: ::).
+  --outgoingIpv4InterfaceAddress <address>  Outgoing IPv4 address (default first external address).
+  --outgoingIpv6InterfaceAddress <address>  Outgoing IPv6 address (default first external address).
+  --advertise                               Enable mDNS advertisement (default: disabled).
+  --query                                   Enable mDNS query (default: disabled).
+  --filter <string>                         Filter string to match in the mDNS record name (can be repeated).
+  -v, --verbose                             Enable verbose logging (default: disabled).
+
+Examples:
+  # List Matter device commissioner service records only on eth0 interface
+  mb_mdns --interfaceName eth0 --filter _matterc._udp
+
+  # List Matter device service records only on eth0 interface
+  mb_mdns --interfaceName eth0 --filter _matter._tcp
+
+  # List both Matter commissioner and device service records only on eth0 interface
+  mb_mdns --interfaceName eth0 --filter _matterc._udp _matter._tcp
+
+  # Query for mDNS devices every 10s on a specific interface
+  mb_mdns --interfaceName eth0 --query
+`);
+        process.exit(0);
+    }
+    const mdnsIpv4 = new Mdns('mDNS Server udp4', MDNS_MULTICAST_IPV4_ADDRESS, MDNS_MULTICAST_PORT, 'udp4', true, getParameter('interfaceName'), getParameter('ipv4InterfaceAddress') || '0.0.0.0', getParameter('outgoingIpv4InterfaceAddress'));
+    const mdnsIpv6 = new Mdns('mDNS Server udp6', MDNS_MULTICAST_IPV6_ADDRESS, MDNS_MULTICAST_PORT, 'udp6', true, getParameter('interfaceName'), getParameter('ipv6InterfaceAddress') || '::', getParameter('outgoingIpv6InterfaceAddress'));
+    if (hasParameter('v') || hasParameter('verbose')) {
+        mdnsIpv4.log.logLevel = "debug";
+        mdnsIpv6.log.logLevel = "debug";
+    }
+    else {
+        mdnsIpv4.log.logLevel = "info";
+        mdnsIpv6.log.logLevel = "info";
+    }
     mdnsIpv4.listNetworkInterfaces();
+    const filters = getStringArrayParameter('filter');
+    if (filters) {
+        mdnsIpv4.filters.push(...filters);
+        mdnsIpv6.filters.push(...filters);
+    }
     function cleanupAndLogAndExit() {
         mdnsIpv4.stop();
         mdnsIpv6.stop();
@@ -18,6 +62,8 @@ import { Mdns } from './mdns.js';
             { name: '_http._tcp.local', type: 12, class: 1, unicastResponse: false },
             { name: '_services._dns-sd._udp.local', type: 12, class: 1, unicastResponse: false },
         ]);
+    };
+    const advertiseUdp4 = () => {
         const ptrRdata = mdnsIpv4.encodeDnsName('matterbridge._http._tcp.local');
         mdnsIpv4.sendResponse('_http._tcp.local', 12, 1, 120, ptrRdata);
     };
@@ -28,6 +74,8 @@ import { Mdns } from './mdns.js';
             { name: '_http._tcp.local', type: 12, class: 1, unicastResponse: true },
             { name: '_services._dns-sd._udp.local', type: 12, class: 1, unicastResponse: true },
         ]);
+    };
+    const advertiseUdp6 = () => {
         const ptrRdata = mdnsIpv6.encodeDnsName('matterbridge._http._tcp.local');
         mdnsIpv6.sendResponse('_http._tcp.local', 12, 1, 120, ptrRdata);
     };
@@ -37,22 +85,34 @@ import { Mdns } from './mdns.js';
     mdnsIpv4.start();
     mdnsIpv4.on('ready', (address) => {
         mdnsIpv4.log.info(`mdnsIpv4 server ready on ${address.family} ${address.address}:${address.port}`);
-        if (!process.argv.includes('--query'))
-            return;
-        queryUdp4();
-        setInterval(() => {
+        if (getParameter('advertise')) {
+            advertiseUdp4();
+            setInterval(() => {
+                advertiseUdp4();
+            }, 10000).unref();
+        }
+        if (getParameter('query')) {
             queryUdp4();
-        }, 10000).unref();
+            setInterval(() => {
+                queryUdp4();
+            }, 10000).unref();
+        }
     });
     mdnsIpv6.start();
     mdnsIpv6.on('ready', (address) => {
         mdnsIpv6.log.info(`mdnsIpv6 server ready on ${address.family} ${address.address}:${address.port}`);
-        if (!process.argv.includes('--query'))
-            return;
-        queryUdp6();
-        setInterval(() => {
+        if (getParameter('advertise')) {
+            advertiseUdp6();
+            setInterval(() => {
+                advertiseUdp6();
+            }, 10000).unref();
+        }
+        if (getParameter('query')) {
             queryUdp6();
-        }, 10000).unref();
+            setInterval(() => {
+                queryUdp6();
+            }, 10000).unref();
+        }
     });
     setTimeout(() => {
         cleanupAndLogAndExit();

package/dist/dgram/mdns.js

@@ -108,8 +108,9 @@ export var DnsClassFlag;
 export class Mdns extends Multicast {
     deviceQueries = new Map();
     deviceResponses = new Map();
-    constructor(name, multicastAddress, multicastPort, socketType, reuseAddr = true, interfaceName, interfaceAddress) {
-        super(name, multicastAddress, multicastPort, socketType, reuseAddr, interfaceName, interfaceAddress);
+    filters = [];
+    constructor(name, multicastAddress, multicastPort, socketType, reuseAddr = true, interfaceName, interfaceAddress, outgoingInterfaceAddress) {
+        super(name, multicastAddress, multicastPort, socketType, reuseAddr, interfaceName, interfaceAddress, outgoingInterfaceAddress);
     }
     onQuery(rinfo, _query) {
         this.log.debug(`mDNS query received from ${BLUE}${rinfo.family}${db} ${BLUE}${rinfo.address}${db}:${BLUE}${rinfo.port}${db}`);
@@ -118,7 +119,8 @@ export class Mdns extends Multicast {
         this.log.debug(`mDNS response received from ${BLUE}${rinfo.family}${db} ${BLUE}${rinfo.address}${db}:${BLUE}${rinfo.port}${db}`);
     }
     onMessage(msg, rinfo) {
-        this.log.info(`Dgram mDNS server received a mDNS message from ${BLUE}${rinfo.family}${nf} ${BLUE}${rinfo.address}${nf}:${BLUE}${rinfo.port}${nf}`);
+        if (this.filters.length === 0)
+            this.log.info(`Dgram mDNS server received a mDNS message from ${BLUE}${rinfo.family}${nf} ${BLUE}${rinfo.address}${nf}:${BLUE}${rinfo.port}${nf}`);
         try {
             const result = this.decodeMdnsMessage(msg);
             if (result.qr === 0) {
@@ -136,6 +138,21 @@ export class Mdns extends Multicast {
                 this.deviceResponses.set(rinfo.address, { rinfo, response: result, dataPTR: ptr?.type === 12 ? ptr?.data : ptr?.name });
                 this.onResponse(rinfo, result);
             }
+            if (this.filters.length > 0) {
+                this.log.debug(`mDNS message filtered out by filters: ${this.filters.join(', ')}`);
+                for (const filter of this.filters) {
+                    const foundInQuestions = result.questions?.some((q) => q.name.includes(filter));
+                    const foundInAnswers = result.answers?.some((a) => a.name.includes(filter) || a.data.includes(filter));
+                    const foundInAdditionals = result.additionals?.some((a) => a.name.includes(filter) || a.data.includes(filter));
+                    if (foundInQuestions || foundInAnswers || foundInAdditionals) {
+                        this.log.info(`Dgram mDNS server received a mDNS message from ${BLUE}${rinfo.family}${nf} ${BLUE}${rinfo.address}${nf}:${BLUE}${rinfo.port}${nf}`);
+                        this.logMdnsMessage(result);
+                        return;
+                    }
+                }
+                this.log.debug(`mDNS message does not match any filter, ignoring.`);
+                return;
+            }
             this.logMdnsMessage(result);
         }
         catch (error) {

package/dist/dgram/multicast.js

@@ -10,11 +10,13 @@ export const COAP_MULTICAST_PORT = 5683;
 export class Multicast extends Dgram {
     multicastAddress;
     multicastPort;
+    outgoingInterfaceAddress;
     joinedInterfaces = [];
-    constructor(name, multicastAddress, multicastPort, socketType, reuseAddr = true, interfaceName, interfaceAddress) {
+    constructor(name, multicastAddress, multicastPort, socketType, reuseAddr = true, interfaceName, interfaceAddress, outgoingInterfaceAddress) {
         super(name, socketType, reuseAddr, interfaceName, interfaceAddress);
         this.multicastAddress = multicastAddress;
         this.multicastPort = multicastPort;
+        this.outgoingInterfaceAddress = outgoingInterfaceAddress;
     }
     start() {
         if (this.socketType === 'udp4') {
@@ -86,9 +88,12 @@ export class Multicast extends Dgram {
                 }
             }
         });
-        let interfaceAddress = this.interfaceAddress;
-        if (this.socketType === 'udp6' && this.interfaceAddress === '::') {
-            interfaceAddress = '::' + this.getIpv6ScopeIdForAllInterfacesAddress();
+        let interfaceAddress = this.outgoingInterfaceAddress || this.interfaceAddress;
+        if (!this.outgoingInterfaceAddress && this.socketType === 'udp4' && this.interfaceAddress === '0.0.0.0') {
+            interfaceAddress = this.getIpv4InterfaceAddress(this.interfaceName);
+        }
+        if (!this.outgoingInterfaceAddress && this.socketType === 'udp6' && this.interfaceAddress === '::') {
+            interfaceAddress = '::' + this.getIpv6ScopeId(this.interfaceName);
         }
         this.log.debug(`Dgram multicast socket setting multicastInterface to ${BLUE}${interfaceAddress}${db} for ${BLUE}${address.family}${db} ${BLUE}${address.address}${db}:${BLUE}${address.port}${db}`);
         this.socket.setMulticastInterface(interfaceAddress);

package/dist/frontend.js

@@ -8,7 +8,7 @@ import express from 'express';
 import WebSocket, { WebSocketServer } from 'ws';
 import multer from 'multer';
 import { AnsiLogger, stringify, debugStringify, CYAN, db, er, nf, rs, UNDERLINE, UNDERLINEOFF, YELLOW, nt } from 'node-ansi-logger';
-import { Logger, LogLevel as MatterLogLevel, LogFormat as MatterLogFormat, Lifecycle } from '@matter/main';
+import { Logger, LogLevel as MatterLogLevel, Lifecycle } from '@matter/main';
 import { BridgedDeviceBasicInformation, PowerSource } from '@matter/main/clusters';
 import { createZip, isValidArray, isValidNumber, isValidObject, isValidString, isValidBoolean, withTimeout, hasParameter } from './utils/export.js';
 import { plg } from './matterbridgeTypes.js';
@@ -1443,23 +1443,10 @@ export class Frontend extends EventEmitter {
                             this.matterbridge.matterbridgeInformation.matterFileLogger = data.params.value;
                             await this.matterbridge.nodeContext?.set('matterFileLog', data.params.value);
                             if (data.params.value) {
-                                try {
-                                    Logger.addLogger('matterfilelogger', await this.matterbridge.createMatterFileLogger(path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterLoggerFile), true), {
-                                        defaultLogLevel: this.matterbridge.matterbridgeInformation.matterLoggerLevel,
-                                        logFormat: MatterLogFormat.PLAIN,
-                                    });
-                                }
-                                catch (error) {
-                                    this.log.debug(`Error adding the matterfilelogger for file ${CYAN}${path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterLoggerFile)}${er}: ${error instanceof Error ? error.message : error}`);
-                                }
+                                this.matterbridge.matterLog.logFilePath = path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterLoggerFile);
                             }
                             else {
-                                try {
-                                    Logger.removeLogger('matterfilelogger');
-                                }
-                                catch (error) {
-                                    this.log.debug(`Error removing the matterfilelogger for file ${CYAN}${path.join(this.matterbridge.matterbridgeDirectory, this.matterbridge.matterLoggerFile)}${er}: ${error instanceof Error ? error.message : error}`);
-                                }
+                                this.matterbridge.matterLog.logFilePath = undefined;
                             }
                             client.send(JSON.stringify({ id: data.id, method: data.method, src: 'Matterbridge', dst: data.src, success: true }));
                         }

package/dist/matterbridge.js

@@ -117,6 +117,7 @@ export class Matterbridge extends EventEmitter {
     sigtermHandler;
     exceptionHandler;
     rejectionHandler;
+    matterLog = new AnsiLogger({ logName: 'Matter', logTimestampFormat: 4, logLevel: "debug" });
     environment = Environment.default;
     matterStorageName = 'matterstorage' + (getParameter('profile') ? '.' + getParameter('profile') : '');
     matterStorageService;
@@ -408,15 +409,11 @@ export class Matterbridge extends EventEmitter {
             Logger.level = (await this.nodeContext.get('matterLogLevel', this.matterbridgeInformation.shellyBoard ? MatterLogLevel.NOTICE : MatterLogLevel.INFO));
         }
         Logger.format = MatterLogFormat.ANSI;
-        Logger.setLogger('default', this.createMatterLogger());
-        this.matterbridgeInformation.matterLoggerLevel = Logger.level;
         if (hasParameter('matterfilelogger') || (await this.nodeContext.get('matterFileLog', false))) {
             this.matterbridgeInformation.matterFileLogger = true;
-            Logger.addLogger('matterfilelogger', await this.createMatterFileLogger(path.join(this.matterbridgeDirectory, this.matterLoggerFile), true), {
-                defaultLogLevel: Logger.level,
-                logFormat: MatterLogFormat.PLAIN,
-            });
         }
+        Logger.destinations.default.write = this.createDestinationMatterLogger(this.matterbridgeInformation.matterFileLogger);
+        this.matterbridgeInformation.matterLoggerLevel = Logger.level;
         this.log.debug(`Matter logLevel: ${Logger.level} fileLoger: ${this.matterbridgeInformation.matterFileLogger}.`);
         const networkInterfaces = os.networkInterfaces();
         const availableAddresses = Object.entries(networkInterfaces);
@@ -921,77 +918,32 @@ export class Matterbridge extends EventEmitter {
         const cmdArgs = process.argv.slice(2).join(' ');
         this.log.debug(`Command Line Arguments: ${cmdArgs}`);
     }
-    createMatterLogger() {
-        const matterLogger = new AnsiLogger({ logName: 'Matter', logTimestampFormat: 4, logLevel: "debug" });
-        return (level, formattedLog) => {
-            const logger = formattedLog.slice(44, 44 + 20).trim();
-            const message = formattedLog.slice(65);
-            matterLogger.logName = logger;
-            switch (level) {
-                case MatterLogLevel.DEBUG:
-                    matterLogger.log("debug", message);
-                    break;
-                case MatterLogLevel.INFO:
-                    matterLogger.log("info", message);
-                    break;
-                case MatterLogLevel.NOTICE:
-                    matterLogger.log("notice", message);
-                    break;
-                case MatterLogLevel.WARN:
-                    matterLogger.log("warn", message);
-                    break;
-                case MatterLogLevel.ERROR:
-                    matterLogger.log("error", message);
-                    break;
-                case MatterLogLevel.FATAL:
-                    matterLogger.log("fatal", message);
-                    break;
-            }
-        };
-    }
-    async createMatterFileLogger(filePath, unlink = false) {
-        let fileSize = 0;
-        if (unlink) {
-            try {
-                await fs.unlink(filePath);
-            }
-            catch (error) {
-                this.log.debug(`Error unlinking the log file ${CYAN}${filePath}${db}: ${error instanceof Error ? error.message : error}`);
-            }
-        }
-        return async (level, formattedLog) => {
-            if (fileSize > 100000000) {
-                return;
-            }
-            fileSize += formattedLog.length;
-            if (fileSize > 100000000) {
-                await fs.appendFile(filePath, `Logging on file has been stopped because the file size is greater than 100MB.` + os.EOL);
-                return;
-            }
-            const now = new Date();
-            const timestamp = `${now.getHours().toString().padStart(2, '0')}:${now.getMinutes().toString().padStart(2, '0')}:${now.getSeconds().toString().padStart(2, '0')}.${now.getMilliseconds().toString().padStart(3, '0')}`;
-            const message = formattedLog.slice(24);
-            const parts = message.split(' ');
-            const logger = parts[1];
-            const finalMessage = parts.slice(2).join(' ') + os.EOL;
-            switch (level) {
+    createDestinationMatterLogger(fileLogger) {
+        if (fileLogger) {
+            this.matterLog.logFilePath = path.join(this.matterbridgeDirectory, this.matterLoggerFile);
+        }
+        return (text, message) => {
+            const logger = text.slice(44, 44 + 20).trim();
+            const msg = text.slice(65);
+            this.matterLog.logName = logger;
+            switch (message.level) {
                 case MatterLogLevel.DEBUG:
-                    await fs.appendFile(filePath, `[${timestamp}] [${logger}] [debug] ${finalMessage}`);
+                    this.matterLog.log("debug", msg);
                     break;
                 case MatterLogLevel.INFO:
-                    await fs.appendFile(filePath, `[${timestamp}] [${logger}] [info] ${finalMessage}`);
+                    this.matterLog.log("info", msg);
                     break;
                 case MatterLogLevel.NOTICE:
-                    await fs.appendFile(filePath, `[${timestamp}] [${logger}] [notice] ${finalMessage}`);
+                    this.matterLog.log("notice", msg);
                     break;
                 case MatterLogLevel.WARN:
-                    await fs.appendFile(filePath, `[${timestamp}] [${logger}] [warn] ${finalMessage}`);
+                    this.matterLog.log("warn", msg);
                     break;
                 case MatterLogLevel.ERROR:
-                    await fs.appendFile(filePath, `[${timestamp}] [${logger}] [error] ${finalMessage}`);
+                    this.matterLog.log("error", msg);
                     break;
                 case MatterLogLevel.FATAL:
-                    await fs.appendFile(filePath, `[${timestamp}] [${logger}] [fatal] ${finalMessage}`);
+                    this.matterLog.log("fatal", msg);
                     break;
             }
         };

package/dist/utils/export.js

@@ -9,3 +9,4 @@ export * from './createDirectory.js';
 export * from './createZip.js';
 export * from './wait.js';
 export * from './hex.js';
+export * from './error.js';

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge",
-  "version": "3.2.6-dev-20250904-a79f653",
+  "version": "3.2.6-dev-20250906-4b022a0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge",
-      "version": "3.2.6-dev-20250904-a79f653",
+      "version": "3.2.6-dev-20250906-4b022a0",
       "license": "Apache-2.0",
       "dependencies": {
         "@matter/main": "0.15.3",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge",
-  "version": "3.2.6-dev-20250904-a79f653",
+  "version": "3.2.6-dev-20250906-4b022a0",
   "description": "Matterbridge plugin manager for Matter",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",