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

Commit eb7f8aa

Browse files
authored
v1.3.0 to support core v2.0.0
#### Releases v1.3.0 ##### Warning: Releases v1.3.0+ can be used for either ESP32 core v2.0.0+ or v1.0.6-. Default is v2.0.0+ now 1. Making compatible either with breaking core v2.0.0+ or core v1.0.6- 2. Renew examples
1 parent e85bc6f commit eb7f8aa

32 files changed

+196
-50
lines changed

README.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212

1313
* [Table of contents](#table-of-contents)
1414
* [Why do we need this AsyncWebServer_WT32_ETH01 library](#why-do-we-need-this-asyncwebserver_wt32_eth01-library)
15+
* [Important notes](#Important-notes)
1516
* [Features](#features)
1617
* [Why Async is better](#why-async-is-better)
1718
* [Currently supported Boards](#currently-supported-boards)
@@ -97,6 +98,25 @@
9798

9899
### Why do we need this [AsyncWebServer_WT32_ETH01 library](https://github.com/khoih-prog/AsyncWebServer_WT32_ETH01)
99100

101+
#### Important notes
102+
103+
ESP32 Core v2.0.0 introduces new `arduino_event_id_t` enum, breaking almost all `WT32_ETH01` codes written for core v1.0.6-.
104+
105+
It's really strange to define that breaking enum `arduino_event_id_t` in [**WiFiGeneric.h**#L36-L78](https://github.com/espressif/arduino-esp32/blob/master/libraries/WiFi/src/WiFiGeneric.h#L36-L78), compared to the old `system_event_id_t`, now placed in [**esp_event_legacy.h**#L29-L63](https://github.com/espressif/arduino-esp32/blob/master/tools/sdk/esp32/include/esp_event/include/esp_event_legacy.h#L29-L63)
106+
107+
It's better to preserve the old enum order and just adding new items **to do no harm to pre-2.0.0 codes**
108+
109+
- Releases v1.2.5- to be used for ESP32 core v1.0.6- only
110+
- Releases v1.3.0+ can be used for either ESP32 core v2.0.0+ or v1.0.6-. **Default is using core v2.0.0+**
111+
112+
To use with core v1.0.6-, just define in your sketch
113+
114+
```
115+
#define USING_CORE_ESP32_CORE_V200_PLUS false
116+
```
117+
118+
---
119+
100120
#### Features
101121

102122
This library is based on, modified from:
@@ -134,9 +154,11 @@ to apply the better and faster **asynchronous** feature of the **powerful** [ESP
134154

135155
## Prerequisites
136156

137-
1. [`Arduino IDE 1.8.16+`](https://www.arduino.cc/en/Main/Software)
138-
2. [`ESP32 Core 2.0.0+`](https://github.com/espressif/arduino-esp32) for ESP32-based boards. [![Latest release](https://img.shields.io/github/release/espressif/arduino-esp32.svg)](https://github.com/espressif/arduino-esp32/releases/latest/)
139-
3. [`AsyncTCP library v1.1.1+`](https://github.com/me-no-dev/AsyncTCP).
157+
1. [`Arduino IDE 1.8.16+` for Arduino](https://www.arduino.cc/en/Main/Software)
158+
2. [`ESP32 Core 2.0.0+`](https://github.com/espressif/arduino-esp32) for ESP32-based WT32_ETH01 boards using release v1.3.0+. [![Latest release](https://img.shields.io/github/release/espressif/arduino-esp32.svg)](https://github.com/espressif/arduino-esp32/releases/latest/)
159+
3. [`ESP32 Core 1.0.6-`](https://github.com/espressif/arduino-esp32) for ESP32-based WT32_ETH01 boards using release v1.2.5- [![Latest release](https://img.shields.io/github/release/espressif/arduino-esp32.svg)](https://github.com/espressif/arduino-esp32/releases/latest/)
160+
161+
4. [`AsyncTCP library v1.1.1+`](https://github.com/me-no-dev/AsyncTCP).
140162

141163
---
142164

@@ -1328,6 +1350,9 @@ build_flags =
13281350
#error This code is designed for WT32_ETH01 to run on ESP32 platform! Please check your Tools->Board setting.
13291351
#endif
13301352

1353+
// Uncomment to use ESP32 core v1.0.6-
1354+
//#define USING_CORE_ESP32_CORE_V200_PLUS false
1355+
13311356
#include <Arduino.h>
13321357

13331358
#define _ASYNC_WEBSERVER_LOGLEVEL_ 4
@@ -1488,12 +1513,12 @@ You can access the Async Advanced WebServer @ the server IP
14881513
14891514
#### 1. AsyncMultiWebServer_WT32_ETH01 on WT32-ETH01 with ETH_PHY_LAN8720
14901515
1491-
Following are debug terminal output and screen shots when running example [AsyncMultiWebServer_WT32_ETH01](examples/AsyncMultiWebServer_WT32_ETH01) on WT32-ETH01 with ETH_PHY_LAN8720 to demonstrate the operation of 3 independent AsyncWebServers on 3 different ports and how to handle the complicated AsyncMultiWebServers.
1516+
Following are debug terminal output and screen shots when running example [AsyncMultiWebServer_WT32_ETH01](examples/AsyncMultiWebServer_WT32_ETH01) on WT32-ETH01 with ETH_PHY_LAN8720, using EP32 core v2.0.0, to demonstrate the operation of 3 independent AsyncWebServers on 3 different ports and how to handle the complicated AsyncMultiWebServers.
14921517
14931518
14941519
```
14951520
Starting AsyncMultiWebServer_WT32_ETH01 on WT32-ETH01 with ETH_PHY_LAN8720
1496-
AsyncWebServer_WT32_ETH01 v1.2.5
1521+
AsyncWebServer_WT32_ETH01 v1.3.0 for core v2.0.0+
14971522
ETH MAC: A8:03:2A:A1:61:73, IPv4: 192.168.2.232
14981523
FULL_DUPLEX, 100Mbps
14991524

changelog.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
## Table of contents
1212

1313
* [Changelog](#changelog)
14+
* [Releases v1.3.0](#releases-v130)
1415
* [Releases v1.2.5](#releases-v125)
1516
* [Releases v1.2.4](#releases-v124)
1617
* [Releases v1.2.3](#releases-v123)
@@ -21,8 +22,18 @@
2122

2223
## Changelog
2324

25+
#### Releases v1.3.0
26+
27+
##### Warning: Releases v1.3.0+ can be used for either ESP32 core v2.0.0+ or v1.0.6-. Default is v2.0.0+ now
28+
29+
1. Making compatible either with breaking core v2.0.0+ or core v1.0.6-
30+
2. Renew examples
31+
32+
2433
### Releases v1.2.5
2534

35+
##### Warning: Releases v1.2.5- to be used for ESP32 core v1.0.6- only
36+
2637
1. Update `platform.ini` and `library.json` to use original `khoih-prog` instead of `khoih.prog` after PIO fix
2738

2839

examples/AsyncFSBrowser_WT32_ETH01/AsyncFSBrowser_WT32_ETH01.ino

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,10 @@
1919
#error Must use ESP32 core v1.0.6-, with MBEDTLS_VERSION_NUMBER < v2.7.0
2020
#endif
2121

22-
#endif
22+
#endif
23+
24+
// Uncomment to use ESP32 core v1.0.6-
25+
//#define USING_CORE_ESP32_CORE_V200_PLUS false
2326

2427
#include <Arduino.h>
2528

examples/AsyncMultiWebServer_WT32_ETH01/AsyncMultiWebServer_WT32_ETH01.ino

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
#error This code is designed for WT32_ETH01 to run on ESP32 platform! Please check your Tools->Board setting.
1515
#endif
1616

17+
// Uncomment to use ESP32 core v1.0.6-
18+
//#define USING_CORE_ESP32_CORE_V200_PLUS false
19+
1720
#include <Arduino.h>
1821

1922
#define _ASYNC_WEBSERVER_LOGLEVEL_ 4

examples/AsyncSimpleServer_WT32_ETH01/AsyncSimpleServer_WT32_ETH01.ino

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@
2727
#error This code is designed for WT32_ETH01 to run on ESP32 platform! Please check your Tools->Board setting.
2828
#endif
2929

30+
// Uncomment to use ESP32 core v1.0.6-
31+
//#define USING_CORE_ESP32_CORE_V200_PLUS false
32+
3033
#include <Arduino.h>
3134

3235
#define _ASYNC_WEBSERVER_LOGLEVEL_ 4

examples/Async_AdvancedWebServer/Async_AdvancedWebServer.ino

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@
4242
#error This code is designed for WT32_ETH01 to run on ESP32 platform! Please check your Tools->Board setting.
4343
#endif
4444

45+
// Uncomment to use ESP32 core v1.0.6-
46+
//#define USING_CORE_ESP32_CORE_V200_PLUS false
47+
4548
#include <Arduino.h>
4649

4750
#define _ASYNC_WEBSERVER_LOGLEVEL_ 4

examples/Async_HelloServer/Async_HelloServer.ino

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
#error This code is designed for WT32_ETH01 to run on ESP32 platform! Please check your Tools->Board setting.
1515
#endif
1616

17+
// Uncomment to use ESP32 core v1.0.6-
18+
//#define USING_CORE_ESP32_CORE_V200_PLUS false
19+
1720
#include <Arduino.h>
1821

1922
#define _ASYNC_WEBSERVER_LOGLEVEL_ 4

examples/Async_HelloServer2/Async_HelloServer2.ino

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
#error This code is designed for WT32_ETH01 to run on ESP32 platform! Please check your Tools->Board setting.
1515
#endif
1616

17+
// Uncomment to use ESP32 core v1.0.6-
18+
//#define USING_CORE_ESP32_CORE_V200_PLUS false
19+
1720
#include <Arduino.h>
1821

1922
#define _ASYNC_WEBSERVER_LOGLEVEL_ 4

examples/Async_PostServer/Async_PostServer.ino

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
#error This code is designed for WT32_ETH01 to run on ESP32 platform! Please check your Tools->Board setting.
1515
#endif
1616

17+
// Uncomment to use ESP32 core v1.0.6-
18+
//#define USING_CORE_ESP32_CORE_V200_PLUS false
19+
1720
#include <Arduino.h>
1821

1922
#define _ASYNC_WEBSERVER_LOGLEVEL_ 4

examples/Async_RegexPatterns_WT32_ETH01/Async_RegexPatterns_WT32_ETH01.ino

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@
3333
#error This code is designed for WT32_ETH01 to run on ESP32 platform! Please check your Tools->Board setting.
3434
#endif
3535

36+
// Uncomment to use ESP32 core v1.0.6-
37+
//#define USING_CORE_ESP32_CORE_V200_PLUS false
38+
3639
#include <Arduino.h>
3740

3841
#define _ASYNC_WEBSERVER_LOGLEVEL_ 4

0 commit comments

Comments
 (0)