AsyncHTTPSRequest_ESP32_Ethernet Library

Table of Contents

Why do we need this AsyncHTTPSRequest_ESP32_Ethernet library
- Important notes for WT32_ETH01
- Features
- Supports
- Principles of operation
- Currently supported Boards
- To-be supported Boards
Changelog
Prerequisites
Installation
- Use Arduino Library Manager
- Manual Install
- VS Code & PlatformIO
Note for Platform IO using ESP32 LittleFS
HOWTO Fix Multiple Definitions Linker Error
HOWTO Use analogRead() with ESP32 running WiFi and/or BlueTooth (BT/BLE)
- 1. ESP32 has 2 ADCs, named ADC1 and ADC2
- 2. ESP32 ADCs functions
- 3. ESP32 WiFi uses ADC2 for WiFi functions
How to connect W5500, W6100 or ENC28J60 to ESP32_S2/S3/C3
Examples
- For WT32_ETH01
  - 1. AsyncHTTPSRequest_WT32_ETH01
- For ESP32_ENC
  - 1. AsyncHTTPSRequest_ESP32_ENC
- For ESP32_W5500
  - 1. AsyncHTTPSRequest_ESP32_W5500
- For ESP32_W6100
  - 1. AsyncHTTPSRequest_ESP32_W6100
- For ESP32_SC_ENC
  - 1. AsyncHTTPSRequest_ESP32_SC_ENC
- For ESP32_SC_W5500
  - 1. AsyncHTTPSRequest_ESP32_SC_W5500
- For ESP32_SC_W6100
  - 1. AsyncHTTPSRequest_ESP32_SC_W6100
- For ESP32
  - 1. multiFileProject
Example AsyncHTTPSRequest_ESP32_SC_W5500
Debug Terminal Output Samples
- 1. AsyncHTTPSRequest_ESP32_SC_W5500 using ESP32S3_DEV with ESP32_S3_W5500
- 2. AsyncHTTPSRequest_ESP32_SC_ENC using ESP32S3_DEV with ESP32_S3_ENC28J60
- 3. AsyncHTTPSRequest_ESP32_W5500 using ESP32_DEV with ESP32_W5500
- 4. AsyncHTTPSRequest_ESP32_ENC using ESP32_DEV with ESP32_ENC28J60
- 5. AsyncHTTPSRequest_ESP32_SC_W5500 using ESP32C3_DEV with ESP32_C3_W5500
- 6. AsyncHTTPSRequest_ESP32_SC_ENC using ESP32C3_DEV with ESP32_C3_ENC28J60
- 7. AsyncHTTPSRequest_ESP32_SC_W5500 using ESP32S2_DEV with ESP32_S2_W5500
- 8. AsyncHTTPSRequest_ESP32_SC_W6100 using ESP32S3_DEV with ESP32_S3_W6100
- 9. AsyncHTTPSRequest_ESP32_W6100 using ESP32_DEV with ESP32_W6100
Debug
Troubleshooting
Issues
TO DO
DONE
Contributions and Thanks
Contributing
License and credits
Copyright

Why do we need this AsyncHTTPSRequest_ESP32_Ethernet library

Important notes for WT32_ETH01

ESP32 Core v2.0.0+ introduces new enum breaking almost all WT32_ETH01 codes written for core v1.0.6-.

It's really strange to define a breaking enum arduino_event_id_t in WiFiGeneric.h#L36-L78, compared to the old system_event_id_t, now placed in esp_event_legacy.h#L29-L63

It's better to preserve the old enum order and just adding new items to do no harm to pre-2.0.0 codes

WebServer_WT32_ETH01 Releases v1.2.0-** to be used for EP32 core v1.0.6- only
WebServer_WT32_ETH01 Releases v1.3.0+** can be used for either EP32 core v2.0.0+ or v1.0.6-. Default is using core v2.0.0+

To use with core v1.0.6-, just define in your sketch

#define USING_CORE_ESP32_CORE_V200_PLUS       false

WebServer_WT32_ETH01 Releases v1.4.0+** can be used for either ESP32 core v2.0.0+ or v1.0.6-. Autodetect core

Features

Asynchronous HTTPS Request library for ESP32, ESP32_S2, ESP32_C3, ESP32_S3, WT32_ETH01 using LwIP ENC28J60, W5500 or LAN8720
Providing a subset of HTTPS.
Relying on AsyncTCP_SSL library for ESP32
Methods similar in format and usage to XmlHTTPrequest in Javascript.
Coexist with AsyncHTTPRequest library to permit sending HTTP / HTTPS requests to multiple addresses and receive responses from them

