setWatch now reports lastTime - time of last state change espruino#238

gfwilliams · gfwilliams · commit 4ec13c9fa92b · 2014-02-14T12:45:40.000Z
diff --git a/ChangeLog b/ChangeLog
@@ -35,6 +35,7 @@
             Fix charCodeAt being signed (should be unsigned)
             When casting Strings to booleans, so s.length!=0
             Guess initial values for average SysTick time - means that getTime is more accurate for the first 1-2 seconds after startup
+            setWatch now reports lastTime - time of last state change #238
 
      1v50 : Fix broken Web IDE caused by change to printing JSON for console.log (part of #206)
             Fix bug when trying to stringify {5:5}
diff --git a/scripts/build_docs.py b/scripts/build_docs.py
@@ -37,6 +37,7 @@ def html(s): htmlFile.write(s+"\n");
 
 def htmlify(d):
   d = re.sub(r'```([^`]+)```', r'<code>\1</code>', d) # code tags
+  d = re.sub(r'`([^`]+)`', r'<code>\1</code>', d) # code tags
   d = re.sub(r'(http://[^ ]+)', r'<a href="\1">\1</a>', d) # links tags
   return d
 
diff --git a/src/jsinteractive.c b/src/jsinteractive.c
@@ -1322,7 +1322,7 @@ void jsiIdle() {
           bool pinIsHigh = (event.flags&EV_EXTI_IS_HIGH)!=0;
 
           JsVarInt debounce = jsvGetIntegerAndUnLock(jsvObjectGetChild(watchPtr, "debounce", 0));
-          if (debounce>0) {
+          if (debounce>0) { // Debouncing - use timeouts to ensure we only fire at the right time
             JsVar *timeout = jsvObjectGetChild(watchPtr, "timeout", 0);
             if (timeout) { // if we had a timeout, update the callback time
               JsVar *timerTime = jsvObjectGetChild(timeout, "time", JSV_INTEGER);
@@ -1334,6 +1334,7 @@ void jsiIdle() {
                 jsvObjectSetChild(timeout, "watch", watchPtr); // no unlock
                 jsvUnLock(jsvObjectSetChild(timeout, "time", jsvNewFromInteger(event.data.time+debounce)));
                 jsvUnLock(jsvObjectSetChild(timeout, "callback", jsvObjectGetChild(watchPtr, "callback", 0)));
+                jsvUnLock(jsvObjectSetChild(timeout, "lastTime", jsvObjectGetChild(watchPtr, "lastTime", 0)));
                 // Add to timer array
                 jsiTimerAdd(timeout);
                 // Add to our watch
@@ -1344,12 +1345,15 @@ void jsiIdle() {
             // store the current state here
             jsvUnLock(jsvObjectSetChild(watchPtr, "state", jsvNewFromBool(pinIsHigh)));
           } else { // Not debouncing - just execute normally
+            JsVar *timePtr = jsvNewFromFloat(jshGetMillisecondsFromTime(event.data.time)/1000);
             if (jsiShouldExecuteWatch(watchPtr, pinIsHigh)) { // edge triggering
               JsVar *watchCallback = jsvObjectGetChild(watchPtr, "callback", 0);
               bool watchRecurring = jsvGetBoolAndUnLock(jsvObjectGetChild(watchPtr,  "recur", 0));
               JsVar *data = jsvNewWithFlags(JSV_OBJECT);
               if (data) {
-                jsvUnLock(jsvObjectSetChild(data, "time", jsvNewFromFloat(jshGetMillisecondsFromTime(event.data.time)/1000)));
+                jsvUnLock(jsvObjectSetChild(data, "lastTime", jsvObjectGetChild(watchPtr, "lastTime", 0)));
+                // set both data.time, and watch.lastTime in one go
+                jsvObjectSetChild(data, "time", timePtr); // no unlock
                 jsvUnLock(jsvObjectSetChild(data, "state", jsvNewFromBool(pinIsHigh)));
               }
               jsiExecuteEventCallback(watchCallback, data, 0);
@@ -1360,6 +1364,7 @@ void jsiIdle() {
               }
               jsvUnLock(watchCallback);
             }
+            jsvUnLock(jsvObjectSetChild(watchPtr, "lastTime", timePtr));
           }
         }
 
@@ -1401,12 +1406,17 @@ void jsiIdle() {
       bool exec = true;
       JsVar *data = jsvNewWithFlags(JSV_OBJECT);
       if (data) {
-        jsvUnLock(jsvObjectSetChild(data, "time", jsvNewFromFloat(jshGetMillisecondsFromTime(jsvGetInteger(timerTime))/1000)));
+        JsVar *timePtr = jsvNewFromFloat(jshGetMillisecondsFromTime(jsvGetInteger(timerTime))/1000);
         // if it was a watch, set the last state up
         if (watchPtr) {
           bool state = jsvGetBoolAndUnLock(jsvObjectSetChild(data, "state", jsvObjectGetChild(watchPtr, "state", 0)));
           exec = jsiShouldExecuteWatch(watchPtr, state);
+          // set up the lastTime variable of data to what was in the watch
+          jsvObjectSetChild(data, "lastTime", jsvObjectGetChild(watchPtr, "lastTime", 0));
+          // set up the watches lastTime to this one
+          jsvObjectSetChild(watchPtr, "lastTime", timePtr); // don't unlock
         }
+        jsvUnLock(jsvObjectSetChild(data, "time", timePtr));
       }
       if (exec) jsiExecuteEventCallback(timerCallback, data, 0);
       jsvUnLock(data);
diff --git a/src/jswrap_io.c b/src/jswrap_io.c
@@ -247,8 +247,10 @@ JsVar *jswrap_interface_setTimeout(JsVar *func, JsVarFloat timeout) {
 
 /*JSON{ "type":"function", "name" : "setWatch",
          "description" : ["Call the function specified when the pin changes",
-                          "The function may also take an argument, which is an object containing a field called 'time', which is the time in seconds at which the pin changed state, and 'state', which is the current state of the pin",
-                          " This can also be removed using clearWatch" ],
+                          "The function may also take an argument, which is an object of type `{time:float, lastTime:float, state:bool}`.",
+                          "`time` is the time in seconds at which the pin changed state, `lastTime` is the time in seconds at which the pin last changed state, and `state` is the current state of the pin.",
+                          "For instance, if you want to measure the length of a positive pusle you could use: ```setWatch(function(e) { console.log(e.time-e.lastTime); }, BTN, { repeat:true, edge:'falling' });```",
+                          "This can also be removed using clearWatch" ],
          "generate" : "jswrap_interface_setWatch",
          "params" : [ [ "function", "JsVarName", "A Function or String to be executed"],
                       [ "pin", "pin", "The pin to watch" ],
