智慧物流>> ESP32TimerInterrupt>> 返回
项目作者： khoih-prog

项目描述 ：
This library enables you to use Interrupt from Hardware Timers on an ESP32-based board. It now supports 16 ISR-based timers, while consuming only 1 hardware Timer. Timers' interval is very long (ulong millisecs). The most important feature is they're ISR-based timers. Therefore, their executions are not blocked by bad-behaving functions or tasks. This important feature is absolutely necessary for mission-critical tasks.
高级语言： C++
项目地址: git://github.com/khoih-prog/ESP32TimerInterrupt.git
创建时间： 2019-11-22T04:42:21Z
项目社区：https://github.com/khoih-prog/ESP32TimerInterrupt
开源协议：MIT License
下载


ESP32TimerInterrupt Library

arduino-library-badge
GitHub release
GitHub
contributions welcome
GitHub issues

Donate to my libraries using BuyMeACoffee

—-

Table of Contents

—-

Important Breaking Change from v2.0.0

Please have a look at HOWTO Fix Multiple Definitions Linker Error

—-

Why do we need this ESP32TimerInterrupt library

Features

This library enables you to use Interrupt from Hardware Timers on an ESP32-based board.

As Hardware Timers are rare, and very precious assets of any board, this library now enables you to use up to 16 ISR-based Timers, while consuming only 1 Hardware Timer. Timers’ interval is very long (ulong millisecs).

Now with these new 16 ISR-based timers, the maximum interval is practically unlimited (limited only by unsigned long milliseconds) while 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.

The ISR_Timer_Complex example will demonstrate the nearly perfect accuracy compared to software timers by printing the actual elapsed millisecs of each type of timers.

Being ISR-based timers, their executions are not blocked by bad-behaving functions / tasks, such as connecting to WiFi, Internet and Blynk services. You can also have many (up to 16) timers to use.

This non-being-blocked important feature is absolutely necessary for mission-critical tasks.

You’ll see blynkTimer Software is blocked while system is connecting to WiFi / Internet / Blynk, as well as by blocking task
in loop(), using delay() function as an example. The elapsed time then is very unaccurate

Why using ISR-based Hardware Timer Interrupt is better

Imagine you have a system with a mission-critical function, measuring water level and control the sump pump or doing something much more important. You normally use a software timer to poll, or even place the function in loop(). But what if another function is blocking the loop() or setup().

So your function might not be executed, and the result would be disastrous.

You’d prefer to have your function called, no matter what happening with other functions (busy loop, bug, etc.).

The correct choice is to use a Hardware Timer with Interrupt to call your function.

These hardware timers, using interrupt, still work even if other functions are blocking. Moreover, they are much more precise (certainly depending on clock frequency accuracy) than other software timers using millis() or micros(). That’s necessary if you need to measure some data requiring better accuracy.

Functions using normal software timers, relying on loop() and calling millis(), won’t work if the loop() or setup() is blocked by certain operation. For example, certain function is blocking while it’s connecting to WiFi or some services.

The catch is your function is now part of an ISR (Interrupt Service Routine), and must be lean / mean, and follow certain rules. More to read on:

HOWTO Attach Interrupt

Currently supported Boards

  1. ESP32 boards, such as ESP32_DEV, etc.
  2. ESP32_S2-based boards, such as ESP32S2_DEV, ESP32_S2 Saola, Adafruit QTPY_ESP32S2, ESP32S2 Native USB, UM FeatherS2 Neo, UM TinyS2, UM RMP, microS2, etc.
  3. ESP32_C3-based boards, such as ESP32C3_DEV, LOLIN_C3_MINI, DFROBOT_BEETLE_ESP32_C3, ADAFRUIT_QTPY_ESP32C3, AirM2M_CORE_ESP32C3, XIAO_ESP32C3, etc. New
  4. ESP32_S3-based boards, such as ESP32S3_DEV, ESP32_S3_BOX, UM TINYS3, UM PROS3, UM FEATHERS3, FEATHER_ESP32S3_NOPSRAM, QTPY_ESP32S3_NOPSRAM, etc. New

Important Notes about ISR

  1. Inside the attached function, delay() won’t work and the value returned by millis() will not increment. Serial data received while in the function may be lost. You should declare as volatile any variables that you modify within the attached function.

  2. Typically global variables are used to pass data between an ISR and the main program. To make sure variables shared between an ISR and the main program are updated correctly, declare them as volatile.

—-

Prerequisites

  1. Arduino IDE 1.8.19+ for Arduino. GitHub release
  2. ESP32 Core 2.0.5+ for ESP32-based boards. Latest release.
  3. SimpleTimer library to use with some examples.

—-

Installation

Use Arduino Library Manager

The best and easiest way is to use Arduino Library Manager. Search for ESP32TimerInterrupt, then select / install the latest version.
You can also use this link arduino-library-badge for more detailed instructions.

Manual Install

Another way to install is to:

  1. Navigate to ESP32TimerInterrupt page.
  2. Download the latest release ESP32TimerInterrupt-master.zip.
  3. Extract the zip file to ESP32TimerInterrupt-master directory
  4. Copy whole ESP32TimerInterrupt-master folder to Arduino libraries’ directory such as ~/Arduino/libraries/.

