Add ISR average time calculation to the debug

src/IRsmallDDebug.h

@@ -8,6 +8,7 @@
  *   IRSMALLD_DEBUG_STATE    - Prints FSM states
  *   IRSMALLD_DEBUG_INTERVAL - Prints interval's duration between consecutive interrupts (in µs)
  *   IRSMALLD_DEBUG_ISRTIME  - Prints ISR execution time (in µs)
+ *   IRSMALLD_DEBUG_ISRAVG   - Prints the average of the ISR execution time (in µs)
  * 
  * NOTES:
  * - The usage of debuging functionalities requires a Serial.begin in the setup;
@@ -17,35 +18,60 @@
  *   in this case, it's just a few prints for debuging purposes.
  * - IRSMALLD_DEBUG_ISRTIME mode uses AVR 328p Timer1 hardware specific code;
  *   Results are in microseconds, assuming a 16MHz clock (Clk Count is divided by 16 to get µs);
+ * - IRSMALLD_DEBUG_ISRAVG shows the average of all ISR execution times since the last reset.
+ *   To restart the average calculation you'll need to reset the Arduino or restart the serial monitor.
+ *   You need to accumulator and counter used to calculate the average, you need to reset the Arduino.
  */
 
 
 #ifndef IRsmallD_Debug_h
   #define IRsmallD_Debug_h
 
+  // Check Debug incompatibilities:
+  #if defined(IRSMALLD_DEBUG_INTERVAL) && (defined(IRSMALLD_DEBUG_ISRTIME) || defined(IRSMALLD_DEBUG_ISRAVG))
+      #error Do not use IRSMALLD_DEBUG_ISRTIME or IRSMALLD_DEBUG_ISRAVG with IRSMALLD_DEBUG_INTERVAL, the ISR execution time is significantly affected by the print(uint32_t)
+  #elif defined(IRSMALLD_DEBUG_STATE) && (defined(IRSMALLD_DEBUG_ISRTIME) || defined(IRSMALLD_DEBUG_ISRAVG))
+      #warning Do not use IRSMALLD_DEBUG_ISRTIME or IRSMALLD_DEBUG_ISRAVG with IRSMALLD_DEBUG_STATE if you want accurate measurements of execution time
+  #endif 
+
+  // FSM states debug:
   #ifdef IRSMALLD_DEBUG_STATE
     #define DBG_PRINT_STATE(...)  Serial.print(__VA_ARGS__);
   #else
     #define DBG_PRINT_STATE(...) 	//nothing
   #endif
 
+  // Signals' intervals' duration:
   #ifdef IRSMALLD_DEBUG_INTERVAL
-    #ifdef IRSMALLD_DEBUG_ISRTIME
-      #define DBG_PRINTLN_DUR(...)  {Serial.print("i"); Serial.print(__VA_ARGS__);}
+    #if defined(IRSMALLD_DEBUG_ISRTIME) || defined(IRSMALLD_DEBUG_ISRAVG)
+      #define DBG_PRINTLN_DUR(...)  {Serial.print(" i"); Serial.print(__VA_ARGS__);}
     #else
-      #define DBG_PRINTLN_DUR(...)  {Serial.print("i"); Serial.println(__VA_ARGS__);}
+      #define DBG_PRINTLN_DUR(...)  {Serial.print(" i"); Serial.println(__VA_ARGS__);}
     #endif
   #else
     #define DBG_PRINTLN_DUR(...) 	//nothing
   #endif
 
-  #ifdef IRSMALLD_DEBUG_ISRTIME
-    #if defined(IRSMALLD_DEBUG_STATE) || defined(IRSMALLD_DEBUG_INTERVAL)
-      #warning Do not use IRSMALLD_DEBUG_ISRTIME with IRSMALLD_DEBUG_STATE or IRSMALLD_DEBUG_INTERVAL if you want accurate measurements of execution time
-    #endif 
-    #define DBG_RESTART_TIMER()  { TCCR1A = 0; TCCR1B = 1; TCNT1=0; } //set mode to count clock cycles and reset
-    #define DBG_PRINTLN_TIMER()  { uint16_t elapsedTime=TCNT1; Serial.print("t"); Serial.println(elapsedTime>>4);}
-  #else
+  // ISR Execution Time and Average:
+  #if defined(IRSMALLD_DEBUG_ISRTIME) && defined(IRSMALLD_DEBUG_ISRAVG)  // Time and Average
+      #define DBG_RESTART_TIMER() TCCR1A = 0; TCCR1B = 1; TCNT1=0;     \
+                                  static uint16_t dbg_isrCallsCount=0; \
+                                  static uint16_t dbg_isrTimeAccum=0;
+      #define DBG_PRINTLN_TIMER() uint16_t dbg_elapsedTime=TCNT1>>4; Serial.print(" t"); Serial.print(dbg_elapsedTime);  \
+                                  dbg_isrTimeAccum += dbg_elapsedTime; dbg_isrCallsCount += 1; Serial.print(" a");       \
+                                  Serial.println((float)dbg_isrTimeAccum / dbg_isrCallsCount);
+
+  #elif defined(IRSMALLD_DEBUG_ISRTIME)  // just Time, no Average
+      #define DBG_RESTART_TIMER() TCCR1A = 0; TCCR1B = 1; TCNT1=0;   
+      #define DBG_PRINTLN_TIMER() uint16_t dbg_elapsedTime=TCNT1>>4; Serial.print(" t"); Serial.println(dbg_elapsedTime);
+
+  #elif defined(IRSMALLD_DEBUG_ISRAVG)  // just Average, no Time
+      #define DBG_RESTART_TIMER() TCCR1A = 0; TCCR1B = 1; TCNT1=0;     \
+                                  static uint16_t dbg_isrCallsCount=0; \
+                                  static uint16_t dbg_isrTimeAccum=0;
+      #define DBG_PRINTLN_TIMER() dbg_isrTimeAccum += TCNT1>>4; dbg_isrCallsCount += 1; Serial.print(" a");  \
+                                  Serial.println((float)dbg_isrTimeAccum / dbg_isrCallsCount);
+  #else  // no Time and no Average
     #define DBG_RESTART_TIMER()  //nothing
     #define DBG_PRINTLN_TIMER()  //nothing
   #endif