Plugin Sonoff-DIY Documentation

sonoffdiy icon

Présentation du plugin

Ce plugin va vous permettre de commander vos équipements Sonoff-DIY sans aucun flashage du module.

La marque Sonoff (Itead) lance une nouvelle gamme de produits labellisés DIY (Do It Yourself).

Cette gamme sp√©cialis√©e pour la domotique n‚Äôa plus besoin de ‚Äúflashage‚ÄĚ, le positionnement d‚Äôun cavalier bascule ces modules en mode DIY.

Les produits sont extrêmement peu chers.

Sans avoir à sortir le fer à souder ni de flasher le module, ce plugin (et la documentation qui correspond) vont permettre aux moins expérimentés , d’utiliser avec Jeedom ces modules très facilement.

Deux produits sont actuellement lancés mais d’autres viendront :

http://developers.sonoff.tech/sonoff-diy-mode-api-protocol.html#Supported-Device

Aucun protocole radio ou domotique n‚Äôest indispensable, les modules se placent sur le r√©seau wifi et fonctionnent gr√Ęce au plugin.

Le retour d’état ne fonctionne pas encore, c’est en cours d’étude, le documentation de Sonoff vient de sortir mais les commandes ON et OFF fonctionnent très bien et sont extrêmement rapide.

Plugin développé en php, JS Aucun démon, cron ou dépendance complexe, tout est dans le plugin.

Installation du Plugin Sonoff-DIY

Installer le Plugin depuis le Market

installationalexaapi1

Aller ensuite dans le Market et sélectionner Sonoff-DIY

Puis Activer le plugin

Options de configuration du plugin

Pas d’option

Devices compatibles

Sont compatibles :

Vidéo de présentation des SONOFF-DIY

Programmation des modules pour les interfacer avec le plugin

Les modules sont livr√©s comme utilisables avec l’application eWeLink

ewelink

N’utilisez pas cette application, il est m√™me totalement inutile de la configurer avant de passer au mode DIY.

Le seul interet de passer par l’application est de faire une mise √† jour, j’ai toujours re√ßu des modules √† jour donc je n’ai jamais utilis√© cette fonctionnalit√©.

Il est conseill√© par Sonoff d’utiliser au minimum la version 3.3.0

Attention, nouvelle version du Firmware 3.5.0, et nouvelle méthode, suivez : Tuto spécifique pour la version 3.5.0

Etape 1 : Basculer le module en mode DIY

Pour les basculer en mode DIY, il est necessaire de les ouvrir (c’est tr√®s simple) et d’ajouter le petit cavalier fourni sur l’emplacement pr√©vu √† cet effet :

Sonoff Mini demontage

Cet image pr√©sente un Sonoff Mini mais c’est quasiement la m√™me chose pour les autres modules.

Une fois le cavalier pos√©, fermez le boitier, c√īt√© hard (mat√©riel) c’est termin√©, votre module est pass√© en mode DIY.

Etape 2 : cr√©er un point d’acc√®s WIFI avec votre t√©l√©phone portable

Cette étape est très simple, utilisez votre téléphhone portable et activez la fonctionnalité, sur un Samsung, il faut par exemple faire :

  • Param√®tres
  • Connexions
  • Point d’acc√®s mobile et modem
  • Activer Point d’acc√®s mobile
  • Appuyer dessus
  • Changer le nom du r√©seau et mettre : sonoffDiy
  • Changer le mot de passe et mettre : 20170618sn
  • Sur les … en haut √† droite, Appareils autoris√©s puis D√©sactiver Uniquement les p√©riph√©riques autoris√©s

Etape 3 : raccorder le Sonoff √† l’√©lectricit√©

Evidemment avec toutes les pr√©cautions d’emploi !!!

  • Connecter N et Lin √† une prise de courant
  • Connecter la prise

La diode bleue va clignoter 1 fois toutes les secondes. D√®s que la connexion sera faite au point d’acc√®s, elle clignotera 2 fois en 1 seconde.

Etape 4 : connecter un ordinateur au point d’acc√®s sonoffDiy

Sur un ordinateur dot√© d’une carte wifi, chercher dans la liste des connexions wifi disponibles

Se connecter au réseau sonoffDiy (avec le code 20170618sn)

Etape 5 : Lancer le programme Sonoff DIY mode tool

