ESP8266 : RELAIS WIFI 1 CANAL

Relais WIFI

Nom			Relais WIFI
Famille			Objets connectés
Wiki créé le			22/05/2018
Wiki mis à jour le			09/08/2018
Auteur			fgtoul

Prérequis

Avant de pouvoir programmer le module NodeMCU, vous devez avoir installé l'environnement de développement spécifique à l'ESP8266.

Je vous invite à lire ce tutoriel : ESP8266 : Installation de l'environnement

Présentation

Difficulté de mise en oeuvre : ★★☆☆☆

Le montage que nous allons réaliser, permet de piloter un relais à distance avec l'ESP8266.

Nous utiliserons le module NodeMCU dans sa version LoLin, pour une programmation simplifiée par le port USB et la possibilité d'alimenter un relais 5V directement sur l'une de ses broches.

Attention :
ce ne sont pas des relais de puissance. Limite = 10A (résistif).
Ne pas utiliser pour piloter un ballon d'eau chaude ou tout appareil à forte consommation.
Réservez ce type de matériel aux circuits de commande (faible consommation) ou pour piloter des appareils basse tension (caméras, ...).

Pour faire les branchements électriques, veillez à toujours respecter les règles de sécurité.

Matériel nécessaire

1 cable micro USB Type B vers USB Type A (câble fréquemment utilisé pour les smartphones et les tablettes)

1 module NodeMCU V3 (LoLin) Lua WIFI basé sur ESP8266 ESP-12E

1 module relais 5V avec Trigger (entrée TTL)

COÛT : une dizaine d'Euro

le schéma

Le module NodeMCU est alimenté directement en 5V par son port USB.
Le module relais est un modèle avec Trigger. La broche S est connectée à la sortie D5 du NodeMCU.

Il suffira de piloter cette sortie via le programme afin d'activer ou désactiver le relais.

Le relais est alimenté par la sortie VU, qui est un report de la tension appliquée sur le port USB (5Vcc).

Les Leds LED_Link et LED_Relais sont optionnelles. Repérez le sens des Leds. Les cathodes (méplats) sont connectées à la borne Gnd

Les fonctionalités

Grâce à sa connectivité Wifi intégrée, le module se connecte à un réseau wifi, via lequel il pourra communiquer avec le reste de l'installation domotique. A la fois client et serveur, notre module recevra des consignes sous la forme de requêtes Http et pourra répondre par une page HTML. Il pourra également répondre par une autre requête permettant ainsi d'accuser réception de la consigne.

client Wifi. Le module se connecte automatiquement au réseau. Il est possible de lui appliquer une adresse IP statique.
informations (adresse IP locale) et retours d'état via le port série (USB) lorsqu'il est connecté à un PC.
Serveur Http activé au démarrage. Le client connecté au serveur recevra une réponse à chacune de ses requêtes, sous forme de page web.
la Led embarquée peut retourner des informations sur le statut des communications :
- clignotement lent (5 fois) pour signaler une connexion correcte au réseau Wifi,
- clignotement simple (1 fois) pour signaler la réception d'une requête correcte,
- clignotement rapide (3 fois) pour signaler la réception d'une requête erronée.

En D0, si la Led nommée LED_Link est présente, elle clignotera à la place de la Led embarquée lors de la connexion au Wifi ou de la réception des requêtes.

En D1, si la Led nommée LED_Relais est présente, elle s'allumera lorsque le relais passera à l'état ON, puis s'éteindra lorsque le relais passera à l'état OFF.

L'environnement de programmation : Easycoding

Nous allons utiliser Easycoding pour éditer le code du projet.

Chargement du projet

Téléchargez et décompressez ce fichier : ESP8266_Relais.zip

Cliquez sur le bouton et sélectionnez le fichier XML précédemment téléchargé.

Validez par OK pour charger le fichier.

Programmation

Le programme se décompose en deux parties :

Setup : Le code n'est exécuté qu'une fois au démarrage du module.
- Configuration du réseau
- Définition des variables
- Connexion au réseau Wifi
- Démarrage du serveur Http

Boucle Principale : Le code de cette boucle est répété jusqu'à extinction du module
- attente d'une connexion sur le serveur Web embarqué
- interprêtation de la requête reçue et pilotage du Relais (ON ou OFF)
- réponses sur port série et http
- envoi d'une commande API vers IPX800 pour le retour d'état du Relais.

La configuration

Dans la boucle SETUP, vous devez configurer

