From 9105c94e1b8f002bd9b6cff08ff9db3f9239a598 Mon Sep 17 00:00:00 2001
From: storm64 <github@storm64.de>
Date: Wed, 16 Nov 2022 22:46:49 +0100
Subject: [PATCH] [sleeplog] Replace onChange with trigger object

---
 apps/sleeplog/README.md | 18 ++++++++-----
 apps/sleeplog/boot.js   | 58 ++++++++++++++++++++++-------------------
 2 files changed, 43 insertions(+), 33 deletions(-)

diff --git a/apps/sleeplog/README.md b/apps/sleeplog/README.md
index 00c07ef4a..9e32ad37f 100644
--- a/apps/sleeplog/README.md
+++ b/apps/sleeplog/README.md
@@ -151,13 +151,19 @@ Available through the App Loader when your watch is connected.
   require("sleeplog").getStats(0, 0, require("sleeplog").readLog());
   ```
 
-#### Add functions triggered by status changes
-With the following code it is possible to add functions that will be called on status changes.
+#### Add functions triggered by status changes or inside a specified time period
+With the following code it is possible to add functions that will be called every 10 minutes after new movement data when meeting the specified parameters on each :
 ```
-// first ensure that the sleeplog onChange object is available
-if (typeof (global.sleeplog || {}).onChange === "object") {
-  // then add your function to the onChange object
-  sleeplog.onChange["my app name"] = function(data) { print(data); };
+// first ensure that the sleeplog trigger object is available (sleeplog is enabled)
+if (typeof (global.sleeplog || {}).trigger === "object") {
+  // then add your parameters with the function to call as object into the trigger object
+  sleeplog.trigger["my app name"] = {
+    onChange: false,   // false as default, if true call fn only on a status change
+    from: 0,           // 0 as default, in ms, first time fn will be called
+    to: 24*60*60*1000, // 24h as default, in ms, last time fn will be called
+      // reference time to from & to is rounded to full minutes
+    fn: function(data) { print(data); } // function to be executed
+  };
 }
 ```
 The passed data object has the following properties:
diff --git a/apps/sleeplog/boot.js b/apps/sleeplog/boot.js
index 6a9c7c6e6..d787b8dff 100644
--- a/apps/sleeplog/boot.js
+++ b/apps/sleeplog/boot.js
@@ -253,26 +253,38 @@ if (sleeplog.conf.enabled) {
         }
       }
 
+      // check if the status has changed
+      var changed = data.status !== this.status || data.consecutive !== this.consecutive;
+
+      // read and check trigger entries
+      var triggers = Object.keys(this.trigger) || [];
+      if (triggers.length) {
+        // calculate time from timestamp in ms on full minutes
+        var time = data.timestamp;
+        time = ((time.getHours() * 60) + time.getMinutes() * 60) * 1000;
+        // go through all triggers
+        triggers.forEach(key => {
+          // read entry to key
+          var entry = this.trigger[key];
+          // check if the event matches the entries requirements
+          if (typeof entry.fn === "function" && (changed || !entry.onChange) &&
+            (entry.from || 0) <= time && (entry.to || 24 * 60 * 60 * 1000) >= time)
+            // and call afterwards with status data
+            setTimeout(fn, 100, {
+              timestamp: new Date(data.timestamp),
+              status: data.status === this.status ? undefined : data.status,
+              consecutive: data.consecutive === this.consecutive ? undefined : data.consecutive,
+              prevStatus: this.status,
+              prevConsecutive: this.consecutive
+            });
+        });
+      }
+
       // cache change into a known consecutive state
       var changeIntoConsec = data.consecutive;
 
-      // check if the status has changed
-      if (data.status !== this.status || data.consecutive !== this.consecutive) {
-        // read and check for onChange functions
-        var onChange = Object.keys(this.onChange) || [];
-        if (onChange.length) onChange.forEach(key => {
-          // read function to key
-          var fn = this.onChange[key];
-          // setup timeouts to start onChange functions if fn is a function
-          if (typeof fn === "function") setTimeout(fn, 100, {
-            timestamp: new Date(data.timestamp),
-            status: data.status === this.status ? undefined : data.status,
-            consecutive: data.consecutive === this.consecutive ? undefined : data.consecutive,
-            prevStatus: this.status,
-            prevConsecutive: this.consecutive
-          });
-        });
-
+      // actions on a status change
+      if (changed) {
         // append status
         this.appendStatus(data.timestamp, data.status, data.consecutive);
 
@@ -336,16 +348,8 @@ if (sleeplog.conf.enabled) {
       return this.statsCache;
     },
 
-    // define object for functions to execute after a status change (changes had hapened 10min earlier)
-    //  changed values will be passed as object with the following properties:
-    //    timestamp: as date object,
-    //    status: if changed 0-4 else undefined,
-    //      (0 = unknown, 1 = not worn, 2 = awake, 3 = light sleep, 4 = deep sleep)
-    //    consecutive: if changed 0-2 else undefined,
-    //      (0 = unknown, 1 = no consecutive sleep, 2 = consecutive sleep)
-    //    prevStatus: value of the previous status 0-4,
-    //    prevConsecutive: value of the previous status 0-2
-    onChange: {}
+    // define trigger object
+    trigger: {}
   }, sleeplog);
 
   // initial starting