VS Code & PlatformIO

  1. Install VS Code
  2. Install PlatformIO
  3. Install ESP32TimerInterrupt library by using Library Manager. Search for ESP32TimerInterrupt in Platform.io Author’s Libraries
  4. Use included 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

—-

Note for Platform IO using ESP32 LittleFS

Necessary only for esp32 core v1.0.6-

From esp32 core v1.0.6+, LittleFS_esp32 v1.0.6 has been included and this step is not necessary anymore.

In Platform IO, to fix the error when using LittleFS_esp32 v1.0 for ESP32-based boards with ESP32 core v1.0.4- (ESP-IDF v3.2-), uncomment the following line

from

  1. //#define CONFIG_LITTLEFS_FOR_IDF_3_2   /* For old IDF - like in release 1.0.4 */

to

  1. #define CONFIG_LITTLEFS_FOR_IDF_3_2   /* For old IDF - like in release 1.0.4 */

It’s advisable to use the latest LittleFS_esp32 v1.0.5+ to avoid the issue.

Thanks to Roshan to report the issue in Error esp_littlefs.c ‘utime_p’

—-

HOWTO Fix Multiple Definitions Linker Error

The current library implementation, using xyz-Impl.h instead of standard xyz.cpp, possibly creates certain Multiple Definitions Linker error in certain use cases.

You can use

  1. #include <ESP32TimerInterrupt.hpp>               //https://github.com/khoih-prog/ESP32TimerInterrupt

in many files. But be sure to use the following #include <ESP32TimerInterrupt.h> in just 1 .h, .cpp or .ino file, which must not be included in any other file, to avoid Multiple Definitions Linker Error

  1. // To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
  2. #include <ESP32TimerInterrupt.h>                //https://github.com/khoih-prog/ESP32TimerInterrupt

You now don’t need to include ESP32_ISR_Timer.h anymore.

—-

HOWTO Use analogRead() with ESP32 running WiFi and/or BlueTooth (BT/BLE)

Please have a look at ESP_WiFiManager Issue 39: Not able to read analog port when using the autoconnect example to have more detailed description and solution of the issue.

1. ESP32 has 2 ADCs, named ADC1 and ADC2

2. ESP32 ADCs functions

  • ADC1 controls ADC function for pins GPIO32-GPIO39
  • ADC2 controls ADC function for pins GPIO0, 2, 4, 12-15, 25-27

3.. ESP32 WiFi uses ADC2 for WiFi functions

Look in file adc_common.c

In ADC2, there’re two locks used for different cases:

  1. lock shared with app and Wi-Fi:
    ESP32:

    1.  When Wi-Fi using the `ADC2`, we assume it will never stop, so app checks the lock and returns immediately if failed.

    ESP32S2:

    1.  The controller's control over the ADC is determined by the arbiter. There is no need to control by lock.

  2. lock shared between tasks:
    when several tasks sharing the ADC2, we want to guarantee
    all the requests will be handled.
    Since conversions are short (about 31us), app returns the lock very soon,
    we use a spinlock to stand there waiting to do conversions one by one.

adc2_spinlock should be acquired first, then adc2_wifi_lock or rtc_spinlock.

  • In order to use ADC2 for other functions, we have to acquire complicated firmware locks and very difficult to do
  • So, it’s not advisable to use ADC2 with WiFi/BlueTooth (BT/BLE).
  • Use ADC1, and pins GPIO32-GPIO39
  • If somehow it’s a must to use those pins serviced by ADC2 (GPIO0, 2, 4, 12, 13, 14, 15, 25, 26 and 27), use the fix mentioned at the end of ESP_WiFiManager Issue 39: Not able to read analog port when using the autoconnect example to work with ESP32 WiFi/BlueTooth (BT/BLE).

—-

More useful Information

ESP32 Hardware Timers

  • The ESP32, ESP32_S2 and ESP32_S3 has two timer groups, each one with two general purpose hardware timers.
  • The ESP32_C3 has two timer groups, each one with only one general purpose hardware timer.
  • 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 with these new 16 ISR-based timers (while consuming only 1 hardware timer), the maximum interval is practically unlimited (limited only by unsigned long milliseconds). 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.

The ISR_16_Timers_Array_Complex example will demonstrate the nearly perfect accuracy compared to software timers by printing the actual elapsed millisecs of each type of timers.
Being ISR-based timers, their executions are not blocked by bad-behaving functions / tasks, such as connecting to WiFi, Internet and Blynk services. You can also have many (up to 16) timers to use.

This non-being-blocked important feature is absolutely necessary for mission-critical tasks.

You’ll see software-based SimpleTimer is blocked while system is connecting to WiFi / Internet / Blynk, as well as by blocking task
in loop(), using delay() function as an example. The elapsed time then is very unaccurate

—-

How to use

Before using any Timer, you have to make sure the Timer has not been used by any other purpose.

Timer0, Timer1, Timer2 and Timer3 are supported for ESP32, ESP32_S2 and ESP32_S3.
Timer0, Timer1 are supported for ESP32_C3.

—-

Examples:

  1. Argument_None
  2. Change_Interval
  3. ISR_16_Timers_Array
  4. ISR_16_Timers_Array_Complex
  5. RPM_Measure
  6. SwitchDebounce
  7. TimerInterruptTest
  8. multiFileProject More complex
  9. ISR_16_Timers_Array_OneShot New
    1. ISR_16_Timers_Array_Complex_OneShot New

