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

Commit 01227fe

Browse files
authored
Update README.md
Add note about [AsyncWebServer_STM32 Library](https://github.com/khoih-prog/AsyncWebServer_STM32)
1 parent 2d1cb43 commit 01227fe

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,53 @@
77
[![GitHub issues](https://img.shields.io/github/issues/khoih-prog/EthernetWebServer_STM32.svg)](http://github.com/khoih-prog/EthernetWebServer_STM32/issues)
88

99
---
10+
---
11+
12+
### Important Note for STM32F boards using built-in LAN8742A Ethernet
13+
14+
This [**EthernetWebServer_STM32 Library**](https://github.com/khoih-prog/EthernetWebServer_STM32), by design, is working synchronously. The Client requests must be handled by continuously checking in loop() using :
15+
16+
```cpp
17+
void loop(void)
18+
{
19+
server.handleClient();
20+
}
21+
```
22+
23+
The new [**AsyncWebServer_STM32 Library**](https://github.com/khoih-prog/AsyncWebServer_STM32), in contrast, is designed to work asynchronously. The Client requests are handled on demand, without continuously checking in loop(). The loop() now can be as simple as :
24+
25+
```cpp
26+
void loop(void)
27+
{
28+
}
29+
```
30+
31+
#### Currently Supported Boards by [**AsyncWebServer_STM32**](https://github.com/khoih-prog/AsyncWebServer_STM32)
32+
33+
1. Nucleo-144 (F429ZI, F746ZG, F756ZG, F767ZI)
34+
2. Discovery STM32F746G-DISCOVERY
35+
3. Any STM32 boards with enough flash/memory and already configured to run LAN8742A Ethernet.
36+
37+
---
38+
39+
#### Why do we need the new Async [AsyncWebServer_STM32 library](https://github.com/khoih-prog/AsyncWebServer_STM32)
40+
41+
- Using asynchronous network means that you can handle **more than one connection at the same time**
42+
- **You are called once the request is ready and parsed**
43+
- When you send the response, you are **immediately ready** to handle other connections while the server is taking care of sending the response in the background
44+
- **Speed is OMG**
45+
- **Easy to use API, HTTP Basic and Digest MD5 Authentication (default), ChunkedResponse**
46+
- Easily extensible to handle **any type of content**
47+
- Supports Continue 100
48+
- **Async WebSocket plugin offering different locations without extra servers or ports**
49+
- Async EventSource (Server-Sent Events) plugin to send events to the browser
50+
- URL Rewrite plugin for conditional and permanent url rewrites
51+
- ServeStatic plugin that supports cache, Last-Modified, default index and more
52+
- Simple template processing engine to handle templates
53+
54+
---
55+
---
56+
1057

1158
#### New in v1.0.4
1259

0 commit comments

Comments
 (0)