Plugin Informe Documentation

Présentation du plugin

Ce plugin va vous permettre de simplifier vos scénarios.
Pour informer un utilisateur, il suffira de demander “Informe Sigalou que la porte du frigo est ouverte

En effet, en permanence, le plugin saura o√Ļ est Sigalou (Dans sa voiture, √† la maison, √† l’ext√©rieur,…), il saura sur quelle tranche horaire on se trouve (Jour, Nuit, …) et plusieurs niveaux de priorit√© pourront √™tre d√©finis (par exemple : Informe, Notifie, Alerte,…)

Ces informations ne sont pas toutes g√©r√©es par Informe, mais Informe les r√©cup√®re des autres plugins (de localisation, Blea, Jeemate, Pr√©sence, Alarme, …)

Vous pourrez ainsi programmer que pour donner une information :

  • Si Sigalou est dans sa voiture, il faut l’informer par “Alexa voiture”
  • Si Sigalou est √† la maison, il faut l’informer par “Alexa Tous les appareils”
  • Si Sigalou est au travail, il faut l’informer par SMS

Vous pourrez ainsi programmer que pour alerter (alarme intrusion, détecteur de fumée ..) :

  • Si Sigalou est dans sa voiture, il faut l’alerter par “Alexa voiture” + SMS
  • Si Sigalou est √† la maison, il faut l’alerter par “Alexa Tous les appareils” + SMS
  • Si Sigalou est au travail, il faut l’alerter par SMS + Mail

Les choix sont infinis et le plugin tr√®s souple ; pour chaque utilisateur (Monsieur, Madame, Marcel, Denise, Jacques, Paul, Dexter, Coralie, …) on peut cr√©er tous les lieux qu’on souhaite, toutes les tranches “horaire” qu’on souhaite, toutes les priorit√©s de notification qu’on souhaite…

Une fois la configuration réalisée, dans les scénarios, la commande pour prévenir un utilisateur sera aussi simple que cela :

C’est le plugin qui ira trouver la bonne mani√®re de pr√©venir l’utilisateur.

Installation du Plugin

Installer le Plugin depuis le Market

Aller ensuite dans le Market et sélectionner la version stable de Informe

Puis Activer le plugin

Message au 14/01/2022 : Attention, le plugin est en cours de migration vers une nouvelle version, les écrans peuvent donc être différents, le doc sera prochainement mise à jour

Configurer chaque Utilisateur

Premier onglet : Destinataire

Dans cet onglet, il est spécifié le nom du destinataire du message.

Ce peut être le prénom du destinataire par exemple.

Dans une √©volution prochaine du plugin, il est √† l’√©tude de pouvoir utiliser des groupes de personnes (Parents, enfants…) cela n’est pas encore impl√©ment√©.

Configurer les actions de notifications

Deuxième onglet : Notifications

Une notification est principalement une commande action qui va aller chercher la commande d’un autre plugin pour lancer une action.

Par exemple :

  • L’envoi d’un mail via le plugin mail
  • L’envoi d’un Push via le plugin PushOver
  • L’envoi d’un SMS via le plugin Free SMS
  • L’envoi d’une alerte vocale via le plugin Alexa-API
  • L’allumage d’une consigne ou d’une lumi√®re

Les commandes actions seront s√©lectionn√©es dans la fen√™tre qui s’ouvre apr√®s avoir appuy√© sur le bouton

Mais les notifications peuvent également être des commandes de clignotement de lumières ou tout moyen sonore ou lumineux pour prévenir un utilisateur.

Une notification peut √©galement √™tre le lancement d’un sc√©nario ou un changement de variable (qui serait test√©e par un autre plugin ou un sc√©nario par exemple), toutes les commandes Jeedom sont disponibles en appuyant sur le bouton

Pr√©cisions importantes sur l’utilisation des champs Titre et Message

La plupart des plugins de notification utilisent les champs Titre et Message. Mais parfois, les d√©veloppeurs ne respectent pas ce format standard et il se peut que les champs soient invers√©s ou un des deux absents. Il est donc pr√©vu dans Informe une mani√®re simple de r√©cup√©rer les valeurs Titre et Message qu’il faut envoyer au destinataire. Elles sont r√©cup√©rables gr√Ęce aux balises : #titreInforme# et #messageInforme#.

Ainsi, dans les actions de notifications, vous avez deux manières de fonctionner :

  • Soit, vous mettez le titre et le message dans l’√©cran de configuration de la notification, dans ce cas, c’est ce que vous venez d’√©crire qui sera envoy√© au destinataire, cette mani√®re de faire ne permet pas de personnaliser le message.
  • Soit, (recommand√©) vous inscrivez #titre# dans la case titre et #message# dans la case du message. Avec ce mode, ce sont les valeurs titre et message qui seront sp√©cifi√©es dans le sc√©nario de notification qui seront transmises au destinataire.

Encore plus fort : Si on veut utiliser un message (donc en dur) ainsi qu’une balise (donc variable), cela fonctionne, par exemple, mettez :

  • dans le champ Titre : Jeedom t’informe : #titreInforme#, ainsi, “Jeedom t’informe :” sera toujours pr√©sent et titre sera h√©rit√© de la commande de d√©clenchement.