—-

Example ISR_16_Timers_Array_Complex

https://github.com/khoih-prog/ESP32TimerInterrupt/blob/a9f847be5988a7ffe55605bbb58830aca36b8197/examples/ISR_16_Timers_Array_Complex/ISR_16_Timers_Array_Complex.ino#L44-L385

—-

Debug Terminal Output Samples

1. TimerInterruptTest on ESP32C3_DEV

The following is the sample terminal output when running example TimerInterruptTest on ESP32C3_DEV to demonstrate how to start/stop Hardware Timers.

  1. Starting TimerInterruptTest on ESP32C3_DEV
  2. ESP32TimerInterrupt v2.3.0
  3. CPU Frequency = 160 MHz
  4. [TISR] ESP32_TimerInterrupt: _timerNo = 0 , _fre = 1000000
  5. [TISR] TIMER_BASE_CLK = 80000000 , TIMER_DIVIDER = 80
  6. [TISR] _timerIndex = 0 , _timerGroup = 0
  7. [TISR] _count = 0 - 1000000
  8. [TISR] timer_set_alarm_value = 1000000.00
  9. Starting  ITimer0 OK, millis() = 314
  10. [TISR] ESP32_TimerInterrupt: _timerNo = 1 , _fre = 1000000
  11. [TISR] TIMER_BASE_CLK = 80000000 , TIMER_DIVIDER = 80
  12. [TISR] _timerIndex = 0 , _timerGroup = 1
  13. [TISR] _count = 0 - 3000000
  14. [TISR] timer_set_alarm_value = 3000000.00
  15. Starting  ITimer1 OK, millis() = 346
  16. Stop ITimer0, millis() = 5001
  17. Start ITimer0, millis() = 10002
  18. Stop ITimer1, millis() = 15001
  19. Stop ITimer0, millis() = 15003
  20. Start ITimer0, millis() = 20004
  21. Stop ITimer0, millis() = 25005
  22. Start ITimer1, millis() = 30002
  23. Start ITimer0, millis() = 30006
  24. Stop ITimer0, millis() = 35007

2. Change_Interval on ESP32C3_DEV

The following is the sample terminal output when running example Change_Interval on ESP32C3_DEV to demonstrate how to change Timer Interval on-the-fly

  1. Starting Change_Interval on ESP32C3_DEV
  2. ESP32TimerInterrupt v2.3.0
  3. CPU Frequency = 160 MHz
  4. Starting  ITimer0 OK, millis() = 293
  5. Starting  ITimer1 OK, millis() = 303
  6. Time = 10001, Timer0Count = 5, Timer1Count = 2
  7. Time = 20002, Timer0Count = 10, Timer1Count = 4
  8. Changing Interval, Timer0 = 4000,  Timer1 = 10000
  9. Time = 30003, Timer0Count = 12, Timer1Count = 5
  10. Time = 40004, Timer0Count = 15, Timer1Count = 6
  11. Changing Interval, Timer0 = 2000,  Timer1 = 5000
  12. Time = 50005, Timer0Count = 20, Timer1Count = 8
  13. Time = 60006, Timer0Count = 25, Timer1Count = 10
  14. Changing Interval, Timer0 = 4000,  Timer1 = 10000
  15. Time = 70007, Timer0Count = 27, Timer1Count = 11
  16. Time = 80008, Timer0Count = 30, Timer1Count = 12
  17. Changing Interval, Timer0 = 2000,  Timer1 = 5000
  18. Time = 90009, Timer0Count = 35, Timer1Count = 14
  19. Time = 100010, Timer0Count = 40, Timer1Count = 16
  20. Changing Interval, Timer0 = 4000,  Timer1 = 10000
  21. Time = 110011, Timer0Count = 42, Timer1Count = 17
  22. Time = 120012, Timer0Count = 45, Timer1Count = 18
  23. Changing Interval, Timer0 = 2000,  Timer1 = 5000
  24. Time = 130013, Timer0Count = 50, Timer1Count = 20
  25. Time = 140014, Timer0Count = 55, Timer1Count = 22
  26. Changing Interval, Timer0 = 4000,  Timer1 = 10000

3. Argument_None on ESP32S3_DEV

The following is the sample terminal output when running example Argument_None on ESP32S3_DEV

  1. Starting Argument_None on ESP32S3_DEV
  2. ESP32TimerInterrupt v2.3.0
  3. CPU Frequency = 240 MHz
  4. [TISR] ESP32_S3_TimerInterrupt: _timerNo = 0 , _fre = 1000000
  5. [TISR] TIMER_BASE_CLK = 80000000 , TIMER_DIVIDER = 80
  6. [TISR] _timerIndex = 0 , _timerGroup = 0
  7. [TISR] _count = 0 - 1000000
  8. [TISR] timer_set_alarm_value = 1000000.00
  9. Starting  ITimer0 OK, millis() = 317
  10. [TISR] ESP32_S3_TimerInterrupt: _timerNo = 1 , _fre = 1000000
  11. [TISR] TIMER_BASE_CLK = 80000000 , TIMER_DIVIDER = 80
  12. [TISR] _timerIndex = 1 , _timerGroup = 0
  13. [TISR] _count = 0 - 5000000
  14. [TISR] timer_set_alarm_value = 5000000.00
  15. Starting  ITimer1 OK, millis() = 348

