HoMIDom V1.7. Guide Utilisateur. Manuel Utilisateur. Serveur et Configuration. Version Logiciel / 47

Transcription

1 Manuel Utilisateur Serveur et Configuration Version Logiciel / 47

2 Table des matières Présentation Qu'est ce que HoMIDom? Pourquoi HoMIDom? Comment est construit HoMIDom? Un système évolué et simple Prérequis Glossaire Installation Installeur Premier lancement L interface d administration Configuration Configuration du Serveur Configuration des Drivers Configuration des Composants Gérer les variables associées au composant Gestion des variables Création d une variable Modification de la valeur d une variable Supprimer une variable Accéder, modifier une variable depuis une action VBS Configuration des Zones Configuration des Utilisateurs Configuration des Macros / Triggers / Modules Définition Gestion TriggerTimer TriggerComposant (ou TriggerDevice) Les Macros Les Variables Les Modules Consultation des Historiques/Relevés/Graphes Consultation des Logs Les commandes HTTP Aide / A propos 2 / 47

3 1 Présentation 1.1 Qu'est ce que HoMIDom? C'est un ensemble de logiciels qui vous permettent de contrôler votre installation domotique avec une grande simplicité. Sa conception modulaire permet de centraliser la gestion de technologies utilisées actuellement (X10, PLCBUS, ZWAVE, RFXcom, 1 wire...). 1.2 Pourquoi HoMIDom? Après de nombreuses recherches d'un logiciel de pilotage, HoMIDom est le résultat de la fusion de deux logiciels : DOMOS et EHOME. HoMIDom est un logiciel complet, entièrement gratuit, de gestion de système domotique multi technologies pour la maison développé sous Microsoft Windows en Open Source (libre) proposé gratuitement à toute la communauté! 1.3 Comment est construit HoMIDom? L'application HOMIDOM s'appuie sur trois composants logiciels Le serveur et les drivers, La console d administration, Les clients : Androïd, Web, WPF... La partie serveur prend en charge la gestion des interfaces matérielles avec les équipements (via les drivers) ainsi que la partie intelligente : Triggers / Macro / Historiques... Afin d'être utilisée, elle doit être installée sur un poste connecté à votre réseau afin de traiter les événements et d'exécuter les macros. Ce poste doit être disponible 24h / 24h et il doit être équipé de Windows XP minimum et du Framework.net 4.0 (la version complète et pas seulement la version Client Profile). Toutes les interfaces (clients, console) communiquent avec le serveur en utilisant la technologie «Web service» (SOAP) cependant, un dialogue via des commandes HTTP sont possibles. La console d administration permet de configurer et visualiser votre installation sous un environnement Windows. Les clients permettent de piloter votre installation. 3 / 47

4 1.4 Un système évolué et simple HoMIDom comporte un système permettant de gérer un historique complet de son installation domotique (courbes de température, activation des détecteurs de mouvements, images des caméras, allumage des lampes, consommation électrique...) pour permettre une bonne analyse de son système. Le serveur est également équipé d'un système évolué et simple à la fois, basé sur des macros. Ceci permet d'automatiser toutes les tâches de sa maison : ouverture des volets roulants en fonction de la lumière, gestion du chauffage en fonction des différentes températures de la maison et de la présence des personnes, gestion de l'arrosage... Tout est possible grâce à un ingénieux système permettant de créer des macros complexes en toute simplicité. 1.5 Prérequis HoMIDom nécessite plusieurs prérequis matériel et logiciel Résolution : minimum 1024*768 Processeur : minimum 1*1 Ghz Mémoire Vive : minimum 1 Go Ram Framework.net : Framework.net 4.0 Full Droits : administrateur pour le service Homidom Firewall : ouvrir le port configuré dans l administration (par défaut 7999) avec le protocole TCP en entrée. Ceci est obligatoire pour accéder au serveur depuis les interfaces non installées sur le serveur (Homidroid, HoMIAdmiN sur un poste client, HoMIWpF sur un PC tactile...) Suivant les drivers, il faut également installer les logiciels nécessaires au fonctionnement des interfaces matérielles. Par exemple, avec le PLCBUS, il faut installer le driver Windows Prolific pour port Série/USB. Ceci est précisé dans la documentation de chaque driver. 4 / 47

5 2 Glossaire Driver : Un driver est une DLL stockée sur le serveur. Chaque DLL a été développée pour permettre au serveur de communiquer avec un équipement matériel/logiciel de domotique. La plupart des composants s'appuient sur un protocole particulier utilisé dans la domotique : 1 wire, X10, Zwave, PLCBUS... Ainsi le driver PLCBUS permet, par exemple, au serveur de communiquer avec l interface PLC 1141 USB/Série. Une liste de drivers de base est incluse dans l installation standard d HoMIDom, mais d autres peuvent être ajoutés, simplement en les copiant dans le répertoire Drivers du serveur. Celui ci les reconnaîtra alors automatiquement. Les drivers sont ensuite configurables dans l interface d administration. Composant (ou Device) : Ceci représente un élément physique ou virtuel de votre installation domotique : une sonde de température, un module pour volet roulant, une lampe, une variable... Chaque élément de votre système doit être créé dans HoMIDom sous forme de composant et rattaché à un driver. Zone : Les zones sont des regroupements de composants, macros et autres zones qui permettent de faciliter la gestion et l'utilisation sur les clients. Elles peuvent par exemple représenter les différentes pièces (cuisine, salon, chambre ) ou groupe de pièces (étage, ensemble ) de votre maison. Macro : Les macros permettent d automatiser des tâches : allumer la lumière s il fait nuit, fermer les volets le soir... Les macros dans HoMIDom sont découpées en deux parties : les triggers et les macros Les triggers (ou déclencheurs) permettent de lancer des macros quand un composant est modifié ou à une date/heure précise. Exemple : si le détecteur de mouvement change de statut (ON ou OFF), alors lancer une ou plusieurs macros Les macros sont la partie intelligente, c est un ensemble de conditions et d actions. Exemple : si le détecteur de mouvement est à ON (condition), alors allumer la lumière et envoyer un (action), sinon l éteindre (action) Trigger : Les triggers (ou déclencheurs) permettent de lancer des macros quand un composant est modifié ou à une date/heure précise. Module : Les modules permettent de créer automatiquement les triggers et macros pour des scénarios prédéfinis afin de faciliter la création de ces derniers pour les débutants ou de gagner 5 / 47