Télécharger la dernière version du programme sur cette page

diy

  • Si la liste des √©quipements reste malheureusement vide alors que le point d’acc√®s est bien cr√©√© et que le module clignote bien avec deux impulsions bleues, nous avons d√©tect√© (merci ezdom) que le souci vient d’un conflit entre le WIFI 2.4Ghz et le 5Ghz. Pour corriger cela, d√©sactivez le 5Ghz dans votre routeur wifi (ou d√©connectez les antennes 5Ghz si vous savez faire cela).
  • Si malgr√© la d√©sactivation du 5Ghz, vous avez toujours une liste vide, utilisez la m√©thode Google Chrome/Avanced REST Client (ARC). Cette m√©thode est expliqu√©e sur cette page.
  • Noter le num√©ro qui figure dans la premi√®re colonne, il vous servira pour identifier votre module, (si vous avez oubli√©, le plugin pourra vous le retrouver.)

Etape 6 : Changer SSID Password

En bas à droite, utiliser le bouton Change SSID Password pour mettre le SSID et le mot de passe de votre réseau Wifi

Etape 7 : Débrancher et rebrancher le module Sonoff

C’est termin√©, votre module Sonoff doit se retrouver sur votre r√©seau Wifi

Etape 8 : Aller chercher l’adresse IP de votre nouveau module

L’interface de votre routeur vous donnera l’IP de ce nouveau module, vous devez l’avoir dans les derniers modules d√©tect√©s et ajout√©s par le serveur DHCP de votre routeur. Je vous conseille de lui attribuer une IP fixe √† ce stade.

  • Noter l’IP, elle vous sera n√©cessaire pour commander le module depuis le plugin

Ajout d’un Device Sonoff Diy

Il suffit d’appuyer sur le bouton + pour ajouter un √©quipement

Screenshot 2020 01 25 Sonoffdiy Jeedom

Configurer un nouvel équipement

Screenshot 2020 01 25 Sonoffdiy Jeedom1

Il y a deux param√®tres dans la configuration d’un module :

  • L’adresse IP : Param√®tre obligatoire, c’est l’adresse de votre module sur votr r√©seau wifi, votre routeur vous donnera cette information (cf. Etape 8 de la programmation des √©quipements)
  • L’ID du Device : Param√®tre obligatoire, ce num√©ro de s√©rie vous est donn√© lors de la configuration du module par le logiciel DIY mode tool.

Important : Si vous n’avez pas sp√©cifi√© l‘ID du device, vous n’aurez pas les retours de changements d’√©tat car le plugin ne saura pas √† quel device.

Vous avez un moyen tr√®s simple pour retrouver l’ID d’un device :

Trouver l’ID d’un Sonoff

Si vous avez besoin de retourver l’ID d’un device, suivez cette proc√©dure :

  • Allez dans la configuration du plugin, mettez vous en mode ¬ę¬†debug¬†¬Ľ (warning minimum) et pour que ce soit plus simple, ouvrer le log sonoffdiy_mDNS et cliquer sur vider pour le purger

Screenshot 2020 01 27 Sonoff DIY Jeedom

  • Lancer un changement d’√©tat du module en question (le passer sur on ou sur off)
  • Retourner dans la configuration du plugin, ouvrer le log sonoffdiy_mDNS, vous trouverez l’ID dans le log :

Screenshot 2020 01 27 Sonoff DIY Jeedom1

  • Recopiez cette ID dans la configuration de l’√©quipement, vous ne devriez plus voir ce type de message dans le log et le widget de votre √©quipement changera d’√©tat automatiquement.

Commandes disponibles

On / Off

Ces commandes actionnent le relais du module,

  • ON = allum√©
  • OFF = √©teint

Nota : La commade info Etat du relais permet de récupérer cette information.

Pulse On/Off

Les modules sont √©quip√©s d’une option ¬ę¬†Pulse¬†¬Ľ.

Si cette option est sur ON et qu’un nombre de milli-secondes est sp√©cifi√©, lorsque l’utilisateur passera le module √† On, il s’√©teindra au bout de la tempo sp√©cifi√©e.

  • Pour d√©sactiver l’option, lancer la commande ¬ę¬†Pulse Off¬ę¬†
  • Pour activer l’option, lancer la commande ¬ę¬†Pulse On¬†¬Ľ avec un nombre de milli-secondes (5000 par exemple pour 5 secondes)

