Poulpy – Domotique, OpenSource et Geekeries

Et non je n’était pas mort Juste très occupé

M’intéressant de plus en plus à Domogik (si vous ne connaissez pas allez jeter un oeil : c’est un work in progress mais TRES prometteur), et, celui-ci étant écrit en language python, je me suis penché sur le sujet de la programmation du TellStick en Python.

J’avais déjà fait module xpl pour le TellStick mais celui-ci est très basique et ne supporte pas toutes les possibilités de ce petit transmetteur RF bien pratique, donc je me suis lancé, mais cette fois en python.

Voici donc la première partie du travail : une classe Python qui permet de contrôler le TellStick. Celle-ci s’appuie sur la librairie telldus-core fournie par Telldus, il faut donc l’avoir installée au préalable.

Cous trouverez la classe python dans la section téléchargements de ce blog, ou plus précisément ici.

Pour l’installer, c’est du python classique :

$ tar zxfv TellStick-0.1.tar.gz
$ cd TellStick-0.1
$ sudo python setup.py install

L’utilisation est expliquée dans le fichier lui-même, et voici un exemple d’utilisation en Python :

#!/usr/bin/python

from TellStick import *

# Création de l'objet
ts = TellStick()

# Anciens modules Chacon : allumer le module A4
ts.sendOff("arctech", "codeswitch", "A", "4")

# Nouveaux modules Chacon : eteindre le module 0x12345 / 2
ts.sendOn("arctech", "selflearning-switch", "0x12345", "2")

# Prise commandable 1er prix Castorama : Allumer la A1
ts.sendOff("risingsun", "", "1", "1")

Et voala, c’est pas plus compliqué que ça. Vous trouverez des infos sur les protocoles et devices supportés sur cette page chez Telldus.

Prochaine étape : le plugin xPL complet pour TellStick…

Vous connaissez peut-être le TellSTick, petit dongle USB, assez récemment arrivé en France, et qui permet de commander un certain nombre d’appareils de domotique, comme par exemple les modules Chacon dont j’ai parlé dans un autre billet sur ce blog.

Telldus Technologies, le constructeur du TellStick, a le (très) bon goût de mettre à disposition les logiciels (et leurs sources) permettant d’utiliser leur Tellstick sous linux : il s’agit de la commande rfcmd.

« Ben c’est parfait alors ! » me direz-vous; et bien… presque, il ne manquait plus que le logiciel gateway xPL pour intégrer tout ça dans un réseau domotique xPL en place. Et bien voilà qui est chose faite après quelques lignes perl en cette journée pluvieuse.

Pour le télécharger, ça se passe ici

Ca s’installe à la mode perl, comme d’habitude pour mes modules :

perl Makefile.PL
make
sudo make install

Et ça permet d’envoyer des commandes aux modules HomeEasy/Chacon :

xpl-sender -m xpl-cmnd -c homeeasy.nexa house=A unit=1 command=on

Ca permet aussi de commander les modules utilisant le protocole ‘RisingSun’ comme les modules de type GAO, ou encore les prises telecommandées on/off premier prix de chez casto (merci à Boris pour ce bon plan permettant d’avoir des prises commandables pour 20€ les 3) :

xpl-sender -m xpl-cmnd -c risingsu.basic code=1 device=1 command=on
xpl-sender -m xpl-cmnd -c risingsu.basic code=1 device=1 command=off

1. Intro

Les personnes possédant une interface X10 USB Marmitek CM15A (aussi appellée CM15Pro) et désirant intégrer celle-ci dans leur réseau xPL tout en restant sous Linux ont eu probablement le même problème que moi : il n’y a rien qui existe pour le faire.
Plus généralement, les logiciels disponibles pour cette interface USB sont très peu nombreux sous linux. Cela est principalement dû au manque de documentation technique sur cette interface : En effet, bien que plus évoluée que le archi-connu CM11, le CM15 est aussi conçu très différemment : plus de port série (même émulé sur de l’USB), protocole de communication différent, intégration des commandes X10 sans fil RF…
Grâce au travail de la communauté, plusieurs « proof of concept » ont été réalisés pour faire fonctionner cette interface sous Linux :

