v1.1.1

### Releases v1.1.1

1. Add Change_Interval example to show how to change TimerInterval on-the-fly
2. Add Version String and Change_Interval example to show how to change TimerInterval

Author: khoih-prog

README.md

@@ -42,6 +42,11 @@ The catch is **your function is now part of an ISR (Interrupt Service Routine),
 ---
 ---
 
+### Releases v1.1.1
+
+1. Add Change_Interval example to show how to change TimerInterval on-the-fly
+2. Add Version String and Change_Interval example to show how to change TimerInterval
+
 ### Releases v1.1.0
 
 1. Restore cpp code besides Impl.h code to use if Multiple-Definition linker error.
@@ -62,7 +67,7 @@ The catch is **your function is now part of an ISR (Interrupt Service Routine),
 ---
 ---
 
-## Prerequisite
+## Prerequisites
 
 1. [`Arduino IDE 1.8.13+` for Arduino](https://www.arduino.cc/en/Main/Software)
 2. [`ESP32 Core 1.0.4+`](https://github.com/espressif/arduino-esp32) for ESP32-based boards
@@ -90,7 +95,7 @@ Another way to install is to:
 
 1. Install [VS Code](https://code.visualstudio.com/)
 2. Install [PlatformIO](https://platformio.org/platformio-ide)
-3. Install [**ESP32TimerInterrupt** library](https://platformio.org/lib/show/6904/ESP32TimerInterrupt) by using [Library Manager](https://platformio.org/lib/show/6904/ESP32TimerInterrupt/installation). Search for **ESP32TimerInterrupt** in [Platform.io Author's Libraries](https://platformio.org/lib/search?query=author:%22Khoi%20Hoang%22)
+3. Install [**ESP32TimerInterrupt** library](https://platformio.org/lib/show/11384/ESP32TimerInterrupt) or [**ESP32TimerInterrupt** library](https://platformio.org/lib/show/6904/ESP32TimerInterrupt) by using [Library Manager](https://platformio.org/lib/show/11384/ESP32TimerInterrupt/installation). Search for **ESP32TimerInterrupt** in [Platform.io Author's Libraries](https://platformio.org/lib/search?query=author:%22Khoi%20Hoang%22)
 4. Use included [platformio.ini](platformio/platformio.ini) file from examples to ensure that all dependent libraries will installed automatically. Please visit documentation for the other options and examples at [Project Configuration File](https://docs.platformio.org/page/projectconf.html)
 
 ---
@@ -207,6 +212,7 @@ Before using any Timer, you have to make sure the Timer has not been used by any
  8. [RPM_Measure](examples/RPM_Measure)
  9. [SwitchDebounce](examples/SwitchDebounce)
 10. [TimerInterruptTest](examples/TimerInterruptTest)
+11. [Change_Interval](examples/Change_Interval). New.
 
 
 ---
@@ -405,6 +411,8 @@ void setup()
   while (!Serial);
   
   Serial.println("\nStarting ISR_Timer_Complex on " + String(ARDUINO_BOARD));
+  Serial.println(ESP32_TIMER_INTERRUPT_VERSION);
+  Serial.printf("CPU Frequency = %ld MHz\n", F_CPU / 1000000);
 
   // You need this timer for non-critical tasks. Avoid abusing ISR if not absolutely necessary.
   blynkTimer.setInterval(BLYNK_TIMER_MS, blynkDoingSomething2s);
@@ -520,6 +528,8 @@ While software timer, **programmed for 2s, is activated after 3.435s !!!**
 
 ```
 Starting ISR_Timer_Complex on ESP32_DEV
+ESP32TimerInterrupt v1.1.1
+CPU Frequency = 240 MHz
 ESP32TimerInterrupt: _timerNo = 1, _fre = 1000000.00, _count = 0 - 50000
 Starting  ITimer OK, millis() = 2140
 [2341] 
@@ -581,6 +591,8 @@ blynkDoingSomething2s: Delta programmed ms = 2000, actual = 3000
 
 ```
 Starting TimerInterruptTest on ESP32_DEV
+ESP32TimerInterrupt v1.1.1
+CPU Frequency = 240 MHz
 ESP32TimerInterrupt: _timerNo = 0, _fre = 1000000.00, _count = 0 - 1000000
 Starting  ITimer0 OK, millis() = 136
 ESP32TimerInterrupt: _timerNo = 1, _fre = 1000000.00, _count = 0 - 3000000
@@ -632,9 +644,53 @@ ITimer0: millis() = 45008
 Stop ITimer0, millis() = 45009
 
 ```
+
+---
+
+2. The following is the sample terminal output when running example [Change_Interval](examples/Change_Interval) to demonstrate how to change Timer Interval on-the-fly
+
+```
+Starting Change_Interval on ESP32_DEV
+ESP32TimerInterrupt v1.1.1
+CPU Frequency = 240 MHz
+Starting  ITimer0 OK, millis() = 136
+Starting  ITimer1 OK, millis() = 136
+Time = 10001, Timer0Count = 19, , Timer1Count = 9
+Time = 20002, Timer0Count = 39, , Timer1Count = 19
+Changing Interval, Timer0 = 1000,  Timer1 = 2000
+Time = 30003, Timer0Count = 49, , Timer1Count = 24
+Time = 40004, Timer0Count = 59, , Timer1Count = 29
+Changing Interval, Timer0 = 500,  Timer1 = 1000
+Time = 50005, Timer0Count = 79, , Timer1Count = 39
+Time = 60006, Timer0Count = 99, , Timer1Count = 49
+Changing Interval, Timer0 = 1000,  Timer1 = 2000
+Time = 70007, Timer0Count = 109, , Timer1Count = 54
+Time = 80008, Timer0Count = 119, , Timer1Count = 59
+Changing Interval, Timer0 = 500,  Timer1 = 1000
+Time = 90009, Timer0Count = 139, , Timer1Count = 69
+Time = 100010, Timer0Count = 159, , Timer1Count = 79
+Changing Interval, Timer0 = 1000,  Timer1 = 2000
+Time = 110011, Timer0Count = 169, , Timer1Count = 84
+Time = 120012, Timer0Count = 179, , Timer1Count = 89
+Changing Interval, Timer0 = 500,  Timer1 = 1000
+Time = 130013, Timer0Count = 199, , Timer1Count = 99
+Time = 140014, Timer0Count = 219, , Timer1Count = 109
+Changing Interval, Timer0 = 1000,  Timer1 = 2000
+Time = 150015, Timer0Count = 229, , Timer1Count = 114
+Time = 160016, Timer0Count = 239, , Timer1Count = 119
+Changing Interval, Timer0 = 500,  Timer1 = 1000
+Time = 170017, Timer0Count = 259, , Timer1Count = 129
+Time = 180018, Timer0Count = 279, , Timer1Count = 139
+```
+
 ---
 ---
 
+### Releases v1.1.1
+
+1. Add Change_Interval example to show how to change TimerInterval on-the-fly
+2. Add Version String and Change_Interval example to show how to change TimerInterval
+
 ### Releases v1.1.0
 
 1. Restore cpp code besides Impl.h code to use if Multiple-Definition linker error.
@@ -668,7 +724,7 @@ Submit issues to: [ESP32TimerInterrupt issues](https://github.com/khoih-prog/ESP
 ## TO DO
 
 1. Search for bug and improvement.
-2. Similar features for remaining Arduino boards suh as SAMD21, SAMD51, SAM-DUE, nRF52
+2. Similar features for remaining Arduino boards such as SAMD21, SAMD51, SAM-DUE, nRF52
 
 
 ## DONE

examples/Argument_None/Argument_None.ino

@@ -24,7 +24,7 @@
    Based on BlynkTimer.h
    Author: Volodymyr Shymanskyy
 
-   Version: 1.1.0
+   Version: 1.1.1
 
    Version Modified By   Date      Comments
    ------- -----------  ---------- -----------
@@ -33,6 +33,7 @@
     1.0.2   K.Hoang      03/12/2019 Permit up to 16 super-long-time, super-accurate ISR-based timers to avoid being blocked
     1.0.3   K.Hoang      17/05/2020 Restructure code. Add examples. Enhance README.
     1.1.0   K.Hoang      27/10/2020 Restore cpp code besides Impl.h code to use if Multiple-Definition linker error.
+    1.1.1   K.Hoang      06/12/2020 Add Version String and Change_Interval example to show how to change TimerInterval
 *****************************************************************************************************************************/
 
 /*
@@ -119,6 +120,8 @@ void setup()
   delay(100);
 
   Serial.println("\nStarting Argument_None on " + String(ARDUINO_BOARD));
+  Serial.println(ESP32_TIMER_INTERRUPT_VERSION);
+  Serial.printf("CPU Frequency = %ld MHz\n", F_CPU / 1000000);
 
   // Using ESP32  => 80 / 160 / 240MHz CPU clock ,
   // For 64-bit timer counter

examples/Change_Interval/Change_Interval.ino

@@ -0,0 +1,176 @@
+/****************************************************************************************************************************
+   Change_Interval.ino
+   For ESP32 boards
+   Written by Khoi Hoang
+
+   Built by Khoi Hoang https://github.com/khoih-prog/ESP32TimerInterrupt
+   Licensed under MIT license
+
+   The ESP32 has two timer groups, each one with two general purpose hardware timers. All the timers are based on 64 bits
+   counters and 16 bit prescalers. The timer counters can be configured to count up or down and support automatic reload
+   and software reload. They can also generate alarms when they reach a specific value, defined by the software. The value
+   of the counter can be read by the software program.
+
+   Now even you use all these new 16 ISR-based timers,with their maximum interval practically unlimited (limited only by
+   unsigned long miliseconds), you just consume only one ESP32 timer and avoid conflicting with other cores' tasks.
+   The accuracy is nearly perfect compared to software timers. The most important feature is they're ISR-based timers
+   Therefore, their executions are not blocked by bad-behaving functions / tasks.
+   This important feature is absolutely necessary for mission-critical tasks.
+
+   Based on SimpleTimer - A timer library for Arduino.
+   Author: [email protected]
+   Copyright (c) 2010 OTTOTECNICA Italy
+
+   Based on BlynkTimer.h
+   Author: Volodymyr Shymanskyy
+
+   Version: 1.1.1
+
+   Version Modified By   Date      Comments
+   ------- -----------  ---------- -----------
+    1.0.0   K Hoang      23/11/2019 Initial coding
+    1.0.1   K Hoang      27/11/2019 No v1.0.1. Bump up to 1.0.2 to match ESP8266_ISR_TimerInterupt library
+    1.0.2   K.Hoang      03/12/2019 Permit up to 16 super-long-time, super-accurate ISR-based timers to avoid being blocked
+    1.0.3   K.Hoang      17/05/2020 Restructure code. Add examples. Enhance README.
+    1.1.0   K.Hoang      27/10/2020 Restore cpp code besides Impl.h code to use if Multiple-Definition linker error.
+    1.1.1   K.Hoang      06/12/2020 Add Version String and Change_Interval example to show how to change TimerInterval
+*****************************************************************************************************************************/
+
+/*
+   Notes:
+   Special design is necessary to share data between interrupt code and the rest of your program.
+   Variables usually need to be "volatile" types. Volatile tells the compiler to avoid optimizations that assume
+   variable can not spontaneously change. Because your function may change variables while your program is using them,
+   the compiler needs this hint. But volatile alone is often not enough.
+   When accessing shared variables, usually interrupts must be disabled. Even with volatile,
+   if the interrupt changes a multi-byte variable between a sequence of instructions, it can be read incorrectly.
+   If your data is multiple variables, such as an array and a count, usually interrupts need to be disabled
+   or the entire sequence of your code which accesses the data.
+*/
+
+#ifndef ESP32
+  #error This code is designed to run on ESP32 platform, not Arduino nor ESP8266! Please check your Tools->Board setting.
+#endif
+
+// These define's must be placed at the beginning before #include "ESP32TimerInterrupt.h"
+// Don't define TIMER_INTERRUPT_DEBUG > 0. Only for special ISR debugging only. Can hang the system.
+#define TIMER_INTERRUPT_DEBUG      0
+
+#include "ESP32TimerInterrupt.h"
+
+#ifndef LED_BUILTIN
+  #define LED_BUILTIN       2         // Pin D2 mapped to pin GPIO2/ADC12 of ESP32, control on-board LED
+#endif
+
+#define PIN_D23             23        // Pin D23 mapped to pin GPIO23/VSPI_MOSI of ESP32
+
+volatile uint32_t Timer0Count = 0;
+volatile uint32_t Timer1Count = 0;
+
+void IRAM_ATTR TimerHandler0(void)
+{
+  static bool toggle0 = false;
+
+  // Flag for checking to be sure ISR is working as Serial.print is not OK here in ISR
+  Timer0Count++;
+
+#if (TIMER_INTERRUPT_DEBUG > 0)
+  Serial.println("ITimer0: millis() = " + String(millis()));
+#endif
+
+  //timer interrupt toggles pin LED_BUILTIN
+  digitalWrite(LED_BUILTIN, toggle0);
+  toggle0 = !toggle0;
+}
+
+void IRAM_ATTR TimerHandler1(void)
+{
+  static bool toggle1 = false;
+
+  // Flag for checking to be sure ISR is working as Serial.print is not OK here in ISR
+  Timer1Count++;
+
+#if (TIMER_INTERRUPT_DEBUG > 0)
+  Serial.println("ITimer1: millis() = " + String(millis()));
+#endif
+
+  //timer interrupt toggles PIN_D23
+  digitalWrite(PIN_D23, toggle1);
+  toggle1 = !toggle1;
+}
+
+void printResult(uint32_t currTime)
+{
+  Serial.printf("Time = %ld, Timer0Count = %lu, , Timer1Count = %lu\n", currTime, Timer0Count, Timer1Count);
+}
+
+#define TIMER0_INTERVAL_MS        500
+
+#define TIMER1_INTERVAL_MS        1000
+
+// Init ESP32 timer 0
+ESP32Timer ITimer0(0);
+ESP32Timer ITimer1(1);
+
+void setup()
+{
+  pinMode(LED_BUILTIN,  OUTPUT);
+  pinMode(PIN_D23,      OUTPUT);
+  
+  Serial.begin(115200);
+  while (!Serial);
+
+  delay(100);
+
+  Serial.println("\nStarting Change_Interval on " + String(ARDUINO_BOARD));
+  Serial.println(ESP32_TIMER_INTERRUPT_VERSION);
+  Serial.printf("CPU Frequency = %ld MHz\n", F_CPU / 1000000);
+
+  // Interval in microsecs
+  if (ITimer0.attachInterruptInterval(TIMER0_INTERVAL_MS * 1000, TimerHandler0))
+  {
+    Serial.printf("Starting  ITimer0 OK, millis() = %ld\n", millis());
+  }
+  else
+    Serial.println("Can't set ITimer0. Select another freq. or timer");
+
+  // Interval in microsecs
+  if (ITimer1.attachInterruptInterval(TIMER1_INTERVAL_MS * 1000, TimerHandler1))
+  {
+    Serial.printf("Starting  ITimer1 OK, millis() = %ld\n", millis());
+  }
+  else
+    Serial.println("Can't set ITimer1. Select another freq. or timer");
+}
+
+#define CHECK_INTERVAL_MS     10000L
+#define CHANGE_INTERVAL_MS    20000L
+
+void loop()
+{
+  static uint32_t lastTime = 0;
+  static uint32_t lastChangeTime = 0;
+  static uint32_t currTime;
+  static uint32_t multFactor = 0;
+
+  currTime = millis();
+
+  if (currTime - lastTime > CHECK_INTERVAL_MS)
+  {
+    printResult(currTime);
+    lastTime = currTime;
+
+    if (currTime - lastChangeTime > CHANGE_INTERVAL_MS)
+    {
+      //setInterval(unsigned long interval, timerCallback callback)
+      multFactor = (multFactor + 1) % 2;
+      
+      ITimer0.setInterval(TIMER0_INTERVAL_MS * 1000 * (multFactor + 1), TimerHandler0);
+      ITimer1.setInterval(TIMER1_INTERVAL_MS * 1000 * (multFactor + 1), TimerHandler1);
+
+      Serial.printf("Changing Interval, Timer0 = %lu,  Timer1 = %lu\n", TIMER0_INTERVAL_MS * (multFactor + 1), TIMER1_INTERVAL_MS * (multFactor + 1));
+      
+      lastChangeTime = currTime;
+    }
+  }
+}

examples/ISR_RPM_Measure/ISR_RPM_Measure.ino

@@ -24,7 +24,7 @@
    Based on BlynkTimer.h
    Author: Volodymyr Shymanskyy
 
-   Version: 1.1.0
+   Version: 1.1.1
 
    Version Modified By   Date      Comments
    ------- -----------  ---------- -----------
@@ -33,6 +33,7 @@
     1.0.2   K.Hoang      03/12/2019 Permit up to 16 super-long-time, super-accurate ISR-based timers to avoid being blocked
     1.0.3   K.Hoang      17/05/2020 Restructure code. Add examples. Enhance README.
     1.1.0   K.Hoang      27/10/2020 Restore cpp code besides Impl.h code to use if Multiple-Definition linker error.
+    1.1.1   K.Hoang      06/12/2020 Add Version String and Change_Interval example to show how to change TimerInterval
 *****************************************************************************************************************************/
 /*
    Notes:
@@ -142,6 +143,8 @@ void setup()
   while (!Serial);
 
   Serial.println("\nStarting ISR_RPM_Measure on " + String(ARDUINO_BOARD));
+  Serial.println(ESP32_TIMER_INTERRUPT_VERSION);
+  Serial.printf("CPU Frequency = %ld MHz\n", F_CPU / 1000000);
 
   // Using ESP32  => 80 / 160 / 240MHz CPU clock ,
   // For 64-bit timer counter

examples/ISR_Switch/ISR_Switch.ino

@@ -24,7 +24,7 @@
    Based on BlynkTimer.h
    Author: Volodymyr Shymanskyy
 
-   Version: 1.1.0
+   Version: 1.1.1
 
    Version Modified By   Date      Comments
    ------- -----------  ---------- -----------
@@ -33,6 +33,7 @@
     1.0.2   K.Hoang      03/12/2019 Permit up to 16 super-long-time, super-accurate ISR-based timers to avoid being blocked
     1.0.3   K.Hoang      17/05/2020 Restructure code. Add examples. Enhance README.
     1.1.0   K.Hoang      27/10/2020 Restore cpp code besides Impl.h code to use if Multiple-Definition linker error.
+    1.1.1   K.Hoang      06/12/2020 Add Version String and Change_Interval example to show how to change TimerInterval
 *****************************************************************************************************************************/
 /* Notes:
    Special design is necessary to share data between interrupt code and the rest of your program.
@@ -61,7 +62,9 @@
 
 // These define's must be placed at the beginning before #include "ESP32TimerInterrupt.h"
 // Don't define TIMER_INTERRUPT_DEBUG > 2. Only for special ISR debugging only. Can hang the system.
-#define TIMER_INTERRUPT_DEBUG      1
+#define TIMER_INTERRUPT_DEBUG      0
+
+#include "ESP32TimerInterrupt.h"
 
 #define BLYNK_PRINT Serial
 //#define BLYNK_DEBUG true
@@ -251,6 +254,8 @@ void setup()
   while (!Serial);
 
   Serial.println("\nStarting ISR_Switch on " + String(ARDUINO_BOARD));
+  Serial.println(ESP32_TIMER_INTERRUPT_VERSION);
+  Serial.printf("CPU Frequency = %ld MHz\n", F_CPU / 1000000);
 
   LampState = false;