Skip to content

Commit 4723604

Browse files
per1234per1234
committed
Correct typos in comments and documentation
1 parent 85a14d5 commit 4723604

File tree

21 files changed

+81
-115
lines changed

21 files changed

+81
-115
lines changed

‎AUTHORS

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
Alberto Panu https://github.com/bigjohnson
32
Alasdair Allan https://github.com/aallan
43
Alice Pintus https://github.com/00alis
@@ -33,6 +32,5 @@ Richard Sim
3332
Scott Fitzgerald https://github.com/shfitz
3433
Thibaut Viard https://github.com/aethaniel
3534
Tom Igoe https://github.com/tigoe
36-
WizNet http://www.wiznet.co.kr
35+
WIZnet http://www.wiznet.co.kr
3736
Zach Eveland https://github.com/zeveland
38-

‎examples/AdvancedChatServer/AdvancedChatServer.ino

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
to all connected clients but the client the message comes from.
66
To use, telnet to your device's IP address and type.
77
You can see the client's input in the serial monitor as well.
8-
Using an Arduino Wiznet Ethernet shield.
8+
Using an Arduino WIZnet Ethernet shield.
99
1010
Circuit:
1111
* Ethernet shield attached to pins 10, 11, 12, 13
@@ -42,11 +42,11 @@ EthernetClient clients[8];
4242
void setup() {
4343
// You can use Ethernet.init(pin) to configure the CS pin
4444
//Ethernet.init(10); // Most Arduino shields
45-
//Ethernet.init(5); // MKR ETH shield
45+
//Ethernet.init(5); // MKR ETH Shield
4646
//Ethernet.init(0); // Teensy 2.0
4747
//Ethernet.init(20); // Teensy++ 2.0
48-
//Ethernet.init(15); // ESP8266 with Adafruit Featherwing Ethernet
49-
//Ethernet.init(33); // ESP32 with Adafruit Featherwing Ethernet
48+
//Ethernet.init(15); // ESP8266 with Adafruit FeatherWing Ethernet
49+
//Ethernet.init(33); // ESP32 with Adafruit FeatherWing Ethernet
5050

5151
// initialize the Ethernet device
5252
Ethernet.begin(mac, ip, myDns, gateway, subnet);

‎examples/BarometricPressureWebServer/BarometricPressureWebServer.ino

+9-9
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ long lastReadingTime = 0;
6060
void setup() {
6161
// You can use Ethernet.init(pin) to configure the CS pin
6262
//Ethernet.init(10); // Most Arduino shields
63-
//Ethernet.init(5); // MKR ETH shield
63+
//Ethernet.init(5); // MKR ETH Shield
6464
//Ethernet.init(0); // Teensy 2.0
6565
//Ethernet.init(20); // Teensy++ 2.0
66-
//Ethernet.init(15); // ESP8266 with Adafruit Featherwing Ethernet
67-
//Ethernet.init(33); // ESP32 with Adafruit Featherwing Ethernet
66+
//Ethernet.init(15); // ESP8266 with Adafruit FeatherWing Ethernet
67+
//Ethernet.init(33); // ESP32 with Adafruit FeatherWing Ethernet
6868

6969
// start the SPI library:
7070
SPI.begin();
@@ -92,7 +92,7 @@ void setup() {
9292
// start listening for clients
9393
server.begin();
9494

95-
// initalize the data ready and chip select pins:
95+
// initialize the data ready and chip select pins:
9696
pinMode(dataReadyPin, INPUT);
9797
pinMode(chipSelectPin, OUTPUT);
9898

@@ -104,7 +104,7 @@ void setup() {
104104
// give the sensor and Ethernet shield time to set up:
105105
delay(1000);
106106

107-
//Set the sensor to high resolution mode tp start readings:
107+
//Set the sensor to high resolution mode to start readings:
108108
writeRegister(0x03, 0x0A);
109109

110110
}
@@ -131,7 +131,7 @@ void getData() {
131131
//Read the temperature data
132132
int tempData = readRegister(0x21, 2);
133133

134-
// convert the temperature to celsius and display it:
134+
// convert the temperature to Celsius and display it:
135135
temperature = (float)tempData / 20.0;
136136

137137
//Read the pressure data highest 3 bits:
@@ -155,16 +155,16 @@ void listenForEthernetClients() {
155155
EthernetClient client = server.available();
156156
if (client) {
157157
Serial.println("Got a client");
158-
// an http request ends with a blank line
158+
// an HTTP request ends with a blank line
159159
bool currentLineIsBlank = true;
160160
while (client.connected()) {
161161
if (client.available()) {
162162
char c = client.read();
163163
// if you've gotten to the end of the line (received a newline
164-
// character) and the line is blank, the http request has ended,
164+
// character) and the line is blank, the HTTP request has ended,
165165
// so you can send a reply
166166
if (c == '\n' && currentLineIsBlank) {
167-
// send a standard http response header
167+
// send a standard HTTP response header
168168
client.println("HTTP/1.1 200 OK");
169169
client.println("Content-Type: text/html");
170170
client.println();

‎examples/ChatServer/ChatServer.ino

+5-8
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
A simple server that distributes any incoming messages to all
55
connected clients. To use, telnet to your device's IP address and type.
66
You can see the client's input in the serial monitor as well.
7-
Using an Arduino Wiznet Ethernet shield.
7+
Using an Arduino WIZnet Ethernet shield.
88
99
Circuit:
1010
* Ethernet shield attached to pins 10, 11, 12, 13
@@ -37,13 +37,13 @@ bool alreadyConnected = false; // whether or not the client was connected previo
3737
void setup() {
3838
// You can use Ethernet.init(pin) to configure the CS pin
3939
//Ethernet.init(10); // Most Arduino shields
40-
//Ethernet.init(5); // MKR ETH shield
40+
//Ethernet.init(5); // MKR ETH Shield
4141
//Ethernet.init(0); // Teensy 2.0
4242
//Ethernet.init(20); // Teensy++ 2.0
43-
//Ethernet.init(15); // ESP8266 with Adafruit Featherwing Ethernet
44-
//Ethernet.init(33); // ESP32 with Adafruit Featherwing Ethernet
43+
//Ethernet.init(15); // ESP8266 with Adafruit FeatherWing Ethernet
44+
//Ethernet.init(33); // ESP32 with Adafruit FeatherWing Ethernet
4545

46-
// initialize the ethernet device
46+
// initialize the Ethernet device
4747
Ethernet.begin(mac, ip, myDns, gateway, subnet);
4848

4949
// Open serial communications and wait for port to open:
@@ -94,6 +94,3 @@ void loop() {
9494
}
9595
}
9696
}
97-
98-
99-

‎examples/DhcpAddressPrinter/DhcpAddressPrinter.ino

+4-5
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
This sketch uses the DHCP extensions to the Ethernet library
55
to get an IP address via DHCP and print the address obtained.
6-
using an Arduino Wiznet Ethernet shield.
6+
using an Arduino WIZnet Ethernet shield.
77
88
Circuit:
99
Ethernet shield attached to pins 10, 11, 12, 13
@@ -28,11 +28,11 @@ byte mac[] = {
2828
void setup() {
2929
// You can use Ethernet.init(pin) to configure the CS pin
3030
//Ethernet.init(10); // Most Arduino shields
31-
//Ethernet.init(5); // MKR ETH shield
31+
//Ethernet.init(5); // MKR ETH Shield
3232
//Ethernet.init(0); // Teensy 2.0
3333
//Ethernet.init(20); // Teensy++ 2.0
34-
//Ethernet.init(15); // ESP8266 with Adafruit Featherwing Ethernet
35-
//Ethernet.init(33); // ESP32 with Adafruit Featherwing Ethernet
34+
//Ethernet.init(15); // ESP8266 with Adafruit FeatherWing Ethernet
35+
//Ethernet.init(33); // ESP32 with Adafruit FeatherWing Ethernet
3636

3737
// Open serial communications and wait for port to open:
3838
Serial.begin(9600);
@@ -92,4 +92,3 @@ void loop() {
9292
break;
9393
}
9494
}
95-

‎examples/DhcpChatServer/DhcpChatServer.ino

+4-5
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
A simple server that distributes any incoming messages to all
55
connected clients. To use, telnet to your device's IP address and type.
66
You can see the client's input in the serial monitor as well.
7-
Using an Arduino Wiznet Ethernet shield.
7+
Using an Arduino WIZnet Ethernet shield.
88
99
THis version attempts to get an IP address using DHCP
1010
@@ -41,11 +41,11 @@ bool gotAMessage = false; // whether or not you got a message from the client ye
4141
void setup() {
4242
// You can use Ethernet.init(pin) to configure the CS pin
4343
//Ethernet.init(10); // Most Arduino shields
44-
//Ethernet.init(5); // MKR ETH shield
44+
//Ethernet.init(5); // MKR ETH Shield
4545
//Ethernet.init(0); // Teensy 2.0
4646
//Ethernet.init(20); // Teensy++ 2.0
47-
//Ethernet.init(15); // ESP8266 with Adafruit Featherwing Ethernet
48-
//Ethernet.init(33); // ESP32 with Adafruit Featherwing Ethernet
47+
//Ethernet.init(15); // ESP8266 with Adafruit FeatherWing Ethernet
48+
//Ethernet.init(33); // ESP32 with Adafruit FeatherWing Ethernet
4949

5050
// Open serial communications and wait for port to open:
5151
Serial.begin(9600);
@@ -99,4 +99,3 @@ void loop() {
9999
Ethernet.maintain();
100100
}
101101
}
102-

‎examples/LinkStatus/LinkStatus.ino

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
/*
22
Link Status
3-
This sketch prints the ethernet link status. When the
4-
ethernet cable is connected the link status should go to "ON".
5-
NOTE: Only WizNet W5200 and W5500 are capable of reporting
3+
This sketch prints the Ethernet link status. When the
4+
Ethernet cable is connected the link status should go to "ON".
5+
NOTE: Only WIZnet W5200 and W5500 are capable of reporting
66
the link status. W5100 will report "Unknown".
77
Hardware:
8-
- Ethernet shield or equivalent board/shield with WizNet 5200/5500
8+
- Ethernet shield or equivalent board/shield with WIZnet W5200/W5500
99
Written by Cristian Maglie
1010
This example is public domain.
1111
*/
@@ -16,11 +16,11 @@
1616
void setup() {
1717
// You can use Ethernet.init(pin) to configure the CS pin
1818
//Ethernet.init(10); // Most Arduino shields
19-
//Ethernet.init(5); // MKR ETH shield
19+
//Ethernet.init(5); // MKR ETH Shield
2020
//Ethernet.init(0); // Teensy 2.0
2121
//Ethernet.init(20); // Teensy++ 2.0
22-
//Ethernet.init(15); // ESP8266 with Adafruit Featherwing Ethernet
23-
//Ethernet.init(33); // ESP32 with Adafruit Featherwing Ethernet
22+
//Ethernet.init(15); // ESP8266 with Adafruit FeatherWing Ethernet
23+
//Ethernet.init(33); // ESP32 with Adafruit FeatherWing Ethernet
2424

2525
Serial.begin(9600);
2626
}

‎examples/TelnetClient/TelnetClient.ino

+6-10
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
/*
22
Telnet client
33
4-
This sketch connects to a a telnet server (http://www.google.com)
5-
using an Arduino Wiznet Ethernet shield. You'll need a telnet server
4+
This sketch connects to a telnet server (http://www.google.com)
5+
using an Arduino WIZnet Ethernet shield. You'll need a telnet server
66
to test this with.
7-
Processing's ChatServer example (part of the network library) works well,
7+
Processing's ChatServer example (part of the Network library) works well,
88
running on port 10002. It can be found as part of the examples
99
in the Processing application, available at
1010
http://processing.org/
@@ -39,11 +39,11 @@ EthernetClient client;
3939
void setup() {
4040
// You can use Ethernet.init(pin) to configure the CS pin
4141
//Ethernet.init(10); // Most Arduino shields
42-
//Ethernet.init(5); // MKR ETH shield
42+
//Ethernet.init(5); // MKR ETH Shield
4343
//Ethernet.init(0); // Teensy 2.0
4444
//Ethernet.init(20); // Teensy++ 2.0
45-
//Ethernet.init(15); // ESP8266 with Adafruit Featherwing Ethernet
46-
//Ethernet.init(33); // ESP32 with Adafruit Featherwing Ethernet
45+
//Ethernet.init(15); // ESP8266 with Adafruit FeatherWing Ethernet
46+
//Ethernet.init(33); // ESP32 with Adafruit FeatherWing Ethernet
4747

4848
// start the Ethernet connection:
4949
Ethernet.begin(mac, ip);
@@ -107,7 +107,3 @@ void loop() {
107107
}
108108
}
109109
}
110-
111-
112-
113-

‎examples/UDPSendReceiveString/UDPSendReceiveString.ino

+4-6
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
and sends an "acknowledge" string back to the sender
55
66
A Processing sketch is included at the end of file that can be used to send
7-
and received messages for testing with a computer.
7+
and receive messages for testing with a computer.
88
99
created 21 Aug 2010
1010
by Michael Margolis
@@ -35,11 +35,11 @@ EthernetUDP Udp;
3535
void setup() {
3636
// You can use Ethernet.init(pin) to configure the CS pin
3737
//Ethernet.init(10); // Most Arduino shields
38-
//Ethernet.init(5); // MKR ETH shield
38+
//Ethernet.init(5); // MKR ETH Shield
3939
//Ethernet.init(0); // Teensy 2.0
4040
//Ethernet.init(20); // Teensy++ 2.0
41-
//Ethernet.init(15); // ESP8266 with Adafruit Featherwing Ethernet
42-
//Ethernet.init(33); // ESP32 with Adafruit Featherwing Ethernet
41+
//Ethernet.init(15); // ESP8266 with Adafruit FeatherWing Ethernet
42+
//Ethernet.init(33); // ESP32 with Adafruit FeatherWing Ethernet
4343

4444
// start the Ethernet
4545
Ethernet.begin(mac, ip);
@@ -135,5 +135,3 @@ void loop() {
135135
println();
136136
}
137137
*/
138-
139-

‎examples/UdpNtpClient/UdpNtpClient.ino

+3-13
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ EthernetUDP Udp;
4242
void setup() {
4343
// You can use Ethernet.init(pin) to configure the CS pin
4444
//Ethernet.init(10); // Most Arduino shields
45-
//Ethernet.init(5); // MKR ETH shield
45+
//Ethernet.init(5); // MKR ETH Shield
4646
//Ethernet.init(0); // Teensy 2.0
4747
//Ethernet.init(20); // Teensy++ 2.0
48-
//Ethernet.init(15); // ESP8266 with Adafruit Featherwing Ethernet
49-
//Ethernet.init(33); // ESP32 with Adafruit Featherwing Ethernet
48+
//Ethernet.init(15); // ESP8266 with Adafruit FeatherWing Ethernet
49+
//Ethernet.init(33); // ESP32 with Adafruit FeatherWing Ethernet
5050

5151
// Open serial communications and wait for port to open:
5252
Serial.begin(9600);
@@ -144,13 +144,3 @@ void sendNTPpacket(const char * address) {
144144
Udp.write(packetBuffer, NTP_PACKET_SIZE);
145145
Udp.endPacket();
146146
}
147-
148-
149-
150-
151-
152-
153-
154-
155-
156-

‎examples/WebClient/WebClient.ino

+5-6
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Web client
33
44
This sketch connects to a website (http://www.google.com)
5-
using an Arduino Wiznet Ethernet shield.
5+
using an Arduino WIZnet Ethernet shield.
66
77
Circuit:
88
* Ethernet shield attached to pins 10, 11, 12, 13
@@ -43,11 +43,11 @@ bool printWebData = true; // set to false for better speed measurement
4343
void setup() {
4444
// You can use Ethernet.init(pin) to configure the CS pin
4545
//Ethernet.init(10); // Most Arduino shields
46-
//Ethernet.init(5); // MKR ETH shield
46+
//Ethernet.init(5); // MKR ETH Shield
4747
//Ethernet.init(0); // Teensy 2.0
4848
//Ethernet.init(20); // Teensy++ 2.0
49-
//Ethernet.init(15); // ESP8266 with Adafruit Featherwing Ethernet
50-
//Ethernet.init(33); // ESP32 with Adafruit Featherwing Ethernet
49+
//Ethernet.init(15); // ESP8266 with Adafruit FeatherWing Ethernet
50+
//Ethernet.init(33); // ESP32 with Adafruit FeatherWing Ethernet
5151

5252
// Open serial communications and wait for port to open:
5353
Serial.begin(9600);
@@ -69,7 +69,7 @@ void setup() {
6969
if (Ethernet.linkStatus() == LinkOFF) {
7070
Serial.println("Ethernet cable is not connected.");
7171
}
72-
// try to congifure using IP address instead of DHCP:
72+
// try to configure using IP address instead of DHCP:
7373
Ethernet.begin(mac, ip, myDns);
7474
} else {
7575
Serial.print(" DHCP assigned IP ");
@@ -134,4 +134,3 @@ void loop() {
134134
}
135135
}
136136
}
137-

0 commit comments

Comments
 (0)