Skip to content

Commit fc499eb

Browse files
committed
README update
1 parent d3b91ee commit fc499eb

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,24 @@ EthernetENC is the Ethernet library for ENC28J60. It is a modern version of the
33

44
The modernization includes:
55
* Ethernet 2.0 library functions
6+
* compatible include file names EthernetClient.h, EthernetServer.h and EthernetUdp.h
67
* support of many Arduino architectures by using the SPI library
78
* SPI transactions to share the SPI bus with devices with different communication settings
89
* SPI communication at 20 MHz if the MCU supports it, else on the maximum supported by the MCU
910
* client.flush() to send the packet immediately
1011

11-
[The documentation of Arduino Ethernet library](https://www.arduino.cc/en/Reference/Ethernet) applies for class and functions descriptions.
12+
[The documentation of Arduino Ethernet library](https://www.arduino.cc/en/Reference/Ethernet) applies for classes and functions descriptions.
1213

13-
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>`.
14+
Limitations:
15+
* UDP.beginMulticast is not supported, because the uIP stack doesn't support multicast
16+
* UDB broadcasts receiving is turned off on ENC to lower the processing load on the library
17+
* EthernetServer doesn't support the print-to-all-clients functionality, because it takes flash memory space and RAM (10 bytes) and nobody uses it
1418

15-
This library is based on the Norbert Truchsess's arduino-uip original source code repository and uses experience from the development of the multiarchitecture support by Cassy for UIPEthernet library which is published in Library Manager. Applicable fixes and enhancements from developed of EthernetENC were transfered to Cassy's UIPEthernet.
19+
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).
1620

17-
You can find more information in project's [Wiki](https://github.com/jandrassy/EthernetENC/wiki).
21+
This library is based on the Norbert Truchsess's arduino-uip original source code repository and uses experience from the development of the multiarchitecture support by Cassy. Applicable fixes and enhancements from developed of EthernetENC were transfered to Cassy's UIPEthernet.
22+
23+
**You can find more information in project's [Wiki](https://github.com/jandrassy/EthernetENC/wiki).**
1824

1925
## Original notes by Norbert Truchsess
2026

library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name=EthernetENC
2-
author=Norbert Truchsess, maintainer Juraj Andrassy
2+
author=Norbert Truchsess, Juraj Andrassy
33
maintainer=Juraj Andrassy <[email protected]>
44
sentence=Ethernet library for ENC28J60. Only include EthernetENC.h instead of Ethernet.h
55
paragraph=This is a modern version of the UIPEthernet library. EthernetENC library is compatible with all Arduino architectures with Arduino SPI library with transactions support.

0 commit comments

Comments
 (0)