Supports

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.

Principles of operation

This library adds a simple HTTPS layer on top of the AsyncTCP_SSL 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:

Currently Supported Boards

1. ESP32 using LwIP ENC28J60, W5500, W6100 or LAN8720

ESP32 (ESP32-DEV, etc.)

2. WT32_ETH01 using ESP32-based boards and LAN8720 Ethernet

3. ESP32S3 using LwIP W5500, W6100 or ENC28J60

ESP32-S3 (ESP32S3_DEV, ESP32_S3_BOX, UM TINYS3, UM PROS3, UM FEATHERS3, etc.)

4. ESP32S2 using LwIP W5500, W6100 or ENC28J60

ESP32-S2 (ESP32S2_DEV, etc.)

5. ESP32C3 using LwIP W5500, W6100 or ENC28J60

ESP32-C3 (ESP32C3_DEV, etc.)

ESP32S3_DEV

ESP32S2_DEV

ESP32C3_DEV

W6100

FULL_DUPLEX, 100Mbps

W5500

FULL_DUPLEX, 100Mbps

ENC28J60

FULL_DUPLEX, 10Mbps

To-be Supported Boards

1. New ESP32 using LwIP W5500, W6100 or ENC28J60

Prerequisites

Arduino IDE 1.8.19+ for Arduino.
ESP32 Core 2.0.6+ for ESP32-based boards. [Latest stable release
AsyncTCP_SSL v1.3.1+ for ESP32.
WebServer_WT32_ETH01 v1.5.1+ for ESP32-based WT32_ETH01 using either ESP32 core v2.0.0+ or v1.0.6-.
WebServer_ESP32_ENC library v1.5.3+ if necessary to use ESP32 boards using LwIP ENC28J60 Ethernet. To install, check
WebServer_ESP32_W5500 library v1.5.3+ if necessary to use ESP32 boards using LwIP W5500 Ethernet. To install, check
WebServer_ESP32_SC_ENC library v1.2.1+ if necessary to use ESP32_S2/S3/C3 boards using LwIP ENC28J60 Ethernet. To install, check
WebServer_ESP32_SC_W5500 library v1.2.1+ if necessary to use ESP32_S2/S3/C3 boards using LwIP W5500 Ethernet. To install, check
WebServer_ESP32_W6100 library v1.5.3+ if necessary to use ESP32 boards using LwIP W6100 Ethernet. To install, check
WebServer_ESP32_SC_W6100 library v1.2.1+ if necessary to use ESP32_S2/S3/C3 boards using LwIP W6100 Ethernet. To install, check

Installation

Use Arduino Library Manager

The best and easiest way is to use Arduino Library Manager. Search for AsyncHTTPSRequest_ESP32_Ethernet, then select / install the latest version. You can also use this link for more detailed instructions.

Manual Install

Navigate to AsyncHTTPSRequest_ESP32_Ethernet page.
Download the latest release AsyncHTTPSRequest_ESP32_Ethernet-main.zip.
Extract the zip file to AsyncHTTPSRequest_ESP32_Ethernet-main directory
Copy the whole AsyncHTTPSRequest_ESP32_Ethernet-main folder to Arduino libraries' directory such as ~/Arduino/libraries/.

VS Code & PlatformIO

Install VS Code
Install PlatformIO
Install AsyncHTTPSRequest_ESP32_Ethernet library by using Library Manager. Search for AsyncHTTPSRequest_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

Note for Platform IO using ESP32 LittleFS

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'

HOWTO Fix `Multiple Definitions` Linker Error

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 "AsyncHTTPSRequest_ESP32_Ethernet.hpp"     //https://github.com/khoih-prog/AsyncHTTPSRequest_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 "AsyncHTTPSRequest_ESP32_Ethernet.h"           //https://github.com/khoih-prog/AsyncHTTPSRequest_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

HOWTO Use analogRead() with ESP32 running WiFi and/or BlueTooth (BT/BLE)

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.

1. ESP32 has 2 ADCs, named ADC1 and ADC2

2. ESP32 ADCs functions

ADC1 controls ADC function for pins GPIO32-GPIO39
ADC2 controls ADC function for pins GPIO0, 2, 4, 12-15, 25-27

3.. ESP32 WiFi uses ADC2 for WiFi functions

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).

How to connect W5500, W6100 or ENC28J60 to ESP32_S2/S3/C3

W6100

FULL_DUPLEX, 100Mbps

W5500

FULL_DUPLEX, 100Mbps