• Petite application en ligne de commande permettant d’actionner des modules et de recevoir les commandes X10 – http://www.eclipsehomeauto.com/cm15a_on_linux/cm15a.shtml
• Module CM15A pour le célèbre MisterHouse. Mais celui-ci ne permet que de faire de l’émission de commandes (pas de réception) – http://misterhouse.wikispaces.com/X10-CM15A
• Le driver adapté par Neil Cherry permettant de ‘voir’ le device CM15A sous linux et de communiquer avec l’interface – http://www.linuxha.com/USB/cm15a.html

Beaucoup de travail a déjà été fait, et permet la communication ’simple’ avec le CM15A (il reste encore toute une partie des specs de l’interface qui reste inconnue, mais l’envoi/réception des commandes les plus utilisées est tout à fait faisable).

En voyant cela, et utilisant uniquement un CM15A pour l’interfacage X10 (je n’ai plus de CM11) je me suis dit que ça serait pas mal de développer un module pour faire gateway entre le CM15 et mon réseau xPL. Voila qui est chose faite

Pour le téléchargement direct, allez voir dans la section des downloads. Pour les explications, lisez la suite

2. Pré-requis

Je ne détaillerai pas ici, mais vous devez également avoir le perl qui fonctionne correctement avec les modules qui vont bien, ainsi qu’une installation fonctionnelle des librairies xPL-Perl (http://www.xpl-perl.org.uk).
Comme toute machine faisant partie d’un réseau xPL, vous devez avoir au moins un HUB qui tourne dessus (perso j’utilise celui fournit avec les librairies xPL Perl).

Un autre pré-requis important est le driver CM15 dont l’installation est détaillée ci-dessous.

3. Installation du driver pour le CM15

Pour faire fonctionner l’application, il vous faudra d’abord installer le driver iplc de Neil Cherry :

apt-get install linux-headers-generic
wget http://www.linuxha.com/common/iplcd/iplc-driver.tgz
tar zxf iplc-driver.tgz
cd iplc/driver/linux-2.6/
# Pour les kernels les plus récents faire, executer :
sed -i s/\\Winfo\\W*\(/\ pr_info\(/ *.c
cd cm15a.d
make

Vous devriez maintenant avoir un joli driver sous la forme du fichier cm15a.ko que vous pouvez copier où bon vous semblera et que vous allez maintenant charger dans votre noyau :

$ insmod /path/to/cm15a.ko
$ dmesg | tail
[274611.018498] cm15a USB #252 now attached to major 180 minor 252
[274611.018536] usbcore: registered new interface driver cm15a
[274611.018544] X10 CM15A USB Driver v0.03

Vérifiez enfin que le device a bien été créé :

$ ls -la /dev/cm15a0
crw-rw---- 1 root root 180, 252 2010-02-14 19:59 /dev/cm15a0

Le driver marche, vous êtes maintenant parés à installer mon module xPL CM15

4. Installation du module xpl

Pour le téléchargement, ça se passe ici : Download

Téléchargez et décompressez le tarball et procédez à l’installation classique « à la perl ». Attention, il faut que le module soit installé dans le même PREFIX que les librairies xpl-perl. Par exemple :

• Si xPL-perl est installé dans /usr/share/perl5/xPL/, alors votre prefix est « /usr »
• Si par contre c’est installé dans /usr/local/share/perl5/xPL, alors le prefix est « /usr/local »

$ wget ......../xpl-cm15a-0.2.tar.gz
$ tar zxf xpl-cm15a-0.2.tar.gz
$ cd xpl-cm15a-0.2
$ perl Makefile.PL PREFIX=/usr   # Mettre le bon PREFIX voir ci-dessus
# Vérifier qu'il n'y a pas de warning de dépendances
$ make
$ sudo make install

Si tout est OK, l’installation aura entre autres créé le script /usr/bin/xpl-cm15a

5. Lancement de l’application

Tout est indiqué dans la page de man qui aura été installée avec le programme à l’étape précédente. Voici la syntaxe générale :

$ xpl-cm15a --help
Usage:
xpl-cm15a [flags] [options]
where valid flags are:
--help                - show this help text
--verbose             - verbose mode (for the xPL layer)
--cm15a-verbose       - verbose mode (for the cm15a layer)
--cm15a-ignore-rf     - ignore x10 RF messages from the cm15a
--cm15a-ignore-plc    - ignore x10 PowerLine messages from the cm15a
and valid options are (default shown in brackets):
--interface if0            - the interface for xPL messages (first
non-loopback or loopback)
--cm15a-device /dev/xxx    - device for the cm15a (/dev/cm15a0)

Il est obligatoire de spécifier le paramètre ‘cm15a-device’ en précisant le device de votre cm15 (/dev/cm15a0 par défaut).

Il vous est également possible de demander à la gateway d’ignorer les messages X10 RF et/ou les messages X10 courant porteur. Cela concerne uniquement les évennements qui ARRIVENT jusqu’au CM15, et cela évite que l’application ne génère des notifications sur votre réseau xPL si jamais vous n’en voulez pas.
Pour donner un exemple concret : J’ai un CM15 (qui capte les ordres X10 RF sans fil) et j’ai un RFXCOM qui capte lui aussi les ordres X10 RF. Donc, par défaut, quand j’actionne une commande X10 RF (telecommande ou détecteur par exemple), cela va me génèrer DEUX messages sur mon réseau xPL : un envoyé par la gateway RFXCom et l’autre par la gateway CM15 => Dans ce cas là j’ai spécifié l’option « –cm15a-ignore-rf » pour que la gateway CM15 ne me renvoie pas les messages X10 RF.

Exemple de lancement (attention il faut le lancer en root, ou bien avec des droits suffisants pour lire/écrire dans /dev/cm15a0):

$ /usr/bin/xpl-cm15a --cm15a-ignore-rf --cm15a-verbose --cm15a-device /dev/cm15a0

6. Réception / Emission d’ordres X10

Pour émettre un ordre X10, il suffit alors d’envoyer le message correspondant sur votre réseau xPL. Par exemple pour allumer le module A3 :

$ /usr/bin/xpl-sender -m xpl-cmnd -c x10.basic device=a3 command=on

La gateway devrait alors envoyer l’ordre sur courant porteur et votre module devrait s’activer.

Pour vérifier le fonctionnement en réception, vous pouvez par exemple lancer le logger xPL et actionner une commande X10 (par exemple sur un télécommande, ou bien passer devant un détecteur de mouvement…etc..). Vous verrez alors que la gateway xpl-cm15a enverra le message correspondant sur votre réseau xPL :

$ /usr/bin/xpl-logger
192.168.X.X:YYYY [xpl-trig/x10.basic: tlam-CM15A.zzzzzz -> * - off a2]

7. Limitations

Certaines choses ne fonctionnent PAS, notamment :

• Les fonctions compliquées de X10 comme les extended functions
• L’émission d’ordres X10 RF (par manque de documentation du CM15A, seule la réception marche pour le RF)

D’autres n’ont pas pu être testées :

• Les modules X10 bi-directionnels
• Le X10 security

Et voilou, j’espere que ça dépannera les galériens du CM15 sous linux comme moi N’hésitez pas à me remonter les problèmes d’utilisation ou remarques sur ce module xpl-cm15a.

Toujours soucieux d’allier l’inutile à l’agréable, et dans le cadre de mes experimentations du protocole xPL, j’ai développé un petit module passerelle entre xPL et Jabber.

Grâce à cet module complètement indispensable, on peut « discutter » avec sa maison, pour peu qu’elle ait un peu de conversation.
Le module en lui même ne fait que :

• Se logger sur un service Jabber (Google Talk par exemple)
• Diffuser sur le réseau xPL les messages qu’il reçoit
• Permettre d’envoyer des messages à des contacts Jabber via une commande xPL

Pour ceux qui veulent tester sans lire la suite, vous trouverez le module sur la page de téléchargements

Voyons comment installer tout ça.

1. Pré-requis :

• Un PC (ouaou super) sous Linux (C’est du perl donc ça marche probablement sur Mac aussi mais je n’ai jamais essayé).
• Un réseau xPL en place (i.e. les applications essentielles déjà installées, notamment le Hub XPL)
• Un compte jabber (gtalk par exemple) créé spécialement pour votre système domotique et vous ayant dans sa liste de contacts
• Les librairies xPL-Perl installées (http://www.xpl-perl.org.uk)
• Certains modules perl utilisés

Pour ceux sous ubuntu/debian il faut notamment installer les packages suivants :

$ sudo apt-get install libconfig-general-perl libnet-jabber-perl

2. Installation

Télécharger mon petit module en cliquant là : Download.

Décompressez le tarball et procedez à l’installation classique « à la perl ». Attention, il faut que le module soit installé dans le même PREFIX que les librairies xpl-perl. Par exemple :

• Si xPL-perl est installé dans /usr/share/perl5/xPL/, alors votre prefix est « /usr »
• Si par contre c’est installé dans /usr/local/share/perl5/xPL, alors le prefix est « /usr/local »

$ tar zxf xpl-jabber-*.tar.gz
$ cd xpl-jabber-*
$ perl Makefile.PL PREFIX=/usr   # Mettre le bon PREFIX voir ci-dessus
# Vérifier qu'il n'y a pas de warning de dépendances
$ make
$ sudo make install

Si tout se passe bien, le programme s’installe là : /usr/bin/xpl-jabber

3. Configuration

Avant de lancer le soft, il faut définir le compte jabber à utiliser. Pour cela vous pouvez partir du fichier de configuration fourni en exemple et le mettre au bon endroit.

$ sudo mkdir -p /etc/xplperl
$ sudo cp conf/jabber.conf.example /etc/xplperl/jabber.conf

Editez le fichier pour y mettre vos propres infos. Si il s’agit d’un compte google talk, vous n’avez que les paramètres ‘username’ et ‘password’ à changer. Le fichier devrait ressembler à ça :

$ cat /etc/xplperl/jabber.conf
#
# xPL Jabber Gateway config file
#
username = my_gtalk_username
domain = gmail.com
password = my_gtalk_password
server = talk.google.com
port = 5222
tls = 1

4. Lancement

Normalement vous êtes pret à lancer xpl-jabber. Préparez quand même :
- Votre client jabber connecté avec votre compte à vous (histoire de voir quand votre maison se connectera )
- Un logger de messages xPL (xpl-logger du package xpl-perl sera parfait) pour vérifier le bon fonctionnement du tout

$ xpl-logger -v

Attendez quelques secondes, et vous devriez voir le compte que vous avez configuré se connecter sur votre messagerie jabber => victoire !

Envoyez lui le message « help », il devrait vous répondre un message générique.

5. Réception de messages

A chaque fois que vous envoyez un message sur jabber à votre maison, un message xPL sera envoyé sur votre réseau xPL. Par exemple en envoyant le message « home sweet home » sur jabber, on verra passer le message sur le réseau xPL grâce au logger :

$ xpl-logger
[xpl-trig/sendmsg.im: tlam-jabber.home -> * - votre_compte@gmail.com => votre_maison@gmail.com : home sweet home]

Libre à vous ensuite d’utiliser ce message et de déclencher, à sa réception, des actions dans votre habitat.

6. Envoi de messages

Pour que votre maison envoie des messages Jabber, il vaut envoyer un message xPL au bon format. Par exemple, si on veut envoyer le message « rentre vite ! » à l’utilisateur Gtalk mon.compte@gmail.com :

$ xpl-sender -m xpl-cmnd -c sendmsg.im to=mon.compte@gmail.com \
   body='rentre vite !'

Là aussi, libre à vous d’envoyer des messages Jabber en fonction des évennements sur votre réseau domotique. Par exemple lorsqu’un détecteur de mouvement capte quelque chose, lorsque la température descend en dessous d’une certaine limite, etc…

7. Pour aller plus loin

Comme vous l’avez probablement compris, le module xpl-jabber n’est qu’une application « gateway » : elle n’embarque aucune intelligence de contrôle domotique : c’est en utilisant une application de controle (xPLHAL par exemple) que vous pourrez faire inter-agir tous vos éléments xPL avec xpl-jabber.

Enfin quand même un petit avertissement : faites attention à la façon d’intégrer l’Instant Messaging à votre installation : la securité d’une commande par instant messaging n’est clairement pas optimale, c’est le moins qu’on puisse dire.

N’hésitez pas à poster vos commentaires/retours ici même, j’y répondrai avec plaisir !