feat: Add properties to capability

Hypfer · Jan 18, 2021 · 7114fcc · 7114fcc
1 parent b2f46ec
commit 7114fcc
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 4 deletions.
diff --git a/lib/core/capabilities/Capability.js b/lib/core/capabilities/Capability.js
@@ -2,7 +2,6 @@ const NotImplementedError = require("../NotImplementedError");
 
 class Capability {
     /**
-     * //TODO: Ggf braucht es eine Referenz auf die Config hier
      *
      * @param {object} options
      * @param {import("../ValetudoRobot")|any} options.robot
@@ -20,6 +19,16 @@ class Capability {
     getType() {
         throw new NotImplementedError();
     }
+
+    /**
+     * This may contain capability-specific information, restrictions etc, which can't be handled
+     * by splitting the problem into seperate capabilities
+     *
+     * @returns {object}
+     */
+    getProperties() {
+        return {};
+    }
 }
 
-module.exports = Capability;
+module.exports = Capability;
diff --git a/lib/core/capabilities/CombinedVirtualRestrictionsCapability.js b/lib/core/capabilities/CombinedVirtualRestrictionsCapability.js
@@ -86,3 +86,5 @@ class CombinedVirtualRestrictionsCapability extends Capability {
 CombinedVirtualRestrictionsCapability.TYPE = "CombinedVirtualRestrictionsCapability";
 
 module.exports = CombinedVirtualRestrictionsCapability;
+
+//Todo: No-Mop-Zone type in properties
diff --git a/lib/core/capabilities/ZoneCleaningCapability.js b/lib/core/capabilities/ZoneCleaningCapability.js
@@ -11,11 +11,39 @@ class ZoneCleaningCapability extends Capability {
         throw new NotImplementedError();
     }
 
+    /**
+     * @returns {ZoneCleaningCapabilityProperties}
+     */
+    getProperties() {
+        return {
+            zoneCount: {
+                min: 1,
+                max: 1
+            },
+            iterationCount: {
+                min: 1,
+                max: 1
+            }
+        };
+    }
+
     getType() {
         return ZoneCleaningCapability.TYPE;
     }
 }
 
 ZoneCleaningCapability.TYPE = "ZoneCleaningCapability";
 
-module.exports = ZoneCleaningCapability;
+module.exports = ZoneCleaningCapability;
+
+/**
+ * @typedef {object} ZoneCleaningCapabilityProperties
+ *
+ * @property {object} zoneCount
+ * @property {number} zoneCount.min
+ * @property {number} zoneCount.max
+ *
+ * @property {object} iterationCount
+ * @property {number} iterationCount.min
+ * @property {number} iterationCount.max
+ */
diff --git a/lib/webserver/capabilityRouters/CapabilityRouter.js b/lib/webserver/capabilityRouters/CapabilityRouter.js
@@ -12,6 +12,10 @@ class CapabilityRouter {
         this.router = express.Router({mergeParams: true});
         this.capability = options.capability;
 
+        this.router.get("/properties", (req, res) => {
+            res.json(this.capability.getProperties());
+        });
+
         this.initRoutes();
     }
 
@@ -28,4 +32,4 @@ class CapabilityRouter {
     }
 }
 
-module.exports = CapabilityRouter;
+module.exports = CapabilityRouter;