4. ISR_16_Timers_Array_Complex on ESP32S3_DEV

The following is the sample terminal output when running example ISR_16_Timers_Array_Complex on ESP32S3_DEV to demonstrate of ISR Hardware Timer, especially when system is very busy or blocked. The 16 independent ISR timers are programmed to be activated repetitively after certain intervals, is activated exactly after that programmed interval !!!

  1. Starting ISR_16_Timers_Array_Complex on ESP32S3_DEV
  2. ESP32TimerInterrupt v2.3.0
  3. CPU Frequency = 240 MHz
  4. [TISR] ESP32_S3_TimerInterrupt: _timerNo = 1 , _fre = 1000000
  5. [TISR] TIMER_BASE_CLK = 80000000 , TIMER_DIVIDER = 80
  6. [TISR] _timerIndex = 1 , _timerGroup = 0
  7. [TISR] _count = 0 - 10000
  8. [TISR] timer_set_alarm_value = 10000.00
  9. Starting ITimer OK, millis() = 318
  10. SimpleTimer : 2, ms : 10317, Dms : 9999
  11. Timer : 0, programmed : 5000, actual : 5009
  12. Timer : 1, programmed : 10000, actual : 0
  13. Timer : 2, programmed : 15000, actual : 0
  14. Timer : 3, programmed : 20000, actual : 0
  15. Timer : 4, programmed : 25000, actual : 0
  16. Timer : 5, programmed : 30000, actual : 0
  17. Timer : 6, programmed : 35000, actual : 0
  18. Timer : 7, programmed : 40000, actual : 0
  19. Timer : 8, programmed : 45000, actual : 0
  20. Timer : 9, programmed : 50000, actual : 0
  21. Timer : 10, programmed : 55000, actual : 0
  22. Timer : 11, programmed : 60000, actual : 0
  23. Timer : 12, programmed : 65000, actual : 0
  24. Timer : 13, programmed : 70000, actual : 0
  25. Timer : 14, programmed : 75000, actual : 0
  26. Timer : 15, programmed : 80000, actual : 0
  27. SimpleTimer : 2, ms : 20380, Dms : 10063
  28. Timer : 0, programmed : 5000, actual : 5000
  29. Timer : 1, programmed : 10000, actual : 10000
  30. Timer : 2, programmed : 15000, actual : 15009
  31. Timer : 3, programmed : 20000, actual : 20009
  32. Timer : 4, programmed : 25000, actual : 0
  33. Timer : 5, programmed : 30000, actual : 0
  34. Timer : 6, programmed : 35000, actual : 0
  35. Timer : 7, programmed : 40000, actual : 0
  36. Timer : 8, programmed : 45000, actual : 0
  37. Timer : 9, programmed : 50000, actual : 0
  38. Timer : 10, programmed : 55000, actual : 0
  39. Timer : 11, programmed : 60000, actual : 0
  40. Timer : 12, programmed : 65000, actual : 0
  41. Timer : 13, programmed : 70000, actual : 0
  42. Timer : 14, programmed : 75000, actual : 0
  43. Timer : 15, programmed : 80000, actual : 0
  44. SimpleTimer : 2, ms : 30443, Dms : 10063
  45. Timer : 0, programmed : 5000, actual : 5000
  46. Timer : 1, programmed : 10000, actual : 10000
  47. Timer : 2, programmed : 15000, actual : 15000
  48. Timer : 3, programmed : 20000, actual : 20009
  49. Timer : 4, programmed : 25000, actual : 25009
  50. Timer : 5, programmed : 30000, actual : 30009
  51. Timer : 6, programmed : 35000, actual : 0
  52. Timer : 7, programmed : 40000, actual : 0
  53. Timer : 8, programmed : 45000, actual : 0
  54. Timer : 9, programmed : 50000, actual : 0
  55. Timer : 10, programmed : 55000, actual : 0
  56. Timer : 11, programmed : 60000, actual : 0
  57. Timer : 12, programmed : 65000, actual : 0
  58. Timer : 13, programmed : 70000, actual : 0
  59. Timer : 14, programmed : 75000, actual : 0
  60. Timer : 15, programmed : 80000, actual : 0
  61. SimpleTimer : 2, ms : 40506, Dms : 10063
  62. Timer : 0, programmed : 5000, actual : 5000
  63. Timer : 1, programmed : 10000, actual : 10000
  64. Timer : 2, programmed : 15000, actual : 15000
  65. Timer : 3, programmed : 20000, actual : 20000
  66. Timer : 4, programmed : 25000, actual : 25009
  67. Timer : 5, programmed : 30000, actual : 30009
  68. Timer : 6, programmed : 35000, actual : 35009
  69. Timer : 7, programmed : 40000, actual : 40009
  70. Timer : 8, programmed : 45000, actual : 0
  71. Timer : 9, programmed : 50000, actual : 0
  72. Timer : 10, programmed : 55000, actual : 0
  73. Timer : 11, programmed : 60000, actual : 0
  74. Timer : 12, programmed : 65000, actual : 0
  75. Timer : 13, programmed : 70000, actual : 0
  76. Timer : 14, programmed : 75000, actual : 0
  77. Timer : 15, programmed : 80000, actual : 0
  78. SimpleTimer : 2, ms : 50569, Dms : 10063
  79. Timer : 0, programmed : 5000, actual : 5000
  80. Timer : 1, programmed : 10000, actual : 10000
  81. Timer : 2, programmed : 15000, actual : 15000
  82. Timer : 3, programmed : 20000, actual : 20000
  83. Timer : 4, programmed : 25000, actual : 25000
  84. Timer : 5, programmed : 30000, actual : 30009
  85. Timer : 6, programmed : 35000, actual : 35009
  86. Timer : 7, programmed : 40000, actual : 40009
  87. Timer : 8, programmed : 45000, actual : 45009
  88. Timer : 9, programmed : 50000, actual : 50009
  89. Timer : 10, programmed : 55000, actual : 0
  90. Timer : 11, programmed : 60000, actual : 0
  91. Timer : 12, programmed : 65000, actual : 0
  92. Timer : 13, programmed : 70000, actual : 0
  93. Timer : 14, programmed : 75000, actual : 0
  94. Timer : 15, programmed : 80000, actual : 0
  95. SimpleTimer : 2, ms : 60632, Dms : 10063
  96. Timer : 0, programmed : 5000, actual : 5000
  97. Timer : 1, programmed : 10000, actual : 10000
  98. Timer : 2, programmed : 15000, actual : 15000
  99. Timer : 3, programmed : 20000, actual : 20000
  100. Timer : 4, programmed : 25000, actual : 25000
  101. Timer : 5, programmed : 30000, actual : 30000
  102. Timer : 6, programmed : 35000, actual : 35009
  103. Timer : 7, programmed : 40000, actual : 40009
  104. Timer : 8, programmed : 45000, actual : 45009
  105. Timer : 9, programmed : 50000, actual : 50009
  106. Timer : 10, programmed : 55000, actual : 55009
  107. Timer : 11, programmed : 60000, actual : 60009
  108. Timer : 12, programmed : 65000, actual : 0
  109. Timer : 13, programmed : 70000, actual : 0
  110. Timer : 14, programmed : 75000, actual : 0
  111. Timer : 15, programmed : 80000, actual : 0
  112. SimpleTimer : 2, ms : 70695, Dms : 10063
  113. Timer : 0, programmed : 5000, actual : 5000
  114. Timer : 1, programmed : 10000, actual : 10000
  115. Timer : 2, programmed : 15000, actual : 15000
  116. Timer : 3, programmed : 20000, actual : 20000
  117. Timer : 4, programmed : 25000, actual : 25000
  118. Timer : 5, programmed : 30000, actual : 30000
  119. Timer : 6, programmed : 35000, actual : 35000
  120. Timer : 7, programmed : 40000, actual : 40009
  121. Timer : 8, programmed : 45000, actual : 45009
  122. Timer : 9, programmed : 50000, actual : 50009
  123. Timer : 10, programmed : 55000, actual : 55009
  124. Timer : 11, programmed : 60000, actual : 60009
  125. Timer : 12, programmed : 65000, actual : 65009
  126. Timer : 13, programmed : 70000, actual : 70009
  127. Timer : 14, programmed : 75000, actual : 0
  128. Timer : 15, programmed : 80000, actual : 0
  129. SimpleTimer : 2, ms : 80758, Dms : 10063
  130. Timer : 0, programmed : 5000, actual : 5000
  131. Timer : 1, programmed : 10000, actual : 10000
  132. Timer : 2, programmed : 15000, actual : 15000
  133. Timer : 3, programmed : 20000, actual : 20000
  134. Timer : 4, programmed : 25000, actual : 25000
  135. Timer : 5, programmed : 30000, actual : 30000
  136. Timer : 6, programmed : 35000, actual : 35000
  137. Timer : 7, programmed : 40000, actual : 40000
  138. Timer : 8, programmed : 45000, actual : 45009
  139. Timer : 9, programmed : 50000, actual : 50009
  140. Timer : 10, programmed : 55000, actual : 55009
  141. Timer : 11, programmed : 60000, actual : 60009
  142. Timer : 12, programmed : 65000, actual : 65009
  143. Timer : 13, programmed : 70000, actual : 70009
  144. Timer : 14, programmed : 75000, actual : 75009
  145. Timer : 15, programmed : 80000, actual : 80009
  146. ...
  147. SimpleTimer : 2, ms : 161262, Dms : 10063
  148. Timer : 0, programmed : 5000, actual : 5000
  149. Timer : 1, programmed : 10000, actual : 10000
  150. Timer : 2, programmed : 15000, actual : 15000
  151. Timer : 3, programmed : 20000, actual : 20000
  152. Timer : 4, programmed : 25000, actual : 25000
  153. Timer : 5, programmed : 30000, actual : 30000
  154. Timer : 6, programmed : 35000, actual : 35000
  155. Timer : 7, programmed : 40000, actual : 40000
  156. Timer : 8, programmed : 45000, actual : 45000
  157. Timer : 9, programmed : 50000, actual : 50000
  158. Timer : 10, programmed : 55000, actual : 55000
  159. Timer : 11, programmed : 60000, actual : 60000
  160. Timer : 12, programmed : 65000, actual : 65000
  161. Timer : 13, programmed : 70000, actual : 70000
  162. Timer : 14, programmed : 75000, actual : 75000
  163. Timer : 15, programmed : 80000, actual : 80000

