matterbridge 3.1.1-dev-20250704-aff5fcb → 3.1.2-dev-20250705-7da1eac

package/CHANGELOG.md

@@ -8,7 +8,24 @@ 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.1.1] - 2025-07-08
+## [3.1.2] - 2025-07-??
+
+### Development Breaking Changes
+
+- [exports]: The single devices (i.e. Rvc, Evse etc...) are only exported from `matterbridge/devices`. Please update your imports to use the new export path. Refer to the [documentation](README-DEV.md) for details on imports.
+- [MatterbridgeEndpoint]: Added the mode property: `server` will make the device indipendent from its plugin. It has its own server node: QRCode, Fabrics and Sessions are visible in the Devices section of the Home page. This is a workaround for the Rvc Apple issue. With mode=server the Rvc (like any other device) can be paired directly to the controller like a native not bridged Matter device.
+
+### Added
+
+### Changed
+
+- [package]: Updated dependencies.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
+## [3.1.1] - 2025-07-04
 
 ### Development Breaking Changes
 
@@ -22,14 +39,15 @@ If you like this project and find it useful, please consider giving it a star on
 - [SolarPower]: Added SolarPower class and Jest test (working on Home Assistant and SmartThings). Thanks Ludovic BOUÉ.
 - [BatteryStorage]: Added BatteryStorage class and Jest test (working on Home Assistant and SmartThings). Thanks Ludovic BOUÉ.
 - [HeatPump]: Added HeatPump class and Jest test (working on Home Assistant and SmartThings).
+- [test]: Improved test units on Frontend class and all Matterbridge classes (coverage 93%).
 
 ### Changed
 
 - [package]: Updated dependencies.
