Skip to content

Commit f122db4

Browse files
committed
README update - notes for ESP
1 parent 71c1269 commit f122db4

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,22 @@ The modernization includes:
1111
* calls yield() in blocking functions
1212
* Arduino 1.5 library format built with dot_a_linkage option for optimal build result
1313

14+
<details>
15+
<summary>Notes for ESP (click to expand)</summary>
16+
17+
* *For esp8266 Arduino there is a much better option for enc28j60 than using this library. Use the lwIP_enc28j60 library bundled with esp8266 Arduino boards support package 3. (There is also a lwIP_w5500 and lwIP_w5100 library.)*
18+
* *For ESP32 it is better than using a MAC layer module like the enc28j60 to use a PHY layer LAN module like LAN8720 supported by the ESP32 MAC peripheral and the Arduino boards support package.*
19+
</details>
20+
1421
[The documentation of Arduino Ethernet library](https://www.arduino.cc/en/Reference/Ethernet) applies for classes and functions descriptions.
1522

1623
Limitations:
1724
* UDP.beginMulticast is not supported, because the uIP stack doesn't support multicast
1825
* UDP broadcasts receiving is turned off on ENC to lower the processing load on the library
1926

20-
This library doesn't have examples, because examples of the Arduino Ethernet library apply. You can find them in the Arduino IDE Examples menu Ethernet section. Only change `#include <Ethernet.h>` to `#include <EthernetENC.h>`. Some examples require [a little change](https://github.com/jandrassy/EthernetENC/wiki/Examples).
27+
This library doesn't have examples, because examples of the Arduino Ethernet library apply. You can find them in the Arduino IDE Examples menu Ethernet section. Only change `#include <Ethernet.h>` to `#include <EthernetENC.h>`. Some examples require [a little change](https://github.com/jandrassy/EthernetENC/wiki/Examples).
2128

22-
This library is based on the Norbert Truchsess's arduino-uip original source code repository and uses experience from the development of the multi-architecture support by Cassy. Applicable fixes and enhancements from developed of EthernetENC were transfered to Cassy's UIPEthernet.
29+
This library is based on the Norbert Truchsess's arduino-uip original source code repository and uses experience from the development of the multi-architecture support by Cassy. Applicable fixes and enhancements from development of EthernetENC were transfered to Cassy's UIPEthernet.
2330

2431
**You can find more information in project's [Wiki](https://github.com/jandrassy/EthernetENC/wiki).**
2532

0 commit comments

Comments
 (0)