8000 Correct typos in comments and documentation · smartcom-bg/ArduinoHttpClient@e9897fc · GitHub
[go: up one dir, main page]
Skip to content

Commit e9897fc

Browse files
per1234per1234
committed
Correct typos in comments and documentation
1 parent 42d8a20 commit e9897fc

File tree

18 files changed

+28
-30
lines changed

18 files changed

+28
-30
lines changed

‎CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
## ArduinoHttpClient 0.3.1 - 2017.09.25
1010

1111
* Changed examples to support Arduino Create secret tabs
12-
* Increase WebSocket secrect-key length to 24 characters
12+
* Increase WebSocket secret-key length to 24 characters
1313

1414
## ArduinoHttpClient 0.3.0 - 2017.04.20
1515

‎examples/BasicAuthGet/BasicAuthGet.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
#include <WiFi101.h>
1616
#include "arduino_secrets.h"
1717
///////please enter your sensitive data in the Secret tab/arduino_secrets.h
18-
/////// Wifi Settings ///////
18+
/////// WiFi Settings ///////
1919
char ssid[] = SECRET_SSID;
2020
char pass[] = SECRET_PASS;
2121

‎examples/CustomHeader/CustomHeader.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
#include "arduino_secrets.h"
1717
///////please enter your sensitive data in the Secret tab/arduino_secrets.h
18-
/////// Wifi Settings ///////
18+
/////// WiFi Settings ///////
1919
char ssid[] = SECRET_SSID;
2020
char pass[] = SECRET_PASS;
2121

‎examples/DweetGet/DweetGet.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
#include "arduino_secrets.h"
2222
///////please enter your sensitive data in the Secret tab/arduino_secrets.h
23-
/////// Wifi Settings ///////
23+
/////// WiFi Settings ///////
2424
char ssid[] = SECRET_SSID;
2525
char pass[] = SECRET_PASS;
2626

‎examples/DweetPost/DweetPost.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
#include "arduino_secrets.h"
1818
///////please enter your sensitive data in the Secret tab/arduino_secrets.h
19-
/////// Wifi Settings ///////
19+
/////// WiFi Settings ///////
2020
char ssid[] = SECRET_SSID;
2121
char pass[] = SECRET_PASS;
2222

‎examples/HueBlink/HueBlink.ino

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
The body of the PUT request looks like this:
1111
{"on": true} or {"on":false}
1212
13-
This example shows how to concatenate Strings to assemble the
13+
This example shows how to concatenate Strings to assemble the
1414
PUT request and the body of the request.
1515
1616
modified 15 Feb 2016
@@ -23,16 +23,16 @@
2323
#include "arduino_secrets.h"
2424

2525
///////please enter your sensitive data in the Secret tab/arduino_secrets.h
26-
/////// Wifi Settings ///////
26+
/////// WiFi Settings ///////
2727
char ssid[] = SECRET_SSID;
2828
char pass[] = SECRET_PASS;
2929

30-
int status = WL_IDLE_STATUS; // the Wifi radio's status
30+
int status = WL_IDLE_STATUS; // the WiFi radio's status
3131

3232
char hueHubIP[] = "192.168.0.3"; // IP address of the HUE bridge
3333
String hueUserName = "huebridgeusername"; // hue bridge username
3434

35-
// make a wifi instance and a HttpClient instance:
35+
// make a WiFiClient instance and a HttpClient instance:
3636
WiFiClient wifi;
3737
HttpClient httpClient = HttpClient(wifi, hueHubIP);
3838

@@ -42,7 +42,7 @@ void setup() {
4242
Serial.begin(9600);
4343
while (!Serial); // wait for serial port to connect.
4444

45-
// attempt to connect to Wifi network:
45+
// attempt to connect to WiFi network:
4646
while ( status != WL_CONNECTED) {
4747
Serial.print("Attempting to connect to WPA SSID: ");
4848
Serial.println(ssid);
@@ -95,4 +95,4 @@ void sendRequest(int light, String cmd, String value) {
9595
Serial.print("Server response: ");
9696
Serial.println(response);
9797
Serial.println();
98-
}
98+
}

‎examples/PostWithHeaders/PostWithHeaders.ino

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
POST with headers client for ArduinoHttpClient library
33
Connects to server once every five seconds, sends a POST request
4-
with custome headers and a request body
4+
with custom headers and a request body
55
66
created 14 Feb 2016
77
by Tom Igoe
@@ -18,7 +18,7 @@
1818
#include "arduino_secrets.h"
1919

2020
///////please enter your sensitive data in the Secret tab/arduino_secrets.h
21-
/////// Wifi Settings ///////
21+
/////// WiFi Settings ///////
2222
char ssid[] = SECRET_SSID;
2323
char pass[] = SECRET_PASS;
2424

‎examples/SimpleDelete/SimpleDelete.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
#include "arduino_secrets.h"
1616

1717
///////please enter your sensitive data in the Secret tab/arduino_secrets.h
18-
/////// Wifi Settings ///////
18+
/////// WiFi Settings ///////
1919
char ssid[] = SECRET_SSID;
2020
char pass[] = SECRET_PASS;
2121

‎examples/SimpleGet/SimpleGet.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
#include "arduino_secrets.h"
1515

1616
///////please enter your sensitive data in the Secret tab/arduino_secrets.h
17-
/////// Wifi Settings ///////
17+
/////// WiFi Settings ///////
1818
char ssid[] = SECRET_SSID;
1919
char pass[] = SECRET_PASS;
2020

‎examples/SimpleHttpExample/SimpleHttpExample.ino

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// Released under Apache License, version 2.0
33
//
44
// Simple example to show how to use the HttpClient library
5-
// Get's the web page given at http://<kHostname><kPath> and
5+
// Gets the web page given at http://<kHostname><kPath> and
66
// outputs the content to the serial port
77

88
#include <SPI.h>
@@ -14,7 +14,7 @@
1414
#include "arduino_secrets.h"
1515

1616
///////please enter your sensitive data in the Secret tab/arduino_secrets.h
17-
/////// Wifi Settings ///////
17+
/////// WiFi Settings ///////
1818
char ssid[] = SECRET_SSID;
1919
char pass[] = SECRET_PASS;
2020

@@ -42,7 +42,7 @@ void setup()
4242
; // wait for serial port to connect. Needed for native USB port only
4343
}
4444

