Skip to content

Commit b49562a

Browse files
committed
Update README.md
Signed-off-by: Frederic Pillon <[email protected]>
1 parent b0f2a3f commit b49562a

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

+16-7
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,30 @@
1-
# STM32Ethernet
2-
3-
## Ethernet Library for Arduino
1+
# STM32 Ethernet Library for Arduino
42

53
With an STM32 board with Ethernet compatibility, this library allows a STM32
64
board (NUCLEO, DISCOVERY, ...) to connect to the internet.
75

86
This library follows the Ethernet API from Arduino.<br>
97
For more information about it please visit: http://www.arduino.cc/en/Reference/Ethernet
108

11-
## Note
9+
## Dependency
1210

13-
The library is based on LwIP, a Lightweight TCP/IP stack, available here:
11+
This library is based on LwIP, a Lightweight TCP/IP stack, available here:
1412

1513
http://git.savannah.gnu.org/cgit/lwip.git
1614

17-
The LwIP has been ported as Arduino library. The STM32Ethernet library depends
18-
on it.
15+
The LwIP has been ported as Arduino library and is available thanks Arduino Library Manager.
16+
17+
Source: https://github.com/stm32duino/LwIP
18+
19+
## Configuration
20+
21+
The LwIP has several user defined options, which is specified from within the `lwipopts.h` file.
22+
23+
This library provides a default user defined options file named `lwipopts_default.h`.
24+
25+
User can provide his own defined options at sketch level by adding his configuration in a file named `STM32lwipopts.h`.
26+
27+
## Note
1928

2029
`EthernetClass::maintain()` in no more required to renew IP address from DHCP.<br>
2130
It is done automatically by the LwIP stack in a background task.

0 commit comments

Comments
 (0)