Rework for eedomus plugin norm

Author: Nikya

README.md

@@ -1,8 +1,11 @@
 # eedomus script : wind direction
 
-Version : 1.0
+![compass](eedomus_plugin\img\windrose-compass.png "Rose des vents")
 
-Auteur : Nikya
+* Version : 2.0
+* Origine : [GitHub/Nikya/windDirection][be61b901]
+
+  [be61b901]: https://github.com/Nikya/eedomusScript_windDirection "Origine sur GitHub"
 
 
 ## Description
@@ -16,11 +19,15 @@ Le bon fonctionnement de ce script dépend d'une installation correte de la giro
 
 ![rosevents](rosevents.gif "Rose des vents")
 
-## Installation
+## Installation via store
+
+Depuis le portail eedomus, cliquez sur `Configuration / Ajouter ou supprimer un périphérique / Store eedomus` puis selectioner _windDirection_.
+
+## Installation manuel
 1. Télécharger le projet sur GitHub : [github.com/Nikya/eedomusScript_windDirection](https://github.com/Nikya/eedomusScript_windDirection/archive/master.zip)
-1. Uploader le fichier *wind_direction.php* sur la box ([Doc eedomus scripts](http://doc.eedomus.com/view/Scripts#Script_HTTP_sur_la_box_eedomus))
+1. Uploader le fichier *src/wind_direction.php* sur la box ([Doc eedomus scripts](http://doc.eedomus.com/view/Scripts#Script_HTTP_sur_la_box_eedomus))
 
-## Tester
+### Tester
 Ce script peut ensuite être testé au travers du lien suivant dans le navigateur
 
 	http://[ip_de_votre_box]/script/?exec=wind_direction.php&periph=[code_api_perif]
@@ -33,7 +40,7 @@ Exemple
 
 	http://192.168.1.2/script/?exec=wind_direction.php&periph=999999
 
-## Résultat
+### Résultat
 Le résultat est au format XML.
 
 Exemple de résultat
@@ -53,7 +60,7 @@ Exemple de résultat
 </data>
 ```
 
-## Correspondance XPATH
+### Correspondance XPATH
 
 Les différentes informations possibles retournées par les Xpath suivants :
 
@@ -73,8 +80,9 @@ Renseigner les paramètres suivants :
 
 - Type de données : ```Texte```
 - URL de la requête : ```http://[VAR1]/script/?exec=wind_direction.php&periph=[VAR2]```
-- Chemin XPATH : ```/data/fr/long```
+- Chemin XPATH : ```/data/[VAR3]```
 - Fréquence de la requête : ```5```
 - Variables utilisateur :
 	- [VAR1] : ```Localhost```
 	- [VAR2] : ```999999``` Le code API du périphérique
+	- [VAR3] : ```xx/yyyyy``` Langue et longueur d'affichage `fr` ou `en` et `short` ou `long`

asset/windrose-compass.svg

@@ -0,0 +1,57 @@
+{
+    "plugin_id": "wind_direction",
+    "name_fr": "Wind direction",
+    "icon": "windrose-compass.png",
+    "version": "2.0",
+    "creation_date": "2015-11-20",
+    "modification_date": "2017-10-08",
+    "author": "<a href=\"https://github.com/Nikya\">Nikya</a>",
+    "description_fr": "Convertir une direction de vent en degré, vers son équivalent en point cardinal.",
+    "description_en": "convert a wind direction in degrees, to its cardinal point equivalent.",
+    "forum_link": "http://forum.eedomus.com/viewtopic.php?f=50&t=3330",
+    "parameters": [
+        {
+            "parameter": "help_url",
+            "description": "Documentation technique ou pour signaler un beugue",
+            "xtype": "displayfield",
+            "field": "style: 'padding: 3px;', value: 'https://github.com/Nikya/eedomusScript_windDirection'"
+        },
+        {
+            "parameter": "configPerifCode",
+            "description": "Renseigner le code API de l'anémomètre",
+            "xtype": "numberfield",
+            "field": "allowBlank: false, allowDecimals:false, width: 100"
+        },
+        {
+            "parameter": "configDisplay",
+            "description": "<b>Options d'affichages</b> Choisir une langue et une longueur d'affichage parmis : <code>fr/short</code> ou <code>fr/long</code> ou <code>en/short</code> ou <code>en/long</code>",
+            "xtype": "textfield",
+            "field": "allowBlank: false, allowDecimals:false, width: 10"
+        }
+    ],
+    "scripts": [
+        {
+            "name": "wind_direction.php"
+        }
+    ],
+    "devices": [
+        {
+            "device_id": "wind_direction",
+            "module_id": "51",
+            "type": "http",
+            "name_fr": "Wind direction",
+            "icon": "windrose-compass.png",
+            "utilisation_id": "35",
+            "parameters": {
+                "value_type": "list",
+                "ignore_errors": 3,
+                "VAR1": "localhost",
+                "VAR2": "plugin.parameters.configPerifCode",
+                "VAR3": "plugin.parameters.configDisplay",
+                "RAW_URL": "http://[VAR1]/script/?exec=wind_direction.php&periph=[VAR2]",
+                "RAW_XPATH": "/data/[VAR3]",
+                "POLLING": "5"
+            }
+        }
+    ]
+}

src/eedomus_plugin.json

@@ -4,13 +4,13 @@
 * Un script pour la box domotique eedomus pour convertir la direction du vent
 ********************************************************************************
 * Version :
-*	1.0
+*	2.0
 *
 * Auteur :
 *	Nikya
 *	https://github.com/Nikya/
 *
-* Documentation complète :
+* Documentation complète et aide :
 * 	https://github.com/Nikya/eedomusScript_windDirection
 *
 * Param :
@@ -25,7 +25,8 @@
 //require_once ("../eedomusScriptsEmulator.php");
 
 ////////////////////////////////////////////////////////////////////////////////
-// Definition des points cardianux
+// Definition des 16x2 points cardinaux
+// En version courte/longue Français/Anglais
 $cardinalArray = array(
 	'fr' => array(
 		'short' => array(
@@ -174,13 +175,13 @@
 $periphId = getArg('periph', true);
 
 ////////////////////////////////////////////////////////////////////////////////
-// Lecture de la valeur
+// Lecture de la valeur en ° du capteur
 $aVal = getValue($periphId);
 $value = $aVal['value'];
 $change = $aVal['change'];
 
 ////////////////////////////////////////////////////////////////////////////////
-// Recherche de la division
+// Recherche de la division correspondante
 $step = 360/32;
 $divId = 0;
 
@@ -191,18 +192,19 @@
 }
 
 ////////////////////////////////////////////////////////////////////////////////
-// Conversion de la division en point cardinaux
+// Recherche du point cardinal correspondant à la division trouvée
+// dans un tableau de type [langue][longeur][val_precision_0][val_precision_1][val_precision_2]
 $cardinal_fr_s = $cardinalArray['fr']['short'][$divId][0].$cardinalArray['fr']['short'][$divId][1].$cardinalArray['fr']['short'][$divId][2];
 $cardinal_fr_l = $cardinalArray['fr']['long'][$divId][0].$cardinalArray['fr']['long'][$divId][1].$cardinalArray['fr']['long'][$divId][2];
 $cardinal_en_s = $cardinalArray['en']['short'][$divId][0].$cardinalArray['en']['short'][$divId][1].$cardinalArray['en']['short'][$divId][2];
 $cardinal_en_l = $cardinalArray['en']['long'][$divId][0].$cardinalArray['en']['long'][$divId][1].$cardinalArray['en']['long'][$divId][2];
 
 ////////////////////////////////////////////////////////////////////////////////
-// Renvoie du resultat en XML
+// Formatage et renvoie du resultat en XML
 $content_type = 'text/xml';
 sdk_header($content_type);
 
-echo <<<EOD
+echo <<<OUT_XML
 	<data>
 		<change>$change</change>
 		<degree>$value</degree>
@@ -216,5 +218,5 @@
 			<long>$cardinal_en_l</long>
 		</en>
 	</data>
-EOD;
+OUT_XML;
 ?>