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 nouveaux produits n’ont m√™me plus de cavalier, tout se fait sans rien d√©monter.

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’entre nous , d‚Äôutiliser avec Jeedom ces modules tr√®s facilement.

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

Modèle Sonoff a intégré le Mode DIY Supporté par Sonoff-DIY
Mini et Mini R2
Mini R3 Nouveau
(sans s-Mate)

depuis 14/02/2022
Basic R3
4CH 4CH Pro R3
RF R3
D1
POW R2
POW R3 Nouveau
Dual R3
SPM Nouveau depuis 22/01/2022

La page Sonoff des √©quipements support√©s n’est pas √† jour mais est une bonne indication.

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 fonctionne et les commandes ON et OFF fonctionnent très bien, elles sont extrêmement rapides.

Le Sonoff SPM donne la consommation en temps réel (puissance active, réactive et apparente+tension+courant).

Plugin développé en php, JS Aucun démon ou dépendance, 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

Vidéo de présentation des SONOFF-DIY

Passage en mode DIY puis intégration à Jeedom

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.

Ajout du Sonoff-DIY MINI R3 (jan 2022)

Le Sonoff Mini R3 est sorti et il vient d’√™tre int√©gr√© dans le plugin.

Une page spéciale lui est dédiée ici

Ce module n’est pas encore document√© par Sonoff sur leur page officielle, j’ai donc tent√© de trouv√© les commandes √† tatons… et globalement c’est op√©rationnel.

  • On/Off √©videmment fonctionnent
  • Les retours d’√©tat fonctionnent
  • La commande Refresh fonctionne
  • La configuration du Pulse et de l’√©tat initial n’est pas encore impl√©ment√© (au 08/01/2022)
  • Les donn√©es suivantes sont bien r√©cup√©r√©es :

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 :

Laisser un commentaire