5. ISR_16_Timers_Array on ESP32S3_DEV

The following is the sample terminal output when running example ISR_16_Timers_Array on ESP32S3_DEV to demonstrate of ISR Hardware Timer, especially when system is very busy or blocked. The 16 independent ISR timers are programmed to be activated repetitively after certain intervals, is activated exactly after that programmed interval !!!

  1. Starting ISR_16_Timers_Array on ESP32S3_DEV
  2. ESP32TimerInterrupt v2.3.0
  3. CPU Frequency = 240 MHz
  4. [TISR] ESP32_S3_TimerInterrupt: _timerNo = 1 , _fre = 1000000
  5. [TISR] TIMER_BASE_CLK = 80000000 , TIMER_DIVIDER = 80
  6. [TISR] _timerIndex = 1 , _timerGroup = 0
  7. [TISR] _count = 0 - 1000
  8. [TISR] timer_set_alarm_value = 1000.00
  9. Starting ITimer OK, millis() = 318
  10. simpleTimerDoingSomething2s: Delta programmed ms = 2000, actual = 10001
  11. simpleTimerDoingSomething2s: Delta programmed ms = 2000, actual = 10000
  12. simpleTimerDoingSomething2s: Delta programmed ms = 2000, actual = 10000
  13. simpleTimerDoingSomething2s: Delta programmed ms = 2000, actual = 10000

