AsyncHTTPRequest_Generic

Table of Contents

• Important Change from v1.6.0
• Why do we need the new Async AsyncHTTPRequest_Generic library
  • Features
  • Supports
  • Principles of operation
  • Currently supported Boards
• Changelog
• Prerequisites
• Installation
  • Use Arduino Library Manager
  • Manual Install
  • VS Code & PlatformIO
• Packages' Patches
  • 1. For STM32 boards to use LAN8720
  • 2. For STM32 boards to use Serial1
• 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)
  • 1. ESP32 has 2 ADCs, named ADC1 and ADC2
  • 2. ESP32 ADCs functions
  • 3. ESP32 WiFi uses ADC2 for WiFi functions
• HOWTO use STM32F4 with LAN8720
  • 1. Wiring
  • 2. HOWTO program using STLink V-2 or V-3
  • 3. HOWTO use Serial Port for Debugging
• HOWTO use ESP8266 with W5x00 Ethernet
  • 1. ESP8266 Wiring
• Examples
  • For ESP32 and ESP8266
    • 1. AsyncHTTPRequest_ESP
    • 2. AsyncHTTPRequest_ESP_WiFiManager
    • 3. AsyncHTTPMultiRequests_ESP
    • 4. AsyncHTTPRequest_ESP_Multi New
    • 5. AsyncHTTPRequest_ESP8266_Ethernet New
  • For STM32 using LAN8742A
    • 1. AsyncHTTPRequest_STM32
    • 2. AsyncCustomHeader_STM32
    • 3. AsyncDweetGet_STM32
    • 4. AsyncDweetPost_STM32
    • 5. AsyncSimpleGET_STM32
    • 6. AsyncWebClientRepeating_STM32
  • For WT32_ETH01
    • 1. AsyncHTTPRequest_WT32_ETH01
    • 2. AsyncHTTPMultiRequests_WT32_ETH01
  • For ESP or STM32
    • 1. multiFileProject New
• Example AsyncHTTPRequest_STM32
  • 1. File AsyncHTTPRequest_STM32.ino
  • 2. File defines.h
• Debug Terminal Output Samples
  • 1. AsyncHTTPRequest_STM32 running on STM32F7 Nucleo-144 NUCLEO_F767ZI using built-in LAN8742A
  • 2. AsyncHTTPRequest_ESP_WiFiManager running on ESP8266_NODEMCU
  • 3. AsyncHTTPRequest_ESP_WiFiManager running on ESP32_DEV
  • 4. AsyncHTTPRequest_ESP running on ESP8266_NODEMCU
  • 5. AsyncWebClientRepeating_STM32 running on STM32F7 Nucleo-144 NUCLEO_F767ZI using built-in LAN8742A
  • 6. AsyncHTTPRequest_WT32_ETH01 on ESP32_DEV with ETH_PHY_LAN8720
  • 7. AsyncHTTPRequest_ESP_WiFiManager running on ESP32C3_DEV New
  • 8. AsyncHTTPRequest_ESP_WiFiManager running on ESP32S3_DEV New
  • 9. AsyncHTTPRequest_ESP_Multi running on ESP32_DEV New
  • 10. AsyncHTTPRequest_ESP8266_Ethernet running on ESP8266_NODEMCU_ESP12E using ESP8266_W5500 Ethernet New
  • 11. AsyncHTTPRequest_ESP8266_Ethernet running on ESP8266_NODEMCU_ESP12E using ESP8266_ENC28J60 Ethernet New
• Debug
• Troubleshooting
• Issues
• TO DO
• DONE
• Contributions and Thanks
• Contributing
• License and credits
• Copyright

Important Change from v1.6.0

Please have a look at HOWTO Fix Multiple Definitions Linker Error

Why do we need this Async AsyncHTTPRequest_Generic library

Features

1. Asynchronous HTTP Request library for ESP8266, including ESP32-S2 (ESP32-S2 Saola, AI-Thinker ESP-12K, etc.) using built-in WiFi, WT32_ETH01 (ESP32 + LAN8720) and STM32 boards using LAN8720 or built-in LAN8742A Ethernet.
2. Providing a subset of HTTP.
3. Relying on on ESPAsyncTCP for ESP8266, AsyncTCP for ESP32 using built-in WiFi
4. Relying on STM32duino LwIP/STM32duino STM32Ethernet/STM32AsyncTCP for STM32 using LAN8720 or built-in LAN8742A Ethernet.
5. Methods similar in format and usage to XmlHTTPrequest in Javascript.

Supports

1. GET, POST, PUT, PATCH, DELETE and HEAD
2. Request and response headers
3. Chunked response
4. Single String response for short (<~5K) responses (heap permitting).
5. Optional onData callback.
6. Optional onReadyStatechange callback.

