ESP8266 (Web Serveur – Partie 2) : Interaction entre le code Arduino et l’interface HTML

Accéder aux soldes du Black Friday Amazon Black friday Banggood Black Friday Gearbest
10% de remise supplémentaire* sur les produits domotiques Xiaomi

Kits domotiques, caméras de sécurité, robot aspirateur, purificateur d'air... *Hors produits déjà en promotion

Voir le code promo
39 jours restants

Voici la seconde partie des tutoriels consacrés à la création d’une interface HTML stockée dans la zone SPIFFS d’un ESP8266 fonctionnant comme un serveur web. Dans ce tutoriel, nous allons ajouter le code nécessaire à la mise en place des interactions entre l’interface Web et le code Arduino. Nous allons mettre en place l’actualisation automatique de la table des mesures et des afficheurs. Nous allons gérer les commandes pour activer et désactiver des GPIO. Enfin, certaines ressources seront placées dans la zone SPIFFS (fichiers CSS et JS de Bootstrap et jquery) pour diminuer le temps de chargement.

Un peu de JSON avant de commencer

JSON est un méthode pour structurer des données pour le stockage et le transfert. Il remplace très avantageusement le XML surtout dans le langage Javascript ou il est supporté nativement. Il est également très simple de créer une structure JSON dans le code Arduino. Sans trop rentrer dans les détails, voici comment ça fonctionne :

  • Les données sont stockées sous la forme clé:valeur
  • Chaque couple doit être séparé par une virgule, sauf le dernier couple
  • Plusieurs types de valeurs existent
    • une chaine
    • un tableau []
    • une structure de données libre à condition de respecter le formaliste JSON clé:valeur, clé:{}, clé:[]

Ce qui donne par exemple

Ou un tableau

Pour tester vos JSON, je vous conseille http://jsonlint.com/. C’est suffisant pour réaliser de nombreux projets, mais pour en savoir plus, vous pouvez consulter cet article en français de nos amis d’alsacreation.

Actualisation automatique de la table et des afficheurs de mesures

Autant laisser le navigateur actualiser régulièrement les mesures faites à l’aide de l’ESP8266. Nous allons reprendre le code de l’interface développée dans le tutoriel précédent et le faire évoluer pour que toutes les interactions soient gérées coté client (sur le navigateur internet).

Code HTML

