arduino/ArduinoHttpClient
1
0
Fork 0
mirror of https://github.com/arduino-libraries/ArduinoHttpClient.git synced 2025-04-19 21:22:15 +03:00
Code

Correct typos in comments and documentation

Browse Source
This commit is contained in:
per1234 2021-04-11 21:53:59 -07:00
parent 42d8a204f0
commit e9897fc568
18 changed files with 28 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -9,7 +9,7 @@
## ArduinoHttpClient 0.3.1 - 2017.09.25 ## ArduinoHttpClient 0.3.1 - 2017.09.25
* Changed examples to support Arduino Create secret tabs * Changed examples to support Arduino Create secret tabs
* Increase WebSocket secrect-key length to 24 characters * Increase WebSocket secret-key length to 24 characters
## ArduinoHttpClient 0.3.0 - 2017.04.20 ## ArduinoHttpClient 0.3.0 - 2017.04.20

2
examples/BasicAuthGet/BasicAuthGet.ino
View File

@ -15,7 +15,7 @@
#include <WiFi101.h> #include <WiFi101.h>
#include "arduino_secrets.h" #include "arduino_secrets.h"
///////please enter your sensitive data in the Secret tab/arduino_secrets.h ///////please enter your sensitive data in the Secret tab/arduino_secrets.h
/////// Wifi Settings /////// /////// WiFi Settings ///////
char ssid[] = SECRET_SSID; char ssid[] = SECRET_SSID;
char pass[] = SECRET_PASS; char pass[] = SECRET_PASS;

2
examples/CustomHeader/CustomHeader.ino
View File

@ -15,7 +15,7 @@
#include "arduino_secrets.h" #include "arduino_secrets.h"
///////please enter your sensitive data in the Secret tab/arduino_secrets.h ///////please enter your sensitive data in the Secret tab/arduino_secrets.h
/////// Wifi Settings /////// /////// WiFi Settings ///////
char ssid[] = SECRET_SSID; char ssid[] = SECRET_SSID;
char pass[] = SECRET_PASS; char pass[] = SECRET_PASS;

2
examples/DweetGet/DweetGet.ino
View File

@ -20,7 +20,7 @@
#include "arduino_secrets.h" #include "arduino_secrets.h"
///////please enter your sensitive data in the Secret tab/arduino_secrets.h ///////please enter your sensitive data in the Secret tab/arduino_secrets.h
/////// Wifi Settings /////// /////// WiFi Settings ///////
char ssid[] = SECRET_SSID; char ssid[] = SECRET_SSID;
char pass[] = SECRET_PASS; char pass[] = SECRET_PASS;

2
examples/DweetPost/DweetPost.ino
View File

@ -16,7 +16,7 @@
#include "arduino_secrets.h" #include "arduino_secrets.h"
///////please enter your sensitive data in the Secret tab/arduino_secrets.h ///////please enter your sensitive data in the Secret tab/arduino_secrets.h
/////// Wifi Settings /////// /////// WiFi Settings ///////
char ssid[] = SECRET_SSID; char ssid[] = SECRET_SSID;
char pass[] = SECRET_PASS; char pass[] = SECRET_PASS;

8
examples/HueBlink/HueBlink.ino
View File

