feat(ui): Add button to trigger dock auto empty manually (#1087)

Hypfer · Sep 16, 2021 · fa2def7 · fa2def7
1 parent 8736f7f
commit fa2def7
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 8 deletions.
diff --git a/backend/lib/robots/mock/capabilities/MockAutoEmptyDockManualTriggerCapability.js b/backend/lib/robots/mock/capabilities/MockAutoEmptyDockManualTriggerCapability.js
@@ -9,7 +9,7 @@ class MockAutoEmptyDockManualTriggerCapability extends AutoEmptyDockManualTrigge
      * @returns {Promise<void>}
      */
     async triggerAutoEmpty() {
-        Logger.info("Auto Empty Dock Auto Empty triggered");
+        Logger.info("Auto Empty Dock Auto Empty triggered manually");
     }
 }
 

diff --git a/frontend/src/api/client.ts b/frontend/src/api/client.ts
@@ -250,6 +250,12 @@ export const sendLocateCommand = async (): Promise<void> => {
     });
 };
 
+export const sendAutoEmptyDockManualTriggerCommand = async (): Promise<void> => {
+    await valetudoAPI.put<void>(`/robot/capabilities/${Capability.AutoEmptyDockManualTrigger}`, {
+        action: "trigger",
+    });
+};
+
 export const fetchRobotInformation = async (): Promise<RobotInformation> => {
     return valetudoAPI.get<RobotInformation>("/robot").then(({data}) => {
         return data;

diff --git a/frontend/src/api/hooks.ts b/frontend/src/api/hooks.ts
@@ -28,6 +28,7 @@ import {
     fetchValetudoInformation,
     fetchZonePresets,
     fetchZoneProperties,
+    sendAutoEmptyDockManualTriggerCommand,
     sendBasicControlCommand,
     sendCleanSegmentsCommand,
     sendCleanTemporaryZonesCommand,
@@ -369,6 +370,12 @@ export const useLocateMutation = () => {
     return useMutation(sendLocateCommand, { onError });
 };
 
+export const useAutoEmptyDockManualTriggerMutation = () => {
+    const onError = useOnCommandError(Capability.AutoEmptyDockManualTrigger);
+
+    return useMutation(sendAutoEmptyDockManualTriggerCommand, { onError });
+};
+
 export const useRobotInformationQuery = () => {
     return useQuery(CacheKey.RobotInformation, fetchRobotInformation, {
         staleTime: Infinity,

diff --git a/frontend/src/api/types.ts b/frontend/src/api/types.ts
@@ -1,4 +1,5 @@
 export enum Capability {
+    AutoEmptyDockManualTrigger = "AutoEmptyDockManualTriggerCapability",
     BasicControl = "BasicControlCapability",
     CarpetModeControl = "CarpetModeControlCapability",
     CombinedVirtualRestrictions = "CombinedVirtualRestrictionsCapability",

diff --git a/frontend/src/controls/BasicControls.tsx b/frontend/src/controls/BasicControls.tsx
@@ -11,6 +11,7 @@ import {
     BasicControlCommand,
     Capability,
     StatusState,
+    useAutoEmptyDockManualTriggerMutation,
     useBasicControlMutation,
     useLocateMutation,
     useRobotStatusQuery,
@@ -21,6 +22,7 @@ import {
     Pause as PauseIcon,
     PlayArrow as StartIcon,
     Stop as StopIcon,
+    RestoreFromTrash as EmptyIcon,
     SvgIconComponent,
 } from "@material-ui/icons";
 import { useCapabilitiesSupported } from "../CapabilitiesProvider";
@@ -36,7 +38,7 @@ const StartStates: StatusState["value"][] = ["idle", "docked", "paused"];
 const PauseStates: StatusState["value"][] = ["cleaning", "returning", "moving"];
 
 interface CommandButton {
-    command: BasicControlCommand | "locate";
+    command: BasicControlCommand | "locate" | "trigger_empty";
     enabled: boolean;
     label: string;
     Icon: SvgIconComponent;
@@ -53,15 +55,26 @@ const BasicControls = (): JSX.Element => {
         mutate: locate,
         isLoading: locateIsExecuting
     } = useLocateMutation();
-    const isLoading = basicControlIsExecuting || locateIsExecuting;
+    const [triggerEmptySupported] = useCapabilitiesSupported(Capability.AutoEmptyDockManualTrigger);
+    const {
+        mutate: triggerDockEmpty,
+        isLoading: emptyIsExecuting,
+    } = useAutoEmptyDockManualTriggerMutation();
+
+    const isLoading = basicControlIsExecuting || locateIsExecuting || emptyIsExecuting;
 
-    const sendCommand = (command: BasicControlCommand | "locate") => {
+    const sendCommand = (command: BasicControlCommand | "locate" | "trigger_empty") => {
         return () => {
-            if (command === "locate") {
-                locate();
-                return;
+            switch (command) {
+                case "locate":
+                    locate();
+                    break;
+                case "trigger_empty":
+                    triggerDockEmpty();
+                    break;
+                default:
+                    executeBasicControlCommand(command);
             }
-            executeBasicControlCommand(command);
         };
     };
 
@@ -113,6 +126,15 @@ const BasicControls = (): JSX.Element => {
         });
     }
 
+    if (triggerEmptySupported) {
+        buttons.push({
+            command: "trigger_empty",
+            enabled: state === "docked",
+            label: "Empty",
+            Icon: EmptyIcon,
+        });
+    }
+
     return (
         <Paper>
             <Box p={1}>