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

Commit 5ae883f

Browse files
authored
Update
1 parent ce52e88 commit 5ae883f

File tree

2 files changed

+41
-34
lines changed

2 files changed

+41
-34
lines changed

README.md

Lines changed: 39 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ void loop(void)
6868

6969
#### New in v1.0.4
7070

71-
1. Add support to all STM32 boards (***STM32F/L/H/G/WB/MP1***) with 32K+ Flash.
71+
1. Add support to all STM32 boards (**STM32F/L/H/G/WB/MP1**) with 32K+ Flash.
7272

7373
- STM32L0, STM32L1, STM32L4
7474
- STM32G0, STM32G4
@@ -90,20 +90,20 @@ void loop(void)
9090

9191
### New in Version v1.0.1
9292

93-
1. Add support to ***W5x00*** Ethernet shields to all STM32 boards having 64+K bytes Flash.
93+
1. Add support to **W5x00** Ethernet shields to all STM32 boards having 64+K bytes Flash.
9494

9595
---
9696

9797
#### Supporting Boards
9898

99-
1. ***STM32 boards with built-in Ethernet LAN8742A*** such as :
99+
1. **STM32 boards with built-in Ethernet LAN8742A** such as :
100100

101-
- ***Nucleo-144 (F429ZI, F767ZI)***
102-
- ***Discovery (STM32F746G-DISCOVERY)***
103-
- ***All STM32 boards (STM32F/L/H/G/WB/MP1) with 32K+ Flash, with Built-in Ethernet***
101+
- **Nucleo-144 (F429ZI, F767ZI)**
102+
- **Discovery (STM32F746G-DISCOVERY)**
103+
- **All STM32 boards (STM32F/L/H/G/WB/MP1) with 32K+ Flash, with Built-in Ethernet**
104104
- See [EthernetWebServer_STM32 Support and Test Results](https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
105105

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

108108
- Nucleo-144
109109
- Nucleo-64
@@ -146,7 +146,7 @@ The EthernetWebServer class found in `EthernetWebServer_STM32.h` header, is a si
146146

147147
## Prerequisite
148148

149-
1. [`Arduino IDE 1.8.12+` for Arduino](https://www.arduino.cc/en/Main/Software)
149+
1. [`Arduino IDE 1.8.13+` for Arduino](https://www.arduino.cc/en/Main/Software)
150150
2. [`Arduino Core for STM32 1.9.0+`](https://github.com/stm32duino/Arduino_Core_STM32) for STM32 (Use Arduino Board Manager)
151151
3. [`Functional-VLPP library v1.0.1+`](https://github.com/khoih-prog/functional-vlpp) to use server's lambda function. To install. check [![arduino-library-badge](https://www.ardu-badge.com/badge/Functional-Vlpp.svg?)](https://www.ardu-badge.com/Functional-Vlpp)
152152
4. Depending on which Ethernet card you're using:
@@ -156,7 +156,7 @@ The EthernetWebServer class found in `EthernetWebServer_STM32.h` header, is a si
156156
- [`Ethernet2 library v1.0.4+`](https://github.com/adafruit/Ethernet2) for W5500.
157157
- [`Ethernet3 library v1.5.3+`](https://github.com/sstaub/Ethernet3) for W5500/WIZ550io/WIZ850io/USR-ES1 with Wiznet W5500 chip.
158158
- [`EthernetENC library v2.0.0+`](https://github.com/jandrassy/EthernetENC) for ENC28J60. **New and Better**
159-
- [`UIPEthernet library v2.0.8+`](https://github.com/UIPEthernet/UIPEthernet) for ENC28J60.
159+
- [`UIPEthernet library v2.0.9+`](https://github.com/UIPEthernet/UIPEthernet) for ENC28J60.
160160
5. [`LwIP library v2.1.2+`](https://github.com/stm32duino/LwIP) for built-in Ethernet on (Nucleo-144, Discovery)
161161

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

180180
1. Install [VS Code](https://code.visualstudio.com/)
181181
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)
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)
183183
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)
184184

185185
---
@@ -217,7 +217,7 @@ To add UDP Multicast support, necessary for this [**UPnP_Generic library**](http
217217
- [Ethernet3.h](LibraryPatches/Ethernet3/src/Ethernet3.h)
218218
- [Ethernet3.cpp](LibraryPatches/Ethernet3/src/Ethernet3.cpp)
219219

220-
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:
220+
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:
221221

222222
- [UIPEthernet.h](LibraryPatches/UIPEthernet/UIPEthernet.h)
223223
- [UIPEthernet.cpp](LibraryPatches/UIPEthernet/UIPEthernet.cpp)
@@ -346,7 +346,7 @@ Standard W5x00 using Ethernet library is used by default, in the sketch, just be
346346
```
347347

348348
- To use another Ethernet library
349-
For example, Ethernet_XYZ library uses **Ethernet_XYZ.h***
349+
For example, Ethernet_XYZ library uses **Ethernet_XYZ.h**
350350

351351
```cpp
352352
#define USE_BUILTIN_ETHERNET false
@@ -475,19 +475,19 @@ host port number: ``int port`` (default is the standard HTTP port 80)
475475
476476
#### Basic Operations
477477
478-
***Starting the server***
478+
**Starting the server**
479479
480480
```cpp
481481
void begin();
482482
```
483483

484-
***Handling incoming client requests***
484+
**Handling incoming client requests**
485485

486486
```cpp
487487
void handleClient();
488488
```
489489

490-
***Disabling the server***
490+
**Disabling the server**
491491

492492
```cpp
493493
void close();
@@ -496,7 +496,7 @@ host port number: ``int port`` (default is the standard HTTP port 80)
496496

497497
Both methods function the same
498498

499-
***Client request handlers***
499+
**Client request handlers**
500500

501501
```cpp
502502
void on();
@@ -513,7 +513,7 @@ Example:
513513
server.onFileUpload(handlerFunction); // handle file uploads
514514
```
515515

516-
***Sending responses to the client***
516+
**Sending responses to the client**
517517

518518
```cpp
519519
void send();
@@ -531,7 +531,7 @@ Example:
531531

532532
#### Advanced Options
533533

534-
***Getting information about request arguments***
534+
**Getting information about request arguments**
535535

536536
```cpp
537537
const String & arg();
@@ -550,7 +550,7 @@ Example:
550550

551551
`hasArg` - check if argument exist
552552

553-
***Getting information about request headers***
553+
**Getting information about request headers**
554554

555555
```cpp
556556
const String & header();
@@ -571,7 +571,7 @@ Example:
571571

572572
`hasHeader` - check if header exist
573573

574-
***Authentication***
574+
**Authentication**
575575

576576
```cpp
577577
bool authenticate();
@@ -798,6 +798,7 @@ void loop(void)
798798
```
799799
800800
#### 2. File [defines.h](examples/AdvancedWebServer/defines.h)
801+
801802
```cpp
802803
#ifndef defines_h
803804
#define defines_h
@@ -1230,20 +1231,20 @@ The UTC time is 22:20:21
12301231

12311232
### Version v1.0.0
12321233

1233-
This is simple yet complete WebServer library for `STM32` 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.
1234+
This is simple yet complete WebServer library for `STM32` 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.
12341235

12351236
---
12361237

12371238
#### Supporting Boards
12381239

1239-
1. ***STM32 boards with built-in Ethernet LAN8742A*** such as :
1240+
1. **STM32 boards with built-in Ethernet LAN8742A** such as :
12401241

1241-
- ***Nucleo-144 (F429ZI, F767ZI)***
1242-
- ***Discovery (STM32F746G-DISCOVERY)***
1243-
- ***All STM32 boards (STM32F/L/H/G/WB/MP1) with 32K+ Flash, with Built-in Ethernet***
1242+
- **Nucleo-144 (F429ZI, F767ZI)**
1243+
- **Discovery (STM32F746G-DISCOVERY)**
1244+
- **All STM32 boards (STM32F/L/H/G/WB/MP1) with 32K+ Flash, with Built-in Ethernet**
12441245
- See [EthernetWebServer_STM32 Support and Test Results](https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
12451246

1246-
2. ***STM32F/L/H/G/WB/MP1 boards (with 32+K Flash) running W5x00 or ENC28J60 shields)***
1247+
2. **STM32F/L/H/G/WB/MP1 boards (with 32+K Flash) running W5x00 or ENC28J60 shields)**
12471248

12481249
- Nucleo-144
12491250
- Nucleo-64
@@ -1279,6 +1280,12 @@ These boards are not supported:
12791280
---
12801281
---
12811282

1283+
### Issues ###
1284+
1285+
Submit issues to: [EthernetWebServer_STM32 issues](https://github.com/khoih-prog/EthernetWebServer_STM32/issues)
1286+
1287+
---
1288+
12821289
### TO DO
12831290

12841291
1. Bug Searching and Killing
@@ -1289,11 +1296,11 @@ These boards are not supported:
12891296

12901297
### DONE
12911298

1292-
1. Add support to ***STM32F1,2,3,4,7 boards*** with 64K+ Flash.
1293-
2. Add support to ***built-in Ethernet LAN8742A*** using [STM32Ethernet library](https://github.com/stm32duino/STM32Ethernet), for boards such as Nucleo-144 NUCLEO_F767ZI.
1294-
3. Add support to ***Ethernet W5x00***, using either [`Ethernet`](https://www.arduino.cc/en/Reference/Ethernet), [`Ethernet2`](https://github.com/khoih-prog/Ethernet2), [`Ethernet3`](https://github.com/sstaub/Ethernet3) or [`EthernetLarge`](https://github.com/OPEnSLab-OSU/EthernetLarge) library
1295-
4. Add support to Ethernet ***ENC28J60***, using [`EthernetENC`](https://github.com/jandrassy/EthernetENC) or [`UIPEthernet`](https://github.com/UIPEthernet/UIPEthernet) library
1296-
5. Add support to all STM32 boards (***STM32F/L/H/G/WB/MP1***) with 32K+ Flash.
1299+
1. Add support to **STM32F1,2,3,4,7 boards** with 64K+ Flash.
1300+
2. Add support to **built-in Ethernet LAN8742A** using [STM32Ethernet library](https://github.com/stm32duino/STM32Ethernet), for boards such as Nucleo-144 NUCLEO_F767ZI.
1301+
3. Add support to **Ethernet W5x00**, using either [`Ethernet`](https://www.arduino.cc/en/Reference/Ethernet), [`Ethernet2`](https://github.com/khoih-prog/Ethernet2), [`Ethernet3`](https://github.com/sstaub/Ethernet3) or [`EthernetLarge`](https://github.com/OPEnSLab-OSU/EthernetLarge) library
1302+
4. Add support to Ethernet **ENC28J60**, using [`EthernetENC`](https://github.com/jandrassy/EthernetENC) or [`UIPEthernet`](https://github.com/UIPEthernet/UIPEthernet) library
1303+
5. Add support to all STM32 boards (**STM32F/L/H/G/WB/MP1**) with 32K+ Flash.
12971304

12981305
---
12991306

@@ -1327,7 +1334,7 @@ If you want to contribute to this project:
13271334

13281335
### License
13291336

1330-
- The library is licensed under [MIT](https://github.com/khoih-prog/EthernetWebServer/blob/master/LICENSE)
1337+
- The library is licensed under [MIT](https://github.com/khoih-prog/EthernetWebServer_STM32/blob/master/LICENSE)
13311338

13321339
---
13331340

platformio/platformio.ini

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ lib_deps =
3131
STM32duino LwIP@~2.1.2
3232
STM32duino STM32Ethernet@~1.2.0
3333
Functional-Vlpp@~1.0.1
34-
UIPEthernet@~2.0.8
34+
UIPEthernet@~2.0.9
3535
Ethernet@~2.0.0
3636
EthernetLarge@~2.0.0
3737
Ethernet2@~1.0.4
@@ -41,7 +41,7 @@ lib_deps =
4141
; stm32duino/STM32duino LwIP@~2.1.2
4242
; stm32duino/STM32duino STM32Ethernet@~1.2.0
4343
; khoih-prog/Functional-Vlpp@~1.0.1
44-
; UIPEthernet/UIPEthernet@~2.0.8
44+
; UIPEthernet/UIPEthernet@~2.0.9
4545
; PaulStoffregen/Ethernet@~2.0.0
4646
; PaulStoffregen/EthernetLarge@~2.0.0
4747
; adafruit/Ethernet2@~1.0.4

0 commit comments

Comments
 (0)