Use a timer instead of a loop counter

As loop counters are not a reliable substitute for timers, because they are
unreliable, use proper timers instead.

Fixes #3.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>

README.md

@@ -86,13 +86,13 @@ The plugin provides the `Leader` object, with the following methods:
 
 ### `.timeOut`
 
-> The number of loop iterations to wait before a sequence times out. Once the
+> The number of milliseconds to wait before a sequence times out. Once the
 > sequence timed out, if there is a partial match with an action, that will be
 > performed, otherwise the Leader sequence will simply reset.
 >
 > Not strictly a method, it is a variable one can assign a new value to.
 >
-> Defaults to 20.
+> Defaults to 1000.
 
 ## Further reading
 

src/Akela/Leader.cpp

@@ -24,8 +24,8 @@ namespace Akela {
   // --- state ---
   Key Leader::sequence[LEADER_MAX_SEQUENCE_LENGTH + 1];
   uint8_t Leader::sequencePos;
-  uint8_t Leader::timer;
-  uint8_t Leader::timeOut = 20;
+  uint32_t Leader::startTime;
+  uint16_t Leader::timeOut = 1000;
   const Leader::dictionary_t *Leader::dictionary;
 
   // --- helpers ---
@@ -89,7 +89,7 @@ namespace Akela {
 
   void
   Leader::reset (void) {
-    timer = 0;
+    startTime = 0;
     sequencePos = 0;
     sequence[0].raw = Key_NoKey.raw;
   }
@@ -119,6 +119,7 @@ namespace Akela {
 
       if (key_toggled_off (keyState)) {
         // not active, but a leader key = start the sequence on key release!
+        startTime = millis ();
         sequencePos = 0;
         sequence[sequencePos].raw = mappedKey.raw;
       }
@@ -137,7 +138,7 @@ namespace Akela {
         return mappedKey;
       }
 
-      timer = 0;
+      startTime = millis ();
       sequence[sequencePos].raw = mappedKey.raw;
       actionIndex = lookup ();
 
@@ -169,10 +170,7 @@ namespace Akela {
     if (!isActive ())
       return;
 
-    if (timer < timeOut)
-     timer++;
-
-    if (timer >= timeOut)
+    if ((millis () - startTime) >= timeOut)
       reset ();
   }
 };

src/Akela/Leader.h

@@ -42,14 +42,14 @@ namespace Akela {
 
     static void configure (const dictionary_t dictionary[]);
     static void reset (void);
-    static uint8_t timeOut;
+    static uint16_t timeOut;
 
     void inject (Key key, uint8_t keyState);
 
   private:
     static Key sequence[LEADER_MAX_SEQUENCE_LENGTH + 1];
     static uint8_t sequencePos;
-    static uint8_t timer;
+    static uint32_t startTime;
     static const Leader::dictionary_t *dictionary;
 
     static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState);