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

Commit b4ed9d1

Browse files
authored
Major Release v1.0.5
### Major Release v1.0.5 1. Add support to new [**`EthernetENC library`**](https://github.com/jandrassy/EthernetENC) for ENC28J60. 2. Add support to [`Ethernet2`](https://github.com/adafruit/Ethernet2), [`Ethernet3`](https://github.com/sstaub/Ethernet3) and [`EthernetLarge`](https://github.com/OPEnSLab-OSU/EthernetLarge) libraries on top of [`Ethernet`](https://www.arduino.cc/en/Reference/Ethernet). 2. Add debug feature. Clean up code. Restructure examples.
1 parent 4cf1f6c commit b4ed9d1

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ void loop(void)
9595
- ***Nucleo-144 (F429ZI, F767ZI)***
9696
- ***Discovery (STM32F746G-DISCOVERY)***
9797
- ***All STM32 boards (STM32F/L/H/G/WB/MP1) with 32K+ Flash, with Built-in Ethernet***
98-
- See [How To Use Built-in Ethernet](https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
98+
- See [EthernetWebServer_STM32 Support and Test Results](https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
9999

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

@@ -129,11 +129,11 @@ The library supports:
129129
2. HTTP Server and Client
130130
3. HTTP GET and POST requests, provides argument parsing, handles one client at a time.
131131

132-
Library is based on and modified from [Ivan Grokhotkov's ESP8266WebServer](https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WebServer).
132+
Library is based on and modified from [`Ivan Grokhotkov's ESP8266WebServer`](https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WebServer).
133133

134134
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.
135135

136-
2. See [EthernetWebServer Library Issue 1](https://github.com/khoih-prog/EthernetWebServer/issues/1) for reason to create this separate library from [EthernetWebServer library](https://github.com/khoih-prog/EthernetWebServer)
136+
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)
137137

138138
---
139139
---
@@ -158,12 +158,12 @@ The EthernetWebServer class found in `EthernetWebServer_STM32.h` header, is a si
158158
## Installation
159159

160160
### Use Arduino Library Manager
161-
The best way is to use `Arduino Library Manager`. Search for `EthernetWebServer_STM32`, then select / install the latest version.
161+
The best way is to use `Arduino Library Manager`. Search for **`EthernetWebServer_STM32`**, then select / install the latest version.
162162
You can also use this link [![arduino-library-badge](https://www.ardu-badge.com/badge/EthernetWebServer_STM32.svg?)](https://www.ardu-badge.com/EthernetWebServer_STM32) for more detailed instructions.
163163

164164
### Manual Install
165165

166-
1. Navigate to [EthernetWebServer_STM32](https://github.com/khoih-prog/EthernetWebServer_STM32) page.
166+
1. Navigate to [**EthernetWebServer_STM32**](https://github.com/khoih-prog/EthernetWebServer_STM32) page.
167167
2. Download the latest release `EthernetWebServer_STM32-master.zip`.
168168
3. Extract the zip file to `EthernetWebServer_STM32-master` directory
169169
4. Copy whole
@@ -319,7 +319,7 @@ Standard W5x00 using Ethernet library is used by default, in the sketch, just be
319319

320320
```cpp
321321
#define USE_BUILTIN_ETHERNET false
322-
#define USE_UIP_ETHERNET true
322+
#define USE_UIP_ETHERNET false
323323

324324
#if !(USE_BUILTIN_ETHERNET || USE_UIP_ETHERNET)
325325
// Only one of the following to be true
@@ -338,7 +338,7 @@ For example, Ethernet_XYZ library uses **Ethernet_XYZ.h***
338338

339339
```cpp
340340
#define USE_BUILTIN_ETHERNET false
341-
#define USE_UIP_ETHERNET true
341+
#define USE_UIP_ETHERNET false
342342

343343
#if !(USE_BUILTIN_ETHERNET || USE_UIP_ETHERNET)
344344
// Only one of the following to be true
@@ -382,14 +382,14 @@ For example, Ethernet_XYZ library uses **Ethernet_XYZ.h***
382382

383383
**The default CS/SS pin is 10 for all boards, and is configurable in code.**
384384

385-
If the default pin is not corect, select the CS/SS pin (e.g. 22) to use as follows:
385+
If the default pin is not corect, select another CS/SS pin (e.e. D22) to use as follows:
386386

387387
```cpp
388388
// To override the default CS/SS pin. Don't use unless you know exactly which pin to use
389389
// You can define here or customize for each board at same place with BOARD_TYPE
390-
//#define USE_THIS_SS_PIN 22 //21 //5 //4 //2 //15
390+
#define USE_THIS_SS_PIN 22 //21 //5 //4 //2 //15
391391
// Default pin 10 to SS/CS. To change according to your board, if necessary
392-
#define USE_THIS_SS_PIN 10
392+
//#define USE_THIS_SS_PIN 10
393393
```
394394

395395
The current SPI pin usage can be displayed by turn on the debug option. For example:
@@ -403,7 +403,7 @@ Increase debug level to 2 in `defines.h` of any example:
403403
#define _ETHERNET_WEBSERVER_LOGLEVEL_ 2
404404
```
405405

406-
The Debug Terminal will then show that the current SPI pin usage of **NUCLEO_F767ZI uses SS/CS: D10, MOSI: D11, MISO: D12 and SCK: D13**
406+
The Debug Terminal will then show that the current SPI pin usage of **NUCLEO_F767ZI ==> SS/CS: D10, MOSI: D11, MISO: D12 and SCK: D13**
407407

408408
```
409409
[ETHERNET_WEBSERVER] Board : NUCLEO_F767ZI , setCsPin: 10
@@ -481,7 +481,7 @@ Both methods function the same
481481
void onFileUpload();
482482
```
483483

484-
Example:*
484+
Example:
485485

486486
```cpp
487487
server.on("/", handlerFunction);
@@ -617,7 +617,7 @@ Also see examples:
617617
- Nucleo-144 (F429ZI, F767ZI)
618618
- Discovery (STM32F746G-DISCOVERY)
619619
- STM32 boards (STM32F/L/H/G/WB/MP1) with 32K+ Flash, with Built-in Ethernet,
620-
- See How To Use Built-in Ethernet at (https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
620+
- See How To Use Built-in Ethernet at [EthernetWebServer_STM32 Support and Test Results](https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
621621
2) STM32F/L/H/G/WB/MP1 boards (with 32+K Flash) running ENC28J60 shields (to use USE_BUILTIN_ETHERNET = false)
622622
3) STM32F/L/H/G/WB/MP1 boards (with 32+K Flash) running W5x00 shields
623623
*/
@@ -1210,7 +1210,7 @@ This is simple yet complete WebServer library for `STM32` boards running built-i
12101210
- ***Nucleo-144 (F429ZI, F767ZI)***
12111211
- ***Discovery (STM32F746G-DISCOVERY)***
12121212
- ***All STM32 boards (STM32F/L/H/G/WB/MP1) with 32K+ Flash, with Built-in Ethernet***
1213-
- See [How To Use Built-in Ethernet](https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
1213+
- See [EthernetWebServer_STM32 Support and Test Results](https://github.com/khoih-prog/EthernetWebServer_STM32/issues/1)
12141214

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

0 commit comments

Comments
 (0)