6 du temps pour les experts. 3 Installation 3.1 Installeur Nous allons aborder ici l installation de la partie serveur : le serveur, les drivers de base ainsi que l interface d administration. Les autres drivers ou interfaces sont disponibles en téléchargement sur notre site, sur GooglePlay... et leur installation/configuration se passe à part. # Capture d écran Description 1 Vérifier et installer les prérequis : le Framework.net 4 Full (Microsoft) ou le Framework 4.5 Full 2 Télécharger la dernière version d HoMIDom depuis notre site Internet 3 Lancer l installation en double cliquant sur le package téléchargé précédemment : Setup.exe 4 Accepter, si besoin, l alerte de l UAC pour autoriser l installation (ceci dépend de votre système d exploitation et de votre configuration) 5 Cliquer sur Suivant 6 / 47

7 6 Il est conseillé de laisser la configuration par défaut et de cliquer sur Suivant 7 Cliquer sur Suivant pour lancer l installation 8 Cliquer sur Fermer à la fin de l installation 9 Un menu est créé dans le menu «Démarrer» pour HoMIDom, ceci pour permettre de lancer le serveur, l interface d administration ainsi que la documentation (sur le site Web) 7 / 47

8 3.2 Premier lancement Des raccourcis ont été automatiquement créés dans le menu «Démarrer» pour le serveur et l interface d administration. Ces programmes peuvent également être lancés directement depuis le répertoire où est installé HoMIDom. # Capture d écran Description 1 Lancer le serveur en cliquant sur l icône HoMIDom Service 2 Accepter, si besoin, l alerte de l UAC pour autoriser l exécution du serveur (ceci dépend de votre système d exploitation et de votre configuration) 3 Le serveur se lance et charge sa configuration (depuis le fichier HoMIDom/config/homidom.xml) 4 Le serveur est maintenant opérationnel avec une configuration de base et quelques exemples (composants, macros, triggers...) INFO : Dans cette console, un simple appui sur un touche permet de fermer proprement le serveur 8 / 47

9 5 Il faut maintenant lancer l interface d administration pour configurer HoMIDom suivant votre installation 6 Accepter, si besoin, l alerte de l UAC pour autoriser l éxécution de l interface d administration (ceci dépend de votre système d exploitation et de votre configuration) Plus nécessaire à partir de la version du 29/01/13 7 Normalement, il suffit ici de cliquer sur OK lors du premier lancement Si vous avez restauré une ancienne configuration, il faut renseigner les bons Id/Adresse IP/Port INFO : On peut ici créer plusieurs configurations (serveur maison, pour test, pour autres personnes ) pour pouvoir se connecter à plusieurs serveurs HoMIDom Il suffit pour cela de changer les paramètres et de cliquer sur l icône 8 La toute première étape consiste à configurer le serveur 9 Ensuite viendra le temps de configurer les drivers, de créer des composants... 9 / 47

10 3.3 L interface d administration L interface d administration permet de configurer et visualiser toute votre installation L interface est composée de plusieurs parties : Le menu principal en son centre, qui permet d accéder directement à la plupart des fonctionnalités de l interface Ce menu disparaît lorsqu on affiche le détail d un élément (Composant, Driver, Macro...) Le menu de gauche permet de lister tous les éléments de l installation. Il est organisé en 10 / 47

11 onglets. Le contenu de ce menu change suivant le menu principal qui est utilisé : un clic sur Gérer les composants va afficher l onglet Composant La barre d état permet de visualiser différentes informations du serveur : la date et l heure, les heures de lever et coucher du soleil, le serveur sur lequel on est connecté, les derniers logs et erreurs / 47

12 4 Configuration 4.1 Configuration du Serveur Pour accéder à la configuration du serveur, il faut donc utiliser le menu principal et cliquer sur l icône Configuration Les boutons présents en bas à droite de l'icône Configuration permettent d accéder à la visualisation des logs ou de forcer l enregistrement de la configuration dans le fichier XML 12 / 47