ENC28J60

FULL_DUPLEX, 10Mbps

ESP32S3_DEV

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

ESP32S2_DEV

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

ESP32C3_DEV

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

Examples

For WT32_ETH01

AsyncHTTPSRequest_WT32_ETH01

For ESP32_ENC

AsyncHTTPSRequest_ESP32_ENC

For ESP32_W5500

AsyncHTTPSRequest_ESP32_W5500

Lines 43 to 302 in 59238ae

    
           #if !defined(ESP32) 
        
             #error This AsyncHTTPSRequest_ESP32_Ethernet library is currently supporting only ESP32 using LwIP Ethernet 
        
           #endif 
        
           #define ASYNC_HTTPS_REQUEST_ESP32_ETHERNET_VERSION_MIN_TARGET      "AsyncHTTPSRequest_ESP32_Ethernet v2.7.0" 
        
           #define ASYNC_HTTPS_REQUEST_ESP32_ETHERNET_VERSION_MIN             2007000 
        
           ///////////////////////////////////////////////////////// 
        
           // Uncomment for certain HTTP site to optimize 
        
           //#define NOT_SEND_HEADER_AFTER_CONNECTED        true 
        
           // Use larger queue size if necessary for large data transfer. Default is 512 bytes if not defined here 
        
           //#define ASYNC_QUEUE_LENGTH     512 
        
           // Use larger priority if necessary. Default is 10 if not defined here. Must be > 4 or adjusted to 4 
        
           //#define CONFIG_ASYNC_TCP_PRIORITY   (12) 
        
           ///////////////////////////////////////////////////////// 
        
           // Level from 0-4 
        
           #define ASYNC_HTTPS_DEBUG_PORT          Serial 
        
           #define _ASYNC_TCP_SSL_LOGLEVEL_        1 
        
           #define _ASYNC_HTTPS_LOGLEVEL_          2 
        
           #define _ETHERNET_WEBSERVER_LOGLEVEL_   1 
        
           // 300s = 5 minutes to not flooding 
        
           #define HTTPS_REQUEST_INTERVAL      60  //300 
        
           // 10s 
        
           #define HEARTBEAT_INTERVAL          10 
        
           // Uncomment to use ESP32 core v1.0.6- 
        
           //#define USING_CORE_ESP32_CORE_V200_PLUS     false 
        
           ////////////////////////////////////////////////////////// 
        
           // For ESP32-S3 
        
           // Optional values to override default settings 
        
           //#define ETH_SPI_HOST        SPI2_HOST 
        
           //#define SPI_CLOCK_MHZ       25 
        
           // Must connect INT to GPIOxx or not working 
        
           //#define INT_GPIO            4 
        
           //#define MISO_GPIO           13 
        
           //#define MOSI_GPIO           11 
        
           //#define SCK_GPIO            12 
        
           //#define CS_GPIO             10 
        
           // For ESP32_C3 
        
           // Optional values to override default settings 
        
           // Don't change unless you know what you're doing 
        
           //#define ETH_SPI_HOST        SPI2_HOST 
        
           //#define SPI_CLOCK_MHZ       25 
        
           // Must connect INT to GPIOxx or not working 
        
           //#define INT_GPIO            10 
        
           //#define MISO_GPIO           5 
        
           //#define MOSI_GPIO           6 
        
           //#define SCK_GPIO            4 
        
           //#define CS_GPIO             7 
        
           ////////////////////////////////////////////////////////// 
        
           #include <WebServer_ESP32_SC_W5500.h>               // https://github.com/khoih-prog/WebServer_ESP32_SC_W5500 
        
           // To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error 
        
           #include <AsyncHTTPSRequest_ESP32_Ethernet.h>       // https://github.com/khoih-prog/AsyncHTTPSRequest_ESP32_Ethernet 
        
           #include <Ticker.h> 
        
           AsyncHTTPSRequest request; 
        
           Ticker ticker; 
        
           Ticker ticker1; 
        
           ///////////////////////////////////////////// 
        
           // Enter a MAC address and IP address for your controller below. 
        
           #define NUMBER_OF_MAC      20 
        
           byte mac[][NUMBER_OF_MAC] = 
        
           { 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x01 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x02 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x03 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x04 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x05 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x06 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x07 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x08 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x09 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x0A }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x0B }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x0C }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x0D }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x0E }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x0F }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x10 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x11 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x12 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0x13 }, 
        
             { 0xDE, 0xAD, 0xBE, 0xEF, 0xBE, 0x14 }, 
        
           }; 
        
           // Select the IP address according to your local network 
        
           IPAddress myIP(192, 168, 2, 232); 
        
           IPAddress myGW(192, 168, 2, 1); 
        
           IPAddress mySN(255, 255, 255, 0); 
        
           // Google DNS Server IP 
        
           IPAddress myDNS(8, 8, 8, 8); 
        
           ///////////////////////////////////////////// 
        
           void heartBeatPrint() 
        
           { 
        
             static int num = 1; 
        
             if (ESP32_W5500_isConnected()) 
        
               Serial.print(F("H"));        // H means connected 
        
             else 
        
               Serial.print(F("F"));        // F means not connected 
        
             if (num == 80) 
        
             { 
        
               Serial.println(); 
        
               num = 1; 
        
             } 
        
             else if (num++ % 10 == 0) 
        
             { 
        
               Serial.print(F(" ")); 
        
             } 
        
           } 
        
           void sendRequest() 
        
           { 
        
             static bool requestOpenResult; 
        
             if (request.readyState() == readyStateUnsent || request.readyState() == readyStateDone) 
        
             { 
        
               //requestOpenResult = request.open("GET", "https://worldtimeapi.org/api/timezone/Europe/London.txt"); 
        
               requestOpenResult = request.open("GET", "https://worldtimeapi.org/api/timezone/America/Toronto.txt"); 
        
               if (requestOpenResult) 
        
               { 
        
                 // Only send() if open() returns true, or crash 
        
                 request.send(); 
        
               } 
        
               else 
        
               { 
        
                 Serial.println(F("Can't send bad request")); 
        
               } 
        
             } 
        
             else 
        
             { 
        
               Serial.println(F("Can't send request")); 
        
             } 
        
           } 
        
           void requestCB(void *optParm, AsyncHTTPSRequest *request, int readyState) 
        
           { 
        
             (void) optParm; 
        
             if (readyState == readyStateDone) 
        
             { 
        
               AHTTPS_LOGDEBUG0(F("\n**************************************\n")); 
        
               AHTTPS_LOGDEBUG1(F("Response Code = "), request->responseHTTPString()); 
        
               if (request->responseHTTPcode() == 200) 
        
               { 
        
                 Serial.println(F("\n**************************************")); 
        
                 Serial.println(request->responseText()); 
        
                 Serial.println(F("**************************************")); 
        
               } 
        
               request->setDebug(false); 
        
             } 
        
           } 
        
           void setup() 
        
           { 
        
             // put your setup code here, to run once: 
        
             Serial.begin(115200); 
        
             while (!Serial && millis() < 5000); 
        
             delay(500); 
        
             Serial.print(F("\nStarting AsyncHTTPSRequest_ESP32_SC_W5500 using ")); 
        
             Serial.print(ARDUINO_BOARD); 
        
             Serial.print(F(" with ")); 
        
             Serial.println(SHIELD_TYPE); 
        
             Serial.println(WEBSERVER_ESP32_SC_W5500_VERSION); 
        
             Serial.println(ASYNC_TCP_SSL_VERSION); 
        
             Serial.println(ASYNC_HTTPS_REQUEST_ESP32_ETHERNET_VERSION); 
        
             Serial.setDebugOutput(true); 
        
           #if defined(ASYNC_HTTPS_REQUEST_ESP32_ETHERNET_VERSION_MIN) 
        
             if (ASYNC_HTTPS_REQUEST_ESP32_ETHERNET_VERSION_INT < ASYNC_HTTPS_REQUEST_ESP32_ETHERNET_VERSION_MIN) 
        
             { 
        
               Serial.print(F("Warning. Must use this example on Version equal or later than : ")); 
        
               Serial.println(ASYNC_HTTPS_REQUEST_ESP32_ETHERNET_VERSION_MIN_TARGET); 
        
             } 
        
           #endif 
        
             AHTTPS_LOGWARN(F("Default SPI pinout:")); 
        
             AHTTPS_LOGWARN1(F("SPI_HOST:"), ETH_SPI_HOST); 
        
             AHTTPS_LOGWARN1(F("MOSI:"), MOSI_GPIO); 
        
             AHTTPS_LOGWARN1(F("MISO:"), MISO_GPIO); 
        
             AHTTPS_LOGWARN1(F("SCK:"),  SCK_GPIO); 
        
             AHTTPS_LOGWARN1(F("CS:"),   CS_GPIO); 
        
             AHTTPS_LOGWARN1(F("INT:"),  INT_GPIO); 
        
             AHTTPS_LOGWARN1(F("SPI Clock (MHz):"), SPI_CLOCK_MHZ); 
        
             AHTTPS_LOGWARN(F("=========================")); 
        
             /////////////////////////////////// 
        
             // To be called before ETH.begin() 
        
             ESP32_W5500_onEvent(); 
        
             // start the ethernet connection and the server: 
        
             // Use DHCP dynamic IP and random mac 
        
             uint16_t index = millis() % NUMBER_OF_MAC; 
        
             //bool begin(int MISO_GPIO, int MOSI_GPIO, int SCLK_GPIO, int CS_GPIO, int INT_GPIO, int SPI_CLOCK_MHZ, 
        
             //           int SPI_HOST, uint8_t *W5500_Mac = W5500_Default_Mac); 
        
             //ETH.begin( MISO_GPIO, MOSI_GPIO, SCK_GPIO, CS_GPIO, INT_GPIO, SPI_CLOCK_MHZ, ETH_SPI_HOST ); 
        
             ETH.begin( MISO_GPIO, MOSI_GPIO, SCK_GPIO, CS_GPIO, INT_GPIO, SPI_CLOCK_MHZ, ETH_SPI_HOST, mac[index] ); 
        
             // Static IP, leave without this line to get IP via DHCP 
        
             //bool config(IPAddress local_ip, IPAddress gateway, IPAddress subnet, IPAddress dns1 = 0, IPAddress dns2 = 0); 
        
             //ETH.config(myIP, myGW, mySN, myDNS); 
        
             ESP32_W5500_waitForConnect(); 
        
             /////////////////////////////////// 
        
             Serial.print(F("\nHTTP WebClient is @ IP : ")); 
        
             Serial.println(ETH.localIP()); 
        
             request.setDebug(false); 
        
             request.onReadyStateChange(requestCB); 
        
             ticker.attach(HTTPS_REQUEST_INTERVAL, sendRequest); 
        
             ticker1.attach(HEARTBEAT_INTERVAL, heartBeatPrint); 
        
             // Send first request now 
        
             sendRequest(); 
        
           } 
        
           void loop() 
        
           { 
        
           }

