Skip to content
This repository was archived by the owner on Jan 29, 2023. It is now read-only.

Commit 24e320f

Browse files
authored
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
1 parent 444a9da commit 24e320f

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
---
6565

6666

67-
### Important Change from v2.0.0
67+
### Important Breaking Change from v2.0.0
6868

6969
Please have a look at [HOWTO Fix `Multiple Definitions` Linker Error](#howto-fix-multiple-definitions-linker-error)
7070

@@ -116,8 +116,8 @@ The catch is **your function is now part of an ISR (Interrupt Service Routine),
116116
### Currently supported Boards
117117

118118
1. ESP32 boards, such as `ESP32_DEV`, etc.
119-
2. ESP32S2-based boards, such as `ESP32S2_DEV`, `ESP32_S2 Saola`, etc.
120-
3. ESP32C3-based boards, such as `ESP32C3_DEV`, etc. **New**
119+
2. ESP32_S2-based boards, such as `ESP32S2_DEV`, `ESP32_S2 Saola`, etc.
120+
3. ESP32_C3-based boards, such as `ESP32C3_DEV`, etc. **New**
121121
4. ESP32_S3 (ESP32S3_DEV, ESP32_S3_BOX, UM TINYS3, UM PROS3, UM FEATHERS3, etc.) **New**
122122

123123
---
@@ -204,7 +204,7 @@ You can use
204204
#include <ESP32TimerInterrupt.hpp> //https://github.com/khoih-prog/ESP32TimerInterrupt
205205
```
206206

207-
in many files. But be sure to use the following `#include <ESP32_ISR_Timer.h>` **in just 1 `.h`, `.cpp` or `.ino` file**, which must **not be included in any other file**, to avoid `Multiple Definitions` Linker Error
207+
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
208208

209209
```
210210
// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error

library.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "ESP32TimerInterrupt",
33
"version": "2.0.0",
44
"keywords": "timing, device, control, timer, interrupt, timer-interrupt, hardware, isr, isr-based, hardware-timer, isr-timer, isr-based-timer, mission-critical, accuracy, precise, non-blocking, esp32, esp32-s2, esp32-c3, esp32-s3",
5-
"description": "This library enables you to use Interrupt from Hardware Timers on ESP32-based (including ESP32-S2 and ESP32-C3) boards. 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. 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.",
5+
"description": "This library enables you to use Interrupt from Hardware Timers on ESP32-based (including ESP32_S2, ESP32_S3 and ESP32_C3) boards. 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. 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.",
66
"authors":
77
{
88
"name": "Khoi Hoang",

library.properties

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name=ESP32TimerInterrupt
22
version=2.0.0
33
author=Khoi Hoang <khoih.prog@gmail.com>
44
maintainer=Khoi Hoang <khoih.prog@gmail.com>
5-
sentence=This library enables you to use Interrupt from Hardware Timers on ESP32-based (including ESP32-S2 and ESP32-C3) boards
5+
sentence=This library enables you to use Interrupt from Hardware Timers on ESP32-based (including ESP32_S2, ESP32_S3 and ESP32_C3) boards
66
paragraph=These ESP32 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 is mandatory if you need to measure some data requiring better accuracy. 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 are 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.
77
category=Device Control
88
url=https://github.com/khoih-prog/ESP32TimerInterrupt

0 commit comments

Comments
 (0)