Reprenons le code de l’onglet Mesures. On a ajouté 3 boutons de navigations qui permettent de créer 3 afficheurs. Chaque bouton possède un badge repéré par un identifiant (#temperature, #humidite et #pa) qui va nous permettre d’actualiser la mesure.

Ensuite un tableau composé de trois colonnes permet d’afficher le type de mesure, la valeur courante et une valeur précédente. Chaque colonne est associée à un champ de données (data-field) qui sera associé à un JSON envoyé par le code Arduino. Le contenu de chaque colonne est mis en forme par une fonction indiquée dans l’attribut data-formatter.

Tout est prêt du coté de l’interface Web

Code Javascript

Le plugin Bootstrap-table va nous simplifier la vie pour actualiser les données. En effet, il va nous suffire d’appeler la méthode refresh et d’indiquer l’url de retour des données (toutes les fonctions sont présentée ici). Par contre, il faut s’assurer que la table existe avant de pouvoir commencer,  on doit donc inclure cet appel dans un test $(document).ready(). On en profitera également pour appeler une fonction qui permettra d’actualiser les afficheurs. Voici le code

Petit problème, cette solution ne fonctionne pas dans le cas ou la table est intégrée dans un onglet (div tab-pane). Heureusement, la solution a été présentée dans l’issue 1760 sur Github. Sur la classe shown.bs.tab de la balise a[data-toggle=’tab’], on test la présence de l’attribut tab_mesures, celui qui correspond à l’onglet contenant la table des mesures. Si c’est le cas, on lance l’actualisation de la table ainsi que les 3 afficheurs.

Pour actualiser à intervalle régulier les données, on va donc créer un Timer qui va exécuter une fonction au bout d’une minute (6000ms) par exemple. Pour que le Timer soit appelé de manière récurrente, il suffit de le relancer à chaque fois que la table des mesures vient d’être actualisée (on.(‘load-success.bs.table’)). On testera également que l’onglet de la table soit actif. On obtient le code suivant :

Dans la fonction updateMesures(), on va donc faire un appel $.getJSON qui prend en paramètre une URL, ici /mesures.json .

Remarque. On pourrait extraire les données lors de la mise en forme de la table mais j’ai préféré introduire une nouvelle fonction jquery.

Dès que les données sont réceptionnées, la fonction est exécutée. La méthode jquery html permet d’actualiser le contenu du badge. Comme c’est un objet JSON, on accède à la valeur par data.nom_element. Pour faciliter la mise au point, on peut également appeler la fonction fail. On envoi vers la console l’objet JSON. Pour pouvoir le lire, on utilise la fonction Javascript JSON.stringify.

Il ne reste plus qu’à mettre en forme l’affichage des colonnes de la table. Pour bien comprendre ce qui se passe, voici le JSON renvoyé par l’ESP8266. Le plugin Bootstrap-table attend un tableau de données. Si ce n’est pas le cas, vous aurez une erreur renvoyée par la fonction .fail()

Pour chaque ligne, on va donc récupérer :

  • Le libellé de la mesure
  • La valeur actuelle
  • L’unité
  • Le symbole, cela évite un test coté client (navigateur) et le code Arduino est plus vite téléchargé en cas de modification que les fichiers SPIFFS.
  • Une valeur précédente

On va maintenant créer une fonction qui va s’occuper de créer le libellé qui va correspond à chaque colonne. Pour la colonne Mesure, on appel la fonction labelFormatter().

Remarque. On pourrait codifier le type de mesure de manière à aller chercher le libellé dans un tableau ou un fichier JSON pour chaque langue. Ici c’est juste un exemple pour montrer l’architecture du système.

On réalise un test sur le libellé et on construit une chaine qui va contenir le libellé. On y ajoute une balise span qui va ajouter juste avant le libellé (pull-left) un icône (glyphicon) contenu dans le JSON (row.glyph). Vous trouverez tous les glyphicons proposés par Bootstrap ici. Sinon vous pouvez également utiliser la librairie Fontawesome.

Passons à la mesure actuelle qui est mise en forme par la fonction valueFormatter(). Comme on dispose du contenu de la ligne, on peut faire un test pour déterminer si la valeur actuelle est supérieure ou inférieure à la précédente. On peut ainsi construire un libellé de la forme : valeur + unité + icône (haut / bas).

Enfin pour la valeur précédente, on assemble simplement value + unite.

Tout est prêt du coté de l’interface Web, passons au code Arduino coté ESP8266.

Code Arduino

On va ajouter des fonctions qui seront appelées lorsque le serveur reçoit une requête sur /mesures.json et tabmesures.json (juste avant de démarrer le serveur).

Pour les deux fonctions, on va créer une chaine texte en respectant le formaliste JSON. Pour la fonction sendMesures(), ce sera objet simple dont voici un exemple

{“t”:”21.50″,”h”:”31.80″,”pa”:”990.53″}

ou sous une forme plus lisible

Comme vous pouvez le voir dans le code, chaque clé et valeur doit être encadrée par un double guillemet (“). Il faut donc le faire précéder du caractère échappatoire pour que la chaîne puisse être compilée (\”). On appel ensuite la méthode server.send() pour envoyer l’objet JSON au client.

Pour la table, on doit envoyer un objet constitué d’un tableau, chaque ligne étant un objet contenant les informations nécessaires (libellé, valeur actuelle, unité, symbole, valeur précédente). La chaine est plus délicate à construire. Pour le moment on envoi 0 pour la valeur précédente.

Petit conseil. N’hésitez pas à bien découper votre chaîne et allez dans le navigateur pour récupérer le JSON envoyé. Une virgule en trop ou manquante et rien ne fonctionne. Pensez également à jsonlint pour vérifier vos JSON.

esp8266 web server http post json console google chrome bootstrap

Piloter le GPIO depuis l’interface Web

Il n’y a rien de plus compliqué pour piloter le GPIO depuis l’interface WEB, on va envoyer une requête HTTP de type POST à l’aide de la commande jsquery $.post(). En retour, on actualisera l’affichage du GPIO (On ou Off) en fonction de la réponse envoyée par le serveur.

Code HTML

On va profiter de la puissance de la librairie jquery pour intercepter un click sur le bouton de commande (ON, OFF)  de chaque GPIO. Le code HTML devient très simple.

Code Javascript

Le code Javascript va se dérouler en deux temps. Tout d’abord on intercepte un click sur le bouton à l’aide de la commande jquery $(‘#Dx_Etat’). Sur un click, on appel la fonction setBouton et on lui passe les paramètres (GPIO, Etat). L’état prendra la valeur 1 pour activer la sortie et 0 pour l’arrêter !

Ensuite la fonction setBouton envoi une requête HTTP de type POST. Pour cela on utilise la fonction $.post de jquery (documentation officielle). Voici sont fonctionnement :

  • On construit d’URL qui contient les paramètres et les valeurs. On pourrait aussi passer un JSON mais c’est plus facile de la gérer du coté Arduino avec la méthode server.arg(“xx”). L’URL prendra la forme gpio?id=id_gpio@etat=etat_gpio
  • La fonction done permet d’exécuter du code dès qu’une réponse valide est réceptionnée du serveur
  • La fonction fail permet de réaliser un traitement en cas d’erreur. Pratique pour la mise au point

Le traitement est très simple, par convention, le code Arduino renvoi la demande complétée par un drapeau (flag) success qui prend la valeur 1 si l’ESP8266 a correctement réalisée la requête demandée, 0 si ce n’est pas le cas. On pourrait imaginer d’autres états et modifier l’affichage en conséquence ou faire apparaître une notification…

Code Arduino

C’est exactement la même chose que pour les mesures. On appel la fonction updateGpio() lorsque le serveur reçoit une demande sur /gpio.

On va donc récupérer les paramètres passés au serveur (gpio, etat) à l’aide de la méthode server.arg(“id”). Ensuite, c’est de la cuisine classique. On doit juste faire attention car on récupère une chaine de caractère, il faut donc faire une petite conversion pour pointer vers la bonne broche (Pin). Peu importe le traitement, ce qui importe, c’est de répondre au client, car il attend sa réponse avec impatience. On construit un JSON dans lequel on recopie (par exemple) la demande et on ajoute un succès (success) qui eut prendre 1s si OK, 0 si KO, une autre valeur en cas d’erreur… et on envoi le tout avec un server.send().

Ce qui donne par exemple pour activer la broche D7 l’objet JSON suivant

Ajout des ressources dans le système de SPIFFS

Il est possible d’éviter d’aller chercher les ressources sur internet (jquery, bootstrap, bootstrap-table…) en embarquant toutes les resources dans le répertoire Data. Après avoir fait quelques tests, il n’y a pas vraiment de gain en terme de performance. L’ESP8266 ayant une puissance assez limitée, il ne délivre pas les ressources au navigateur plus rapidement que le CDN.

Par contre si vous ne souhaitez pas que l’ESP8266 puisse accéder à internet et y accéder en mode AP (point d’accès), il est nécessaire de tout embarquer dans la zone SPIFFS.

esp8266 firefow temps chargement ressources webserver

Pour récupérer les ressources, collez l’URL dans un navigateur et collez le texte obtenu dans un fichier texte. Il est préférable de placer les fichiers dans des dossiers séparés pour faciliter la maintenant. Attention à ce que le chemin complet (repertoire/fichier.ext) ne dépasse pas 31 caractères (limitation SPIFFS)

Ressource Répertoire Nom du fichier
 bootstrap.min.css css bootstrap.min.css
 bootstrap-table.min.css css bootstrap-table.min.css

Il ne reste plus qu’à modifier les chemins dans le Head, ce qui donne par exemple.

Assembler le tout

Comme d’habitude, voici le code Pug permettant de générer le fichier de l’interface HTML. Vous pouvez le modifier en fonction de vos besoins et pour faire vos tests.

Template Pug de l’interface

Code HTML généré

Sinon voici le fichier HTML

Code Arduino

Et le code Arduino

L’interface obtenue

En accédant à l’ESP8266, vous avez maintenant des mesures qui s’affichent
esp8266 webserver dht22 bmp180 bootstrap

ainsi qu’une interaction complète avec le GPIO. Le libellé (On / Off) est mis à jour une fois que l’ESP8266 a exécuté la commande.

esp8266 webserver dht22 bmp180 bootstrap gpio

Dans le prochain tutoriel, nous verrons comment enregistrer les mesures pour créer un historique et créer des graphiques et des gauges.

Le code source complet est disponible sur GitHub ici https://github.com/projetsdiy/ESP8266-Webserver-Tutorials/tree/master/Part2_DHT22WebserverESP8266_SPIFFS

Inscrivez-vous à la newsletter hebdomadaire

Aucun spam et aucun autre usage ne sera fait de votre email. Vous pouvez vous dés inscrire à tout moment.

Comparateur de prix

Bons plans

Les offres suivantes se terminent bientôt. Utilisez le coupon indiqué pour profiter du prix promo

  • visvic

    IMPRESSIONNANT !!!
    BRAVO !!
    tu pousse les possibilités de l’esp8266 dans ces derniers retranchements et j’en apprend plus a chacun de tes tutos !

    merci !!!

    • Bonjour Visvic. Merci beaucoup. Oui, je suis aussi un fan de l’ESP8266. Il y a encore plein de choses à découvrir…

  • gandolfi

    Quel travail !!!! Merci de nous faire partager ton savoir et de manière aussi pédagogique.
    L’ESP8266 est vraiment puissant car il se suffit à lui même en utilisant ce type de tuto et il est vraiment pas cher.
    On peut imaginer en acheter un pour chaque type de fonction et cela coutera seulement 4 euros….

    – Par contre je me suis perdu en chemin par rapport au code html : ou est il passé ? est il d’ans un appel d’un fichier ?
    – Que faut il televerser dans l’ESP8266 ? seulement le sketch arduino ? d’autres librairies mais comment ?

    je te remercie.

    • Bonjour Gandolfi. Oui, le rapport possibilités/performances/prix est imbattable.
      – Le code HTML est a dnc été ‘sorti’ du code Arduino. C’est un fichier HTML classique comme pour un site internet. On le place avec les autres fichiers (style CSS, code javascript, images…) dans un dossier data qu’il faut télécharger manuellement dans une zone mémoire spéciale du l’Arduino/ESP8266, appelée SPIFFS. C’est le 1er tuto de la série : https://www.projetsdiy.fr/esp8266-web-server-partie1-stockage-spiffs-interface-web/
      – Idem, tout est expliqué dans le 1er tuto.
      A la fin de la série il y aura un article de synthèse pour que tout le monde s’y retrouve

      • gandolfi

        Merci. j’étais passé à coté de cette info très importante.Effectivement le tuto indiqué est très technique.
        – Cela ouvre beaucoup de possibilité car cela permet de créer une page web et d’ensuite pouvoir programmer à la chaine des objets indépendants d’un serveur ou autres protocoles (mqtt, node,red…)
        – Tu penses que sur la nouvelle version du wemos ou une autre puce bon marché, on pourra créer un serveur dynamique php ou apparenté ?

        bonne soirée

        • Oui c’est assez fantastique et en plus le serveur Web est disponible en quelques secondes (par rapport à un ordinateur ou un mini-pc).
          Oui, ce sont bien des pages dynamiques et les données sont actualisées à intervalle régulier.

  • Clemzo

    En effet, excellent tuto.

    J’utilise à fond le Spiffs pour la gestion de mes pages et logos.
    J’utilise aussi l’Upgrade OTA pour effectuer la mise à jour de mon code.

    Par contre quand je modifie aussi certains fichiers (html ou logos) sur mon serveur externe de mise à jour, je souhaiterais pouvoir les upgrader à leurs tours sur l’ESP.

    Pensez vous qu’il soit possible d’uploader un fichier binaire (.png par ex.) en provenance d’un serveur externe, sur l’ESP pour le transférer dans le Spiffs ensuite ?

    • On devrait pourvoir faire quelque chose en FTP. Le transfert vers le SPIFFS étant très long, j’ai regardé pour transférer uniquement le fichier HTML modifié. Il y a un petit projet sur GitHub (https://github.com/nailbuster). Le tuto sera publié vendredi. Le seul problème actuellement, c’est que l’arborescence n’est pas gérée. Dites moi ce que vous en pensé.

Projets DIY - Domotique et objets connectés à faire soi-même