matterbridge-irobot 0.0.3 → 0.0.4-dev-20260409-d3ea264

package/CHANGELOG.md

@@ -6,6 +6,26 @@ If you like this project and find it useful, please consider giving it a **star*
 
 <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="120"></a>
 
+## [0.0.4] - Dev branch
+
+### Added
+
+- [logger]: Add logger level and log on file for the plugin and all devices.
+- [select]: Add select for the platform.
+
+### Changed
+
+- [package]: Update dependencies.
+- [package]: Bump package to `automator` v.3.1.5.
+- [package]: Bump `eslint` to v.10.2.0.
+- [package]: Bump `typescript-eslint` to v.8.58.1.
+- [devcontainer]: Fix pull of new image.
+- [devcontainer]: Update VS Code settings.
+- [devcontainer]: Leave matterbridge scripts in the cloned repo.
+- [scripts]: Update mb-run script.
+
+<a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
+
 ## [0.0.3] - 2026-03-27
 
 First published release. It requires matterbridge v.3.7.1.

package/README.md

@@ -7,10 +7,10 @@
 ![Node.js CI](https://github.com/Luligu/matterbridge-irobot/actions/workflows/build.yml/badge.svg)
 ![CodeQL](https://github.com/Luligu/matterbridge-irobot/actions/workflows/codeql.yml/badge.svg)
 [![codecov](https://codecov.io/gh/Luligu/matterbridge-irobot/branch/main/graph/badge.svg)](https://codecov.io/gh/Luligu/matterbridge-irobot)
-[![styled with prettier](https://img.shields.io/badge/styled_with-Prettier-f8bc45.svg?logo=prettier)](https://github.com/prettier/prettier)
-[![linted with eslint](https://img.shields.io/badge/linted_with-ES_Lint-4B32C3.svg?logo=eslint)](https://github.com/eslint/eslint)
+[![styled with prettier](https://img.shields.io/badge/styled_with-Prettier-f8bc45.svg?logo=prettier)](https://prettier.io/)
+[![linted with eslint](https://img.shields.io/badge/linted_with-ES_Lint-4B32C3.svg?logo=eslint)](https://eslint.org/)
 [![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
-[![ESM](https://img.shields.io/badge/ESM-Node.js-339933?logo=node.js&logoColor=white)](https://nodejs.org/api/esm.html)
+[![ESM](https://img.shields.io/badge/ESM-Node.js-339933?logo=node.js&logoColor=white)](https://nodejs.org/)
 [![matterbridge.io](https://img.shields.io/badge/matterbridge.io-online-brightgreen)](https://matterbridge.io)
 
 [![powered by](https://img.shields.io/badge/powered%20by-matterbridge-blue)](https://www.npmjs.com/package/matterbridge)

package/dist/module.js

@@ -1,3 +1,5 @@
+import { mkdirSync } from 'node:fs';
+import path from 'node:path';
 import { inspect } from 'node:util';
 import { MatterbridgeDynamicPlatform } from 'matterbridge';
 import { RoboticVacuumCleaner } from 'matterbridge/devices';
@@ -19,19 +21,26 @@ export class Platform extends MatterbridgeDynamicPlatform {
         if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.7.1')) {
             throw new Error(`This plugin requires Matterbridge version >= "3.7.1". Please update Matterbridge to the latest version in the frontend.`);
         }
-        this.log.info('Initializing platform:', this.config.name);
         this.config.discovery = this.config.discovery ?? true;
         this.config.whiteList = this.config.whiteList ?? [];
         this.config.blackList = this.config.blackList ?? [];
         this.config.devices = this.config.devices ?? [];
         this.config.enableServerRvc = this.config.enableServerRvc ?? true;
         this.config.debug = this.config.debug ?? false;
+        this.config.logLevel = this.config.logLevel ?? "info";
+        this.config.logOnFile = this.config.logOnFile ?? false;
         this.config.unregisterOnShutdown = this.config.unregisterOnShutdown ?? false;
+        if (this.config.logOnFile) {
+            mkdirSync(path.join(matterbridge.matterbridgePluginDirectory, this.config.name), { recursive: true });
+            this.log.logFilePath = path.join(matterbridge.matterbridgePluginDirectory, this.config.name, this.config.name + '.log');
+        }
+        this.log.info('Initializing platform:', this.config.name);
         this.log.info('Finished initializing platform:', this.config.name);
     }
     async onStart(reason) {
         this.log.info('onStart called with reason:', reason ?? 'none');
         await this.ready;
+        await this.clearSelect();
         if (this.config.discovery)
             await this.discoverDevices();
         await this.registerDevices();
@@ -124,6 +133,9 @@ export class Platform extends MatterbridgeDynamicPlatform {
     async registerDevices(timeout = 3000) {
         for (const device of this.config.devices) {
             this.log.info(`Registering device "${device.name}" with IP ${device.ip}...`);
+            this.setSelectDevice(device.ip ?? 'unknown-ip-' + device.name.toLowerCase().replaceAll(' ', '-'), device.name);
+            if (!this.validateDevice(device.name, true))
+                continue;
             if (device.ip) {
                 try {
                     this.log.info(`Getting public info for device "${device.name}" with IP ${device.ip}...`);
@@ -151,6 +163,10 @@ export class Platform extends MatterbridgeDynamicPlatform {
             const rvc = new RoboticVacuumCleaner(device.name, device.ip ?? device.name.toLocaleLowerCase().replaceAll(' ', '-') + '-unknown-ip', this.config.enableServerRvc ? 'server' : undefined, runMode, runModes, cleanMode, cleanModes, phase, phases, RvcOperationalState.OperationalState.Docked, undefined, supportedAreas, selectedAreas, currentArea, supportedMaps);
             await this.registerDevice(rvc);
             await rvc.construction.ready;
+            rvc.log.logLevel = this.config.logLevel;
+            if (this.config.logOnFile) {
+                rvc.log.logFilePath = path.join(this.matterbridge.matterbridgePluginDirectory, this.config.name, device.name.toLowerCase().replaceAll(' ', '-') + '.log');
+            }
             await rvc.setAttribute(PowerSource.Cluster.with(PowerSource.Feature.Battery), 'batChargeLevel', PowerSource.BatChargeLevel.Ok);
             await rvc.setAttribute(PowerSource.Cluster.with(PowerSource.Feature.Battery, PowerSource.Feature.Rechargeable), 'batChargeState', PowerSource.BatChargeState.IsAtFullCharge);
             await rvc.setAttribute(PowerSource.Cluster.with(PowerSource.Feature.Battery), 'batReplaceability', PowerSource.BatReplaceability.UserReplaceable);

package/matterbridge-irobot.config.json

@@ -8,5 +8,7 @@
   "blackList": [],
   "enableServerRvc": true,
   "debug": false,
+  "logLevel": "info",
+  "logOnFile": false,
   "unregisterOnShutdown": false
 }

package/matterbridge-irobot.schema.json

@@ -45,9 +45,9 @@
     },
     "discovery": {
       "title": "iRobot Discovery",
-      "description": "iRobot discovery of new devices on startup.",
+      "description": "iRobot discovery of new devices on startup. Once the devices are discovered, you can disable discovery to speed up the startup time.",
       "type": "boolean",
-      "ui:widget": "checkbox"
+      "default": true
     },
     "devices": {
       "title": "Devices",
@@ -106,7 +106,7 @@
     },
     "enableServerRvc": {
       "title": "Enable Server RVC",
-      "description": "Enable the Robot Vacuum Cleaner in server mode (Apple Home will crash unless you use this mode!)",
+      "description": "Enable the Robot Vacuum Cleaner in server mode. It is mandatory with Apple Home (Apple Home will crash unless you use this mode!)",
       "type": "boolean",
       "default": true
     },
@@ -114,6 +114,20 @@
       "title": "Enable Debug",
       "description": "Enable the debug for the plugin (development only)",
       "type": "boolean",
+      "default": false,
+      "ui:widget": "hidden"
+    },
+    "logLevel": {
+      "title": "Log Level",
+      "description": "Set the log level for the plugin logger and all devices loggers.",
+      "type": "string",
+      "default": "info",
+      "enum": ["debug", "info", "notice", "warn", "error", "fatal"]
+    },
+    "logOnFile": {
+      "title": "Log On File",
+      "description": "Enable logging to file for the plugin logger and all devices loggers. The log files will be stored in the matterbridge plugin directory.",
+      "type": "boolean",
       "default": false
     },
     "unregisterOnShutdown": {

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-irobot",
-  "version": "0.0.3",
+  "version": "0.0.4-dev-20260409-d3ea264",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-irobot",
-      "version": "0.0.3",
+      "version": "0.0.4-dev-20260409-d3ea264",
       "license": "Apache-2.0",
       "dependencies": {
         "mqtt": "5.15.1",
@@ -31,9 +31,9 @@
       }
     },
     "node_modules/@types/node": {
-      "version": "25.5.0",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-25.5.0.tgz",
-      "integrity": "sha512-jp2P3tQMSxWugkCUKLRPVUpGaL5MVFwF8RDuSRztfwgN1wmqJeMSbKlnEtQqU8UrhTmzEmZdu2I6v2dpp7XIxw==",
+      "version": "25.5.2",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-25.5.2.tgz",
+      "integrity": "sha512-tO4ZIRKNC+MDWV4qKVZe3Ql/woTnmHDr5JD8UI5hn2pwBrHEwOEMZK7WlNb5RKB6EoJ02gwmQS9OrjuFnZYdpg==",
       "license": "MIT",
       "dependencies": {
         "undici-types": "~7.18.0"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-irobot",
-  "version": "0.0.3",
+  "version": "0.0.4-dev-20260409-d3ea264",
   "description": "Matterbridge iRobot plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",
@@ -69,8 +69,7 @@
     "node-persist-manager": "2.0.1"
   },
   "overrides": {
-    "typescript": "6.0.2",
-    "eslint": "10.1.0",
+    "eslint": "10.2.0",
     "@eslint/js": "10.0.1"
   }
 }