Principles of operation

This library adds a simple HTTP layer on top of the ESPAsyncTCP/AsyncTCP/STM32 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:

1. Bob Lemaire's asyncHTTPrequest Library

Currently Supported Boards

1. ESP32 including ESP32_S2 (ESP32_S2 Saola, AI-Thinker ESP-12K, etc.), ESP32_S3 and ESP32_C3

1. ESP32-S2 (ESP32-S2 Saola, AI-Thinker ESP-12K, etc.) using EEPROM, SPIFFS or LittleFS.
2. ESP32-C3 (ARDUINO_ESP32C3_DEV) using EEPROM, SPIFFS or LittleFS.
3. ESP32-S3 (ESP32S3_DEV, ESP32_S3_BOX, UM TINYS3, UM PROS3, UM FEATHERS3, etc.) using EEPROM, SPIFFS or LittleFS.

2. ESP8266

1. Using WiFi
2. Using W5x00 with lwIP_w5100 or lwIP_w5500 library
3. Using ENC28J60 with lwIP_enc28j60 library

3. STM32F/L/H/G/WB/MP1 with built-in LAN8742A Ethernet.

1. Nucleo-144 (F429ZI, F746ZG, F756ZG, F767ZI)
2. Discovery STM32F746G-DISCOVERY
3. Any STM32 boards with enough flash/memory and already configured to run LAN8742A Ethernet.

4. STM32 boards using Ethernet LAN8720

Support for LAN8720 has been removed from STM32 core v2.3.0

1. Nucleo-144 (F429ZI, NUCLEO_F746NG, NUCLEO_F746ZG, NUCLEO_F756ZG)
2. Discovery (DISCO_F746NG)
3. STM32F4 boards (BLACK_F407VE, BLACK_F407VG, BLACK_F407ZE, BLACK_F407ZG, BLACK_F407VE_Mini, DIYMORE_F407VGT, FK407M1)

5. WT32_ETH01 using ESP32-based boards and LAN8720 Ethernet

Prerequisites

