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.

Quelques 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

Mise à jour décembre 2020

Étape 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.

Étape 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

Étape 3 : raccorder le Sonoff Ă  l’Ă©lectricitĂ©

Évidemment 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.

Étape 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)

Étape 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.)

Étape 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

Étape 7 : Débrancher et rebrancher le module Sonoff

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

Étape 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

Nota du 07/03/2021, le plugin est maintenant capable de trouver seul l’ID si vous ne l’avez pas. L’ID sera dĂ©tectĂ©e Ă  l’envoi de la première commande.

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.

Bonus, créer un toggle on/off

Habituellement, le device apparait sous cette forme :

On a donc un bouton On, un bouton Off et un widget indiquant l’etat du relais
Le plugin a Ă©tĂ© amĂ©liorĂ©, on peut maintenant avoir un seul bouton reprĂ©sentant la lumière, un appui dessus allume, un autre appui dessus Ă©teint. Cela est vraiment pratique pour l’intĂ©gration dans un Design et Ă©vite de passer par un Virtual.

Pour rĂ©aliser cela, il faut mettre le mĂŞme widget sur la commande On et sur la commande Off puis dĂ©cocher la case Afficher de l’Ă©tat du relais, tout le reste est gĂ©rĂ© par le plugin.

Exemples d’utilisation

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 :

