Buy Download Getting Started Learning Reference Hardware FAQ

Reference   Language | Libraries | Comparison | Changes

Ethernet library

With the Arduino Ethernet Shield, this library allows an Arduino board to connect to the internet. It can serve as either a server accepting incoming connections or a client making outgoing ones. The library supports up to four concurrent connection (incoming or outgoing or a combination).

Arduino communicates with the shield using the SPI bus. This is on digital pins 11, 12, and 13 on the Uno and pins 50, 51, and 52 on the Mega. On both boards, pin 10 is used as SS. On the Mega, the hardware SS pin, 53, is not used to select the W5100, but it must be kept as an output or the SPI interface won't work.

Ethernet class

The Ethernet class initializes the ethernet library and network settings.

• begin()
• localIP()

IPAddress class

The IPAddress class works with local and remote IP addressing.

• IPAddress()

Server class

The Server class creates servers which can send data to and receive data from connected clients (programs running on other computers or devices).

• Server

• EthernetServer()
• begin()
• available()
• write()
• print()
• println()

Client class

The client class creates clients that can connect to servers and send and receive data.

• Client

• EthernetClient()
• connected()
• connect()
• write()
• print()
• println()
• available()
• read()
• flush()
• stop()

EthernetUDP class

The EthernetUDP class enables UDP message to be sent and received.

• begin()
• read()
• write()
• beginPacket()
• endPacket()
• parsePacket()
• available()
• remoteIP()
• remotePort()

Reference Home

Corrections, suggestions, and new documentation should be posted to the Forum.

The text of the Arduino reference is licensed under a Creative Commons Attribution-ShareAlike 3.0 License. Code samples in the reference are released into the public domain.