13 Onglet Serveur L Id du serveur (par défaut à mais que vous pouvez changer) permet de sécuriser l accès au serveur (une sorte de mot de passe global) en attendant de mettre en place une gestion d accès L IP et le port utilisé sur le serveur, par défaut «Localhost» et Dans le cas de l utilisation d une interface Web ou Android, il faut configurer l IP locale du serveur (ex : ) et ensuite utiliser cette IP lors de la connexion à l interface d administration Votre pays: sera utilisé ulterieurement Les coordonnées de latitude et de longitude. Ces valeurs permettent de calculer les heures de lever et coucher du soleil automatiquement Les corrections (en minutes) des heures de lever et de coucher du soleil. Cela permet par exemple de faire croire au système que le soleil s est levé une heure plus tard pour l utiliser dans les macros pour ouvrir les volets roulants. Par défaut à 0 La voix par défaut utilisé pour le TTS sur le serveur lors de l annonce d un message vocal (voir macro) Onglet Logs La taille du fichier Log et la durée de conservation : non utilisé pour le moment Le type de log à prendre en compte pour l affichage et l enregistrement. Il est conseillé de tout laisser coché et lors de la phase d installation/configuration de laisse DEBUG activé pour permettre de stabiliser votre installation plus facilement. Onglet Les paramètres de connexion et la messagerie utilisée pour l'envoi automatique de mails Onglet Energie permet de calculer la consommation totale de votre installation suivant la durée de fonctionnement et la puissance configuré de chaque module Onglet Configuration La périodicité de la sauvegarde automatique de la configuration (en minutes). Il est conseillé de cocher la sauvegarde en temps réel (à chaque modification) et la sauvegarde automatique sur 0 La sauvegarde externe permet de sauvegarder le fichier homidom.xml et la BDD dans un dossier externe à Homidom (disque dur externe, dossier Dropbox, NAS ). Il est conseillé de régler le cycle de sauvegarde sur minimum 1 jour (24h) voir une semaine (158h) 13 / 47

14 Possibilité d importer ou d exporter le fichier de configuration manuellement SARAH : exporter la configuration dans un fichier XML utilisable dans SARAH pour la reconnaissance vocale Onglet Divers Le mode découverte permet de créer automatiquement des composants quand un driver trouve un composant inconnu. Il est conseillé de plutôt activer cette fonctionnalité dans chaque driver pour plus de granularité et ainsi pouvoir l activer/désactiver plus rapidement lors de l ajout/modification de composants dans une technologie particulière sans risquer de recevoir des informations non désirées d un autre driver Le Groupe «Serveur Web» permet : d activer ou non le serveur web permettant d envoyer ou recevoir des commandes HTTP depuis un client de définir le port HTTP à utiliser (par défaut 8080) Ceci est différent de l API web qui utilise le port SOAP et qui renvoie du xml ou Json avec une syntaxe différente (voir la partie commande Http pour plus de détails) Durée Animation : permet de régler la durée du fondue des fenêtres dans l administration. 0 permet de le désactiver. ce paramètre peut être utile dans le cas d une connexion RDP lente. 14 / 47

15 4.2 Configuration des Drivers Pour ouvrir la fenêtre de configuration du driver, plusieurs possibilités : Cliquer sur l onglet à gauche Driver puis double cliquer sur le driver ou effectuer un clic droit / modifier Cliquer dans le menu principal sur le bouton Modifier du cadre Drivers puis choisir le driver à configurer dans la liste qui s affiche Chaque driver se configure individuellement et comporte des champs différents suivant ses besoins (adresse IP, nom du port COM...). 15 / 47

