feat(core): CurrentStatisticsCapability

backend/lib/core/capabilities/CurrentStatisticsCapability.js

@@ -0,0 +1,26 @@
+const Capability = require("./Capability");
+const NotImplementedError = require("../NotImplementedError");
+const ValetudoDataPoint = require("../../entities/core/ValetudoDataPoint");
+
+/**
+ * @template {import("../ValetudoRobot")} T
+ * @extends Capability<T>
+ */
+class CurrentStatisticsCapability extends Capability {
+    /**
+     * The amount and type of stuff returned here depends on the robots implementation
+     *
+     * @return {Promise<Array<ValetudoDataPoint>>}
+     */
+    async getStatistics() {
+        throw new NotImplementedError();
+    }
+
+    getType() {
+        return CurrentStatisticsCapability.TYPE;
+    }
+}
+
+CurrentStatisticsCapability.TYPE = "CurrentStatisticsCapability";
+
+module.exports = CurrentStatisticsCapability;

backend/lib/core/capabilities/index.js

@@ -5,6 +5,7 @@ module.exports = {
     CarpetModeControlCapability: require("./CarpetModeControlCapability"),
     CombinedVirtualRestrictionsCapability: require("./CombinedVirtualRestrictionsCapability"),
     ConsumableMonitoringCapability: require("./ConsumableMonitoringCapability"),
+    CurrentStatisticsCapability: require("./CurrentStatisticsCapability"),
     DebugCapability: require("./DebugCapability"),
     DoNotDisturbCapability: require("./DoNotDisturbCapability"),
     FanSpeedControlCapability: require("./FanSpeedControlCapability"),

backend/lib/webserver/CapabilitiesRouter.js

@@ -87,7 +87,8 @@ const CAPABILITY_TYPE_TO_ROUTER_MAPPING = {
     [capabilities.ObstacleAvoidanceControlCapability.TYPE]: capabilityRouters.SimpleToggleCapabilityRouter,
     [capabilities.AutoEmptyDockAutoEmptyControlCapability.TYPE]: capabilityRouters.SimpleToggleCapabilityRouter,
     [capabilities.AutoEmptyDockManualTriggerCapability.TYPE]: capabilityRouters.AutoEmptyDockManualTriggerCapabilityRouter,
-    [capabilities.TotalStatisticsCapability.TYPE]: capabilityRouters.TotalStatisticsCapabilityRouter
+    [capabilities.TotalStatisticsCapability.TYPE]: capabilityRouters.StatisticsCapabilityRouter,
+    [capabilities.CurrentStatisticsCapability.TYPE]: capabilityRouters.StatisticsCapabilityRouter
 };
 
 module.exports = CapabilitiesRouter;

backend/lib/webserver/capabilityRouters/TotalStatisticsCapabilityRouter.js → backend/lib/webserver/capabilityRouters/StatisticsCapabilityRouter.js

@@ -1,17 +1,17 @@
 const CapabilityRouter = require("./CapabilityRouter");
 const Logger = require("../../Logger");
 
-class TotalStatisticsCapabilityRouter extends CapabilityRouter {
+class StatisticsCapabilityRouter extends CapabilityRouter {
     initRoutes() {
         this.router.get("/", async (req, res) => {
             try {
                 res.json(await this.capability.getStatistics());
             } catch (e) {
-                Logger.warn("Error while fetching total statistics", e);
+                Logger.warn("Error while fetching statistics", e);
                 res.status(500).json(e.message);
             }
         });
     }
 }
 
-module.exports = TotalStatisticsCapabilityRouter;
+module.exports = StatisticsCapabilityRouter;

backend/lib/webserver/capabilityRouters/doc/StatisticsCapabilityRouter.openapi.json

@@ -0,0 +1,89 @@
+{
+  "/api/v2/robot/capabilities/TotalStatisticsCapability": {
+    "get": {
+      "tags": [
+        "TotalStatisticsCapability"
+      ],
+      "summary": "Get total statistics",
+      "responses": {
+        "200": {
+          "description": "Ok",
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/ValetudoDataPoint"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/api/v2/robot/capabilities/TotalStatisticsCapability/properties": {
+    "get": {
+      "tags": [
+        "TotalStatisticsCapability"
+      ],
+      "summary": "Get various capability-related properties",
+      "responses": {
+        "200": {
+          "description": "Ok",
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+
+  "/api/v2/robot/capabilities/CurrentStatisticsCapability": {
+    "get": {
+      "tags": [
+        "CurrentStatisticsCapability"
+      ],
+      "summary": "Get statistics about the current (or last) task",
+      "responses": {
+        "200": {
+          "description": "Ok",
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/ValetudoDataPoint"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/api/v2/robot/capabilities/CurrentStatisticsCapability/properties": {
+    "get": {
+      "tags": [
+        "CurrentStatisticsCapability"
+      ],
+      "summary": "Get various capability-related properties",
+      "responses": {
+        "200": {
+          "description": "Ok",
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

backend/lib/webserver/capabilityRouters/index.js

@@ -21,7 +21,7 @@ module.exports = {
     SimpleToggleCapabilityRouter: require("./SimpleToggleCapabilityRouter"),
     SpeakerTestCapabilityRouter: require("./SpeakerTestCapabilityRouter"),
     SpeakerVolumeControlCapabilityRouter: require("./SpeakerVolumeControlCapabilityRouter"),
-    TotalStatisticsCapabilityRouter: require("./TotalStatisticsCapabilityRouter"),
+    StatisticsCapabilityRouter: require("./StatisticsCapabilityRouter"),
     VoicePackManagementCapabilityRouter: require("./VoicePackManagementCapabilityRouter"),
     WifiConfigurationCapabilityRouter: require("./WifiConfigurationCapabilityRouter"),
     ZoneCleaningCapabilityRouter: require("./ZoneCleaningCapabilityRouter")