Arduino - Requête HTTP
Arduino peut jouer le rôle de client web pour effectuer des requêtes HTTP sur un serveur web. Le serveur web peut être un site web, une API web ou REST, un service web...
Dans ce tutoriel, nous allons apprendre :
- Connaissances de base du client web et du serveur web
- Comment faire une requête HTTP (GET et POST)
- Comment envoyer des données à un serveur web (un site web, API WEB ou API REST)
- Code Arduino :
- Effectuer une requête HTTP GET/POST en utilisant Arduino Uno/Mega + Ethernet Shield 2
- Effectuer une requête HTTP GET et envoyer des données en utilisant Arduino Uno/Mega + Ethernet Shield 2
- Effectuer une requête HTTP POST et envoyer des données en utilisant Arduino Uno/Mega + Ethernet Shield 2
- Arduino Uno R4 WiFi
- Arduino Uno/Mega avec Ethernet Shield 2
- En-tête de requête HTTP
- (Facultatif) Corps de la requête HTTP
- Adresse Web (URL)
- Méthode de requête (POST ou GET)
- Port HTTP utilisé par le serveur web (la plupart des serveurs web utilisent le port 80 pour HTTP)
- (Facultatif) Données à envoyer au serveur web (chaîne de requête). Dans ce tutoriel, nous supposons que nous envoyons la température et l'humidité à un serveur web avec le format ?temperature={valeur-t}&humidity={valeur-h}.
- Déclarer la méthode de requête, le port HTTP, nom d'hôte, chemin d'accès, chaîne de requête
- Déclarez un objet client web
- Se connecter au serveur web
- Si connecté au serveur, envoyer une requête HTTP.
- Lisez les données de réponse du serveur Web.
- Requête HTTP GET
- Ne peut envoyer des données qu'au format de chaîne de requête.
- Les données sont attachées au chemin d'accès.
- Requête HTTP POST
- Peut envoyer des données NON SEULEMENT au format de chaîne de requête MAIS AUSSI dans tout autre format tel que Json, XML, image ...
- Les données se trouvent dans le corps de la requête HTTP.
- Construire une chaîne de requête
- Modifiez le code pour envoyer des données dans la requête HTTP
- HTTP GET : ajoutez la chaîne de requête au chemin d'accès
- POST HTTP : envoyer chaîne de requête en tant que corps HTTP
- Lisez les données de réponse du serveur web.
- Pour Ethernet Shield 2, vous devez modifier le code Arduino. Voir Arduino Ethernet Shield 2 avec adresse IP statique
Le code pour les autres WiFi ou Shield/Board Ethernet est similaire. La différence réside uniquement dans la bibliothèque.
Le tutoriel fournit le code Arduino pour deux cas :
Préparation du matériel
| 1 | × | Arduino UNO R4 WiFi | |
| 1 | × | USB Cable Type-C | |
| 1 | × | (Recommended) Screw Terminal Block Shield for Arduino Uno | |
| 1 | × | (Optional) Transparent Acrylic Enclosure For Arduino Uno |
Alternatively if using Ethernet:
Or you can buy the following sensor kits:
| 1 | × | DIYables Sensor Kit (30 sensors/displays) | |
| 1 | × | DIYables Sensor Kit (18 sensors/displays) |
Divulgation : Certains des liens fournis dans cette section sont des liens affiliés Amazon. Nous pouvons recevoir une commission pour tout achat effectué via ces liens, sans coût supplémentaire pour vous. Nous vous remercions de votre soutien.
Connaissances de base sur le client Web et le serveur Web
Lorsque vous accédez à un site Web depuis votre PC ou smartphone, vous saisissez simplement l'adresse Web (URL) dans un navigateur web, attendez une seconde, puis la page Web s'affiche sur votre PC/smartphone. Vous ne savez pas ce que votre PC/smartphone fait derrière l'écran. Alors, que se passe-t-il derrière l'écran :
i. Votre PC/smartphone (en tant que client web) envoie une requête HTTP à un serveur web
ii. Le serveur web renvoie une réponse HTTP à votre PC/smartphone
iii. Votre PC/smartphone reçoit la réponse HTTP et affiche la réponse HTTP sur votre écran
Dans ce tutoriel, nous allons transformer l'Arduino en un client web pour faire quelque chose de similaire à votre PC/smartphone.
Adresse web (URL)
Une URL comprend deux parties : nom d'hôte et chemin d'accès. Le nom d'hôte peut être remplacé par l'adresse IP du serveur web. Par exemple : example.com/test
Dans une requête HTTP GET, l'URL peut inclure la chaîne de requête. Par exemple : example.com/test?temperature=20&humidity=70.
Chaîne de requête
La chaîne de requête est un ensemble de paires nom-valeur, qui sont incluses dans la requête HTTP pour envoyer des données du client web au serveur web.
Le nom et la valeur sont séparés par le caractère "=". Les paires nom-valeur sont séparées par le caractère "&".
Par exemple : temperature=26&humidity=70&state=2
Requête HTTP
La requête HTTP est composée de :
L'en-tête de requête HTTP et le corps de requête HTTP sont séparés par deux paires de caractères de retour chariot (ASCII 13, ou '\r') et de saut de ligne (ASCII 10, ou '\n').
Il existe de nombreuses méthodes de requête. Parmi elles, deux méthodes populaires : GET et POST.
Habituellement, nous utilisons la méthode GET lorsque nous voulons obtenir des données du serveur web, et la méthode POST pour envoyer des données au serveur web. Cependant, la méthode GET peut être utilisée pour obtenir et envoyer des données de/vers le serveur web.
Prérequis
Nous devons déterminer les valeurs suivantes :
L'adresse web (URL) est divisée en nom d'hôte et chemin d'accès
Comment effectuer une requête HTTP
Cette partie présente uniquement le code lié à HTTP. Le code complet pour chaque bouclier sera présenté dans la dernière partie.
c
int HTTP_PORT = 80;
String HTTP_METHOD = "GET"; // ou "POST"
char HOST_NAME[] = "example.phpoc.com"; // nom d'hôte du serveur web :
String PATH_NAME = "";
| Arduino Ethernet Shield 2 | EthernetClient client; |
| Arduino Uno WiFi | WiFiClient client; |
if(client.connect(HOST_NAME, HTTP_PORT)) {
Serial.println("Connected to server");
} else {
Serial.println("connection failed");
}
// envoyer l'en-tête de la requête HTTP
client.println(HTTP_METHOD + " " + PATH_NAME + " HTTP/1.1");
client.println("Host: " + String(HOST_NAME));
client.println("Connection: close");
client.println(); // fin de l'en-tête de la requête HTTP
while(client.available())
{
// lire un octet entrant du serveur et l'imprimer sur le moniteur série :
char c = client.read();
Serial.print(c);
}
if(!client.connected())
{
// si le serveur est déconnecté, arrêter le client :
Serial.println("disconnected");
client.stop();
}
Comment envoyer des données à un serveur Web
Nous pouvons inclure des données dans la requête HTTP. Le format des données dépend de la méthode de requête HTTP :
Nous devons juste modifier le code pour envoyer la requête HTTP :
int temp = // lire depuis le capteur
int humi = // lire depuis le capteur
String queryString = String("?temperature=") + String(temp) + String("&humidity=") + String(humi);
// envoyer l'en-tête HTTP
client.println("GET " + PATH_NAME + queryString + " HTTP/1.1");
client.println("Host: " + String(HOST_NAME));
client.println("Connection: close");
client.println(); // fin de l'en-tête HTTP
// envoyer l'en-tête HTTP
client.println("POST " + PATH_NAME + " HTTP/1.1");
client.println("Host: " + String(HOST_NAME));
client.println("Connection: close");
client.println(); // terminer l'en-tête HTTP
// envoyer le corps HTTP
client.println(queryString);
while(client.available())
{
// lire un octet entrant du serveur et l'imprimer sur le moniteur série :
char c = client.read();
Serial.print(c);
}
if(!client.connected())
{
// si le serveur est déconnecté, arrêter le client :
Serial.println("disconnected");
client.stop();
}
Code Arduino complet pour effectuer une requête HTTP
Voici le code Arduino complet pour effectuer une requête HTTP GET/POST.
Requête HTTP GET/POST avec Arduino Uno R4 Wifi
/*
* Ce code Arduino a été développé par newbiely.fr
* Ce code Arduino est mis à disposition du public sans aucune restriction.
* Pour des instructions complètes et des schémas de câblage, veuillez visiter:
* https://newbiely.fr/tutorials/arduino/arduino-http-request
*/
#include <WiFiS3.h>
const char ssid[] = "YOUR_WIFI_SSID"; // change your network SSID (name)
const char pass[] = "YOUR_WIFI_PASSWORD"; // change your network password (use for WPA, or use as key for WEP)
WiFiClient client;
int status = WL_IDLE_STATUS;
int HTTP_PORT = 80;
String HTTP_METHOD = "GET"; // or POST
char HOST_NAME[] = "maker.ifttt.com";
String PATH_NAME = "/trigger";
void setup() {
Serial.begin(9600);
// check for the WiFi module:
if (WiFi.status() == WL_NO_MODULE) {
Serial.println("Communication with WiFi module failed!");
// don't continue
while (true)
;
}
String fv = WiFi.firmwareVersion();
if (fv < WIFI_FIRMWARE_LATEST_VERSION) {
Serial.println("Please upgrade the firmware");
}
// attempt to connect to WiFi network:
while (status != WL_CONNECTED) {
Serial.print("Attempting to connect to SSID: ");
Serial.println(ssid);
// Connect to WPA/WPA2 network. Change this line if using open or WEP network:
status = WiFi.begin(ssid, pass);
// wait 10 seconds for connection:
delay(10000);
}
// print your board's IP address:
Serial.print("IP Address: ");
Serial.println(WiFi.localIP());
// connect to web server on port 80:
if (client.connect(HOST_NAME, HTTP_PORT)) {
// if connected:
Serial.println("Connected to server");
// make a HTTP request:
// send HTTP header
client.println(HTTP_METHOD + " " + PATH_NAME + " HTTP/1.1");
client.println("Host: " + String(HOST_NAME));
client.println("Connection: close");
client.println(); // end HTTP header
while (client.connected()) {
if (client.available()) {
// read an incoming byte from the server and print it to serial monitor:
char c = client.read();
Serial.print(c);
}
}
// the server's disconnected, stop the client:
client.stop();
Serial.println();
Serial.println("disconnected");
} else { // if not connected:
Serial.println("connection failed");
}
}
void loop() {
}
Requête HTTP GET/POST avec Arduino Ethernet Shield 2
/*
* Ce code Arduino a été développé par newbiely.fr
* Ce code Arduino est mis à disposition du public sans aucune restriction.
* Pour des instructions complètes et des schémas de câblage, veuillez visiter:
* https://newbiely.fr/tutorials/arduino/arduino-http-request
*/
#include <SPI.h>
#include <Ethernet.h>
// replace the MAC address below by the MAC address printed on a sticker on the Arduino Shield 2
byte mac[] = { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED };
EthernetClient client;
int HTTP_PORT = 80;
String HTTP_METHOD = "GET"; // or POST
char HOST_NAME[] = "maker.ifttt.com";
String PATH_NAME = "/trigger";
void setup() {
Serial.begin(9600);
// initialize the Ethernet shield using DHCP:
if (Ethernet.begin(mac) == 0) {
Serial.println("Failed to obtaining an IP address using DHCP");
while(true);
}
// connect to web server on port 80:
if(client.connect(HOST_NAME, HTTP_PORT)) {
// if connected:
Serial.println("Connected to server");
// make a HTTP request:
// send HTTP header
client.println(HTTP_METHOD + " " + PATH_NAME + " HTTP/1.1");
client.println("Host: " + String(HOST_NAME));
client.println("Connection: close");
client.println(); // end HTTP header
while(client.connected()) {
if(client.available()){
// read an incoming byte from the server and print it to serial monitor:
char c = client.read();
Serial.print(c);
}
}
// the server's disconnected, stop the client:
client.stop();
Serial.println();
Serial.println("disconnected");
} else {// if not connected:
Serial.println("connection failed");
}
}
void loop() {
}
Code Arduino complet pour effectuer une requête HTTP GET avec des données
Requête HTTP GET avec données en utilisant l'Arduino Uno R4 Wifi
/*
* Ce code Arduino a été développé par newbiely.fr
* Ce code Arduino est mis à disposition du public sans aucune restriction.
* Pour des instructions complètes et des schémas de câblage, veuillez visiter:
* https://newbiely.fr/tutorials/arduino/arduino-http-request
*/
#include <WiFiS3.h>
const char ssid[] = "YOUR_WIFI_SSID"; // change your network SSID (name)
const char pass[] = "YOUR_WIFI_PASSWORD"; // change your network password (use for WPA, or use as key for WEP)
WiFiClient client;
int status = WL_IDLE_STATUS;
int HTTP_PORT = 80;
String HTTP_METHOD = "GET";
char HOST_NAME[] = "maker.ifttt.com";
String PATH_NAME = "/trigger";
String queryString = "?value1=26&value2=70";
;
void setup() {
Serial.begin(9600);
// check for the WiFi module:
if (WiFi.status() == WL_NO_MODULE) {
Serial.println("Communication with WiFi module failed!");
// don't continue
while (true)
;
}
String fv = WiFi.firmwareVersion();
if (fv < WIFI_FIRMWARE_LATEST_VERSION) {
Serial.println("Please upgrade the firmware");
}
// attempt to connect to WiFi network:
while (status != WL_CONNECTED) {
Serial.print("Attempting to connect to SSID: ");
Serial.println(ssid);
// Connect to WPA/WPA2 network. Change this line if using open or WEP network:
status = WiFi.begin(ssid, pass);
// wait 10 seconds for connection:
delay(10000);
}
// print your board's IP address:
Serial.print("IP Address: ");
Serial.println(WiFi.localIP());
// connect to web server on port 80:
if (client.connect(HOST_NAME, HTTP_PORT)) {
// if connected:
Serial.println("Connected to server");
// make a HTTP request:
// send HTTP header
client.println(HTTP_METHOD + " " + PATH_NAME + queryString + " HTTP/1.1");
client.println("Host: " + String(HOST_NAME));
client.println("Connection: close");
client.println(); // end HTTP header
while (client.connected()) {
if (client.available()) {
// read an incoming byte from the server and print it to serial monitor:
char c = client.read();
Serial.print(c);
}
}
// the server's disconnected, stop the client:
client.stop();
Serial.println();
Serial.println("disconnected");
} else { // if not connected:
Serial.println("connection failed");
}
}
void loop() {
}
Requête HTTP GET avec données en utilisant Arduino Ethernet Shield 2
/*
* Ce code Arduino a été développé par newbiely.fr
* Ce code Arduino est mis à disposition du public sans aucune restriction.
* Pour des instructions complètes et des schémas de câblage, veuillez visiter:
* https://newbiely.fr/tutorials/arduino/arduino-http-request
*/
#include <SPI.h>
#include <Ethernet.h>
// replace the MAC address below by the MAC address printed on a sticker on the Arduino Shield 2
byte mac[] = { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED };
EthernetClient client;
int HTTP_PORT = 80;
String HTTP_METHOD = "GET";
char HOST_NAME[] = "maker.ifttt.com";
String PATH_NAME = "/trigger";
String queryString = "?value1=26&value2=70";;
void setup() {
Serial.begin(9600);
// initialize the Ethernet shield using DHCP:
if (Ethernet.begin(mac) == 0) {
Serial.println("Failed to obtaining an IP address using DHCP");
while(true);
}
// connect to web server on port 80:
if(client.connect(HOST_NAME, HTTP_PORT)) {
// if connected:
Serial.println("Connected to server");
// make a HTTP request:
// send HTTP header
client.println(HTTP_METHOD + " " + PATH_NAME + queryString + " HTTP/1.1");
client.println("Host: " + String(HOST_NAME));
client.println("Connection: close");
client.println(); // end HTTP header
while(client.connected()) {
if(client.available()){
// read an incoming byte from the server and print it to serial monitor:
char c = client.read();
Serial.print(c);
}
}
// the server's disconnected, stop the client:
client.stop();
Serial.println();
Serial.println("disconnected");
} else {// if not connected:
Serial.println("connection failed");
}
}
void loop() {
}
Code Arduino complet pour effectuer une requête HTTP POST avec des données
Requête HTTP POST avec des données utilisant Arduino Uno R4 Wifi
/*
* Ce code Arduino a été développé par newbiely.fr
* Ce code Arduino est mis à disposition du public sans aucune restriction.
* Pour des instructions complètes et des schémas de câblage, veuillez visiter:
* https://newbiely.fr/tutorials/arduino/arduino-http-request
*/
#include <WiFiS3.h>
const char ssid[] = "YOUR_WIFI_SSID"; // change your network SSID (name)
const char pass[] = "YOUR_WIFI_PASSWORD"; // change your network password (use for WPA, or use as key for WEP)
WiFiClient client;
int status = WL_IDLE_STATUS;
int HTTP_PORT = 80;
String HTTP_METHOD = "POST";
char HOST_NAME[] = "maker.ifttt.com";
String PATH_NAME = "/trigger";
String queryString = "?value1=26&value2=70";
;
void setup() {
Serial.begin(9600);
// check for the WiFi module:
if (WiFi.status() == WL_NO_MODULE) {
Serial.println("Communication with WiFi module failed!");
// don't continue
while (true)
;
}
String fv = WiFi.firmwareVersion();
if (fv < WIFI_FIRMWARE_LATEST_VERSION) {
Serial.println("Please upgrade the firmware");
}
// attempt to connect to WiFi network:
while (status != WL_CONNECTED) {
Serial.print("Attempting to connect to SSID: ");
Serial.println(ssid);
// Connect to WPA/WPA2 network. Change this line if using open or WEP network:
status = WiFi.begin(ssid, pass);
// wait 10 seconds for connection:
delay(10000);
}
// print your board's IP address:
Serial.print("IP Address: ");
Serial.println(WiFi.localIP());
// connect to web server on port 80:
if (client.connect(HOST_NAME, HTTP_PORT)) {
// if connected:
Serial.println("Connected to server");
// make a HTTP request:
// send HTTP header
client.println(HTTP_METHOD + " " + PATH_NAME + " HTTP/1.1");
client.println("Host: " + String(HOST_NAME));
client.println("Connection: close");
client.println(); // end HTTP header
// send HTTP body
client.println(queryString);
while (client.connected()) {
if (client.available()) {
// read an incoming byte from the server and print it to serial monitor:
char c = client.read();
Serial.print(c);
}
}
// the server's disconnected, stop the client:
client.stop();
Serial.println();
Serial.println("disconnected");
} else { // if not connected:
Serial.println("connection failed");
}
}
void loop() {
}
Requête POST HTTP Arduino avec des données en utilisant Arduino Ethernet Shield 2
/*
* Ce code Arduino a été développé par newbiely.fr
* Ce code Arduino est mis à disposition du public sans aucune restriction.
* Pour des instructions complètes et des schémas de câblage, veuillez visiter:
* https://newbiely.fr/tutorials/arduino/arduino-http-request
*/
#include <SPI.h>
#include <Ethernet.h>
// replace the MAC address below by the MAC address printed on a sticker on the Arduino Shield 2
byte mac[] = { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED };
EthernetClient client;
int HTTP_PORT = 80;
String HTTP_METHOD = "POST";
char HOST_NAME[] = "maker.ifttt.com";
String PATH_NAME = "/trigger";
String queryString = "?value1=26&value2=70";;
void setup() {
Serial.begin(9600);
// initialize the Ethernet shield using DHCP:
if (Ethernet.begin(mac) == 0) {
Serial.println("Failed to obtaining an IP address using DHCP");
while(true);
}
// connect to web server on port 80:
if(client.connect(HOST_NAME, HTTP_PORT)) {
// if connected:
Serial.println("Connected to server");
// make a HTTP request:
// send HTTP header
client.println(HTTP_METHOD + " " + PATH_NAME + " HTTP/1.1");
client.println("Host: " + String(HOST_NAME));
client.println("Connection: close");
client.println(); // end HTTP header
// send HTTP body
client.println(queryString);
while(client.connected()) {
if(client.available()){
// read an incoming byte from the server and print it to serial monitor:
char c = client.read();
Serial.print(c);
}
}
// the server's disconnected, stop the client:
client.stop();
Serial.println();
Serial.println("disconnected");
} else {// if not connected:
Serial.println("connection failed");
}
}
void loop() {
}
※ NOTE THAT:
Ce tutoriel utilise l'adresse IP dynamique (via DHCP). Si vous souhaitez utiliser l'adresse IP statique :
WARNING
Veuillez noter que ce tutoriel est incomplet. Nous publierons sur notre Page Facebook lorsque le tutoriel sera complet. Aimez-la pour rester informé.