Skip to content

Fix typos in documentation #183

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.

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

Merged
merged 2 commits into from
Feb 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

#### Description

Initializes the ethernet library and network settings.
Initializes the Ethernet library and network settings.

With version 1.0, the library supports DHCP. Using Ethernet.begin(mac) with the proper network setup, the Ethernet shield will automatically obtain an IP address. This increases the sketch size significantly. To make sure the DHCP lease is properly renewed when needed, be sure to call Ethernet.maintain() regularly.

Expand Down Expand Up @@ -2107,7 +2107,7 @@ void loop() {
Serial.print(", port ");
Serial.println(Udp.remotePort());

// read the packet into packetBufffer
// read the packet into packetBuffer
Udp.read(packetBuffer,UDP_TX_PACKET_MAX_SIZE);
Serial.println("Contents:");
Serial.println(packetBuffer);
Expand Down Expand Up @@ -2432,7 +2432,7 @@ void loop() {
Serial.print(", port ");
Serial.println(Udp.remotePort());

// read the packet into packetBufffer
// read the packet into packetBuffer
Udp.read(packetBuffer,UDP_TX_PACKET_MAX_SIZE);
Serial.println("Contents:");
Serial.println(packetBuffer);
Expand Down Expand Up @@ -2597,7 +2597,7 @@ void loop() {
Serial.print(", port ");
Serial.println(Udp.remotePort());

// read the packet into packetBufffer
// read the packet into packetBuffer
Udp.read(packetBuffer,UDP_TX_PACKET_MAX_SIZE);
Serial.println("Contents:");
Serial.println(packetBuffer);
Expand Down
3 changes: 2 additions & 1 deletion docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ The Arduino board communicates with the shield using the SPI bus. This is on dig

![Arduino MEGA Pin map.](./arduino_mega_ethernet_pins.png)

```
To use this library

```
#include <SPI.h>
#include <Ethernet.h>
```
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
SCP1000 Barometric Pressure Sensor Display
SCP1000 Barometric Pressure Sensor Display

Serves the output of a Barometric Pressure Sensor as a web page.
Uses the SPI library. For details on the sensor, see:
Expand Down Expand Up @@ -216,7 +216,7 @@ void writeRegister(byte registerName, byte registerValue) {

//Read register from the SCP1000:
unsigned int readRegister(byte registerName, int numBytes) {
byte inByte = 0; // incoming from the SPI read
byte inByte = 0; // incoming from the SPI read
unsigned int result = 0; // result to return

// SCP1000 expects the register name in the upper 6 bits
Expand Down
2 changes: 1 addition & 1 deletion examples/DhcpChatServer/DhcpChatServer.ino
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
DHCP Chat Server
DHCP Chat Server

A simple server that distributes any incoming messages to all
connected clients. To use, telnet to your device's IP address and type.
Expand Down
1 change: 1 addition & 0 deletions examples/LinkStatus/LinkStatus.ino
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/*
Link Status

This sketch prints the Ethernet link status. When the
Ethernet cable is connected the link status should go to "ON".
NOTE: Only WIZnet W5200 and W5500 are capable of reporting
Expand Down
2 changes: 1 addition & 1 deletion examples/PagerServer/PagerServer.ino
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Pager Server
Pager Server

A simple server that echoes any incoming messages to all
connected clients. Connect two or more telnet sessions
Expand Down
2 changes: 1 addition & 1 deletion examples/TelnetClient/TelnetClient.ino
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Telnet client
Telnet client

This sketch connects to a telnet server (http://www.google.com)
using an Arduino WIZnet Ethernet shield. You'll need a telnet server
Expand Down
5 changes: 3 additions & 2 deletions examples/UDPSendReceiveString/UDPSendReceiveString.ino
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/*
UDPSendReceiveString:
UDPSendReceiveString

This sketch receives UDP message strings, prints them to the serial port
and sends an "acknowledge" string back to the sender

Expand Down Expand Up @@ -82,7 +83,7 @@ void loop() {
Serial.print(", port ");
Serial.println(Udp.remotePort());

// read the packet into packetBufffer
// read the packet into packetBuffer
Udp.read(packetBuffer, UDP_TX_PACKET_MAX_SIZE);
Serial.println("Contents:");
Serial.println(packetBuffer);
Expand Down
1 change: 0 additions & 1 deletion examples/UdpNtpClient/UdpNtpClient.ino
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
/*

Udp NTP Client

Get the time from a Network Time Protocol (NTP) time server
Expand Down
2 changes: 1 addition & 1 deletion examples/WebClient/WebClient.ino
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Web client
Web client

This sketch connects to a website (http://www.google.com)
using an Arduino WIZnet Ethernet shield.
Expand Down
6 changes: 3 additions & 3 deletions examples/WebClientRepeating/WebClientRepeating.ino
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
Repeating Web client
Repeating Web client

This sketch connects to a a web server and makes a request
This sketch connects to a web server and makes a request
using a WIZnet Ethernet shield. You can use the Arduino Ethernet Shield, or
the Adafruit Ethernet shield, either one will work, as long as it's got
a WIZnet Ethernet module on board.
Expand Down Expand Up @@ -104,7 +104,7 @@ void loop() {
// this method makes a HTTP connection to the server:
void httpRequest() {
// close any connection before send a new request.
// This will free the socket on the WiFi shield
// This will free the socket on the Ethernet shield
client.stop();

// if there's a successful connection:
Expand Down
2 changes: 1 addition & 1 deletion examples/WebServer/WebServer.ino
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Web Server
Web Server

A simple web server that shows the value of the analog input pins.
using an Arduino WIZnet Ethernet shield.
Expand Down
2 changes: 1 addition & 1 deletion library.properties
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version=2.0.0
author=Various (see AUTHORS file for details)
maintainer=Paul Stoffregen <[email protected]>, Arduino <[email protected]>
sentence=Enables network connection (local and Internet) using the Arduino Ethernet Board or Shield.
paragraph=With this library you can use the Arduino Ethernet (shield or board) to connect to Internet. The library provides both Client and server functionalities. The library permits you to connect to a local network also with DHCP and to resolve DNS.
paragraph=With this library you can use the Arduino Ethernet (shield or board) to connect to Internet. The library provides both client and server functionalities. The library permits you to connect to a local network also with DHCP and to resolve DNS.
category=Communication
url=https://www.arduino.cc/en/Reference/Ethernet
architectures=*
Expand Down