16 Il faut ensuite configurer le driver suivant son installation et ses besoins. Par exemple, pour le driver RFXtrx Certains champs sont en lecture seule à titre informatif. Usage des autres champs : Activer/Désactiver un driver (s il est désactivé, il n'apparaît plus dans les menus des composants, des interfaces clientes...) StartAuto permet de lancer le driver automatiquement au démarrage du serveur Découverte permet de créer automatiquement les nouveaux composants détectés par le driver. (il existe le même paramètre au niveau du serveur prioritaire sur celui ci) Les paramètres avancés sont propres à chaque driver et permettent par exemple de configurer un mode débogage complet en cas de problème, de configurer un code PIN pour le driver GSM... Adresse IP / Port IP / Port COM... permettent de configurer les accès à l interface physique/logicielle (ici, le boitier RFXtrx est connecté sur le port COM2 du serveur) Refresh est rarement utilisé sur les drivers, il permet de lancer une fonction dédiée toutes les x secondes pour, par exemple, interroger un bus de données... Cela est très rarement le cas donc, laisser la valeur par défaut à 0. La configuration complète de chaque driver est renseignée dans une documentation propre qui est disponible sur notre site web. Pour résumer : Il est conseillé d activer (Enable) uniquement les drivers qui correspondent à votre installation, de configurer le paramètre avancé DEBUG (disponible uniquement sur certains drivers) uniquement lors de la configuration ou en cas de problème, d activer le démarrage automatique StartAuto pour vos drivers en production / 47

17 4.3 Configuration des Composants Les composants (ou Devices) correspondent à chaque élément physique (un capteur de température, un interrupteur...) ou virtuel (météo, jour...) de l installation. Les éléments comportant plusieurs informations (un capteur de température et humidité par exemple) sont une exception. Il faut en effet créer un composant par information. Exemple : avec un capteur de température et humidité, il faut créer avec la même adresse, un composant de type Température et un composant de type Humidité. Pour créer un composant, il faut utiliser le menu principal A partir de ce cadre, on peut également (dans l ordre) Afficher la liste des composants déjà créés dans le menu de gauche (bouton Gérer) Ajouter un composant Modifier un composant. Une liste s affiche et permet de choisir le composant à modifier Supprimer un composant. Une liste s affiche et permet de choisir le composant à supprimer A Savoir : Une fois le composant créé, il n est plus possible de modifier son type, il faut pour cela le supprimer et en créer un nouveau. Important : Le nom du composant doit être unique et ne pas contenir de caractères spéciaux, ceci afin d éviter des problèmes d affichage dans les différentes interfaces. Particularité : les composants systèmes (comme HOMIJour) ne sont pas supprimables ou modifiables. 17 / 47

18 Dans la fenêtre de création/modification d un composant, les différents champs disponibles changent en fonction du driver et du type de composant sélectionné. C est pourquoi il est fortement conseillé de commencer par sélectionner le driver associé au composant puis le type de composant. Description des différents champs disponibles Nom : nom unique du composant ; ex : Chambre parents : température Description : champ texte non obligatoire pour décrire le composant (ceci peut être utile pour préciser où il est situé, une configuration particulière...) Driver : liste déroulante permettant de choisir le driver associé à ce composant Type : liste déroulante permettant de choisir le type de composant (cette liste change en fonction du driver sélectionné) : APPAREIL (Booléen) : modules pour diriger un appareil ON/OFF AUDIO (Text) : module de type audio BAROMETRE (Numérique) : pour stocker la valeur issue d'un baromètre météo ou web BATTERIE (Texte) : pour stocker les valeurs issues d'une batterie 18 / 47

19 COMPTEUR (Numérique) : pour les compteurs de gaz, compteur DS2423, RFXPower... CONTACT (Booléen) : détecteur de contact : switch 1 wire DETECTEUR (Booléen) : tous détecteurs : mouvement, obscurité... DIRECTIONVENT (Texte) : module donnant la direction du vent ENERGIEINSTANTANEE (Numérique) : valeur de puissance d'énergie instantanée ENERGIETOTALE (Numérique) : valeur de puissance d'énergie totale FREEBOX (Texte) : FreeBox GENERIQUEBOOLEEN (Booléen) : générique de type booléen GENERIQUESTRING (Texte) : générique de type texte GENERIQUEVALUE (Numérique) : générique de type numérique HUMIDITE (Numérique) : capteur d'humidité LAMPE (Numérique) : module de type lampe avec variation METEO (Spécial) : station météo (physique ou web) MULTIMEDIA (Texte) : multimédia PLUIECOURANT (Numérique) : valeur de pluie courante PLUIETOTAL (Numérique) : valeur de pluie totale SWITCH (Booléen) : interrupteur (mural / télécommande...) TELECOMMANDE (Texte) : télécommande TEMPERATURE (Numérique) : capteur de température TEMPERATURECONSIGNE (Numérique) : température de consigne (ex : thermostat) UV (Numérique) : indice UV soleil VITESSEVENT (Numérique) : vitesse du vent VOLET (Numérique) : volet roulant Enable : permet d activer ou non un composant (utile pour de l'affichage dans les interfaces clientes) Solo : peu utilisé (1 wire) ; si non coché, permet de mettre à jour les composants associés. Pour un switch 8 entrées 1 wire, la lecture d un des switch met à jour les 8 composants switch LastEtat : si coché, permet de tenir compte de l'avant dernière valeur. Ex : un composant a une valeur 10 puis 11 puis 10, avec lastetat, 10 sera pris en compte ainsi que 11 mais pas le dernier 10 (car égale à l avant dernière valeur). Ceci pour limiter le nombre d enregistrement par exemple pour un capteur de température AllValue : par défaut, à chaque nouvelle valeur reçue pour un composant, celle ci n est prise en compte que si elle a changé (macros, historiques...). Si coché, toutes les valeurs sont enregistrées. ATTENTION : ceci peut engendrer un nombre important d enregistrements ainsi qu une charge accrue au niveau des triggers Unité : utile pour l affichage dans certaines interfaces clientes ainsi que pour certains drivers. En effet, des drivers comme le Zwave utilisent ce champ. Exemple pour une 19 / 47

20 température : C ou F pour afficher la température dans la bonne unité Puissance : en Watt, permet de calculer la consommation d un appareil quand celui ci est ON Adresse 1 : ce champ peut changer de nom suivant les drivers mais correspond à l adresse du composant Adresse 2 : ce champ peut changer de nom suivant les drivers. Certains composants ont besoin de 2 adresses (ex avec la Zibase pour la réception et l émission) Modele : ce champ peut changer de nom suivant les drivers. Permet de choisir suivant les drivers un modèle de composant (par exemple pour le protocole d émission avec le RFXtrx) Refresh : ce champ peut changer de nom suivant les drivers. Suivant le driver, si > 0, alors le composant sera interrogé toutes les x secondes pour récupérer sa valeur LastChangeDuree : en minutes, ceci permet dans les interfaces de vérifier si un composant n a pas été mis à jour depuis au moins X minutes. Dans ce cas, il apparaît en erreur (pour savoir quand un composant ne fonctionne plus, n émet plus...) Value Min/Max : ceci permet de borner les valeurs reçues, les valeurs sont tronquées si elles dépassent les limites Correction : permet via une formule +10 ou * de modifier la valeur reçue, ceci afin de corriger une température, de transformer des km/h en m/sec...). Il est ici possible d utiliser <nomcomposant>. Formatage : ceci sert dans les interfaces pour formater la valeur en vue de son affichage (peu utilisé) Zones : permet de sélectionner dans quelle(s) zone(s) est situé le composant, ceci pour organiser votre installation (une zone peut être une pièce, un étage, un type de composants...) Variables: permet de créer des variables personnalisées et associées au device (exemple variable compteur ) permettant d ajouter des propriétés personnalisées et utilisables dans les Scripts VB (macro). Les boutons d actions Sauvegarder/Fermer : sauvegarde le composant et ferme la fenêtre Annuler : annule les modifications et ferme la fenêtre Sauvegarder : sauvegarde le composant Tester : visible lors de la modification ou lorsque le composant a été sauvegardé une première fois. Ceci permet d ouvrir une fenêtre pour lancer différentes fonctions dépendantes du driver et du type de composant (ON/OFF/Read...) à des fins de tests Historique : Ce bouton permet d afficher le graphe et la liste des relevés du composant. Si celui ci n a pas encore de valeurs, le titre du bouton est en italique mais il est quand même possible d afficher la liste des relevés pour en ajouter manuellement 20 / 47

