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

Commit 1e4e1e8

Browse files
authored
v1.0.3
### Version v1.0.3 1. Fix bug not closing client and releasing socket. 2. Merge new features from latest ESP8266WebServer 3. Add and enhance examples. 4. Add back dependency to [`Functional-VLPP library`](https://github.com/khoih-prog/functional-vlpp).
1 parent a98fd9e commit 1e4e1e8

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

README.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
1. Fix bug not closing client and releasing socket.
1414
2. Merge new features from latest ESP8266WebServer
1515
3. Add and enhance examples.
16+
4. Add back dependency to [`Functional-VLPP library`](https://github.com/khoih-prog/functional-vlpp).
1617

1718
### New in Version v1.0.2
1819

@@ -53,13 +54,13 @@ The EthernetWebServer class found in `EthernetWebServer_STM32.h` header, is a si
5354
2. [`Arduino Core for STM32 1.9.0+`](https://github.com/stm32duino/Arduino_Core_STM32) for STM32 (Use Arduino Board Manager)
5455
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)
5556
4. Depending on which Ethernet card you're using:
56-
- [STM32Ethernet library](https://github.com/stm32duino/STM32Ethernet) for built-in Ethernet on (Nucleo-144, Discovery)
57-
- [`Ethernet library`](https://www.arduino.cc/en/Reference/Ethernet) for W5100, W5200 and W5500.
58-
- [`EthernetLarge library`](https://github.com/OPEnSLab-OSU/EthernetLarge) for W5100, W5200 and W5500.
59-
- [`Ethernet2 library`](https://github.com/khoih-prog/Ethernet2) for W5500.
60-
- [`Ethernet3 library`](https://github.com/sstaub/Ethernet3) for W5500/WIZ550io/WIZ850io/USR-ES1 with Wiznet W5500 chip.
61-
- [`UIPEthernet`](https://github.com/UIPEthernet/UIPEthernet) for ENC28J60
62-
4. [LwIP library](https://github.com/stm32duino/LwIP) for built-in Ethernet on (Nucleo-144, Discovery)
57+
- [`STM32Ethernet library v1.2.0+`](https://github.com/stm32duino/STM32Ethernet) for built-in Ethernet on (Nucleo-144, Discovery)
58+
- [`Ethernet library v2.0.0+`](https://www.arduino.cc/en/Reference/Ethernet) for W5100, W5200 and W5500.
59+
- [`EthernetLarge library v2.0.0+`](https://github.com/OPEnSLab-OSU/EthernetLarge) for W5100, W5200 and W5500.
60+
- [`Ethernet2 library v1.0.4+`](https://github.com/khoih-prog/Ethernet2) for W5500.
61+
- [`Ethernet3 library v1.5.3+`](https://github.com/sstaub/Ethernet3) for W5500/WIZ550io/WIZ850io/USR-ES1 with Wiznet W5500 chip.
62+
- [`UIPEthernet v2.0.8+`](https://github.com/UIPEthernet/UIPEthernet) for ENC28J60
63+
4. [`LwIP library v2.1.2+`](https://github.com/stm32duino/LwIP) for built-in Ethernet on (Nucleo-144, Discovery)
6364

6465
---
6566

@@ -143,18 +144,20 @@ Select ***one and only one*** Ethernet library to use as follows:
143144
```
144145
---
145146

146-
#### 1. Using new Ethernet Library and shield
147+
### HOWTO
148+
149+
#### 1. Use new Ethernet Library and shield
147150

148151
1. The ***Ethernet_Shield_W5200, EtherCard, EtherSia libraries are not supported***. Don't use unless you know how to modify those libraries.
149152
2. Requests to support for any future custom Ethernet library will be ignored. ***Use at your own risk***.
150153

151-
#### 2. How to select another CS/SS pin to use
154+
#### 2. Select another CS/SS pin to use
152155

153156
The default CS/SS pin is 10 for all boards.
154157

155158
---
156159

157-
#### Usage
160+
### Usage
158161

159162
#### Class Constructor
160163

@@ -305,6 +308,8 @@ Example:*
305308

306309
---
307310

311+
## Examples
312+
308313
Also see examples:
309314
1. [HelloServer](examples/HelloServer)
310315
2. [HelloServer2](examples/HelloServer2)
@@ -318,7 +323,7 @@ Also see examples:
318323
10. [WebClientRepeating](examples/WebClientRepeating)
319324
11. [WebServer](examples/WebServer)
320325

321-
## Example [AdvancedWebServer](examples/AdvancedWebServer)
326+
### Example [AdvancedWebServer](examples/AdvancedWebServer)
322327

323328
Please take a look at other examples, as well.
324329

@@ -729,13 +734,14 @@ Disconnecting from server...
729734
730735
---
731736
732-
#### New in v1.0.3
737+
### Version v1.0.3
733738
734739
1. Fix bug not closing client and releasing socket.
735740
2. Merge new features from latest ESP8266WebServer
736741
3. Add and enhance examples.
742+
4. Add back dependency to [`Functional-VLPP library`](https://github.com/khoih-prog/functional-vlpp).
737743
738-
### New in Version v1.0.2
744+
### Version v1.0.2
739745
740746
1. Remove dependendy on [`Functional-VLPP library`](https://github.com/khoih-prog/functional-vlpp).
741747
2. Enhance examples and update README.md
@@ -749,12 +755,12 @@ Disconnecting from server...
749755
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.
750756
751757
This library currently supports
752-
1. STM32 boards with built-in Ethernet such as :
758+
1. ***STM32 boards with built-in Ethernet*** such as :
753759
- Nucleo-144 (F429ZI, F767ZI)
754760
- Discovery (STM32F746G-DISCOVERY)
755761
- All STM32 Boards with Built-in Ethernet, See [How To Use Built-in Ethernet](https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
756762
757-
2. STM32 boards (with 64+K Flash) running EMC28J60 shields
763+
2. ***STM32 boards (with 64+K Flash) running EMC28J60 shields***
758764
- Nucleo-144
759765
- Nucleo-64
760766
- Discovery
@@ -781,7 +787,7 @@ and these boards are not supported:
781787
782788
---
783789
784-
## TO DO
790+
### TO DO
785791
786792
1. Bug Searching and Killing
787793
2. Add SSL/TLS Client and Server support

0 commit comments

Comments
 (0)