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

Commit 6dda231

Browse files
khoih-progkhoih-prog
authored
Update README
1 parent 5ae883f commit 6dda231

File tree

1 file changed

+40
-25
lines changed

1 file changed

+40
-25
lines changed

‎README.md

Lines changed: 40 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,26 @@ void loop(void)
5454
---
5555
---
5656

57+
### Why do we need this [EthernetWebServer_STM32 library](https://github.com/khoih-prog/EthernetWebServer_STM32)
58+
59+
This [**EthernetWebServer_STM32 library**](https://github.com/khoih-prog/EthernetWebServer_STM32) is a simple yet complete WebServer library for **STM32F/L/H/G/WB/MP1** boards using built-in Ethernet (Nucleo-144, Discovery), W5x00 or ENC28J60 Ethernet shields.
60+
61+
The functions are similar and compatible to those of [`ESP32 WebServer`](https://github.com/espressif/arduino-esp32/tree/master/libraries/WebServer) and [`ESP8266WebServer`](https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WebServer) libraries to make life much easier to port sketches from ESP8266/ESP32.
62+
63+
The [**EthernetWebServer_STM32 library**](https://github.com/khoih-prog/EthernetWebServer_STM32) supports:
64+
65+
1. TCP/UDP Server and Client
66+
2. HTTP Server and Client
67+
3. HTTP GET and POST requests, provides argument parsing, handles one client at a time.
68+
69+
[**EthernetWebServer_STM32 library**](https://github.com/khoih-prog/EthernetWebServer_STM32) is based on and modified from [`Ivan Grokhotkov's ESP8266WebServer`](https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WebServer).
70+
71+
The `EthernetWebServer class` found in `EthernetWebServer_STM32.h` header, is a simple web server that knows how to handle HTTP requests such as GET and POST and can only support one simultaneous client.
72+
73+
Check [`EthernetWebServer Library Issue: Support for STM32F Series`](https://github.com/khoih-prog/EthernetWebServer/issues/1) for reason to create this separate library from [`EthernetWebServer library`](https://github.com/khoih-prog/EthernetWebServer)
74+
75+
---
76+
5777
### Release v1.0.6
5878

5979
1. Add support to PROGMEM-related commands, such as sendContent_P() and send_P()
@@ -81,7 +101,7 @@ void loop(void)
81101
1. Fix bug not closing client and releasing socket.
82102
2. Merge new features from latest ESP8266WebServer
83103
3. Add and enhance examples.
84-
4. Add back dependency to [`Functional-VLPP library`](https://github.com/khoih-prog/functional-vlpp).
104+
4. Restore dependency to [`Functional-VLPP library`](https://github.com/khoih-prog/functional-vlpp).
85105

86106
### New in Version v1.0.2
87107

@@ -125,21 +145,6 @@ void loop(void)
125145

126146
2. ENC28J60 using new [`EthernetENC`](https://github.com/jandrassy/EthernetENC) or [`UIPEthernet`](https://github.com/UIPEthernet/UIPEthernet) library
127147

128-
---
129-
130-
This is simple yet complete WebServer library for `STM32F/L/H/G/WB/MP1` boards running built-in Ethernet (Nucleo-144, Discovery) or EMC28J60 Ethernet shields. The functions are similar and compatible to ESP8266/ESP32 WebServer libraries to make life much easier to port sketches from ESP8266/ESP32.
131-
132-
The library supports:
133-
134-
1. TCP/UDP Server and Client
135-
2. HTTP Server and Client
136-
3. HTTP GET and POST requests, provides argument parsing, handles one client at a time.
137-
138-
Library is based on and modified from [`Ivan Grokhotkov's ESP8266WebServer`](https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WebServer).
139-
140-
The EthernetWebServer class found in `EthernetWebServer_STM32.h` header, is a simple web server that knows how to handle HTTP requests such as GET and POST and can only support one simultaneous client.
141-
142-
2. See [`EthernetWebServer Library Issue: Support for STM32F Series`](https://github.com/khoih-prog/EthernetWebServer/issues/1) for reason to create this separate library from [`EthernetWebServer library`](https://github.com/khoih-prog/EthernetWebServer)
143148

144149
---
145150
---
@@ -179,7 +184,7 @@ You can also use this link [![arduino-library-badge](https://www.ardu-badge.com/
179184

180185
1. Install [VS Code](https://code.visualstudio.com/)
181186
2. Install [PlatformIO](https://platformio.org/platformio-ide)
182-
3. Install **EthernetWebServer_STM32** library by using [Library Manager](https://docs.platformio.org/en/latest/librarymanager/). Search for **EthernetWebServer_STM32** in [Platform.io Author's Libraries](https://platformio.org/lib/search?query=author:%22Khoi%20Hoang%22)
187+
3. Install [**EthernetWebServer_STM32** library](https://platformio.org/lib/show/7077/EthernetWebServer_STM32) by using [Library Manager](https://platformio.org/lib/show/7077/EthernetWebServer_STM32/installation). Search for **EthernetWebServer_STM32** in [Platform.io Author's Libraries](https://platformio.org/lib/search?query=author:%22Khoi%20Hoang%22)
183188
4. Use included [platformio.ini](platformio/platformio.ini) file from examples to ensure that all dependent libraries will installed automatically. Please visit documentation for the other options and examples at [Project Configuration File](https://docs.platformio.org/page/projectconf.html)
184189

185190
---
@@ -219,10 +224,19 @@ To add UDP Multicast support, necessary for this [**UPnP_Generic library**](http
219224

220225
6. **To be able to compile and run on nRF52 boards with ENC28J60 using UIPEthernet library**, you have to copy these following files into the UIPEthernet `utility` directory to overwrite the old files:
221226

222-
- [UIPEthernet.h](LibraryPatches/UIPEthernet/UIPEthernet.h)
223-
- [UIPEthernet.cpp](LibraryPatches/UIPEthernet/UIPEthernet.cpp)
224-
- [Enc28J60Network.h](LibraryPatches/UIPEthernet/utility/Enc28J60Network.h)
225-
- [Enc28J60Network.cpp](LibraryPatches/UIPEthernet/utility/Enc28J60Network.cpp)
227+
- For [UIPEthernet v2.0.8](https://github.com/UIPEthernet/UIPEthernet)
228+
229+
- [UIPEthernet.h](LibraryPatches/UIPEthernet/UIPEthernet.h)
230+
- [UIPEthernet.cpp](LibraryPatches/UIPEthernet/UIPEthernet.cpp)
231+
- [Enc28J60Network.h](LibraryPatches/UIPEthernet/utility/Enc28J60Network.h)
232+
- [Enc28J60Network.cpp](LibraryPatches/UIPEthernet/utility/Enc28J60Network.cpp)
233+
234+
- For [UIPEthernet v2.0.9](https://github.com/UIPEthernet/UIPEthernet)
235+
236+
- [UIPEthernet.h](LibraryPatches/UIPEthernet-2.0.9/UIPEthernet.h)
237+
- [UIPEthernet.cpp](LibraryPatches/UIPEthernet-2.0.9/UIPEthernet.cpp)
238+
- [Enc28J60Network.h](LibraryPatches/UIPEthernet-2.0.9/utility/Enc28J60Network.h)
239+
- [Enc28J60Network.cpp](LibraryPatches/UIPEthernet-2.0.9/utility/Enc28J60Network.cpp)
226240

227241
7. Check if you need to install the UIPthernet patch [new STM32 core F3/F4 compatibility](https://github.com/UIPEthernet/UIPEthernet/commit/c6d6519a260166b722b9cee5dd1f0fb2682e6782) to avoid errors `#include HardwareSPI.h` on some STM32 boards (Nucleo-32 F303K8, etc.)
228242

@@ -588,7 +602,8 @@ Example:
588602

589603
```cpp
590604

591-
if(!server.authenticate(username, password)){
605+
if(!server.authenticate(username, password))
606+
{
592607
server.requestAuthentication();
593608
}
594609
```
@@ -1206,7 +1221,7 @@ The UTC time is 22:20:21
12061221

12071222
#### New in v1.0.4
12081223

1209-
1. Add support to all STM32 boards (STM32F/L/H/G/WB/MP1) with 32K+ Flash.
1224+
1. Add support to all STM32 boards (**STM32F/L/H/G/WB/MP1**) with 32K+ Flash.
12101225
- STM32L0, STM32L1, STM32L4
12111226
- STM32G0, STM32G4
12121227
- STM32H7
@@ -1218,7 +1233,7 @@ The UTC time is 22:20:21
12181233
1. Fix bug not closing client and releasing socket.
12191234
2. Merge new features from latest ESP8266WebServer
12201235
3. Add and enhance examples.
1221-
4. Add back dependency to [`Functional-VLPP library`](https://github.com/khoih-prog/functional-vlpp).
1236+
4. Restore dependency to [`Functional-VLPP library`](https://github.com/khoih-prog/functional-vlpp).
12221237

12231238
### Version v1.0.2
12241239

@@ -1242,7 +1257,7 @@ This is simple yet complete WebServer library for `STM32` boards running built-i
12421257
- **Nucleo-144 (F429ZI, F767ZI)**
12431258
- **Discovery (STM32F746G-DISCOVERY)**
12441259
- **All STM32 boards (STM32F/L/H/G/WB/MP1) with 32K+ Flash, with Built-in Ethernet**
1245-
- See [EthernetWebServer_STM32 Support and Test Results](https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
1260+
- Check [EthernetWebServer_STM32 Support and Test Results](https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
12461261

12471262
2. **STM32F/L/H/G/WB/MP1 boards (with 32+K Flash) running W5x00 or ENC28J60 shields)**
12481263

0 commit comments

Comments
 (0)