Debug Terminal Output Samples

1. AsyncHTTPSRequest_ESP32_SC_W5500 using ESP32S3_DEV with ESP32_S3_W5500

Following is the debug terminal when running example AsyncHTTPSRequest_ESP32_SC_W5500 on ESP32S3_DEV to demonstrate the operation of SSL Async HTTPS request, using AsyncTCP_SSL Library with LwIP W5500 Ethernet

Starting AsyncHTTPSRequest_ESP32_SC_W5500 using ESP32S3_DEV with ESP32_S3_W5500
WebServer_ESP32_SC_W5500 v1.2.1 for core v2.0.0+
AsyncTCP_SSL v1.3.1
AsyncHTTPSRequest_ESP32_Ethernet v2.7.0
[AHTTPS] Default SPI pinout:
[AHTTPS] SPI_HOST: 2
[AHTTPS] MOSI: 11
[AHTTPS] MISO: 13
[AHTTPS] SCK: 12
[AHTTPS] CS: 10
[AHTTPS] INT: 4
[AHTTPS] SPI Clock (MHz): 25
[AHTTPS] =========================

ETH Started
ETH Connected
ETH MAC: DE:AD:BE:EF:FE:01, IPv4: 192.168.2.95
FULL_DUPLEX, 100Mbps

HTTP WebClient is @ IP : 192.168.2.95

