Skip to content

Commit d57e372

Browse files
committed
(doc) Documentation update
1 parent 47fdb43 commit d57e372

File tree

1 file changed

+22
-33
lines changed

1 file changed

+22
-33
lines changed

README.md

Lines changed: 22 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,50 +6,34 @@
66
[![Continuous Integration](https://github.com/ESP32Async/AsyncTCP/actions/workflows/ci.yml/badge.svg)](https://github.com/ESP32Async/AsyncTCP/actions/workflows/ci.yml)
77
[![PlatformIO Registry](https://badges.registry.platformio.org/packages/ESP32Async/library/AsyncTCP.svg)](https://registry.platformio.org/libraries/ESP32Async/AsyncTCP)
88

9-
Project moved to [ESP32Async](https://github.com/ESP32Async) organization at [https://github.com/ESP32Async/AsyncTCP](https://github.com/ESP32Async/AsyncTCP)
10-
119
Discord Server: [https://discord.gg/X7zpGdyUcY](https://discord.gg/X7zpGdyUcY)
1210

13-
Please see the new links:
14-
15-
- `ESP32Async/ESPAsyncWebServer` (ESP32, ESP8266, RP2040)
16-
- `ESP32Async/AsyncTCP` (ESP32)
17-
- `ESP32Async/ESPAsyncTCP` (ESP8266)
18-
- `https://github.com/ESP32Async/AsyncTCPSock/archive/refs/tags/v1.0.3-dev.zip` (AsyncTCP alternative for ESP32)
19-
- `khoih-prog/AsyncTCP_RP2040W` (RP2040)
20-
21-
### Async TCP Library for ESP32 Arduino
11+
## Async TCP Library for ESP32 Arduino
2212

2313
This is a fully asynchronous TCP library, aimed at enabling trouble-free, multi-connection network environment for Espressif's ESP32 MCUs.
2414

2515
This library is the base for [ESPAsyncWebServer](https://github.com/ESP32Async/ESPAsyncWebServer)
2616

17+
## How to install
18+
19+
The library can be downloaded from the releases page at [https://github.com/ESP32Async/AsyncTCP/releases](https://github.com/ESP32Async/AsyncTCP/releases).
20+
21+
It is also deployed in these registries:
22+
23+
- Arduino Library Registry: [https://github.com/arduino/library-registry](https://github.com/arduino/library-registry)
24+
25+
- ESP Component Registry [https://components.espressif.com/components/esp32async/asynctcp/](https://components.espressif.com/components/esp32async/asynctcp/)
26+
27+
- PlatformIO Registry: [https://registry.platformio.org/libraries/esp32async/AsyncTCP](https://registry.platformio.org/libraries/esp32async/AsyncTCP)
28+
29+
- Use: `lib_deps=ESP32Async/AsyncTCP` to point to latest version
30+
- Use: `lib_deps=ESP32Async/AsyncTCP @ ^<x.y.z>` to point to latest version with the same major version
31+
- Use: `lib_deps=ESP32Async/AsyncTCP @ <x.y.z>` to always point to the same version (reproductible build)
32+
2733
## AsyncClient and AsyncServer
2834

2935
The base classes on which everything else is built. They expose all possible scenarios, but are really raw and require more skills to use.
3036

31-
## Changes
32-
33-
- `library.properties` for Arduino IDE users
34-
- Add `CONFIG_ASYNC_TCP_MAX_ACK_TIME`
35-
- Add `CONFIG_ASYNC_TCP_PRIORITY`
36-
- Add `CONFIG_ASYNC_TCP_QUEUE_SIZE`
37-
- Add `setKeepAlive()`
38-
- Arduino 3 / ESP-IDF 5 compatibility
39-
- Better CI
40-
- Better example
41-
- Customizable macros
42-
- Fix for "Required to lock TCPIP core functionality". Ref: https://github.com/ESP32Async/AsyncTCP/issues/27 and https://github.com/espressif/arduino-esp32/issues/10526
43-
- Fix for "ack timeout 4" client disconnects.
44-
- Fix from https://github.com/me-no-dev/AsyncTCP/pull/173 (partially applied)
45-
- Fix from https://github.com/me-no-dev/AsyncTCP/pull/184
46-
- IPv6
47-
- LIBRETINY support
48-
- LibreTuya
49-
- Reduce logging of non critical messages
50-
- Use IPADDR6_INIT() macro to set connecting IPv6 address
51-
- xTaskCreateUniversal function
52-
5337
## Important recommendations
5438

5539
Most of the crashes are caused by improper configuration of the library for the project.
@@ -64,3 +48,8 @@ I personally use the following configuration in my projects:
6448
-D CONFIG_ASYNC_TCP_RUNNING_CORE=1 // force async_tcp task to be on same core as the app (default is core 0)
6549
-D CONFIG_ASYNC_TCP_STACK_SIZE=4096 // reduce the stack size (default is 16K)
6650
```
51+
52+
## Compatibility
53+
54+
- ESP32
55+
- Arduino Core 2.x and 3.x

0 commit comments

Comments
 (0)