matterbridge 3.3.7 → 3.3.8-dev-20251115-920acfc

package/CHANGELOG.md

@@ -28,6 +28,42 @@ Advantages:
 - individual plugin isolation in childbridge mode;
 - ability to update the plugin in childbridge mode without restarting matterbridge;
 
+## [3.3.8] - 2025-11-15
+
+### Development Breaking Changes
+
+This will be the last release with the following long deprecated elements:
+
+- [platform]: Matterbridge instead of PlatformMatterbridge in the platform constructor (deprecated since 3.0.0).
+- [endpoint]: uniqueStorageKey instead of id in MatterbridgeEndpointOptions (deprecated since months).
+- [endpoint]: endpointId instead of number in MatterbridgeEndpointOptions (deprecated since months).
+
+So please update your plugin.
+
+### Added
+
+- [endpoint]: Added matterbridgeEndpointTypes.
+- [devices]: Added tests for device types and their revision changes.
+- [clusters]: Added test for clusters and their revision changes.
+- [chip]: Added fetch script to download zcl data from connectedhomeip.
+- [endpoint]: Added createDefaultPowerSourceBatteryClusterServer(). Add Power Source cluster for a generic battery device.
+- [platform]: Added setSchema() to temporarly set the schema for the config editor.
+- [platform]: Added getSchema() to retrieve the schema from the Matterbridge plugin manager.
+- [platform]: Added return value to registerVirtualDevice().
+
+### Changed
+
+- [package]: Updated dependencies.
+- [package]: Bumped jestHelpers v.1.0.12.
+- [endpoint]: Changed long deprecated uniqueStorageKey with id in MatterbridgeEndpointOptions.
+- [endpoint]: Changed long deprecated endpointId with number in MatterbridgeEndpointOptions.
+- [endpoint]: Added property originalId in MatterbridgeEndpoint to store the original id passed in MatterbridgeEndpointOptions (since it can be changed for matter.js storage compatibility).
+- [endpoint]: Changed logger level of single device classes.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
 ## [3.3.7] - 2025-11-08
 
 ### Breaking Changes
@@ -41,6 +77,7 @@ Advantages:
 
 ### Changed
 
+- [package]: Updated dependencies.
 - [frontend]: Bumped `frontend` version to 3.3.1.
 - [PluginManager]: Bumped `PluginManager` version to 1.3.0.
 - [DeviceManager]: Bumped `DeviceManager` version to 1.1.0.

package/README-SERVICE-OPT.md

@@ -162,23 +162,23 @@ sudo systemctl stop matterbridge
 ### Show Matterbridge status
 
 ```bash
-sudo systemctl status matterbridge.service
+sudo systemctl status matterbridge
 ```
 
 ### Enable Matterbridge to start automatically on boot
 
 ```bash
-sudo systemctl enable matterbridge.service
+sudo systemctl enable matterbridge
 ```
 
 ### Disable Matterbridge from starting automatically on boot
 
 ```bash
-sudo systemctl disable matterbridge.service
+sudo systemctl disable matterbridge
 ```
 
 ### View the log of Matterbridge in real time (this will show the log with colors)
 
 ```bash
-sudo journalctl -u matterbridge.service -n 1000 -f --output cat
+sudo journalctl -u matterbridge -n 1000 -f --output cat
 ```

package/README.md

@@ -354,6 +354,10 @@ The plugin uses local connection to Daikin Wifi modules. The plugin does not wor
 
 Matterbridge Roborock Platform Plugin is a dynamic platform plugin for Matterbridge that integrates Roborock vacuums into the Matter ecosystem, enabling control via Apple Home and other Matter-compatible apps.
 
+### [Wyze Robot Vacuum](https://github.com/RMCob/matterbridge-wyze-robovac)
+
+Matterbridge plugin to control and report status of the Wyze S200 Robot Vacuum
+
 ## How to install and add a plugin with the frontend (best option)
 
 Just open the frontend on the link provided in the log, select a plugin and click install.

package/dist/broadcastServer.js

@@ -1,36 +1,9 @@
-/**
- * This file contains the BroadcastServer class.
- *
- * @file broadcastServer.ts
- * @author Luca Liguori
- * @created 2025-10-05
- * @version 1.0.2
- * @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.
- */
-// eslint-disable-next-line no-console
 if (process.argv.includes('--loader') || process.argv.includes('-loader'))
     console.log('\u001B[32mBroadcastServer loaded.\u001B[40;0m');
 import { EventEmitter } from 'node:events';
 import { BroadcastChannel } from 'node:worker_threads';
 import { debugStringify } from 'node-ansi-logger';
 import { hasParameter } from './utils/commandLine.js';