**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-02-01T14:22:06.740570-05:00
day_of_week: 3
day_of_year: 32
dst: false
dst_from: 
dst_offset: 0
dst_until: 
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675279326
utc_datetime: 2023-02-01T19:22:06.740570+00:00
utc_offset: -05:00
week_number: 5
**************************************

2. AsyncHTTPSRequest_ESP32_SC_ENC using ESP32S3_DEV with ESP32_S3_ENC28J60

Following is the debug terminal when running example AsyncHTTPSRequest_ESP32_SC_ENC on ESP32S3_DEV to demonstrate the operation of SSL Async HTTPS request, using AsyncTCP_SSL Library with LwIP ENC28J60 Ethernet

Starting AsyncHTTPSRequest_ESP32_SC_ENC using ESP32S3_DEV with ESP32_S3_ENC28J60
WebServer_ESP32_SC_ENC v1.2.1 for core v2.0.0+
AsyncTCP_SSL v1.3.1
AsyncHTTPSRequest_ESP32_Ethernet v2.7.0
[AHTTPS] Default SPI pinout:
[AHTTPS] SPI_HOST: 1
[AHTTPS] MOSI: 11
[AHTTPS] MISO: 13
[AHTTPS] SCK: 12
[AHTTPS] CS: 10
[AHTTPS] INT: 4
[AHTTPS] SPI Clock (MHz): 8
[AHTTPS] =========================

