v2.0.0 to add support to new ESP32_S3

### Releases v2.0.0

1. Restructure library.
2. Add support to new ESP32_S3. Now supporting ESP32, ESP32_S2, ESP32_S3 and ESP32_C3
3. Optimize library code by using `reference-passing` instead of `value-passing`
4. Add example [multiFileProject](examples/multiFileProject) to demo for multiple-file project

Author: khoih-prog

CONTRIBUTING.md

@@ -16,7 +16,7 @@ Please ensure to specify the following:
 
 * Arduino IDE version (e.g. 1.8.19) or Platform.io version
 * `ESP32` Core Version (e.g. ESP32 core v2.0.2)
-* `ESP32` Board type (e.g. ESP32_DEV, ESP32_S2_DEV, etc.)
+* `ESP32` Board type (e.g. ESP32_DEV Module, ESP32_S2_DEV, ESP32_S3_DEV, ESP32_C3_DEV, etc.)
 * Contextual information (e.g. what you were trying to achieve)
 * Simplest possible steps to reproduce
 * Anything that might be relevant in your opinion, such as:
@@ -31,7 +31,7 @@ Arduino IDE version: 1.8.19
 ESP32 Core Version 2.0.2
 ESP32S2_DEV Module
 OS: Ubuntu 20.04 LTS
-Linux xy-Inspiron-3593 5.4.0-96-generic #109-Ubuntu SMP Wed Jan 12 16:49:16 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
+Linux xy-Inspiron-3593 5.4.0-99-generic #112-Ubuntu SMP Thu Feb 3 13:50:55 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
 
 Context:
 I encountered a crash while using ESP32TimerInterrupt.

README.md