-/**
- * BroadcastServer class to handle broadcast messages between workers with BroadcastChannel.
- */
 export class BroadcastServer extends EventEmitter {
     name;
     log;
@@ -38,13 +11,6 @@ export class BroadcastServer extends EventEmitter {
     broadcastChannel;
     debug = hasParameter('debug') || hasParameter('verbose');
     verbose = hasParameter('verbose');
-    /**
-     * Creates an instance of BroadcastServer.
-     *
-     * @param {string} name - The name of the broadcast server.
-     * @param {AnsiLogger} log - The logger instance to use for logging.
-     * @param {string} channel - The channel name for the broadcast. Default is 'broadcast-channel'.
-     */
     constructor(name, log, channel = 'broadcast-channel') {
         super();
         this.name = name;
@@ -53,72 +19,30 @@ export class BroadcastServer extends EventEmitter {
         this.broadcastChannel = new BroadcastChannel(this.channel);
         this.broadcastChannel.onmessage = this.broadcastMessageHandler.bind(this);
     }
-    /**
-     * Closes the broadcast channel.
-     *
-     * @returns {void}
-     */
     close() {
-        // @ts-expect-error: wrong type definition in node.d.ts
         this.broadcastChannel.onmessage = null;
         this.broadcastChannel.close();
     }
-    /**
-     * Generates a unique ID with range 100000-999999.
-     *
-     * @returns {number} - A unique ID between 100000 and 999999
-     */
     getUniqueId() {
-        return Math.floor(Math.random() * (999999 - 100000 + 1)) + 100000; // random int between 100000 and 999999
+        return Math.floor(Math.random() * (999999 - 100000 + 1)) + 100000;
     }
-    /**
-     * Type guard to check if a message is a request of a specific type.
-     *
-     * @param {unknown} msg - The message to check.
-     * @param {T} type - The type to check against.
-     * @returns {msg is WorkerRequest<T>} True if the message is a request of the specified type.
-     */
     isWorkerRequest(msg, type) {
         return typeof msg === 'object' && msg !== null && 'id' in msg && 'timestamp' in msg && 'type' in msg && msg.type === type && !('response' in msg) && 'src' in msg && 'dst' in msg;
     }
-    /**
-     * Type guard to check if a message is a response of a specific type.
-     *
-     * @param {unknown} msg - The message to check.
-     * @param {T} type - The type to check against.
-     * @returns {msg is WorkerResponse<T>} True if the message is a response of the specified type.
-     */
     isWorkerResponse(msg, type) {
         return typeof msg === 'object' && msg !== null && 'id' in msg && 'timestamp' in msg && 'type' in msg && msg.type === type && 'response' in msg && 'src' in msg && 'dst' in msg;
     }
-    /**
-     * Handles incoming broadcast messages.
-     *
-     * @param {MessageEvent} event - The message event containing the broadcast message.
-     * @returns {void}
-     */
     broadcastMessageHandler(event) {
         const data = event.data;
         if (this.verbose)
             this.log.debug(`Received broadcast message: ${debugStringify(data)}`);
         this.emit('broadcast_message', data);
     }
-    /**
-     * Broadcast a message to all workers.
-     *
-     * @param {WorkerMessage} message - The message to broadcast.
-     */
     broadcast(message) {
         if (this.verbose)
             this.log.debug(`Broadcasting message: ${debugStringify(message)}`);
         this.broadcastChannel.postMessage(message);
     }
-    /**
-     * Broadcast a request message to all workers.
-     *
-     * @param {WorkerRequest<T>} message - The typed request message to broadcast.
-     * @returns {void}
-     */
     request(message) {
         if (message.id === undefined) {
             message.id = this.getUniqueId();
@@ -134,12 +58,6 @@ export class BroadcastServer extends EventEmitter {
             this.log.debug(`Broadcasting request message: ${debugStringify(message)}`);
         this.broadcastChannel.postMessage(message);
     }
-    /**
-     * Broadcast a response message to all workers.
-     *
-     * @param {WorkerResponse<T>} message - The typed response message to broadcast.
-     * @returns {void}
-     */
     respond(message) {
         if (message.timestamp === undefined) {
             message.timestamp = Date.now();
@@ -152,15 +70,6 @@ export class BroadcastServer extends EventEmitter {
             this.log.debug(`Broadcasting response message: ${debugStringify(message)}`);
         this.broadcastChannel.postMessage(message);
     }
-    /**
-     * Fetch data from a worker.
-     * It broadcasts a request message and waits for a response with the same id.
-     *
-     * @param {WorkerRequest<T>} message - The typed request message to broadcast.
-     * @param {number} timeout - The timeout in milliseconds to wait for a response. Default is 100ms.
-     * @returns {Promise<WorkerResponse<T>>} A promise that resolves with the response from the worker or rejects on timeout.
-     * @throws {Error} If the fetch operation times out after 100ms.
-     */
     async fetch(message, timeout = 100) {
         if (message.id === undefined) {
             message.id = this.getUniqueId();
@@ -189,4 +98,3 @@ export class BroadcastServer extends EventEmitter {
         });
     }
 }
-//# sourceMappingURL=broadcastServer.js.map

package/dist/broadcastServerTypes.js

@@ -1,25 +1 @@
-/**
- * This file contains the BroadcastServer types.
- *
- * @file broadcastServerTypes.ts
- * @author Luca Liguori
- * @created 2025-10-05
- * @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.
- */
 export {};
-//# sourceMappingURL=broadcastServerTypes.js.map

package/dist/cli.js

@@ -1,33 +1,6 @@
-/**
- * This file contains the CLI entry point of Matterbridge.
- *
- * @file cli.ts
- * @author Luca Liguori
- * @created 2023-12-29
- * @version 3.0.0
- * @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.
- */
-/* eslint-disable no-console */
-/* eslint-disable n/no-process-exit */
 if (process.argv.includes('--loader') || process.argv.includes('-loader'))
     console.log('\u001B[32mCli loaded.\u001B[40;0m');
-// AnsiLogger module
 import { AnsiLogger } from 'node-ansi-logger';
-// Cli
 import { cliEmitter } from './cliEmitter.js';
 import { hasParameter, hasAnyParameter } from './utils/commandLine.js';
 import { inspectError } from './utils/error.js';
@@ -37,10 +10,7 @@ import { formatBytes, formatUptime } from './utils/format.js';
 export let instance;
 export const tracker = new Tracker('Cli', false, false);
 export const inspector = new Inspector('Cli', false, false);
-const log = new AnsiLogger({ logName: 'Cli', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: hasParameter('debug') ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
-/**
- * Starts the CPU and memory tracker.
- */
+const log = new AnsiLogger({ logName: 'Cli', logTimestampFormat: 4, logLevel: hasParameter('debug') ? "debug" : "info" });
 function startCpuMemoryCheck() {
     log.debug(`Cpu memory check starting...`);
     tracker.start();
@@ -53,50 +23,26 @@ function startCpuMemoryCheck() {
     });
     log.debug(`Cpu memory check started`);
 }
-/**
- * Stops the CPU and memory tracker.
- */
 function stopCpuMemoryCheck() {
     log.debug(`Cpu memory check stopping...`);
     tracker.stop();
     tracker.removeAllListeners();
     log.debug(`Cpu memory check stopped`);
 }
-/**
- * Starts the inspector for heap sampling.
- * This function is called when the -inspect parameter is passed.
- */
 async function startInspector() {
     await inspector.start();
 }
-/**
- * Stops the heap sampling and saves the profile.
- * This function is called when the -inspect parameter is passed.
- */
 async function stopInspector() {
     await inspector.stop();
 }
-/**
- * Takes a heap snapshot
- */
 async function takeHeapSnapshot() {
     await inspector.takeHeapSnapshot();
 }
-/**
- * Triggers a manual garbage collection.
- * This function is working only if the node process is started with --expose_gc.
- *
- * @remarks To check the effect of the garbage collection, add also --trace_gc or --trace_gc_verbose.
- */
 function triggerGarbageCollection() {
     inspector.runGarbageCollector();
 }
-/**
- * Registers event handlers for the Matterbridge instance.
- */
 function registerHandlers() {
     log.debug('Registering event handlers...');
-    // istanbul ignore next cause registerHandlers is called only if instance is defined
     if (!instance)
         return;
     instance.on('shutdown', () => shutdown());
@@ -110,9 +56,6 @@ function registerHandlers() {
     instance.on('triggergarbagecollection', () => 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'))
@@ -121,56 +64,26 @@ async function shutdown() {
     cliEmitter.emit('shutdown');
     process.exit(0);
 }
-/**
- * Restarts the Matterbridge instance.
- */
 async function restart() {
     log.debug('Received restart event, loading...');
     const { Matterbridge } = await import('./matterbridge.js');
     instance = await Matterbridge.loadInstance(true);
     registerHandlers();
 }
-/**
- * Updates the Matterbridge instance.
- */
 async function update() {
     log.debug('Received update event, updating...');
-    // TODO: Implement update logic outside of matterbridge
     const { Matterbridge } = await import('./matterbridge.js');
     instance = await Matterbridge.loadInstance(true);
     registerHandlers();
 }
-/**
- * Starts the CPU and memory check when the -startmemorycheck parameter is passed.
- */
 function start() {
     log.debug('Received start memory check event');
     startCpuMemoryCheck();
 }
-/**
- * Stops the CPU and memory check when the -stopmemorycheck parameter is passed.
- */
 function stop() {
     log.debug('Received stop memory check event');
     stopCpuMemoryCheck();
 }
-/**
- * Main function that initializes the Matterbridge instance and starts the CLI.
- *
- * @remarks
- *
- * Debug parameters:
- *
- * --debug enables debug logging.
- *
- * --verbose enables verbose logging.
- *
- * --loader enables loader logging.
- *
- * --inspect enables the inspector for heap sampling.
- *
- * --snapshotinterval <milliseconds> can be used to set the heap snapshot interval. Default is undefined. Minimum is 30000 ms.
- */
 async function main() {
     log.debug(`Cli main() started`);
     startCpuMemoryCheck();
@@ -180,7 +93,6 @@ async function main() {
     const { Matterbridge } = await import('./matterbridge.js');
     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();
     }
@@ -198,18 +110,11 @@ main().catch((error) => {
     inspectError(log, 'Matterbridge.loadInstance() failed with error', error);
     shutdown();
 });
-/**
- * Displays the version.
- */
 async function version() {
-    // Dynamic JSON import (Node >= 20) with import attributes
     const { default: pkg } = await import('../package.json', { with: { type: 'json' } });
     console.log(`Matterbridge version ${pkg.version}`);
     process.exit(0);
 }
-/**
- * Displays the help.
- */
 function help() {
     console.log(`
   Usage: matterbridge [options] [command] 
@@ -263,4 +168,3 @@ function help() {
   `);
     process.exit(0);
 }
-//# sourceMappingURL=cli.js.map

package/dist/cliEmitter.js

@@ -1,49 +1,12 @@
-/**
- * This file contains the CLI emitter.
- *
- * @file cliEmitter.ts
- * @author Luca Liguori
- * @created 2025-07-04
- * @version 1.0.2
- * @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.
- */
-// eslint-disable-next-line no-console
 if (process.argv.includes('--loader') || process.argv.includes('-loader'))
     console.log('\u001B[32mCli emitter loaded.\u001B[40;0m');
 import { EventEmitter } from 'node:events';
 export const cliEmitter = new EventEmitter();
 export let lastOsCpuUsage = 0;
 export let lastProcessCpuUsage = 0;
-/**
- * Sets the last os CPU usage.
- *
- * @param {number} val - The os CPU usage percentage to set.
- * @returns {void}
- */
 export function setLastOsCpuUsage(val) {
     lastOsCpuUsage = val;
 }
-/**
- * Sets the last process CPU usage.
- *
- * @param {number} val - The process CPU usage percentage to set.
- * @returns {void}
- */
 export function setLastProcessCpuUsage(val) {
     lastProcessCpuUsage = val;
 }
-//# sourceMappingURL=cliEmitter.js.map

package/dist/cliHistory.js

@@ -1,40 +1,9 @@
-/**
- * This file contains the CLI history page generator.
- *
- * @file cliHistory.ts
- * @author Luca Liguori
- * @created 2025-10-09
- * @version 1.0.1
- * @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.
- */
-// eslint-disable-next-line no-console
 if (process.argv.includes('--loader') || process.argv.includes('-loader'))
     console.log('\u001B[32mCli history loaded.\u001B[40;0m');
 import { writeFileSync } from 'node:fs';
 import path from 'node:path';
 import os from 'node:os';
 import { Tracker } from './utils/tracker.js';
-/**
- * Generates a static HTML dashboard displaying CPU and memory history.
- *
- * @param {GenerateHistoryPageOptions} [options] - Optional configuration for output path, page title, and refresh interval.
- *
- * @returns {string | undefined} The absolute path to the generated HTML file, or undefined if no samples exist.
- */
 export function generateHistoryPage(options = {}) {
     const pageTitle = options.pageTitle ?? 'Matterbridge CPU & Memory History';
     const hostname = options.hostname ?? os.hostname();
@@ -814,13 +783,6 @@ export function generateHistoryPage(options = {}) {
     writeFileSync(outputPath, html, { encoding: 'utf-8' });
     return outputPath;
 }
-/**
- * Escapes HTML special characters to prevent breaking embedded markup.
- *
- * @param {string} input - The string to escape.
- * @returns {string} The escaped string safe for HTML contexts.
- */
 function escapeHtml(input) {
     return input.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;').replace(/'/g, '&#39;');
 }
-//# sourceMappingURL=cliHistory.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