matterbridge-roborock-vacuum-plugin 1.1.0-rc10 → 1.1.0-rc11

package/src/roborockService.ts

@@ -39,6 +39,7 @@ export default class RoborockService {
   messageProcessorMap = new Map<string, MessageProcessor>();
   ipMap = new Map<string, string>();
   localClientMap = new Map<string, Client>();
+  mqttAlwaysOnDevices = new Map<string, boolean>();
   clientManager: ClientManager;
   refreshInterval: number;
   requestDeviceStatusInterval: NodeJS.Timeout | undefined;
@@ -48,6 +49,8 @@ export default class RoborockService {
   private supportedRoutines = new Map<string, ServiceArea.Area[]>();
   private selectedAreas = new Map<string, number[]>();
 
+  private readonly vacuumNeedAPIV3 = ['roborock.vacuum.ss07'];
+
   constructor(
     authenticateApiSupplier: Factory<void, RoborockAuthenticateApi> = (logger) => new RoborockAuthenticateApi(logger),
     iotApiSupplier: Factory<UserData, RoborockIoTApi> = (logger, ud) => new RoborockIoTApi(ud, logger),
@@ -117,15 +120,16 @@ export default class RoborockService {
   }
 
   public async getRoomIdFromMap(duid: string): Promise<number | undefined> {
-    const data = (await this.customGet(duid, new RequestMessage({ method: 'get_map_v1' }))) as { vacuumRoom: number | undefined };
+    const data = (await this.customGet(duid, new RequestMessage({ method: 'get_map_v1' }))) as { vacuumRoom?: number };
     return data?.vacuumRoom;
   }
 
-  public async getMapInformation(duid: string): Promise<MapInfo> {
+  public async getMapInformation(duid: string): Promise<MapInfo | undefined> {
     this.logger.debug('RoborockService - getMapInformation', duid);
     assert(this.messageClient !== undefined);
-    return this.messageClient.get<MultipleMap[]>(duid, new RequestMessage({ method: 'get_multi_maps_list' })).then((response) => {
-      return new MapInfo(response[0]);
+    return this.messageClient.get<MultipleMap[] | undefined>(duid, new RequestMessage({ method: 'get_multi_maps_list' })).then((response) => {
+      this.logger.debug('RoborockService - getMapInformation response', debugStringify(response ?? []));
+      return response ? new MapInfo(response[0]) : undefined;
     });
   }
 
@@ -212,6 +216,17 @@ export default class RoborockService {
     return this.getMessageProcessor(duid)?.sendCustomMessage(duid, request);
   }
 
+  public async getCustomAPI(url: string): Promise<unknown> {
+    this.logger.debug('RoborockService - getCustomAPI', url);
+    assert(this.iotApi !== undefined);
+    try {
+      return await this.iotApi.getCustom(url);
+    } catch (error) {
+      this.logger.error(`Failed to get custom API with url ${url}: ${error ? debugStringify(error) : 'undefined'}`);
+      return { result: undefined, error: `Failed to get custom API with url ${url}` };
+    }
+  }
+
   public stopService(): void {
     if (this.messageClient) {
       this.messageClient.disconnect();
@@ -245,15 +260,15 @@ export default class RoborockService {
     this.deviceNotify = callback;
   }
 
-  public async activateDeviceNotify(device: Device): Promise<void> {
+  public activateDeviceNotify(device: Device): void {
     // eslint-disable-next-line @typescript-eslint/no-this-alias
     const self = this;
     this.logger.debug('Requesting device info for device', device.duid);
     const messageProcessor = this.getMessageProcessor(device.duid);
     this.requestDeviceStatusInterval = setInterval(async () => {
       if (messageProcessor) {
-        await messageProcessor.getDeviceStatus(device.duid).then((response: DeviceStatus) => {
-          if (self.deviceNotify) {
+        await messageProcessor.getDeviceStatus(device.duid).then((response: DeviceStatus | undefined) => {
+          if (self.deviceNotify && response) {
             const message = { duid: device.duid, ...response.errorStatus, ...response.message } as DeviceStatusNotify;
             self.logger.debug('Device status update', debugStringify(message));
             self.deviceNotify(NotifyMessageTypes.LocalMessage, message);
@@ -284,6 +299,16 @@ export default class RoborockService {
     const products = new Map<string, string>();
     homeData.products.forEach((p) => products.set(p.id, p.model));
 
+    if (homeData.products.some((p) => this.vacuumNeedAPIV3.includes(p.model))) {
+      this.logger.debug('Using v3 API for home data retrieval');
+      const homeDataV3 = await this.iotApi.getHomev3(homeDetails.rrHomeId);
+      if (!homeDataV3) {
+        throw new Error('Failed to retrieve the home data from v3 API');
+      }
+      homeData.devices = [...homeData.devices, ...homeDataV3.devices.filter((d) => !homeData.devices.some((x) => x.duid === d.duid))];
+      homeData.receivedDevices = [...homeData.receivedDevices, ...homeDataV3.receivedDevices.filter((d) => !homeData.receivedDevices.some((x) => x.duid === d.duid))];
+    }
+
     // Try to get rooms from v2 API if rooms are empty
     if (homeData.rooms.length === 0) {
       const homeDataV2 = await this.iotApi.getHomev2(homeDetails.rrHomeId);
@@ -298,7 +323,6 @@ export default class RoborockService {
     }
 
     const devices: Device[] = [...homeData.devices, ...homeData.receivedDevices];
-    // homeData.devices.length > 0 ? homeData.devices : homeData.receivedDevices;
 
     const result = devices.map((device) => {
       return {
@@ -316,6 +340,7 @@ export default class RoborockService {
           model: homeData.products.find((p) => p.id === device.productId)?.model,
           category: homeData.products.find((p) => p.id === device.productId)?.category,
           batteryLevel: device.deviceStatus?.[Protocol.battery] ?? 100,
+          schema: homeData.products.find((p) => p.id === device.productId)?.schema,
         },
 
         store: {
@@ -344,6 +369,18 @@ export default class RoborockService {
     homeData.products.forEach((p) => products.set(p.id, p.model));
     const devices: Device[] = homeData.devices.length > 0 ? homeData.devices : homeData.receivedDevices;
 
+    if (homeData.rooms.length === 0) {
+      const homeDataV3 = await this.iotApi.getHomev3(homeid);
+      if (homeDataV3 && homeDataV3.rooms && homeDataV3.rooms.length > 0) {
+        homeData.rooms = homeDataV3.rooms;
+      } else {
+        const homeDataV1 = await this.iotApi.getHome(homeid);
+        if (homeDataV1 && homeDataV1.rooms && homeDataV1.rooms.length > 0) {
+          homeData.rooms = homeDataV1.rooms;
+        }
+      }
+    }
+
     const dvs = devices.map((device) => {
       return {
         ...device,
@@ -357,6 +394,7 @@ export default class RoborockService {
           model: homeData.products.find((p) => p.id === device.productId)?.model,
           category: homeData.products.find((p) => p.id === device.productId)?.category,
           batteryLevel: device.deviceStatus?.[Protocol.battery] ?? 100,
+          schema: homeData.products.find((p) => p.id === device.productId)?.schema,
         },
 
         store: {
@@ -384,13 +422,13 @@ export default class RoborockService {
     return this.iotApi.startScene(sceneId);
   }
 
-  public getRoomMappings(duid: string): Promise<number[][]> | undefined {
+  public getRoomMappings(duid: string): Promise<number[][] | undefined> {
     if (!this.messageClient) {
       this.logger.warn('messageClient not initialized. Waititing for next execution');
-      return undefined;
+      return Promise.resolve(undefined);
     }
 
-    return this.messageClient.get(duid, new RequestMessage({ method: 'get_room_mapping' }));
+    return this.messageClient.get(duid, new RequestMessage({ method: 'get_room_mapping', secure: this.isRequestSecure(duid) }));
   }
 
   public async initializeMessageClient(username: string, device: Device, userdata: UserData): Promise<void> {
@@ -434,6 +472,7 @@ export default class RoborockService {
       this.logger.error('messageClient not initialized');
       return false;
     }
+
     // eslint-disable-next-line @typescript-eslint/no-this-alias
     const self = this;
 
@@ -462,6 +501,15 @@ export default class RoborockService {
 
     this.messageProcessorMap.set(device.duid, messageProcessor);
 
+    this.logger.debug('Checking if device supports local connection', device.pv, device.data.model, device.duid);
+    if (device.pv === 'B01') {
+      this.logger.warn('Device does not support local connection', device.duid);
+      this.mqttAlwaysOnDevices.set(device.duid, true);
+      return true;
+    } else {
+      this.mqttAlwaysOnDevices.set(device.duid, false);
+    }
+
     this.logger.debug('Local device', device.duid);
     let localIp = this.ipMap.get(device.duid);
     try {
@@ -507,8 +555,7 @@ export default class RoborockService {
   }
 
   private onLocalClientDisconnect(duid: string): void {
-    // this.mqttAlwaysOnDevices.set(duid, true);
-    this.logger.debug('Local client disconnected for device', duid);
+    this.mqttAlwaysOnDevices.set(duid, true);
   }
 
   private sleep(ms: number): Promise<void> {
@@ -520,4 +567,8 @@ export default class RoborockService {
     this.iotApi = this.iotApiFactory(this.logger, userdata);
     return userdata;
   }
+
+  private isRequestSecure(duid: string): boolean {
+    return this.mqttAlwaysOnDevices.get(duid) ?? false;
+  }
 }

package/src/tests/roborockCommunication/broadcast/listener/implementation/syncMessageListener.test.ts

@@ -1,5 +1,6 @@
 import { SyncMessageListener } from '../../../../../roborockCommunication/broadcast/listener/implementation/syncMessageListener';
 import { Protocol } from '../../../../../roborockCommunication/broadcast/model/protocol';
+import { RequestMessage } from '../../../../../roborockCommunication/broadcast/model/requestMessage';
 
 describe('SyncMessageListener', () => {
   let listener: SyncMessageListener;
@@ -20,7 +21,7 @@ describe('SyncMessageListener', () => {
     const resolve = jest.fn();
     const reject = jest.fn();
     const messageId = 123;
-    listener.waitFor(messageId, resolve, reject);
+    listener.waitFor(messageId, { method: 'test' } as RequestMessage, resolve, reject);
 
     const dps = { id: messageId, result: { foo: 'bar' } };
     const message = {
@@ -38,7 +39,7 @@ describe('SyncMessageListener', () => {
     const resolve = jest.fn();
     const reject = jest.fn();
     const messageId = 456;
-    listener.waitFor(messageId, resolve, reject);
+    listener.waitFor(messageId, { method: 'test' } as RequestMessage, resolve, reject);
 
     const dps = { id: messageId, result: ['ok'] };
     const message = {
@@ -56,7 +57,7 @@ describe('SyncMessageListener', () => {
     const resolve = jest.fn();
     const reject = jest.fn();
     const messageId = 789;
-    listener.waitFor(messageId, resolve, reject);
+    listener.waitFor(messageId, { method: 'test' } as RequestMessage, resolve, reject);
 
     const dps = { id: messageId };
     const message = {
@@ -73,7 +74,7 @@ describe('SyncMessageListener', () => {
     const resolve = jest.fn();
     const reject = jest.fn();
     const messageId = 321;
-    listener.waitFor(messageId, resolve, reject);
+    listener.waitFor(messageId, { method: 'test' } as RequestMessage, resolve, reject);
 
     expect(listener['pending'].has(messageId)).toBe(true);
 

package/web-for-testing/README.md

@@ -0,0 +1,47 @@
+# Web Testing Interface
+
+This is a web-based testing interface for the Matterbridge Roborock Vacuum Plugin.
+
+## 🚀 Quick Start
+
+### Prerequisites
+- Node.js installed on your system
+- Access to the main plugin source code
+
+### Installation & Setup
+
+1. **Copy source files:**
+   ```bash
+   npm run copy-src
+   ```
+
+2. **Build the project:**
+   ```bash
+   npm run build
+   ```
+
+3. **Start the development server:**
+   ```bash
+   npm run dev
+   ```
+
+## 🌐 Access
+
+Once the server is running, open your browser and navigate to:
+```
+http://localhost:3000
+```
+
+## 🔐 Authentication
+
+Log in using your Roborock account credentials:
+- **Username:** Your Roborock account username/email
+- **Password:** Your Roborock account password
+
+## 🧪 Testing
+
+After successful authentication, you can start testing the plugin functionality through the web interface.
+
+---
+
+**Note:** This is a development/testing tool and should not be used in production environments.

package/web-for-testing/nodemon.json

@@ -0,0 +1,7 @@
+{
+    "watch": [
+        "src"
+    ],
+    "ext": "ts",
+    "exec": "node --loader ts-node/esm --experimental-specifier-resolution=node ./src/app.ts"
+}