ETH Started
ETH Connected
ETH MAC: DE:AD:BE:EF:BE:04, IPv4: 192.168.2.105
FULL_DUPLEX, 10Mbps

HTTP WebClient is @ IP : 192.168.2.105

**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-02-01T14:23:04.735327-05:00
day_of_week: 3
day_of_year: 32
dst: false
dst_from: 
dst_offset: 0
dst_until: 
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675279384
utc_datetime: 2023-02-01T19:23:04.735327+00:00
utc_offset: -05:00
week_number: 5
**************************************

3. AsyncHTTPSRequest_ESP32_W5500 using ESP32_DEV with ESP32_W5500

Following is the debug terminal when running example AsyncHTTPSRequest_ESP32_W5500 on ESP32_DEV to demonstrate the operation of SSL Async HTTPS request, using AsyncTCP_SSL Library with LwIP W5500 Ethernet

Starting AsyncHTTPSRequest_ESP32_W5500 using ESP32_DEV with ESP32_W5500
WebServer_ESP32_W5500 v1.5.3 for core v2.0.0+
AsyncTCP_SSL v1.3.1
AsyncHTTPSRequest_ESP32_Ethernet v2.7.0
[AHTTPS] Default SPI pinout:
[AHTTPS] SPI_HOST: 2
[AHTTPS] MOSI: 11
[AHTTPS] MISO: 13
[AHTTPS] SCK: 12
[AHTTPS] CS: 10
[AHTTPS] INT: 4
[AHTTPS] SPI Clock (MHz): 25
[AHTTPS] =========================

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-02-01T14:25:04.735194-05:00
day_of_week: 3
day_of_year: 32
dst: false
dst_from: 
dst_offset: 0
dst_until: 
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675279504
utc_datetime: 2023-02-01T19:25:04.735194+00:00
utc_offset: -05:00
week_number: 5
**************************************

4. AsyncHTTPSRequest_ESP32_ENC using ESP32_DEV with ESP32_ENC28J60

Following is the debug terminal when running example AsyncHTTPSRequest_ESP32_ENC on ESP32_DEV to demonstrate the operation of SSL Async HTTPS request, using AsyncTCP_SSL Library, with LwIP ENC28J60 Ethernet

Starting AsyncHTTPSRequest_ESP32_ENC using ESP32_DEV with ESP32_ENC28J60
WebServer_ESP32_ENC v1.5.3 for core v2.0.0+
AsyncTCP_SSL v1.3.1
AsyncHTTPSRequest_ESP32_Ethernet v2.7.0
[AHTTPS] Default SPI pinout:
[AHTTPS] SPI_HOST: 1
[AHTTPS] MOSI: 11
[AHTTPS] MISO: 13
[AHTTPS] SCK: 12
[AHTTPS] CS: 10
[AHTTPS] INT: 4
[AHTTPS] SPI Clock (MHz): 8
[AHTTPS] =========================

ETH Started
ETH Connected
ETH MAC: 0C:B8:15:D8:01:D7, IPv4: 192.168.2.158
FULL_DUPLEX, 10Mbps

HTTP WebClient is @ IP : 192.168.2.158

**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-02-01T14:26:04.735728-05:00
day_of_week: 3
day_of_year: 32
dst: false
dst_from: 
dst_offset: 0
dst_until: 
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675279564
utc_datetime: 2023-02-01T19:26:04.735728+00:00
utc_offset: -05:00
week_number: 5
**************************************

5. AsyncHTTPSRequest_ESP32_SC_W5500 using ESP32C3_DEV with ESP32_C3_W5500

Following is the debug terminal when running example AsyncHTTPSRequest_ESP32_SC_W5500 on ESP32C3_DEV to demonstrate the operation of SSL Async HTTPS request, using AsyncTCP_SSL Library, with LwIP W5500 Ethernet

Starting AsyncHTTPSRequest_ESP32_SC_W5500 using ESP32C3_DEV with ESP32_C3_W5500
WebServer_ESP32_SC_W5500 v1.2.1 for core v2.0.0+
AsyncTCP_SSL v1.3.1
AsyncHTTPSRequest_ESP32_Ethernet v2.7.0
[AHTTPS] Default SPI pinout:
[AHTTPS] SPI_HOST: 1
[AHTTPS] MOSI: 6
[AHTTPS] MISO: 5
[AHTTPS] SCK: 4
[AHTTPS] CS: 7
[AHTTPS] INT: 10
[AHTTPS] SPI Clock (MHz): 25
[AHTTPS] =========================
Using built-in mac_eth = 7C:DF:A1:BC:BC:53