le réseau
Les commandes API qui seront envoyées vers IPX800 (retour d'état)
Les Leds optionnelles

La configuration du réseau

Modifiez la valeur de chaque variable :

NOM_DISPOSITIF : remplacez RelaisIPCAM1 par le nom que vous souhaitez attribuer à votre module
WIFI_SSID : remplacez la valeur MON_SSID par le SSID de votre réseau wifi
WIFI_SECURITE : remplacez la valeur MA_CLE_WPA par la clé WPA de votre réseau Wifi

Nom d'hôte et adresse IP statique

Si vous souhaitez affecter une adresse IP fixe au module, renseignez les valeurs

IP : Remplacez 192,168,0,64 par l'adresse à attribuer. Attention, les séparateurs sont des virgules, et non des points.
Passerelle : Remplacez 192,168,0,254 par l'adresse IP locale de votre routeur (box adsl), les séparateurs sont des virgules.
Masque : Remplacez 255,255,255,0 par le masque de votre réseau, les séparateurs sont des virgules.

Si vous souhaitez que votre module conserve une adresse IP dynamique (DHCP), sélectionnez le bloc "IP Statique" puis appuyez la touche Suppr de votre clavier. Les blocs situés en dessous, doivent remonter.

La configuration des commandes API

Après pilotage du relais, le module envoie une commande API à l'IPX800 pour confirmer l'état du relais (ON ou OFF)

IPX800_IP : remplacez 192.168.000.112 par l'adresse IP de l'IPX800 V4. Les séparateurs sont des points.

Cette adresse IP sera utilisée pour le retour d'état via l'API IPX800.

IPX800_Port : remplacez la valeur 80 par le port paramétré sur l'IPX800 (port http)
APIKEY_SECURE : renseignez 1 si vous avez activé la protection de l'API, sinon renseignez 0
IPX800_KEY : remplacez apikey par votre clé API.

API_Commande_ON : remplacez SetVO par une autre commande si vous ne souhaitez pas activer une sortie virtuelle sur l'IPX800 (SetR par exemple pour activer un relais)
API_Commande_OFF : remplacez ClearVO par une autre commande si vous ne souhaitez pas désactiver une sortie virtuelle sur l'IPX800 (ClearR par exemple pour désactiver un relais)
IPX800_SV_Retour : remplacez 005 par le numéro de la sortie virtuelle ou physique qui recevra le retour d'état.

Attention : pour une sortie virtuelle, le numéro doit être présenté sur 3 digits (ex : 005), pour une sortie relais, il doit être sur 2 digits (ex : 05).

La configuration des Leds optionnelles

LED_Link : remplacez 1 par 0 si la Led n'est pas installée en D0. La Led embarquée sera utilisée.

LED_Relais : remplacez 1 par 0 si la Led n'est pas installée en D1.

Le reste du code

Aucune modification n'est nécessaire dans les blocs décrits dans ce paragraphe.
Nous les survolons juste pour en comprendre la fonction. Cliquez sur [Afficher] si vous êtes curieux.

Les autres variables

Démarrage du Serveur Http

Démarrage du serveur Http et envoi des informations sur le port série (USB)

Mise en place de l'API Key s active

Création des commandes API à envoyer à l'IPX800 (retour d'état)

Création des requêtes attendues par le module

Les requêtes sont composées avec le nom du dispositif afin de sécuriser le process.

Attente d'un client

Le programme attend la connexion d'un client sur le serveur web embarqué

interprétation de la requête reçue par le module

En fonction de la valeur de la requête reçue, le module active ou désactive le relais, émet des informations sur le port série puis envoie un retour d'état à l'IPX800 via les commandes API. La réponse de l'IPX800 sera affichée via le port série également.

La réponse par le serveur Web

Le code restant s'occupe d'émettre une réponse au client qui a émis la requête vers le module.

La réponse se fait sous la forme d'une page web contenant toutes les informations sur la requête et les erreurs éventuelles.

La réponse de l'IPX800 à la commande API reçue (retour d'état) sera également affichée dans la page Web.

Sauvegarde et Transfert du programme sur le module

Cliquez sur pour sauvegarder votre projet.

Exportez votre code vers Arduino IDE : Sur l'interface de Easycoding, cliquez sur le bouton d'exécution .

Validez par OK

Choisissez l'option "Ouvrir avec" et choisissez le logiciel par défaut "Arduino IDE" installé au préalable.

Validez,

le logiciel Arduino IDE s'ouvre et charge votre programme.

Arduino IDE : compilation & téléversement du code

Branchement du module au PC

Connectez le module au port USB de votre PC. Vous pouvez laisser le relais et les leds connectés.

Si vous devez intervenir dans le code C++, c'est le moment .

Vérification du code

Dans l'interface du logiciel Arduino IDE, vérifiez les prérequis

Configuration du Port COM (menu Outils)
Installation des bibliothèques ESP8266 (Gestionnaire de cartes)
Sélection du Type de Carte (menu Outils)

Pour plus d'information, voir plus haut le paragraphe "Prérequis"

Cliquez sur le bouton afin de vérifier le code.

Vérifiez les éventuelles erreurs dans la console.

