Repository files navigation

• Important Notes
• Why do we need this ESPAsyncTCP library
  • Features
  • Why Async is better
  • Currently supported Boards
• Changelog
• Async TCP Library for ESP8266 Arduino
• Documentation
  • AsyncClient and AsyncServer
  • AsyncPrinter
  • AsyncTCPbuffer
  • SyncClient
• Examples
  • 1. Client
  • 2. Server
  • 3. SyncClient
• Libraries and projects that use ESPAsyncTCP
• Contributions and Thanks
• Contributing
• License
• Copyright

The new ESP8266 cores v3.0.2+ introduces many new breaking features, such as replacingaxtls withbearssl, as well as good ones such as LwIP EthernetW5500lwIP,W5100lwIP andENC28J60lwIP libraries.

Because the originalESPAsyncTCP library is not well maintained to cope with dynamic environment of new cores, features, etc., this forkedESPAsyncTCP library is created as an effort to trythe best to keep up with the fast changes and avoid compile errors in future cores or dependent libraries.

Hopefully thebearssl feature of new ESP8266 cores will be added to this library in the near future to support SSL.

This library is based on, modified from:

1. Hristo Gochkov's ESPAsyncTCP

to apply the better and fasterasynchronous feature of thepowerfulESPAsyncTCP Library with SSL, and will be the base for other more advanced Async libraries for ESP8266, such as ESPAsyncWebServer, AsyncHTTPRequest, AsyncHTTPSRequest, etc.

• Using asynchronous network means that you can handlemore than one connection at the same time
• You are called once the request is ready and parsed
• When you send the response, you areimmediately ready to handle other connections while the server is taking care of sending the response in the background
• Speed is OMG
• Easy to use API, HTTP Basic and Digest MD5 Authentication (default), ChunkedResponse
• Easily extensible to handleany type of content
• Supports Continue 100
• Async WebSocket plugin offering different locations without extra servers or ports
• Async EventSource (Server-Sent Events) plugin to send events to the browser
• URL Rewrite plugin for conditional and permanent url rewrites
• ServeStatic plugin that supports cache, Last-Modified, default index and more
• Simple template processing engine to handle templates

1. ESP8266 boards

For ESP32, checkAsyncTCP orAsyncTCP_SSL

This is a fully asynchronous TCP library, aimed at enabling trouble-free, multi-connection network environment for Espressif's ESP8266 MCUs, using WiFi or LwIP Ethernet (W5500lwIP, W5100lwIP and ENC28J60lwIP libraries)

This library is the base forESPAsyncWebServer

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

This class can be used to send data like any otherPrint interface (Serial for example).

The object then can be used outside of the Async callbacks (the loop) and receive asynchronously data usingonData. The object can be checked if the underlyingAsyncClient is connected, or hook to theonDisconnect callback.

This class is really similar to theAsyncPrinter, but it differs in the fact that it can buffer some of the incoming data.

It is exactly what it sounds like. This is a standard, blocking TCP Client, similar to the one included inESP8266WiFi

1. Client
2. Server
3. SyncClient

• ESP Async Web Server
• Async MQTT client
• arduinoWebSockets
• ESP8266 Smart Home
• KBox Firmware

• AsyncMQTT_Generic
• ESPAsync_WiFiManager
• AsyncHTTPRequest_Generic
• AsyncHTTPSRequest_Generic
• ESPAsync_WiFiManager_Lite
• AsyncWebServer_Ethernet

and many more to come.

Submit issues to:ESPAsyncTCP issues

1. Search for bug and improvement.
2. Addbearssl Async features for new cores
3. Removehard-code if possible

1. Try to convert to use with new ESP8266 cores v3.0.2+ withoutaxtls support
2. Add Table of Contents
3. Modify examples\
4. Add astyle usingallman style. Restyle the library

Many thanks for everyone for bug reporting, new feature suggesting, testing and contributing to the development of this library.

1. Based on and modified fromHristo Gochkov's ESPAsyncTCP. Many thanks toHristo Gochkov for greatESPAsyncTCP Library

⭐️⭐️ Hristo Gochkov

If you want to contribute to this project:

• Report bugs and errors
• Ask for enhancements
• Create issues and pull requests
• Tell other people about this library

• The library is licensed underLGPLv3

• Copyright (c) 2016- Hristo Gochkov
• Copyright (c) 2022- Khoi Hoang