Skip to content
This repository was archived by the owner on Jan 21, 2025. It is now read-only.

Commit 6aa552d

Browse files
committed
update readme
1 parent f74a854 commit 6aa552d

File tree

2 files changed

+31
-32
lines changed

2 files changed

+31
-32
lines changed

README.ESP32Async.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
![https://avatars.githubusercontent.com/u/195753706?s=96&v=4](https://avatars.githubusercontent.com/u/195753706?s=96&v=4)
22

3-
# Project moved to [ESP32Async](https://github.com/organizations/ESP32Async) organization at [https://github.com/ESP32Async/ESPAsyncTCP](https://github.com/ESP32Async/ESPAsyncTCP)
3+
# ESPAsyncTCP
4+
5+
Project moved to [ESP32Async](https://github.com/organizations/ESP32Async) organization at [https://github.com/ESP32Async/ESPAsyncTCP](https://github.com/ESP32Async/ESPAsyncTCP)
46

57
Discord Server: [https://discord.gg/X7zpGdyUcY](https://discord.gg/X7zpGdyUcY)
68

@@ -11,3 +13,31 @@ Please see the new links:
1113
- `ESP32Async/ESPAsyncTCP @ 2.0.0` (ESP8266)
1214
- `https://github.com/ESP32Async/AsyncTCPSock/archive/refs/tags/v1.0.3-dev.zip` (AsyncTCP alternative for ESP32)
1315
- `khoih-prog/AsyncTCP_RP2040W @ 1.2.0` (RP2040)
16+
17+
### Async TCP Library for ESP8266 Arduino
18+
19+
For ESP32 look [https://github.com/ESP32Async/AsyncTCP](https://github.com/ESP32Async/AsyncTCP)
20+
21+
This is a fully asynchronous TCP library, aimed at enabling trouble-free, multi-connection network environment for Espressif's ESP8266 MCUs.
22+
23+
This library is the base for [https://github.com/ESP32Async/ESPAsyncWebServer](https://github.com/ESP32Async/ESPAsyncWebServer)
24+
25+
## AsyncClient and AsyncServer
26+
The base classes on which everything else is built. They expose all possible scenarios, but are really raw and require more skills to use.
27+
28+
## AsyncPrinter
29+
This class can be used to send data like any other ```Print``` interface (```Serial``` for example).
30+
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.
31+
32+
## AsyncTCPbuffer
33+
This class is really similar to the ```AsyncPrinter```, but it differs in the fact that it can buffer some of the incoming data.
34+
35+
## SyncClient
36+
It is exactly what it sounds like. This is a standard, blocking TCP Client, similar to the one included in ```ESP8266WiFi```
37+
38+
## Libraries and projects that use AsyncTCP
39+
- [ESP Async Web Server](https://github.com/ESP32Async/ESPAsyncWebServer)
40+
- [Async MQTT client](https://github.com/marvinroger/async-mqtt-client)
41+
- [arduinoWebSockets](https://github.com/Links2004/arduinoWebSockets)
42+
- [ESP8266 Smart Home](https://github.com/baruch/esp8266_smart_home)
43+
- [KBox Firmware](https://github.com/sarfata/kbox-firmware)

0 commit comments

Comments
 (0)