Voir la source de ESP8266 : RELAIS WIFI 1 CANAL

{{sommaire|niveau=2|flottant=left}}
{{Infobox IPX800
| titre = Relais WIFI
| image = ESP8266_Relais_presentation.png
| famille = Objets connectés
| date-create = 22/05/2018
| date-update = 22/05/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_:_ENVIRONNEMENT|ESP8266 : Installation de l'environnement]]'''

==Présentation ==
Difficulté de mise en oeuvre : <span style="font-size:110%;color:green;">★★☆☆☆</span>

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.

<span style="color:#e56d0f">
'''Attention :''' <br>
ce ne sont pas des relais de puissance. Limite = 10A (résistif).<br>
Ne pas utiliser pour piloter un ballon d'eau chaude ou tout appareil à forte consommation.<br>
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é. '''

</span>

==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 (Keyes relay 5V module ou Velleman VMA406)<br>

<code>COÛT : une dizaine d'Euro</code>

==le schéma==

[[Fichier:ESP8266_Relais_Led.PNG|700px|Iborder]]


* Le module NodeMCU est alimenté directement en '''5V''' par son port '''USB'''.
* Le module relais est un modèle avec Trigger. La broche <code>S</code> est connectée à la sortie <code>D7</code> du NodeMCU.<br>
:Il suffira de piloter cette sortie via le programme afin d'activer ou désactiver le relais.<br>
:Le relais est alimenté par la sortie <code>VU</code>, qui est un report de la tension appliquée sur le port USB (5V).

Les Leds ''LED_Link'' et ''LED_Relais'' sont optionnelles.

==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.

* 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 <code>D4</code>, 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 <code>D5</code>, 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==

[[Fichier:Logo_googleblockly.png]]

La programmation du module NodeMCU se fait soit en script LUA, soit en langage C++ via '''Arduino IDE'''.

Pour cette réalisation, nous écrirons un programme en '''langage C++''' (vous n'allez pas vous en rendre compte ...)

Afin de ne pas effrayer les débutants, nous utiliserons un générateur de code nommé '''[http://easycoding.tn Easycoding]''', qui permet une écriture simplifiée et graphique du code.

Easycoding a été développé avec '''[https://developers.google.com/blockly/ Google Blockly]''' <br>
''(bibliothèque logicielle javascript, Open Source, créée par Google en 2012)''.

Cet outil permettra aux débutants de configurer l'application, sans avoir à se préoccuper du langage.

Les lecteurs plus férus de programmation, pourront intervenir dans le code C++, après l'avoir injecté dans '''Arduino IDE'''.

===Easycoding.tn===

Pour accéder à l'interface de développement, rendez-vous sur le site '''[http://easycoding.tn Easycoding.tn]'''

Dans le sous-menu '''TUNIOT FOR ESP8266''', cliquez sur le drapeau de votre choix, afin d'accéder à l'interface dans votre langue préférée.

::[[Fichier:easycoding.tn.png|border|600px]]

L'outil prend un peu de temps pour s'ouvrir, mais devient très performant par la suite. Ne vous impatientez pas.


====Premiers pas====

Easycoding présente une interface comportant 5 zones

::[[Fichier:Easycoding_interface2.png|600px]]

1 : Menu permettant la sélection du mode
:* '''<code>Blocs</code>''' : mode permettant la saisie du programme par glisser/déposer des blocs.
:* '''<code>CODE </code>''' : mode permettant la consultation du code C++ généré en temps réel. Lecture seule.
:* '''<code>XML&nbsp;&nbsp;</code>''' : mode permettant la consultation du code XML généré automatiquement.

2 : Menu principal de gestion du projet
:* [[Fichier:Easycoding_clipboard.png|50px]] copie du code C++ dans le presse-papier
:* [[Fichier:Easycoding_tutoriaux.png|50px]] accès à des tutoraux vidéos (en français)
:* [[Fichier:Easycoding_vidage.png|50px]] vidage de la surface de travail et du code
:* [[Fichier:Easycoding_arduinoIDE.png|50px]] Lancer le programme (bascule dans Arduino IDE pour compilation et téléversement)
:* [[Fichier:Easycoding_modeles.png|50px]] chargement de modèles de code.
:* [[Fichier:Easycoding_save.png|50px]] sauvegarde du projet au format EasyCoding (XML)
:* [[Fichier:Easycoding_load.png|50px]] chargement d'un projet au format EasyCoding (XML)

3 : Menu d'accès aux blocs de programmation, positionnables par Glisser/Déposer

4 : Zone de travail.

5 : Menu d'affichage. 
:* Recentrer
:* Zoomer +
:* Zoomer -
:* Corbeille (suppression de blocs par glisser/déposer)

====Chargement du projet====

* Téléchargez et décompressez ce fichier : '''[http://gce-electronics.com/wiki/images/e/e3/ESP8266_Relais.zip ESP8266_Relais.zip]'''

* Cliquez sur le bouton [[Fichier:Easycoding_load.png|50px|Load XML]] et sélectionnez le fichier XML précédemment téléchargé.

* Validez par OK pour charger le fichier.

::[[Fichier:easycoding.tn3.png|border|250px|Load XML]]

===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=====

::[[Fichier:ESP8266_Code_Wifi.png]]

Modifiez la valeur de chaque variable :
* '''NOM_DISPOSITIF''' : remplacez <code>''RelaisIPCAM1''</code> par le nom que vous souhaitez attribuer à votre module
* '''WIFI_SSID''' : remplacez la valeur <code>''MON_SSID''</code> par le SSID de votre réseau wifi
* '''WIFI_SECURITE''' : remplacez la valeur <code>''Ma_Cle_WPA''</code> par la clé WPA de votre réseau Wifi

=====Nom d'hôte et adresse IP statique=====

::[[Fichier:ESP8266_Relais_ConfigStatique.png]]

Si vous souhaitez affecter une adresse IP fixe au module, renseignez les valeurs
* '''IP''' : Remplacez <code>''192,168,0,64''</code> par l'adresse à attribuer. Attention, les séparateurs sont des virgules, et non des points.
* '''Passerelle''' : Remplacez <code>''192,168,0,254''</code> par l'adresse IP locale de votre routeur (box adsl), les séparateurs sont des virgules.
* '''Masque''' : Remplacez <code>''255,255,255,0''</code> 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 <code>'''Suppr'''</code> 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)

::[[Fichier:Relais4CH_Config_API.png]]

* '''IPX800_IP''' : remplacez <code>''192.168.000.112''</code> par l'adresse IP de l'IPX800 V4. Les séparateurs sont des points.<br>
:Cette adresse IP sera utilisée pour le retour d'état via l'API IPX800.
* '''IPX800_Port''' : remplacez la valeur <code>''80''</code> 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 <code>''apikey''</code> par votre clé API.


* '''API_Commande_ON''' : remplacez <code>''SetVO''</code> 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 <code>''ClearVO''</code> 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 <code>''05''</code> par le numéro de la sortie virtuelle ou physique qui recevra le retour d'état.

=====La configuration des Leds optionnelles=====

::[[Fichier:ESP8266_Relais_ConfigLeds.png]]

* '''LED_Link''' : remplacez <code>''1''</code> par <code>''0''</code> si la Led n'est pas installée en <code>D4</code>. La Led embarquée sera utilisée.

* '''LED_Relais''' : remplacez <code>''1''</code> par <code>''0''</code> si la Led n'est pas installée en  <code>D5</code>.

====Le reste du code====
<div class="mw-collapsible mw-collapsed" data-expandtext="{{int:show}}" data-collapsetext="{{int:hide}}" style="width:730px;">
 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.
<div class="mw-collapsible-content">

=====Les autres variables=====

::[[Fichier:ESP8266_Code_Var.png]]

=====Démarrage du Serveur Http=====

::[[Fichier:ESP8266_Code_Serveur.png]]

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

=====Mise en place de l'API Key s active=====

::[[Fichier:ESP8266_Code_APISECURE.png]]

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

[[Fichier:ESP8266_Code_Cde_API.png]]

=====Création des requêtes attendues par le module=====

[[Fichier:ESP8266_Code_Request.png]]

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

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

[[Fichier:ESP8266_Code_Request2.png]]

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.

</div></div>

== Sauvegarde et Transfert du programme sur le module==

Cliquez sur [[Fichier:Easycoding_save.png|50px|Save XML]] pour sauvegarder votre projet.


Exportez votre code vers Arduino IDE :
Sur l'interface de Easycoding, cliquez sur le bouton d'exécution [[Fichier:Easycoding_arduinoIDE.png|50px|Lancer le programme défini par les blocs dans l'espace de travail]].

Validez par OK

[[Fichier:ESP8266_Code_Transfert2.png|border]]


[[Fichier:ESP8266_Code_Transfert3.png|border]]

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.

[[Fichier:ESP8266_Televersement.png|500px]]

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

===L'espace de travail===

[[Fichier:ArduinoIDE_Interface.png|500px]]

1 : Barre d'outils

2 : espace programmation

3 : console

4 : Sélection en cours (type de carte et port COM)


'''La barre d'outil en détail :'''

[[Fichier:ArduinoIDE_Menu.png|500px]]

===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 "[[ESP8266_:_UN_RELAIS_WIFI#Pr.C3.A9requis|Prérequis]]"

Cliquez sur le bouton [[Fichier:ArduinoIDE_VerifCode.png|25px]] afin de vérifier le code.

Vérifiez les éventuelles erreurs dans la console.

===Téléversement vers le module===

* Cliquez sur le bouton [[Fichier:ArduinoIDE_TeleverseCode.png|25px]] pour compiler et téléverser le code compilé dans la mémoire flash du module,

* ouvrez le moniteur Série [[Fichier:ArduinoIDE_Moniteur.png|25px]]

* 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.

===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.

[[Fichier:ESP8266_Web_NoRequest.PNG|900px]]

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

[[Fichier:ESP8266_Web_ErrorRequest.PNG|900px]]

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

[[Fichier:ESP8266_Web_OnRequest.PNG|900px]]

'''Cas d'une requête OFF correcte'''

[[Fichier:ESP8266_Web_OffRequest.PNG|900px]]

===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.

===Récupération des requêtes à émettre===

A partir d'un navigateur, entrez l'adresse IP du module '''<nowiki>http://IP_Relais</nowiki>'''

Dans la page Web retournée par l'ESP8266, relevez les deux requêtes attendues.

===Création du widget pour émission de l'ordre "ON"===

Sur le dashboard de l'IPX800, créez un widget de type PUSH qui émettra la requête ON au module.

=> capture PUSH ON vers module

===Création du widget pour émission de l'ordre "OFF"===

Créez un second widget qui émettra la requête de type OFF

=> capture PUSH OFF vers module

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

Pour visualiser sur l'IPX800 l'état du relais wifi, nous allons créer un widget de pilotage de sortie sur le dashboard. Nous désactiverons le contrôle.

=> capture widget sortie virtuelle.

==Exemple d'intégration==

[[ESP8266_:_CAMERA_DANS_LA_BOÎTE_AUX_LETTRES | ESP8266 : CAMERA DANS LA BOITE AUX LETTRES]]