matterbridge-roborock-vacuum-plugin 1.0.8-rc07 → 1.0.8-rc09

package/dist/initialData/getOperationalStates.js

@@ -1,6 +1,7 @@
 import { RvcOperationalState } from 'matterbridge/matter/clusters';
 import { getDefaultOperationalStates } from '../behaviors/roborock.vacuum/default/initalData.js';
 import { VacuumErrorCode } from '../roborockCommunication/Zenum/vacuumAndDockErrorCode.js';
+import { DockingStationStatusType, hasDockingStationError } from '../model/DockingStationStatus.js';
 export function getOperationalStates() {
     return getDefaultOperationalStates();
 }
@@ -13,3 +14,69 @@ export function getOperationalErrorState(errorCode) {
         }
     }
 }
+export function getErrorFromErrorCode(errorCode) {
+    const operationalState = getOperationalErrorState(errorCode);
+    if (operationalState) {
+        return {
+            errorStateId: RvcOperationalState.ErrorState.NoError,
+            errorStateLabel: `${RvcOperationalState.ErrorState.NoError}`,
+            errorStateDetails: `Error code: ${errorCode}`,
+        };
+    }
+    return undefined;
+}
+export function getErrorFromDSS(status) {
+    if (!status) {
+        return {
+            errorStateId: RvcOperationalState.ErrorState.NoError,
+            errorStateLabel: 'No Docking Station Status',
+            errorStateDetails: 'Docking station status is not available.',
+        };
+    }
+    const hasError = hasDockingStationError(status);
+    if (hasError) {
+        if (status.cleanFluidStatus === DockingStationStatusType.Error) {
+            return {
+                errorStateId: RvcOperationalState.ErrorState.MopCleaningPadMissing,
+                errorStateLabel: 'Clean Fluid Error',
+                errorStateDetails: 'The clean fluid is not available or has an issue.',
+            };
+        }
+        if (status.waterBoxFilterStatus === DockingStationStatusType.Error) {
+            return {
+                errorStateId: RvcOperationalState.ErrorState.WaterTankEmpty,
+                errorStateLabel: 'Water Box Filter Error',
+                errorStateDetails: 'The water box filter is not available or has an issue.',
+            };
+        }
+        if (status.dustBagStatus === DockingStationStatusType.Error) {
+            return {
+                errorStateId: RvcOperationalState.ErrorState.DustBinMissing,
+                errorStateLabel: 'Dust Bag Error',
+                errorStateDetails: 'The dust bag is not available or has an issue.',
+            };
+        }
+        if (status.dirtyWaterBoxStatus === DockingStationStatusType.Error) {
+            return {
+                errorStateId: RvcOperationalState.ErrorState.WaterTankEmpty,
+                errorStateLabel: 'Dirty Water Box Error',
+                errorStateDetails: 'The dirty water box is not available or has an issue.',
+            };
+        }
+        if (status.clearWaterBoxStatus === DockingStationStatusType.Error) {
+            return {
+                errorStateId: RvcOperationalState.ErrorState.WaterTankEmpty,
+                errorStateLabel: 'Clear Water Box Error',
+                errorStateDetails: 'The clear water box is not available or has an issue.',
+            };
+        }
+        if (status.isUpdownWaterReady === DockingStationStatusType.Error) {
+            return {
+                errorStateId: RvcOperationalState.ErrorState.WaterTankMissing,
+                errorStateLabel: 'Updown Water Ready Error',
+                errorStateDetails: 'The updown water tank is not ready or has an issue.',
+            };
+        }
+    }
+    return undefined;
+}

package/dist/platform.js

