6b0100fd61
* Add and remove libs and components for Arduino Core 3 * Arduino Core 3 * Add back Solo1 * Change ESP32-S3 to 4MB build * Update README.md * Fix retain and number of retries * Fix rolling log * Fix defaults * Fix BleScanner on Solo1 * Export settings * Import settings * Fix HA Battery voltage * Change submodule * Update espMqttClient and AsyncTCP * Webserial and MQTT/Network reconnecting * Update nuki_ble --------- Co-authored-by: iranl <iranl@github.com>
53 lines
2.5 KiB
Markdown
53 lines
2.5 KiB
Markdown
# AsyncTCP
|
|
|
|
[](https://opensource.org/license/lgpl-3-0/)
|
|
[](https://github.com/mathieucarbou/AsyncTCP/actions/workflows/push.yml)
|
|
[](https://registry.platformio.org/libraries/mathieucarbou/Async%20TCP)
|
|
|
|
A fork of the [AsyncTCP](https://github.com/me-no-dev/AsyncTCP) library by [@me-no-dev](https://github.com/me-no-dev) for [ESPHome](https://esphome.io).
|
|
|
|
### Async TCP Library for ESP32 Arduino
|
|
|
|
This is a fully asynchronous TCP library, aimed at enabling trouble-free, multi-connection network environment for Espressif's ESP32 MCUs.
|
|
|
|
This library is the base for [ESPAsyncWebServer](https://github.com/mathieucarbou/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.
|
|
|
|
## Changes in this fork
|
|
|
|
- All improvements from [ESPHome fork](https://github.com/esphome/AsyncTCP)
|
|
- Reverted back `library.properties` for Arduino IDE users
|
|
- Arduino 3 / ESP-IDF 5 compatibility
|
|
- Changed lib name: `AsyncTCP` -> `Async TCP`
|
|
- Point to `mathieucarbou/Async TCP @ ^3.1.4`
|
|
- IPv6 support
|
|
|
|
## Important recommendations
|
|
|
|
Most of the crashes are caused by improper configuration of the library for the project.
|
|
Here are some recommendations to avoid them.
|
|
|
|
1. Set the running core to be on the same core of your application (usually core 1) `-D CONFIG_ASYNC_TCP_RUNNING_CORE=1`
|
|
2. Set the stack size appropriately with `-D CONFIG_ASYNC_TCP_STACK_SIZE=16384`.
|
|
The default value of `16384` might be too much for your project.
|
|
You can look at the [MycilaTaskMonitor](https://oss.carbou.me/MycilaTaskMonitor) project to monitor the stack usage.
|
|
3. You can change **if you know what you are doing** the task priority with `-D CONFIG_ASYNC_TCP_PRIORITY=10`.
|
|
Default is `10`.
|
|
4. You can increase the queue size with `-D CONFIG_ASYNC_TCP_QUEUE_SIZE=128`.
|
|
Default is `64`.
|
|
5. You can decrease the maximum ack time `-D CONFIG_ASYNC_TCP_MAX_ACK_TIME=3000`.
|
|
Default is `5000`.
|
|
|
|
I personally use the following configuration in my projects:
|
|
|
|
```c++
|
|
-D CONFIG_ASYNC_TCP_MAX_ACK_TIME=3000
|
|
-D CONFIG_ASYNC_TCP_PRIORITY=10
|
|
-D CONFIG_ASYNC_TCP_QUEUE_SIZE=128
|
|
-D CONFIG_ASYNC_TCP_RUNNING_CORE=1
|
|
-D CONFIG_ASYNC_TCP_STACK_SIZE=4096
|
|
```
|