Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Elaborated on the requirements of this library. #253

Merged
merged 1 commit into from Oct 22, 2016
Merged

Elaborated on the requirements of this library. #253

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Expand Up @@ -9,6 +9,25 @@ License: GPL2

The documentation for this library is at http://jeelabs.net/pub/docs/ethercard/.

## Requirements

* Hardware: This library **only** supports the ENC28J60 chip.
* Hardware: Only AVR-based microcontrollers are supported, such as:
* Arduino Uno
* Arduino Mega
* Arduino Leonardo
* Arduino Nano/Pro/Fio/Pro-mini/LiliPad/Duemilanove
* Any other Arduino clone using an AVR microcontroller should work
* Hardware: Non-AVR boards are **NOT** currently supported (101/Zero/Due)
[#211](https://github.com/jcw/ethercard/issues/211#issuecomment-255011491)
* Hardware: Depending on the size of the buffer for packets, this library
uses about 1k of Arduino RAM. Large strings and other global variables
can easily push the limits of smaller microcontrollers.
* Hardware: This library uses the SPI interface of the microcontroller,
and will require at least one dedicated pin for CS, plus the SO, SI, and
SCK pins of the SPI interface.
* Software: Any Arduino IDE >= 1.0.0 should be fine

## Library Installation

1. Download the ZIP file from https://github.com/jcw/ethercard/archive/master.zip
Expand Down