v2.14.2 to fix ESP8266 Async Bug

### Release v2.14.2

1. Fix Async bug for ESP8266 when using NETWORK_ESP8266_ASYNC
2. Add example [ESP8266_AsyncWSClient](examples/Async/ESP8266_AsyncWSClient)
3. Update `platformio.ini` to temporarily use ESP32 core v2.0.0+ and use [ESPAsyncTCP](https://github.com/me-no-dev/ESPAsyncTCP) library for ESP8266 Async
4. Update `Packages' Patches`

Author: khoih-prog

CONTRIBUTING.md

@@ -15,7 +15,7 @@ If you don't find anything, please [open a new issue](https://github.com/khoih-p
 Please ensure to specify the following:
 
 * Arduino IDE version (e.g. 1.8.19) or Platform.io version
-* Board Core Version (e.g. Arduino SAMDUE core v1.6.12, ESP8266 core v3.0.2, ArduinoCore-mbed v2.7.2, etc.)
+* Board Core Version (e.g. Arduino SAMDUE core v1.6.12, ESP8266 core v3.0.2, ArduinoCore-mbed v3.0.0, etc.)
 * Contextual information (e.g. what you were trying to achieve)
 * Simplest possible steps to reproduce
 * Anything that might be relevant in your opinion, such as:
@@ -28,9 +28,9 @@ Please ensure to specify the following:
 ```
 Arduino IDE version: 1.8.19
 RASPBERRY_PI_PICO board
-ArduinoCore-mbed v2.7.2
+ArduinoCore-mbed v3.0.0
 OS: Ubuntu 20.04 LTS
-Linux xy-Inspiron-3593 5.4.0-99-generic #112-Ubuntu SMP Thu Feb 3 13:50:55 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
+Linux xy-Inspiron-3593 5.13.0-37-generic #42~20.04.1-Ubuntu SMP Tue Mar 15 15:44:28 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
 
 Context:
 I encountered an endless loop while trying to connect to Local WiFi.

README.md

@@ -12,6 +12,7 @@
 ## Table of Contents
 
 * [Changelog](#changelog)
+  * [Release v2.14.2](#release-v2142)
   * [Release v2.14.1](#release-v2141)
   * [Release v2.14.0](#release-v2140)
   * [Release v2.13.0](#release-v2130)
@@ -55,10 +56,17 @@
 
 ## Changelog
 
+### Release v2.14.2
+
+1. Fix Async bug for ESP8266 when using NETWORK_ESP8266_ASYNC
+2. Add example [ESP8266_AsyncWSClient](examples/Async/ESP8266_AsyncWSClient)
+3. Update `platformio.ini` to temporarily use ESP32 core v2.0.0+ and use [ESPAsyncTCP](https://github.com/me-no-dev/ESPAsyncTCP) library for ESP8266 Async
+4. Update `Packages' Patches`
+
 ### Release v2.14.1
 
 1. Fix setInsecure() bug for WIO_Terminal.
-5. Update `Packages' Patches` for `Seeeduino` core. Be sure to use the `Packages_Patches` of this library version v2.14.1+ to avoid compiler error.
+2. Update `Packages' Patches` for `Seeeduino` core. Be sure to use the `Packages_Patches` of this library version v2.14.1+ to avoid compiler error.
 
 ### Release v2.14.0
 

changelog.md

@@ -1,6 +1,6 @@
 {
   "name": "WebSockets_Generic",
-  "version": "2.14.1",
+  "version": "2.14.2",
   "description": "RFC6455-based WebSockets Server and Client for Arduino boards, such as nRF52, Portenta_H7, SAMD21, SAMD51, STM32F/L/H/G/WB/MP1, Teensy, SAM DUE, RP2040-based boards, besides ESP8266/ESP32 ESP32 (ESP32, ESP32_S2, ESP32_S3 and ESP32_C3) and WT32_ETH01. Ethernet shields W5100, W5200, W5500, ENC28J60, Teensy 4.1 NativeEthernet/QNEthernet or Portenta_H7 WiFi/Ethernet.  Now supporting websocket only mode for Socket.IO",
   "keywords": "wifi, WiFiNINA, websocket, websockets-server, websockets-client, Teensy, SAM DUE, SAMD, STM32, nRF52, QNEthernet, rp2040, Portenta-H7, ESP32, ESP8266, W5x00, Ethernet, Ethernet2, Ethernet3, EthernetLarge, EthernetENC, UIPEthernet, NativeEthernet, ENC28J60, rpi-pico, http, web, server, client, Mega",
   "authors": [

library.json

@@ -1,5 +1,5 @@
 name=WebSockets_Generic
-version=2.14.1
+version=2.14.2
 author=Markus Sattler, Khoi Hoang <khoih.prog@gmail.com>
 maintainer=Khoi Hoang <khoih.prog@gmail.com>
 sentence=RFC6455-based WebSockets Server and Client for Arduino boards, such as nRF52, Portenta_H7, SAMD21, SAMD51, STM32F/L/H/G/WB/MP1, Teensy, SAM DUE, RP2040-based boards, besides ESP8266/ESP32 (ESP32, ESP32_S2, ESP32_S3 and ESP32_C3) and WT32_ETH01. Ethernet shields W5100, W5200, W5500, ENC28J60, Teensy 4.1 NativeEthernet/QNEthernet or Portenta_H7 WiFi/Ethernet. Now supporting websocket only mode for Socket.IO

library.properties

@@ -40,45 +40,47 @@ lib_compat_mode = strict
 
 lib_deps =  
 ; PlatformIO 4.x
-  WiFiNINA_Generic@~1.8.14-3
-  WiFiWebServer@~1.6.1
-  EthernetWebServer@~2.0.0
-  WebServer_WT32_ETH01@~1.4.1
-  EthernetWebServer_STM32@>=1.3.3
-  Ethernet@~2.0.0
-  EthernetLarge@~2.0.0
-  Ethernet2@~1.0.4
-  Ethernet3@~1.5.5
-  EthernetENC@~2.0.2
-  UIPEthernet@~2.0.8
-  STM32duino LwIP@>=2.1.2
-  STM32duino STM32Ethernet@>=1.2.0
-  DoubleResetDetector_Generic@>=1.8.0
-  SinricPro_Generic@>=2.8.4
-  FlashStorage_SAMD@>=1.3.2
-  FlashStorage_STM32@~1.2.0
-  QNEthernet@~0.13.0
-  https://github.com/khoih-prog/WiFi101
+;  WiFiNINA_Generic@~1.8.14-3
+;  WiFiWebServer@~1.6.1
+;  EthernetWebServer@~2.0.0
+;  WebServer_WT32_ETH01@~1.4.1
+;  EthernetWebServer_STM32@>=1.3.3
+;  Ethernet@~2.0.0
+;  EthernetLarge@~2.0.0
+;  Ethernet2@~1.0.4
+;  Ethernet3@~1.5.5
+;  EthernetENC@~2.0.2
+;  UIPEthernet@~2.0.8
+;  STM32duino LwIP@>=2.1.2
+;  STM32duino STM32Ethernet@>=1.2.0
+;  DoubleResetDetector_Generic@>=1.8.0
+;  SinricPro_Generic@>=2.8.4
+;  FlashStorage_SAMD@>=1.3.2
+;  FlashStorage_STM32@~1.2.0
+;  QNEthernet@~0.13.0
+;  https://github.com/khoih-prog/WiFi101
+;  ESPAsyncTCP@>=1.2.2
 ; PlatformIO 5.x
-; khoih-prog/WiFiNINA_Generic@~1.8.14-3
-; khoih-prog/WiFiWebServer@~1.6.1
-; khoih-prog/EthernetWebServer@~2.0.0
-; khoih-prog/WebServer_WT32_ETH01@~1.4.1
-; khoih-prog/EthernetWebServer_STM32@>=1.3.3
-; PaulStoffregen/Ethernet@~2.0.0
-; PaulStoffregen/EthernetLarge@~2.0.0
-; adafruit/Ethernet2@~1.0.4
-; sstaub/Ethernet3@~1.5.5
-; jandrassy/EthernetENC@~2.0.2
-; UIPEthernet/UIPEthernet@~2.0.8
-; stm32duino/STM32duino LwIP@>=2.1.2
-; stm32duino/STM32duino STM32Ethernet@>=1.2.0
-; khoih-prog/DoubleResetDetector_Generic@>=1.8.0
-; khoih-prog/SinricPro_Generic@>=2.8.4
-; khoih-prog/FlashStorage_SAMD@~1.3.2
-; khoih-prog/FlashStorage_STM32@~1.2.0
-; ssilverman/QNEthernet@~0.13.0
-; https://github.com/khoih-prog/WiFi101
+ khoih-prog/WiFiNINA_Generic@~1.8.14-3
+ khoih-prog/WiFiWebServer@~1.6.1
+ khoih-prog/EthernetWebServer@~2.0.0
+ khoih-prog/WebServer_WT32_ETH01@~1.4.1
+ khoih-prog/EthernetWebServer_STM32@>=1.3.3
+ PaulStoffregen/Ethernet@~2.0.0
+ PaulStoffregen/EthernetLarge@~2.0.0
+ adafruit/Ethernet2@~1.0.4
+ sstaub/Ethernet3@~1.5.5
+ jandrassy/EthernetENC@~2.0.2
+ UIPEthernet/UIPEthernet@~2.0.8
+ stm32duino/STM32duino LwIP@>=2.1.2
+ stm32duino/STM32duino STM32Ethernet@>=1.2.0
+ khoih-prog/DoubleResetDetector_Generic@>=1.8.0
+ khoih-prog/SinricPro_Generic@>=2.8.4
+ khoih-prog/FlashStorage_SAMD@~1.3.2
+ khoih-prog/FlashStorage_STM32@~1.2.0
+ ssilverman/QNEthernet@~0.13.0
+ https://github.com/khoih-prog/WiFi101
+ me-no-dev/ESPAsyncTCP@>=1.2.2
 
 build_flags =
 ; set your debug output (default=Serial)
@@ -132,7 +134,11 @@ board = nodemcuv2
 ;board = esp32doit-devkit-v1
 
 [env:ESP32]
-platform = espressif32
+;platform = espressif32
+
+; Temporarily, For ESP32 core v2.0.0+
+platform = https://github.com/Jason2866/platform-espressif32.git#52fb773
+
 framework = arduino, espidf
 ; ============================================================
 ; Board configuration

platformio/platformio.ini

@@ -28,37 +28,20 @@
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
   
-  Version: 2.14.1
+  Version: 2.14.2
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   2.1.3   K Hoang      15/05/2020 Initial porting to support SAMD21, SAMD51, nRF52 boards, such as AdaFruit Feather nRF52832,
                                   nRF52840 Express, BlueFruit Sense, Itsy-Bitsy nRF52840 Express, Metro nRF52840 Express, etc.
-  2.2.1   K Hoang      18/05/2020 Bump up to sync with v2.2.1 of original WebSockets library
-  2.2.2   K Hoang      25/05/2020 Add support to Teensy, SAM DUE and STM32. Enable WebSocket Server for new supported boards.
-  2.2.3   K Hoang      02/08/2020 Add support to W5x00's Ethernet2, Ethernet3, EthernetLarge Libraries. 
-                                  Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards.
-  2.3.1   K Hoang      07/10/2020 Sync with v2.3.1 of original WebSockets library. Add ENC28J60 EthernetENC library support
-  2.3.2   K Hoang      12/11/2020 Add RTL8720DN Seeed_Arduino_rpcWiFi library support
-  2.3.3   K Hoang      28/11/2020 Fix compile error for WIO_TERMINAL and boards using libraries with lib64.
-  2.3.4   K Hoang      12/12/2020 Add SSL support to SAMD21 Nano-33-IoT using WiFiNINA. Upgrade WS and WSS examples.
-  2.4.0   K Hoang      06/02/2021 Add support to Teensy 4.1 NativeEthernet and STM32 built-in LAN8742A. 
-                                  Sync with v2.3.4 of original WebSockets library
-  2.4.1   K Hoang      19/03/2021 Sync with v2.3.5 of original WebSockets library to adapt to ESP32 SSL changes 
-  2.5.0   K Hoang      22/05/2021 Add support to WiFi101
-  2.5.1   K Hoang      22/05/2021 Default to EIO4 for Socket.IO. Permit increase reconnectInterval in Socket.IO
-  2.6.0   K Hoang      23/05/2021 Fix breaking problem with SocketIO. Add setExtraHeaders to SocketIO
-  2.7.0   K Hoang      24/05/2021 Add support to RP2040-based boards using Arduino-pico and Arduino mbed_rp2040 core
-  2.8.0   K Hoang      08/07/2021 Add support to WT32_ETH01 (ESP32 + LAN8720) boards
-  2.9.0   K Hoang      05/09/2021 Add support to QNEthernet Library for Teensy 4.1
-  2.10.0  K Hoang      18/09/2021 Add support to Portenta_H7, using either WiFi or Vision-shield Ethernet
-  2.10.1  K Hoang      12/10/2021 Update `platform.ini` and `library.json`
+  ...
   2.11.0  K Hoang      30/11/2021 Auto detect ESP32 core version. Fix bug in examples
   2.11.1  K Hoang      12/12/2021 Add option to use transport=websocket with sticky-session SIO server
   2.12.0  K Hoang      28/01/2022 Supporting SSL for ESP32-based WT32_ETH01 boards
   2.13.0  K Hoang      14/02/2022 Add support to ESP32_S3. Add PING and PONG SocketIO events
   2.14.0  K Hoang      17/02/2022 Suppress unnecessary warnings. Optimize code by passing by reference instead of value
   2.14.1  K Hoang      18/02/2022 Fix setInsecure() bug for WIO_Terminal. Update Packages_Patches for Seeeduino
+  2.14.2  K Hoang      27/03/2022 Fix Async bug for ESP8266 when using NETWORK_ESP8266_ASYNC
  *****************************************************************************************************************************/
 
 #pragma once

src/SocketIOclient_Generic-Impl.h

@@ -28,37 +28,20 @@
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
   
-  Version: 2.14.1
+  Version: 2.14.2
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   2.1.3   K Hoang      15/05/2020 Initial porting to support SAMD21, SAMD51, nRF52 boards, such as AdaFruit Feather nRF52832,
                                   nRF52840 Express, BlueFruit Sense, Itsy-Bitsy nRF52840 Express, Metro nRF52840 Express, etc.
-  2.2.1   K Hoang      18/05/2020 Bump up to sync with v2.2.1 of original WebSockets library
-  2.2.2   K Hoang      25/05/2020 Add support to Teensy, SAM DUE and STM32. Enable WebSocket Server for new supported boards.
-  2.2.3   K Hoang      02/08/2020 Add support to W5x00's Ethernet2, Ethernet3, EthernetLarge Libraries. 
-                                  Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards.
-  2.3.1   K Hoang      07/10/2020 Sync with v2.3.1 of original WebSockets library. Add ENC28J60 EthernetENC library support
-  2.3.2   K Hoang      12/11/2020 Add RTL8720DN Seeed_Arduino_rpcWiFi library support
-  2.3.3   K Hoang      28/11/2020 Fix compile error for WIO_TERMINAL and boards using libraries with lib64.
-  2.3.4   K Hoang      12/12/2020 Add SSL support to SAMD21 Nano-33-IoT using WiFiNINA. Upgrade WS and WSS examples.
-  2.4.0   K Hoang      06/02/2021 Add support to Teensy 4.1 NativeEthernet and STM32 built-in LAN8742A. 
-                                  Sync with v2.3.4 of original WebSockets library
-  2.4.1   K Hoang      19/03/2021 Sync with v2.3.5 of original WebSockets library to adapt to ESP32 SSL changes 
-  2.5.0   K Hoang      22/05/2021 Add support to WiFi101
-  2.5.1   K Hoang      22/05/2021 Default to EIO4 for Socket.IO. Permit increase reconnectInterval in Socket.IO
-  2.6.0   K Hoang      23/05/2021 Fix breaking problem with SocketIO. Add setExtraHeaders to SocketIO
-  2.7.0   K Hoang      24/05/2021 Add support to RP2040-based boards using Arduino-pico and Arduino mbed_rp2040 core
-  2.8.0   K Hoang      08/07/2021 Add support to WT32_ETH01 (ESP32 + LAN8720) boards
-  2.9.0   K Hoang      05/09/2021 Add support to QNEthernet Library for Teensy 4.1
-  2.10.0  K Hoang      18/09/2021 Add support to Portenta_H7, using either WiFi or Vision-shield Ethernet
-  2.10.1  K Hoang      12/10/2021 Update `platform.ini` and `library.json`
+  ...
   2.11.0  K Hoang      30/11/2021 Auto detect ESP32 core version. Fix bug in examples
   2.11.1  K Hoang      12/12/2021 Add option to use transport=websocket with sticky-session SIO server
   2.12.0  K Hoang      28/01/2022 Supporting SSL for ESP32-based WT32_ETH01 boards
   2.13.0  K Hoang      14/02/2022 Add support to ESP32_S3. Add PING and PONG SocketIO events
   2.14.0  K Hoang      17/02/2022 Suppress unnecessary warnings. Optimize code by passing by reference instead of value
   2.14.1  K Hoang      18/02/2022 Fix setInsecure() bug for WIO_Terminal. Update Packages_Patches for Seeeduino
+  2.14.2  K Hoang      27/03/2022 Fix Async bug for ESP8266 when using NETWORK_ESP8266_ASYNC
  *****************************************************************************************************************************/
 
 #pragma once

src/SocketIOclient_Generic.h

@@ -28,37 +28,20 @@
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
   
-  Version: 2.14.1
+  Version: 2.14.2
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   2.1.3   K Hoang      15/05/2020 Initial porting to support SAMD21, SAMD51, nRF52 boards, such as AdaFruit Feather nRF52832,
                                   nRF52840 Express, BlueFruit Sense, Itsy-Bitsy nRF52840 Express, Metro nRF52840 Express, etc.
-  2.2.1   K Hoang      18/05/2020 Bump up to sync with v2.2.1 of original WebSockets library
-  2.2.2   K Hoang      25/05/2020 Add support to Teensy, SAM DUE and STM32. Enable WebSocket Server for new supported boards.
-  2.2.3   K Hoang      02/08/2020 Add support to W5x00's Ethernet2, Ethernet3, EthernetLarge Libraries. 
-                                  Add support to STM32F/L/H/G/WB/MP1 and Seeeduino SAMD21/SAMD51 boards.
-  2.3.1   K Hoang      07/10/2020 Sync with v2.3.1 of original WebSockets library. Add ENC28J60 EthernetENC library support
-  2.3.2   K Hoang      12/11/2020 Add RTL8720DN Seeed_Arduino_rpcWiFi library support
-  2.3.3   K Hoang      28/11/2020 Fix compile error for WIO_TERMINAL and boards using libraries with lib64.
-  2.3.4   K Hoang      12/12/2020 Add SSL support to SAMD21 Nano-33-IoT using WiFiNINA. Upgrade WS and WSS examples.
-  2.4.0   K Hoang      06/02/2021 Add support to Teensy 4.1 NativeEthernet and STM32 built-in LAN8742A. 
-                                  Sync with v2.3.4 of original WebSockets library
-  2.4.1   K Hoang      19/03/2021 Sync with v2.3.5 of original WebSockets library to adapt to ESP32 SSL changes 
-  2.5.0   K Hoang      22/05/2021 Add support to WiFi101
-  2.5.1   K Hoang      22/05/2021 Default to EIO4 for Socket.IO. Permit increase reconnectInterval in Socket.IO
-  2.6.0   K Hoang      23/05/2021 Fix breaking problem with SocketIO. Add setExtraHeaders to SocketIO
-  2.7.0   K Hoang      24/05/2021 Add support to RP2040-based boards using Arduino-pico and Arduino mbed_rp2040 core
-  2.8.0   K Hoang      08/07/2021 Add support to WT32_ETH01 (ESP32 + LAN8720) boards
-  2.9.0   K Hoang      05/09/2021 Add support to QNEthernet Library for Teensy 4.1
-  2.10.0  K Hoang      18/09/2021 Add support to Portenta_H7, using either WiFi or Vision-shield Ethernet
-  2.10.1  K Hoang      12/10/2021 Update `platform.ini` and `library.json`
+  ...
   2.11.0  K Hoang      30/11/2021 Auto detect ESP32 core version. Fix bug in examples
   2.11.1  K Hoang      12/12/2021 Add option to use transport=websocket with sticky-session SIO server
   2.12.0  K Hoang      28/01/2022 Supporting SSL for ESP32-based WT32_ETH01 boards
   2.13.0  K Hoang      14/02/2022 Add support to ESP32_S3. Add PING and PONG SocketIO events
   2.14.0  K Hoang      17/02/2022 Suppress unnecessary warnings. Optimize code by passing by reference instead of value
   2.14.1  K Hoang      18/02/2022 Fix setInsecure() bug for WIO_Terminal. Update Packages_Patches for Seeeduino
+  2.14.2  K Hoang      27/03/2022 Fix Async bug for ESP8266 when using NETWORK_ESP8266_ASYNC
  *****************************************************************************************************************************/
 
 #pragma once