45-
// attempt to connect to Wifi network:
45+
// attempt to connect to WiFi network:
4646
Serial.print("Attempting to connect to WPA SSID: ");
4747
Serial.println(ssid);
4848
while (WiFi.begin(ssid, pass) != WL_CONNECTED) {
@@ -129,5 +129,3 @@ void loop()
129129
// And just stop, now that we've tried a download
130130
while(1);
131131
}
132-
133-

‎examples/SimplePost/SimplePost.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
#include "arduino_secrets.h"
1515

1616
///////please enter your sensitive data in the Secret tab/arduino_secrets.h
17-
/////// Wifi Settings ///////
17+
/////// WiFi Settings ///////
1818
char ssid[] = SECRET_SSID;
1919
char pass[] = SECRET_PASS;
2020

‎examples/SimplePut/SimplePut.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
#include "arduino_secrets.h"
1515

1616
///////please enter your sensitive data in the Secret tab/arduino_secrets.h
17-
/////// Wifi Settings ///////
17+
/////// WiFi Settings ///////
1818
char ssid[] = SECRET_SSID;
1919
char pass[] = SECRET_PASS;
2020

‎examples/SimpleWebSocket/SimpleWebSocket.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
#include "arduino_secrets.h"
1616

1717
///////please enter your sensitive data in the Secret tab/arduino_secrets.h
18-
/////// Wifi Settings ///////
18+
/////// WiFi Settings ///////
1919
char ssid[] = SECRET_SSID;
2020
char pass[] = SECRET_PASS;
2121

‎keywords.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#######################################
2-
# Syntax Coloring Map For HttpClient
2+
# Syntax Coloring Map For ArduinoHttpClient
33
#######################################
44

55
#######################################

‎library.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "ArduinoHttpClient",
33
"keywords": "http, web, client, ethernet, wifi, GSM",
4-
"description": "Easily interact with web servers from Arduino, using HTTP and WebSocket's.",
4+
"description": "Easily interact with web servers from Arduino, using HTTP and WebSockets.",
55
"repository":
66
{
77
"type": "git",

‎library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name=ArduinoHttpClient
22
version=0.4.0
33
author=Arduino
44
maintainer=Arduino <info@arduino.cc>
5-
sentence=[EXPERIMENTAL] Easily interact with web servers from Arduino, using HTTP and WebSocket's.
5+
sentence=[EXPERIMENTAL] Easily interact with web servers from Arduino, using HTTP and WebSockets.
66
paragraph=This library can be used for HTTP (GET, POST, PUT, DELETE) requests to a web server. It also supports exchanging messages with WebSocket servers. Based on Adrian McEwen's HttpClient library.
77
category=Communication
88
url=https://github.com/arduino-libraries/ArduinoHttpClient

‎src/HttpClient.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -587,7 +587,7 @@ String HttpClient::responseBody()
587587
}
588588

589589
if (bodyLength > 0 && (unsigned int)bodyLength != response.length()) {
590-
// failure, we did not read in reponse content length bytes
590+
// failure, we did not read in response content length bytes
591591
return String((const char*)NULL);
592592
}
593593

@@ -685,7 +685,7 @@ int HttpClient::read()
685685

686686
bool HttpClient::headerAvailable()
687687
{
688-
// clear the currently store header line
688+
// clear the currently stored header line
689689
iHeaderLine = "";
690690

691691
while (!endOfHeadersReached())

‎src/HttpClient.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ class HttpClient : public Client
228228
*/
229229
String readHeaderName();
230230

231-
/** Read the vallue of the current response header.
231+
/** Read the value of the current response header.
232232
Returns empty string if a header is not available.
233233
*/
234234
String readHeaderValue();
@@ -341,7 +341,7 @@ class HttpClient : public Client
341341
// Number of milliseconds that we wait each time there isn't any data
342342
// available to be read (during status code and header processing)
343343
static const int kHttpWaitForDataDelay = 1000;
344-
// Number of milliseconds that we'll wait in total without receiveing any
344+
// Number of milliseconds that we'll wait in total without receiving any
345345
// data before returning HTTP_ERROR_TIMED_OUT (during status code and header
346346
// processing)
347347
static const int kHttpResponseTimeout = 30*1000;

0 commit comments

Comments
 (0)
0