Vera - 05 - Parlons documentation 1

Mardi, 05 Avril 2016 06:00 GuyT
Imprimer
Note des utilisateurs: / 29
MauvaisTrès bien 

Avec cet article je vous propose de documenter les modules physiques et virtuels que vous avez associés au fil du temps à votre box domotique. Pour vous faciliter la tâche, je vous ai préparé :

  1. un classeur Excel qui vous permettra de calculer le coût global de votre installation ; mais aussi de générer un fichier de déclarations de variables utilisables avec des scripts lua
  2. un script permettant de récupérer les informations déjà renseignées dans la box domotique (afin de vous éviter autant se faire se peut des ressaisies)

Let’s go (c’est parti)

 

Sommaire

 

Présentation du classeur Excel

Comme indiqué, le classeur Excel est conçu de manière à limiter au maximum les ressaisies, il est constitué de 6 onglets :

 

Onglet 1 – Modules

Cet onglet fournit une vue d’ensemble des différents modules constituant votre installation domotique. Vous retrouvez les rubriques suivantes :


- Pièce (renseignée automatiquement) : information sélectionnée dans la box au moment de l’association d’un module / device, l’information est renseignée grâce à une formule qui va rechercher l’information dans l’onglet « Data » (information extraite de la box)
- Marque (renseignée automatiquement) : information renseignée grâce à une formule qui va rechercher l’information dans l’onglet « Types Modules »
- Modèle (choisir une valeur parmi N) : la liste de valeurs est issue de l’onglet « Types Modules »
- Nom déclaré (renseigné automatiquement) : information saisie dans la box au moment de l’association d’un module / device, l’information est renseignée grâce à une formule qui va rechercher l’information dans l’onglet « Data » (information extraite de la box)
- Fonction (renseignée automatiquement) : information renseignée grâce à une formule qui va rechercher l’information dans l’onglet « Types Modules »
- Numéro affecté (à saisir) : le numéro est attribué par la box lors de l’inclusion d’un module, l’information est disponible dans l’onglet « Data » (information extraite de la box)
- Nom de variable (à saisir) : c’est à vous de définir le nom de variable que vous souhaitez.

Dans l’article « Vera – 04 Tableau de bord 2 », je vous ai donné quelques suggestions dans le paragraphe « Recommandation pour le nommage des variables ».

L’utilisation d’une variable pour identifier un module / device est à privilégier plutôt que l’utilisation de son numéro. En effet, le numéro peut changer dans le temps (exemple : remplacement d’un matériel défectueux) ; dans un tel cas, il suffit de modifier la valeur de la variable (numéro du nouvel appareil attribué par la box) ; il ne sera pas nécessaire de rechercher et modifier tous les scripts lua faisant référence à l’appareil concerné.

Attention : Le nom de variable doit être unique et ne doit pas être changé dans le temps.

- Date achat (à saisir) : cela permet de suivre vos garanties
- Durée de la garantie (à saisir) : idem
- Prix d’achat (à saisir) : cela permet de chiffrer le coût de l’installation

Les colonnes en blanc correspondent à celles que vous devez renseigner.

Recommandation : commencez dans un premier temps à donner un nom de variable seulement aux modules qui seront utilisés dans des scripts lua.


Onglet 2 – Data

Les informations de cet onglet sont le résultat d’un script LUA exécuté à partir de la box. Le fichier généré est au format csv, une fois le fichier ouvert sous Excel, il suffit de faire un copier / coller des informations dans cet onglet. Vous retrouvez les rubriques suivantes :


- Device # : c’est le numéro attribué par la box lors de l’inclusion des modules
- AltId # : c’est un identifiant interne à la box utilisé dans certaines situations
- Description : c’est la description que vous avez renseignée dans la box
- IP@ : adresse IP (cette rubrique est utilisée par peu de modules)
- Piece # : c’est le numéro de pièce que la box a attribué lors de la configuration des pièces
- Nom Pièce : c’est le nom de la pièce que vous avez renseigné dans la box
- Categorie # : catégorie, voir onglet « Categories Modules »
- Sous-Categorie # : catégorie, voir onglet « Categories Modules »
- UDN (UPnP) : Universal Plug and Play (pour utilisateur averti)

