Prepare move to https://github.com/ESP32Async/ESPAsyncTCP (#196)

* Create fork for esphome

* Correct ssl  recv (#1)

Co-authored-by: M Hightower <27247790+mhightower83@users.noreply.github.com>

* Remove _tx_unsent_len (#3)

* Bump version to v1.2.3

* Remove Arduino IDE support

* Update library.json

* Update README.md

* Delete .travis.yml

* Fix Github Action (#2)

* Preparation for IPv6 support (#1)

* Bump version to 2.0.0

* Fixing CI

* Add back library.properties

* Prepare move to https://github.com/ESP32Async

---------

Co-authored-by: Otto Winter <otto@otto-winter.com>
Co-authored-by: moritzj29 <18733473+moritzj29@users.noreply.github.com>
Co-authored-by: M Hightower <27247790+mhightower83@users.noreply.github.com>
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
Co-authored-by: Jimmy Hedman <jimmy.hedman@gmail.com>

Author: 6 people

.github/scripts/on-push.sh

@@ -7,7 +7,7 @@ if [ ! -z "$TRAVIS_BUILD_DIR" ]; then
 	export GITHUB_REPOSITORY="$TRAVIS_REPO_SLUG"
 elif [ -z "$GITHUB_WORKSPACE" ]; then
 	export GITHUB_WORKSPACE="$PWD"
-	export GITHUB_REPOSITORY="me-no-dev/ESPAsyncTCP"
+	export GITHUB_REPOSITORY="ESP32Async/ESPAsyncTCP"
 fi
 
 CHUNK_INDEX=$1
@@ -34,7 +34,7 @@ if [ "$BUILD_PIO" -eq 0 ]; then
 	build_sketches "$FQBN" "$GITHUB_WORKSPACE/examples"
 	if [ ! "$OS_IS_WINDOWS" == "1" ]; then
 		echo "Installing ESPAsyncWebServer ..."
-		git clone https://github.com/me-no-dev/ESPAsyncWebServer "$ARDUINO_USR_PATH/libraries/ESPAsyncWebServer" > /dev/null 2>&1
+		git clone https://github.com/ESP32Async/ESPAsyncWebServer "$ARDUINO_USR_PATH/libraries/ESPAsyncWebServer" > /dev/null 2>&1
 
 		echo "Installing ArduinoJson ..."
 		git clone https://github.com/bblanchon/ArduinoJson "$ARDUINO_USR_PATH/libraries/ArduinoJson" > /dev/null 2>&1
@@ -53,8 +53,8 @@ else
 
 	if [[ "$OSTYPE" != "cygwin" ]] && [[ "$OSTYPE" != "msys" ]] && [[ "$OSTYPE" != "win32" ]]; then
 		echo "Installing ESPAsyncWebServer ..."
-		python -m platformio lib -g install https://github.com/me-no-dev/ESPAsyncWebServer.git > /dev/null 2>&1
-		git clone https://github.com/me-no-dev/ESPAsyncWebServer "$HOME/ESPAsyncWebServer" > /dev/null 2>&1
+		python -m platformio lib -g install https://github.com/ESP32Async/ESPAsyncWebServer.git > /dev/null 2>&1
+		git clone https://github.com/ESP32Async/ESPAsyncWebServer "$HOME/ESPAsyncWebServer" > /dev/null 2>&1
 
 		echo "Installing ArduinoJson ..."
 		python -m platformio lib -g install https://github.com/bblanchon/ArduinoJson.git > /dev/null 2>&1

.github/workflows/push.yml

@@ -1,32 +1,30 @@
 name: ESP Async TCP CI
 
 on:
+  workflow_dispatch:
   push:
-    branches:
-    - master
-    - release/*
   pull_request:
 
 jobs:
 
-  build-arduino:
-    name: Arduino on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest, windows-latest, macOS-latest]
-    steps:
-    - uses: actions/checkout@v1
-    - name: Build Tests
-      run: bash ./.github/scripts/on-push.sh 0 1
-
   build-pio:
     name: PlatformIO on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macOS-latest]
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
+    - uses: actions/cache@v3
+      with:
+        path: |
+          ~/.cache/pip
+          ~/.platformio/.cache
+        key: ${{ runner.os }}-pio
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    - name: Install PlatformIO Core
+      run: pip install --upgrade platformio
     - name: Build Tests
       run: bash ./.github/scripts/on-push.sh 1 1

.travis.yml

@@ -0,0 +1,31 @@
+# ESPAsyncTCP 
+
+Discord Server: [https://discord.gg/X7zpGdyUcY](https://discord.gg/X7zpGdyUcY)
+
+### Async TCP Library for ESP8266 Arduino
+
+For ESP32 look [https://github.com/ESP32Async/AsyncTCP](https://github.com/ESP32Async/AsyncTCP)
+
+This is a fully asynchronous TCP library, aimed at enabling trouble-free, multi-connection network environment for Espressif's ESP8266 MCUs.
+
+This library is the base for [https://github.com/ESP32Async/ESPAsyncWebServer](https://github.com/ESP32Async/ESPAsyncWebServer)
+
+## AsyncClient and AsyncServer
+The base classes on which everything else is built. They expose all possible scenarios, but are really raw and require more skills to use.
+
+## AsyncPrinter
+This class can be used to send data like any other ```Print``` interface (```Serial``` for example).
+The object then can be used outside of the Async callbacks (the loop) and receive asynchronously data using ```onData```. The object can be checked if the underlying ```AsyncClient```is connected, or hook to the ```onDisconnect``` callback.
+
+## AsyncTCPbuffer
+This class is really similar to the ```AsyncPrinter```, but it differs in the fact that it can buffer some of the incoming data.
+
+## SyncClient
+It is exactly what it sounds like. This is a standard, blocking TCP Client, similar to the one included in ```ESP8266WiFi```
+
+## Libraries and projects that use AsyncTCP
+- [ESP Async Web Server](https://github.com/ESP32Async/ESPAsyncWebServer)
+- [Async MQTT client](https://github.com/marvinroger/async-mqtt-client)
+- [arduinoWebSockets](https://github.com/Links2004/arduinoWebSockets)
+- [ESP8266 Smart Home](https://github.com/baruch/esp8266_smart_home)
+- [KBox Firmware](https://github.com/sarfata/kbox-firmware)

README.ESP32Async.md

@@ -1,32 +1,13 @@
-# ESPAsyncTCP 
-[![Build Status](https://travis-ci.org/me-no-dev/ESPAsyncTCP.svg?branch=master)](https://travis-ci.org/me-no-dev/ESPAsyncTCP) ![](https://github.com/me-no-dev/ESPAsyncTCP/workflows/ESP%20Async%20TCP%20CI/badge.svg)
+![https://avatars.githubusercontent.com/u/195753706?s=96&v=4](https://avatars.githubusercontent.com/u/195753706?s=96&v=4)
 
-### Async TCP Library for ESP8266 Arduino
+# Project moved to [ESP32Async](https://github.com/organizations/ESP32Async) organization at [https://github.com/ESP32Async/ESPAsyncTCP](https://github.com/ESP32Async/ESPAsyncTCP)
 
-For ESP32 look [HERE](https://github.com/me-no-dev/AsyncTCP)
+Discord Server: [https://discord.gg/X7zpGdyUcY](https://discord.gg/X7zpGdyUcY)
 
-[![Join the chat at https://gitter.im/me-no-dev/ESPAsyncWebServer](https://badges.gitter.im/me-no-dev/ESPAsyncWebServer.svg)](https://gitter.im/me-no-dev/ESPAsyncWebServer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+Please see the new links:
 
-This is a fully asynchronous TCP library, aimed at enabling trouble-free, multi-connection network environment for Espressif's ESP8266 MCUs.
-
-This library is the base for [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer)
-
-## AsyncClient and AsyncServer
-The base classes on which everything else is built. They expose all possible scenarios, but are really raw and require more skills to use.
-
-## AsyncPrinter
-This class can be used to send data like any other ```Print``` interface (```Serial``` for example).
-The object then can be used outside of the Async callbacks (the loop) and receive asynchronously data using ```onData```. The object can be checked if the underlying ```AsyncClient```is connected, or hook to the ```onDisconnect``` callback.
-
-## AsyncTCPbuffer
-This class is really similar to the ```AsyncPrinter```, but it differs in the fact that it can buffer some of the incoming data.
-
-## SyncClient
-It is exactly what it sounds like. This is a standard, blocking TCP Client, similar to the one included in ```ESP8266WiFi```
-
-## Libraries and projects that use AsyncTCP
-- [ESP Async Web Server](https://github.com/me-no-dev/ESPAsyncWebServer)
-- [Async MQTT client](https://github.com/marvinroger/async-mqtt-client)
-- [arduinoWebSockets](https://github.com/Links2004/arduinoWebSockets)
-- [ESP8266 Smart Home](https://github.com/baruch/esp8266_smart_home)
-- [KBox Firmware](https://github.com/sarfata/kbox-firmware)
+- `ESP32Async/ESPAsyncWebServer @ 3.6.0` (ESP32, ESP8266, RP2040)
+- `ESP32Async/AsyncTCP @ 3.3.2` (ESP32)
+- `ESP32Async/ESPAsyncTCP @ 2.0.0` (ESP8266)
+- `https://github.com/ESP32Async/AsyncTCPSock/archive/refs/tags/v1.0.3-dev.zip` (AsyncTCP alternative for ESP32)
+- `khoih-prog/AsyncTCP_RP2040W @ 1.2.0` (RP2040)

README.md

@@ -4,19 +4,16 @@
   "keywords":"async,tcp",
   "authors":
   {
-    "name": "Hristo Gochkov",
+    "name": "ESP32Async",
     "maintainer": true
   },
   "repository":
   {
     "type": "git",
-    "url": "https://github.com/me-no-dev/ESPAsyncTCP.git"
+    "url": "https://github.com/ESP32Async/ESPAsyncTCP.git"
   },
-  "version": "1.2.2",
+  "version": "2.0.0",
   "license": "LGPL-3.0",
   "frameworks": "arduino",
-  "platforms": "espressif8266",
-  "build": {
-    "libCompatMode": 2
-  }
+  "platforms": "espressif8266"
 }

library.json

@@ -1,9 +1,9 @@
 name=ESP AsyncTCP
-version=1.2.2
-author=Me-No-Dev
-maintainer=Me-No-Dev
+version=2.0.0
+author=ESP32Async
+maintainer=ESP32Async
 sentence=Async TCP Library for ESP8266 and ESP31B
 paragraph=Async TCP Library for ESP8266 and ESP31B
 category=Other
-url=https://github.com/me-no-dev/ESPAsyncTCP
+url=https://github.com/ESP32Async/ESPAsyncTCP
 architectures=*

library.properties

@@ -27,18 +27,34 @@ inline struct _DEBUG_TIME_STAMP debugTimeStamp(void) {
 }
 #endif
 
+#if defined(DEBUG_ESP_PORT) && !defined(DEBUG_ESP_PORT_PRINTF)
+
+#ifdef __cplusplus
+#define DEBUG_ESP_PORT_PRINTF(format, ...)   DEBUG_ESP_PORT.printf((format), ##__VA_ARGS__)
+#define DEBUG_ESP_PORT_PRINTF_F(format, ...) DEBUG_ESP_PORT.printf_P(PSTR(format), ##__VA_ARGS__)
+#define DEBUG_ESP_PORT_FLUSH DEBUG_ESP_PORT.flush
+#else
+// Handle debug printing from .c without CPP Stream, Print, ... classes
+// Cannot handle flash strings in this setting
+#define DEBUG_ESP_PORT_PRINTF ets_uart_printf
+#define DEBUG_ESP_PORT_PRINTF_F ets_uart_printf
+#define DEBUG_ESP_PORT_FLUSH (void)0
+#endif
+
+#endif
+
 #if defined(DEBUG_ESP_PORT) && !defined(DEBUG_GENERIC)
   #define DEBUG_GENERIC( module, format, ... ) \
     do { \
       struct _DEBUG_TIME_STAMP st = debugTimeStamp(); \
-      DEBUG_ESP_PORT.printf( DEBUG_TIME_STAMP_FMT module " " format, st.whole, st.dec, ##__VA_ARGS__ ); \
+      DEBUG_ESP_PORT_PRINTF( (DEBUG_TIME_STAMP_FMT module " " format), st.whole, st.dec, ##__VA_ARGS__ ); \
     } while(false)
 #endif
-#if defined(DEBUG_ESP_PORT) && !defined(DEBUG_GENERIC_P)
-  #define DEBUG_GENERIC_P( module, format, ... ) \
+#if defined(DEBUG_ESP_PORT) && !defined(DEBUG_GENERIC_F)
+  #define DEBUG_GENERIC_F( module, format, ... ) \
     do { \
       struct _DEBUG_TIME_STAMP st = debugTimeStamp(); \
-      DEBUG_ESP_PORT.printf_P(PSTR( DEBUG_TIME_STAMP_FMT module " " format ), st.whole, st.dec, ##__VA_ARGS__ ); \
+      DEBUG_ESP_PORT_PRINTF_F( (DEBUG_TIME_STAMP_FMT module " " format), st.whole, st.dec, ##__VA_ARGS__ ); \
     } while(false)
 #endif
 
@@ -47,16 +63,16 @@ inline struct _DEBUG_TIME_STAMP debugTimeStamp(void) {
   do { \
     if ( !(a) ) { \
       DEBUG_GENERIC( module, "%s:%s:%u: ASSERT("#a") failed!\n", __FILE__, __func__, __LINE__); \
-      DEBUG_ESP_PORT.flush(); \
+      DEBUG_ESP_PORT_FLUSH(); \
     } \
   } while(false)
 #endif
-#if defined(DEBUG_GENERIC_P) && !defined(ASSERT_GENERIC_P)
-#define ASSERT_GENERIC_P( a, module ) \
+#if defined(DEBUG_GENERIC_F) && !defined(ASSERT_GENERIC_F)
+#define ASSERT_GENERIC_F( a, module ) \
   do { \
     if ( !(a) ) { \
-      DEBUG_GENERIC_P( module, "%s:%s:%u: ASSERT("#a") failed!\n", __FILE__, __func__, __LINE__); \
-      DEBUG_ESP_PORT.flush(); \
+      DEBUG_GENERIC_F( module, "%s:%s:%u: ASSERT("#a") failed!\n", __FILE__, __func__, __LINE__); \
+      DEBUG_ESP_PORT_FLUSH(); \
     } \
   } while(false)
 #endif
@@ -65,32 +81,32 @@ inline struct _DEBUG_TIME_STAMP debugTimeStamp(void) {
 #define DEBUG_GENERIC(...) do { (void)0;} while(false)
 #endif
 
-#ifndef DEBUG_GENERIC_P
-#define DEBUG_GENERIC_P(...) do { (void)0;} while(false)
+#ifndef DEBUG_GENERIC_F
+#define DEBUG_GENERIC_F(...) do { (void)0;} while(false)
 #endif
 
 #ifndef ASSERT_GENERIC
 #define ASSERT_GENERIC(...) do { (void)0;} while(false)
 #endif
 
-#ifndef ASSERT_GENERIC_P
-#define ASSERT_GENERIC_P(...) do { (void)0;} while(false)
+#ifndef ASSERT_GENERIC_F
+#define ASSERT_GENERIC_F(...) do { (void)0;} while(false)
 #endif
 
 #ifndef DEBUG_ESP_PRINTF
-#define DEBUG_ESP_PRINTF( format, ...) DEBUG_GENERIC_P("[%s]", format, &_FILENAME_[1], ##__VA_ARGS__)
+#define DEBUG_ESP_PRINTF( format, ...) DEBUG_GENERIC_F("[%s]", format, &_FILENAME_[1], ##__VA_ARGS__)
 #endif
 
 #if defined(DEBUG_ESP_ASYNC_TCP) && !defined(ASYNC_TCP_DEBUG)
-#define ASYNC_TCP_DEBUG( format, ...) DEBUG_GENERIC_P("[ASYNC_TCP]", format, ##__VA_ARGS__)
+#define ASYNC_TCP_DEBUG( format, ...) DEBUG_GENERIC_F("[ASYNC_TCP]", format, ##__VA_ARGS__)
 #endif
 
 #ifndef ASYNC_TCP_ASSERT
-#define ASYNC_TCP_ASSERT( a ) ASSERT_GENERIC_P( (a), "[ASYNC_TCP]")
+#define ASYNC_TCP_ASSERT( a ) ASSERT_GENERIC_F( (a), "[ASYNC_TCP]")
 #endif
 
 #if defined(DEBUG_ESP_TCP_SSL) && !defined(TCP_SSL_DEBUG)
-#define TCP_SSL_DEBUG( format, ...) DEBUG_GENERIC_P("[TCP_SSL]", format, ##__VA_ARGS__)
+#define TCP_SSL_DEBUG( format, ...) DEBUG_GENERIC_F("[TCP_SSL]", format, ##__VA_ARGS__)
 #endif
 
 #endif //_DEBUG_PRINT_MACROS_H