Merge branch 'mc/ticks-until'

* mc/ticks-until:
  README: document tick() return value
  src:timer: return ticks until next event

Author: contrem

README.md

@@ -78,8 +78,8 @@ Timer<10, micros> timer; // timer with 10 task slots and microsecond resolution
 bool handler(void *argument);
 
 /* Timer Methods */
-/* Ticks the timer forward - call this function in loop() */
-void tick();
+/* Ticks the timer forward, returns the ticks until next event, or 0 if none */
+unsigned int tick(); // call this function in loop()
 
 /* Calls handler with opaque as argument in delay units of time */
 Timer<>::Task

src/timer.h

@@ -96,9 +96,11 @@ class Timer {
     }
 
     /* Ticks the timer forward - call this function in loop() */
-    void
+    unsigned long
     tick()
     {
+        unsigned long ticks = (unsigned long)-1;
+
         for (size_t i = 0; i < max_tasks; ++i) {
             struct task * const task = &tasks[i];
 
@@ -111,9 +113,14 @@ class Timer {
 
                     if (task->repeat) task->start = t;
                     else remove(task);
+                } else {
+                    const unsigned long remaining = task->expires - duration;
+                    ticks = remaining < ticks ? remaining : ticks;
                 }
             }
         }
+
+        return ticks == (unsigned long)-1 ? 0 : ticks;
     }
 
     /* DEPRECATED */