+- [matter.js]: Bumped `matter.js` to 0.15.1 (https://github.com/project-chip/matter.js/discussions/2220). Great job matter.js!
 - [frontend]: Added all esa devices.
 - [frontend]: New default values: devices on the home page and icon view on the devices page.
-- [matter.js]: Bumped `matter.js` to 0.15.1 (https://github.com/project-chip/matter.js/discussions/2220). Great job matter.js!
-- [imports]: Added more dynamic imports to Matterbridge and Frontend classes.
+- [imports]: Added dynamic imports to Matterbridge and Frontend classes.
 
 <a href="https://www.buymeacoffee.com/luligugithub">
   <img src="bmc-button.svg" alt="Buy me a coffee" width="80">

package/README-DEV.md

@@ -272,9 +272,9 @@ You create a Matter device with a new instance of MatterbridgeEndpoint(definitio
 - @param {boolean} [debug] - Debug flag.
 
 ```typescript
-    const device = new MatterbridgeEndpoint([contactSensor, powerSource], { uniqueStorageKey: 'Eve door', mode: 'matter' }, this.config.debug as boolean)
+    const device = new MatterbridgeEndpoint([contactSensor, powerSource], { id: 'EntryDoor', mode: 'server' })
       .createDefaultIdentifyClusterServer()
-      .createDefaultBasicInformationClusterServer('My contact sensor', '0123456789')
+      .createDefaultBasicInformationClusterServer('My entry door', '0123456789')
       .createDefaultBooleanStateClusterServer(true)
       .createDefaultPowerSourceReplaceableBatteryClusterServer(75)
       .addRequiredClusterServers(); // Always better to call it at the end of the chain to add all the not already created but required clusters.
@@ -282,6 +282,10 @@ You create a Matter device with a new instance of MatterbridgeEndpoint(definitio
 
 In the above example we create a contact sensor device type with also a power source device type feature replaceble battery.
 
+The mode=`server` property of MatterbridgeEndpointOptions, allows to create an independent (not bridged) Matter device with its server node. In this case the bridge mode is not relevant.
+
+The mode=`matter` property of MatterbridgeEndpointOptions, allows to create a (not bridged) Matter device that is added to the Matterbridge server node alongside the aggregator.
+
 All device types are defined in src\matterbridgeDeviceTypes.ts and taken from the 'Matter-1.4-Device-Library-Specification.pdf'.
 
 All default cluster helpers are available as methods of MatterbridgeEndpoint.

package/README.md

@@ -520,27 +520,13 @@ As of version 18.4.x, the Robot is supported by the Home app only as a single, n
 
 If a Robot is present alongside other devices in the bridge, the entire bridge becomes unstable in the Home app.
 
-## Home Assistant
-
-So far is the only controller supporting some Matter 1.2, 1.3 and 1.4 device type:
-
-- airQualitySensor code 0x002c (Matter 1.2)
-- smokesmokeCoAlarm code 0x0076 (Matter 1.2)
-- waterFreezeDetector code 0x0041 (Matter 1.3 with only BooleanState cluster)
-- waterLeakDetector code 0x0043 (Matter 1.3 with only BooleanState cluster)
-- rainSensor code 0x0044 (Matter 1.3 with only BooleanState cluster)
-- deviceEnergyManagement code 0x050d (Matter 1.3 with only DeviceEnergyManagementMode cluster)
-
-Electrical measurements:
+A workaround has been released in Matterbridge 3.1.1. Ask the plugin authors to update the code.
 
-- electrical measurements from EveHistoryCluster (used in old Matterbridge plugins)
-- electricalSensor code 0x0510 with clusters: ElectricalPowerMeasurement and ElectricalEnergyMeasurement
-
-Other supported cluster:
+## Home Assistant
 
-- modeSelect code 0x27 with ModeSelect cluster
+So far is the only controller supporting all Matter 1.2, 1.3 and 1.4 device type.
 
-## Home Assistant issues (Matter Server for HA is still in Beta)
+## Home Assistant issues
 
 - If HA doesn't show all devices, reload the Matter Server Integration or reboot HA
 - Home Assistant doesn't seem to always react when a device is removed from the bridge: they remain in HA unavailable forever...
@@ -565,8 +551,7 @@ There is no support for these Matter device types:
 - pressure sensor
 - flow sensor
 
-In the zigbee2mqtt and shelly plugins select the option to expose
-the switch devices like light or outlet cause they don't show up like switch
+In the zigbee2mqtt and shelly plugins select the option to expose the switch devices like light or outlet cause they don't show up like switch
 (Matterbridge uses a switch device type without client cluster).
 
 ## SmartThings
@@ -575,11 +560,6 @@ Tested by Tamer Salah
 
 No issues reported so far.
 
-Supports also:
-
-- air Quality Sensor (Matter 1.2)
-- smoke Co Alarm
-
 ## eWeLink
 
 Tested by Tamer Salah

package/dist/cli.js

@@ -1,16 +1,14 @@
 import os from 'node:os';
-import { EventEmitter } from 'node:events';
 import { inspect } from 'node:util';
 import { AnsiLogger, BRIGHT, CYAN, db, YELLOW } from 'node-ansi-logger';
 import { getIntParameter, hasParameter } from './utils/export.js';
 import { Matterbridge } from './matterbridge.js';
-export const cliEmitter = new EventEmitter();
+import { cliEmitter, lastCpuUsage, setLastCpuUsage } from './cliEmitter.js';
 export let instance;
 let session;
 let snapshotInterval;
 let memoryCheckInterval;
 let prevCpus;
-export let lastCpuUsage = 0;
 let peakCpu = 0;
 let peakRss = 0;
 const log = new AnsiLogger({ logName: 'Cli', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
@@ -82,7 +80,7 @@ async function startCpuMemoryCheck() {
         }
         else {
             cpuUsageLog = cpuUsage.toFixed(2);
-            lastCpuUsage = cpuUsage;
+            setLastCpuUsage(cpuUsage);
             if (lastCpuUsage > peakCpu)
                 peakCpu = lastCpuUsage;
             cliEmitter.emit('cpu', lastCpuUsage);

package/dist/cliEmitter.js

@@ -0,0 +1,6 @@
+import { EventEmitter } from 'node:events';
+export const cliEmitter = new EventEmitter();
+export let lastCpuUsage = 0;
+export function setLastCpuUsage(val) {
+    lastCpuUsage = val;
+}

package/dist/devices/roboticVacuumCleaner.js

@@ -11,8 +11,8 @@ import { MatterbridgeEndpoint } from '../matterbridgeEndpoint.js';
 import { powerSource, roboticVacuumCleaner } from '../matterbridgeDeviceTypes.js';
 import { MatterbridgeServer, MatterbridgeServiceAreaServer } from '../matterbridgeBehaviors.js';
 export class RoboticVacuumCleaner extends MatterbridgeEndpoint {
-    constructor(name, serial, currentRunMode, supportedRunModes, currentCleanMode, supportedCleanModes, currentPhase = null, phaseList = null, operationalState, operationalStateList, supportedAreas, selectedAreas, currentArea) {
-        super([roboticVacuumCleaner, powerSource], { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}` }, true);
+    constructor(name, serial, mode = undefined, currentRunMode, supportedRunModes, currentCleanMode, supportedCleanModes, currentPhase = null, phaseList = null, operationalState, operationalStateList, supportedAreas, selectedAreas, currentArea) {
+        super([roboticVacuumCleaner, powerSource], { uniqueStorageKey: `${name.replaceAll(' ', '')}-${serial.replaceAll(' ', '')}`, mode }, true);
         this.createDefaultIdentifyClusterServer()
             .createDefaultBasicInformationClusterServer(name, serial, 0xfff1, 'Matterbridge', 0x8000, 'Matterbridge Robot Vacuum Cleaner')
             .createDefaultPowerSourceRechargeableBatteryClusterServer(80, PowerSource.BatChargeLevel.Ok, 5900)

package/dist/frontend.js

@@ -13,6 +13,7 @@ import { BridgedDeviceBasicInformation, PowerSource } from '@matter/main/cluster
 import { createZip, isValidArray, isValidNumber, isValidObject, isValidString, isValidBoolean, withTimeout, hasParameter } from './utils/export.js';
 import { plg } from './matterbridgeTypes.js';
 import { capitalizeFirstLetter } from './matterbridgeEndpointHelpers.js';
+import { cliEmitter, lastCpuUsage } from './cliEmitter.js';
 export const WS_ID_LOG = 0;
 export const WS_ID_REFRESH_NEEDED = 1;
 export const WS_ID_RESTART_NEEDED = 2;
@@ -51,7 +52,14 @@ export class Frontend extends EventEmitter {
         this.expressApp = express();
         this.expressApp.use(express.static(path.join(this.matterbridge.rootDirectory, 'frontend/build')));
         if (!hasParameter('ssl')) {
-            this.httpServer = createServer(this.expressApp);
+            try {
+                this.httpServer = createServer(this.expressApp);
+            }
+            catch (error) {
+                this.log.error(`Failed to create HTTP server: ${error}`);
+                this.emit('server_error', error);
+                return;
+            }
             if (hasParameter('ingress')) {
                 this.httpServer.listen(this.port, '0.0.0.0', () => {
                     this.log.info(`The frontend http server is listening on ${UNDERLINE}http://0.0.0.0:${this.port}${UNDERLINEOFF}${rs}`);
@@ -90,6 +98,7 @@ export class Frontend extends EventEmitter {
             }
             catch (error) {
                 this.log.error(`Error reading certificate file ${path.join(this.matterbridge.matterbridgeDirectory, 'certs/cert.pem')}: ${error}`);
+                this.emit('server_error', error);
                 return;
             }
             let key;
@@ -99,6 +108,7 @@ export class Frontend extends EventEmitter {
             }
             catch (error) {
                 this.log.error(`Error reading key file ${path.join(this.matterbridge.matterbridgeDirectory, 'certs/key.pem')}: ${error}`);
+                this.emit('server_error', error);
                 return;
             }
             let ca;
@@ -110,7 +120,14 @@ export class Frontend extends EventEmitter {
                 this.log.info(`CA certificate file ${path.join(this.matterbridge.matterbridgeDirectory, 'certs/ca.pem')} not loaded: ${error}`);
             }
             const serverOptions = { cert, key, ca };
-            this.httpsServer = https.createServer(serverOptions, this.expressApp);
+            try {
+                this.httpsServer = https.createServer(serverOptions, this.expressApp);
+            }
+            catch (error) {
+                this.log.error(`Failed to create HTTPS server: ${error}`);
+                this.emit('server_error', error);
+                return;
+            }
             if (hasParameter('ingress')) {
                 this.httpsServer.listen(this.port, '0.0.0.0', () => {
                     this.log.info(`The frontend https server is listening on ${UNDERLINE}https://0.0.0.0:${this.port}${UNDERLINEOFF}${rs}`);
@@ -187,7 +204,6 @@ export class Frontend extends EventEmitter {
         this.webSocketServer.on('error', (ws, error) => {
             this.log.error(`WebSocketServer error: ${error}`);
         });
-        const { cliEmitter } = await import('./cli.js');
         cliEmitter.removeAllListeners();
         cliEmitter.on('uptime', (systemUptime, processUptime) => {
             this.wssSendUptimeUpdate(systemUptime, processUptime);
@@ -463,6 +479,7 @@ export class Frontend extends EventEmitter {
             this.log.debug('Frontend app closed successfully');
         }
         if (this.webSocketServer) {
+            this.log.debug('Closing WebSocket server...');
             this.webSocketServer.clients.forEach((client) => {
                 if (client.readyState === WebSocket.OPEN) {
                     client.close();
@@ -483,6 +500,7 @@ export class Frontend extends EventEmitter {
             this.webSocketServer = undefined;
         }
         if (this.httpServer) {
+            this.log.debug('Closing http server...');
             await withTimeout(new Promise((resolve) => {
                 this.httpServer?.close((error) => {
                     if (error) {
@@ -499,6 +517,7 @@ export class Frontend extends EventEmitter {
             this.log.debug('Frontend http server closed successfully');
         }
         if (this.httpsServer) {
+            this.log.debug('Closing https server...');
             await withTimeout(new Promise((resolve) => {
                 this.httpsServer?.close((error) => {
                     if (error) {
@@ -543,7 +562,6 @@ export class Frontend extends EventEmitter {
         return `${seconds} second${seconds !== 1 ? 's' : ''}`;
     };
     async getApiSettings() {
-        const { lastCpuUsage } = await import('./cli.js');
         this.matterbridge.systemInformation.totalMemory = this.formatMemoryUsage(os.totalmem());
         this.matterbridge.systemInformation.freeMemory = this.formatMemoryUsage(os.freemem());
         this.matterbridge.systemInformation.systemUptime = this.formatOsUpTime(os.uptime());

package/dist/index.js

@@ -11,14 +11,6 @@ export * from './matterbridgePlatform.js';
 export * from './matterbridgeAccessoryPlatform.js';
 export * from './matterbridgeDynamicPlatform.js';
 export { addVirtualDevice } from './helpers.js';
-export * from './devices/roboticVacuumCleaner.js';
-export * from './devices/laundryWasher.js';
-export * from './devices/laundryDryer.js';
-export * from './devices/waterHeater.js';
-export * from './devices/evse.js';
-export * from './devices/solarPower.js';
-export * from './devices/batteryStorage.js';
-export * from './devices/heatPump.js';
 const log = new AnsiLogger({ logName: 'Main', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
 async function main() {
     log.debug('***Matterbridge.loadInstance() called');

package/dist/pluginManager.js

@@ -241,8 +241,6 @@ export class PluginManager extends EventEmitter {
             plugin.help = this.getHelp(packageJson);
             plugin.changelog = this.getChangelog(packageJson);
             plugin.funding = this.getFunding(packageJson);
-            if (!plugin.path)
-                this.log.warn(`Plugin ${plg}${plugin.name}${wr} has no path`);
             if (!plugin.type)
                 this.log.warn(`Plugin ${plg}${plugin.name}${wr} has no type`);
             const checkForProjectChipPackages = (dependencies) => {

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge",
-  "version": "3.1.1-dev-20250704-aff5fcb",
+  "version": "3.1.2-dev-20250705-7da1eac",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge",
-      "version": "3.1.1-dev-20250704-aff5fcb",
+      "version": "3.1.2-dev-20250705-7da1eac",
       "license": "Apache-2.0",
       "dependencies": {
         "@matter/main": "0.15.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge",
-  "version": "3.1.1-dev-20250704-aff5fcb",
+  "version": "3.1.2-dev-20250705-7da1eac",
   "description": "Matterbridge plugin manager for Matter",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",