Configurer les lieux

Troisième onglet : Lieux

C’est sur ce troisi√®me et dernier onglet que la configuration de la mani√®re dont le plugin Informe va contacter l’utilisateur se configure, cela en fonction de la priorit√© de notification et l’horaire de la notification.

Première étape, définir les lieux

Spécifiez pour chaque utilisateur les lieux dans lesquels il peut se trouver.

Pour cela, il existe 2 méthodes, vous pouvez en choisir une ou les mixer, le plugin accepte tout.

Pour choisir la m√©thode que vous allez utiliser, r√©fl√©chissez √† la mani√®re dont vous allez r√©cup√©rer l’information du lieu o√Ļ se trouve l’utilisateur.

1er cas (méthode manuelle)

Si vous avez un plugin ou sc√©nario qui est en capacit√© de vous envoyer une commande de changement de Lieu, vous allez int√©grer dans le processus de ce plugin ou sc√©nario le lancement de la commande “Voiture” (que nous allons cr√©er) pour dire √† Informe que l’utilisateur est dans sa voiture ou vous allez int√©grer la commande “Maison” pour dire √† Informe que l’utilisateur est rentr√© chez lui.

Dans cet exemple d’utilisation, cliquez sur puis ajoutez la commande “Voiture” puis cliquez √† nouveau sur le m√™me bouton pour ajouter la commande “Maison”. A l’enregistrement, la Commande info “Lieu” apparait automatiquement :

Ainsi le lancement de la commande “Voiture” affectera “Voiture” √† Lieu.

2ème cas (méthode automatique)

Si vous pouvez savoir o√Ļ se trouve votre utilisateur par un calcul, c’est le plugin qui changera automatiquement le lieu de l’utilisateur quand ce calcul donnera comme r√©sultat “vrai”.

Pour v√©rifier les calculs, sur la droite, un petit pouce indique si le r√©sultat est “vrai” ou pas. Attention quand on se trouve sur l’√©cran de configuration ces pouces ne changent pas tout seuls, il faut cliquer sur Save pour actualiser la page.

Si plusieurs calculs sont √† “vrai”, c’est le lieu le plus haut dans le tableau qui sera utilis√© par Informe.

Si aucun calcul ne donne le r√©sultat “vrai”, il faudra pr√©voir d’int√©grer en bas de tableau un Lieu qui sera utilis√© dans ce cas, et pour qu’il soit toujours √† vrai, il faudra mettre 1 dans la case calcul.

Seconde étape, configurer chaque lieu ainsi créé

Une fois les lieux d√©finis, c’est sur chaque lieu qu’on va d√©finir la mani√®re dont le plugin Informe va trouver la bonne mani√®re de contacter le destinataire.

Le bouton “Configurer ce lieu” permet sur chaque ligne d’ouvrir l’√©cran de configuration.

Lors de la premi√®re ouverture, l’√©cran ressemble √† cela :

Sur la 1ere colonne, en vert, on découvre les 3 niveaux de priorité définis par défaut :

  • Informe
  • Notifie
  • Alerte

Ces niveaux sont modifiables, supprimables et vous pouvez ajouter vos propres niveaux. Si vous ne souhaitez pas faire de diff√©rence entre les lieux, utilisez un seul lieu que vous pouvez nommer “Partout”.

Sur la 1ère ligne, en bleu, on découvre les 2 horaires définis par défaut :

  • Jour (de 07h √† 20h59)
  • Nuit (de 21h √† 06h59)

Ces horaires sont modifiables, supprimables et vous pouvez ajouter vos propres horaires. Si vous ne souhaitez pas faire de diff√©rence entre les horaires, utilisez un seul horaire que vous pouvez nommer “Tout le temps”.

Ces deux boutons sont disponibles, le bouton + vert permet d’ajouter une action, le bouton bleu permet de tester les actions que vous venez d’ajouter.

Un exemple valant tous les discours, voici un exemple de configuration d’un Lieu, chacun adaptera √©videmment :

Ainsi, on comprend que si on est le jour et qu’on demande au plugin d’informer Sigalou, il enverra un message sur tous les Alexa de la maison. Apr√®s 21h par contre, il ne d√©clenchera que l’Alexa de la Chambre.

  • Pour ajouter une nouvelle action, il faut cliquer sur le bouton + vert de la case concern√©e
  • Pour supprimer une action, il suffit de cliquer dessus

Utiliser les commandes dans vos scénarios

Quand tout est configuré, vous pouvez donc utiliser les commandes Informe. Ces commandes correspondent aux priorités de notification. Dans les exemples de configuration, nous avons utilisé comme priorité de notification :

  • Informe
  • Notifie
  • Alerte

Ainsi, dans cet exemple d’utilisation, vous retrouverez 3 commandes qui soit Informe, Notifie ou Alerte.

Sur l’image ci-dessus, nous retrouvons donc :

  • [Equipements internes] c’est l’objet parent sp√©cifi√© dans l’onglet Destinataire
  • [Sigalou] c’est le nom du Destinataire
  • [Alerte] c’est la commande qui correspond √† la priorit√© de notification Alerte.

Autres ressources

Laisser un commentaire