ETH Started
ETH Connected
ETH MAC: 7C:DF:A1:BC:BC:53, IPv4: 192.168.2.135
FULL_DUPLEX, 100Mbps

HTTP WebClient is @ IP : 192.168.2.135

**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-02-01T14:27:04.739237-05:00
day_of_week: 3
day_of_year: 32
dst: false
dst_from: 
dst_offset: 0
dst_until: 
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675279624
utc_datetime: 2023-02-01T19:27:04.739237+00:00
utc_offset: -05:00
week_number: 5
**************************************
HHHHHH
**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-02-01T14:28:04.735068-05:00
day_of_week: 3
day_of_year: 32
dst: false
dst_from: 
dst_offset: 0
dst_until: 
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675279684
utc_datetime: 2023-02-01T19:28:04.735068+00:00
utc_offset: -05:00
week_number: 5
**************************************

6. AsyncHTTPSRequest_ESP32_SC_ENC using ESP32C3_DEV with ESP32_C3_ENC28J60

Following is the debug terminal when running example AsyncHTTPSRequest_ESP32_SC_ENC on ESP32C3_DEV to demonstrate the operation of SSL Async HTTPS request, using AsyncTCP_SSL Library, with LwIP ENC28J60 Ethernet

Starting AsyncHTTPSRequest_ESP32_SC_ENC using ESP32C3_DEV with ESP32_C3_ENC28J60
WebServer_ESP32_SC_ENC v1.2.1 for core v2.0.0+
AsyncTCP_SSL v1.3.1
AsyncHTTPSRequest_ESP32_Ethernet v2.7.0
[AHTTPS] Default SPI pinout:
[AHTTPS] SPI_HOST: 1
[AHTTPS] MOSI: 6
[AHTTPS] MISO: 5
[AHTTPS] SCK: 4
[AHTTPS] CS: 7
[AHTTPS] INT: 10
[AHTTPS] SPI Clock (MHz): 8
[AHTTPS] =========================
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-02-01T14:29:06.367282-05:00
day_of_week: 3
day_of_year: 32
dst: false
dst_from: 
dst_offset: 0
dst_until: 
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675279746
utc_datetime: 2023-02-01T19:29:06.367282+00:00
utc_offset: -05:00
week_number: 5
**************************************

7. AsyncHTTPSRequest_ESP32_SC_W5500 using ESP32S2_DEV with ESP32_S2_W5500

Following is the debug terminal when running example AsyncHTTPSRequest_ESP32_SC_W5500 on ESP32S2_DEV to demonstrate the operation of SSL Async HTTPS request, using AsyncTCP_SSL Library, with LwIP W5500 Ethernet

Starting AsyncHTTPSRequest_ESP32_SC_W5500 using ESP32S2_DEV with ESP32_S2_W5500
WebServer_ESP32_SC_W5500 v1.2.1 for core v2.0.0+
AsyncTCP_SSL v1.3.1
AsyncHTTPSRequest_ESP32_Ethernet v2.7.0
[AHTTPS] Default SPI pinout:
[AHTTPS] SPI_HOST: 2
[AHTTPS] MOSI: 35
[AHTTPS] MISO: 37
[AHTTPS] SCK: 36
[AHTTPS] CS: 34
[AHTTPS] INT: 4
[AHTTPS] SPI Clock (MHz): 25
[AHTTPS] =========================
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-02-01T14:31:00.753296-05:00
day_of_week: 3
day_of_year: 32
dst: false
dst_from: 
dst_offset: 0
dst_until: 
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675279860
utc_datetime: 2023-02-01T19:31:00.753296+00:00
utc_offset: -05:00
week_number: 5
**************************************

8. AsyncHTTPSRequest_ESP32_SC_W6100 using ESP32S3_DEV with ESP32_S3_W6100

Following is the debug terminal when running example AsyncHTTPSRequest_ESP32_SC_W6100 on ESP32S3_DEV to demonstrate the operation of SSL Async HTTPS request, using AsyncTCP_SSL Library, with LwIP W6100 Ethernet