Téléversement vers le module

Cliquez sur le bouton pour compiler et téléverser le code compilé dans la mémoire flash du module,

ouvrez le moniteur Série

suivez la progression du téléversement dans la fenêtre console

A la fin du téléversement, le module démarre. Les informations arrivent par le port USB.

Notez l'adresse IP attribuée au module

Après programmation par le port série (USB) il est conseillé de redémarrer manuellement le module (débranchez/rebranchez) pour éviter tout risque d'instabilité.

Utilisation

Alimentez le module en 5V par son port USB '(il peut également être utilisé lorsqu'il est connecté au port USB de votre PC).

Accès au module

Pour démarrer, dans votre navigateur, entrez l'adresse IP de votre module (relevée précédemment dans Arduino IDE).

Le serveur http du module vous envoie une page Html comportant les commandes attendues.

Les commandes de pilotage du relais par le module sont sous la forme

http://<IP_Module>:<Port_Module>/ON_<NomDispositif>

http://<IP_Module>:<Port_Module>/OFF_<NomDispositif>

<IP_Module> représente l'adresse IP locale du module (fixe ou dynamique)
<Port_Module> représente le port Http du serveur Web intégré au module.
<NomDispositif> représente le nom d'hôte que vous avez attribué au module.

Le retour d'état se fait sur l'IPX800 avec les commandes API mises en place dans le programme. Ces commandes sont également affichées dans la page réponse du module.

Voici la page Web retournée par le module, ainsi que les informations remontées sur le port USB.

Cas d'une URL comprenant une requête incorrecte. Les instructions sont rappelées dans la page Html.

Cas d'une requête comportant une commande ON correcte

Cas d'une requête OFF correcte

La Led embarquée

Au démarrage,

la Led clignote 5 fois pour signaler que le module est connecté au réseau Wifi.

A la réception d'une requête,

la Led clignote 1 fois rapidement pour signaler qu'une requête correcte a été reçue.

la Led clignote 3 fois rapidement pour signaler qu'une requête incorrecte a été reçue.

Pilotage depuis l'IPX800 V4

Comme nous l'avons vu, le relais wifi est piloté par des requêtes Http ON ou OFF, un retour d'état se fait sur une sortie virtuelle.

Création du widget pour visualisation du retour d'état

Comme nous l'avons vu, le relais wifi est piloté par des requêtes Http comprenant des commandes ON ou OFF, un retour d'état se fait sur 1 sortie virtuelle ou un relais.

En mode Administrateur sur le dashboard de l'IPX800, créez un widget de type HTML de hauteur 1 bloc.

Cliquez sur le bouton JAVASCRIPT et collez ce code :

var SVa="4"; //num SV -1
var moduleRelais="RelaisIPCAM1";
var adresseIP="192.168.0.64";
var portIP="80";
var Desc1="Description Relais";
var TypeSortie="vout"; //renseignez vout pour une sortie virtuelle, ou led pour un relais
//si Watchdog
var SVw=0 //watchdog avec preset 1

return `

<div class="indicator-light3  pw${SVw}" style="float:right;margin-right:18px;margin-top:5px;width:5px;height:5px;"></div>
<br>
<div class="indicator-light2  ${TypeSortie}${SVa} ${TypeSortie}ta9${SVa}" style="margin-left:10px;margin-top:15px;"></div>
<span>
        <input type="button"   class="bouton2" style="margin-top:10px;margin-left:10px;width: 100px;" onclick="newAJAXCommand('api.cgi?SetPushURL=${adresseIP}&amp;Port=${portIP}&amp;Message=/ON_${moduleRelais}');" value="ON Relais 1"  title="${Desc1}">
        <input type="button"   class="bouton2" style="margin-top:10px;margin-left:10px;width: 100px;" onclick="newAJAXCommand('api.cgi?SetPushURL=${adresseIP}&amp;Port=${portIP}&amp;Message=/OFF_${moduleRelais}');" value="OFF Relais 1"  title="${Desc1}">
</span>  
`;

Dans les 5 premières lignes du code,

renseignez la valeur de SVa avec le numéro de la sorties virtuelle (ou relais IPX) à utiliser pour le retour d'état.
Cette information doit correspondre à celle qui a été mise en place dans le programme du module ESP8266
renseignez le Nom que vous avez attribué au module ESP8266
renseignez l'adresse IP et le port Http du module ESP8266
renseignez une courte description du relais.
Cette description apparaîtra en info-bulle lors du survol des boutons avec la souris.

En ligne 6, indiquez le type de sortie qui affichera le retour d'état.

Si le module envoie des commandes API telles que SetVO ou ClearVO, renseignez vout
Si le module envoie des commandes API telles que SetR ou ClearR, renseignez led

Sauvegardez le Widget

Sauvegardez l'IHM

voici le résultat :