feat(vendor.roborock): Dock dustbin consumable for all auto-empty docks

Hypfer · Nov 18, 2023 · e3d13fa · e3d13fa
1 parent 868bd74
commit e3d13fa
Show file tree

Hide file tree

Showing 18 changed files with 112 additions and 95 deletions.
diff --git a/backend/lib/robots/roborock/RoborockConst.js b/backend/lib/robots/roborock/RoborockConst.js
@@ -0,0 +1,11 @@
+module.exports = {
+    /**
+     *  @typedef {string} RoborockDockType
+     *  @enum {string}
+     */
+    DOCK_TYPE: Object.freeze({
+        ULTRA: "ultra",
+        AUTO_EMPTY: "auto_empty",
+        CHARGING: "charging"
+    })
+};
diff --git a/backend/lib/robots/roborock/RoborockG10SValetudoRobot.js b/backend/lib/robots/roborock/RoborockG10SValetudoRobot.js
@@ -4,6 +4,7 @@ const fs = require("fs");
 const Logger = require("../../Logger");
 const MiioValetudoRobot = require("../MiioValetudoRobot");
 const QuirksCapability = require("../../core/capabilities/QuirksCapability");
+const RoborockConst = require("./RoborockConst");
 const RoborockGen4ValetudoRobot = require("./RoborockGen4ValetudoRobot");
 const RoborockQuirkFactory = require("./RoborockQuirkFactory");
 const RoborockValetudoRobot = require("./RoborockValetudoRobot");
@@ -24,7 +25,7 @@ class RoborockG10SValetudoRobot extends RoborockGen4ValetudoRobot {
                 {
                     waterGrades: WATER_GRADES,
                     supportedAttachments: SUPPORTED_ATTACHMENTS,
-                    hasUltraDock: true
+                    dockType: RoborockConst.DOCK_TYPE.ULTRA
                 }
             )
         );
@@ -45,11 +46,6 @@ class RoborockG10SValetudoRobot extends RoborockGen4ValetudoRobot {
             })
         }));
 
