Merge pull request #4052 from EmVee381/feat/pomoplus

pomoplus: feat: add advanced configurable notification with buzz patterns and r…

Author: thyttan

apps/pomoplus/ChangeLog

@@ -5,3 +5,6 @@
 0.07: Make fonts and buttons larger for legibility and ease of use. Hide
 	buttons when screen is locked. Toggle the graphical presentation when
 	pressing the (middle) hardware button.
+0.08: Configurable buzz patterns for short, long, and work notifications; the
+number of pattern repetitions and the delay are shared for all three types.
+(emvee381)	

apps/pomoplus/README.md

@@ -39,4 +39,4 @@ bruceblore
 
 ## Contributors
 
-notEvil, thyttan
+notEvil, thyttan, emvee381

apps/pomoplus/common.js

@@ -23,7 +23,12 @@ if (!exports.settings) {
         longBreak: 900000,                  //15 minute long break
         numShortBreaks: 3,                  //3 short breaks for every long break
         pausedTimerExpireTime: 21600000,    //If the timer was left paused for >6 hours, reset it on next launch
-        widget: false                       //If a widget is added in the future, whether the user wants it
+        widget: false,                       //If a widget is added in the future, whether the user wants it
+        notifyShortPattern: "=",            // pattern for short break notification
+        notifyLongPattern: "=",             // pattern for long break notification
+        notifyWorkPattern: "==",            // pattern for work session notification
+        notifyReps: 2,                      // number of pattern repetitions
+        notifyRepsDelay: 50,                // delay between repetitions (in ms)
     };
 }
 
@@ -80,13 +85,6 @@ exports.getNextPhase = function () {
 
 //Change to the next phase and update numShortBreaks, and optionally vibrate. DOES NOT WRITE STATE CHANGE TO STORAGE!
 exports.nextPhase = function (vibrate) {
-    a = {
-        startTime: 0,                   //When the timer was last started. Difference between this and now is how long timer has run continuously.
-        pausedTime: 0,                  //When the timer was last paused. Used for expiration and displaying timer while paused.
-        elapsedTime: 0,                 //How much time the timer had spent running before the current start time. Update on pause or user skipping stages.
-        phase: exports.PHASE_WORKING,   //What phase the timer is currently in
-        numShortBreaks: 0               //Number of short breaks that have occured so far
-    }
     let now = (new Date()).getTime();
     exports.state.startTime = now;  //The timer is being reset, so say it starts now.
     exports.state.pausedTime = now; //This prevents a paused timer from having the start time moved to the future and therefore having been run for negative time.
@@ -105,13 +103,30 @@ exports.nextPhase = function (vibrate) {
 
     if (vibrate) {
         if (exports.state.phase == exports.PHASE_WORKING) {
-            Bangle.buzz(800, 1);
+            exports.doNotify(exports.settings.notifyWorkPattern, exports.settings.notifyReps,exports.settings.notifyRepsDelay);  
+
         } else if (exports.state.phase == exports.PHASE_SHORT_BREAK) {
-            Bangle.buzz();
-            setTimeout(Bangle.buzz, 400);
+            exports.doNotify(exports.settings.notifyShortPattern, exports.settings.notifyReps,exports.settings.notifyRepsDelay);  
+      
         } else {
-            Bangle.buzz();
-            setTimeout(Bangle.buzz, 400, 400);
+            exports.doNotify(exports.settings.notifyLongPattern, exports.settings.notifyReps,exports.settings.notifyRepsDelay);  
         }
     }
 }
+
+exports.doNotify = function(pattern, repetitions, repeatDelay) {
+    const buzz = require("buzz");
+
+    let i = 0;
+
+    function doBuzz() {
+      buzz.pattern(pattern).then(() => {
+        i++;
+        if (i < repetitions) {
+          setTimeout(doBuzz, repeatDelay);
+        }
+      });
+    }
+
+    doBuzz();
+}

apps/pomoplus/metadata.json

@@ -1,7 +1,7 @@
 {
   "id": "pomoplus",
   "name": "Pomodoro Plus",
-  "version": "0.07",
+  "version": "0.08",
   "description": "A configurable pomodoro timer that runs in the background.",
   "icon": "icon.png",
   "type": "app",

apps/pomoplus/settings.js

@@ -12,6 +12,11 @@ const storage = require("Storage");
             pausedTimerExpireTime: 21600000,    //If the timer was left paused for >6 hours, reset it on next launch
             showClock: false,                   //Show clock after start/resume
             widget: false,                      //If a widget is added in the future, whether the user wants it
+            notifyShortPattern: "=",            // pattern for short break notification
+            notifyLongPattern: "=",             // pattern for long break notification
+            notifyWorkPattern: "==",            // pattern for work session notification
+            notifyReps: 2,                      // number of pattern repetitions
+            notifyRepsDelay: 50,                // delay between repetitions (in ms)
         };
     }
 
@@ -75,6 +80,46 @@ const storage = require("Storage");
                 return '' + (value / 60000) + 'm'
             }
         },
+        'Notify work': require("buzz_menu").pattern(settings.notifyWorkPattern, value =>{
+settings.notifyWorkPattern = value;
+save();
+require("buzz").pattern(value);
+
+        }),
+        'Notify short': require("buzz_menu").pattern(settings.notifyShortPattern, value =>{
+settings.notifyShortPattern = value;
+save();
+require("buzz").pattern(value);
+
+        }),
+        'Notify long': require("buzz_menu").pattern(settings.notifyLongPattern, value =>{
+settings.notifyLongPattern = value;
+save();
+        }),
+        'Notify reps': {
+            value: settings.notifyReps,
+            step: 1,
+            min: 1,
+            max: 50,
+            onchange: function (value) {
+                settings.notifyReps = value;
+                save();
+                require("pomoplus-com.js").doNotify(settings.notifyLongPattern, settings.notifyReps,settings.notifyRepsDelay);  
+      
+            }
+        },
+        'Reps. delay': {
+            value: settings.notifyRepsDelay || 50,
+            step: 50,
+            min: 0,
+            max: 5000,
+            wrap: true,
+            onchange: function (value) {
+                settings.notifyRepsDelay = value;
+                save();
+                require("pomoplus-com.js").doNotify(settings.notifyLongPattern, settings.notifyReps,settings.notifyRepsDelay);  
+            }
+        },
         'Timer expiration': {
             value: settings.pausedTimerExpireTime,
             step: 900000,   //15 minutes