Recommandation : lors du nommage des modules et/ou des pièces dans la box, n’utilisez pas de lettres accentuées

Attention : Si vous modifiez le nom de modules, les modifications seront prises en compte seulement après le reboot de la box. Menu : Settings / Net & Wi-fi, bouton « Reboot »


Onglet 3 – Types Modules

Cet onglet fournit une vue d’ensemble des différents types des modules utilisés dans votre installation domotique. Vous retrouvez les rubriques suivantes :


- Modèle : saisir la référence du module
- Marque : une valeur parmi N, la liste de valeurs est gérée dans l’onglet « Configuration »
- Photo : c’est plus parlant
- Fonction : description en quelques mots
- Inclusion : que faire en quelques lignes, cela évite de rechercher l’information plus tard
- Reset Usine : que faire en quelques lignes, cela évite de rechercher l’information lorsqu’il faut faire un reset d’un module (lorsqu’on est confronté à la situation, on est toujours content d’avoir pris le temps de documenter cet aspect des choses)

Pour les appareils comportant plusieurs modules fonctionnels et donnant lieu à plusieurs modules inclus dans la box ; personnellement, j’ajoute des lignes supplémentaires avec un suffixe correspondant à chaque type de module, cela permet de disposer d’une définition fonctionnelle plus explicite.

Exemple pour le FGMS-001 de Fibaro, capteur 3 en 1 : luminosité, mouvement et température, j’ai ajouté les lignes suivante : FGMS-001l pour luminosité, FGMS-001m pour mouvement et FGMS-001t pour température

 

Si vous êtes plusieurs à le demander, je peux mettre à disposition l’onglet « Types Modules » au fur à mesure de son enrichissement.

 

Onglet 4 – Catégories Modules

Cet onglet fournit les différentes catégories et sous-catégories des modules gérés par la box Vera. Vous retrouvez les rubriques suivantes :

- Category : numéro de la catégorie
- Device Type : nom de la catégorie
- Sub category : numéro de la sous-catégorie
- Device Type : nom de la sous-catégorie

L’information est disponible à l’adresse suivante : http://wiki.micasaverde.com/index.php/Luup_Device_Categories

 

Onglet 5 – Configuration

Cet onglet comporte assez peu de chose, il ne tient qu’à vous de l’enrichir si besoin était. Il comporte la liste de valeurs des marques ; cela évite les coquilles lors de la saisie des informations.

 

Onglet 6 – Déclarations

Le contenu de cet onglet est généré automatiquement grâce à une macro (bouton « Générer déclarations » dans l’onglet « Modules »). Les lignes des variables sont constituées de la manière suivante : nom de la variable, numéro affecté par la box, nom déclaré au moment de l’inclusion, nom fonctionnel.


La macro Excel génère uniquement une ligne de déclaration pour les modules pour lesquels vous avez pris le temps de renseigner un nom de variable. Les lignes sont générées selon l’ordre défini dans l’onglet « Modules ».

 

Vous trouverez ci-après les liens de téléchargement du fichier Excel vide et avec l’exemple, avec et sans macro (pour ceux qui craignent de récupérer un malware).

 

Téléchargement du fichier SANS macro - Liste des modules (vierge).xlsx

Liste des modules (vide).xlsx

Téléchargement du fichier AVEC macro - Liste des modules (vierge).xlsm

Liste des modules (vide).xlsm

Téléchargement du fichier AVEC macro - Liste des modules (exemple).xlsm

Liste des modules (exemple).xlsm

Téléchargement du fichier - Liste des modules (code de la macro).txt

Liste des modules (code de la macro).txt


Récupération des informations de la box

Pour récupérer les informations, il y a deux manières de faire :

1) la plus longue et la plus fastidieuse : aller dans la partie « Advanced » de chaque module et recopier les informations affichées dans le classeur Excel.


2) exécuter un script LUA afin de récupérer les informations dans un fichier texte au format csv :


Téléchargement du fichier de macro lua

Get_Infos_Device.lua

 

