matterbridge-roborock-vacuum-plugin 1.1.0-rc05 → 1.1.0-rc07

package/README.md

@@ -90,10 +90,23 @@ For a detailed table of how Apple Home clean modes map to Roborock settings, see
 
 ---
 
+### ⚙️ Matterbridge setting
+
+<div align="center">
+  <img src="./screenshot/IMG_6.PNG" alt="Matterbridge Configuration Screenshot" style="border-radius: 8px; max-width: 100%; box-shadow: 0 4px 12px rgba(0,0,0,0.1);" />
+</div>
+
+---
+
 ### 💬 Need Help?
 
+🛠️ **Reporting an Issue**  
+Before opening an issue, please make sure to read the instructions here:  
+[📄 How to Report an Issue](./README_REPORT_ISSUE.md)
+
+💬 **Community Support**  
 Join our Discord for support, updates, and community discussions:  
-👉 [Join the Matterbridge Roborock Discord](https://discord.gg/NHMDKdzm)
+👉 [Join the Matterbridge Roborock Discord](https://discord.gg/favqExHGn4)
 
 ---
 

package/README_REPORT_ISSUE.md

@@ -0,0 +1,34 @@
+### ⚙️ Matterbridge Setup
+
+<div align="center">
+  <img src="./screenshot/IMG_6.PNG" alt="Matterbridge Configuration Screenshot" style="border-radius: 8px; max-width: 100%; box-shadow: 0 4px 12px rgba(0,0,0,0.1);" />
+</div>
+
+> 🛠️ Follow the configuration shown above to set up Matterbridge correctly for your Roborock vacuum.
+
+---
+
+### 🔄 Steps to Reproduce
+
+1. Apply the configuration shown above.  
+2. Restart **Matterbridge**.  
+3. Reproduce the issue you're encountering.
+
+---
+
+### 🪵 Collect Logs
+
+After reproducing the issue, download the **MATTERBRIDGE LOG** file:
+
+<div align="center">
+  <img src="./screenshot/IMG_7.PNG" alt="Download Matterbridge Log Screenshot" style="border-radius: 8px; max-width: 100%; box-shadow: 0 4px 12px rgba(0,0,0,0.1);" />
+</div>
+
+---
+
+### 📬 Submit an Issue
+
+Please upload the log file and describe the problem at:  
+[https://github.com/RinDevJunior/matterbridge-roborock-vacuum-plugin/issues](https://github.com/RinDevJunior/matterbridge-roborock-vacuum-plugin/issues)
+
+Your logs help me troubleshoot and improve compatibility. Thank you! 🙏

package/README_SUPPORTED.md

@@ -12,6 +12,19 @@ These devices have been fully tested and are confirmed to work as expected.
 
 ---
 
+## ⚠️ Not Supported Devices
+
+This plugin does NOT support these models:
+
+| Device Name                | Model String                  |
+|----------------------------|-------------------------------|
+| Roborock Q10 Series        | `roborock.vacuum.ss07`        |
+
+**Reason:**
+Roborock recently released a new series of models, Q10. Roborock has changed the protocol for how these devices interact.
+
+---
+
 ## ⚠️ Other Supported Devices
 
 All other models listed in the code are supported, but **may have some limitations**.
@@ -51,4 +64,4 @@ If you have one of these models, please try it out and let me know your results!
 ---
 
 > **Note:**  
-> If you have a device not listed above, feel free to try it and report your experience!
+> If you have a device not listed above, feel free to try it and report your experience!

package/dist/model/ExperimentalFeatureSetting.js

@@ -1 +1,28 @@
-export {};
+export function createDefaultExperimentalFeatureSetting() {
+    return {
+        enableExperimentalFeature: false,
+        advancedFeature: {
+            showRoutinesAsRoom: false,
+            includeDockStationStatus: false,
+            forceRunAtDefault: false,
+            useVacationModeToSendVacuumToDock: false,
+            enableServerMode: false,
+        },
+        cleanModeSettings: {
+            enableCleanModeMapping: false,
+            vacuuming: {
+                fanMode: 'Balanced',
+                mopRouteMode: 'Standard',
+            },
+            mopping: {
+                waterFlowMode: 'Medium',
+                mopRouteMode: 'Standard',
+            },
+            vacmop: {
+                fanMode: 'Balanced',
+                waterFlowMode: 'Medium',
+                mopRouteMode: 'Standard',
+            },
+        },
+    };
+}

package/dist/platform.js

@@ -10,6 +10,7 @@ import { RoborockVacuumCleaner } from './rvc.js';
 import { configurateBehavior } from './behaviorFactory.js';
 import { RoborockAuthenticateApi, RoborockIoTApi } from './roborockCommunication/index.js';
 import { getSupportedAreas, getSupportedScenes } from './initialData/index.js';
+import { createDefaultExperimentalFeatureSetting } from './model/ExperimentalFeatureSetting.js';
 import NodePersist from 'node-persist';
 import Path from 'node:path';
 export class RoborockMatterbridgePlatform extends MatterbridgeDynamicPlatform {
@@ -33,8 +34,8 @@ export class RoborockMatterbridgePlatform extends MatterbridgeDynamicPlatform {
             config.whiteList = [];
         if (config.blackList === undefined)
             config.blackList = [];
-        if (config.enableExperimentalFeature === undefined)
-            config.enableExperimentalFeature = false;
+        if (config.enableExperimental === undefined)
+            config.enableExperimental = createDefaultExperimentalFeatureSetting();
         const persistDir = Path.join(this.matterbridge.matterbridgePluginDirectory, PLUGIN_NAME, 'persist');
         this.persist = NodePersist.create({ dir: persistDir });
         this.clientManager = new ClientManager(this.log);
@@ -111,14 +112,21 @@ export class RoborockMatterbridgePlatform extends MatterbridgeDynamicPlatform {
             return;
         }
         const self = this;
+        const configurateSuccess = new Map();
         for (const vacuum of this.devices.values()) {
-            await this.configurateDevice(vacuum);
-            this.rrHomeId = vacuum.rrHomeId;
+            const success = await this.configurateDevice(vacuum);
+            configurateSuccess.set(vacuum.duid, success);
+            if (success) {
+                this.rrHomeId = vacuum.rrHomeId;
+            }
         }
         this.roborockService.setDeviceNotify(async function (messageSource, homeData) {
             await self.platformRunner?.updateRobot(messageSource, homeData);
         });
-        for (const robot of this.robots.values()) {
+        for (const [duid, robot] of this.robots.entries()) {
+            if (!configurateSuccess.get(duid)) {
+                continue;
+            }
             await this.roborockService.activateDeviceNotify(robot.device);
         }
         await this.platformRunner?.requestHomeData();
@@ -128,9 +136,13 @@ export class RoborockMatterbridgePlatform extends MatterbridgeDynamicPlatform {
         const username = this.config.username;
         if (this.platformRunner === undefined || this.roborockService === undefined) {
             this.log.error('Initializing: PlatformRunner or RoborockService is undefined');
-            return;
+            return false;
+        }
+        const connectedToLocalNetwork = await this.roborockService.initializeMessageClientForLocal(vacuum);
+        if (!connectedToLocalNetwork) {
+            this.log.error(`Failed to connect to local network for device: ${vacuum.name} (${vacuum.duid})`);
+            return false;
         }
-        await this.roborockService.initializeMessageClientForLocal(vacuum);
         const roomMap = await this.platformRunner.getRoomMapFromDevice(vacuum);
         this.log.debug('Initializing - roomMap: ', debugStringify(roomMap));
         const behaviorHandler = configurateBehavior(vacuum.data.model, vacuum.duid, this.roborockService, this.cleanModeSettings, this.enableExperimentalFeature?.advancedFeature?.forceRunAtDefault ?? false, this.log);
@@ -149,6 +161,7 @@ export class RoborockMatterbridgePlatform extends MatterbridgeDynamicPlatform {
             await this.registerDevice(robot);
         }
         this.robots.set(robot.serialNumber ?? '', robot);
+        return true;
     }
     async onShutdown(reason) {
         await super.onShutdown(reason);

package/dist/roborockService.js

@@ -314,7 +314,7 @@ export default class RoborockService {
         this.logger.debug('Begin get local ip');
         if (this.messageClient === undefined) {
             this.logger.error('messageClient not initialized');
-            return;
+            return false;
         }
         const self = this;
         const messageProcessor = new MessageProcessor(this.messageClient);
@@ -340,6 +340,10 @@ export default class RoborockService {
             if (!localIp) {
                 this.logger.debug('Requesting network info for device', device.duid);
                 const networkInfo = await messageProcessor.getNetworkInfo(device.duid);
+                if (!networkInfo || !networkInfo.ip) {
+                    this.logger.error('Failed to retrieve network info for device', device.duid);
+                    return false;
+                }
                 localIp = networkInfo.ip;
             }
             if (localIp) {
@@ -362,7 +366,9 @@ export default class RoborockService {
         }
         catch (error) {
             this.logger.error('Error requesting network info', error);
+            return false;
         }
+        return true;
     }
     sleep(ms) {
         return new Promise((resolve) => setTimeout(resolve, ms));

package/dist/rvc.js

@@ -15,7 +15,7 @@ export class RoborockVacuumCleaner extends RoboticVacuumCleaner {
         log.debug(`Supported Clean Modes: ${JSON.stringify(cleanModes)}`);
         log.debug(`Supported Run Modes: ${JSON.stringify(supportedRunModes)}`);
         log.debug(`Supported Areas: ${JSON.stringify(supportedAreas)}`);
-        const bridgeMode = enableExperimentalFeature?.advancedFeature.enableServerMode ? 'server' : undefined;
+        const bridgeMode = enableExperimentalFeature?.enableExperimentalFeature && enableExperimentalFeature?.advancedFeature?.enableServerMode ? 'server' : undefined;
         super(deviceName, device.duid, bridgeMode, supportedRunModes[0].mode, supportedRunModes, cleanModes[0].mode, cleanModes, undefined, undefined, RvcOperationalState.OperationalState.Docked, getOperationalStates(), supportedAreas, undefined, supportedAreas[0].areaId);
         this.username = username;
         this.device = device;

package/matterbridge-roborock-vacuum-plugin.config.json

@@ -1,7 +1,7 @@
 {
   "name": "matterbridge-roborock-vacuum-plugin",
   "type": "DynamicPlatform",
-  "version": "1.1.0-rc05",
+  "version": "1.1.0-rc07",
   "whiteList": [],
   "blackList": [],
   "useInterval": true,

package/matterbridge-roborock-vacuum-plugin.schema.json

@@ -1,6 +1,6 @@
 {
   "title": "Matterbridge Roborock Vacuum Plugin",
-  "description": "matterbridge-roborock-vacuum-plugin v. 1.1.0-rc05 by https://github.com/RinDevJunior",
+  "description": "matterbridge-roborock-vacuum-plugin v. 1.1.0-rc07 by https://github.com/RinDevJunior",
   "type": "object",
   "required": [
     "username",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge-roborock-vacuum-plugin",
-  "version": "1.1.0-rc05",
+  "version": "1.1.0-rc07",
   "description": "Matterbridge Roborock Vacuum Plugin",
   "author": "https://github.com/RinDevJunior",
   "license": "MIT",

package/src/model/ExperimentalFeatureSetting.ts

@@ -28,3 +28,32 @@ export interface CleanModeSettings {
     distanceOff?: number;
   };
 }
+
+export function createDefaultExperimentalFeatureSetting(): ExperimentalFeatureSetting {
+  return {
+    enableExperimentalFeature: false,
+    advancedFeature: {
+      showRoutinesAsRoom: false,
+      includeDockStationStatus: false,
+      forceRunAtDefault: false,
+      useVacationModeToSendVacuumToDock: false,
+      enableServerMode: false,
+    },
+    cleanModeSettings: {
+      enableCleanModeMapping: false,
+      vacuuming: {
+        fanMode: 'Balanced',
+        mopRouteMode: 'Standard',
+      },
+      mopping: {
+        waterFlowMode: 'Medium',
+        mopRouteMode: 'Standard',
+      },
+      vacmop: {
+        fanMode: 'Balanced',
+        waterFlowMode: 'Medium',
+        mopRouteMode: 'Standard',
+      },
+    },
+  };
+}

package/src/platform.ts

@@ -11,7 +11,7 @@ import { configurateBehavior } from './behaviorFactory.js';
 import { NotifyMessageTypes } from './notifyMessageTypes.js';
 import { Device, RoborockAuthenticateApi, RoborockIoTApi } from './roborockCommunication/index.js';
 import { getSupportedAreas, getSupportedScenes } from './initialData/index.js';
-import { CleanModeSettings, ExperimentalFeatureSetting } from './model/ExperimentalFeatureSetting.js';
+import { CleanModeSettings, createDefaultExperimentalFeatureSetting, ExperimentalFeatureSetting } from './model/ExperimentalFeatureSetting.js';
 import { ServiceArea } from 'matterbridge/matter/clusters';
 import NodePersist from 'node-persist';
 import Path from 'node:path';
@@ -40,7 +40,7 @@ export class RoborockMatterbridgePlatform extends MatterbridgeDynamicPlatform {
     this.log.info('Initializing platform:', this.config.name);
     if (config.whiteList === undefined) config.whiteList = [];
     if (config.blackList === undefined) config.blackList = [];
-    if (config.enableExperimentalFeature === undefined) config.enableExperimentalFeature = false;
+    if (config.enableExperimental === undefined) config.enableExperimental = createDefaultExperimentalFeatureSetting() as ExperimentalFeatureSetting;
 
     // Create storage for this plugin (initialised in onStart)
     const persistDir = Path.join(this.matterbridge.matterbridgePluginDirectory, PLUGIN_NAME, 'persist');
@@ -161,16 +161,24 @@ export class RoborockMatterbridgePlatform extends MatterbridgeDynamicPlatform {
     // eslint-disable-next-line @typescript-eslint/no-this-alias
     const self = this;
 
+    const configurateSuccess = new Map<string, boolean>();
+
     for (const vacuum of this.devices.values()) {
-      await this.configurateDevice(vacuum);
-      this.rrHomeId = vacuum.rrHomeId;
+      const success = await this.configurateDevice(vacuum);
+      configurateSuccess.set(vacuum.duid, success);
+      if (success) {
+        this.rrHomeId = vacuum.rrHomeId;
+      }
     }
 
     this.roborockService.setDeviceNotify(async function (messageSource: NotifyMessageTypes, homeData: unknown) {
       await self.platformRunner?.updateRobot(messageSource, homeData);
     });
 
-    for (const robot of this.robots.values()) {
+    for (const [duid, robot] of this.robots.entries()) {
+      if (!configurateSuccess.get(duid)) {
+        continue;
+      }
       await this.roborockService.activateDeviceNotify(robot.device);
     }
 
@@ -180,15 +188,21 @@ export class RoborockMatterbridgePlatform extends MatterbridgeDynamicPlatform {
   }
 
   // Running in loop to configurate devices
-  private async configurateDevice(vacuum: Device) {
+  private async configurateDevice(vacuum: Device): Promise<boolean> {
     const username = this.config.username as string;
 
     if (this.platformRunner === undefined || this.roborockService === undefined) {
       this.log.error('Initializing: PlatformRunner or RoborockService is undefined');
-      return;
+      return false;
+    }
+
+    const connectedToLocalNetwork = await this.roborockService.initializeMessageClientForLocal(vacuum);
+
+    if (!connectedToLocalNetwork) {
+      this.log.error(`Failed to connect to local network for device: ${vacuum.name} (${vacuum.duid})`);
+      return false;
     }
 
-    await this.roborockService.initializeMessageClientForLocal(vacuum);
     const roomMap = await this.platformRunner.getRoomMapFromDevice(vacuum);
 
     this.log.debug('Initializing - roomMap: ', debugStringify(roomMap));
@@ -222,6 +236,8 @@ export class RoborockMatterbridgePlatform extends MatterbridgeDynamicPlatform {
     }
 
     this.robots.set(robot.serialNumber ?? '', robot);
+
+    return true;
   }
 
   override async onShutdown(reason?: string) {

package/src/roborockService.ts

@@ -408,11 +408,11 @@ export default class RoborockService {
     this.logger.debug('MessageClient connected');
   }
 
-  public async initializeMessageClientForLocal(device: Device): Promise<void> {
+  public async initializeMessageClientForLocal(device: Device): Promise<boolean> {
     this.logger.debug('Begin get local ip');
     if (this.messageClient === undefined) {
       this.logger.error('messageClient not initialized');
-      return;
+      return false;
     }
     // eslint-disable-next-line @typescript-eslint/no-this-alias
     const self = this;
@@ -448,6 +448,11 @@ export default class RoborockService {
       if (!localIp) {
         this.logger.debug('Requesting network info for device', device.duid);
         const networkInfo = await messageProcessor.getNetworkInfo(device.duid);
+        if (!networkInfo || !networkInfo.ip) {
+          this.logger.error('Failed to retrieve network info for device', device.duid);
+          return false;
+        }
+
         localIp = networkInfo.ip;
       }
 
@@ -473,7 +478,10 @@ export default class RoborockService {
       }
     } catch (error) {
       this.logger.error('Error requesting network info', error);
+      return false;
     }
+
+    return true;
   }
 
   private sleep(ms: number): Promise<void> {

package/src/rvc.ts

@@ -34,7 +34,7 @@ export class RoborockVacuumCleaner extends RoboticVacuumCleaner {
     log.debug(`Supported Run Modes: ${JSON.stringify(supportedRunModes)}`);
     log.debug(`Supported Areas: ${JSON.stringify(supportedAreas)}`);
 
-    const bridgeMode = enableExperimentalFeature?.advancedFeature.enableServerMode ? 'server' : undefined;
+    const bridgeMode = enableExperimentalFeature?.enableExperimentalFeature && enableExperimentalFeature?.advancedFeature?.enableServerMode ? 'server' : undefined;
     super(
       deviceName, // name
       device.duid, // serial