Timers now have unique IDs (#1444)

Added `require("timer")` to access timers, removed `E.dumpTimers` and `Pin.writeAtTime` (fix #2586)
Added ability to execute JS from an a timer with `require("timer").add({type:"EXEC",...)`

Author: gfwilliams

ChangeLog

@@ -2,6 +2,9 @@
             Bangle.js: Updated built-in Layout.js with some minor fixes
             STM32: Ensure setDeepSleep(1) will only sleep if there are no active PWM outputs
             Pin.getInfo().negated now set if pin negated in firmware
+            Timers now have unique IDs (#1444)
+            Added `require("timer")` to access timers, removed `E.dumpTimers` and `Pin.writeAtTime` (fix #2586)
+            Added ability to execute JS from an a timer with `require("timer").add({type:"EXEC",...)`
             Bangle.js: Add Bangle.setOptions({stepCounterDisabled:bool}) to disable the step counter
             Date: fix parsing of ISO8601 timezones (+HHMM worked, but +HH:MM and +HH added) (fix #2669)
 

Makefile

@@ -270,6 +270,7 @@ src/jswrap_json.c \
 src/jswrap_number.c \
 src/jswrap_object.c \
 src/jswrap_regexp.c \
+src/jswrap_timer.c \
 src/jswrap_string.c \
 src/jswrap_modules.c \
 src/jswrap_math.c

boards/BANGLEJS.blocklist

@@ -1,9 +1,8 @@
 [
   {"class":"OneWire","name":"*"},
   {"class":"SPI","name":"send4bit"},
-  {"class":"E","name":"dumpTimers"},
   {"class":"E","name":"enableWatchdog"},
   {"class":"E","name":"getClock"},
   {"class":"E","name":"setBootCode"},
-  {"class":"Pin","name":"writeAtTime"}
+  {"class":"timer","name":"*"}
 ]

src/jsdevices.c

@@ -470,6 +470,11 @@ bool CALLED_FROM_INTERRUPT jshPushEvent(IOEventFlags evt, uint8_t *data, unsigne
   return true;
 }
 
+/// Push a Custom IO event into the ioBuffer (designed to be called from IRQ), returns true on success, Calls jshHadEvent();
+bool CALLED_FROM_INTERRUPT jshPushCustomEvent(IOCustomEventFlags customFlags) {
+  jshPushEvent(EV_CUSTOM, (uint8_t*)&customFlags, sizeof(customFlags));
+}
+
 /// Try and handle events in the IRQ itself. true if handled and shouldn't go in queue
 static bool jshPushIOCharEventsHandler(IOEventFlags channel, char *data, unsigned int count) {
   // Check for a CTRL+C

src/jsdevices.h

@@ -87,7 +87,8 @@ typedef enum {
 #ifdef BLUETOOTH
   EV_BLUETOOTH_PENDING,      // Tasks that came from the Bluetooth Stack in an IRQ
 #endif
-  EV_CUSTOM, ///< Custom event (See IOCustomEventFlags)
+  EV_RUN_INTERRUPT_JS,   ///< Run some JavaScript code. See EXEC_RUN_INTERRUPT_JS. data is JsVarRef of code to run
+  EV_CUSTOM, ///< Custom event (First byte is IOCustomEventFlags to determine the event type)
 #ifdef BANGLEJS
   EV_BANGLEJS,               // sent whenever Bangle.js-specific data needs to be queued
 #endif
@@ -131,10 +132,13 @@ typedef enum {
 /** Event types for EV_CUSTOM */
 typedef enum {
   EVC_NONE,
+  EVC_TIMER_FINISHED,
+  EVC_TIMER_BUFFER_FLIP,
 #ifdef NRF52_SERIES
   EVC_LPCOMP, // jswrap_espruino: E.setComparator / E.on("comparator" event
 #endif
   EVC_TYPE_MASK = 255,
+  EVC_DATA_SHIFT = 8,
   EVC_DATA_LPCOMP_UP = 256
 } PACKED_FLAGS IOCustomEventFlags;
 
@@ -185,6 +189,8 @@ typedef enum {
 
 /// Push an IO event (max IOEVENT_MAX_LEN) into the ioBuffer (designed to be called from IRQ), returns true on success, Calls jshHadEvent();
 bool CALLED_FROM_INTERRUPT jshPushEvent(IOEventFlags evt, uint8_t *data, unsigned int length);
+/// Push a Custom IO event into the ioBuffer (designed to be called from IRQ), returns true on success, Calls jshHadEvent();
+bool CALLED_FROM_INTERRUPT jshPushCustomEvent(IOCustomEventFlags customFlags);
 /// Add this IO event to the IO event queue. Calls jshHadEvent();
 void jshPushIOEvent(IOEventFlags channel, JsSysTime time);
 /// Signal an IO watch event as having happened. Calls jshHadEvent();
@@ -196,7 +202,7 @@ void jshPushIOCharEvents(IOEventFlags channel, char *data, unsigned int count);
 
 /// pop an IO event, returns EV_NONE on failure. data must be IOEVENT_MAX_LEN bytes
 IOEventFlags jshPopIOEvent(uint8_t *data, unsigned int *length);
-// pop an IO event of type eventType, returns true on success. data must be IOEVENT_MAX_LEN bytes
+// pop an IO event of type eventType, returns event type on success,EV_NONE on failure. data must be IOEVENT_MAX_LEN bytes
 IOEventFlags jshPopIOEventOfType(IOEventFlags eventType, uint8_t *data, unsigned int *length);
 /// Do we have any events pending? Will jshPopIOEvent return true?
 bool jshHasEvents();

src/jsinteractive.c

@@ -2204,6 +2204,20 @@ void jsiHandleIOEventForConsole(uint8_t *eventData, int eventLen) {
   jsiSetBusy(BUSY_INTERACTIVE, false);
 }
 
+/** This is called if a EV_RUN_INTERRUPT_JS is received, or when a EXEC_RUN_INTERRUPT_JS is set.
+It executes JavaScript code that was pushed to the queue by a require("timer").add({type:"EXEC", fn:myFunction... */
+static void jsiOnRunInterruptJSEvent(const uint8_t *eventData, unsigned int eventLen) {
+  for (unsigned int i=0;i<eventLen-1;i+=2) {
+    JsVarRef codeRef = *(JsVarRef *)&eventData[i];
+    if (codeRef) {
+      JsVar *code = jsvLock(codeRef);
+      if (!jsvIsFunction(code)) return; // invalid code - maybe things got moved?
+      jsvUnLock(jspExecuteFunction(code, execInfo.root, 0, NULL));
+      jsvUnLock(code);
+    }
+  }
+}
+
 void jsiIdle() {
   // This is how many times we have been here and not done anything.
   // It will be zeroed if we do stuff later
@@ -2248,7 +2262,10 @@ void jsiIdle() {
       }
       jsvUnLock(usartClass);
 #endif
+    } else if (eventType == EV_RUN_INTERRUPT_JS) {
+      jsiOnRunInterruptJSEvent(eventData, eventLen);
     } else if (eventType == EV_CUSTOM) {
+      jstOnCustomEvent(eventFlags, eventData, eventLen);
       jswOnCustomEvent(eventFlags, eventData, eventLen);
 #ifdef BLUETOOTH
     } else if (eventType == EV_BLUETOOTH_PENDING) {
@@ -3000,3 +3017,13 @@ void jsiDebuggerLine(JsVar *line) {
   jslSetLex(oldLex);
 }
 #endif // USE_DEBUGGER
+
+/** This is called from the parser if EXEC_RUN_INTERRUPT_JS is set.
+It executes JavaScript code that was pushed to the queue by require("timer").add({type:"EXEC", fn:myFunction... */
+void jsiRunInterruptingJS() {
+  uint8_t data[8];
+  memset(data, 0, sizeof(data));
+  if (jshPopIOEventOfType(EV_RUN_INTERRUPT_JS, data, sizeof(data)))
+    jsiOnRunInterruptJSEvent(data, sizeof(data));
+}
+

src/jsinteractive.h

@@ -201,5 +201,8 @@ extern void jsiTimersChanged(); // Flag timers changed so we can skip out of the
 extern void jsiDebuggerLoop(); ///< Enter the debugger loop
 #endif
 
+/** This is called from the parser if EXEC_RUN_INTERRUPT_JS is set.
+It executes JavaScript code that was pushed to the queue by require("timer").add({type:"EXEC", fn:myFunction... */
+void jsiRunInterruptingJS();
 
 #endif /* JSINTERACTIVE_H_ */

src/jsparse.c

@@ -2959,6 +2959,10 @@ NO_INLINE JsVar *jspeStatement() {
     jsiDebuggerLoop();
   }
 #endif
+  if (execInfo.execute&EXEC_RUN_INTERRUPT_JS) {
+    execInfo.execute&=~EXEC_RUN_INTERRUPT_JS;
+    jsiRunInterruptingJS();
+  }
   if (lex->tk==LEX_ID ||
       lex->tk==LEX_INT ||
       lex->tk==LEX_FLOAT ||

src/jsparse.h

@@ -98,7 +98,7 @@ typedef enum  {
   EXEC_INTERRUPTED = 16, ///< true if execution has been interrupted
   EXEC_EXCEPTION = 32, ///< we had an exception, so don't execute until we hit a try/catch block
   EXEC_ERROR = 64,
-  // 128 is free now
+  EXEC_RUN_INTERRUPT_JS = 128, ///< when set, we should stop our execution to run some JavaScript code (used for immediate timers)
 
   EXEC_FOR_INIT = 256, ///< when in for initialiser parsing - hack to avoid getting confused about multiple use for IN
   EXEC_IN_LOOP = 512, ///< when in a loop, set this - we can then block break/continue outside it