Je vous recommande – si vous ne l’avez pas déjà fait – de télécharger et d’installer l’éditeur « Notepad++ ».

 

Pour exécuter le script, vous devez aller dans la partie Apps / Develop Apps / Test Luup code (Lua)

Copier le texte du script dans la zone « Test Luup code (Lua) », cliquez sur le bouton « Go ».


Si tout c’est bien passé, vous devriez avoir un message sous forme de fenêtre popup « Code sent successfully. ».

 

NB : vous pouvez enrichir les informations extraites des modules, pour ce faire vous trouverez ci-après la liste des informations disponibles.

Pour consulter le résultat, vous devez taper le chemin suivant dans votre navigateur préféré (en fonction de l’extension indiquée dans le script lua) :

adresse-ip-box/liste_des_devices.txt, exemple 192.168.1.244/liste_des_devices.txt

adresse-ip-box/liste_des_devices.csv, exemple 192.168.1.244/liste_des_devices.csv

 

C’est à vous

Il ne vous reste plus qu’à vous lancer.

Avec les prochains articles, nous commencerons à réaliser de petits scripts et donc à utiliser le fichier généré des déclarations.

 

Documentation


Article

Menu Vera

Module / Apps

Scénario / Script

01 – Prise en main 1

Settings / Setup Wizard

Fibaro Wall Plug

Fibaro Wall Plug

02 – Consommation électrique 1

Dashboard

Scenes / + Add Scene

Fibaro Wall Plug

Scénario de mise hors tension quotidienne à heure fixe

Feuille Excel

03 – Tableau de bord 1

Settings / Net & Wifi

Apps/Install apps

Apps / Develop Apps / Test Lupp Code (LUA)

Scenes / + Add Scene

Mobile Apps « ImperiHome »

Caméra FOSCAM FI8918W

Capteur EverSpring SM103

Apps « Virtual ON/OFF Switches »


Scénario+ script d’ouverture / fermeture d’ouvrants


04 – Tableau de bord 2

Apps/Install apps

Apps « ImperiHome »

Mobile Apps « ImperiHome », création d’une page de tableau de bord

Scénario + script de vérification de l’état des portes de garage et permettant la vocalisation d’un message

05 – Documentation 1

Apps / Develop Apps / Test Lupp Code (LUA)


Script de collecte d’information des devices utilisés

Feuille Excel

06 – Tout savoir ou presque sur les scénarios

Scenes / + Add Scene


Scénario + script enrichis de vérification de l’état des portes de garage et permettant la vocalisation d’un message

07 – Tout savoir ou presque sur les notifications

Apps / Develop Apps



 

Conclusion

Avec cet article, vous êtes en mesure de documenter les modules utilisés avec votre box, mais surtout de chiffrer le coût de votre installation domotique. Il ne tient qu’à vous d’enrichir les informations de la feuille Excel ; par exemple dans l’onglet « Modules », vous pourriez ajouter le numéro de facture, la boutique d’achat, …

Dans un prochain article nous parlerons de la façon de documenter une architecture fonctionnelle sous forme de schéma ; cela est bien pratique pour définir un cas d’utilisation qui comporte plusieurs modules à intégrer. Si vous vous dites « quèsaco » (Qu’est-ce que c’est ?), alors encore un peu de patience.

 

Vous n'avez pas compris un point ? Vous vous posez une question ? Vous pouvez nous contacter via le bouton Assistance sur votre gauche. N'hésitez pas à demander un rendez-vous téléphonique avec Domotics.

Vous avez aimé cet article ? Vous pouvez le partager sur vos réseaux sociaux pour soutenir son auteur et l'encourager à écrire de nouveaux articles ...

 

Cet article vous est proposé par GuyT : Guy possède une expérience des Systèmes d'Information (SI) à l'international chez un opérateur telco où l’intégration est vitale entre les différents quartiers du SI (par analogie avec l’urbanisation des villes). Il s'est lancé dans la domotique en 2012, après une pause rédactionnelle, il est de retour pour vous proposer des cas concrets d'utilisation et d'intégration qui tiennent compte de l'expérience utilisateur.

Mise à jour le Mercredi, 15 Juin 2016 03:35