You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 29, 2023. It is now read-only.
### Releases v2.3.0
1. Fix doubled time for ESP32_C3, ESP32_S2 and ESP32_S3. Check [Error in the value defined by TIMER0_INTERVAL_MS #28](#28)
2. Modify examples to avoid using `LED_BUILTIN` / `GPIO2` as it cam cause crash in some boards, such as `ESP32_C3`
3. Use `allman astyle` and add `utils`
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+28-5
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ If you don't find anything, please [open a new issue](https://github.com/khoih-p
15
15
Please ensure to specify the following:
16
16
17
17
* Arduino IDE version (e.g. 1.8.19) or Platform.io version
18
-
*`ESP32` Core Version (e.g. ESP32 core v2.0.4)
18
+
*`ESP32` Core Version (e.g. ESP32 core v2.0.5)
19
19
*`ESP32` Board type (e.g. ESP32_DEV Module, etc.)
20
20
*`ESP32-S2` Board type (e.g. ESP32S2_DEV Module, ESP32_S2_Saola, etc.)
21
21
*`ESP32_S3` Board type (e.g. ESP32S3_DEV, ESP32_S3_BOX, UM TINYS3, UM PROS3, UM FEATHERS3, etc.)
@@ -31,28 +31,51 @@ Please ensure to specify the following:
31
31
32
32
```
33
33
Arduino IDE version: 1.8.19
34
-
ESP32 core v2.0.4
34
+
ESP32 core v2.0.5
35
35
ESP32S3_DEV Module
36
36
OS: Ubuntu 20.04 LTS
37
-
Linux xy-Inspiron-3593 5.15.0-41-generic #44~20.04.1-Ubuntu SMP Fri Jun 24 13:27:29 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
37
+
Linux xy-Inspiron-3593 5.15.0-52-generic #58~20.04.1-Ubuntu SMP Thu Oct 13 13:09:46 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
38
38
39
39
Context:
40
-
I encountered a crash while using ESP32TimerInterrupt.
41
-
40
+
I encountered a crash while using this library
42
41
Steps to reproduce:
43
42
1. ...
44
43
2. ...
45
44
3. ...
46
45
4. ...
47
46
```
48
47
48
+
### Additional context
49
+
50
+
Add any other context about the problem here.
51
+
52
+
---
53
+
49
54
### Sending Feature Requests
50
55
51
56
Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.
52
57
53
58
There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/ESP32TimerInterrupt/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.
54
59
60
+
---
61
+
55
62
### Sending Pull Requests
56
63
57
64
Pull Requests with changes and fixes are also welcome!
58
65
66
+
Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux)
67
+
68
+
1. Change directory to the library GitHub
69
+
70
+
```
71
+
xy@xy-Inspiron-3593:~$ cd Arduino/xy/ESP32TimerInterrupt_GitHub/
Copy file name to clipboardExpand all lines: README.md
+23-17
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,8 @@
8
8
9
9
<ahref="https://www.buymeacoffee.com/khoihprog6"title="Donate to my libraries using BuyMeACoffee"><imgsrc="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png"alt="Donate to my libraries using BuyMeACoffee"style="height: 50px!important;width: 181px!important;" ></a>
10
10
<ahref="https://www.buymeacoffee.com/khoihprog6"title="Donate to my libraries using BuyMeACoffee"><imgsrc="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange.svg?logo=buy-me-a-coffee&logoColor=FFDD00"style="height: 20px!important;width: 200px!important;" ></a>
@@ -138,7 +140,7 @@ The catch is **your function is now part of an ISR (Interrupt Service Routine),
138
140
## Prerequisites
139
141
140
142
1.[`Arduino IDE 1.8.19+` for Arduino](https://github.com/arduino/Arduino). [](https://github.com/arduino/Arduino/releases/latest)
141
-
2.[`ESP32 Core 2.0.4+`](https://github.com/espressif/arduino-esp32) for ESP32-based boards. [](https://github.com/espressif/arduino-esp32/releases/latest/).
143
+
2.[`ESP32 Core 2.0.5+`](https://github.com/espressif/arduino-esp32) for ESP32-based boards. [](https://github.com/espressif/arduino-esp32/releases/latest/).
142
144
3.[`SimpleTimer library`](https://github.com/jfturcot/SimpleTimer) to use with some examples.
143
145
144
146
---
@@ -184,13 +186,13 @@ In Platform IO, to fix the error when using [`LittleFS_esp32 v1.0`](https://gith
184
186
185
187
from
186
188
187
-
```
189
+
```cpp
188
190
//#define CONFIG_LITTLEFS_FOR_IDF_3_2 /* For old IDF - like in release 1.0.4 */
189
191
```
190
192
191
193
to
192
194
193
-
```
195
+
```cpp
194
196
#defineCONFIG_LITTLEFS_FOR_IDF_3_2 /* For old IDF - like in release 1.0.4 */
195
197
```
196
198
@@ -207,13 +209,13 @@ The current library implementation, using `xyz-Impl.h` instead of standard `xyz.
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
215
217
216
-
```
218
+
```cpp
217
219
// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
@@ -232,33 +234,33 @@ Please have a look at [**ESP_WiFiManager Issue 39: Not able to read analog port
232
234
233
235
#### 2. ESP32 ADCs functions
234
236
235
-
- ADC1 controls ADC function for pins **GPIO32-GPIO39**
236
-
- ADC2 controls ADC function for pins **GPIO0, 2, 4, 12-15, 25-27**
237
+
-`ADC1` controls ADC function for pins **GPIO32-GPIO39**
238
+
-`ADC2` controls ADC function for pins **GPIO0, 2, 4, 12-15, 25-27**
237
239
238
240
#### 3.. ESP32 WiFi uses ADC2 for WiFi functions
239
241
240
242
Look in file [**adc_common.c**](https://github.com/espressif/esp-idf/blob/master/components/driver/adc_common.c)
241
243
242
-
> In ADC2, there're two locks used for different cases:
244
+
> In `ADC2`, there're two locks used for different cases:
243
245
> 1. lock shared with app and Wi-Fi:
244
246
> ESP32:
245
-
> When Wi-Fi using the ADC2, we assume it will never stop, so app checks the lock and returns immediately if failed.
247
+
> When Wi-Fi using the `ADC2`, we assume it will never stop, so app checks the lock and returns immediately if failed.
246
248
> ESP32S2:
247
249
> The controller's control over the ADC is determined by the arbiter. There is no need to control by lock.
248
250
>
249
251
> 2. lock shared between tasks:
250
-
> when several tasks sharing the ADC2, we want to guarantee
252
+
> when several tasks sharing the `ADC2`, we want to guarantee
251
253
> all the requests will be handled.
252
254
> Since conversions are short (about 31us), app returns the lock very soon,
253
255
> we use a spinlock to stand there waiting to do conversions one by one.
254
256
>
255
257
> adc2_spinlock should be acquired first, then adc2_wifi_lock or rtc_spinlock.
256
258
257
259
258
-
- In order to use ADC2 for other functions, we have to **acquire complicated firmware locks and very difficult to do**
259
-
- So, it's not advisable to use ADC2 with WiFi/BlueTooth (BT/BLE).
260
-
- Use ADC1, and pins GPIO32-GPIO39
261
-
- 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**](https://github.com/khoih-prog/ESP_WiFiManager/issues/39) to work with ESP32 WiFi/BlueTooth (BT/BLE).
260
+
- In order to use `ADC2` for other functions, we have to **acquire complicated firmware locks and very difficult to do**
261
+
- So, it's not advisable to use `ADC2` with WiFi/BlueTooth (BT/BLE).
262
+
- Use `ADC1`, and pins `GPIO32-GPIO39`
263
+
- 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**](https://github.com/khoih-prog/ESP_WiFiManager/issues/39) to work with ESP32 WiFi/BlueTooth (BT/BLE).
262
264
263
265
---
264
266
---
@@ -295,8 +297,8 @@ in loop(), using delay() function as an example. The elapsed time then is very u
295
297
296
298
Before using any Timer, you have to make sure the Timer has not been used by any other purpose.
297
299
298
-
`Timer0, Timer1, Timer2 and Timer3` are supported for ESP32, ESP32_S2 and ESP32_S3.
299
-
`Timer0, Timer1` are supported for ESP32_C3.
300
+
`Timer0, Timer1, Timer2 and Timer3` are supported for `ESP32`, `ESP32_S2` and `ESP32_S3`.
301
+
`Timer0, Timer1` are supported for `ESP32_C3`.
300
302
301
303
---
302
304
---
@@ -851,6 +853,8 @@ Submit issues to: [ESP32TimerInterrupt issues](https://github.com/khoih-prog/ESP
851
853
- 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
852
854
- ESP32_S3 : UM TinyS3, UM PROS3, UM FeatherS3, ESP32_S3_USB_OTG, ESP32S3_CAM_LCD, DFROBOT_FIREBEETLE_2_ESP32S3, ADAFRUIT_FEATHER_ESP32S3_TFT
@@ -859,11 +863,13 @@ Submit issues to: [ESP32TimerInterrupt issues](https://github.com/khoih-prog/ESP
859
863
860
864
Many thanks for everyone for bug reporting, new feature suggesting, testing and contributing to the development of this library.
861
865
862
-
1. Thanks to [Jelmer](https://github.com/jjwbruijn) to report and make PR in [Moved the implementation header file to a separate .cpp file](https://github.com/khoih-prog/ESP32TimerInterrupt/pull/6) leading to new Version v1.1.0.
866
+
1. Thanks to [Jelmer](https://github.com/jjwbruijn) to report and make PR in [Moved the implementation header file to a separate .cpp file](https://github.com/khoih-prog/ESP32TimerInterrupt/pull/6) leading to new Version v1.1.0
867
+
2. Thanks to [pedrojvs](https://github.com/pedrojvs) to report the issue in [Error in the value defined by TIMER0_INTERVAL_MS #28](https://github.com/khoih-prog/ESP32TimerInterrupt/issues/28) leading to new Version v2.3.0
<ahref="https://www.buymeacoffee.com/khoihprog6"title="Donate to my libraries using BuyMeACoffee"><imgsrc="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png"alt="Donate to my libraries using BuyMeACoffee"style="height: 50px!important;width: 181px!important;" ></a>
11
+
<ahref="https://www.buymeacoffee.com/khoihprog6"title="Donate to my libraries using BuyMeACoffee"><imgsrc="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange.svg?logo=buy-me-a-coffee&logoColor=FFDD00"style="height: 20px!important;width: 200px!important;" ></a>
1. Fix doubled time for ESP32_C3, ESP32_S2 and ESP32_S3. Check [Error in the value defined by TIMER0_INTERVAL_MS #28](https://github.com/khoih-prog/ESP32TimerInterrupt/issues/28)
45
+
2. Modify examples to avoid using `LED_BUILTIN` / `GPIO2` as it cam cause crash in some boards, such as `ESP32_C3`
46
+
3. Use `allman astyle` and add `utils`
47
+
35
48
### Releases v2.2.0
36
49
37
50
1. Suppress warnings for ESP32_C3, ESP32_S2 and ESP32_S3
0 commit comments