One thought on “Plugin Sonoff-DIY Documentation

  1. Bonjour, super facile de mise en oeuvre. Sauf pour une fonction. Avant de passĂ© en Diy sur des sonoff mini il y avait la possibilitĂ© de brancher un bouton poussoir plutĂ´t qu’un inverseur(va et vient). Comment configurer cette fonction dans jeedom?

  2. Je me permet de poster ici car je viens de recevoir mes modules et il semble que le cavalier ai disparu, j’ai dĂ©monter le module mais le 2 pins n’y sont plus, on retrouve 2 trous repĂ©rĂ©s OTA et GND. Pensez vous qu’il faille que je soude un shunt afin de les passer en DIY?

    1. Bonjour, je suis dans le mĂŞme cas, j’ai commandĂ© un switch DIY Mini chez Domadoo mais il n’y a pas de cavalier, le jumper a disparu de la carte electronique. Il s’agit bien d’un module DIY , c’est marquĂ© sur la boite et sur le manuel fourni avec.

      Je l’ai configurĂ© dans le plug in sonoffdiy, mais je ne peux pas le piloter. Le plugin me renvoie une erreur « souci dans la commande on … »

      Le module fonctionne bien dans ewelink.

      merci de votre aide

    2. Bonsoir,
      Je rencontre le mĂŞme problème, je n’ai pas de cavalier.
      Comment as tu fais ? (soudure, logiciel ?)
      Merci pour le retour,

    3. Bonjour,
      J’ai Ă©galement le mĂŞme soucis !
      Je viens d’acheter des MINIR2, mais pas de cavalier Ă  l’intĂ©rieur.
      Avez-vous trouver la solution ?
      Merci
      Jerem

  3. bonjour J’ai exactement la mĂŞme chose, je vois que l’on peut cochĂ© contrĂ´le sur rĂ©seaux local dans l’application

  4. Bonjour

    Merci pour cet excellent plugin qui aide bien la vie.

    Par contre, y’a-t’il en prévision une commande pour éteindre les led bleus du signal wifi ?
    C’est relativement casse-pied d’avoir les modules qui flashent toutes les 3 secondes…

    Sinon,
    Merci

  5. Bonjour,
    je remet ici mon msg postĂ© sur le topic todo-list oups… erreur dsl

    J’ai voulu déplacer un module Sonoff mini DYI dans un autre VLAN… Je le ping sans soucis, si j’actionne l’interrupteur l’état de ce module remonte bien dans Jeedom par contre impossible de le piloter à distance j’ai systématiquement une erreur de type :
    [2020-11-19 20:50:55][ERROR] : ║ ******** Souci sur la commande On de Entrée comble ********
    je débute avec Jeedom (V4.0.61)… je n’ai qu’un seul fichier log « sonoffdiy » pas de log « sonoffdiy_mDNS »
    J’ai aussi essayé de le supprimer et de le recréé sans succès…
    Par contre j’ai essayĂ© avec l’outil Sonoff => tout marche correctement… du coup est-ce qu’il y aurait un cache ou quelque chose du genre Ă  vider…

  6. Bonjour,
    J’ai suivi Ă  la lettre les instructions pour intĂ©grer mon sonoff mini dans mon rĂ©seau, je le vois sur l’application ewilink, je retrouve bien son ip sur mon router sur le rĂ©seau wifi 2.4, mais je ne parviens pas Ă  communiquer dans jeedom, j’ai ce genre de message « Souci sur la commande On de mini « , sur le module je n’ai pas de cavalier. Une idĂ©e ? Merci

  7. Salut,

    Merci pour ce tuto, mais j’ai un petit problème.
    J’ai bien modifier mon SSID etc, mais impossible de retrouver le sonoff mini en l’ajoutant avec l’id et l’ip dans jeedom.

    A plus

  8. Bonjour,
    J’ai bien tout installĂ© avec un sonoff mini DIY version 3.6.0 d’emblĂ©e (nouvelle version sans le cavalier).
    Tout fonctionne très bien avec eWilink mais rien ne fonctionne avec le plugin.
    J’ai essayĂ© de tout dĂ©sinstaller et tout rĂ©installer sans eWilink. Toujours pareil.
    Je suis sur jeedom sur une Raspberry pi connectĂ©e en RJ45. Le sonoff est en wifi 2,4GHz. J’ai rĂ©cupĂ©rĂ© l’IP qui est fixe et l’ID du sonoff….
    Je suis Ă  cours d’idĂ©e.

    Merci et bonne année !

    1. je confirme…
      J’ai mis 3 hr Ă  essayer de parametrer mon sonoff DIY Basic R3 et c’est voyant ton message (et le lien) que j’ai compris.
      Mon premier Sonoff avait ete installe avec cette procedure (voir mon message plus haut) mais maintenant cela ne fonctionne plus : je ne trouvais pas mon sonoff sur mon reseau wifi.

  9. Bonjour,
    tout d’abord merci pour les tutos qui permettent d’avancer sans etre un expert.
    J’ai egalement un probleme avec un sonoff rfr3 et jeedom; impossible d’etablir une communication
    Poutant sans le cavalier le module fonctionne avec ewelink et mĂŞme Alexa en vocal
    En DIY avec cavalier, j’ai le message ***souci sur la commande On de sonoff***
    L’IP et l’ID sont bon
    Sympa si qq à une idée
    Slts

  10. J’apporte une petite pierre Ă  l’Ă©difice, j’ai deux petites remarques après l’installation de mes sonoff mini :

    1- lorsque le module est connectĂ© Ă  votre rĂ©seau, ne cherchez un equipement avec un nom qui contient sonoff, vous allez chercher très longtemps et croire que le pairing ne s’est pas fait ( comme moi ) et recommencer et recommencer la procĂ©dure jusqu’Ă  Ă©puisement. Mes 2 modules Ă©taient reconnus avec un nom commençant par ESP et un numĂ©ro dĂ©rrière …

    2- En recommençant la procĂ©dure je me suis heurtĂ© Ă  un souci qui n’en ai pas un aujourd’hui mais qui le sera certainement demain, une fois le module connectĂ© Ă  un wifi il est impossible de faire un hard reset et de le connecter Ă  un autre wifi, la page 10.10.7.1 n’est plus accessible. J’ai tout essayĂ© sans succès et beaucoup sur le net en parlent.

  11. Bonjour, les commandes fonctionnent bien mais sur les sonoff mini, je n’arrive pas à connaître le device Id.
    Je n’ai pas de bouton log sonoffdiy-mDNS. Dans le log je vois les commandes on ou off envoyer avec device Id « ». Comment faire pour avoir un retour d’état ?
    Sinon, super blog.

Laisser un commentaire

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