diff --git a/README.md b/README.md index 8642e19..a183b40 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ --- -### Important Change from v2.0.0 +### Important Breaking Change from v2.0.0 Please have a look at [HOWTO Fix `Multiple Definitions` Linker Error](#howto-fix-multiple-definitions-linker-error) @@ -116,8 +116,8 @@ The catch is **your function is now part of an ISR (Interrupt Service Routine), ### Currently supported Boards 1. ESP32 boards, such as `ESP32_DEV`, etc. -2. ESP32S2-based boards, such as `ESP32S2_DEV`, `ESP32_S2 Saola`, etc. -3. ESP32C3-based boards, such as `ESP32C3_DEV`, etc. **New** +2. ESP32_S2-based boards, such as `ESP32S2_DEV`, `ESP32_S2 Saola`, etc. +3. ESP32_C3-based boards, such as `ESP32C3_DEV`, etc. **New** 4. ESP32_S3 (ESP32S3_DEV, ESP32_S3_BOX, UM TINYS3, UM PROS3, UM FEATHERS3, etc.) **New** --- @@ -204,7 +204,7 @@ You can use #include //https://github.com/khoih-prog/ESP32TimerInterrupt ``` -in many files. But be sure to use the following `#include ` **in just 1 `.h`, `.cpp` or `.ino` file**, which must **not be included in any other file**, to avoid `Multiple Definitions` Linker Error +in many files. But be sure to use the following `#include ` **in just 1 `.h`, `.cpp` or `.ino` file**, which must **not be included in any other file**, to avoid `Multiple Definitions` Linker Error ``` // To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error diff --git a/library.json b/library.json index 874fb4c..89c8007 100644 --- a/library.json +++ b/library.json @@ -2,7 +2,7 @@ "name": "ESP32TimerInterrupt", "version": "2.0.0", "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", - "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.", + "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.", "authors": { "name": "Khoi Hoang", diff --git a/library.properties b/library.properties index ba45579..ab02db8 100644 --- a/library.properties +++ b/library.properties @@ -2,7 +2,7 @@ name=ESP32TimerInterrupt version=2.0.0 author=Khoi Hoang maintainer=Khoi Hoang -sentence=This library enables you to use Interrupt from Hardware Timers on ESP32-based (including ESP32-S2 and ESP32-C3) boards +sentence=This library enables you to use Interrupt from Hardware Timers on ESP32-based (including ESP32_S2, ESP32_S3 and ESP32_C3) boards 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. category=Device Control url=https://github.com/khoih-prog/ESP32TimerInterrupt