@ -23,16 +23,16 @@
#include "arduino_secrets.h" #include "arduino_secrets.h"
///////please enter your sensitive data in the Secret tab/arduino_secrets.h ///////please enter your sensitive data in the Secret tab/arduino_secrets.h
/////// Wifi Settings /////// /////// WiFi Settings ///////
char ssid[] = SECRET_SSID; char ssid[] = SECRET_SSID;
char pass[] = SECRET_PASS; char pass[] = SECRET_PASS;
int status = WL_IDLE_STATUS; // the Wifi radio's status int status = WL_IDLE_STATUS; // the WiFi radio's status
char hueHubIP[] = "192.168.0.3"; // IP address of the HUE bridge char hueHubIP[] = "192.168.0.3"; // IP address of the HUE bridge
String hueUserName = "huebridgeusername"; // hue bridge username String hueUserName = "huebridgeusername"; // hue bridge username
// make a wifi instance and a HttpClient instance: // make a WiFiClient instance and a HttpClient instance:
WiFiClient wifi; WiFiClient wifi;
HttpClient httpClient = HttpClient(wifi, hueHubIP); HttpClient httpClient = HttpClient(wifi, hueHubIP);
@ -42,7 +42,7 @@ void setup() {
Serial.begin(9600); Serial.begin(9600);
while (!Serial); // wait for serial port to connect. while (!Serial); // wait for serial port to connect.
// attempt to connect to Wifi network: // attempt to connect to WiFi network:
while ( status != WL_CONNECTED) { while ( status != WL_CONNECTED) {
Serial.print("Attempting to connect to WPA SSID: "); Serial.print("Attempting to connect to WPA SSID: ");
Serial.println(ssid); Serial.println(ssid);

4
examples/PostWithHeaders/PostWithHeaders.ino
View File

@ -1,7 +1,7 @@
/* /*
POST with headers client for ArduinoHttpClient library POST with headers client for ArduinoHttpClient library
Connects to server once every five seconds, sends a POST request Connects to server once every five seconds, sends a POST request
with custome headers and a request body with custom headers and a request body
created 14 Feb 2016 created 14 Feb 2016
by Tom Igoe by Tom Igoe
@ -18,7 +18,7 @@
#include "arduino_secrets.h" #include "arduino_secrets.h"
///////please enter your sensitive data in the Secret tab/arduino_secrets.h ///////please enter your sensitive data in the Secret tab/arduino_secrets.h
/////// Wifi Settings /////// /////// WiFi Settings ///////
char ssid[] = SECRET_SSID; char ssid[] = SECRET_SSID;
char pass[] = SECRET_PASS; char pass[] = SECRET_PASS;

2
examples/SimpleDelete/SimpleDelete.ino
View File

@ -15,7 +15,7 @@
#include "arduino_secrets.h" #include "arduino_secrets.h"
///////please enter your sensitive data in the Secret tab/arduino_secrets.h ///////please enter your sensitive data in the Secret tab/arduino_secrets.h
/////// Wifi Settings /////// /////// WiFi Settings ///////
char ssid[] = SECRET_SSID; char ssid[] = SECRET_SSID;
char pass[] = SECRET_PASS; char pass[] = SECRET_PASS;

2
examples/SimpleGet/SimpleGet.ino
View File

@ -14,7 +14,7 @@
#include "arduino_secrets.h" #include "arduino_secrets.h"
///////please enter your sensitive data in the Secret tab/arduino_secrets.h ///////please enter your sensitive data in the Secret tab/arduino_secrets.h
/////// Wifi Settings /////// /////// WiFi Settings ///////
char ssid[] = SECRET_SSID; char ssid[] = SECRET_SSID;
char pass[] = SECRET_PASS; char pass[] = SECRET_PASS;

8
examples/SimpleHttpExample/SimpleHttpExample.ino
View File

@ -2,7 +2,7 @@
// Released under Apache License, version 2.0 // Released under Apache License, version 2.0
// //
// Simple example to show how to use the HttpClient library // Simple example to show how to use the HttpClient library
// Get's the web page given at http://<kHostname><kPath> and // Gets the web page given at http://<kHostname><kPath> and
// outputs the content to the serial port // outputs the content to the serial port
#include <SPI.h> #include <SPI.h>
@ -14,7 +14,7 @@
#include "arduino_secrets.h" #include "arduino_secrets.h"
///////please enter your sensitive data in the Secret tab/arduino_secrets.h ///////please enter your sensitive data in the Secret tab/arduino_secrets.h
/////// Wifi Settings /////// /////// WiFi Settings ///////
char ssid[] = SECRET_SSID; char ssid[] = SECRET_SSID;
char pass[] = SECRET_PASS; char pass[] = SECRET_PASS;
@ -42,7 +42,7 @@ void setup()
; // wait for serial port to connect. Needed for native USB port only ; // wait for serial port to connect. Needed for native USB port only
} }
// attempt to connect to Wifi network: // attempt to connect to WiFi network:
Serial.print("Attempting to connect to WPA SSID: "); Serial.print("Attempting to connect to WPA SSID: ");
Serial.println(ssid); Serial.println(ssid);
while (WiFi.begin(ssid, pass) != WL_CONNECTED) { while (WiFi.begin(ssid, pass) != WL_CONNECTED) {
@ -129,5 +129,3 @@ void loop()
// And just stop, now that we've tried a download // And just stop, now that we've tried a download
while(1); while(1);
} }

2
examples/SimplePost/SimplePost.ino
View File

@ -14,7 +14,7 @@
#include "arduino_secrets.h" #include "arduino_secrets.h"
///////please enter your sensitive data in the Secret tab/arduino_secrets.h ///////please enter your sensitive data in the Secret tab/arduino_secrets.h
/////// Wifi Settings /////// /////// WiFi Settings ///////
char ssid[] = SECRET_SSID; char ssid[] = SECRET_SSID;
char pass[] = SECRET_PASS; char pass[] = SECRET_PASS;

2
examples/SimplePut/SimplePut.ino
View File

@ -14,7 +14,7 @@
#include "arduino_secrets.h" #include "arduino_secrets.h"
///////please enter your sensitive data in the Secret tab/arduino_secrets.h ///////please enter your sensitive data in the Secret tab/arduino_secrets.h
/////// Wifi Settings /////// /////// WiFi Settings ///////
char ssid[] = SECRET_SSID; char ssid[] = SECRET_SSID;
char pass[] = SECRET_PASS; char pass[] = SECRET_PASS;

2
examples/SimpleWebSocket/SimpleWebSocket.ino
View File

@ -15,7 +15,7 @@
#include "arduino_secrets.h" #include "arduino_secrets.h"
///////please enter your sensitive data in the Secret tab/arduino_secrets.h ///////please enter your sensitive data in the Secret tab/arduino_secrets.h
/////// Wifi Settings /////// /////// WiFi Settings ///////
char ssid[] = SECRET_SSID; char ssid[] = SECRET_SSID;
char pass[] = SECRET_PASS; char pass[] = SECRET_PASS;

2
keywords.txt
View File

@ -1,5 +1,5 @@
####################################### #######################################
# Syntax Coloring Map For HttpClient # Syntax Coloring Map For ArduinoHttpClient
####################################### #######################################
####################################### #######################################

2
library.json
View File

@ -1,7 +1,7 @@
{ {
"name": "ArduinoHttpClient", "name": "ArduinoHttpClient",
"keywords": "http, web, client, ethernet, wifi, GSM", "keywords": "http, web, client, ethernet, wifi, GSM",
"description": "Easily interact with web servers from Arduino, using HTTP and WebSocket's.", "description": "Easily interact with web servers from Arduino, using HTTP and WebSockets.",
"repository": "repository":
{ {
"type": "git", "type": "git",

2
library.properties
View File

@ -2,7 +2,7 @@ name=ArduinoHttpClient
version=0.4.0 version=0.4.0
author=Arduino author=Arduino
maintainer=Arduino <info@arduino.cc> maintainer=Arduino <info@arduino.cc>
sentence=[EXPERIMENTAL] Easily interact with web servers from Arduino, using HTTP and WebSocket's. sentence=[EXPERIMENTAL] Easily interact with web servers from Arduino, using HTTP and WebSockets.
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. 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.
category=Communication category=Communication
url=https://github.com/arduino-libraries/ArduinoHttpClient url=https://github.com/arduino-libraries/ArduinoHttpClient

4
src/HttpClient.cpp
View File

@ -587,7 +587,7 @@ String HttpClient::responseBody()
} }
if (bodyLength > 0 && (unsigned int)bodyLength != response.length()) { if (bodyLength > 0 && (unsigned int)bodyLength != response.length()) {
// failure, we did not read in reponse content length bytes // failure, we did not read in response content length bytes
return String((const char*)NULL); return String((const char*)NULL);
} }
@ -685,7 +685,7 @@ int HttpClient::read()
bool HttpClient::headerAvailable() bool HttpClient::headerAvailable()
{ {
// clear the currently store header line // clear the currently stored header line
iHeaderLine = ""; iHeaderLine = "";
while (!endOfHeadersReached()) while (!endOfHeadersReached())

4
src/HttpClient.h
View File

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