Merge pull request espruino#4101 from RKBoss6/sleeplogqolfixes

[SleepLog] Make date title easier to follow at a glance, update documentation in README

Author: bobrippling

apps/sleeplog/ChangeLog

@@ -16,6 +16,7 @@
 0.18: Add back as a function to prevent translation making it a menu entry
 0.19: Write sleep state into health event's .activity field
 0.20: Increase default sleep thresholds, tweak settings to allow higher ones to be chosen
-0.21: Use HRM data is polling is enabled, and add appropriate thresholds in settings. Change settings to feel more intuitive, rather than copied settings in different pages.
+0.21: Use HRM data if polling is enabled, and add appropriate thresholds in settings. Change settings to feel more intuitive, rather than copied settings in different pages.
 0.22: Fix bug with HRM threshold not updating due to movement thresholds being incorrectly compared against the HRM thresholds.
 0.23: Fix important bug with HRM data being undefined when compared - broken apps should work properly now
+0.24: Change day title to be easier to read, capitalization, and improved documentation/tuning guide in README.

apps/sleeplog/README.md

@@ -32,7 +32,7 @@ Logfiles are not removed on un-/reinstall to prevent data loss.
 #### Controls:
   - __swipe left & right__
     to change the displayed day
-  - __touch the "title"__ (e.g. `Night to Fri 20/05/2022`)
+  - __touch the "title"__ (e.g. `Thu to Fri 20/05/2022`)
     to enter day selection prompt
   - __touch the info area__
     to change the displayed information
@@ -56,14 +56,22 @@ Logfiles are not removed on un-/reinstall to prevent data loss.
 ---
 ### Settings Usage
 ---
-
+#### Tuning guide
+To make sure the app accurately provides sleep information, it's a good idea to change the default thresholds to find one that works for you. A step-by-step process would be:
+- Set the thresholds (movement or hrm, depending on what you use) to be high.
+- Every day, look at the sleep it tracked and see if it's accurate or not.
+- If it doesn't detect much, reduce the thresholds.
+- If it detects more than it should, increase slightly until you find an accurate setting.
+#### Settings
+
+  
   - __HRM Thresholds__ submenu
 
     Changes take effect from now on, not retrospective! HRM works only if polling is enabled in `Health` settings
     - __Deep Sleep__ | deep sleep threshold
-      _30_ / _31_ / ... / __100__ / ... / _200_
+      _40_ / _41_ / ... / __60__ / ... / _80_
     - __Light Sleep__ | light sleep threshold
-      _100_ / _110_ / ... / __200__ / ... / _400_
+      _50_ / _51_ / ... / __74__ / ... / _90_
      - __Reset to Default__ | reset to bold values above
  - __Movement Thresholds__ submenu
 

apps/sleeplog/app.js

@@ -153,16 +153,16 @@ function drawingCycle(calcDate, thisID, cycle, log) {
     infoData = slMod.getStats(calcDate, 0, log);
     infoData = [
       [
-        [ /*LANG*/"consecutive\nsleeping", infoData.consecSleep],
-        [ /*LANG*/"true\nsleeping", infoData.deepSleep + infoData.lightSleep]
+        [ /*LANG*/"Consec.\nsleep", infoData.consecSleep],
+        [ /*LANG*/"True\nsleep", infoData.deepSleep + infoData.lightSleep]
       ],
       [
-        [ /*LANG*/"deep\nsleep", infoData.deepSleep],
-        [ /*LANG*/"light\nsleep", infoData.lightSleep]
+        [ /*LANG*/"Deep\nsleep", infoData.deepSleep],
+        [ /*LANG*/"Light\nsleep", infoData.lightSleep]
       ],
       [
-        [ /*LANG*/"awake", infoData.awakeTime],
-        [ /*LANG*/"not worn", infoData.notWornTime]
+        [ /*LANG*/"Awake", infoData.awakeTime],
+        [ /*LANG*/"Not worn", infoData.notWornTime]
       ]
     ];
     // draw info
@@ -235,10 +235,11 @@ function draw() {
 
   // set date to calculate data for
   var calcDate = new Date(startDate - prevDays * 864E5);
-
+  var oneDayAgo = new Date(startDate - prevDays * 864E5);
+  oneDayAgo.setDate(oneDayAgo.getDate() - 1);
   // draw title
   g.setFont("12x20").setFontAlign(0, -1)
-    .drawString( /*LANG*/"Night to " + require('locale').dow(calcDate, 1) + "\n" +
+    .drawString(require('locale').dow(oneDayAgo, 1)+" to " + require('locale').dow(calcDate, 1) + "\n" +
       require('locale').date(calcDate, 1), 87, 28);
 
   // reset graphics and define image string
@@ -262,7 +263,7 @@ function draw() {
   // show loading info with progresss bar
   g.reset().drawRect(7, 117, width - 8, 157)
     .setFont("6x8").setFontAlign(0, 0)
-    .drawString( /*LANG*/ "calculating data ...\nplease be patient :)", 87, 133)
+    .drawString( /*LANG*/ "Calculating...\nPlease be patient :)", 87, 133)
     .drawRect(17, 145, 157, 151);
 
   // draw first progress

apps/sleeplog/metadata.json

@@ -2,8 +2,8 @@
   "id":"sleeplog",
   "name":"Sleep Log",
   "shortName": "SleepLog",
-  "version": "0.23",
-  "description": "Log and view your sleeping habits. This app uses built in movement calculations, or HRM data, if enabled. View data from Bangle.js, or from the web app.",
+  "version": "0.24",
+  "description": "Log and view your sleeping habits. This app uses built in movement calculations or HRM data, if enabled. View data from Bangle.js, or from the web app.",
   "icon": "app.png",
   "type": "app",
   "tags": "tool,boot,health",