Le nombre de multisecondes doit être un multiple de 500 (1/2 seconde).

Ces commandes sont √† programmer une fois pour toute en fonction de l’utilisation de votre modufle, cela ne doit pas √™tre envoy√© √† chaque changement d’√©tat. C’est une valeur de param√©trage du module et reste enregistr√©e dans le module.

Nota : La commade info Etat à la mise sous tension permet de récupérer cette information.

Etat Initial

Les modules sont √©quip√©s d’une option ¬ę¬†Startup¬†¬Ľ.

Cela correspond √† l’√©tat (on/off) sur lequel se place le module √† sa mise sous tension.

  • Pour que le module s’allume √† la mise sous tension, choisir On
  • Pour que le module soit reste eteint √† la mise sous tension, choisir Off
  • Pour que le module garde son dernier √©tat √† la mise sous tension, choisir Stay

Ces commandes sont √† programmer une fois pour toute en fonction de l’utilisation de votre modufle, cela ne doit pas √™tre envoy√© √† chaque changement d’√©tat. C’est une valeur de param√©trage du module et reste enregistr√©e dans le module

A noter que ces commandes (qui sont très peu utilisées une fois le module en service) doivent être programmées via un scénario.

Si cette commande est lanc√©e depuis le bouton ¬ę¬†test¬†¬Ľ de l’√©cran des commandes du device, c’est l’√©tat Stay qui est envoy√© (Mise √† jour version 10/05/2020)

Nota : La commade info Etat de la fonction Pulse et Tempo de la fonction Pulse permet de récupérer cette information.

Rafra√ģchir

Cette commande actualise les états du modules.

Nota : Cette commande sera que très peu utilisée puisque les états sont actualisés automatiquement et instantanement.

Informations disponibles

Afin de permettre aux utilisateur d’exploiter au mieux toutes les possibilit√©s et les options des modules, beaucoup d’informations sont disponibles.

Notez que ces informations sont actualisés automatiquement et instantanement.

Le widget du device sera basé sur ces informations.

Pour les utiliser (ou pas), vous pouvez cocher ¬ę¬†Afficher¬†¬Ľ pour les retrouver sur le widget de l’√©quipement.

Etat du relais

Cette information (1 ou 0) correspond √† l’√©tat allum√© ou √©teint du module

Screenshot 2020 01 25 Dashboard Jeedom1

Etat à la mise sous tension

Cette information correspond √† la configuration choisie par l’option Startup, cf. Commande ¬ę¬†Etat initial¬†¬Ľ

Etat de la fonction Pulse

Cette information correspond √† la configuration choisie par l’option Pulse, cf. Commande ¬ę¬†Pulse¬†¬Ľ

Tempo de la fonction Pulse

Cette information correspond √† la tempo en milli-secondes choisie pour l’option Pulse, cf. Commande ¬ę¬†Pulse¬†¬Ľ

Nota : cette information est ignorée si Pulse est sur Off

SSID

Cette information correspond au SSID de votre réseau Wifi

RSSI

Cette information correspond à la force du réseau Wifi

Cette valeur de signal est mesurée en décibels de 0 à -120. Plus la valeur est proche de 0, plus le signal sera fort.

  • Entre 0 et -50, c’est extr√®mement rare.
  • Entre -50 et -80 est correct.
  • Entre -80 et -100 est mauvais.

Foire Aux Questions FAQ

FAQ1 : Le widget de mon √©quipement ne change pas d’√©tat quand je l’utilise manuellement

C’est que l’ID du device de cet √©quipement n’est pas renseign√© ou n’est pas exact, suivez cette proc√©dure pour r√©soudre le souci

FAQ2 : J’ai une erreur 400 quand je veux utiliser la commande ¬ę¬†Etat initial¬†¬Ľ avec la valeur Off ou Stay

Il y a eu une petite erreur gliss√©e dans la version de mai 2020, corrig√©e depuis la mise √† jour de Juillet 2020. Pour ne plus avoir l’erreur, il suffit d’aller dans les commandes du device en question, sur la commande Etat initial et de retirer les espaces apr√®s les points virgules, pour obtenir cela :

Liens intéressants, expériences ou tuto :

La sonnette connectée de juandelavega

One thought on “Plugin Sonoff-DIY Documentation

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *