From 4b3ed974d064b788f470c9439a719a3f3ed95cb9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=B6ren=20Beye?= <github@hypfer.de>
Date: Wed, 20 Jan 2021 20:02:31 +0100
Subject: [PATCH] feat(vendor.roborock): Do not disturb capability (#659)

* Roborock/Capability Do Not Disturb

Co-authored-by: bensweet86 <bensweet@outlook.com.au>
---
 client/services/api.service.js                | 26 ++++-----
 client/settings-timers.html                   |  7 ++-
 client/settings-timers.js                     | 53 +++++++++++--------
 client/settings.html                          |  4 +-
 .../capabilities/DoNotDisturbCapability.js    | 30 +++++++++++
 lib/core/capabilities/index.js                |  1 +
 lib/entities/core/ValetudoDNDConfiguration.js | 31 +++++++++++
 lib/robots/roborock/RoborockValetudoRobot.js  |  3 ++
 .../RoborockDoNotDisturbCapability.js         | 45 ++++++++++++++++
 lib/robots/roborock/capabilities/index.js     |  3 +-
 lib/webserver/CapabilitiesRouter.js           |  3 +-
 .../DoNotDisturbCapabilityRouter.js           | 30 +++++++++++
 lib/webserver/capabilityRouters/index.js      |  3 +-
 13 files changed, 197 insertions(+), 42 deletions(-)
 create mode 100644 lib/core/capabilities/DoNotDisturbCapability.js
 create mode 100644 lib/entities/core/ValetudoDNDConfiguration.js
 create mode 100644 lib/robots/roborock/capabilities/RoborockDoNotDisturbCapability.js
 create mode 100644 lib/webserver/capabilityRouters/DoNotDisturbCapabilityRouter.js

diff --git a/client/services/api.service.js b/client/services/api.service.js
index 668c261f3a1..6bbeaeb2ba6 100644
--- a/client/services/api.service.js
+++ b/client/services/api.service.js
@@ -226,16 +226,22 @@ export class ApiService {
         await this.fetch("DELETE", "api/timers/" + id);
     }
 
-    static async getDnd() {
-        return await this.fetch("GET", "api/get_dnd");
+    static async getDndConfiguration() {
+        return await this.fetch("GET", "api/v2/robot/capabilities/DoNotDisturbCapability");
     }
 
-    static async deleteDnd() {
-        await this.fetch("PUT", "api/delete_dnd");
-    }
-
-    static async setDnd(start_hour, start_minute, end_hour, end_minute) {
-        await this.fetch("POST", "api/set_dnd", {start_hour, start_minute, end_hour, end_minute});
+    static async setDndConfiguration(enabled, start_hour, start_minute, end_hour, end_minute) {
+        await this.fetch("PUT", "api/v2/robot/capabilities/DoNotDisturbCapability", {
+            enabled: enabled,
+            start: {
+                hour: start_hour,
+                minute: start_minute
+            },
+            end: {
+                hour: end_hour,
+                minute: end_minute
+            }
+        });
     }
 
     static async getCarpetMode() {
@@ -270,10 +276,6 @@ export class ApiService {
     }
 
 
-    static async setLabStatus(labStatus) {
-        await this.fetch("PUT", "api/set_lab_status", {lab_status: labStatus});
-    }
-
     static async resetConsumable(type, subType) {
         var url = "api/v2/robot/capabilities/ConsumableMonitoringCapability/" + type;
 
diff --git a/client/settings-timers.html b/client/settings-timers.html
index 064f4c4bb8e..882d2713d8d 100644
--- a/client/settings-timers.html
+++ b/client/settings-timers.html
@@ -124,18 +124,21 @@
         </div>
         <div class="center">Timers</div>
         <div class="right">
+        <!--
             <ons-toolbar-button id="settings-timers-timezone" onclick="showTimeZoneDialog();">
                 <ons-icon icon="fa-cog"></ons-icon>
             </ons-toolbar-button>
+        -->
         </div>
     </ons-toolbar>
     <ons-progress-bar id="loading-bar-settings-timers" value="0" indeterminate="indeterminate"></ons-progress-bar>
 
+<!--
     <ons-list-title style="margin-top:5px;">
         Cleaning - Timers <ons-toolbar-button id="settings-timers-create-new-timer" onclick="showAddTimerDialog(-1);"><ons-icon icon="fa-plus"></ons-icon></ons-toolbar-button></div>
     </ons-list-title>
     <ons-list id="settings-timers-timer-list"></ons-list>
-
+-->
     <ons-list-title style="margin-top:5px;">"Do Not Disturb" - Timer</ons-list-title>
     <ons-list id="settings-dnd-timer-list"></ons-list>
 
@@ -148,7 +151,7 @@
         ons.getScriptPage().appendChild(s);
 
         ons.getScriptPage().onShow = function() {
-            updateSettingsTimersPage();
+            //updateSettingsTimersPage();
             updateDndTimerPage();
         };
       }
diff --git a/client/settings-timers.js b/client/settings-timers.js
index a3b7eed5ce3..6db868d2595 100644
--- a/client/settings-timers.js
+++ b/client/settings-timers.js
@@ -95,9 +95,9 @@ async function updateDndTimerPage() {
         dndTimerList.removeChild(dndTimerList.lastChild);
     }
     try {
-        let res = await ApiService.getDnd();
+        let res = await ApiService.getDndConfiguration();
         // TODO: Check if multiple dnd timers can be created!
-        if (res.length === 0 || res[0].enabled === 0) {
+        if (res.length === 0 || !(res.enabled) ) {
             // no timer is enabled yet, show possibility to add dnd timer
             dndTimerList.appendChild(ons.createElement(
                 "<ons-list-item>\n" +
@@ -110,24 +110,23 @@ async function updateDndTimerPage() {
                 "</ons-list-item>"));
         } else {
             // Show current active timer
-            res.forEach(function(dndTimer) {
-                dndTimerList.appendChild(ons.createElement(
-                    "<ons-list-item>\n" +
-                    "    <div class='left'>DND will start at " + dndTimer.start_hour + ":" +
-                    asTwoDigitNumber(dndTimer.start_minute) + " and end on " +
-                    dndTimer.end_hour + ":" + asTwoDigitNumber(dndTimer.end_minute) + "</div>" +
-                    "    <div class='right'>" +
-                    "        <ons-button modifier='quiet' class='button-margin' style='font-size: 2em;' onclick='showDndTimerDialog(" +
-                    dndTimer.start_hour + ", " + dndTimer.start_minute + ", " +
-                    dndTimer.end_hour + ", " + dndTimer.end_minute + ");'>" +
-                    "            <ons-icon icon='fa-edit'></ons-icon>" +
-                    "        </ons-button>" +
-                    "        <ons-button modifier='quiet' class='button-margin' style='font-size: 2em;' onclick='deleteDndTimer();'>" +
-                    "            <ons-icon icon='fa-trash'></ons-icon>" +
-                    "        </ons-button>" +
-                    "    </div>" +
-                    "</ons-list-item>"));
-            });
+            dndTimerList.appendChild(ons.createElement(
+                "<ons-list-item>\n" +
+                "    <div class='left'>DND will start at " + res.start.hour + ":" +
+                asTwoDigitNumber(res.start.minute) + " and end on " +
+                res.end.hour + ":" + asTwoDigitNumber(res.end.minute) + "</div>" +
+                "    <div class='right'>" +
+                "        <ons-button modifier='quiet' class='button-margin' style='font-size: 2em;' onclick='showDndTimerDialog(" +
+                res.start.hour + ", " + res.start.minute + ", " +
+                res.end.hour + ", " + res.end.minute + ");'>" +
+                "            <ons-icon icon='fa-edit'></ons-icon>" +
+                "        </ons-button>" +
+                "        <ons-button modifier='quiet' class='button-margin' style='font-size: 2em;' onclick='deleteDndTimer();'>" +
+                "            <ons-icon icon='fa-trash'></ons-icon>" +
+                "        </ons-button>" +
+                "    </div>" +
+                "</ons-list-item>"
+            ));
         }
     } catch (err) {
         ons.notification.toast(err.message,
@@ -143,7 +142,7 @@ async function deleteDndTimer() {
         let answer = await ons.notification.confirm("Do you really want to disable DND?");
         if (answer === 1) {
             loadingBarSettingsTimers.setAttribute("indeterminate", "indeterminate");
-            await ApiService.deleteDnd();
+            await ApiService.setDndConfiguration(false, 0, 0, 0, 0);
             updateDndTimerPage();
         }
     } catch (err) {
@@ -160,9 +159,17 @@ async function saveDndTimer() {
     var start_minute = document.getElementById("edit-dnd-form").start_minute.value;
     var end_hour = document.getElementById("edit-dnd-form").end_hour.value;
     var end_minute = document.getElementById("edit-dnd-form").end_minute.value;
+
     if (start_hour && start_minute && end_hour && end_minute) {
         try {
-            await ApiService.setDnd(start_hour, start_minute, end_hour, end_minute);
+            await ApiService.setDndConfiguration(
+                true,
+                parseInt(start_hour),
+                parseInt(start_minute),
+                parseInt(end_hour),
+                parseInt(end_minute)
+            );
+
             hideDndTimerDialog();
             updateDndTimerPage();
         } catch (err) {
@@ -413,4 +420,4 @@ window.deleteDndTimer = deleteDndTimer;
 window.saveDndTimer = saveDndTimer;
 window.addNewTimer = addNewTimer;
 window.showAddTimerDialog = showAddTimerDialog;
-window.hideNewTimerDialog = hideNewTimerDialog;
\ No newline at end of file
+window.hideNewTimerDialog = hideNewTimerDialog;
diff --git a/client/settings.html b/client/settings.html
index 558c95276cb..a3a963e71da 100644
--- a/client/settings.html
+++ b/client/settings.html
@@ -3,12 +3,12 @@
         <div class="title"><ons-icon icon="fa-info"></ons-icon> Info</div>
         <div class="content">View device information</div>
     </ons-card>
-    <!--
+
     <ons-card onclick="fn.pushPage({'id': 'settings-timers.html', 'title': 'Timers'})">
         <div class="title"><ons-icon icon="fa-clock-o"></ons-icon> Timers</div>
         <div class="content">Manage timers</div>
     </ons-card>
-    -->
+
     <!--
     <ons-card onclick="fn.pushPage({'id': 'settings-carpet-mode.html', 'title': 'Carpet Mode'})">
         <div class="title"><ons-icon icon="fa-cart-arrow-down"></ons-icon> Carpet Mode</div>
diff --git a/lib/core/capabilities/DoNotDisturbCapability.js b/lib/core/capabilities/DoNotDisturbCapability.js
new file mode 100644
index 00000000000..05848f9a873
--- /dev/null
+++ b/lib/core/capabilities/DoNotDisturbCapability.js
@@ -0,0 +1,30 @@
+const Capability = require("./Capability");
+const NotImplementedError = require("../NotImplementedError");
+
+class DoNotDisturbCapability extends Capability {
+    /**
+     *
+     * @abstract
+     * @returns {Promise<import("../../entities/core/ValetudoDNDConfiguration")>}
+     */
+    async getDndConfiguration() {
+        throw new NotImplementedError();
+    }
+
+    /**
+     * @abstract
+     * @param {import("../../entities/core/ValetudoDNDConfiguration")} dndConfig
+     * @returns {Promise<void>}
+     */
+    async setDndConfiguration(dndConfig) {
+        throw new NotImplementedError();
+    }
+
+    getType() {
+        return DoNotDisturbCapability.TYPE;
+    }
+}
+
+DoNotDisturbCapability.TYPE = "DoNotDisturbCapability";
+
+module.exports = DoNotDisturbCapability;
diff --git a/lib/core/capabilities/index.js b/lib/core/capabilities/index.js
index a8ba40f9edf..4886dc8f950 100644
--- a/lib/core/capabilities/index.js
+++ b/lib/core/capabilities/index.js
@@ -18,4 +18,5 @@ module.exports = {
     SensorCalibrationCapability: require("./SensorCalibrationCapability"),
     SpeakerVolumeControlCapability: require("./SpeakerVolumeControlCapability"),
     RawCommandCapability: require("./RawCommandCapability"),
+    DoNotDisturbCapability: require("./DoNotDisturbCapability"),
 };
\ No newline at end of file
diff --git a/lib/entities/core/ValetudoDNDConfiguration.js b/lib/entities/core/ValetudoDNDConfiguration.js
new file mode 100644
index 00000000000..a438c20f472
--- /dev/null
+++ b/lib/entities/core/ValetudoDNDConfiguration.js
@@ -0,0 +1,31 @@
+const SerializableEntity = require("../SerializableEntity");
+
+
+// noinspection JSCheckFunctionSignatures
+class ValetudoDNDConfiguration extends SerializableEntity {
+    /**
+     * @param {object} options
+     * @param {boolean} options.enabled
+     *
+     * @param {object} options.start
+     * @param {number} options.start.hour
+     * @param {number} options.start.minute
+     *
+     * @param {object} options.end
+     * @param {number} options.end.hour
+     * @param {number} options.end.minute
+     *
+     * @param {object} [options.metaData]
+     *
+     * @class
+     */
+    constructor(options) {
+        super(options);
+
+        this.enabled = options.enabled;
+        this.start = options.start;
+        this.end = options.end;
+    }
+}
+
+module.exports = ValetudoDNDConfiguration;
diff --git a/lib/robots/roborock/RoborockValetudoRobot.js b/lib/robots/roborock/RoborockValetudoRobot.js
index 748fbc63c3a..7888463c759 100644
--- a/lib/robots/roborock/RoborockValetudoRobot.js
+++ b/lib/robots/roborock/RoborockValetudoRobot.js
@@ -43,6 +43,9 @@ class RoborockValetudoRobot extends MiioValetudoRobot {
         this.registerCapability(new capabilities.RoborockLocateCapability({
             robot: this
         }));
+        this.registerCapability(new capabilities.RoborockDoNotDisturbCapability({
+            robot: this
+        }));
     }
 
     setEmbeddedParameters() {
diff --git a/lib/robots/roborock/capabilities/RoborockDoNotDisturbCapability.js b/lib/robots/roborock/capabilities/RoborockDoNotDisturbCapability.js
new file mode 100644
index 00000000000..7e7eb5dc44c
--- /dev/null
+++ b/lib/robots/roborock/capabilities/RoborockDoNotDisturbCapability.js
@@ -0,0 +1,45 @@
+const DoNotDisturbCapability = require("../../../core/capabilities/DoNotDisturbCapability");
+const ValetudoDNDConfiguration = require("../../../entities/core/ValetudoDNDConfiguration");
+
+class RoborockDoNotDisturbCapability extends DoNotDisturbCapability {
+    /**
+     *
+     * @abstract
+     * @returns {Promise<ValetudoDNDConfiguration>}
+     */
+    async getDndConfiguration() {
+        const res = await this.robot.sendCommand("get_dnd_timer", [], {});
+
+        return new ValetudoDNDConfiguration({
+            enabled: (res[0].enabled === 1),
+            start: {
+                hour: res[0].start_hour,
+                minute: res[0].start_minute
+            },
+            end: {
+                hour: res[0].end_hour,
+                minute: res[0].end_minute
+            }
+        });
+    }
+
+    /**
+     * @abstract
+     * @param {ValetudoDNDConfiguration} dndConfig
+     * @returns {Promise<void>}
+     */
+    async setDndConfiguration(dndConfig) {
+        if (dndConfig.enabled === true) {
+            return this.robot.sendCommand("set_dnd_timer", [
+                dndConfig.start.hour,
+                dndConfig.start.minute,
+                dndConfig.end.hour,
+                dndConfig.end.minute
+            ], {});
+        } else {
+            return this.robot.sendCommand("close_dnd_timer", [], {});
+        }
+    }
+}
+
+module.exports = RoborockDoNotDisturbCapability;
diff --git a/lib/robots/roborock/capabilities/index.js b/lib/robots/roborock/capabilities/index.js
index 4d03677d515..43b17ba29cf 100644
--- a/lib/robots/roborock/capabilities/index.js
+++ b/lib/robots/roborock/capabilities/index.js
@@ -10,5 +10,6 @@ module.exports = {
     RoborockCombinedVirtualRestrictionsCapability: require("./RoborockCombinedVirtualRestrictionsCapability"),
     RoborockPersistentMapControlCapability: require("./RoborockPersistentMapControlCapability"),
     RoborockMultiMapPersistentMapControlCapability: require("./RoborockMultiMapPersistentMapControlCapability"),
-    RoborockMapSegmentationCapability: require("./RoborockMapSegmentationCapability")
+    RoborockMapSegmentationCapability: require("./RoborockMapSegmentationCapability"),
+    RoborockDoNotDisturbCapability: require("./RoborockDoNotDisturbCapability")
 };
diff --git a/lib/webserver/CapabilitiesRouter.js b/lib/webserver/CapabilitiesRouter.js
index c01bcb73b3b..61885a28f93 100644
--- a/lib/webserver/CapabilitiesRouter.js
+++ b/lib/webserver/CapabilitiesRouter.js
@@ -69,7 +69,8 @@ const CAPABILITY_TYPE_TO_ROUTER_MAPPING = {
     [capabilities.SensorCalibrationCapability.TYPE]: capabilityRouters.SensorCalibrationCapabilityRouter,
     [capabilities.SpeakerVolumeControlCapability.TYPE]: capabilityRouters.SpeakerVolumeControlCapabilityRouter,
     [capabilities.RawCommandCapability.TYPE]: capabilityRouters.RawCommandCapabilityRouter,
-    [capabilities.MapSegmentationCapability.TYPE]: capabilityRouters.MapSegmentationCapabilityRouter
+    [capabilities.MapSegmentationCapability.TYPE]: capabilityRouters.MapSegmentationCapabilityRouter,
+    [capabilities.DoNotDisturbCapability.TYPE]: capabilityRouters.DoNotDisturbCapabilityRouter
 };
 
 module.exports = CapabilitiesRouter;
diff --git a/lib/webserver/capabilityRouters/DoNotDisturbCapabilityRouter.js b/lib/webserver/capabilityRouters/DoNotDisturbCapabilityRouter.js
new file mode 100644
index 00000000000..d5c41551e8b
--- /dev/null
+++ b/lib/webserver/capabilityRouters/DoNotDisturbCapabilityRouter.js
@@ -0,0 +1,30 @@
+const Logger = require("../../Logger");
+
+const CapabilityRouter = require("./CapabilityRouter");
+const ValetudoDNDConfiguration = require("../../entities/core/ValetudoDNDConfiguration");
+
+class DoNotDisturbCapabilityRouter extends CapabilityRouter {
+
+    initRoutes() {
+        this.router.get("/", async (req, res) => {
+            res.json(await this.capability.getDndConfiguration());
+        });
+
+        this.router.put("/", async (req, res) => {
+            if (req.body && req.body.start && req.body.end) {
+                try {
+                    await this.capability.setDndConfiguration(new ValetudoDNDConfiguration(req.body));
+
+                    res.sendStatus(200);
+                } catch (e) {
+                    Logger.warn("Error while configuring do not disturb setting", e);
+                    res.status(500).json(e.message);
+                }
+            } else {
+                res.status(400).send("Missing parameters in request body");
+            }
+        });
+    }
+}
+
+module.exports = DoNotDisturbCapabilityRouter;
diff --git a/lib/webserver/capabilityRouters/index.js b/lib/webserver/capabilityRouters/index.js
index a3a03f32551..86ffde737ed 100644
--- a/lib/webserver/capabilityRouters/index.js
+++ b/lib/webserver/capabilityRouters/index.js
@@ -14,5 +14,6 @@ module.exports = {
     SensorCalibrationCapabilityRouter: require("./SensorCalibrationCapabilityRouter"),
     SpeakerVolumeControlCapabilityRouter: require("./SpeakerVolumeControlCapabilityRouter"),
     RawCommandCapabilityRouter: require("./RawCommandCapabilityRouter"),
-    MapSegmentationCapabilityRouter: require("./MapSegmentationCapabilityRouter")
+    MapSegmentationCapabilityRouter: require("./MapSegmentationCapabilityRouter"),
+    DoNotDisturbCapabilityRouter: require("./DoNotDisturbCapabilityRouter")
 };