21 Une fois les composants créés, ils apparaissent dans le menu de gauche A partir de ce menu, en double cliquant sur un composant ou en faisant un clic droit / modifier, une fenêtre s ouvre permettant de modifier le composant. A partir du clic droit, il est également possible d activer/désactiver un composant, de le supprimer, mais aussi de consulter l historique/relevés/graphes directement. Si Historique est écrit en italique, cela veut dire qu il n y a actuellement pas d historique pour ce composant, mais il est quand même possible d afficher la liste des relevés pour en ajouter manuellement. INFORMATION : En passant simplement la souris sur un composant, un pop up affiche un résumé de ses caractéristiques 21 / 47

22 4.4 Gérer les variables associées au composant Gestion des variables Les variables sont de type string et gérer d un point de vue code comme un Dictionnary, elles ont chacune 2 propriétés importantes: Une clé (key) Une valeur associée à cette clé Exemple: Clé Valeur Compteur 0 VAR1 valeur Test Création d une variable Pour créer une nouvelle variable cliquer sur l icone nouvelle variable et si besoin sa valeur par défaut:, puis renseigner ensuite le nom de la Valider Ensuite (ou annuler) via l icone, la variable est désormais créée, ATTENTION une fois une variable crée son Nom (clé) n est plus modifiable et il ne peut y avoir de doublon! Modification de la valeur d une variable Sélectionner la variable dans la liste déroulante, puis modifier sa valeur: 22 / 47

23 Cliquer ensuite sur l icône pour prendre en compte la modification Supprimer une variable Sélectionner la variable dans la liste déroulante, puis cliquer sur l icône pour la supprimer Accéder, modifier une variable depuis une action VBS Pour accéder ou modifier une variable d un composant il faut déjà récupérer celui ci via son ID: Dim x as TemplateDevice=Myservice.ReturnDeviceById(IdSrv,Iddevice) Ensuite toutes ses variables sont stockées dans x.variablesofdevice Pour récupérer la valeur d une variable nommée TOTO : Retour =x.variablesofdevice( TOTO ) Pour définir la valeur d une variable nommée TOTO en 1234 : x.variablesofdevice( TOTO )= / 47

24 4.5 Configuration des Zones Les zones permettent de regrouper des composants, des macros et d autres zones pour permettre ensuite, dans les interfaces, de les lister ensemble, de les positionner sur des cartes... Le menu principal permet d effectuer les opérations de base sur les zones Comme pour les composants, chaque bouton permet d afficher la liste des zones déjà créées dans le menu de gauche, d en créer une nouvelle ainsi que de modifier ou supprimer une zone existante. Le menu de gauche permet donc de visualiser et de gérer les zones existantes 24 / 47

25 On peut y voir le nombre d éléments contenus dans la zone et via un clic droit accéder aux fonctions de modification/suppression de la zone. Le double clic fonctionne également et permet de modifier la zone. Une zone est composée de Nom : nom de la zone qui soit le plus simple possible (caractères spéciaux déconseillés) car ce nom sera souvent utilisé dans les interfaces clientes, dans les menus Icon : permet de choisir (en cliquant dessus) une image représentant la zone qui sera utilisée dans les clients en tant qu icône Image : permet de choisir une image (en cliquant dessus) représentant la zone qui sera utilisée dans les clients en arrière plan (background) Composants / Zones / Macros : listes permettant de sélectionner les éléments à inclure dans la zone. Lorsqu un élément est choisi, une case à cocher apparaît, permettant de décider s il sera visible dans la zone (on peut ainsi choisir de regrouper dans une même zone des éléments, mais n en afficher qu une partie dans les interfaces, ceci pour des raisons d organisation) 25 / 47

26 4.6 Configuration des Utilisateurs Comme pour les autres éléments, il est possible de gérer les utilisateurs depuis le menu principal ou depuis le menu de gauche IMPORTANT : Actuellement, les utilisateurs ne sont utilisés dans HoMIDom que pour récupérer l adresse mail d un utilisateur dans le cadre d une action « ». En effet, seul l Id du serveur permet une authentification. 26 / 47

