Merge pull request #4231 from thyttan/twenties

Twenties: refactor to use the scheduling library instead of its own timeouts

Author: thyttan

apps/twenties/ChangeLog

@@ -5,3 +5,4 @@
 0.05: Improve energy efficiency
 0.06: Align with whole thirds of the hour.
 0.07: Fix TypeError on scheduling for the next day.
+0.08: Refactor to use the scheduling library.

apps/twenties/README.md

@@ -12,6 +12,14 @@ Vibrates to remind you to stand up and look away for healthy living.
 
 Only vibrates during work days and hours.
 
-## Creator
+## Todo
 
-[@splch](https://github.com/splch/)
+Add settings page.
+Add setting for active days and hours.
+Add setting for buzz strength/pattern.
+Add entry in settings to re-run setup.
+
+## Contributors
+
+[@splch](https://github.com/splch/) (Creator)
+[@thyttan](https://github.com/thyttan/)

apps/twenties/boot.js

@@ -1,31 +1,6 @@
-(() => {
-  const LOOP_INTERVAL = 1.2e6; // 20 minutes
-  const BUZZ_INTERVAL = 2e4; // 20 seconds
-
-  const isWorkTime = (d) =>
-    d.getDay() % 6 && d.getHours() >= 8 && d.getHours() < 18;
-
-  const scheduleNext = () => {
-    const now = new Date();
-    if (isWorkTime(now)) {
-      Bangle.buzz().then(() => setTimeout(Bangle.buzz, BUZZ_INTERVAL));
-      setTimeout(scheduleNext, LOOP_INTERVAL);
-    } else {
-      const next = new Date(now+864e5); // 24 hours
-      next.setHours(8, 0, 0, 0);
-      while (!isWorkTime(next)) next.setDate(next.getDate() + 1);
-      setTimeout(scheduleNext, next - now);
-    }
-  };
-
-  // Align so we fire at whole hour, 20 min past and 40 min past - not at arbitrary times.
-  const TIME_AT_BOOT = new Date();
-  const TIME_SINCE_WHOLE_THIRD_OF_HOUR = (TIME_AT_BOOT.getMinutes() % 20) * 6e4 + TIME_AT_BOOT.getSeconds() * 1e3;
-  setTimeout(scheduleNext,
-    LOOP_INTERVAL - TIME_SINCE_WHOLE_THIRD_OF_HOUR);
-  // Make sure we don't miss the 2nd buzz after 20 seconds if we rebooted during that interval.
-  if (TIME_SINCE_WHOLE_THIRD_OF_HOUR <= BUZZ_INTERVAL) {
-    setTimeout(Bangle.buzz, 
-      BUZZ_INTERVAL - TIME_SINCE_WHOLE_THIRD_OF_HOUR);
-  }
-})();
+{ // This boot script is deleted once the companion alarm is set up.
+  // The app will continue working by having the alarm rearm itself until
+  // the app is uninstalled.
+  require("twenties").setup();
+  setTimeout(require("Storage").erase, 1000, "twenties.boot.js");
+}

apps/twenties/lib.js

@@ -0,0 +1,50 @@
+{
+  // TODO:
+  // - Add settings page.
+  // - Add setting for active days and hours.
+  // - Add setting for buzz strength/pattern.
+  // - Add entry in settings to re-run setup.
+
+  const getTimeAtNextBuzz = () => {
+    const isWorkTime = (d) =>
+      d.getDay() % 6 && d.getHours() >= 8 && d.getHours() < 18;
+    const isLookAwayTime = (d) =>
+      d.getMinutes() % 20 === 0 && d.getSeconds() < 20;
+    const NOW = new Date();
+    let t = 8 * 3600000;
+    if (isWorkTime(NOW)) {
+      if (isLookAwayTime(NOW)) {
+        t = NOW.getHours() * 3600000 +
+          NOW.getMinutes() * 60000 + 20 * 1000;
+      } else {
+        t = NOW.getHours() * 3600000 +
+          (NOW.getMinutes() + (20 - NOW.getMinutes() % 20)) * 60000;
+      }
+    }
+    return t;
+  };
+
+  exports.buzzAndSetup = function () {
+    Bangle.buzz();
+    exports.setup();
+  };
+
+  const JS_DELETE_ALARM_THEN_BUZZ_AND_SETUP = `require("sched").setAlarm("twenties", undefined); require('twenties').buzzAndSetup();`;
+
+  const S = require("sched");
+
+  exports.setup = function () {
+    const TIME_AT_NEXT_BUZZ = getTimeAtNextBuzz();
+    let alarm = {
+      on: true,
+      t: TIME_AT_NEXT_BUZZ,
+      dow: 0b0111110,
+      hidden: true,
+      msg: "Twenties",
+      group: "Twenties",
+      js: JS_DELETE_ALARM_THEN_BUZZ_AND_SETUP
+    };
+    S.setAlarm("twenties", alarm);
+    S.reload();
+  };
+}

apps/twenties/metadata.json

@@ -2,7 +2,7 @@
   "id": "twenties",
   "name": "Twenties",
   "shortName": "Twenties",
-  "version": "0.07",
+  "version": "0.08",
   "description": "Buzzes every 20m to stand / sit and look 20ft away for 20s.",
   "icon": "app.png",
   "type": "bootloader",
@@ -11,5 +11,8 @@
   "supports": ["BANGLEJS", "BANGLEJS2"],
   "allow_emulator": true,
   "readme": "README.md",
-  "storage": [{ "name": "twenties.boot.js", "url": "boot.js" }]
+  "storage": [
+    { "name": "twenties.boot.js", "url": "boot.js" },
+    { "name": "twenties", "url": "lib.js" }
+  ]
 }