From 99663e4583ae34cacffe0e4d72d749f4e1c9741a Mon Sep 17 00:00:00 2001
From: storm64 <github@storm64.de>
Date: Thu, 10 Nov 2022 00:33:51 +0100
Subject: [PATCH] [sleeplog] onChange: + previous values and readme

---
 apps/sleeplog/README.md | 25 +++++++++++++++++++++++--
 apps/sleeplog/boot.js   | 10 ++++++++--
 2 files changed, 31 insertions(+), 4 deletions(-)

diff --git a/apps/sleeplog/README.md b/apps/sleeplog/README.md
index 45aeb316b..7f122add3 100644
--- a/apps/sleeplog/README.md
+++ b/apps/sleeplog/README.md
@@ -87,7 +87,7 @@ Available through the App Loader when your watch is connected.
   Deletes the logfile from the watch. __Please backup your data first!__
 
 ---
-### Timestamps and files
+### Timestamps and Files
 ---
 
 1. externally visible/usable timestamps (in `global.sleeplog`) are formatted as Bangle timestamps:  
@@ -110,8 +110,10 @@ Available through the App Loader when your watch is connected.
 
 
 ---
-### Access statistics (developer information)
+### Developer Information
 ---
+
+#### Access statistics
 - Last Asleep Time [Date]:  
   `Date(sleeplog.awakeSince)`
 - Last Awake Duration [ms]:  
@@ -149,6 +151,25 @@ 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.
+```
+// first ensure that the sleeplog object is available
+if (typeof (global.sleeplog || {}).onChange === "object") {
+  // then add your function to the onChange-array
+  sleeplog.onChange.push( function(data) { print(data); } );
+}
+```
+The passed data object has the following properties:
+- timestamp: of the status change as date object,
+    (should be around 10min. before "now", the actual call of the function)
+- status: if changed the value of the new status (0-4) else undefined,
+    (0 = unknown, 1 = not worn, 2 = awake, 3 = light sleep, 4 = deep sleep)
+- consecutive: if changed the value of the new status (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)
+
 
 ---
 ### Worth Mentioning
diff --git a/apps/sleeplog/boot.js b/apps/sleeplog/boot.js
index f4d9dff46..3d4685ea4 100644
--- a/apps/sleeplog/boot.js
+++ b/apps/sleeplog/boot.js
@@ -265,7 +265,9 @@ if (sleeplog.conf.enabled) {
             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
+              consecutive: data.consecutive === this.consecutive ? undefined : data.consecutive,
+              prevStatus: this.status,
+              prevConsecutive: this.consecutive
             });
           });
         }
@@ -337,7 +339,11 @@ if (sleeplog.conf.enabled) {
     //  changed values will be passed as object with the following properties:
     //    timestamp: as date object,
     //    status: if changed 0-4 else undefined,
-    //    consecutive: if changed 0-2 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: []
   }, sleeplog);