27 4.7 Configuration des Macros / Triggers / Modules Cette partie est la plus difficile à comprendre et à utiliser, mais la plus utile et puissante en domotique! Pour simplifier au maximum l utilisation des Triggers et Macros, nous avons créé des modules. Ceux ci seront de plus en plus nombreux avec le temps et permettent de créer automatiquement les triggers et macros nécessaires pour des scénarios particuliers Définition Un trigger permet de lancer une ou des macros suivant un événement particulier : à une date/heure donnée (TriggerTimer) ou lorsqu un composant change de valeur (TriggerComposant ou TriggerDevice). Les macros sont, quant à elles, une suite d actions à exécuter. On peut également y ajouter des conditions (Si xxx alors xxx sinon xxx) pour créer des scénarios plus complexes (gestion de chauffage, alarme...). Important : Une macro nécessite obligatoirement un Trigger pour être lancée! Gestion Comme pour les autres éléments d HoMIDom, on peut gérer les triggers et les macros existants depuis le menu principal en cliquant sur l icône Triggers / Macros ou en utilisant le sous menu Gérer. A partir des sous menus, on peut créer un TriggerTimer un TriggerComposant ou une Macro. Les modules seront abordés plus tard dans ce chapitre. 27 / 47

28 On peut également utiliser le menu de gauche pour afficher les macros et triggers déjà créés. Dans ces onglets, un double clic sur un élément ou un clic droit / modifier affiche sa fenêtre de modification TriggerTimer Un TriggerTimer fonctionne sur le principe des tâches planifiées de Windows ou plus précisément du Cron sous Linux. 28 / 47

29 En effet, pour configurer un TriggerTimer, il faut renseigner Le nom du trigger qui doit être simple et sans caractères spéciaux comme pour les autres éléments Enable pour activer ou non le trigger (si désactivé, il ne sera pas pris en compte utile le temps de la création ou pour ne pas le supprimer en cas de non utilisation) Une description Macro(s) : permet de sélectionner quelle(s) macro(s) sera(ont) lancée(s) par le Trigger Date heure : ceci reprend le fonctionnement du Cron Le fonctionnement des champs date heure est assez simple. Voici quelques exemples pour aider à en comprendre le principe : Tous les lundis à 01h00 : Heure=01, Minute=00, Seconde=00, Jour=, Mois=, Lundi=coché Le premier du mois à 3h : Heure=03, Minute=00, Seconde=00, Jour= 01, Mois= Toutes les heures : Heure=, Minute=00, Seconde=00, Jour=, Mois= La semaine à 2h00 : Heure=02, Minute=00, Seconde=00, Jour=, Mois=, Lundi à vendredi=coché Un mode avancé a été mis en place pour permettre une plus grande flexibilité du système Il permet d utiliser exactement le même format que le cron de Linux : * : veut dire n importe quelle valeur 2 5 permet de prendre en compte les valeur de 2, 3, 4 et 5 2,5 permet de prendre en compte 2 et 5 29 / 47

30 Chaque, si coché, permet de lancer le trigger toutes les X minutes/heures au lieu du système standard, exemple Minute = 25 et chaque coché, le reste par défaut Le trigger sera lancé toutes les 25 minutes à partir de l heure du lancement du serveur. Quand le mode avancé est utilisé, le mode simple n est plus accessible car celui ci ne gére pas ces settings TriggerComposant (ou TriggerDevice) Ces triggers permettent donc de lancer une ou des macros quand une propriété d un composant change, typiquement quand la valeur d un composant est modifiée (une température qui augmente/diminue...). Il faut donc choisir Le nom du trigger qui doit être simple et sans caractères spéciaux comme pour les autres éléments Enable pour activer ou non le trigger (si désactivé, il ne sera pas pris en compte utile le temps de la création ou pour ne pas le supprimer en cas de non utilisation) Une description Macro(s) : permet de sélectionner quelle(s) macro(s) sera(ont) lancée(s) par le Trigger Composant: liste des composants actifs Propriété : nom de la propriété du composant, en principe, Valeur 30 / 47

31 31 / 47

32 4.7.5 Les Macros Nous allons maintenant aborder la partie intelligente de ce système... les Macros. Les triggers permettent donc de déclencher une ou des macros suivant une date/heure ou la modification d un composant. En effet, c est ici que nous allons pouvoir définir des conditions d exécution (valeur, date/heure...), des actions à lancer (modifier un composant, donner un ordre, lancer une URL, envoyer un mail...), le tout suivant un timelap pour permettre de lancer des actions décalées dans le temps (ex : ouvrir un volet puis 5 secondes plus tard en ouvrir un autre). La fenêtre d une macro présente donc des propriétés classiques Le nom de la macro qui doit être simple et sans caractères spéciaux comme pour les autres éléments Enable pour activer ou non la macro (si désactivée, elle ne sera pas prise en compte, utile le temps de la création ou pour ne pas la supprimer en cas de non utilisation) Une description : champ texte non obligatoire pour décrire la macro (ceci peut être utile pour préciser son fonctionnement, une configuration particulière...) 32 / 47

