Merge remote-tracking branch 'Koell/jwalk' into app-loader

Author: thyttan

apps/hrmmar/README.md

@@ -2,6 +2,8 @@
 
 Measurements from the build in PPG-Sensor (Photoplethysmograph) is sensitive to motion and can be corrupted with Motion Artifacts (MA). This module allows to remove these.
 
+**WARNING:** On Bangle.js 2 this has been found to make heart rate readings [substantially less accurate in some cases](https://github.com/orgs/espruino/discussions/7738#discussioncomment-13594093) (the HRM already has built in motion artefact removal).
+
 ## Settings
 
 * **MA removal**

apps/hrmmar/metadata.json

@@ -4,7 +4,7 @@
   "shortName":"HRM MA removal",
   "icon": "app.png",
   "version":"0.02",
-  "description": "Removes Motion Artifacts in Bangle.js's heart rate sensor data.",
+  "description": "Removes Motion Artifacts in Bangle.js's heart rate sensor data. **WARNING:** On Bangle.js 2 this has been found to make heart rate readings substantially less accurate in some cases.",
   "type": "bootloader",
   "tags": "health",
   "supports": ["BANGLEJS","BANGLEJS2"],

apps/jwalk/app.js

@@ -2,37 +2,30 @@ const FILE = "jwalk.json";
 const DEFAULTS = {
   totalDuration: 30,
   intervalDuration: 3,
-  startMode: 0
+  startMode: 0,
+   modeBuzzerDuration: 1000,
+   finishBuzzerDuration: 1500,
 };
 
-const PAUSE_BEEP_DURATION = 1000;
-const SECOND_BEEP_DURATION = 500;
-const MESSAGE_DISPLAY_DURATION = 1500;
-const FONT_SIZE_TIME = 40;
-const FONT_SIZE_BACKGROUND = 2;
-const FONT_SIZE_PAUSE = 15;
-const CIRCLE_RADIUS = 5;
-const TRIANGLE_OFFSET = 6;
+let settings = require("Storage").readJSON(FILE, 1) || DEFAULTS;
 
-// Load settings
-var settings = require("Storage").readJSON(FILE, 1) || DEFAULTS;
-
-// App state
-var state = {
+let state = {
   remainingTotal: settings.totalDuration * 60,
   intervalDuration: settings.intervalDuration * 60,
   remainingInterval: 0,
   intervalEnd: 0,
   paused: false,
-  currentMode: settings.startMode === 1 ? "Intense" : "Relax"
+  currentMode: settings.startMode === 1 ? "Intense" : "Relax",
+  finished: false,
+  forceDraw: false,
 };
 
-var drawTimerInterval;
-var cachedLeftTime = "";
+let drawTimerInterval;
+let cachedLeftTime = "";
 
 function formatTime(seconds) {
-  var mins = Math.floor(seconds / 60);
-  var secs = (seconds % 60).toString().padStart(2, '0');
+  let mins = Math.floor(seconds / 60);
+  let secs = (seconds % 60).toString().padStart(2, '0');
   return `${mins}:${secs}`;
 }
 
@@ -41,97 +34,118 @@ function updateCachedLeftTime() {
 }
 
 function getTimeStr() {
-  var d = new Date();
+  let d = new Date();
   return `${d.getHours().toString().padStart(2, '0')}:${d.getMinutes().toString().padStart(2, '0')}`;
 }
 
-
 function drawUI() {
-  var y = Bangle.appRect.y + 8;
+  let y = Bangle.appRect.y + 8;
   g.reset().setBgColor(g.theme.bg).clearRect(Bangle.appRect);
 
-  // Background
-  g.setColor(g.theme.bg);
-  g.fillRect(0, y + 25, g.getWidth(), g.getHeight());
-
   g.setColor(g.theme.fg);
 
-  var displayInterval = state.paused
+  let displayInterval = state.paused
     ? state.remainingInterval
     : Math.max(0, Math.floor((state.intervalEnd - Date.now()) / 1000));
 
-  g.setFont("Vector", FONT_SIZE_TIME);
+  g.setFont("Vector", 40);
   g.setFontAlign(0, 0);
   g.drawString(formatTime(displayInterval), g.getWidth() / 2, y + 70);
 
-  var cy = y + 100;
+  let cy = y + 100;
   if (state.paused) {
-    g.setFont("Vector", FONT_SIZE_PAUSE);
+    g.setFont("Vector", 15);
     g.drawString("PAUSED", g.getWidth() / 2, cy);
   } else {
-    var cx = g.getWidth() / 2;
-    // Use accent color for mode indicators for nice contrast
+    let cx = g.getWidth() / 2;
     g.setColor(g.theme.accent || g.theme.fg2 || g.theme.fg);
-
     if (state.currentMode === "Relax") {
-      g.fillCircle(cx, cy, CIRCLE_RADIUS);
+      g.fillCircle(cx, cy, 5);
     } else {
       g.fillPoly([
-        cx, cy - TRIANGLE_OFFSET,
-        cx - TRIANGLE_OFFSET, cy + TRIANGLE_OFFSET,
-        cx + TRIANGLE_OFFSET, cy + TRIANGLE_OFFSET
+        cx, cy - 6,
+        cx - 6, cy + 6,
+        cx + 6, cy + 6
       ]);
     }
-
-    // Reset to normal fg for text below
     g.setColor(g.theme.fg);
   }
 
-  g.setFont("6x8", FONT_SIZE_BACKGROUND);
+  g.setFont("6x8", 2);
   g.setFontAlign(0, -1);
   g.drawString(state.currentMode, g.getWidth() / 2, y + 15);
-  
   g.drawString(cachedLeftTime, g.getWidth() / 2, cy + 15);
-  
+
   g.setFontAlign(1, 0);
   g.drawString(getTimeStr(), g.getWidth() - 4, y);
-
- 
-
   g.flip();
 }
 
 function toggleMode() {
   state.currentMode = state.currentMode === "Relax" ? "Intense" : "Relax";
-  Bangle.buzz();
+  Bangle.buzz(settings.modeBuzzerDuration);
+  state.forceDraw = true;
+}
+
+function finishWorkout() {
+  clearInterval(drawTimerInterval);
+  Bangle.buzz(settings.finishBuzzerDuration);
+  state.finished = true;
+
+  setTimeout(() => {
+    g.clear();
+    g.setFont("Vector", 30);
+    g.setFontAlign(0, 0);
+    g.drawString("Well done!", g.getWidth() / 2, g.getHeight() / 2);
+    g.flip();
+
+    const exitHandler = () => {
+      Bangle.removeListener("touch", exitHandler);
+      Bangle.removeListener("btn1", exitHandler);
+      load(); // Exit app
+    };
+
+    Bangle.on("touch", exitHandler);
+    setWatch(exitHandler, BTN1, { repeat: false });
+  }, 500);
 }
 
+
 function startNextInterval() {
   if (state.remainingTotal <= 0) {
-    clearInterval(drawTimerInterval);
-    Bangle.buzz(PAUSE_BEEP_DURATION);
-    setTimeout(() => Bangle.buzz(SECOND_BEEP_DURATION), MESSAGE_DISPLAY_DURATION);
-    E.showMessage("Done!");
+    finishWorkout();
     return;
   }
 
   state.remainingInterval = Math.min(state.intervalDuration, state.remainingTotal);
   state.remainingTotal -= state.remainingInterval;
   updateCachedLeftTime();
   state.intervalEnd = Date.now() + state.remainingInterval * 1000;
+
+  state.forceDraw = true;
 }
 
 function tick() {
+  if (state.finished) return;
+
   if (!state.paused) {
     if ((state.intervalEnd - Date.now()) / 1000 <= 0) {
       toggleMode();
       startNextInterval();
+      return;
     }
   }
-  drawUI();
+
+  if (!Bangle.isLocked() || state.forceDraw) {
+    drawUI();
+    state.forceDraw = false;
+  }
 }
 
+
 function togglePause() {
+  if (state.finished) return;
+
   if (!state.paused) {
     state.remainingInterval = Math.max(0, Math.floor((state.intervalEnd - Date.now()) / 1000));
     state.paused = true;
@@ -142,12 +156,12 @@ function togglePause() {
   drawUI();
 }
 
-// Button / touch handlers
+// Setup
 Bangle.on("touch", togglePause);
-
 Bangle.loadWidgets();
 Bangle.drawWidgets();
 
+updateCachedLeftTime();
 startNextInterval();
 drawUI();
 drawTimerInterval = setInterval(tick, 1000);

apps/jwalk/settings.js

@@ -4,6 +4,8 @@
     totalDuration: 30,
     intervalDuration: 3,
     startMode: 0,
+    modeBuzzerDuration: 1000,
+    finishBuzzerDuration: 1500,
   };
 
   let settings = require("Storage").readJSON(FILE, 1) || DEFAULTS;
@@ -13,41 +15,36 @@
   }
 
   function showSettingsMenu() {
-    const menu = {
+    E.showMenu({
       '': { title: 'Japanese Walking' },
       '< Back': back,
       'Total Time (min)': {
         value: settings.totalDuration,
-        min: 10,
-        max: 60,
-        step: 1,
-        onchange: v => {
-          settings.totalDuration = v;
-          saveSettings();
-        }
+        min: 10, max: 60, step: 1,
+        onchange: v => { settings.totalDuration = v; saveSettings(); }
       },
       'Interval (min)': {
         value: settings.intervalDuration,
-        min: 1,
-        max: 10,
-        step: 1,
-        onchange: v => {
-          settings.intervalDuration = v;
-          saveSettings();
-        }
+        min: 1, max: 10, step: 1,
+        onchange: v => { settings.intervalDuration = v; saveSettings(); }
       },
       'Start Mode': {
         value: settings.startMode,
-        min: 0,
-        max: 1,
+        min: 0, max: 1,
         format: v => v ? "Intense" : "Relax",
-        onchange: v => {
-          settings.startMode = v;
-          saveSettings();
-        }
-      }
-    };
-    E.showMenu(menu);
+        onchange: v => { settings.startMode = v; saveSettings(); }
+      },
+      'Mode Buzz (ms)': {
+        value: settings.modeBuzzerDuration,
+        min: 0, max: 2000, step: 50,
+        onchange: v => { settings.modeBuzzerDuration = v; saveSettings(); }
+      },
+      'Finish Buzz (ms)': {
+        value: settings.finishBuzzerDuration,
+        min: 0, max: 5000, step: 100,
+        onchange: v => { settings.finishBuzzerDuration = v; saveSettings(); }
+      },
+    });
   }
 
   showSettingsMenu();

apps/setting/README.md

@@ -8,11 +8,20 @@ This is Bangle.js's main settings menu:
 * **Alerts** - Set how Bangle.js alerts you (including Quiet mode)
 * **Utils** - Utilities, including resetting settings
 
+**New Users:** these are some settings you'll probably want to change right away:
+
+* **Calibrate LCD** Make sure that the LCD touchscreen responds to touches where you expect them to
+* **Locale** Set whether you want 12 hour time, and what day of the week the week starts on.
+
 See below for options under each heading:
+  
+## Apps - App-specific settings
+
+This is where you adjust settings for an individual app. (eg. Health app: Adjust how often heart rate tracking should fire.)
 
 ## System - System settings
 
-* **Theme** Adjust the colour scheme
+* **Theme** Adjust the colour scheme. Choose between light mode, dark mode, or a custom theme. To adjust themes in more detail you can also use the [Theme Switcher App](https://banglejs.com/apps/?id=themesetter)
 * **LCD** Configure settings about the screen. How long it stays on, how bright it is, and when it turns on - see below.
 * **Locale** set time zone, the time format (12/24h, for supported clocks) and the first day of the week
 * **Clock** if you have more than one clock face, select the default one
@@ -44,9 +53,9 @@ See below for options under each heading:
 * **Rotation** allows you to rotate (or mirror) what's displayed on the screen, eg. for left-handed wearers (needs 2v16 or 2v15 cutting edge firmware to work reliably)
 * **Wake on X** should the given activity wake up the Bangle.js LCD?
   * On Bangle.js 2 when locked the touchscreen is turned off to save power. Because of this,
-    `Wake on Touch` actually uses the accelerometer, and you need to actually tap the display to wake Bangle.js (we recently renamed the menu item to `Wake on Tap`).
+    `Wake on Tap` actually uses the accelerometer, and you need to actually tap the display to wake Bangle.js.
 * **Twist X** these options adjust the sensitivity of `Wake on Twist` to ensure Bangle.js wakes up with just the right amount of wrist movement.
-* **Calibrate** on Bangle.js 2, pop up a screen allowing you to calibrate the touchscreen (calibration only works on 2v16 or 2v15 cutting edge builds)
+* **Calibrate** on Bangle.js 2, pop up a screen allowing you to calibrate the touchscreen, ensuring your touches are mapped to the right place on the screen. (Highly reccomended for new users!)
 
 ## Locale