Mon premier script Lua dans Domoticz : La mise en oeuvre

Cet article fait suite à deux autres permettant de poser les bases du langage Lua dans Domoticz.

Le premier  (https://easydomoticz.com/point-scripts-lua/)  décrivait quels étaient les principes de fonctionnement des script Lua.

Le second donnait quelques notions de langage.

Ici pour faire suite nous allons prendre un exemple que nous allons dérouler et complexifier étape par étape.

L’exemple que je souhaite détailler ici part du fait que je possède un capteur de luminosité, des volets roulants. Je voudrais que lorsque la luminosité descend en dessous de 170 et que il est plus de 17h30, fermer tous les volets automatiquement. 😯

fenetres_maison

N.B :Pour simplifier j’ai rassemblés tous (!) mes volets roulants au sein d’un groupe (une scène au sens Domoticz)  pour pouvoir les commander tous ensemble.

Dans un pseudo langage on pourrait écrire :

  • A chaque fois que la valeur de mon capteur de luminosité change

je regarde si il est plus de 17H30

ET si

elle est inférieure a 170

ALORS

je passe le groupe des volets à ON

Ce qui signifie qu’il nous faut un script basé sur les devices puisque je cherche à déclencher tout cela lorsque la luminosité change, il faudra récupérer la valeur de notre capteur , la comparer à un seuil, aller chercher l’heure actuelle la comparer à un seuil horaire, puis passer le groupe de volets à ON.

N.B : il y a un petit bug de conception car une fois que les volets vont être fermés, si j’allume puis éteint la lumière de mon salon, la luminosité va changer, il sera plus de 17h30 et on tentera de fermer les volets en permanence alors qu’ils le sont déjà.

Lire la suite

Pour toute question technique concernant cet article, veuillez utiliser les forum situés à https://easydomoticz.com/forum/

Mon premier script Lua dans Domoticz : Les fondations

Nous avons vu précédemment https://easydomoticz.com/point-scripts-lua/ quels sont les principes de fonctionnement des script Lua au sein de Domoticz, voyons dans cet article les premières base de la rédaction de scripts puis nous prendrons un exemple que nous allons dérouler et complexifier de bout en bout afin de voir quelques instructions.

Les bases des scripts : Avoir les idées claires

idees

Avant toute chose, il faut que vous ayez les idées claires concernant les actions que vous devez réaliser, prenez un papier et un crayon et écrivez en français ce que vous devez faire.

Partant du fait que je possède un capteur de luminosité, des volets roulants que j’ai tous rassemblés dans un groupe (une scène au sens Domoticz)  pour pouvoir les commander tous ensemble, je voudrais que lorsque la luminosité descend en dessous de 170 et que il est plus de 17h30, fermer tous les volets.

 

Ce qui pourrait commencer à se traduire par :

  • A chaque fois que la valeur de mon capteur de luminosité change

je regarde si elle est inférieure a 170

ET si

il est plus de 17H30

ALORS

je passe le groupe des volets à ON

Ce qui signifie qu’il nous faut un script basé sur les devices puisque je cherche à déclencher tout cela lorsque la luminosité change, il faudra récupérer la valeur de notre capteur , la comparer à un seuil, aller chercher l’heure actuelle la comparer à un seuil horaire, puis passer le groupe de volets à ON.

N.B : il y a un petit bug de conception car une fois que les volets vont être fermés, si j’allume puis éteint la lumière de mon salon, la luminosité va changer, il sera plus de 17h30 et on tentera de fermer les volets alors qu’ils le sont déjà.

Lire la suite

Pour toute question technique concernant cet article, veuillez utiliser les forum situés à https://easydomoticz.com/forum/

Domoticz et Tasker

Beaucoup d’entre vous connaissent et utilisent l’ appli Android nommée Tasker qui permet d’ automatiser des tâches sur son téléphone/tablette Android.

Faisons ici un petit tour d’horizon de cette  appli pour ceux qui ne la connaitraient pas

Depuis quelques semaines vous avez recyclé un vieux téléphone Android qui fait maintenant plate-forme d’ envoi de sms grâce à cet article concernant les sms alors voyons ici comment transformer ce téléphone en capteurs capable d’envoyer des données vers Domoticz via Tasker.

 

Prérequis

 

Le logiciel Tasker permet de récupérer tout ce qui se passe sur votre appareil Android et d’en faire quelque chose.

Par exemple : Si le Wifi est off alors on le passe à On, si on se situe dans tel lieu alors on envoie un sms automatique, si on dit Ok Google allume la musique …

Un lien de lecture ici http://techno-bidouille.com/android-exploitez-vos-capteurs/  ou l’auteur utilise tout d’abord un logiciel nommé sensors pour savoir de quel capteurs est équipé son téléphone/tablette Android.

Tasker : Les bases

Ici , pas question de faire un cours complet de Tasker , plein de tutos existent.

Le minimum à savoir est que la décomposition dans Tasker est la suivante

Le profil Tasker  est basé sur un évènement : « si il est telle heure », « si mon wifi est off », « si l’appli X se lance » ….

Et lorsque un profil est exécuté il lance une tâche.

Une Tâche  est un ensemble d’actions à réaliser suivant le profil.

Sachez qu’il y a des scènes qui sont des interfaces graphiques Tasker, des variables que l’on peut stocker, plein de choses avec lesquelles on peut jouer.

Tasker : En pratique

Commencez par créer un profil basé sur les heures.

Décochez  la case « De » et la case « Jusqu’a » puis cochez en bas « Répéter » toutes les X minutes à votre volonté.

Attention : pour valider il faut faut utiliser la flèche « Retour » en haut à gauche.

Donc nous avons un truc (profil) qui déclenche toutes les 5 minutes.

Créons une tâche. Nommons la puis associons lui UNE action

Je vous conseille au début afin de connaitre tous les capteurs utilisables sur votre Android, soit d’installer l’appli Sensors soit de faire une tache Alerte/Popup qui affiche la valeur en question (les capteurs en rouge ne sont pas accessibles).

Ici j’illustre le fait de lancer une popup, le TEXTE de ma popup sera le niveau de batterie de mon téléphone, en cliquant sur le petit crayon gris en bout de ligne en face du TEXTE que je veux afficher :Tasker2

 

j’obtiens la liste des variables utilisables.

Tassker1

Je choisis donc « Niveau de batterie »

Validez puis remarquez que les valeurs des capteurs se nomment %TEMP, %HUMIDITY, %BATT, ainsi de suite.

Ce qui va nous être utile pour la suite lors de l’envoi vers Domoticz.

L’envoi des données vers Domoticz

J’ai honte, mais il s’avère que Deennoo sur le forum à traité de cette partie avant moi, aussi vais je vous renvoyer vers ses explications

https://easydomoticz.com/forum/viewtopic.php?f=7&t=1008

 

Bonne lecture et n’hésitez pas à poser vos questions dans le forum.

Pour toute question technique concernant cet article, veuillez utiliser les forum situés à https://easydomoticz.com/forum/

Mother & Cookies Sen.se : intégration dans Domoticz 2eme partie

Les créateurs du lapin connecté bien connu ont développé une nouvelle invention « Mother » et ses petits cookies.

Mother

Les cookies sont des capteurs polyvalents connectés à leur « Mother », elle même reliée au cloud.

La société commercialisant cet objet connecté se nomme sen.se
Dans l’article précédent nous avons vu comment récupérer une clé d’API sen.se, créer les widgets Domoticz, etc…
Voyons ici comment installer, configurer le script python de récupération.

Généralités

Vous trouverez plus loin un script python destiné à récupérer les données POUR 1 seul COOKIE.
Si vous envisagez de gérer plusieurs cookies, il faudra recopier le script plusieurs fois sous des noms différents (celui du cookie par exemple) et faire les paramétrages des widgets Domoticz dans chaque script.

N.B : Il existe une bibliothèque spécifique python sense dans un github. J’ai fait le choix de ne pas l’utiliser car autant l’API sen.se est bien décrite et documentée que cette bibliothèque est pauvre en littérature.

Installation

Si ce n’est déjà fait, installer python et pip par un

sudo apt-get install python	 	
sudo apt-get install python-pip

puis  les bibliothèques ssl pour https,  nécessaires pour interroger sen.se.

sudo pip install requests==2.5.3
sudo pip install requests[security]

et si cela ne marchait pas (erreurs SSL lors du lancement du script) faites 
sudo pip install pyopenssl ndg-httpsclient pyasn1

L’intégration de ces 3 dernières bibliothèques ralentit considérablement les scripts écrits en python 2 , python 3 donne des temps d’exécution bien plus rapides.

A ce jour un bug est ouvert https://github.com/pyca/pyopenssl/issues/137

LA solution serait de convertir le script en python3 ou d’atttendre une mise à jour de python2 qui corrigerait ce phénomène.

Le script python

Il n’est pas hyperpythonisé pour qu’il puisse être compréhensible.

Il est téléchargeable ici https://easydomoticz.com/scripts/cookie1.py
Créez un fichier .py au nom de votre cookie par exemple mon cookie se nommant « golden eyes », je choisis de nommer le script golden.py.
Copiez/collez le script dans votre nouveau fichier.

Examinons le contenu du fichier.

La config Domoticz

Tout d’abord arrivent les ip,port, user/password de Domoticz.
Comme j’utilise beaucoup de scripts python j’ai crée, une fois pour toute, un fichier nommé config_Domoticz.py contenant tous les paramètres usuels de ma configuration Domoticz que j’importe systématiquement à chaque nouveau développement.
Voila la structure du config_Domoticz.py

#!/usr/bin/python
 	 
# -*- coding: utf-8 -*-	 	 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~	 	 
# les parametres de Domoticz	 	 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~	 	 
domoticz_ip='192.168.1.82'	 	 
domoticz_port='8080'	 	 
domoticz_user=''	 	 
domoticz_password=''	 	 

Créez ce fichier sous le nom de config_Domoticz.py copier/coller les lignes ci-dessus, modifiez suivant votre installation , les ip, port, user,password.
Mais ceci n’est pas obligatoire, bien que pratique.
Vous verrez dans le script python que l’on peut les encoder directement ou faire référence à  ce fichier de paramètres (config_Domoticz.py) que l’on importe et qui fournira ces données. Supprimez le bloc qui n’est pas nécessaire ou commentez le par des # en décommentant l’autre.

~~~~~~~~~~ Parametres Domoticz ~~~~~~~~~~~~~~~~~~~~~~~~~~~~	 	 
domoticz_ip='192.168.1.82'	 	 
domoticz_port='8080'	 	 
user=''	 	 
password=''	 	 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~	 	 
#~~~~~~~~~~ Parametres Domoticz importes depuis le fichier config_Domoticz.py ~~~~~~~~~~~~~~~~~~~~~~~~~~~~	 	 
########### import de mes parametres Domoticz #################################	 	 
#import config_Domoticz	 	 
#domoticz_ip=config_Domoticz.domoticz_ip	 	 
#domoticz_port=config_Domoticz.domoticz_port	 	 
#user=config_Domoticz.domoticz_user	 	 
#password=config_Domoticz.domoticz_password	 	 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~	 	 

Mode debug et param

La ligne debug=0 peut être modifiée en debug=1 pour afficher les URL lues de chez sen.se et les URL que nous écrirons dans Domoticz.

fparam=0 , le passage à 1 de cette variable permet d’avoir quelques indications sur les widgets à créer.

Repassez ces 2 variables à 0 une fois débuggé l’ensemble.

les idx des widgets

Il s’agit du bloc ci-dessous :

#~~~~~~~~~~~ Parametres des widget Domoticz~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~	 	 
### Parametrage des idx des widget de Domoticz ##########################	 	 
## creer un widget 'compteur' poubelle et affecter a son idx tous les parametres	 	 
## non desires 	 	 
periph_idx= { 'Motion_durationSeconds' : 11, 	 	 
 'Motion_numberMovements' : 13,	 	 
 'Motion_avgIntensity' : 14,	 	 
 'Alerte' : 6,	 	 
 'Presence' : 10,	 	 
 'Temperature' : 8,	 	 
 'Batterie' : 7,	 	 
 }	 	 
##################################################################################	 	 

Dans l’article précédent nous avions crée des widgets destinés à recevoir nos valeurs et avions noté leurs idx Domoticz.
Nous allons reporter ces idx en face de chaque paramètre (nommé Event chez Sen.se, regardez l’api sen.se ou l’article précédent pour la signification de ces events)
Ne supprimez pas de ligne dans ce bloc.

Si vous ne désirez pas certaines valeurs, mettez un chiffre bidon, mais gardez les textes tels qu’ils sont.

Ou alors créez un compteur « poubelle » et affectez son idx à tous les compteurs que vous ne voulez pas afficher.
Ainsi si j’ai un compteur caché nomme $dechets dont l’idx est 44 , les 3 valeurs de motion et la batterie ne seront pas affichés dans Domoticz grâce à

periph_idx= { 'Motion_durationSeconds' : 44, 	 	 
 'Motion_numberMovements' : 44,	 	 
 'Motion_avgIntensity' : 44,	 	 
 'Alerte' : 6,	 	 
 'Presence' : 10,	 	 
 'Temperature' : 8,	 	 
 'Batterie' : 44,	 	 
 }	 	 
##################################################################################

Les paramètres de chez sen.se

Ensuite nous  configurons les paramètres de notre compte sen.se

La clé d’api (c.f le 1er épisode ou https://sen.se/board/ ) puis le nom du cookie (c.f le 1er épisode ou https://sen.se/board/ )

# la cle API
sense_api_key = '5qddhhhjtddsj443EFGTYGghgg35RDZfff'
# cookie_id
cookie_name='golden eyes'

Utilisation du script python.

chmod +x golden_eye.py
./golden_eye.py pour le lancer

Vérifiez, vérifiez et vérifiez que tous les widgets sont correctement alimentés.

Une fois correct placez une ligne dans le crontab  à la fréquence que vous désirez par un crontab -e

*/10 * * * * root /domoticz/scripts/golden_eye.py

Cette ligne déclenche le script golden_eye.py toutes les 10 minutes

A ce sujet je constate que les envois de données ne se font pas régulièrement mais à chaque fois que une valeur change pour ce cookie.

Le script python ne récupère QUE la valeur la plus récente.

Merci à Knox du forum pour sa demande initiale, sa participation aux tests et sa relecture attentive.

J’espère que cet article vous prouvera une fois de plus que : Nobody loves me but my mother.

et pour les amateurs de blues | bd
http://zepworld.blog.lemonde.fr/2015/05/18/b-b-king-moi/

 

P.S :Et vous qui êtes le petit cookie de votre Mother, n’oubliez pas de lui souhaiter sa fête le 31 Mai 😆

Pour toute question technique concernant cet article, veuillez utiliser les forum situés à https://easydomoticz.com/forum/

Mother & Cookies Sen.se : intégration dans Domoticz 1ere partie

Les créateurs du lapin connecté bien connu ont développé une nouvelle invention nommée « Mother » et accompagnée de petits « cookies ».

On dirait un croisement entre un barbapapa et une poupée russe.

mother2

Le site « les numériques »  nous  dit que  :

Mother, cette véritable « mère juive », comme s’en amuse son créateur, est à la tête d’une famille de petits capteurs connectés baptisés Motion Cookies. Polyvalents, ceux-ci sont paramétrables. Le principe repose sur l’interrogation : « Qu’est-ce qui est important pour moi en ce moment ? » Tout comme les réponses à cette question, la programmation des tâches est multiple et modulable.

Sécurité, santé, bien-être… Sen.se promet aux utilisateurs d’inventer la vie connectée dont ils ont envie, transformant les Cookies en podomètre connecté, thermomètre, outil de vérification… Quelle distance ai-je parcourue aujourd’hui ? Combien de calories ai-je dépensées ? Mes enfants sont-ils bien rentrés de l’école ? Se sont-ils soigneusement brossé les dents ? Quelqu’un est-il entré chez moi ? Si oui, à quelle heure ? Toutes les activités sont enregistrées et délivrées en temps réel.

source http://www.lesnumeriques.com/objet-connecte/mother-p18525/test.html

Vous pouvez assister à démo publicitaire sur le site web de référence https://sen.se/store/mother/

Le fonctionnement de cette solution est le suivant : chacun des cookies envoie à intervalles réguliers (?) ses infos de geoloc, température, présence…, à  sa ‘mère’ qui elle même retransmet cela sur le site sen.se en mode cloud.

Ainsi on peut suivre individuellement chaque cookie, sa présence, ses paramètres…

On peut imaginer de tels de scénarios :

Je rentre à la maison, il fait nuit dehors, les lumières s’allument, mais si il fait jour j’ouvre les volets.
ou
Si aucune personne n’est détectée dans la maison, on active le mode alarm.

 

Ce qui va nous occuper ici sera la connexion de Mother à notre plate forme préférée de domotique. Pour cela allons devoir interroger l’API de sen.se pour récupérer les données individuelles de chaque capteur-cookie.

 

Vous trouverez plus loin un lien sur script python destiné à cet usage. Ce script ne récupère les données QUE POUR 1 seul COOKIE.

Donc si vous envisagez de gérer plusieurs cookies dans Domoticz, il faudra recopier le script sous un nom différent et faire les paramètrages des widgets Domoticz dans chaque script.

N.B : Il existe une bibliothèque spécifique python sense dans un github. J’ai fait le choix de ne pas l’utiliser car autant l’API sen.se est bien décrite et documentée que cette bibliothèque est pauvre en littérature.

Nous partirons du fait que l’installation est fonctionnelle, que le compte est crée chez sen.se, les capteurs et la mère associés correctement à votre compte comme décrit dans le mode opératoire fourni avec votre achat.

Récupération des identifiants sen.se.

La clé d’API.

Toute l’interrogation du cloud sen.se se base sur des échanges sécurisés en https par le biais d’un identifiant unique nommé « Clé API ».

Rendez vous à l’adresse : https://sen.se/board/, connectez vous à votre compte, utilisez maintenant le menu en haut à  droite pour accéder au menu « Développeur » puis « Clé d’API ».

apikey

Copiez cette clé par un clic droit.

Les cookies

Chaque cookie envoie donc ses données via Mother au board sen.se.

Nous aurons besoin du nom du cookie pour interroger les données lui appartenant.

Allez récupérer le nom dans le menu du bas « Things-Mes objets » ou via ce lien https://sen.se/devices/

Attention : Notez bien les espaces, majuscules/minuscules.

Nom-Cookie

Les données envoyées par les cookies

A l’adresse https://sen.se/api/docs/v2/events/# nous voyons que de nombreuses données sont disponibles.

Certaines sont liées à Mother, d’autres à chacun des cookies.

Le script python dans son état actuel récupère pour un cookie donné les paramètres suivants :

  • Alert : (Détection mouvement) : https://sen.se/api/docs/v2/events/#alert, on récupère une ‘intensité’ (de mouvement j’imagine) sans unité , je n’ai pas d’ordre de grandeur de cette valeur.
  • Presence : Présence de ce cookie auprès de sa mère.  https://sen.se/api/docs/v2/events/#presence la valeur 200 est renvoyée si il est à proximité, 404 si il est hors de vue durant 2 minutes et 201 lorsque le cookie est proche mais n’est pas relié à sa mère (les données ne sont alors pas transmises au cloud sen.se)
  • Motion :  mesure de « secouage™ » du cookie (lavage de dents, sommeil…) https://sen.se/api/docs/v2/events/#motion 3 paramètres sont lus  : « numberMovements », « durationSeconds » , « avgIntensity » et affectés à Domoticz pour l’usage qui vous conviendra dans 3 widgets.

Vous constatez que au total ce sont 7 paramètres maximum que l’on récupère PAR COOKIE.

 Configuration de Domoticz

On a vu qu’au maximum chaque cookie peut envoyer 7 paramètres différents. Il nous faudra donc 7 widgets dans Domoticz.

Respectez les types de widget demandés ci dessous, car le script python s’attend à trouver tel type pour la batterie, tel autre pour la présence et ne saura pas écrire dans le widget si vous ne l’avez pas créé avec le bon type.

Nous créerons les widgets en tant que « capteur virtuel » : mode opératoire ici https://easydomoticz.com/detection-de-presence-basee-sur-ip#virtual_dev/

Alors c’est parti :

  • Temperature : ici ça coule de source vous créerez un capteur virtuel temperature.
  • Battery : capteur compteur de type counter. Il existe bien un type de capteur « Voltage » dans Domoticz mais l’API n’est pas documentée pour son utilisation JSON.
  • Alert : capteur compteur de type counter.
  • Presence : Nous utilisons ici un simple interrupteur pour indiquer On : présence ou Off: absence du cookie. Le troisième état (Not Linked : en vue de Mother mais pas lié à elle !) n’est pas géré. Knox, heureux possesseur d’une Mother nous communique un pack d’icônes prêt à l’emploi destiné à illustrer l’état du switch de Présence du cookie, utilisez ce lien (https://easydomoticz.com/scripts/Cookies.zip) pour télécharger le pack complet.
  • Motion :  Cet événement nous donne 3 valeurs : « numberMovements » , « durationSeconds » , « avgIntensity » que nous afficherons au travers de compteurs « counter »

Les compteurs sont tous des « counter »

counter

Ce type « Counter » ne peut être changé que depuis de menu des « Mesures »

Lorsque vous allez ajouter vos capteurs virtuels depuis le menu des « Dispositifs » par la flèche verte et que le nom vous est demandé pensez à nommer correctement le widget car vous serez amené à avoir le même paramètre pour plusieurs cookies.

Si j’ajoute la batterie pour le cookie nommé « Golden eye » je nomme mon widget « Golden_batt », la température « Golden_temp, « Golden_number », « Golden_seconds », « Golden_intesite », pour les 3 paramètres de motion (c.f. ci-dessus)

Les widgets du cookie « Smooth avocado » seront « Smooth_batt », « Smooth_temp » et vous avez compris.

Depuis le menu des dispositifs Domoticz, notez les idx que vous voulez gérer.

idx_domoticz

 

Je vous laisse digérer tout cela et on se prépare pour la prochaine étape du script python.

De la lecture technique concernant l’API ici https://sen.se/developers/documentation/ et aussi ici  https://sen.se/developers/browse/

Merci à Knox du forum pour sa demande initiale, sa participation aux tests et sa relecture attentive.

Bonus : Knox nous remet un pack d’icônes

COOKYELLOW48_Off COOKYELLOW48_On COOKBLUE48_On COOKGREEN48_On COOKORANGE48_On

prêt à l’emploi destiné à illustrer l’état du switch de Présence du cookie, utilisez ce lien (https://easydomoticz.com/scripts/Cookies.zip) pour télécharger le pack complet et celui ci (https://easydomoticz.com/un-outil-pour-ajouter-nos-icones-domoticz-custom-icons/#icones_envoi) pour un mode d’emploi sur l’ajout de set d’icônes (Réglages/Plus d’options/Icônes Personnalisées)

L’article suivant se trouve ici https://easydomoticz.com/mother-cookies-sen-se-integration-dans-domoticz-2eme-partie/

Pour toute question technique concernant cet article, veuillez utiliser les forum situés à https://easydomoticz.com/forum/