1. Arduino IDE 1.8.19+ for Arduino.
2. ESP8266 Core 3.0.2+ for ESP8266-based boards.
3. ESP32 Core 2.0.4+ for ESP32-based boards. [Latest stable release
4. Arduino Core for STM32 2.3.0+ for for STM32 using built-in Ethernet LAN8742A.
5. ESPAsyncTCP v1.2.2+ for ESP8266.
6. AsyncTCP v1.1.1+ for ESP32.
7. STM32Ethernet library v1.3.0+ for STM32 using built-in Ethernet LAN8742A on (Nucleo-144, Discovery).
8. LwIP library v2.1.2+ for STM32 using built-in Ethernet LAN8742A on (Nucleo-144, Discovery).
9. STM32AsyncTCP library v1.0.1+ for built-in Ethernet on (Nucleo-144, Discovery). To install manually for Arduino IDE.
10. ESPAsync_WiFiManager library v1.13.0+ for ESP32/ESP8266 using some examples.
11. LittleFS_esp32 v1.0.6+ for ESP32-based boards using LittleFS only with ESP32 core v1.0.5-. To install, check .
12. WebServer_WT32_ETH01 library v1.5.0+ if necessary to use WT32_ETH01 boards. To install, check

Installation

Use Arduino Library Manager

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

Manual Install

1. Navigate to AsyncHTTPRequest_Generic page.
2. Download the latest release AsyncHTTPRequest_Generic-master.zip.
3. Extract the zip file to AsyncHTTPRequest_Generic-master directory
4. Copy the whole AsyncHTTPRequest_Generic-master folder to Arduino libraries' directory such as ~/Arduino/libraries/.

VS Code & PlatformIO

1. Install VS Code
2. Install PlatformIO
3. Install AsyncHTTPRequest_Generic library by using Library Manager. Search for AsyncHTTPRequest_Generic in Platform.io Author's Libraries
4. 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

Packages' Patches

1. For STM32 boards to use LAN8720

To use LAN8720 on some STM32 boards

• Nucleo-144 (F429ZI, NUCLEO_F746NG, NUCLEO_F746ZG, NUCLEO_F756ZG)
• Discovery (DISCO_F746NG)
• STM32F4 boards (BLACK_F407VE, BLACK_F407VG, BLACK_F407ZE, BLACK_F407ZG, BLACK_F407VE_Mini, DIYMORE_F407VGT, FK407M1)

you have to copy the files stm32f4xx_hal_conf_default.h and stm32f7xx_hal_conf_default.h into STM32 stm32 directory (~/.arduino15/packages/STM32/hardware/stm32/2.3.0/system) to overwrite the old files.

Supposing the STM32 stm32 core version is 2.3.0. These files must be copied into the directory:

• ~/.arduino15/packages/STM32/hardware/stm32/2.3.0/system/STM32F4xx/stm32f4xx_hal_conf_default.h for STM32F4.
• ~/.arduino15/packages/STM32/hardware/stm32/2.3.0/system/STM32F7xx/stm32f7xx_hal_conf_default.h for Nucleo-144 STM32F7.

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz, theses files must be copied into the corresponding directory:

• ~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/system/STM32F4xx/stm32f4xx_hal_conf_default.h
• `~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/system/STM32F7xx/stm32f7xx_hal_conf_default.h

2. For STM32 boards to use Serial1

To use Serial1 on some STM32 boards without Serial1 definition (Nucleo-144 NUCLEO_F767ZI, Nucleo-64 NUCLEO_L053R8, etc.) boards, you have to copy the files STM32 variant.h into STM32 stm32 directory (~/.arduino15/packages/STM32/hardware/stm32/2.3.0). You have to modify the files corresponding to your boards, this is just an illustration how to do.

Supposing the STM32 stm32 core version is 2.3.0. These files must be copied into the directory:

• ~/.arduino15/packages/STM32/hardware/stm32/2.3.0/variants/STM32F7xx/F765Z(G-I)T_F767Z(G-I)T_F777ZIT/NUCLEO_F767ZI/variant.h for Nucleo-144 NUCLEO_F767ZI.
• ~/.arduino15/packages/STM32/hardware/stm32/2.3.0/variants/STM32L0xx/L052R(6-8)T_L053R(6-8)T_L063R8T/NUCLEO_L053R8/variant.h for Nucleo-64 NUCLEO_L053R8.

Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zz, theses files must be copied into the corresponding directory:

• ~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/variants/STM32F7xx/F765Z(G-I)T_F767Z(G-I)T_F777ZIT/NUCLEO_F767ZI/variant.h
• ~/.arduino15/packages/STM32/hardware/stm32/x.yy.zz/variants/STM32L0xx/L052R(6-8)T_L053R(6-8)T_L063R8T/NUCLEO_L053R8/variant.h

Note for Platform IO using ESP32 LittleFS

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'

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

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_Generic.h"           //https://github.com/khoih-prog/AsyncHTTPRequest_Generic

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

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 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:

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

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

HOWTO use STM32F4 with LAN8720

1. Wiring

This is the Wiring for STM32F4 (BLACK_F407VE, etc.) using LAN8720

2. HOWTO program using STLink V-2 or V-3

Connect as follows. To program, use STM32CubeProgrammer or Arduino IDE with

• U(S)ART Support: "Enabled (generic Serial)"
• Upload Method : "STM32CubeProgrammer (SWD)"

3. HOWTO use Serial Port for Debugging

Connect FDTI (USB to Serial) as follows:

HOWTO use ESP8266 with W5x00 Ethernet

1. ESP8266 Wiring

This is the wiring for EP8266 W5x00 or ENC28J60 Ethernet when using SS = GPIO16

https://github.com/khoih-prog/AsyncHTTPRequest_Generic/blob/e3dd512e7aa9e60c85043893d4527d3b052077c0/examples/AsyncHTTPRequest_ESP8266_Ethernet/AsyncHTTPRequest_ESP8266_Ethernet.ino#L65

Examples

For ESP32 and ESP8266

1. AsyncHTTPRequest_ESP
2. AsyncHTTPRequest_ESP_WiFiManager
3. AsyncHTTPMultiRequests_ESP
4. AsyncHTTPRequest_ESP_Multi New
5. AsyncHTTPRequest_ESP8266_Ethernet New

For STM32 using LAN8742A

1. AsyncHTTPRequest_STM32
2. AsyncCustomHeader_STM32
3. AsyncDweetGet_STM32
4. AsyncDweetPost_STM32
5. AsyncSimpleGET_STM32
6. AsyncWebClientRepeating_STM32

For WT32_ETH01

1. AsyncHTTPRequest_WT32_ETH01
2. AsyncHTTPMultiRequests_WT32_ETH01

For ESP or STM32

1. multiFileProject New

Example AsyncHTTPRequest_STM32

Please take a look at other examples, as well.

1. File AsyncHTTPRequest_STM32.ino

https://github.com/khoih-prog/AsyncHTTPRequest_Generic/blob/07e2add9960fb3ab7333acd84fb2c697f3efc6a6/examples/AsyncHTTPRequest_STM32/AsyncHTTPRequest_STM32.ino#L43-L148

2. File defines.h

https://github.com/khoih-prog/AsyncHTTPRequest_Generic/blob/07e2add9960fb3ab7333acd84fb2c697f3efc6a6/examples/AsyncHTTPRequest_STM32/defines.h#L22-L134

Debug Terminal Ouput Samples

1. AsyncHTTPRequest_STM32 running on STM32F7 Nucleo-144 NUCLEO_F767ZI using built-in LAN8742A

Start AsyncHTTPRequest_STM32 on NUCLEO_F767ZI
AsyncHTTPRequest_Generic v1.9.0
AsyncHTTPRequest @ IP : 192.168.2.178

**************************************
abbreviation: EDT
client_ip: aaa.bbb.ccc.ddd
datetime: 2022-04-13T22:00:07.669102-04:00
day_of_week: 3
day_of_year: 103
dst: true
dst_from: 2022-03-13T07:00:00+00:00
dst_offset: 3600
dst_until: 2022-11-06T06:00:00+00:00
raw_offset: -18000
timezone: America/Toronto
unixtime: 1649901607
utc_datetime: 2022-04-14T02:00:07.669102+00:00
utc_offset: -04:00
week_number: 15
*********************

**************************************
abbreviation: EDT
client_ip: aaa.bbb.ccc.ddd
datetime: 2022-04-13T22:01:07.647308-04:00
day_of_week: 3
day_of_year: 103
dst: true
dst_from: 2022-03-13T07:00:00+00:00
dst_offset: 3600
dst_until: 2022-11-06T06:00:00+00:00
raw_offset: -18000
timezone: America/Toronto
unixtime: 1649901667
utc_datetime: 2022-04-14T02:01:07.647308+00:00
utc_offset: -04:00
week_number: 15

2. AsyncHTTPRequest_ESP_WiFiManager running on ESP8266_NODEMCU

Starting AsyncHTTPRequest_ESP_WiFiManager using LittleFS on ESP8266_NODEMCU
AsyncHTTPRequest_Generic v1.9.0
Stored: SSID = HueNet1, Pass = 12345678
Got stored Credentials. Timeout 120s
ConnectMultiWiFi in setup
After waiting 3.43 secs more in setup(), connection result is connected. Local IP: 192.168.2.186
H
**************************************
abbreviation: EDT
client_ip: aaa.bbb.ccc.ddd
datetime: 2022-04-13T22:02:07.647703-04:00
day_of_week: 3
day_of_year: 103
dst: true
dst_from: 2022-03-13T07:00:00+00:00
dst_offset: 3600
dst_until: 2022-11-06T06:00:00+00:00
raw_offset: -18000
timezone: America/Toronto
unixtime: 1649901727
utc_datetime: 2022-04-14T02:02:07.647703+00:00
utc_offset: -04:00
week_number: 15
**************************************
HHHHHH

3. AsyncHTTPRequest_ESP_WiFiManager running on ESP32_DEV

Starting AsyncHTTPRequest_ESP_WiFiManager using SPIFFS on ESP32_DEV
AsyncHTTPRequest_Generic v1.9.0
Stored: SSID = HueNet1, Pass = 12345678
Got stored Credentials. Timeout 120s
ConnectMultiWiFi in setup
After waiting 2.35 secs more in setup(), connection result is connected. Local IP: 192.168.2.232
H
**************************************
abbreviation: EDT
client_ip: aaa.bbb.ccc.ddd
datetime: 2022-04-13T22:03:07.647977-04:00
day_of_week: 3
day_of_year: 103
dst: true
dst_from: 2022-03-13T07:00:00+00:00
dst_offset: 3600
dst_until: 2022-11-06T06:00:00+00:00
raw_offset: -18000
timezone: America/Toronto
unixtime: 1649901787
utc_datetime: 2022-04-14T02:03:07.647977+00:00
utc_offset: -04:00
week_number: 15
**************************************
HHHHHHHHH HHHHHHHHHH HHHHHHHHHH H
**************************************
abbreviation: EDT
client_ip: aaa.bbb.ccc.ddd
datetime: 2022-04-13T22:04:07.648721-04:00
day_of_week: 3
day_of_year: 103
dst: true
dst_from: 2022-03-13T07:00:00+00:00
dst_offset: 3600
dst_until: 2022-11-06T06:00:00+00:00
raw_offset: -18000
timezone: America/Toronto
unixtime: 1649901847
utc_datetime: 2022-04-14T02:04:07.648721+00:00
utc_offset: -04:00
week_number: 15
**************************************
HHHHHHHHH HHHHHHHHHH HHHHHHHHHH 

4. AsyncHTTPRequest_ESP running on ESP8266_NODEMCU

Starting AsyncHTTPRequest_ESP using ESP8266_NODEMCU
AsyncHTTPRequest_Generic v1.9.0
Connecting to WiFi SSID: HueNet1
...........
HTTP WebServer is @ IP : 192.168.2.81

**************************************
abbreviation: EDT
client_ip: aaa.bbb.ccc.ddd
datetime: 2022-04-13T22:03:07.647977-04:00
day_of_week: 3
day_of_year: 103
dst: true
dst_from: 2022-03-13T07:00:00+00:00
dst_offset: 3600
dst_until: 2022-11-06T06:00:00+00:00
raw_offset: -18000
timezone: America/Toronto
unixtime: 1649901787
utc_datetime: 2022-04-14T02:03:07.647977+00:00
utc_offset: -04:00
week_number: 15
**************************************
HHHHHHHHH HHHHHHHHHH HHHHHHHHHH H

5. AsyncWebClientRepeating_STM32 running on STM32F7 Nucleo-144 NUCLEO_F767ZI using built-in LAN8742A

Start AsyncWebClientRepeating_STM32 on NUCLEO_F767ZI
AsyncHTTPRequest_Generic v1.9.0
AsyncHTTPRequest @ IP : 192.168.2.72

**************************************

           `:;;;,`                      .:;;:.           
        .;;;;;;;;;;;`                :;;;;;;;;;;:     TM 
      `;;;;;;;;;;;;;;;`            :;;;;;;;;;;;;;;;
     :;;;;;;;;;;;;;;;;;;         `;;;;;;;;;;;;;;;;;;
    ;;;;;;;;;;;;;;;;;;;;;       .;;;;;;;;;;;;;;;;;;;;
   ;;;;;;;;:`   `;;;;;;;;;     ,;;;;;;;;.`   .;;;;;;;;
  .;;;;;;,         :;;;;;;;   .;;;;;;;          ;;;;;;;
  ;;;;;;             ;;;;;;;  ;;;;;;,            ;;;;;;. 
 ,;;;;;               ;;;;;;.;;;;;;`              ;;;;;; 
 ;;;;;.                ;;;;;;;;;;;`      ```       ;;;;;`
 ;;;;;                  ;;;;;;;;;,       ;;;       .;;;;;
`;;;;:                  `;;;;;;;;        ;;;        ;;;;;
,;;;;`    `,,,,,,,,      ;;;;;;;      .,,;;;,,,     ;;;;;
:;;;;`    .;;;;;;;;       ;;;;;,      :;;;;;;;;     ;;;;;
:;;;;`    .;;;;;;;;      `;;;;;;      :;;;;;;;;     ;;;;;
.;;;;.                   ;;;;;;;.        ;;;        ;;;;;
 ;;;;;                  ;;;;;;;;;        ;;;        ;;;;;
 ;;;;;                 .;;;;;;;;;;       ;;;       ;;;;;,
 ;;;;;;               `;;;;;;;;;;;;                ;;;;; 
 `;;;;;,             .;;;;;; ;;;;;;;              ;;;;;; 
  ;;;;;;:           :;;;;;;.  ;;;;;;;            ;;;;;;
   ;;;;;;;`       .;;;;;;;,    ;;;;;;;;        ;;;;;;;:
    ;;;;;;;;;:,:;;;;;;;;;:      ;;;;;;;;;;:,;;;;;;;;;;
    `;;;;;;;;;;;;;;;;;;;.        ;;;;;;;;;;;;;;;;;;;;
      ;;;;;;;;;;;;;;;;;           :;;;;;;;;;;;;;;;;:
       ,;;;;;;;;;;;;;,              ;;;;;;;;;;;;;;
         .;;;;;;;;;`                  ,;;;;;;;;:         
                                                         
                                                         
                                                         
                                                         
    ;;;   ;;;;;`  ;;;;:  .;;  ;; ,;;;;;, ;;. `;,  ;;;;
    ;;;   ;;:;;;  ;;;;;; .;;  ;; ,;;;;;: ;;; `;, ;;;:;;
   ,;:;   ;;  ;;  ;;  ;; .;;  ;;   ,;,   ;;;,`;, ;;  ;;
   ;; ;:  ;;  ;;  ;;  ;; .;;  ;;   ,;,   ;;;;`;, ;;  ;;. 
   ;: ;;  ;;;;;:  ;;  ;; .;;  ;;   ,;,   ;;`;;;, ;;  ;;` 
  ,;;;;;  ;;`;;   ;;  ;; .;;  ;;   ,;,   ;; ;;;, ;;  ;;
  ;;  ,;, ;; .;;  ;;;;;:  ;;;;;: ,;;;;;: ;;  ;;, ;;;;;;
  ;;   ;; ;;  ;;` ;;;;.   `;;;:  ,;;;;;, ;;  ;;,  ;;;;

6. AsyncHTTPRequest_WT32_ETH01 on ESP32_DEV with ETH_PHY_LAN8720

Starting AsyncHTTPRequest_WT32_ETH01 on ESP32_DEV with ETH_PHY_LAN8720
WebServer_WT32_ETH01 v1.5.0
AsyncHTTPRequest_Generic v1.9.0
ETH MAC: A8:03:2A:A1:61:73, IPv4: 192.168.2.232, FULL_DUPLEX, 100Mbps
AsyncHTTPRequest @ IP : 192.168.2.232

**************************************
abbreviation: EDT
client_ip: aaa.bbb.ccc.ddd
datetime: 2022-04-13T22:04:07.648721-04:00
day_of_week: 3
day_of_year: 103
dst: true
dst_from: 2022-03-13T07:00:00+00:00
dst_offset: 3600
dst_until: 2022-11-06T06:00:00+00:00
raw_offset: -18000
timezone: America/Toronto
unixtime: 1649901847
utc_datetime: 2022-04-14T02:04:07.648721+00:00
utc_offset: -04:00
week_number: 15
**************************************

7. AsyncHTTPRequest_ESP_WiFiManager running on ESP32C3_DEV

Starting AsyncHTTPRequest_ESP_WiFiManager using LittleFS on ESP32C3_DEV
ESPAsync_WiFiManager v1.13.0
AsyncHTTPRequest_Generic v1.9.0
Stored: SSID = HueNet1, Pass = password
Got stored Credentials. Timeout 120s
ConnectMultiWiFi in setup
After waiting 9.23 secs more in setup(), connection result is connected. Local IP: 192.168.2.85
H
**************************************
abbreviation: EDT
client_ip: aaa.bbb.ccc.ddd
datetime: 2022-04-13T22:05:07.648251-04:00
day_of_week: 3
day_of_year: 103
dst: true
dst_from: 2022-03-13T07:00:00+00:00
dst_offset: 3600
dst_until: 2022-11-06T06:00:00+00:00
raw_offset: -18000
timezone: America/Toronto
unixtime: 1649901907
utc_datetime: 2022-04-14T02:05:07.648251+00:00
utc_offset: -04:00
week_number: 15
**************************************
HHHHHH
**************************************
abbreviation: EDT
client_ip: aaa.bbb.ccc.ddd
datetime: 2022-04-13T22:06:07.648775-04:00
day_of_week: 3
day_of_year: 103
dst: true
dst_from: 2022-03-13T07:00:00+00:00
dst_offset: 3600
dst_until: 2022-11-06T06:00:00+00:00
raw_offset: -18000
timezone: America/Toronto
unixtime: 1649901967
utc_datetime: 2022-04-14T02:06:07.648775+00:00
utc_offset: -04:00
week_number: 15
**************************************

8. AsyncHTTPRequest_ESP_WiFiManager running on ESP32S3_DEV

Starting AsyncHTTPRequest_ESP_WiFiManager using LittleFS on ESP32S3_DEV
ESPAsync_WiFiManager v1.13.0
AsyncHTTPRequest_Generic v1.9.0
Stored: SSID = HueNet1, Pass = password
Got stored Credentials. Timeout 120s
ConnectMultiWiFi in setup
After waiting 7.77 secs more in setup(), connection result is connected. Local IP: 192.168.2.83
H
**************************************
abbreviation: EDT
client_ip: aaa.bbb.ccc.ddd
datetime: 2022-04-13T22:07:07.649344-04:00
day_of_week: 3
day_of_year: 103
dst: true
dst_from: 2022-03-13T07:00:00+00:00
dst_offset: 3600
dst_until: 2022-11-06T06:00:00+00:00
raw_offset: -18000
timezone: America/Toronto
unixtime: 1649902027
utc_datetime: 2022-04-14T02:07:07.649344+00:00
utc_offset: -04:00
week_number: 15
**************************************

HHHHHH
**************************************
abbreviation: EDT
client_ip: aaa.bbb.ccc.ddd
datetime: 2022-04-13T22:08:07.649062-04:00
day_of_week: 3
day_of_year: 103
dst: true
dst_from: 2022-03-13T07:00:00+00:00
dst_offset: 3600
dst_until: 2022-11-06T06:00:00+00:00
raw_offset: -18000
timezone: America/Toronto
unixtime: 1649902087
utc_datetime: 2022-04-14T02:08:07.649062+00:00
utc_offset: -04:00
week_number: 15
**************************************

9. AsyncHTTPRequest_ESP_Multi running on ESP32_DEV

The terminal output of AsyncHTTPRequest_ESP_Multi example running on ESP32_DEV to demonstrate how to send requests to multiple addresses and receive responses from them.

Starting AsyncHTTPRequest_ESP_Multi using ESP32_DEV
AsyncHTTPRequest_Generic v1.9.0
Connecting to WiFi SSID: HueNet1
.......
AsyncHTTPSRequest @ IP : 192.168.2.88

Sending request: http://worldtimeapi.org/api/timezone/Europe/Prague.txt

Sending request: http://www.myexternalip.com/raw

**************************************
abbreviation: CET
client_ip: aaa.bbb.ccc.ddd
datetime: 2022-02-26T01:54:15.753826+01:00
day_of_week: 6
day_of_year: 57
dst: false
dst_from: 
dst_offset: 0
dst_until: 
raw_offset: 3600
timezone: Europe/Prague
unixtime: 1645836855
utc_datetime: 2022-02-26T00:54:15.753826+00:00
utc_offset: +01:00
week_number: 8
**************************************

**************************************
aaa.bbb.ccc.ddd
**************************************

Sending request: http://worldtimeapi.org/api/timezone/America/Toronto.txt

**************************************
abbreviation: EST
client_ip: aaa.bbb.ccc.ddd
datetime: 2022-02-25T19:54:15.822746-05:00
day_of_week: 5
day_of_year: 56
dst: false
dst_from: 
dst_offset: 0
dst_until: 
raw_offset: -18000
timezone: America/Toronto
unixtime: 1645836855
utc_datetime: 2022-02-26T00:54:15.822746+00:00
utc_offset: -05:00
week_number: 8
**************************************
HHH

10. AsyncHTTPRequest_ESP8266_Ethernet running on ESP8266_NODEMCU_ESP12E using ESP8266_W5500 Ethernet

The terminal output of AsyncHTTPRequest_ESP8266_Ethernet example running on ESP8266_NODEMCU_ESP12E to demonstrate how to use ESP8266_W5500 Ethernet Async feature.

Starting AsyncHTTPRequest_ESP8266_Ethernet on ESP8266_NODEMCU_ESP12E using ESP8266_W5500 Ethernet
AsyncHTTPRequest_Generic v1.9.0
Connecting ethernet..
Ethernet IP address: 192.168.2.187

**************************************
abbreviation: EDT
client_ip: aaa.bbb.ccc.ddd
datetime: 2022-04-13T21:58:31.037966-04:00
day_of_week: 3
day_of_year: 103
dst: true
dst_from: 2022-03-13T07:00:00+00:00
dst_offset: 3600
dst_until: 2022-11-06T06:00:00+00:00
raw_offset: -18000
timezone: America/Toronto
unixtime: 1649901511
utc_datetime: 2022-04-14T01:58:31.037966+00:00
utc_offset: -04:00
week_number: 15
**************************************
HHHHHH
**************************************
abbreviation: EDT
client_ip: aaa.bbb.ccc.ddd
datetime: 2022-04-13T21:59:31.025188-04:00
day_of_week: 3
day_of_year: 103
dst: true
dst_from: 2022-03-13T07:00:00+00:00
dst_offset: 3600
dst_until: 2022-11-06T06:00:00+00:00
raw_offset: -18000
timezone: America/Toronto
unixtime: 1649901571
utc_datetime: 2022-04-14T01:59:31.025188+00:00
utc_offset: -04:00
week_number: 15
**************************************
HH

11. AsyncHTTPRequest_ESP8266_Ethernet running on ESP8266_NODEMCU_ESP12E using ESP8266_ENC28J60 Ethernet

The terminal output of AsyncHTTPRequest_ESP8266_Ethernet example running on ESP8266_NODEMCU_ESP12E to demonstrate how to use ESP8266_ENC28J60 Ethernet Async feature.

Starting AsyncHTTPRequest_ESP8266_Ethernet on ESP8266_NODEMCU_ESP12E using ESP8266_ENC28J60 Ethernet
AsyncHTTPRequest_Generic v1.9.0
Connecting to network : ..........................................................
Ethernet IP address: 192.168.2.187

**************************************
abbreviation: EDT
client_ip: aaa.bbb.ccc.ddd
datetime: 2022-04-13T23:54:42.973735-04:00
day_of_week: 3
day_of_year: 103
dst: true
dst_from: 2022-03-13T07:00:00+00:00
dst_offset: 3600
dst_until: 2022-11-06T06:00:00+00:00
raw_offset: -18000
timezone: America/Toronto
unixtime: 1649908482
utc_datetime: 2022-04-14T03:54:42.973735+00:00
utc_offset: -04:00
week_number: 15
**************************************
HHHHHH
**************************************
abbreviation: EDT
client_ip: aaa.bbb.ccc.ddd
datetime: 2022-04-13T23:55:42.894333-04:00
day_of_week: 3
day_of_year: 103
dst: true
dst_from: 2022-03-13T07:00:00+00:00
dst_offset: 3600
dst_until: 2022-11-06T06:00:00+00:00
raw_offset: -18000
timezone: America/Toronto
unixtime: 1649908542
utc_datetime: 2022-04-14T03:55:42.894333+00:00
utc_offset: -04:00
week_number: 15

Debug

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

Troubleshooting

If you get compilation errors, more often than not, you may need to install a newer version of the ESP32 / ESP8266 / STM32 core for Arduino.

Sometimes, the library will only work if you update the ESP32 / ESP8266 / STM32 core to the latest version because I am using newly added functions.

Issues

Submit issues to: AsyncHTTPRequest_Generic issues

TO DO

1. Fix bug. Add enhancement
2. Add support to more Ethernet / WiFi shields with lwIP-based feature.
3. Add support to more boards.
4. Add many more examples.

DONE

1. Initially add support to STM32 using built-in LAN8742A Etnernet. Tested on STM32F7 Nucleo-144 F767ZI.
2. Add more examples.
3. Add debugging features.
4. Add PUT, PATCH, DELETE and HEAD besides GET and POST.
5. Add support to Ethernet LAN8720 using STM32Ethernet library, for boards such as Nucleo-144 (F429ZI, NUCLEO_F746NG, NUCLEO_F746ZG, NUCLEO_F756ZG), Discovery (DISCO_F746NG) and STM32F4 boards (BLACK_F407VE, BLACK_F407VG, BLACK_F407ZE, BLACK_F407ZG, BLACK_F407VE_Mini, DIYMORE_F407VGT, FK407M1)
6. Add support to WT32_ETH01 using ESP32-based boards and LAN8720 Ethernet
7. Auto detect ESP32 core to use for WT32_ETH01
8. Fix bug in WT32_ETH01 examples to reduce connection time
9. Fix multiple-definitions linker error and weird bug related to src_cpp.
10. Optimize library code by using reference-passing instead of value-passing
11. Enable compatibility with old code to include only AsyncHTTPRequest_Generic.h
12. Add support to ESP32-S3 (ESP32S3_DEV, ESP32_S3_BOX, UM TINYS3, UM PROS3, UM FEATHERS3, etc.) using EEPROM, SPIFFS or LittleFS
13. Add LittleFS support to ESP32-C3
14. Use ESP32-core's LittleFS library instead of Lorol's LITTLEFS library for ESP32 core v2.0.0+
15. Add example AsyncHTTPRequest_ESP_Multi to demonstrate how to send requests to multiple addresses and receive responses from them.
16. Add support to ESP8266 using W5x00 with lwIP_w5100 or lwIP_w5500 library
17. Add support to ESP8266 using ENC28J60 with lwIP_enc28j60 library
18. Fix long timeout if using IPAddress.
19. Remove support to STM32 using LAN8720 due to problem with new STM32 core v2.3.0

Contributions and Thanks

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

1. Bob Lemaire's asyncHTTPrequest Library to use the better asynchronous features of these following Async TCP Libraries : ( ESPAsyncTCP, AsyncTCP, and STM32AsyncTCP ).
2. Thanks to Daniel Brunner to report and make PR in Fixed linker errors when included in multiple .cpp files leading to v1.0.1. See HOWTO Fix Multiple Definitions Linker Error
3. Thanks to gleniat to make enhancement request in Add support for sending PUT, PATCH, DELETE request leading to v1.1.0.
4. Thanks to BadDwarf to report compatibility with ESPAsyncWebServer #11 leading to the enhancement in v1.1.2.
5. Thanks to spdi to report 'Connection' header expects 'disconnect' instead 'close' ? #13 leading to new release v1.1.3 to fix bug.
6. Thanks to andrewk123 to report Http GET polling causes crash when host disconnected #22 leading to new release v1.4.0 to fix bug.
7. Thanks to DavidAntonin to report Cannot send requests to different addresses #4 leading to new release v1.7.1 to demonstrate how to send requests to multiple addresses and receive responses from them.
8. Thanks to per1234 to make PR Remove unavailable items from depends field of library.properties leading to v1.8.2
9. Thanks to miwied to report setTimeout() hasn't any effect #38 leading to new release v1.9.0

⭐️ Bob Lemaire	Daniel Brunner	gleniat	BadDwarf	spdi	andrewk123
DavidAntonin	per1234	miwied

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 2020- Khoi Hoang