- Why do we need this AsyncHTTPRequest_ESP32_Ethernet library
- Changelog
- Prerequisites
- Installation
- Note for Platform IO using ESP32 LittleFS
- HOWTO Fix
Multiple Definitions
Linker Error - Note for Platform IO using ESP32 LittleFS
- HOWTO Use analogRead() with ESP32 running WiFi and/or BlueTooth (BT/BLE)
- How to connect W5500, W6100 or ENC28J60 to ESP32_S2/S3/C3
- Examples
- Example AsyncHTTPRequest_ESP32_SC_W5500
- Debug Terminal Output Samples
- 1. AsyncHTTPRequest_ESP32_SC_W5500 on ESP32S3_DEV with ESP32_S3_W5500
- 2. AsyncHTTPRequest_ESP32_SC_ENC on ESP32S3_DEV with ESP32_S3_ENC28J60
- 3. AsyncHTTPRequest_ESP32_W5500 on ESP32_DEV with ESP32_W5500
- 4. AsyncHTTPRequest_ESP32_SC_W5500 on ESP32S2_DEV with ESP32_S2_W5500
- 5. AsyncHTTPRequest_ESP32_SC_ENC on ESP32C3_DEV with ESP32_C3_ENC28J60
- 6. AsyncHTTPRequest_ESP32_W6100 on ESP32_DEV with ESP32_W6100
- 7. AsyncHTTPRequest_ESP32_SC_W6100 on ESP32S3_DEV with ESP32_S3_W6100
- Debug
- Troubleshooting
- Issues
- TO DO
- DONE
- Contributions and Thanks
- Contributing
- License and credits
- Copyright
Why do we need this AsyncHTTPRequest_ESP32_Ethernet library
- Asynchronous HTTP Request library for ESP32/S2/S3/C3, WT32_ETH01 (ESP32 + LAN8720), ESP32 using LwIP ENC28J60, W5500, W6100 or LAN8720.
- Providing a subset of HTTP.
- Relying on
AsyncTCP
- Methods similar in format and usage to XmlHTTPrequest in Javascript.
- GET, POST, PUT, PATCH, DELETE and HEAD
- Request and response headers
- Chunked response
- Single String response for short (<~5K) responses (heap permitting).
- Optional onData callback.
- Optional onReadyStatechange callback.
This library adds a simple HTTP layer on top of the AsyncTCP library to facilitate REST communication from a Client to a Server. The paradigm is similar to the XMLHttpRequest in Javascript, employing the notion of a ready-state progression through the transaction request.
Synchronization can be accomplished using callbacks on ready-state change, a callback on data receipt, or simply polling for ready-state change. Data retrieval can be incremental as received, or bulk retrieved when the transaction completes provided there is enough heap to buffer the entire response.
The underlying buffering uses a new xbuf class. It handles both character and binary data. Class xbuf uses a chain of small (64 byte) segments that are allocated and added to the tail as data is added and deallocated from the head as data is read, achieving the same result as a dynamic circular buffer limited only by the size of heap. The xbuf implements indexOf and readUntil functions.
For short transactions, buffer space should not be an issue. In fact, it can be more economical than other methods that use larger fixed length buffers. Data is acked when retrieved by the caller, so there is some limited flow control to limit heap usage for larger transfers.
Request and response headers are handled in the typical fashion.
Chunked responses are recognized and handled transparently.
This library is based on, modified from:
- ESP32 (ESP32-DEV, etc.)
- ESP32-S3 (ESP32S3_DEV, ESP32_S3_BOX, UM TINYS3, UM PROS3, UM FEATHERS3, etc.)
- ESP32-S2 (ESP32S2_DEV, etc.)
- ESP32-C3 (ESP32C3_DEV, etc.)
FULL_DUPLEX, 100Mbps
FULL_DUPLEX, 100Mbps
FULL_DUPLEX, 10Mbps
Arduino IDE 1.8.19+
for Arduino.ESP32 Core 2.0.6+
for ESP32-based boards. [Latest stable releaseAsyncTCP v1.1.1+
for ESP32.ESPAsync_WiFiManager library v1.15.1+
for ESP32/ESP8266 using some examples.WebServer_WT32_ETH01 library v1.5.1+
if necessary to use WT32_ETH01 boards. To install, checkWebServer_ESP32_ENC library v1.5.3+
if necessary to use ESP32 boards usingLwIP ENC28J60
Ethernet. To install, checkWebServer_ESP32_W5500 library v1.5.3+
if necessary to use ESP32 boards usingLwIP W5500
Ethernet. To install, checkWebServer_ESP32_SC_ENC library v1.2.1+
if necessary to useESP32_S2/S3/C3
boards usingLwIP ENC28J60
Ethernet. To install, checkWebServer_ESP32_SC_W5500 library v1.2.1+
if necessary to useESP32_S2/S3/C3
boards usingLwIP W5500
Ethernet. To install, checkWebServer_ESP32_W6100 library v1.5.3+
if necessary to use ESP32 boards usingLwIP W6100
Ethernet. To install, checkWebServer_ESP32_SC_W6100 library v1.2.1+
if necessary to useESP32_S2/S3/C3
boards usingLwIP W6100
Ethernet. To install, check
The best and easiest way is to use Arduino Library Manager
. Search for AsyncHTTPRequest_ESP32_Ethernet
, then select / install the latest version. You can also use this link for more detailed instructions.
- Navigate to AsyncHTTPRequest_ESP32_Ethernet page.
- Download the latest release
AsyncHTTPRequest_ESP32_Ethernet-main.zip
. - Extract the zip file to
AsyncHTTPRequest_ESP32_Ethernet-main
directory - Copy the whole
AsyncHTTPRequest_ESP32_Ethernet-main
folder to Arduino libraries' directory such as~/Arduino/libraries/
.
- Install VS Code
- Install PlatformIO
- Install AsyncHTTPRequest_ESP32_Ethernet library by using Library Manager. Search for AsyncHTTPRequest_ESP32_Ethernet in Platform.io Author's Libraries
- 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
In Platform IO, to fix the error when using LittleFS_esp32 v1.0.6
for ESP32-based boards with ESP32 core v1.0.4- (ESP-IDF v3.2-), uncomment the following line
from
//#define CONFIG_LITTLEFS_FOR_IDF_3_2 /* For old IDF - like in release 1.0.4 */
to
#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'
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 include this .hpp
file
// Can be included as many times as necessary, without `Multiple Definitions` Linker Error
#include "AsyncHTTPRequest_ESP32_Ethernet.hpp" //https://github.com/khoih-prog/AsyncHTTPRequest_ESP32_Ethernet
in many files. But be sure to use the following .h
file 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
#include "AsyncHTTPRequest_ESP32_Ethernet.h" //https://github.com/khoih-prog/AsyncHTTPRequest_ESP32_Ethernet
Check the new multiFileProject example for a HOWTO
demo.
Have a look at the discussion in Different behaviour using the src_cpp or src_h lib #80
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
//#define CONFIG_LITTLEFS_FOR_IDF_3_2 /* For old IDF - like in release 1.0.4 */
to
#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'
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.
ADC1
controlsADC
function for pins GPIO32-GPIO39ADC2
controlsADC
function for pins GPIO0, 2, 4, 12-15, 25-27
Look in file adc_common.c
In
ADC2
, there're two locks used for different cases:
lock shared with app and Wi-Fi: ESP32: When Wi-Fi using the
ADC2
, we assume it will never stop, so app checks the lock and returns immediately if failed. ESP32S2: The controller's control over the ADC is determined by the arbiter. There is no need to control by lock.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).
FULL_DUPLEX, 100Mbps
You can change the INT
pin to another one. Default is GPIO4
// Must connect INT to GPIOxx or not working
#define INT_GPIO 4
W5500, W6100 or ENC28J60 | <---> | ESP32_S3 |
---|---|---|
MOSI | <---> | GPIO11 |
MISO | <---> | GPIO13 |
SCK | <---> | GPIO12 |
CS/SS | <---> | GPIO10 |
INT | <---> | GPIO4 |
RST | <---> | RST |
GND | <---> | GND |
3.3V | <---> | 3.3V |
You can change the INT
pin to another one. Default is GPIO4
// Must connect INT to GPIOxx or not working
#define INT_GPIO 4
W5500, W6100 or ENC28J60 | <---> | ESP32_S2 |
---|---|---|
MOSI | <---> | GPIO35 |
MISO | <---> | GPIO37 |
SCK | <---> | GPIO36 |
CS/SS | <---> | GPIO34 |
INT | <---> | GPIO4 |
RST | <---> | RST |
GND | <---> | GND |
3.3V | <---> | 3.3V |
You can change the INT
pin to another one. Default is GPIO4
// Must connect INT to GPIOxx or not working
#define INT_GPIO 10
W5500, W6100 or ENC28J60 | <---> | ESP32_C3 |
---|---|---|
MOSI | <---> | GPIO6 |
MISO | <---> | GPIO5 |
SCK | <---> | GPIO4 |
CS/SS | <---> | GPIO7 |
INT | <---> | GPIO10 |
RST | <---> | RST |
GND | <---> | GND |
3.3V | <---> | 3.3V |
Example AsyncHTTPRequest_ESP32_SC_W5500
Start AsyncHTTPRequest_ESP32_SC_W5500 on ESP32S3_DEV with ESP32_S3_W5500
WebServer_ESP32_SC_W5500 v1.2.1 for core v2.0.0+
AsyncHTTPRequest_ESP32_Ethernet v1.15.0
ETH Started
ETH Connected
ETH MAC: DE:AD:BE:EF:BE:14, IPv4: 192.168.2.89
FULL_DUPLEX, 100Mbps
HTTP WebClient is @ IP : 192.168.2.89
**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-01-31T23:01:30.472515-05:00
day_of_week: 2
day_of_year: 31
dst: false
dst_from:
dst_offset: 0
dst_until:
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675224090
utc_datetime: 2023-02-01T04:01:30.472515+00:00
utc_offset: -05:00
week_number: 5
**************************************
HHHHHH
**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-01-31T23:02:24.463788-05:00
day_of_week: 2
day_of_year: 31
dst: false
dst_from:
dst_offset: 0
dst_until:
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675224144
utc_datetime: 2023-02-01T04:02:24.463788+00:00
utc_offset: -05:00
week_number: 5
**************************************
Start AsyncHTTPRequest_ESP32_SC_ENC on ESP32S3_DEV with ESP32_S3_ENC28J60
WebServer_ESP32_SC_ENC v1.2.1 for core v2.0.0+
AsyncHTTPRequest_ESP32_Ethernet v1.15.0
ETH Started
ETH Connected
ETH MAC: DE:AD:BE:EF:FE:03, IPv4: 192.168.2.125
FULL_DUPLEX, 10Mbps
HTTP WebClient is @ IP : 192.168.2.125
**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-01-31T23:03:24.464007-05:00
day_of_week: 2
day_of_year: 31
dst: false
dst_from:
dst_offset: 0
dst_until:
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675224204
utc_datetime: 2023-02-01T04:03:24.464007+00:00
utc_offset: -05:00
week_number: 5
**************************************
HHHHHH
**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-01-31T23:04:24.464088-05:00
day_of_week: 2
day_of_year: 31
dst: false
dst_from:
dst_offset: 0
dst_until:
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675224264
utc_datetime: 2023-02-01T04:04:24.464088+00:00
utc_offset: -05:00
week_number: 5
**************************************
Start AsyncHTTPRequest_ESP32_W5500 on ESP32_DEV with ESP32_W5500
WebServer_ESP32_W5500 v1.5.3 for core v2.0.0+
AsyncHTTPRequest_ESP32_Ethernet v1.15.0
ETH Started
ETH Connected
ETH MAC: DE:AD:BE:EF:FE:11, IPv4: 192.168.2.101
FULL_DUPLEX, 100Mbps
HTTP WebClient is @ IP : 192.168.2.101
**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-01-31T23:06:24.463935-05:00
day_of_week: 2
day_of_year: 31
dst: false
dst_from:
dst_offset: 0
dst_until:
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675224384
utc_datetime: 2023-02-01T04:06:24.463935+00:00
utc_offset: -05:00
week_number: 5
**************************************
HHHHHH
**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-01-31T23:07:24.465199-05:00
day_of_week: 2
day_of_year: 31
dst: false
dst_from:
dst_offset: 0
dst_until:
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675224444
utc_datetime: 2023-02-01T04:07:24.465199+00:00
utc_offset: -05:00
week_number: 5
**************************************
HHHHHHHHH
Start AsyncHTTPRequest_ESP32_SC_W5500 on ESP32S2_DEV with ESP32_S2_W5500
WebServer_ESP32_SC_W5500 v1.2.1 for core v2.0.0+
AsyncHTTPRequest_ESP32_Ethernet v1.15.0
Using built-in mac_eth = 7E:DF:A1:08:32:C9
ETH Started
ETH Connected
ETH MAC: 7E:DF:A1:08:32:C9, IPv4: 192.168.2.133
FULL_DUPLEX, 100Mbps
HTTP WebClient is @ IP : 192.168.2.133
**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-01-31T23:09:24.464676-05:00
day_of_week: 2
day_of_year: 31
dst: false
dst_from:
dst_offset: 0
dst_until:
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675224564
utc_datetime: 2023-02-01T04:09:24.464676+00:00
utc_offset: -05:00
week_number: 5
**************************************
HH HHHH
**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-01-31T23:10:24.464712-05:00
day_of_week: 2
day_of_year: 31
dst: false
dst_from:
dst_offset: 0
dst_until:
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675224624
utc_datetime: 2023-02-01T04:10:24.464712+00:00
utc_offset: -05:00
week_number: 5
**************************************
Start AsyncHTTPRequest_ESP32_SC_ENC on ESP32C3_DEV with ESP32_C3_ENC28J60
WebServer_ESP32_SC_ENC v1.2.1 for core v2.0.0+
AsyncHTTPRequest_ESP32_Ethernet v1.15.0
Using built-in mac_eth = 7C:DF:A1:DA:66:87
ETH Started
ETH Connected
ETH MAC: 7C:DF:A1:DA:66:87, IPv4: 192.168.2.136
FULL_DUPLEX, 10Mbps
HTTP WebClient is @ IP : 192.168.2.136
**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-01-31T23:12:24.463868-05:00
day_of_week: 2
day_of_year: 31
dst: false
dst_from:
dst_offset: 0
dst_until:
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675224744
utc_datetime: 2023-02-01T04:12:24.463868+00:00
utc_offset: -05:00
week_number: 5
**************************************
HHHH
Start AsyncHTTPRequest_ESP32_W6100 on ESP32_DEV with ESP32_W6100
WebServer_ESP32_W6100 v1.5.3 for core v2.0.0+
AsyncHTTPRequest_ESP32_Ethernet v1.15.0
ETH Started
ETH Connected
ETH MAC: 0C:B8:15:D8:01:D7, IPv4: 192.168.2.158
FULL_DUPLEX, 100Mbps
HTTP WebClient is @ IP : 192.168.2.158
**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-01-31T23:13:24.464322-05:00
day_of_week: 2
day_of_year: 31
dst: false
dst_from:
dst_offset: 0
dst_until:
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675224804
utc_datetime: 2023-02-01T04:13:24.464322+00:00
utc_offset: -05:00
week_number: 5
**************************************
HHHHHH
**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-01-31T23:14:24.465232-05:00
day_of_week: 2
day_of_year: 31
dst: false
dst_from:
dst_offset: 0
dst_until:
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675224864
utc_datetime: 2023-02-01T04:14:24.465232+00:00
utc_offset: -05:00
week_number: 5
**************************************
Start AsyncHTTPRequest_ESP32_SC_W6100 on ESP32S3_DEV with ESP32_S3_W6100
WebServer_ESP32_SC_W6100 v1.2.1 for core v2.0.0+
AsyncHTTPRequest_ESP32_Ethernet v1.15.0
ETH Started
ETH Connected
ETH MAC: FE:ED:DE:AD:BE:EF, IPv4: 192.168.2.92
FULL_DUPLEX, 100Mbps
HTTP WebClient is @ IP : 192.168.2.92
**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-01-31T23:15:24.464696-05:00
day_of_week: 2
day_of_year: 31
dst: false
dst_from:
dst_offset: 0
dst_until:
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675224924
utc_datetime: 2023-02-01T04:15:24.464696+00:00
utc_offset: -05:00
week_number: 5
**************************************
HHHHHH
**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-01-31T23:16:24.464377-05:00
day_of_week: 2
day_of_year: 31
dst: false
dst_from:
dst_offset: 0
dst_until:
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675224984
utc_datetime: 2023-02-01T04:16:24.464377+00:00
utc_offset: -05:00
week_number: 5
**************************************
HHHH
Debug is enabled by default on Serial.
You can also change the debugging level from 0 to 4
#define ASYNC_HTTP_DEBUG_PORT Serial
// Use from 0 to 4. Higher number, more debugging messages and memory usage.
#define _ASYNC_HTTP_LOGLEVEL_ 1
If you get compilation errors, more often than not, you may need to install a newer version of the ESP32
core for Arduino.
Sometimes, the library will only work if you update the ESP32
core to the latest version because I am using newly added functions.
Submit issues to: AsyncHTTPRequest_ESP32_Ethernet issues
- Fix bug. Add enhancement
- Add support to more
LwIP Ethernet
shields
- Initially add support to
ESP32/S2/S3/C3
boards usingLwIP W5500 / ENC28J60 / LAN8720 Ethernet
- Sync with AsyncHTTPRequest_Generic v1.12.0
- Use
allman astyle
and addutils
. Restyle the library - Add support to
ESP32S2/C3
boards usingLwIP W5500 or ENC28J60 Ethernet
- Add support to
ESP32
andESP32S2/S3/C3
boards usingLwIP W6100 Ethernet
- Fix
_parseURL()
bug. Check Bug with _parseURL() #21 - Improve
README.md
so that links can be used in other sites, such asPIO
This library is based on, modified, bug-fixed and improved from:
- Bob Lemaire's asyncHTTPrequest Library to use the better asynchronous features of these following Async TCP Libraries : (
ESPAsyncTCP
,AsyncTCP
, andSTM32AsyncTCP
).
⭐️ Bob Lemaire |
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
- The library is licensed under GPLv3
Copyright (C) <2018> <Bob Lemaire, IoTaWatt, Inc.>
Copyright (C) 2022- Khoi Hoang