feat: Timers

client/settings-timers.js

@@ -113,8 +113,8 @@ async function updateDndTimerPage() {
             const dndTime = {
                 start: convertTime(res.start.hour, res.start.minute, offset),
                 end: convertTime(res.end.hour, res.end.minute, offset)
-            }
-            
+            };
+
             dndTimerList.appendChild(ons.createElement(
                 "<ons-list-item>\n" +
                 "    <div class='left'>DND will start at " + dndTime.start.hour + ":" +
@@ -188,7 +188,7 @@ async function saveDndTimer() {
         const dndTime = {
             start: convertTime(parseInt(start_hour), parseInt(start_minute), offset),
             end: convertTime(parseInt(end_hour), parseInt(end_minute), offset)
-        }
+        };
 
         try {
             await ApiService.setDndConfiguration(

lib/NTPClient.js

@@ -11,7 +11,6 @@ class NTPClient {
      * @param {object} options
      * @param {import("./Configuration")} options.config
      */
-
     constructor(options) {
         this.config = options.config;
 

lib/Valetudo.js

@@ -8,6 +8,7 @@ const Tools = require("./Tools");
 const v8 = require("v8");
 const Webserver = require("./webserver/WebServer");
 
+const Scheduler = require("./scheduler/Scheduler");
 const ValetudoRobotFactory = require("./core/ValetudoRobotFactory");
 
 class Valetudo {
@@ -63,6 +64,12 @@ class Valetudo {
             robot: this.robot
         });
 
+        this.scheduler = new Scheduler({
+            config: this.config,
+            robot: this.robot,
+            ntpClient: this.ntpClient
+        });
+
 
         //This might get refactored if there are more of these options
         if (this.config.get("debug") && typeof this.config.get("debug").memoryStatInterval === "number") {
@@ -129,6 +136,7 @@ class Valetudo {
         }, 5000);
 
         // shuts down valetudo (reverse startup sequence):
+        await this.scheduler.shutdown();
         if (this.mqttClient) {
             await this.mqttClient.shutdown();
         }

lib/core/ValetudoRobot.js

@@ -31,6 +31,11 @@ class ValetudoRobot {
         }
     }
 
+    /**
+     * @public
+     * @param {string} capabilityType
+     * @returns {boolean}
+     */
     hasCapability(capabilityType) {
         return this.capabilities[capabilityType] !== undefined;
     }

lib/entities/core/ValetudoTimer.js

@@ -0,0 +1,49 @@
+const SerializableEntity = require("../SerializableEntity");
+const uuid = require("uuid");
+
+
+class ValetudoTimer extends SerializableEntity {
+    /**
+     *  Timers are always in UTC
+     * 
+     * @param {object} options
+     * @param {string} [options.id] uuidv4
+     * @param {boolean} options.enabled
+     * @param {Array<number>} options.dow Sunday = 0 because js
+     * @param {number} options.hour 0-23
+     * @param {number} options.minute 0-59
+     * @param {object} options.action
+     * @param {ValetudoTimerActionType} options.action.type
+     * @param {object} options.action.params
+     * @param {string} [options.action.params.zone_id]
+     * @param {Array<number>} [options.action.params.segment_ids]
+     * @param {number} [options.action.params.iterations]
+     * @param {boolean} [options.action.params.custom_order]
+     * @param {object} [options.metaData]
+     * @class
+     */
+    constructor(options) {
+        super(options);
+
+        this.id = options.id ?? uuid.v4();
+        this.enabled = options.enabled;
+        this.dow = options.dow;
+        this.hour = options.hour;
+        this.minute = options.minute;
+        this.action = options.action;
+    }
+}
+
+/**
+ *  @typedef {string} ValetudoTimerActionType
+ *  @enum {string}
+ *
+ */
+ValetudoTimer.ACTION_TYPE = Object.freeze({
+    FULL_CLEANUP: "full_cleanup",
+    ZONE_CLEANUP: "zone_cleanup",
+    SEGMENT_CLEANUP: "segment_cleanup"
+});
+
+
+module.exports = ValetudoTimer;

lib/entities/core/index.js

@@ -6,6 +6,7 @@ module.exports = {
     ValetudoRestrictedZone: require("./ValetudoRestrictedZone"),
     ValetudoSelectionPreset: require("./ValetudoSelectionPreset"),
     ValetudoSensor: require("./ValetudoSensor"),
+    ValetudoTimer: require("./ValetudoTimer"),
     ValetudoVirtualRestrictions: require("./ValetudoVirtualRestrictions"),
     ValetudoVirtualWall: require("./ValetudoVirtualWall"),
     ValetudoVoicePackOperationStatus: require("./ValetudoVoicePackOperationStatus"),

lib/entities/index.js

@@ -1,7 +1,6 @@
 module.exports = {
     SerializableEntity: require("./SerializableEntity"),
     core: require("./core"),
-    job: require("./job"),
     map: require("./map"),
     state: require("./state")
 };

lib/miio/MiioSocket.js

@@ -130,7 +130,7 @@ class MiioSocket {
                         clearTimeout(pending.timeout_id);
 
                         if (msg["error"]) {
-                            Logger.info("error response", msg);
+                            Logger.info("Miio error response", msg);
                             pending.reject(msg["error"]);
                         } else {
                             pending.resolve(msg["result"]);

lib/res/default_config.json

@@ -53,6 +53,7 @@
         "interval": 28800000,
         "timeout": 10000
     },
+    "timers": {},
     "allowSSHKeyUpload": true,
     "logLevel": "info",
     "debug": {