-        this.registerCapability(new capabilities.RoborockConsumableMonitoringCapability({
-            robot: this,
-            hasUltraDock: true
-        }));
-
         this.registerCapability(new capabilities.RoborockCarpetSensorModeControlCapability({
             robot: this,
             liftModeId: 1

diff --git a/backend/lib/robots/roborock/RoborockM1SValetudoRobot.js b/backend/lib/robots/roborock/RoborockM1SValetudoRobot.js
@@ -15,7 +15,6 @@ class RoborockM1SValetudoRobot extends RoborockValetudoRobot {
         super(Object.assign({}, options, {fanSpeeds: FAN_SPEEDS}));
 
         [
-            capabilities.RoborockConsumableMonitoringCapability,
             capabilities.RoborockMapSnapshotCapability,
             capabilities.RoborockCombinedVirtualRestrictionsCapability,
             capabilities.RoborockPersistentMapControlCapability,

diff --git a/backend/lib/robots/roborock/RoborockQ7MaxValetudoRobot.js b/backend/lib/robots/roborock/RoborockQ7MaxValetudoRobot.js
@@ -2,6 +2,7 @@ const capabilities = require("./capabilities");
 const entities = require("../../entities");
 const MiioValetudoRobot = require("../MiioValetudoRobot");
 const QuirksCapability = require("../../core/capabilities/QuirksCapability");
+const RoborockConst = require("./RoborockConst");
 const RoborockGen4ValetudoRobot = require("./RoborockGen4ValetudoRobot");
 const RoborockQuirkFactory = require("./RoborockQuirkFactory");
 const RoborockValetudoRobot = require("./RoborockValetudoRobot");
@@ -21,7 +22,8 @@ class RoborockQ7MaxValetudoRobot extends RoborockGen4ValetudoRobot {
                 options,
                 {
                     waterGrades: WATER_GRADES,
-                    supportedAttachments: SUPPORTED_ATTACHMENTS
+                    supportedAttachments: SUPPORTED_ATTACHMENTS,
+                    dockType: RoborockConst.DOCK_TYPE.AUTO_EMPTY
                 }
             )
         );
@@ -43,7 +45,6 @@ class RoborockQ7MaxValetudoRobot extends RoborockGen4ValetudoRobot {
         }));
 
         [
-            capabilities.RoborockConsumableMonitoringCapability,
             capabilities.RoborockAutoEmptyDockAutoEmptyControlCapability,
             capabilities.RoborockAutoEmptyDockManualTriggerCapability,
             capabilities.RoborockKeyLockCapability,

diff --git a/backend/lib/robots/roborock/RoborockS4MaxValetudoRobot.js b/backend/lib/robots/roborock/RoborockS4MaxValetudoRobot.js
@@ -16,7 +16,6 @@ class RoborockS4MaxValetudoRobot extends RoborockGen4ValetudoRobot {
         super(options);
 
         [
-            capabilities.RoborockConsumableMonitoringCapability,
             capabilities.RoborockCombinedVirtualRestrictionsCapability
         ].forEach(capability => {
             this.registerCapability(new capability({robot: this}));

diff --git a/backend/lib/robots/roborock/RoborockS4ValetudoRobot.js b/backend/lib/robots/roborock/RoborockS4ValetudoRobot.js
@@ -17,7 +17,6 @@ class RoborockS4ValetudoRobot extends RoborockValetudoRobot {
         super(Object.assign({}, options, {fanSpeeds: FAN_SPEEDS}));
 
         [
-            capabilities.RoborockConsumableMonitoringCapability,
             capabilities.RoborockCombinedVirtualRestrictionsCapability,
             capabilities.RoborockMultiMapPersistentMapControlCapability,
             capabilities.RoborockMultiMapMapResetCapability,

diff --git a/backend/lib/robots/roborock/RoborockS5MaxValetudoRobot.js b/backend/lib/robots/roborock/RoborockS5MaxValetudoRobot.js
@@ -42,7 +42,6 @@ class RoborockS5MaxValetudoRobot extends RoborockValetudoRobot {
         }));
 
         [
-            capabilities.RoborockConsumableMonitoringCapability,
             capabilities.RoborockMultiMapPersistentMapControlCapability,
             capabilities.RoborockMultiMapMapResetCapability,
             capabilities.RoborockMapSegmentationCapability,

diff --git a/backend/lib/robots/roborock/RoborockS5ValetudoRobot.js b/backend/lib/robots/roborock/RoborockS5ValetudoRobot.js
@@ -17,7 +17,6 @@ class RoborockS5ValetudoRobot extends RoborockValetudoRobot {
         super(Object.assign({}, options, {fanSpeeds: FAN_SPEEDS}));
 
         [
-            capabilities.RoborockConsumableMonitoringCapability,
             capabilities.RoborockMapSnapshotCapability,
             capabilities.RoborockCombinedVirtualRestrictionsCapability,
             capabilities.RoborockPersistentMapControlCapability,

diff --git a/backend/lib/robots/roborock/RoborockS6MaxVValetudoRobot.js b/backend/lib/robots/roborock/RoborockS6MaxVValetudoRobot.js
@@ -44,7 +44,6 @@ class RoborockS6MaxVValetudoRobot extends RoborockValetudoRobot {
         }));
 
         [
-            capabilities.RoborockConsumableMonitoringCapability,
             capabilities.RoborockMultiMapPersistentMapControlCapability,
             capabilities.RoborockMultiMapMapResetCapability,
             capabilities.RoborockMapSegmentationCapability,

diff --git a/backend/lib/robots/roborock/RoborockS6PureValetudoRobot.js b/backend/lib/robots/roborock/RoborockS6PureValetudoRobot.js
@@ -16,7 +16,6 @@ class RoborockS6PureValetudoRobot extends RoborockValetudoRobot {
         super(Object.assign({}, options, {fanSpeeds: FAN_SPEEDS}));
 
         [
-            capabilities.RoborockConsumableMonitoringCapability,
             capabilities.RoborockCombinedVirtualRestrictionsCapability,
             capabilities.RoborockMultiMapPersistentMapControlCapability,
             capabilities.RoborockMultiMapMapResetCapability,

diff --git a/backend/lib/robots/roborock/RoborockS6ValetudoRobot.js b/backend/lib/robots/roborock/RoborockS6ValetudoRobot.js
@@ -25,7 +25,6 @@ class RoborockS6ValetudoRobot extends RoborockValetudoRobot {
         }));
 
         [
-            capabilities.RoborockConsumableMonitoringCapability,
             capabilities.RoborockMapSnapshotCapability,
             capabilities.RoborockMultiMapPersistentMapControlCapability,
             capabilities.RoborockMultiMapMapResetCapability,

diff --git a/backend/lib/robots/roborock/RoborockS7ProUltraValetudoRobot.js b/backend/lib/robots/roborock/RoborockS7ProUltraValetudoRobot.js
@@ -2,6 +2,7 @@ const capabilities = require("./capabilities");
 const entities = require("../../entities");
 const MiioValetudoRobot = require("../MiioValetudoRobot");
 const QuirksCapability = require("../../core/capabilities/QuirksCapability");
+const RoborockConst = require("./RoborockConst");
 const RoborockGen4ValetudoRobot = require("./RoborockGen4ValetudoRobot");
 const RoborockQuirkFactory = require("./RoborockQuirkFactory");
 const RoborockValetudoRobot = require("./RoborockValetudoRobot");
@@ -23,7 +24,7 @@ class RoborockS7ProUltraValetudoRobot extends RoborockGen4ValetudoRobot {
                 {
                     waterGrades: WATER_GRADES,
                     supportedAttachments: SUPPORTED_ATTACHMENTS,
-                    hasUltraDock: true
+                    dockType: RoborockConst.DOCK_TYPE.ULTRA
                 }
             )
         );
@@ -44,11 +45,6 @@ class RoborockS7ProUltraValetudoRobot extends RoborockGen4ValetudoRobot {
             })
         }));
 
-        this.registerCapability(new capabilities.RoborockConsumableMonitoringCapability({
-            robot: this,
-            hasUltraDock: true
-        }));
-
         this.registerCapability(new capabilities.RoborockCarpetSensorModeControlCapability({
             robot: this,
             liftModeId: 1

diff --git a/backend/lib/robots/roborock/RoborockS7ValetudoRobot.js b/backend/lib/robots/roborock/RoborockS7ValetudoRobot.js
@@ -2,6 +2,7 @@ const capabilities = require("./capabilities");
 const entities = require("../../entities");
 const MiioValetudoRobot = require("../MiioValetudoRobot");
 const QuirksCapability = require("../../core/capabilities/QuirksCapability");
+const RoborockConst = require("./RoborockConst");
 const RoborockGen4ValetudoRobot = require("./RoborockGen4ValetudoRobot");
 const RoborockQuirkFactory = require("./RoborockQuirkFactory");
 const RoborockValetudoRobot = require("./RoborockValetudoRobot");
@@ -21,7 +22,8 @@ class RoborockS7ValetudoRobot extends RoborockGen4ValetudoRobot {
                 options,
                 {
                     waterGrades: WATER_GRADES,
-                    supportedAttachments: SUPPORTED_ATTACHMENTS
+                    supportedAttachments: SUPPORTED_ATTACHMENTS,
+                    dockType: RoborockConst.DOCK_TYPE.AUTO_EMPTY
                 }
             )
         );
@@ -48,7 +50,6 @@ class RoborockS7ValetudoRobot extends RoborockGen4ValetudoRobot {
         }));
 
         [
-            capabilities.RoborockConsumableMonitoringCapability,
             capabilities.RoborockAutoEmptyDockAutoEmptyControlCapability,
             capabilities.RoborockAutoEmptyDockManualTriggerCapability,
             capabilities.RoborockKeyLockCapability,

diff --git a/backend/lib/robots/roborock/RoborockS8ProUltraValetudoRobot.js b/backend/lib/robots/roborock/RoborockS8ProUltraValetudoRobot.js
@@ -4,6 +4,7 @@ const fs = require("fs");
 const Logger = require("../../Logger");
 const MiioValetudoRobot = require("../MiioValetudoRobot");
 const QuirksCapability = require("../../core/capabilities/QuirksCapability");
+const RoborockConst = require("./RoborockConst");
 const RoborockGen4ValetudoRobot = require("./RoborockGen4ValetudoRobot");
 const RoborockQuirkFactory = require("./RoborockQuirkFactory");
 const RoborockValetudoRobot = require("./RoborockValetudoRobot");
@@ -24,7 +25,7 @@ class RoborockS8ProUltraValetudoRobot extends RoborockGen4ValetudoRobot {
                 {
                     waterGrades: WATER_GRADES,
                     supportedAttachments: SUPPORTED_ATTACHMENTS,
-                    hasUltraDock: true
+                    dockType: RoborockConst.DOCK_TYPE.ULTRA
                 }
             )
         );
@@ -45,11 +46,6 @@ class RoborockS8ProUltraValetudoRobot extends RoborockGen4ValetudoRobot {
             })
         }));
 