33 Une fois les champs de base renseignés, il faut ajouter les actions. Il en existe de différents types Composant : permet d agir sur un composant (lancer une commande : ON /OFF...) envoyer un pour, par exemple, vous prévenir d un événement particulier Si Alors Sinon : permet de tester une condition et d agir suivant le résultat, ceci est la partie qui permet d automatiser son installation : si la température est inférieure à 20 alors chauffer sinon éteindre le chauffage Une autre macro : permet de lancer une autre macro ; cela est utile pour créer des systèmes complexes sans tout mettre dans une seule macro ou bien pour créer une macro particulière qui sera lancée depuis plusieurs autres macros Parler : permet de faire lire au serveur un texte donné Envoyer une commande HTTP : permet de lancer une URL donnée pour piloter d autres logiciels, commander des appareils (Karotz, webcams...) Log Windows : pour pouvoir logger dans les journaux d événements de Windows Log HoMIDom : pour ajouter un log dans HoMIDom Commande DOS : permet de lancer une commande DOS pour lancer un exécutable, un script, une commande sur son système... Script VBS : permet de lancer un script VBS pour effectuer des actions particulières Arrêter la macro : permet de mettre fin à la macro, utilie pour stopper la macro suivant certaines conditions ou temps même si d autres actions ne sont pas terminés (par exemple arrêter au bout de 30 secondes une macro Alarme si le composant Alarme est passé à True entre temps. Variable :Définir la valeur d une variable Le principe est assez simple, il suffit de Glisser/déposer l icône de l action voulue sur la time line, 33 / 47

34 La fenêtre de création de l action apparaît automatiquement (il faut patienter quelques secondes) Configurer le délai pour décaler son lancement dans le temps Configurer ensuite l action suivant ses paramètres Pour modifier une action, il faut double cliquer sur l action et attendre quelques secondes pour que la fenêtre d édition apparaisse. L action la plus utilisée et complexe à la fois est Si Alors Sinon. Elle permet en effet d utiliser des conditions pour effectuer des actions. Elle permet par exemple de tester la valeur d un composant pour choisir une action, de vérifier une plage horaire pour lancer une action... IMPORTANT : une macro est seulement la partie traitement (tests, actions...), il faut obligatoirement configurer un Trigger (Composant ou Timer) pour que la macro puisse être lancée! Par exemple, pour configurer l allumage d une lampe à partir d une télécommande, il faut Créer un trigger composant sur le composant Télécommande qui lancera la macro à chaque changement de valeur de la télécommande Créer une macro Si Alors Sinon : Si la télécommande = ON alors action sur composant Lampe = ON sinon action sur composant Lampe = OFF Calcul et remplacement de valeur de composants dans les actions Dans les actions Composant, Si Alors Sinon (Champ condition), HTTP, Mail (Sujet et Texte), Parler, LogEvent, LogHomidomEvent et Commande Dos de mettre des balises pour : Les remplacer par la valeur du composant : Soit <nomducomposant> pour récupérer par défaut la valeur de la propriété Value Soit <nomducomposant.propriété> pour récupérer la valeur de la propriété indiquée Les remplacer par un donnée système : <SYSTEM_DATE> : date au format court <SYSTEM_LONG_DATE> : date au format long <SYSTEM_TIME> : Heure au format court <SYSTEM_LONG_TIME> : Heure au format long <SYSTEM_SOLEIL_COUCHE> : Heure de couché du soleil au format court <SYSTEM_SOLEIL_LEVE> : Heure de levé du soleil au format court Faire des calculs : {xxxxxxxxxxxxxxxxxxxxx} : évalution de xxxxx Il est ainsi possible d envoyer un avec comme texte : Le soleil s est levé à <SYSTEM_SOLEIL_LEVE> et la consommation electrique est de {<composantconsoinstantaneeenampere>*220} W 34 / 47

35 4.7.6 Les Variables Les variables permettent comme leur nom indique, de stocker des valeurs. Une variable comporte: Un Nom de type String et sans doublon, Une Valeur de type String. La gestion des variables se fait via l admin en cliquant sur l icone dans le menu principal. La liste des variables déjà créées s affichent dans la liste de gauche Pour créer une nouvelle variable cliquer sur l icone puis renseigner le nom, la description (si besoin), ainsi que la valeur de la nouvelle variable (si besoin) 35 / 47

36 Pour éditer une variable (modifier sa valeur, si active ou non, le nom n est plus modifiable), sélectionner une variable dans la liste puis cliquer sur l icone Pour supprimer une variable, la sélectionner puis cliquer sur l icone Dans les macros il est possible de modifier la valeur d une variable en sélectionnant l action puis ensuite sélectionner la variable voulue et la valeur associée. Dans les scripts VB, il est possible de modifier ou récupérer la valeur d une variable donnée: GET: Function GetValueOfVariable(ByVal idsrv As String, Name As String) As String exemple: myservice.getvalueofvariable( , MaVariable ) SET: Function SetValueOfVariable(ByVal idsrv As String, Name As String, Value As String) exemple: myservice.setvalueofvariable( , MaVariable, MaValeur ) Les Modules Les modules permettent de créer automatiquement les triggers et macros pour des scénarios prédéfinis afin de faciliter la création de ces derniers pour les débutants ou de gagner du temps pour les experts. Il existe plusieurs modules de base mais de nombreux seront ajoutés au fil du temps. 36 / 47

37 Information : Les modules permettent de créer les triggers et macros mais une fois créés, il faut utiliser les menus Trigger et Macro pour les modifier / supprimer. En effet, il n est pas encore prévu de pouvoir modifier un module directement. La création d un module se fait à partir de la fenêtre suivante Elle permet de sélectionner le type de module que l on souhaite créer et suivant le choix effectué, de compléter les informations nécessaires à la création des Triggers/Macros. Par exemple, pour allumer les lampes d un couloir à partir d un détecteur de mouvement, il faut choisir le module Associer un interrupteur/détecteur à des appareils/lampes/volets. Il faut ensuite choisir un nom (qui sera utilisé pour nommer les triggers et macros) choisir le composant émetteur dans la liste déroulante : le détecteur de mouvement choisir les composants récepteurs (liste à cocher) : les lampes du couloir 37 / 47

38 En appuyant sur ajouter, nous aurons une indication sur ce qui va être créé : 38 / 47

39 On peut donc vérifier dans les triggers et dans les macros 39 / 47

40 5 Consultation des Historiques/Relevés/Graphes La consultation des relevés (ou historiques) et des graphes est possible depuis plusieurs endroits. En effet, le plus simple est d utiliser le menu principal ou l onglet Historique pour afficher la liste des composants. Dans ce menu, les composants apparaissent de deux couleurs : ceux en noir n ont pas encore de valeur enregistrée dans les relevés. Il suffit donc ensuite de double cliquer sur un composant pour afficher ses relevés et le graphe correspondant. Il est également possible de sélectionner plusieurs composants puis de cliquer sur le bouton en 40 / 47

41 bas de l onglet pour générer un graphe avec les différentes courbes et les relevés. Une autre solution consiste à passer directement par la fenêtre d édition d un composant (si le composant a des relevés, un bouton Historique sera présent) ou via un clic droit sur le composant 41 / 47

42 Une fois la fenêtre d historique à l écran, on peut voir que celle ci affiche par défaut les relevés et graphes des 15 derniers jours sous forme de courbe On peut ensuite choisir des périodes différentes, d autres types de graphe, afficher des moyennes de valeurs... et même exporter le graphe en.jpg! Un clic droit sur l onglet graphe le rafraîchit. Via les onglets, on peut afficher le/les tableaux des relevés 42 / 47

43 6 Consultation des Logs Les logs sont consultables depuis plusieurs endroits Le plus simple consiste à regarder la console du serveur en temps réel Les logs sont également disponibles sous forme de fichier texte dans le répertoire HoMIDom\Logs Dans l interface d administration, on peut également visualiser rapidement les derniers logs du serveur en temps réel La dernière méthode permet, via l interface d administration de consulter, rechercher, trier... les logs La barre d état : Le dernier log est toujours visible dans cette barre et il est possible, en passant la souris au dessus de ce dernier, de faire apparaître un pop up avec les 10 derniers logs. Depuis le menu principal, le sous menu Configuration permet d ouvrir une fenêtre de gestion complète des logs 43 / 47

44 7 Les commandes HTTP Il est en effet possible d interroger et de commander HoMIDoM via de simples URL. Ceci permet d interfacer HoMIDoM avec d autres logiciels, sites webs, interfaces personnelles ou simplement depuis votre navigateur internet. Pour ce faire, il faut tout d abord ouvrir le port adéquat sur votre firewall (du serveur et aussi de votre routeur/box internet) ; par défaut, il s agit du port La syntaxe utilisée est la suivante : <IP> : adresse IP du serveur web (ou localhost) : IP locale depuis votre réseau ou IP publique / Nom de domaine depuis Internet <PORT> : port web utilisé (par défaut: 7980) <IDSRV> : correspond à l'id du serveur pour question de sécurité (par défaut : ) <CMD> : commande envoyée au serveur du type getalldevices : retourne la liste de tous les devices (ex : getallzones : retourne la liste de toutes les zones, avec les éléments (devices, macros... identifiés par id) (ex : getdevice (id doit être renseigné) : retourne un device (ex : 4c14 4d5 e bb83 95d32a5bc6c4) ondevice (id doit être renseigné) : allume un device (ex : 4c14 4d5 e bb83 95d32a5bc6c4) offdevice (id doit être renseigné) : éteint un device (ex : 4c14 4d5 e bb83 95d32a5bc6c4) Une autre possibilité est d utiliser l API disponible avec l identifiant api dans l URL. La première syntaxe permet d interroger HoMIDoM. Elle est de la forme api/{key}/{controller}/{id} où {id} est facultatif. {key} est la clef du serveur (par défaut ) {controller} est la classe qui va recevoir la requête 44 / 47

45 {id} représente l objet qu on veut récupérer (par exemple, l id du device) Les différentes valeurs de {controller} sont device driver macro trigger user zone Quelques exemples : retourne la liste de tous les devices : retourne le device «soleil01» La seconde syntaxe permet de commander HoMIDoM. Elle est de la forme api/{key}/command/{controller}/{id}/{command} et dans ce cas, {id} est obligatoire. {key} est la clef du serveur (par défaut ) {controller} est la classe qui va recevoir la requête {id} représente l objet qu on veut récupérer (par exemple, l id du device) {command} est la commande à exécuter (par exemple, ON/OFF pour les devices) Les différentes valeurs de {controller} sont device driver macro Exemple 9d b64c 323c /OFF : exécute un OFF sur le device 70f62ac0 9d b64c 323c / 47

46 8 Aide / A propos Cette fenêtre permet de consulter différentes informations sur HoMIDom. Le premier onglet permet d avoir le traditionnel A propos Le deuxième, plus important, permet de lister les différentes versions des drivers, DLL... ainsi que plusieurs informations sur votre système. Ceci peut être très utile pour du débogage! Le troisième permet d accéder aux différentes aides possibles. 46 / 47

47 Actuellement, il n y a pas encore d aide locale, tout est disponible sur notre site Internet via l aide en ligne et également sur le forum. Le dernier onglet est important pour le projet. En effet, il concerne la partie DON. Si vous aimez ce produit, pensez à faire un don (via Paypal donc totalement sécurisé et indépendant d HoMIDom) pour nous aider à développer cette suite entièrement gratuite! 47 / 47