@@ -25,8 +25,8 @@ export class RoborockMatterbridgePlatform extends MatterbridgeDynamicPlatform {
     persist;
     constructor(matterbridge, log, config) {
         super(matterbridge, log, config);
-        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.0.5')) {
-            throw new Error(`This plugin requires Matterbridge version >= "3.0.5". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend.`);
+        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.0.7')) {
+            throw new Error(`This plugin requires Matterbridge version >= "3.0.7". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend.`);
         }
         this.log.info('Initializing platform:', this.config.name);
         if (config.whiteList === undefined)

package/dist/roborockCommunication/broadcast/client/LocalNetworkClient.js

@@ -56,7 +56,7 @@ export class LocalNetworkClient extends AbstractClient {
         await this.connectionListeners.onConnected();
     }
     async onDisconnect() {
-        this.logger.info('Socket has disconnected.');
+        this.logger.notice('LocalNetworkClient: Socket has disconnected.');
         this.connected = false;
         if (this.socket) {
             this.socket.destroy();
@@ -68,7 +68,7 @@ export class LocalNetworkClient extends AbstractClient {
         await this.connectionListeners.onDisconnected();
     }
     async onError(result) {
-        this.logger.error('Socket connection error: ' + result);
+        this.logger.error('LocalNetworkClient: Socket connection error: ' + result);
         this.connected = false;
         if (this.socket) {
             this.socket.destroy();

package/dist/roborockService.js

@@ -158,7 +158,7 @@ export default class RoborockService {
                 await this.messageProcessor.getDeviceStatus(device.duid).then((response) => {
                     if (self.deviceNotify) {
                         const message = { duid: device.duid, ...response.errorStatus, ...response.message };
-                        self.logger.debug('Device status update xxx', debugStringify(message));
+                        self.logger.debug('Device status update', debugStringify(message));
                         self.deviceNotify(NotifyMessageTypes.LocalMessage, message);
                     }
                 });
@@ -320,6 +320,8 @@ export default class RoborockService {
                     self.deviceNotify(NotifyMessageTypes.BatteryUpdate, { duid: device.duid, percentage });
                 }
             },
+            onStatusChanged: () => {
+            },
         });
         this.logger.debug('Local device', device.duid);
         try {
@@ -332,16 +334,21 @@ export default class RoborockService {
                 this.logger.debug('initializing the local connection for this client towards ' + this.ip);
                 this.localClient = this.messageClient.registerClient(device.duid, this.ip);
                 this.localClient.connect();
-                while (!this.localClient.isConnected()) {
+                let count = 0;
+                while (!this.localClient.isConnected() && count < 20) {
+                    this.logger.debug('Keep waiting for local client to connect');
+                    count++;
                     await this.sleep(500);
                 }
+                if (!this.localClient.isConnected()) {
+                    throw new Error('Local client did not connect after 10 attempts, something is wrong');
+                }
                 this.logger.debug('LocalClient connected');
             }
         }
         catch (error) {
             this.logger.error('Error requesting network info', error);
         }
-        this.logger.debug('Local client connected');
     }
     sleep(ms) {
         return new Promise((resolve) => setTimeout(resolve, ms));

package/dist/rvc.js

@@ -21,15 +21,18 @@ export class RoborockVacuumCleaner extends RoboticVacuumCleaner {
         this.rrHomeId = device.rrHomeId;
     }
     configurateHandler(behaviorHandler) {
-        this.addCommandHandler('identify', async ({ request: { identifyTime } }) => {
-            behaviorHandler.executeCommand('playSoundToLocate', identifyTime);
+        this.addCommandHandler('identify', async ({ request, cluster, attributes, endpoint }) => {
+            this.log.info(`Identify command received for endpoint ${endpoint}, cluster ${cluster}, attributes ${attributes}, request: ${JSON.stringify(request)}`);
+            behaviorHandler.executeCommand('playSoundToLocate', request.identifyTime ?? 0);
         });
         this.addCommandHandler('selectAreas', async ({ request }) => {
-            this.log.info(`Selecting areas: ${request.newAreas.join(', ')}`);
-            behaviorHandler.executeCommand('selectAreas', request.newAreas);
+            const { newAreas } = request;
+            this.log.info(`Selecting areas: ${newAreas?.join(', ')}`);
+            behaviorHandler.executeCommand('selectAreas', newAreas);
         });
         this.addCommandHandler('changeToMode', async ({ request }) => {
-            behaviorHandler.executeCommand('changeToMode', request.newMode);
+            const { newMode } = request;
+            behaviorHandler.executeCommand('changeToMode', newMode);
         });
         this.addCommandHandler('pause', async () => {
             behaviorHandler.executeCommand('pause');

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

@@ -1,7 +1,7 @@
 {
   "name": "matterbridge-roborock-vacuum-plugin",
   "type": "DynamicPlatform",
-  "version": "1.0.8-rc07",
+  "version": "1.0.8-rc09",
   "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.0.8-rc07 by https://github.com/RinDevJunior",
+  "description": "matterbridge-roborock-vacuum-plugin v. 1.0.8-rc09 by https://github.com/RinDevJunior",
   "type": "object",
   "required": ["username", "password"],
   "properties": {

package/package.json

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

package/src/initialData/getOperationalStates.ts

@@ -1,6 +1,7 @@
 import { RvcOperationalState } from 'matterbridge/matter/clusters';
 import { getDefaultOperationalStates } from '../behaviors/roborock.vacuum/default/initalData.js';
 import { VacuumErrorCode } from '../roborockCommunication/Zenum/vacuumAndDockErrorCode.js';
+import { DockingStationStatus, DockingStationStatusType, hasDockingStationError } from '../model/DockingStationStatus.js';
 
 export function getOperationalStates(): RvcOperationalState.OperationalStateStruct[] {
   return getDefaultOperationalStates();
@@ -15,3 +16,79 @@ export function getOperationalErrorState(errorCode: VacuumErrorCode): RvcOperati
     }
   }
 }
+
+export function getErrorFromErrorCode(errorCode: VacuumErrorCode): RvcOperationalState.ErrorStateStruct | undefined {
+  const operationalState = getOperationalErrorState(errorCode);
+  if (operationalState) {
+    return {
+      errorStateId: RvcOperationalState.ErrorState.NoError,
+      errorStateLabel: `${RvcOperationalState.ErrorState.NoError}`,
+      errorStateDetails: `Error code: ${errorCode}`,
+    };
+  }
+  return undefined;
+}
+
+export function getErrorFromDSS(status: DockingStationStatus): RvcOperationalState.ErrorStateStruct | undefined {
+  if (!status) {
+    return {
+      errorStateId: RvcOperationalState.ErrorState.NoError,
+      errorStateLabel: 'No Docking Station Status',
+      errorStateDetails: 'Docking station status is not available.',
+    };
+  }
+
+  const hasError = hasDockingStationError(status);
+
+  if (hasError) {
+    if (status.cleanFluidStatus === DockingStationStatusType.Error) {
+      return {
+        errorStateId: RvcOperationalState.ErrorState.MopCleaningPadMissing,
+        errorStateLabel: 'Clean Fluid Error',
+        errorStateDetails: 'The clean fluid is not available or has an issue.',
+      };
+    }
+
+    if (status.waterBoxFilterStatus === DockingStationStatusType.Error) {
+      return {
+        errorStateId: RvcOperationalState.ErrorState.WaterTankEmpty,
+        errorStateLabel: 'Water Box Filter Error',
+        errorStateDetails: 'The water box filter is not available or has an issue.',
+      };
+    }
+
+    if (status.dustBagStatus === DockingStationStatusType.Error) {
+      return {
+        errorStateId: RvcOperationalState.ErrorState.DustBinMissing,
+        errorStateLabel: 'Dust Bag Error',
+        errorStateDetails: 'The dust bag is not available or has an issue.',
+      };
+    }
+
+    if (status.dirtyWaterBoxStatus === DockingStationStatusType.Error) {
+      return {
+        errorStateId: RvcOperationalState.ErrorState.WaterTankEmpty, // TODO: Check if this is correct
+        errorStateLabel: 'Dirty Water Box Error',
+        errorStateDetails: 'The dirty water box is not available or has an issue.',
+      };
+    }
+
+    if (status.clearWaterBoxStatus === DockingStationStatusType.Error) {
+      return {
+        errorStateId: RvcOperationalState.ErrorState.WaterTankEmpty,
+        errorStateLabel: 'Clear Water Box Error',
+        errorStateDetails: 'The clear water box is not available or has an issue.',
+      };
+    }
+
+    if (status.isUpdownWaterReady === DockingStationStatusType.Error) {
+      return {
+        errorStateId: RvcOperationalState.ErrorState.WaterTankMissing,
+        errorStateLabel: 'Updown Water Ready Error',
+        errorStateDetails: 'The updown water tank is not ready or has an issue.',
+      };
+    }
+  }
+
+  return undefined;
+}

package/src/platform.ts

@@ -32,9 +32,9 @@ export class RoborockMatterbridgePlatform extends MatterbridgeDynamicPlatform {
     super(matterbridge, log, config);
 
     // Verify that Matterbridge is the correct version
-    if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.0.5')) {
+    if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.0.7')) {
       throw new Error(
-        `This plugin requires Matterbridge version >= "3.0.5". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend.`,
+        `This plugin requires Matterbridge version >= "3.0.7". Please update Matterbridge from ${this.matterbridge.matterbridgeVersion} to the latest version in the frontend.`,
       );
     }
     this.log.info('Initializing platform:', this.config.name);

package/src/platformRunner.ts

@@ -16,6 +16,7 @@ import { BatteryMessage, Device, DeviceErrorMessage, DeviceStatusNotify, Home }
 import { OperationStatusCode } from './roborockCommunication/Zenum/operationStatusCode.js';
 import { getCurrentCleanModeFunc } from './share/runtimeHelper.js';
 import { debugStringify } from 'matterbridge/logger';
+// import { getErrorFromErrorCode } from './initialData/getOperationalStates.js';
 
 export class PlatformRunner {
   platform: RoborockMatterbridgePlatform;
@@ -95,6 +96,11 @@ export class PlatformRunner {
         if (operationalStateId) {
           platform.log.error(`Error occurred: ${message.errorCode}`);
           platform.robot.updateAttribute(RvcOperationalState.Cluster.id, 'operationalState', operationalStateId, platform.log);
+
+          // const errorState = getErrorFromErrorCode(message.errorCode);
+          // if (operationalStateId === RvcOperationalState.OperationalState.Error && errorState) {
+          //   platform.robot.updateAttribute(RvcOperationalState.Cluster.id, 'operationalError', errorState, platform.log);
+          // }
         }
         break;
       }

package/src/roborockCommunication/broadcast/client/LocalNetworkClient.ts

@@ -67,7 +67,7 @@ export class LocalNetworkClient extends AbstractClient {
   }
 
   private async onDisconnect(): Promise<void> {
-    this.logger.info('Socket has disconnected.');
+    this.logger.notice('LocalNetworkClient: Socket has disconnected.');
     this.connected = false;
 
     if (this.socket) {
@@ -82,7 +82,7 @@ export class LocalNetworkClient extends AbstractClient {
   }
 
   private async onError(result: Error): Promise<void> {
-    this.logger.error('Socket connection error: ' + result);
+    this.logger.error('LocalNetworkClient: Socket connection error: ' + result);
     this.connected = false;
 
     if (this.socket) {

package/src/roborockCommunication/broadcast/listener/implementation/simpleMessageListener.ts

@@ -2,6 +2,7 @@ import { ResponseMessage } from '../../model/responseMessage.js';
 import { AbstractMessageListener } from '../index.js';
 import { Protocol } from '../../model/protocol.js';
 import { AbstractMessageHandler } from '../abstractMessageHandler.js';
+// import { DeviceStatus } from '../../../Zmodel/deviceStatus.js';
 
 export class SimpleMessageListener implements AbstractMessageListener {
   private handler: AbstractMessageHandler | undefined;

package/src/roborockService.ts

@@ -29,6 +29,7 @@ import type {
   DeviceStatusNotify,
 } from './roborockCommunication/index.js';
 import { ServiceArea } from 'matterbridge/matter/clusters';
+import { LocalNetworkClient } from './roborockCommunication/broadcast/client/LocalNetworkClient.js';
 export type Factory<A, T> = (logger: AnsiLogger, arg: A) => T;
 
 export default class RoborockService {
@@ -227,7 +228,7 @@ export default class RoborockService {
         await this.messageProcessor.getDeviceStatus(device.duid).then((response: DeviceStatus) => {
           if (self.deviceNotify) {
             const message: DeviceStatusNotify = { duid: device.duid, ...response.errorStatus, ...response.message } as DeviceStatusNotify;
-            self.logger.debug('Device status update xxx', debugStringify(message));
+            self.logger.debug('Device status update', debugStringify(message));
             self.deviceNotify(NotifyMessageTypes.LocalMessage, message);
           }
         });
@@ -419,6 +420,14 @@ export default class RoborockService {
           self.deviceNotify(NotifyMessageTypes.BatteryUpdate, { duid: device.duid, percentage } as BatteryMessage);
         }
       },
+      onStatusChanged: () => {
+        // status: DeviceStatus
+        // if (self.deviceNotify) {
+        //   const message: DeviceStatusNotify = { duid: device.duid, ...status.errorStatus, ...status.message } as DeviceStatusNotify;
+        //   self.logger.debug('Device status update', debugStringify(message));
+        //   self.deviceNotify(NotifyMessageTypes.LocalMessage, message);
+        // }
+      },
     } as AbstractMessageHandler);
 
     this.logger.debug('Local device', device.duid);
@@ -431,19 +440,25 @@ export default class RoborockService {
 
       if (this.ip) {
         this.logger.debug('initializing the local connection for this client towards ' + this.ip);
-        this.localClient = this.messageClient.registerClient(device.duid, this.ip);
+        this.localClient = this.messageClient.registerClient(device.duid, this.ip) as LocalNetworkClient;
         this.localClient.connect();
 
-        while (!this.localClient.isConnected()) {
+        let count = 0;
+        while (!this.localClient.isConnected() && count < 20) {
+          this.logger.debug('Keep waiting for local client to connect');
+          count++;
           await this.sleep(500);
         }
+
+        if (!this.localClient.isConnected()) {
+          throw new Error('Local client did not connect after 10 attempts, something is wrong');
+        }
+
         this.logger.debug('LocalClient connected');
       }
     } catch (error) {
       this.logger.error('Error requesting network info', error);
     }
-
-    this.logger.debug('Local client connected');
   }
 
   private sleep(ms: number): Promise<void> {

package/src/rvc.ts

@@ -56,17 +56,20 @@ export class RoborockVacuumCleaner extends RoboticVacuumCleaner {
   }
 
   public configurateHandler(behaviorHandler: BehaviorFactoryResult): void {
-    this.addCommandHandler('identify', async ({ request: { identifyTime } }) => {
-      behaviorHandler.executeCommand('playSoundToLocate', identifyTime as number);
+    this.addCommandHandler('identify', async ({ request, cluster, attributes, endpoint }) => {
+      this.log.info(`Identify command received for endpoint ${endpoint}, cluster ${cluster}, attributes ${attributes}, request: ${JSON.stringify(request)}`);
+      behaviorHandler.executeCommand('playSoundToLocate', (request as { identifyTime?: number }).identifyTime ?? 0);
     });
 
-    this.addCommandHandler('selectAreas', async ({ request }: { request: ServiceArea.SelectAreasRequest }) => {
-      this.log.info(`Selecting areas: ${request.newAreas.join(', ')}`);
-      behaviorHandler.executeCommand('selectAreas', request.newAreas);
+    this.addCommandHandler('selectAreas', async ({ request }) => {
+      const { newAreas } = request as ServiceArea.SelectAreasRequest;
+      this.log.info(`Selecting areas: ${newAreas?.join(', ')}`);
+      behaviorHandler.executeCommand('selectAreas', newAreas);
     });
 
-    this.addCommandHandler('changeToMode', async ({ request }: { request: ModeBase.ChangeToModeRequest }) => {
-      behaviorHandler.executeCommand('changeToMode', request.newMode);
+    this.addCommandHandler('changeToMode', async ({ request }) => {
+      const { newMode } = request as ModeBase.ChangeToModeRequest;
+      behaviorHandler.executeCommand('changeToMode', newMode);
     });
 
     this.addCommandHandler('pause', async () => {