Starting AsyncHTTPSRequest_ESP32_SC_W6100 using ESP32S3_DEV with ESP32_S3_W6100
WebServer_ESP32_SC_W6100 v1.2.1 for core v2.0.0+
AsyncTCP_SSL v1.3.1
AsyncHTTPSRequest_ESP32_Ethernet v2.7.0
[AHTTPS] Default SPI pinout:
[AHTTPS] SPI_HOST: 2
[AHTTPS] MOSI: 11
[AHTTPS] MISO: 13
[AHTTPS] SCK: 12
[AHTTPS] CS: 10
[AHTTPS] INT: 4
[AHTTPS] SPI Clock (MHz): 25
[AHTTPS] =========================

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-02-01T14:32:00.755448-05:00
day_of_week: 3
day_of_year: 32
dst: false
dst_from: 
dst_offset: 0
dst_until: 
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675279920
utc_datetime: 2023-02-01T19:32:00.755448+00:00
utc_offset: -05:00
week_number: 5
**************************************
HHHHHH
**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2023-02-01T14:33:00.754918-05:00
day_of_week: 3
day_of_year: 32
dst: false
dst_from: 
dst_offset: 0
dst_until: 
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675279980
utc_datetime: 2023-02-01T19:33:00.754918+00:00
utc_offset: -05:00
week_number: 5
**************************************

9. AsyncHTTPSRequest_ESP32_W6100 using ESP32_DEV with ESP32_W6100

Following is the debug terminal when running example AsyncHTTPSRequest_ESP32_W6100 on ESP32_DEV to demonstrate the operation of SSL Async HTTPS request, using AsyncTCP_SSL Library, with LwIP W6100 Ethernet

Starting AsyncHTTPSRequest_ESP32_W6100 using ESP32_DEV with ESP32_W6100
WebServer_ESP32_W6100 v1.5.3 for core v2.0.0+
AsyncTCP_SSL v1.3.1
AsyncHTTPSRequest_ESP32_Ethernet v2.7.0
[AHTTPS] Default SPI pinout:
[AHTTPS] SPI_HOST: 2
[AHTTPS] MOSI: 23
[AHTTPS] MISO: 19
[AHTTPS] SCK: 18
[AHTTPS] CS: 5
[AHTTPS] INT: 4
[AHTTPS] SPI Clock (MHz): 25
[AHTTPS] =========================

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-02-01T14:35:00.755933-05:00
day_of_week: 3
day_of_year: 32
dst: false
dst_from: 
dst_offset: 0
dst_until: 
raw_offset: -18000
timezone: America/Toronto
unixtime: 1675280100
utc_datetime: 2023-02-01T19:35:00.755933+00:00
utc_offset: -05:00
week_number: 5
**************************************

Debug

Debug is enabled by default on Serial.

You can also change the debugging level from 0 to 4

#define ASYNC_HTTPS_DEBUG_PORT          Serial

// Use from 0 to 4. Higher number, more debugging messages and memory usage.
#define _ASYNC_TCP_SSL_LOGLEVEL_        1
#define _ASYNC_HTTPS_LOGLEVEL_          2

Troubleshooting

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.

Issues

Submit issues to: AsyncHTTPSRequest_ESP32_Ethernet issues

TO DO

Fix bug. Add enhancement
Add support to more LwIP Ethernet shields

DONE

Initially add support to ESP32/S2/S3/C3 boards using LwIP W5500 / ENC28J60 / LAN8720 Ethernet
Sync with AsyncHTTPSRequest_Generic v2.4.0
Use allman astyle and add utils. Restyle the library
Add support to ESP32S2/C3 boards using LwIP W5500 or ENC28J60 Ethernet
Add support to ESP32 and ESP32S2/S3/C3 boards using LwIP W6100 Ethernet
Fix wrong reqStates bug. Check Callback behavior buggy #19
Fix _parseURL() bug. Check Bug with _parseURL() #21
Improve README.md so that links can be used in other sites, such as PIO

Contributions and Thanks

This library is based on, modified, bug-fixed and improved from:

Bob Lemaire's asyncHTTPrequest Library to use the better asynchronous features of the following Async SSL TCP Libraries : ( AsyncTCP_SSL ).

_{⭐️ Bob Lemaire}

Contributing

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

License and credits

The library is licensed under GPLv3

Copyright

Copyright (C) <2018> <Bob Lemaire, IoTaWatt, Inc.>

Copyright (C) 2022- Khoi Hoang

License

khoih-prog/AsyncHTTPSRequest_ESP32_Ethernet

ErrorLooks like something went wrong!

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 4

Packages 0

Uh oh!

Languages

Error
Looks like something went wrong!

Packages