This library is designed to work with the Arduino Ethernet Shield, Arduino Ethernet Shield 2, Leonardo Ethernet, and any other W5100/W5200/W5500-based devices. The library allows an Arduino board to connect to the Internet. The board can serve as either a server accepting incoming connections or a client making outgoing ones. The library supports up to eight (W5100 and boards with <= 2 kB SRAM are limited to four) concurrent connections (incoming, outgoing, or a combination).

The Arduino board 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 Ethernet controller chip, but it must be kept as an output or the SPI interface won't work.

Examples

• ChatServer: set up a simple chat server.
• WebClient: make a HTTP request.
• WebClientRepeating: Make repeated HTTP requests.
• WebServer: host a simple HTML page that displays analog sensor values.
• BarometricPressureWebServer: outputs the values from a barometric pressure sensor as a web page.
• UDPSendReceiveString: Send and receive text strings via UDP.
• UdpNtpClient: Query a Network Time Protocol (NTP) server using UDP.
• DnsWebClient: DNS and DHCP-based Web client.
• DhcpChatServer: A simple DHCP Chat Server
• DhcpAddressPrinter: Get an IP address via DHCP and print it out
• TelnetClient: A simple Telnet client
  
  

Ethernet class

The Ethernet class initializes the ethernet library and network settings.

• begin()
• dnsServerIP()
• gatewayIP()
• hardwareStatus()
• init()
• linkStatus()
• localIP()
• MACAddress()
• maintain()
• setDnsServerIP()
• setGatewayIP()
• setLocalIP()
• setMACAddress()
• setRetransmissionCount()
• setRetransmissionTimeout()
• setSubnetMask()
• subnetMask()

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()
• accept()
• available()
• if(server)
• write()
• print()
• println()

Client class

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

• Client
• EthernetClient()
• if (EthernetClient)
• connected()
• connect()
• localPort()
• remoteIP()
• remotePort()
• setConnectionTimeout()
• 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()
• stop()
• remoteIP()
• remotePort()