-        this.registerCapability(new capabilities.RoborockConsumableMonitoringCapability({
-            robot: this,
-            hasUltraDock: true
-        }));
-
         this.registerCapability(new capabilities.RoborockCarpetSensorModeControlCapability({
             robot: this,
             liftModeId: 3

diff --git a/backend/lib/robots/roborock/RoborockS8ValetudoRobot.js b/backend/lib/robots/roborock/RoborockS8ValetudoRobot.js
@@ -4,6 +4,7 @@ const fs = require("fs");
 const Logger = require("../../Logger");
 const MiioValetudoRobot = require("../MiioValetudoRobot");
 const QuirksCapability = require("../../core/capabilities/QuirksCapability");
+const RoborockConst = require("./RoborockConst");
 const RoborockGen4ValetudoRobot = require("./RoborockGen4ValetudoRobot");
 const RoborockQuirkFactory = require("./RoborockQuirkFactory");
 const RoborockValetudoRobot = require("./RoborockValetudoRobot");
@@ -23,7 +24,8 @@ class RoborockS8ValetudoRobot extends RoborockGen4ValetudoRobot {
                 options,
                 {
                     waterGrades: WATER_GRADES,
-                    supportedAttachments: SUPPORTED_ATTACHMENTS
+                    supportedAttachments: SUPPORTED_ATTACHMENTS,
+                    dockType: RoborockConst.DOCK_TYPE.AUTO_EMPTY
                 }
             )
         );
@@ -50,7 +52,6 @@ class RoborockS8ValetudoRobot extends RoborockGen4ValetudoRobot {
         }));
 
         [
-            capabilities.RoborockConsumableMonitoringCapability,
             capabilities.RoborockAutoEmptyDockAutoEmptyControlCapability,
             capabilities.RoborockAutoEmptyDockManualTriggerCapability,
             capabilities.RoborockKeyLockCapability,

diff --git a/backend/lib/robots/roborock/RoborockV1ValetudoRobot.js b/backend/lib/robots/roborock/RoborockV1ValetudoRobot.js
@@ -1,4 +1,3 @@
-const capabilities = require("./capabilities");
 const entities = require("../../entities");
 const MiioValetudoRobot = require("../MiioValetudoRobot");
 const RoborockValetudoRobot = require("./RoborockValetudoRobot");
@@ -14,12 +13,6 @@ class RoborockV1ValetudoRobot extends RoborockValetudoRobot {
      */
     constructor(options) {
         super(Object.assign({}, options, {fanSpeeds: FAN_SPEEDS}));
-
-        [
-            capabilities.RoborockConsumableMonitoringCapability,
-        ].forEach(capability => {
-            this.registerCapability(new capability({robot: this}));
-        });
     }
 
     getModelName() {

diff --git a/backend/lib/robots/roborock/RoborockValetudoRobot.js b/backend/lib/robots/roborock/RoborockValetudoRobot.js
@@ -1,6 +1,7 @@
 const capabilities = require("./capabilities");
 const fs = require("fs");
 const Logger = require("../../Logger");
+const RoborockConst = require("./RoborockConst");
 const RoborockMapParser = require("./RoborockMapParser");
 
 const DustBinFullValetudoEvent = require("../../valetudo_events/events/DustBinFullValetudoEvent");
@@ -27,7 +28,7 @@ class RoborockValetudoRobot extends MiioValetudoRobot {
      * @param {object} options.fanSpeeds
      * @param {object} [options.waterGrades]
      * @param {Array<import("../../entities/state/attributes/AttachmentStateAttribute").AttachmentStateAttributeType>} [options.supportedAttachments]
-     * @param {boolean} [options.hasUltraDock]
+     * @param {import("./RoborockConst").DOCK_TYPE} [options.dockType]
      */
     constructor(options) {
         super(options);
@@ -36,6 +37,7 @@ class RoborockValetudoRobot extends MiioValetudoRobot {
         this.fanSpeeds = options.fanSpeeds;
         this.waterGrades = options.waterGrades ?? {};
         this.supportedAttachments = options.supportedAttachments ?? [];
+        this.dockType = options.dockType ?? RoborockConst.DOCK_TYPE.CHARGING;
 
         this.supportedAttachments.forEach(attachmentType => {
             this.state.upsertFirstMatchingAttribute(new entities.state.attributes.AttachmentStateAttribute({
@@ -44,15 +46,18 @@ class RoborockValetudoRobot extends MiioValetudoRobot {
             }));
         });
 
-        this.hasUltraDock = !!options.hasUltraDock;
-
         this.registerCapability(new capabilities.RoborockFanSpeedControlCapability({
             robot: this,
             presets: Object.keys(this.fanSpeeds).map(k => {
                 return new ValetudoSelectionPreset({name: k, value: this.fanSpeeds[k]});
             })
         }));
 
+        this.registerCapability(new capabilities.RoborockConsumableMonitoringCapability({
+            robot: this,
+            dockType: this.dockType
+        }));
+
         [
             capabilities.RoborockBasicControlCapability,
             capabilities.RoborockZoneCleaningCapability,
@@ -82,7 +87,7 @@ class RoborockValetudoRobot extends MiioValetudoRobot {
             }));
         }
 
-        if (this.hasUltraDock) {
+        if (this.dockType === RoborockConst.DOCK_TYPE.ULTRA) {
             this.state.upsertFirstMatchingAttribute(new entities.state.attributes.DockStatusStateAttribute({
                 value: entities.state.attributes.DockStatusStateAttribute.VALUE.IDLE
             }));
@@ -247,7 +252,7 @@ class RoborockValetudoRobot extends MiioValetudoRobot {
     parseAndUpdateState(data) {
         let newStateAttr;
 
-        if (this.hasUltraDock) {
+        if (this.dockType === RoborockConst.DOCK_TYPE.ULTRA) {
             if (data["state"] !== undefined) {
                 switch (data["state"]) {
                     case 23: