feat(core): AutoEmptyDockAutoEmptyControlCapability

Hypfer · Sep 15, 2021 · eeeb46c · eeeb46c
1 parent ca9a499
commit eeeb46c
Show file tree

Hide file tree

Showing 4 changed files with 95 additions and 1 deletion.
diff --git a/backend/lib/core/capabilities/AutoEmptyDockAutoEmptyControlCapability.js b/backend/lib/core/capabilities/AutoEmptyDockAutoEmptyControlCapability.js
@@ -0,0 +1,15 @@
+const SimpleToggleCapability = require("./SimpleToggleCapability");
+
+/**
+ * @template {import("../ValetudoRobot")} T
+ * @extends SimpleToggleCapability<T>
+ */
+class AutoEmptyDockAutoEmptyControlCapability extends SimpleToggleCapability {
+    getType() {
+        return AutoEmptyDockAutoEmptyControlCapability.TYPE;
+    }
+}
+
+AutoEmptyDockAutoEmptyControlCapability.TYPE = "AutoEmptyDockAutoEmptyControlCapability";
+
+module.exports = AutoEmptyDockAutoEmptyControlCapability;
diff --git a/backend/lib/core/capabilities/index.js b/backend/lib/core/capabilities/index.js
@@ -1,4 +1,5 @@
 module.exports = {
+    AutoEmptyDockAutoEmptyControlCapability: require("./AutoEmptyDockAutoEmptyControlCapability"),
     BasicControlCapability: require("./BasicControlCapability"),
     CarpetModeControlCapability: require("./CarpetModeControlCapability"),
     CombinedVirtualRestrictionsCapability: require("./CombinedVirtualRestrictionsCapability"),

diff --git a/backend/lib/webserver/CapabilitiesRouter.js b/backend/lib/webserver/CapabilitiesRouter.js
@@ -84,7 +84,8 @@ const CAPABILITY_TYPE_TO_ROUTER_MAPPING = {
     [capabilities.PendingMapChangeHandlingCapability.TYPE]: capabilityRouters.PendingMapChangeHandlingCapabilityRouter,
     [capabilities.MappingPassCapability.TYPE]: capabilityRouters.MappingPassCapabilityRouter,
     [capabilities.KeyLockCapability.TYPE]: capabilityRouters.SimpleToggleCapabilityRouter,
-    [capabilities.ObstacleAvoidanceControlCapability.TYPE]: capabilityRouters.SimpleToggleCapabilityRouter
+    [capabilities.ObstacleAvoidanceControlCapability.TYPE]: capabilityRouters.SimpleToggleCapabilityRouter,
+    [capabilities.AutoEmptyDockAutoEmptyControlCapability.TYPE]: capabilityRouters.SimpleToggleCapabilityRouter
 };
 
 module.exports = CapabilitiesRouter;
diff --git a/backend/lib/webserver/capabilityRouters/doc/SimpleToggleCapabilityRouter.openapi.json b/backend/lib/webserver/capabilityRouters/doc/SimpleToggleCapabilityRouter.openapi.json
@@ -306,5 +306,82 @@
         }
       }
     }
+  },
+  "/api/v2/robot/capabilities/AutoEmptyDockAutoEmptyControlCapability": {
+    "get": {
+      "tags": [
+        "AutoEmptyDockAutoEmptyControlCapability"
+      ],
+      "summary": "Get auto empty dock auto empty setting",
+      "responses": {
+        "200": {
+          "description": "Ok",
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "enabled": {
+                    "type": "boolean"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "put": {
+      "tags": [
+        "AutoEmptyDockAutoEmptyControlCapability"
+      ],
+      "summary": "Set auto empty dock auto empty setting",
+      "requestBody": {
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "properties": {
+                "action": {
+                  "type": "string",
+                  "enum": [
+                    "enable",
+                    "disable"
+                  ]
+                }
+              }
+            }
+          }
+        }
+      },
+      "responses": {
+        "200": {
+          "$ref": "#/components/responses/200"
+        },
+        "400": {
+          "$ref": "#/components/responses/400"
+        }
+      }
+    }
+  },
+  "/api/v2/robot/capabilities/AutoEmptyDockAutoEmptyControlCapability/properties": {
+    "get": {
+      "tags": [
+        "AutoEmptyDockAutoEmptyControlCapability"
+      ],
+      "summary": "Get various capability-related properties",
+      "responses": {
+        "200": {
+          "description": "Ok",
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              }
+            }
+          }
+        }
+      }
+    }
   }
 }