This repository has been archived by the owner on Jan 20, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 396
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Prepare move to https://github.com/ESP32Async
- Loading branch information
1 parent
fed2fef
commit 2d1f4d7
Showing
5 changed files
with
52 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,13 @@ | ||
# ESPAsyncTCP | ||
![https://avatars.githubusercontent.com/u/195753706?s=96&v=4](https://avatars.githubusercontent.com/u/195753706?s=96&v=4) | ||
|
||
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). | ||
# Project moved to [ESP32Async](https://github.com/organizations/ESP32Async) organization at [https://github.com/ESP32Async/ESPAsyncTCP](https://github.com/ESP32Async/ESPAsyncTCP) | ||
|
||
### Async TCP Library for ESP8266 Arduino | ||
Discord Server: [https://discord.gg/X7zpGdyUcY](https://discord.gg/X7zpGdyUcY) | ||
|
||
For ESP32 look [HERE](https://github.com/me-no-dev/AsyncTCP) | ||
Please see the new links: | ||
|
||
[![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) | ||
|
||
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) | ||
- `khoih-prog/AsyncTCP_RP2040W @ 1.2.0` (RP2040) | ||
- `https://github.com/ESP32Async/AsyncTCPSock/archive/refs/tags/v1.0.3-dev.zip` (AsyncTCP alternative for ESP32) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,19 @@ | ||
{ | ||
"name":"ESPAsyncTCP-esphome", | ||
"name":"ESPAsyncTCP", | ||
"description":"Asynchronous TCP Library for ESP8266", | ||
"keywords":"async,tcp", | ||
"authors": | ||
{ | ||
"name": "Hristo Gochkov", | ||
"name": "ESP32Async", | ||
"maintainer": true | ||
}, | ||
"repository": | ||
{ | ||
"type": "git", | ||
"url": "https://github.com/esphome/ESPAsyncTCP.git" | ||
"url": "https://github.com/ESP32Async/ESPAsyncTCP.git" | ||
}, | ||
"version": "2.0.0", | ||
"license": "LGPL-3.0", | ||
"frameworks": "arduino", | ||
"platforms": "espressif8266", | ||
"build": { | ||
"libCompatMode": 2 | ||
} | ||
"platforms": "espressif8266" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,9 @@ | ||
name=ESPAsyncTCP-esphome | ||
name=ESP AsyncTCP | ||
version=2.0.0 | ||
author=Me-No-Dev | ||
maintainer=ESPHome | ||
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/esphome/ESPAsyncTCP.git | ||
url=https://github.com/ESP32Async/ESPAsyncTCP | ||
architectures=* |