{"id":1019,"date":"2011-10-31T22:24:49","date_gmt":"2011-10-31T21:24:49","guid":{"rendered":"http:\/\/blog.guiguiabloc.fr\/?p=1019"},"modified":"2011-11-14T10:24:13","modified_gmt":"2011-11-14T09:24:13","slug":"xpl-et-nut-recuperer-les-donnees-de-votre-onduleur","status":"publish","type":"post","link":"http:\/\/blog.guiguiabloc.fr\/index.php\/2011\/10\/31\/xpl-et-nut-recuperer-les-donnees-de-votre-onduleur\/","title":{"rendered":"xPL et NUT, r\u00e9cup\u00e9rer les donn\u00e9es de votre onduleur"},"content":{"rendered":"

\"\"<\/a><\/p>\n

Comme la majorit\u00e9 des passionn\u00e9s qui touche \u00e0 la domotique, j’utilise le protocole xPL<\/a> pour centraliser les informations de mes \u00e9quipements.<\/p>\n

Si vous ne connaissez pas encore le principe, je vous invite \u00e0 lire les excellents billets de Thibault<\/a> et Mickael<\/a> \u00e0 ce sujet :<\/p>\n

http:\/\/www.poulpy.com\/2010\/02\/xpl-one-protocol-to-rule-them-all\/<\/a><\/p>\n

http:\/\/www.planete-domotique.com\/blog\/2011\/05\/18\/le-protocole-xpl\/<\/a><\/p>\n

Et bien s\u00fbr, le site du projet lui-m\u00eame :<\/p>\n

http:\/\/xplproject.org.uk\/wiki\/index.php?title=Main_Page<\/a><\/p>\n

C’est un protocole fiable, performant et act\u00e9 par les plus fervents agitateurs de la domotique (par exemple Domogik<\/a>, un des projets fran\u00e7ais les plus prometteurs actuellement dans la mise \u00e0 disposition d’une solution \u00ab\u00a0tout-en-un\u00a0\u00bb (et libre surtout !) ou RFXCOM<\/a>, un des leaders des \u00e9quipements domotique RF qui int\u00e8gre d\u00e9sormais nativement le xPL dans ses produits).<\/p>\n

Moi, comme beaucoup de mes confr\u00e8res passionn\u00e9s, je suis absolument convaincu du fait qu’il faille d\u00e9finir un protocole standard pour l’interaction des \u00e9quipements de domotique, bien \u00e9videmment, ouvert, et bien \u00e9videmment, xPL r\u00e9pond \u00e0 cette attente.<\/p>\n

Jusqu’a maintenant, j’utilisais beaucoup les scripts de la communaut\u00e9, et surtout ceux de l’excellentissime Mark Hindess connu sous le pseudo de beanz et auteur du framework xpl-perl.<\/a><\/p>\n

Et puis vient le moment o\u00f9 l’on a un besoin pr\u00e9cis qui n’existe pas…<\/p>\n

En l’occurence, je voulais r\u00e9cuperer les donn\u00e9es et l’\u00e9tat de mon onduleur et bien s\u00fbr en xPL.<\/p>\n

Je fais le tour des solutions et il existe xpl-apcups du m\u00eame Mark pr\u00e9-cit\u00e9 mais, mince, fl\u00fbte, sacrebleu, il ne fonctionne qu’avec apcupsd<\/a>.<\/p>\n

Bon, tant pis, je me dis que je vais revoir le code pour le faire fonctionner et l\u00e0, forc\u00e9ment, je s\u00e8che comme une blonde d\u00e9color\u00e9e aux attributs silicon\u00e9s\u00a0 sur une plage m\u00e9diterran\u00e9enne en plein mois d’ao\u00fbt.<\/p>\n

Parce que bon, Perl et moi… Comment dire… Autant expliquer le principe du cum-swapping \u00e0 une none ayant fait voeu d’isolement… (avouez que vouliez un lien !!!!)<\/p>\n

Donc je me dis que je vais tenter de l’\u00e9crire moi-m\u00eame mon client, ayant aborder Python du coin de l’oeil je regarde ce qu’il existe et je trouve un petit exemple de John Bent sur le site du projet xPL<\/a>.<\/p>\n

Quelques litres de caf\u00e9 plus tard (s\/caf\u00e9\/bi\u00e8re\/), je vous propose donc xpl-nut<\/strong>.<\/p>\n

Vous pouvez bien s\u00fbr le t\u00e9l\u00e9charger ICI<\/a>
\nOu sur le projet GoogleCode :
\nhttp:\/\/code.google.com\/p\/guiguiabloc\/<\/a><\/p>\n

J’ai essay\u00e9 de suivre les recommandations du projet xPL.<\/p>\n

Les sch\u00e9mas utilis\u00e9s sont UPS.BASIC<\/a> et SENSOR.BASIC<\/a><\/p>\n

Concernant les recommandations TRIGGER<\/a>, il est demand\u00e9 de n’\u00e9mettre une trame que lors d’un changement d’\u00e9tat mais personnellement, j’ai pass\u00e9 outre, pr\u00e9f\u00e9rant avoir une remont\u00e9e constante des informations.<\/p>\n

EDIT :<\/strong> Suite aux discussions avec l’\u00e9quipe Domogik, j’ai revu mon code pour \u00eatre \u00ab\u00a0aux normes\u00a0\u00bb et donc le format de message est donc de type STAT d\u00e9sormais et TRIG en cas de changement d’\u00e9tat (version 1.1 du script)<\/p>\n

Comme donner un script python comme \u00e7a ne sert pas \u00e0 progresser, et comme j’ai pris du plaisir \u00e0 l’\u00e9crire (et oui :p), je vous propose d’en voir les parties int\u00e9ressantes, au cas, o\u00f9, comme moi, vous d\u00e9cidez d’\u00e9crire vos propres clients xPL<\/p>\n

\r\n#############\r\n# variables\r\n#############\r\nupsaddr='127.0.0.1'\r\nupsport=3493\r\npolltime=10\r\nnomups = 'mononduleur'\r\n\r\nxpladdr = (\"255.255.255.255\",3865)\r\nUDPSock = socket.socket(socket.AF_INET,socket.SOCK_DGRAM)\r\nUDPSock.setsockopt(socket.SOL_SOCKET,socket.SO_BROADCAST,1)\r\n<\/pre>\n
Ici rien de compliqu\u00e9, on d\u00e9finit les variables essentielles, a savoir :
\n– upsaddr : l’adresse IP du d\u00e9mon NUT
\n– upsport :  le port du d\u00e9mon NUT
\n– polltime : la fr\u00e9quence d’interrogationdu d\u00e9mon NUT en secondes
\n– nomups : le nom de votre onduleur, tel que d\u00e9finit dans votre \/etc\/ups.conf
\n– xpladdr :  l’adresse et le port de broadcast pour les messages<\/p>\n
Le code suivant est la pr\u00e9paration de l’ouverture d’un socket UDP.<\/p>\n
\r\netatonduleur = \"get var \"+nomups+\" ups.status\\r\\n\"\r\nvoltage= \"get var \"+nomups+\" input.voltage\\r\\n\"\r\nbatterycharge= \"get var \"+nomups+\" battery.charge\\r\\n\"\r\n<\/pre>\n
Ici on d\u00e9finit les requ\u00e8tes que nous allons passer au d\u00e9mon NUT.
\nSi vous faites un \u00ab\u00a0telnet ip_du_nut_demon 3493\u00a0\u00bb par defaut, vous avez acc\u00e8s a une console qui vous permet d’interroger le d\u00e9mon NUT.
\nHELP donne l’aide (nan ????)
\nGET VAR nomdelonduleur input.voltage donne le voltage en entr\u00e9e
\netc…
\nPour avoir la liste des variables, il vous suffit de taper : upsc nomonduleur.<\/p>\n
Voici par exemple ce que cela retourne chez moi :<\/p>\n
\r\nsrv-guiguiabloc:\/etc\/nut# upsc mgeups\r\nbattery.charge: 100.0\r\nbattery.charge.low: 30\r\nbattery.runtime: 02655\r\nbattery.voltage: 055.2\r\nbattery.voltage.nominal: 048.0\r\ndevice.mfr: MGE UPS SYSTEMS\r\ndevice.model: Pulsar ESV22+\r\ndevice.type: ups\r\ndriver.name: mge-utalk\r\ndriver.parameter.pollinterval: 2\r\ndriver.parameter.port: \/dev\/ttyS0\r\ndriver.version: 2.4.3\r\ndriver.version.internal: 0.89\r\ninput.frequency: 50.00\r\ninput.transfer.boost.high: 212.0\r\ninput.transfer.boost.low: 204.0\r\ninput.transfer.high: 248.0\r\ninput.transfer.low: 204.0\r\ninput.transfer.trim.high: 248.0\r\ninput.transfer.trim.low: 240.0\r\ninput.voltage: 227.0\r\noutput.current: 002.9\r\noutput.voltage: 224.1\r\nups.delay.shutdown: 020\r\nups.delay.start: 001\r\nups.firmware: 2\r\nups.id: Pulsar ESV22+ 2\r\nups.load: 027.0\r\nups.mfr: MGE UPS SYSTEMS\r\nups.model: Pulsar ESV22+\r\nups.status: OL\r\nups.test.interval: 10080\r\n<\/pre>\n
A vous de forger les requ\u00e8tes en cons\u00e9quence \ud83d\ude09<\/p>\n
\r\ns.send(etatonduleur)\r\n    data = s.recv(50)\r\n    resultat = data.split()\r\n    statusbatt = resultat.pop()\r\n    statusbatt = statusbatt.replace('\"','')\r\n    statusbatt = statusbatt.replace('OL','onmains')\r\n    statusbatt = statusbatt.replace('OB','onbattery')\r\n    statusbatt = statusbatt.replace('LB','lowbattery')\r\n    body = 'status=battery\\nevent='+statusbatt\r\n    msg = \"xpl-trig\\n{\\nhop=1\\nsource=guigui-xplnut.\"+hostname+\"\\ntarget=*\\n}\\nups.basic\\n{\\n\" + body + \"\\n}\\n\"\r\n    UDPSock.sendto(msg,xpladdr)\r\n    print msg\r\n<\/pre>\n
J’envois la requ\u00e8te au d\u00e9mon NUT et je r\u00e9cup\u00e8re le r\u00e9sultat que je traite (salement je l’avoue).
\nJe forge ensuite le message xPL que j’envois dans le r\u00e9seau.<\/p>\n
Le reste du code est assez basique et vous devriez en comprendre le fonctionnement avec ses quelques explications.
\nsoyez indulgent, je suppose que mon code n’est pas tr\u00e8s propre et si vous \u00eates un pro du python, je suis ouvert \u00e0 vos recommandations ! \ud83d\ude00<\/p>\n
En tout cas, cela marche tr\u00e8s bien et pour un premier script xPL j’en suis plut\u00f4t fier \ud83d\ude42<\/p>\n
Une fois lanc\u00e9, vous devriez voir les remont\u00e9es dans votre bus xPL:<\/p>\n
\r\n[xpl-trig\/ups.basic: guigui-xplnut.Thanatos -> * - battery onmains]\r\n[xpl-trig\/sensor.basic: guigui-xplnut.Thanatos -> * - mgeups[voltage]=225.7]\r\n[xpl-trig\/sensor.basic: guigui-xplnut.Thanatos -> * - mgeups[battery]=100.0]\r\n<\/pre>\n
En esp\u00e9rant que cela vous serve,<\/p>\n
Amusez vous bien \ud83d\ude00<\/p>\n","protected":false},"excerpt":{"rendered":"
Comme la majorit\u00e9 des passionn\u00e9s qui touche \u00e0 la domotique, j’utilise le protocole xPL pour centraliser les informations de mes \u00e9quipements. Si vous ne connaissez pas encore le principe, je vous invite \u00e0 lire les excellents billets de Thibault et … Read More →<\/span><\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[137],"tags":[169,170,171,168],"_links":{"self":[{"href":"http:\/\/blog.guiguiabloc.fr\/index.php\/wp-json\/wp\/v2\/posts\/1019"}],"collection":[{"href":"http:\/\/blog.guiguiabloc.fr\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/blog.guiguiabloc.fr\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/blog.guiguiabloc.fr\/index.php\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"http:\/\/blog.guiguiabloc.fr\/index.php\/wp-json\/wp\/v2\/comments?post=1019"}],"version-history":[{"count":22,"href":"http:\/\/blog.guiguiabloc.fr\/index.php\/wp-json\/wp\/v2\/posts\/1019\/revisions"}],"predecessor-version":[{"id":1040,"href":"http:\/\/blog.guiguiabloc.fr\/index.php\/wp-json\/wp\/v2\/posts\/1019\/revisions\/1040"}],"wp:attachment":[{"href":"http:\/\/blog.guiguiabloc.fr\/index.php\/wp-json\/wp\/v2\/media?parent=1019"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/blog.guiguiabloc.fr\/index.php\/wp-json\/wp\/v2\/categories?post=1019"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/blog.guiguiabloc.fr\/index.php\/wp-json\/wp\/v2\/tags?post=1019"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}