6. ISR_16_Timers_Array_Complex on ESP32C3_DEV

The following is the sample terminal output when running example ISR_16_Timers_Array_Complex on ESP32C3_DEV to demonstrate of ISR Hardware Timer, especially when system is very busy or blocked. The 16 independent ISR timers are programmed to be activated repetitively after certain intervals, is activated exactly after that programmed interval !!!

  1. Starting ISR_16_Timers_Array_Complex on ESP32C3_DEV
  2. ESP32TimerInterrupt v2.3.0
  3. CPU Frequency = 160 MHz
  4. [TISR] ESP32_TimerInterrupt: _timerNo = 1 , _fre = 1000000
  5. [TISR] TIMER_BASE_CLK = 80000000 , TIMER_DIVIDER = 80
  6. [TISR] _timerIndex = 0 , _timerGroup = 1
  7. [TISR] _count = 0 - 10000
  8. [TISR] timer_set_alarm_value = 10000.00
  9. Starting ITimer OK, millis() = 314
  10. SimpleTimer : 2, ms : 10314, Dms : 9999
  11. Timer : 0, programmed : 5000, actual : 5009
  12. Timer : 1, programmed : 10000, actual : 0
  13. Timer : 2, programmed : 15000, actual : 0
  14. Timer : 3, programmed : 20000, actual : 0
  15. Timer : 4, programmed : 25000, actual : 0
  16. Timer : 5, programmed : 30000, actual : 0
  17. Timer : 6, programmed : 35000, actual : 0
  18. Timer : 7, programmed : 40000, actual : 0
  19. Timer : 8, programmed : 45000, actual : 0
  20. Timer : 9, programmed : 50000, actual : 0
  21. Timer : 10, programmed : 55000, actual : 0
  22. Timer : 11, programmed : 60000, actual : 0
  23. Timer : 12, programmed : 65000, actual : 0
  24. Timer : 13, programmed : 70000, actual : 0
  25. Timer : 14, programmed : 75000, actual : 0
  26. Timer : 15, programmed : 80000, actual : 0
  27. SimpleTimer : 2, ms : 20381, Dms : 10067
  28. Timer : 0, programmed : 5000, actual : 5000
  29. Timer : 1, programmed : 10000, actual : 10000
  30. Timer : 2, programmed : 15000, actual : 15009
  31. Timer : 3, programmed : 20000, actual : 20009
  32. Timer : 4, programmed : 25000, actual : 0
  33. Timer : 5, programmed : 30000, actual : 0
  34. Timer : 6, programmed : 35000, actual : 0
  35. Timer : 7, programmed : 40000, actual : 0
  36. Timer : 8, programmed : 45000, actual : 0
  37. Timer : 9, programmed : 50000, actual : 0
  38. Timer : 10, programmed : 55000, actual : 0
  39. Timer : 11, programmed : 60000, actual : 0
  40. Timer : 12, programmed : 65000, actual : 0
  41. Timer : 13, programmed : 70000, actual : 0
  42. Timer : 14, programmed : 75000, actual : 0
  43. Timer : 15, programmed : 80000, actual : 0
  44. SimpleTimer : 2, ms : 30448, Dms : 10067
  45. Timer : 0, programmed : 5000, actual : 5000
  46. Timer : 1, programmed : 10000, actual : 10000
  47. Timer : 2, programmed : 15000, actual : 15000
  48. Timer : 3, programmed : 20000, actual : 20009
  49. Timer : 4, programmed : 25000, actual : 25009
  50. Timer : 5, programmed : 30000, actual : 30009
  51. Timer : 6, programmed : 35000, actual : 0
  52. Timer : 7, programmed : 40000, actual : 0
  53. Timer : 8, programmed : 45000, actual : 0
  54. Timer : 9, programmed : 50000, actual : 0
  55. Timer : 10, programmed : 55000, actual : 0
  56. Timer : 11, programmed : 60000, actual : 0
  57. Timer : 12, programmed : 65000, actual : 0
  58. Timer : 13, programmed : 70000, actual : 0
  59. Timer : 14, programmed : 75000, actual : 0
  60. Timer : 15, programmed : 80000, actual : 0
  61. SimpleTimer : 2, ms : 40515, Dms : 10067
  62. Timer : 0, programmed : 5000, actual : 5000
  63. Timer : 1, programmed : 10000, actual : 10000
  64. Timer : 2, programmed : 15000, actual : 15000
  65. Timer : 3, programmed : 20000, actual : 20000
  66. Timer : 4, programmed : 25000, actual : 25009
  67. Timer : 5, programmed : 30000, actual : 30009
  68. Timer : 6, programmed : 35000, actual : 35009
  69. Timer : 7, programmed : 40000, actual : 40009
  70. Timer : 8, programmed : 45000, actual : 0
  71. Timer : 9, programmed : 50000, actual : 0
  72. Timer : 10, programmed : 55000, actual : 0
  73. Timer : 11, programmed : 60000, actual : 0
  74. Timer : 12, programmed : 65000, actual : 0
  75. Timer : 13, programmed : 70000, actual : 0
  76. Timer : 14, programmed : 75000, actual : 0
  77. Timer : 15, programmed : 80000, actual : 0
  78. SimpleTimer : 2, ms : 50582, Dms : 10067
  79. Timer : 0, programmed : 5000, actual : 5000
  80. Timer : 1, programmed : 10000, actual : 10000
  81. Timer : 2, programmed : 15000, actual : 15000
  82. Timer : 3, programmed : 20000, actual : 20000
  83. Timer : 4, programmed : 25000, actual : 25000
  84. Timer : 5, programmed : 30000, actual : 30009
  85. Timer : 6, programmed : 35000, actual : 35009
  86. Timer : 7, programmed : 40000, actual : 40009
  87. Timer : 8, programmed : 45000, actual : 45009
  88. Timer : 9, programmed : 50000, actual : 50009
  89. Timer : 10, programmed : 55000, actual : 0
  90. Timer : 11, programmed : 60000, actual : 0
  91. Timer : 12, programmed : 65000, actual : 0
  92. Timer : 13, programmed : 70000, actual : 0
  93. Timer : 14, programmed : 75000, actual : 0
  94. Timer : 15, programmed : 80000, actual : 0
  95. SimpleTimer : 2, ms : 60649, Dms : 10067
  96. Timer : 0, programmed : 5000, actual : 5000
  97. Timer : 1, programmed : 10000, actual : 10000
  98. Timer : 2, programmed : 15000, actual : 15000
  99. Timer : 3, programmed : 20000, actual : 20000
  100. Timer : 4, programmed : 25000, actual : 25000
  101. Timer : 5, programmed : 30000, actual : 30000
  102. Timer : 6, programmed : 35000, actual : 35009
  103. Timer : 7, programmed : 40000, actual : 40009
  104. Timer : 8, programmed : 45000, actual : 45009
  105. Timer : 9, programmed : 50000, actual : 50009
  106. Timer : 10, programmed : 55000, actual : 55009
  107. Timer : 11, programmed : 60000, actual : 60009
  108. Timer : 12, programmed : 65000, actual : 0
  109. Timer : 13, programmed : 70000, actual : 0
  110. Timer : 14, programmed : 75000, actual : 0
  111. Timer : 15, programmed : 80000, actual : 0
  112. SimpleTimer : 2, ms : 70716, Dms : 10067
  113. Timer : 0, programmed : 5000, actual : 5000
  114. Timer : 1, programmed : 10000, actual : 10000
  115. Timer : 2, programmed : 15000, actual : 15000
  116. Timer : 3, programmed : 20000, actual : 20000
  117. Timer : 4, programmed : 25000, actual : 25000
  118. Timer : 5, programmed : 30000, actual : 30000
  119. Timer : 6, programmed : 35000, actual : 35000
  120. Timer : 7, programmed : 40000, actual : 40009
  121. Timer : 8, programmed : 45000, actual : 45009
  122. Timer : 9, programmed : 50000, actual : 50009
  123. Timer : 10, programmed : 55000, actual : 55009
  124. Timer : 11, programmed : 60000, actual : 60009
  125. Timer : 12, programmed : 65000, actual : 65009
  126. Timer : 13, programmed : 70000, actual : 70009
  127. Timer : 14, programmed : 75000, actual : 0
  128. Timer : 15, programmed : 80000, actual : 0
  129. SimpleTimer : 2, ms : 80783, Dms : 10067
  130. Timer : 0, programmed : 5000, actual : 5000
  131. Timer : 1, programmed : 10000, actual : 10000
  132. Timer : 2, programmed : 15000, actual : 15000
  133. Timer : 3, programmed : 20000, actual : 20000
  134. Timer : 4, programmed : 25000, actual : 25000
  135. Timer : 5, programmed : 30000, actual : 30000
  136. Timer : 6, programmed : 35000, actual : 35000
  137. Timer : 7, programmed : 40000, actual : 40000
  138. Timer : 8, programmed : 45000, actual : 45009
  139. Timer : 9, programmed : 50000, actual : 50009
  140. Timer : 10, programmed : 55000, actual : 55009
  141. Timer : 11, programmed : 60000, actual : 60009
  142. Timer : 12, programmed : 65000, actual : 65009
  143. Timer : 13, programmed : 70000, actual : 70009
  144. Timer : 14, programmed : 75000, actual : 75009
  145. Timer : 15, programmed : 80000, actual : 80009
  146. ...
  147. SimpleTimer : 2, ms : 161319, Dms : 10067
  148. Timer : 0, programmed : 5000, actual : 5000
  149. Timer : 1, programmed : 10000, actual : 10000
  150. Timer : 2, programmed : 15000, actual : 15000
  151. Timer : 3, programmed : 20000, actual : 20000
  152. Timer : 4, programmed : 25000, actual : 25000
  153. Timer : 5, programmed : 30000, actual : 30000
  154. Timer : 6, programmed : 35000, actual : 35000
  155. Timer : 7, programmed : 40000, actual : 40000
  156. Timer : 8, programmed : 45000, actual : 45000
  157. Timer : 9, programmed : 50000, actual : 50000
  158. Timer : 10, programmed : 55000, actual : 55000
  159. Timer : 11, programmed : 60000, actual : 60000
  160. Timer : 12, programmed : 65000, actual : 65000
  161. Timer : 13, programmed : 70000, actual : 70000
  162. Timer : 14, programmed : 75000, actual : 75000
  163. Timer : 15, programmed : 80000, actual : 80000

