feat(vendor.viomi): IntensiveMoppingPathControlCapability

Author: Hypfer

backend/lib/robots/viomi/ViomiQuirkFactory.js

@@ -54,46 +54,6 @@ class ViomiQuirkFactory {
                         return this.robot.sendCommand("set_light", [val], {});
                     }
                 });
-            case ViomiQuirkFactory.KNOWN_QUIRKS.MOP_PATTERN:
-                return new Quirk({
-                    id: id,
-                    title: "Mop Pattern",
-                    description: "This robot can either mop in straight lines or in a Y-pattern",
-                    options: ["normal", "y_pattern"],
-                    getter: async () => {
-                        const res = await this.robot.sendCommand("get_prop", ["mop_route"], {});
-
-                        if (!(Array.isArray(res) && res.length === 1)) {
-                            throw new Error(`Received invalid response: ${res}`);
-                        } else {
-                            switch (res[0]) {
-                                case 1:
-                                    return "y_pattern";
-                                case 0:
-                                    return "normal";
-                                default:
-                                    throw new Error(`Received invalid value ${res}`);
-                            }
-                        }
-
-                    },
-                    setter: async (value) => {
-                        let val;
-
-                        switch (value) {
-                            case "y_pattern":
-                                val = 1;
-                                break;
-                            case "normal":
-                                val = 0;
-                                break;
-                            default:
-                                throw new Error(`Received invalid value ${value}`);
-                        }
-
-                        return this.robot.sendCommand("set_moproute", [val], {});
-                    }
-                });
             case ViomiQuirkFactory.KNOWN_QUIRKS.OUTLINE_MODE:
                 return new Quirk({
                     id: id,
@@ -147,7 +107,6 @@ class ViomiQuirkFactory {
 
 ViomiQuirkFactory.KNOWN_QUIRKS = {
     BUTTON_LEDS: "977c5972-1f12-4ef1-9622-ce71fd085193",
-    MOP_PATTERN: "0ae06cb4-8cc7-429f-95fb-f3d0bbfc06de",
     OUTLINE_MODE: "061b826c-417c-46a0-b6ad-807260cd4f70",
 };
 

backend/lib/robots/viomi/ViomiV6ValetudoRobot.js

@@ -20,14 +20,17 @@ class ViomiV6ValetudoRobot extends ViomiValetudoRobot {
             robot: this
         }));
 
+        this.registerCapability(new capabilities.ViomiIntensiveMoppingPathControlCapability({
+            robot: this
+        }));
+
         const quirkFactory = new ViomiQuirkFactory({
             robot: this
         });
         this.registerCapability(new QuirksCapability({
             robot: this,
             quirks: [
                 quirkFactory.getQuirk(ViomiQuirkFactory.KNOWN_QUIRKS.BUTTON_LEDS),
-                quirkFactory.getQuirk(ViomiQuirkFactory.KNOWN_QUIRKS.MOP_PATTERN),
                 quirkFactory.getQuirk(ViomiQuirkFactory.KNOWN_QUIRKS.OUTLINE_MODE),
             ]
         }));

backend/lib/robots/viomi/ViomiV7ValetudoRobot.js

@@ -1,3 +1,4 @@
+const capabilities = require("./capabilities");
 const MiioValetudoRobot = require("../MiioValetudoRobot");
 const QuirksCapability = require("../../core/capabilities/QuirksCapability");
 const ViomiQuirkFactory = require("./ViomiQuirkFactory");
@@ -15,14 +16,17 @@ class ViomiV7ValetudoRobot extends ViomiValetudoRobot {
     constructor(options) {
         super(options);
 
+        this.registerCapability(new capabilities.ViomiIntensiveMoppingPathControlCapability({
+            robot: this
+        }));
+
         const quirkFactory = new ViomiQuirkFactory({
             robot: this
         });
         this.registerCapability(new QuirksCapability({
             robot: this,
             quirks: [
                 quirkFactory.getQuirk(ViomiQuirkFactory.KNOWN_QUIRKS.BUTTON_LEDS),
-                quirkFactory.getQuirk(ViomiQuirkFactory.KNOWN_QUIRKS.MOP_PATTERN),
                 quirkFactory.getQuirk(ViomiQuirkFactory.KNOWN_QUIRKS.OUTLINE_MODE),
             ]
         }));

backend/lib/robots/viomi/capabilities/ViomiIntensiveMoppingPathControlCapability.js

@@ -0,0 +1,41 @@
+const IntensiveMoppingPathControlCapability = require("../../../core/capabilities/IntensiveMoppingPathControlCapability");
+const {sleep} = require("../../../utils/misc");
+
+/**
+ * @extends IntensiveMoppingPathControlCapability<import("../ViomiValetudoRobot")>
+ */
+class ViomiIntensiveMoppingPathControlCapability extends IntensiveMoppingPathControlCapability {
+
+    /**
+     * @returns {Promise<boolean>}
+     */
+    async isEnabled() {
+        const res = await this.robot.sendCommand("get_prop", ["mop_route"], {});
+
+        if (!(Array.isArray(res) && res.length === 1)) {
+            throw new Error(`Received invalid response: ${res}`);
+        }
+
+        return res[0] === 1;
+    }
+
+    /**
+     * @returns {Promise<void>}
+     */
+    async enable() {
+        await this.robot.sendCommand("set_moproute", [1], {});
+
+        await sleep(3_000); // Give the firmware a lot of time to think
+    }
+
+    /**
+     * @returns {Promise<void>}
+     */
+    async disable() {
+        await this.robot.sendCommand("set_moproute", [0], {});
+
+        await sleep(3_000); // Give the firmware a lot of time to think
+    }
+}
+
+module.exports = ViomiIntensiveMoppingPathControlCapability;

backend/lib/robots/viomi/capabilities/index.js

@@ -6,6 +6,7 @@ module.exports = {
     ViomiCurrentStatisticsCapability: require("./ViomiCurrentStatisticsCapability"),
     ViomiDoNotDisturbCapability: require("./ViomiDoNotDisturbCapability"),
     ViomiFanSpeedControlCapability: require("./ViomiFanSpeedControlCapability"),
+    ViomiIntensiveMoppingPathControlCapability: require("./ViomiIntensiveMoppingPathControlCapability"),
     ViomiLocateCapability: require("./ViomiLocateCapability"),
     ViomiManualControlCapability: require("./ViomiManualControlCapability"),
     ViomiMapResetCapability: require("./ViomiMapResetCapability"),