@@ -12,6 +12,7 @@
 ## Table of Contents
 
 * [Changelog](#changelog)
+  * [Releases v2.0.0](#releases-v200)
   * [Releases v1.5.0](#releases-v150)
   * [Releases v1.4.1](#releases-v141)
   * [Releases v1.4.0](#releases-v140)
@@ -27,6 +28,13 @@
 
 ## Changelog
 
+### Releases v2.0.0
+
+1. Restructure library.
+2. Add support to new ESP32_S3. Now supporting ESP32, ESP32_S2, ESP32_S3 and ESP32_C3
+3. Optimize library code by using `reference-passing` instead of `value-passing`
+4. Add example [multiFileProject](examples/multiFileProject) to demo for multiple-file project
+
 ### Releases v1.5.0
 
 1. Fix `multiple-definitions` linker error. Drop `src_cpp` and `src_h` directories.

changelog.md

@@ -1,28 +1,25 @@
 /****************************************************************************************************************************
   Argument_None.ino
-  For ESP32 boards
+  For ESP32, ESP32_S2, ESP32_S3, ESP32_C3 boards with ESP32 core v2.0.2+
   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.
+  The ESP32, ESP32_S2, ESP32_S3, ESP32_C3 have two timer groups, TIMER_GROUP_0 and TIMER_GROUP_1
+  1) each group of ESP32, ESP32_S2, ESP32_S3 has two general purpose hardware timers, TIMER_0 and TIMER_1
+  2) each group of ESP32_C3 has ony one general purpose hardware timer, TIMER_0
+  
+  All the timers are based on 64-bit counters (except 54-bit counter for ESP32_S3 counter) 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.
+  unsigned long miliseconds), you just consume only one ESP32-S2 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: mromani@ottotecnica.com
-  Copyright (c) 2010 OTTOTECNICA Italy
-
-  Based on BlynkTimer.h
-  Author: Volodymyr Shymanskyy
 *****************************************************************************************************************************/
 
 /*
@@ -37,98 +34,62 @@
    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.
-#elif ( ARDUINO_ESP32S2_DEV || ARDUINO_FEATHERS2 || ARDUINO_ESP32S2_THING_PLUS || ARDUINO_MICROS2 || \
-        ARDUINO_METRO_ESP32S2 || ARDUINO_MAGTAG29_ESP32S2 || ARDUINO_FUNHOUSE_ESP32S2 || \
-        ARDUINO_ADAFRUIT_FEATHER_ESP32S2_NOPSRAM )
-  #define USING_ESP32_S2_TIMER_INTERRUPT            true
+#if !defined( ESP32 )
+  #error This code is intended to run on the ESP32 platform! Please check your Tools->Board setting.
 #endif
 
-// These define's must be placed at the beginning before #include "TimerInterrupt_Generic.h"
+// These define's must be placed at the beginning before #include "_TIMERINTERRUPT_LOGLEVEL_.h"
 // _TIMERINTERRUPT_LOGLEVEL_ from 0 to 4
-// Don't define _TIMERINTERRUPT_LOGLEVEL_ > 0. Only for special ISR debugging only. Can hang the system.
-#define TIMER_INTERRUPT_DEBUG         0
 #define _TIMERINTERRUPT_LOGLEVEL_     4
 
+// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
 #include "ESP32TimerInterrupt.h"
 
 #ifndef LED_BUILTIN
   #define LED_BUILTIN       2         // Pin D2 mapped to pin GPIO2/ADC12 of ESP32, control on-board LED
 #endif
 
 // Don't use PIN_D1 in core v2.0.0 and v2.0.1. Check https://github.com/espressif/arduino-esp32/issues/5868
-#define PIN_D1              1         // Pin D1 mapped to pin GPIO1 of ESP32-S2
 #define PIN_D2              2         // Pin D2 mapped to pin GPIO2/ADC12/TOUCH2/LED_BUILTIN of ESP32
 #define PIN_D3              3         // Pin D3 mapped to pin GPIO3/RX0 of ESP32
 
-#if USING_ESP32_S2_TIMER_INTERRUPT
-  void IRAM_ATTR TimerHandler0(void * timerNo)
-#else
-  void IRAM_ATTR TimerHandler0(void)
-#endif
+// With core v2.0.0+, you can't use Serial.print/println in ISR or crash.
+// and you can't use float calculation inside ISR
+// Only OK in core v1.0.6-
+bool IRAM_ATTR TimerHandler0(void * timerNo)
 {
-#if USING_ESP32_S2_TIMER_INTERRUPT
-  /////////////////////////////////////////////////////////
-  // Always call this for ESP32-S2 before processing ISR
-  TIMER_ISR_START(timerNo);
-  /////////////////////////////////////////////////////////
-#endif
-
   static bool toggle0 = false;
-
-#if (TIMER_INTERRUPT_DEBUG > 0)
-  Serial.print("ITimer0: millis() = "); Serial.println(millis());
-#endif
+  static bool started = false;
 
   //timer interrupt toggles pin LED_BUILTIN
   digitalWrite(LED_BUILTIN, toggle0);
   toggle0 = !toggle0;
 
-#if USING_ESP32_S2_TIMER_INTERRUPT
-  /////////////////////////////////////////////////////////
-  // Always call this for ESP32-S2 after processing ISR
-  TIMER_ISR_END(timerNo);
-  /////////////////////////////////////////////////////////
-#endif
+  return true;
 }
 
-#if USING_ESP32_S2_TIMER_INTERRUPT
-  void IRAM_ATTR TimerHandler1(void * timerNo)
-#else
-  void IRAM_ATTR TimerHandler1(void)
-#endif
+// With core v2.0.0+, you can't use Serial.print/println in ISR or crash.
+// and you can't use float calculation inside ISR
+// Only OK in core v1.0.6-
+bool IRAM_ATTR TimerHandler1(void * timerNo)
 {
-#if USING_ESP32_S2_TIMER_INTERRUPT
   /////////////////////////////////////////////////////////
-  // Always call this for ESP32-S2 before processing ISR
-  TIMER_ISR_START(timerNo);
-  /////////////////////////////////////////////////////////
-#endif
 
   static bool toggle1 = false;
-
-#if (TIMER_INTERRUPT_DEBUG > 0)
-  Serial.print("ITimer1: millis() = "); Serial.println(millis());
-#endif
+  static bool started = false;
 
   //timer interrupt toggles outputPin
   digitalWrite(PIN_D3, toggle1);
   toggle1 = !toggle1;
 
-#if USING_ESP32_S2_TIMER_INTERRUPT
-  /////////////////////////////////////////////////////////
-  // Always call this for ESP32-S2 after processing ISR
-  TIMER_ISR_END(timerNo);
-  /////////////////////////////////////////////////////////
-#endif
+  return true;
 }
 
 #define TIMER0_INTERVAL_MS        1000
 
 #define TIMER1_INTERVAL_MS        5000
 
-// Init ESP32 timer 0
+// Init ESP32 timer 0 and 1
 ESP32Timer ITimer0(0);
 ESP32Timer ITimer1(1);
 
@@ -140,16 +101,10 @@ void setup()
   Serial.begin(115200);
   while (!Serial);
 
-  delay(100);
+  delay(200);
 
   Serial.print(F("\nStarting Argument_None on ")); Serial.println(ARDUINO_BOARD);
-
-#if USING_ESP32_S2_TIMER_INTERRUPT
-  Serial.println(ESP32_S2_TIMER_INTERRUPT_VERSION);
-#else
   Serial.println(ESP32_TIMER_INTERRUPT_VERSION);
-#endif
-
   Serial.print(F("CPU Frequency = ")); Serial.print(F_CPU / 1000000); Serial.println(F(" MHz"));
 
   // Using ESP32  => 80 / 160 / 240MHz CPU clock ,
@@ -158,22 +113,25 @@ void setup()
 
   // Interval in microsecs
   if (ITimer0.attachInterruptInterval(TIMER0_INTERVAL_MS * 1000, TimerHandler0))
+    //if (ITimer0.attachInterrupt(1, TimerHandler0))
   {
     Serial.print(F("Starting  ITimer0 OK, millis() = ")); Serial.println(millis());
   }
   else
-    Serial.println(F("Can't set ITimer0. Select another freq. or timer"));
+    Serial.println(F("Can't set ITimer0. Select another Timer, freq. or timer"));
+
 
   // Interval in microsecs
   if (ITimer1.attachInterruptInterval(TIMER1_INTERVAL_MS * 1000, TimerHandler1))
+    //if (ITimer1.attachInterrupt(2, TimerHandler1))
   {
     Serial.print(F("Starting  ITimer1 OK, millis() = ")); Serial.println(millis());
   }
   else
-    Serial.println(F("Can't set ITimer1. Select another freq. or timer"));
+    Serial.println(F("Can't set ITimer1. Select another Timer, freq. or timer"));
 }
 
 void loop()
 {
-
+  delay(1);
 }