—-

Debug

Debug is enabled by default on Serial.

You can also change the debugging level (TIMERINTERRUPT_LOGLEVEL) from 0 to 4

  1. // These define's must be placed at the beginning before #include "ESP32TimerInterrupt.h"
  2. // _TIMERINTERRUPT_LOGLEVEL_ from 0 to 4
  3. // Don't define _TIMERINTERRUPT_LOGLEVEL_ > 0. Only for special ISR debugging only. Can hang the system.
  4. #define TIMER_INTERRUPT_DEBUG         0
  5. #define _TIMERINTERRUPT_LOGLEVEL_     0

Troubleshooting

If you get compilation errors, more often than not, you may need to install a newer version of the core for Arduino boards.

Sometimes, the library will only work if you update the board core to the latest version because I am using newly added functions.

—-

Issues

Submit issues to: ESP32TimerInterrupt issues

TO DO

  1. Search for bug and improvement.

DONE

  1. Basic hardware timers for ESP32.
  2. More hardware-initiated software-enabled timers
  3. Longer time interval
  4. Similar features for remaining Arduino boards such as SAMD21, SAMD51, SAM-DUE, nRF52, ESP8266, STM32, etc.
  5. Add support to new ESP32-S2
  6. Add support to new ESP32 core v1.0.6
  7. Fix compiler errors due to conflict to some libraries.
  8. Add complex examples.
  9. Avoid using D1 in examples due to issue with core v2.0.0 and v2.0.1.
    1. Fix multiple-definitions linker error. Drop src_cpp and src_h directories
    2. Restructure library.
    3. Add support to new ESP32_S3. Now supporting ESP32, ESP32_S2, ESP32_S3 and ESP32_C3
    4. Optimize library code by using reference-passing instead of value-passing
    5. Add example multiFileProject to demo for multiple-file project
    6. Add example ISR_16_Timers_Array_Complex_OneShot to demo how to use one-shot ISR-based timer in complex case
    7. Add example ISR_16_Timers_Array_OneShot to demo how to use one-shot ISR-based timer
    8. Add support to many more boards, such as
    • ESP32_S2 : ESP32S2 Native USB, UM FeatherS2 Neo, UM TinyS2, UM RMP, microS2, LOLIN_S2_MINI, LOLIN_S2_PICO, ADAFRUIT_FEATHER_ESP32S2, ADAFRUIT_FEATHER_ESP32S2_TFT, ATMegaZero ESP32-S2, Deneyap Mini, FRANZININHO_WIFI, FRANZININHO_WIFI_MSC
    • ESP32_S3 : UM TinyS3, UM PROS3, UM FeatherS3, ESP32_S3_USB_OTG, ESP32S3_CAM_LCD, DFROBOT_FIREBEETLE_2_ESP32S3, ADAFRUIT_FEATHER_ESP32S3_TFT
    • ESP32_C3 : LOLIN_C3_MINI, DFROBOT_BEETLE_ESP32_C3, ADAFRUIT_QTPY_ESP32C3, AirM2M_CORE_ESP32C3, XIAO_ESP32C3
    1. Use allman astyle and add utils

—-

Contributions and Thanks

Many thanks for everyone for bug reporting, new feature suggesting, testing and contributing to the development of this library.

  1. Thanks to Jelmer to report and make PR in Moved the implementation header file to a separate .cpp file leading to new Version v1.1.0
  2. Thanks to pedrojvs to report the issue in Error in the value defined by TIMER0_INTERVAL_MS #28 leading to new Version v2.3.0





jjwbruijn
Jelmer
 pedrojvs
pedrojvs

Contributing

If you want to contribute to this project:

  • Report bugs and errors
  • Ask for enhancements
  • Create issues and pull requests
  • Tell other people about this library

License

  • The library is licensed under MIT

Copyright 2019- Khoi Hoang