Telegram @InflumanBot

Installation

Notifications et interactions entre Telegram & Eedomus via eedomusBot Notifications (@InflumanBot )

Telegram est une messagerie instantanée cryptée gratuite, telle que Whatsapp.
Un Bot Telegram est un programme personnalisé simplifié (un robot) et intégré à la messagerie afin d'automatiser certaines tâches et intéractions.
Le Bot eedomus est fourni gratuitement et ouvert à tous les propriétaires d'une eedomus. Vous n'avez pas à créer votre propre Bot dans Telegram.

Ce plugin vous permet notamment d'utiliser le robot eedomusBot de Telegram pour :

• Envoyer des notifications textuelles personnalisables d'eedomus vers Telegram, à l'instar de l'envoi d'un sms ou d'un push notification
• Envoyer des photos snapshot de vos caméras IP vers Telegram (incluant les caméras gérées par Surveillance Station)
• Recevoir les questions du plugin Ask dans Telegram et y répondre facilement via des boutons
• Recevoir des notifications personnalisées incluant des boutons de réponses personnalisés (Callback)
• Monitorer les statuts de plugins existants : Délestage électrique...
• Envoyer des ordres à l'eedomus depuis Telegram (via plugin ChatBot ou des raccourcis API, ou Callback)
• Enregistrer la capture d'une caméra dans un FTP eedomus
• Envoyer un email avec la capture d'une caméra
• Envoyer notifications et photos sur des smartphones secondaires

L'application Telegram est nativement intégrée dans les systèmes Carplay et Android Auto pour voir vos notifications en voiture.

Installation Telegram et inscription au Bot eedomus :

• Installez sur votre smartphone l'application Telegram (il est associé à votre numéro de téléphone)
• Sur Telegram, cherchez le Bot @InflumanBot ou "eedomus Notifications" et envoyez lui le message /start, puis /subscribe
• Notez l'InfluBotID d'inscription retourné, il faudra ensuite le renseigner dans ce plugin eedomus pour réaliser l'association

Le bot parlera avec vous dans la langue de votre inscription Telegram : français, espagnol ou anglais par défaut.

Une fois inscrit sur smartphone, vous pouvez aussi utiliser et tester le bot eedomus depuis web.telegram.org
Pour obtenir de l'aide de la communauté eedomus sur ce bot, rejoignez également le groupe Telegram eedomus-domotique-helpdesk (t.me/eedomus)

Installation du plugin eedomus

Cliquez sur "Configuration" / "Ajouter ou supprimer un périphérique" / "Store eedomus" / "Telegram @InflumanBot" / "Créer"

Voici les différents champs à renseigner:

• [Obligatoire] - Votre ID d'inscription InflumanBot [en VAR1]
• [Obligatoire] - Votre API User eedomus
• [Obligatoire] - Votre API Secret eedomus
• [Facultatif] - Le périphérique "Chatbot - Input" [en VAR2]
• [Facultatif] - Le périphérique "Ask - Response" [en VAR3]

Association au Bot

Une fois le plugin installé, lancez la valeur de notification "INFLUBOT_INIT" depuis l'interface eedomus pour associer votre compte eedomus au bot Telegram.
L'association est instantanée et vous devez être notifié côté Telegram.
Si vous n'avez pas de notification, vérifiez que vous avez bien saisi l'InflubotId côté eedomus.

Utilisation

Prédéfinissez des notifications dans les valeurs du périphérique créé par le plugin.
Respectez bien la forme des valeurs et l'url du script appelé, à l'instar des valeurs par défaut fournies à la création.
NB1 : Ne supprimez pas la valeur cachée 9999 - [CHATBOT], qui permet le lien avec le plugin du même nom.
NB2 : Ne supprimez pas la valeur cachée 99999 - [ASK], qui permet le lien avec le plugin du même nom.

• Vous pouvez intégrer dans la notification la valeur d'un ou plusieurs périphériques existants via son code API entre crochet, exemple : [123456].
• Vous pouvez sauter une ligne dans le message en utilisant [BR].
• Insérer la date [DATE] ou l'heure [TIME].
• Mettre en gras entre les balises [B] et [/B].
• Mettre en italique entre les balises [I] et [/I].
• Inclure des émoji en utilisant les codes Bytes UTF8 qu'on peut trouver ici : https://apps.timwhitlock.info/emoji/tables/unicode
• Envoyer un message "CALLBACK", c'est à dire avec des boutons de réponses associés (jusqu'à 4) pour exécuter une action eedomus: message [CALLBACK:textebouton1,periphid1,periphvalue1,textebouton2,periphid2,periphvalue2]
• Le periph_id d'un callback peut être également le code API d'une macro, dans ce cas, il faut préciser le code préfixé d'un M, et la valeur 1 : [CALLBACK:textebouton1,M123456,1]
• Le texte du bouton peut lui-même être la valeur d'un périphérique, il faut alors donner son code API : [CALLBACK:1234567,2345678,1]
• Envoyer une URL de snapshot de caméra pour afficher l'image dans Telegram avec le texte associé. Bien mettre user:pass avant l'adresse : Levée de doute Caméra [http://user:pass@ipcam:port/snapshot.jpg]
• Envoyer une capture issue du plugin Synology Surveillance Station (déjà installé en prérequis) en précisant le ou les numéros de la caméra : Caméra 1 et 2 [survstation:1,2]

Pour les Premium (déblocage depuis le bot et /premium) :

• Vous pouvez rajouter "&ftp" à la fin de l'url d'une capture caméra pour générer une sauvegarde en ftp eedomus en même temps : Levée de doute Caméra [http://user:pass@ipcam:port/snapshot.jpg&ftp]
• En ajoutant "&ftponly" au lieu de "&ftp", vous ne ferez que la sauvegarde FTP, il n'y aura pas de notification (utile pour les caméras avec envoi ftp inopérant)
• En ajoutant "&email" à la fin de l'url, mais avant "&ftp", un message email sera envoyé avec la capture en pièce jointe
• Pour les Callbacks, en ajoutant "&forcereset" à la fin de la formule, alors le message sera effacé au moment du choix de réponse, même si le mode général choisi est de conserver
• Pour les Callbacks, en ajoutant "&forcenoreset" à la fin de la formule, alors le message et boutons seront conservés au moment du choix, même si le mode général choisi est d'effacé le message

Des exemples sont disponibles par défaut à l'installation du plugin.

Lancez ensuite vos notifications depuis vos règles.
NB : Les caractères spéciaux sont remplacés automatiquement, et le caractère ° est remplacé par '

Avec le plugin Ask, Ask posera vos questions directement via ce bot Telegram, et vous pourrez répondre directement via les boutons Oui, Non et Snooze (en espagnol ou anglais également).
Avec le plugin ChatBot, vous pouvez directement écrire un message dans Telegram (ou le dicter à la voix), sans mot clé spécifique, pour interagir avec eedomus en fonction de vos paramètres ChatBot.
Le ChatBot peut également être paramétré en français, espagnol ou anglais (voir documentation du plugin)

Initialisation Chatbot et Ask (facultatif)

Deux cas de figures :

• vous aviez déjà installés les plugin Chatbot et Ask (et vous ne voulez pas tout réinstaller),
  alors vous les avez sélectionnés à l'installation de ce plugin, et vous devrez alors, dans les plugin Ask et Chatbot, changez le code API du périphérique de Notification à appeler avec celui-ci donc.
  Pour Ask, le code API du périphérique de notification est au niveau des URL d'appels sous la valeur &apiwh=123456.
  Au niveau du périphérique Ask-Statut, modifiez le paramètre &apiwh=123456 dans l'URL de la requête de polling.
  Dans les valeurs de Ask-Réponse, modifiez la donnée au niveau des paramètres des requêtes appelées : &action=reponse&type=set&value=RAWVALUE&apipb= &apiwh=123456 N'oubliez pas les valeurs cachées 97, 98 et 99
  Idem dans les valeurs de Ask-05-Question : &action=question&type=ask&value=RAWVALUE&delai=[VAR1]&canal=[VAR2]&apiu=xxxx&apis=yyyy&apipb= &apiwh=123456
  Il faut également changer VAR2 en "InflumanBot".

• vous n'aviez pas déjà installé les plugin Chatbot et Ask, ou l'un des deux, alors vous ne les avez pas sélectionnés à l'installation (puisque qu'inexistants).
  Après avoir installé ChatBot ou Ask, en ayant sélectionné ce plugin de notification Telegram à l'installation,
  vous devrez saisir les codes API respectifs des périphériques Chatbot-Input et Ask-Response dans VAR2 et VAR3 de ce plugin Telegram.

Une fois les liens chatBot et Ask réalisés, vous devez relancer la valeur de notification "INFLUBOT_INIT" pour synchroniser les données avec l'InflumanBot.
Un message Telegram vous confirmera l'association si tout s'est bien passé.

Monitoring des plugins - Apps messages

Un lien est réalisé entre ce plugin et d'autres plugins afin de suivre automatiquement les statuts dans Telegram en cas de déclenchement.

Application - Délestage électrique
* Si vous utilisez le plugin de Délestage électrique, il vous suffit de créer une notification Telegram spécifique, ainsi qu'une règle
* Créer la notification : [APPSDELESTAGE,1234567], où 1234567 est le code API du périphérique Délestage-Statut
* Créer une nouvelle règle "Délestage - Notification"
* En critères : Délestage-Mode est égal à Délestage en cours ET Délestage-Statut change de valeur
* En action : Notification-Telegram [APPSDELESTAGE,1234567]

A chaque délestage, le statut sera notifié dans Telegram. Pour éviter plusieurs messages à la suite, vous pouvez épingler le message dans Telegram (bouton épingle en dessous du message), ainsi il sera juste mis à jour pendant le cycle de délestage.

Autres applications à venir...

Les avantages par rapport au plugin de Notification IFTTT avec Telegram :

• Pas de lien avec IFTTT, donc réactivité instantanée
• La possibilité d'envoyer des images (avec backup ftp eedomus possible, et envoi d'email si premium)
• La possibilité de générer des notifications avec boutons Telegram de réponses intégrés (CALLBACK)
• Une interaction directe avec le chatbot
• Des interactions via raccourcis de saisie (premium)
• Des réponses au Ask via des boutons Telegram (Oui, Snooze, Non)
• Des notifications prédéfinies pour les plugins existants
• Des échanges Telegram cryptés de bout en bout
• Les messages du Bot automatiquement générés dans la langue de l'utilisateur (FR, ES, EN)

Divers

• Chatbot et Ask ne sont pas obligatoires pour profiter des notifications sur Telegram transmises par eedomus. Vous ne pourrez interagir que via CALLBACK (donc sollicité par eedomus) ou via les raccourcis créés (/shortcut).
• Si besoin, vous pouvez à tout moment supprimer définitivement l'association entre l'application Telegram sur votre téléphone et l'eedomus, en lançant INFLUBOT_RESET (valeur cachée par défaut par sécurité).
• Si besoin, vous pouvez suspendre temporairement l'association Telegram-Eedomus (INFLUBOT SUSPEND) puis la rétablir aisément sans réinscription (INFLUBOT REINSTATE)

Commandes spécifiques

Depuis le bot Telegram, les commandes spécifiques suivantes sont disponibles:

• /start : démarrer le robot
• /subscribe : inscription
• /info : vos infos d'inscription
• /help /aide /menu : le menu général avec toutes vos options
• /about : à propos et mentions légales
• /debugon et /debugoff : lancer le mode debug de vos interactions, stopper le mode debug
• /ackon et /ackoff : activer ou désactiver la confirmation de bonne exécution de requête API
• /nackon et /nackoff : activer ou désactiver la notification de non exécution de requête API

Pour les utilisateurs Premium (déblocage depuis le bot et /premium) :

• /mute et /unmute : permet de passer en mode silence. Aucune des notifications envoyées par l'eedomus ne sera restituée dans Telegram. Elles seront retournées pour information au moment de /unmute
• /api : utilisez l'api eedomus (pour les développeurs/testeurs)
• /shortcut : pour gérer les raccourcis de saisie (keyphrase) pour l'exécution directe d'une requête API (set periph_value) ou une question complète au chatBOT.
• /ftp:server,login,mdp : enregistrer un ftp eedomus (ex: /ftp:camera4.eedomus.com,camera01234,pass001)
• /email:email : enregistrer un email (ex: /email:monemail@serveur.fr)
• /secondary : gérer des comptes secondaires (pour associer d'autres comptes Telegram : ils recevront les mêmes notifications texte et photo, mais pas les callbacks)
• /callbackreseton et /callbackresetoff : permet de définir par défaut le choix d'effacer ou non les messages de callbacks dès qu'une réponse est sélectionnée (inopérant si un forcereset ou forcenoreset est positionné dans la notification initiale)
• /askoptionmsgnoaction : permet de ne pas afficher l'action prévue à expiration dans le message de Ask (même s'il y en a bien une de prévue côté eedomus)
• /askoptionmsgnoexpir : permet de ne pas afficher le jalon d'expiration dans le message de Ask
• /askoptionmsgall : permet d'afficher le message complet du Ask, tel que prévu côté eedomus
• /stats : vos statistiques de notifications envoyées par l'eedomus (depuis le 24/04/2022 v1.5)

L'enregistrement d'un ftp de caméra eedomus depuis Telegram est un prérequis à l'enregistrement simultané demandé lors de l'envoi d'une notification snapshot. Voir plus haut ("&ftp"). Si vous avez plusieurs caméras et plusieurs envois de captures différents, l'envoi ftp simultané par Telegram ne se fera que vers l'unique serveur paramétré. Préférez créer alors une caméra virtuelle dans l'eedomus pour servir de "déversoir" des différents captures transmises à Telegram.
Par ailleurs, tout envoi de photo depuis Telegram (photo du smartphone) sera alors poussé sur ce même ftp.

Exemple d'utilisation :

Voici un exemple concret avec la chronologie des évènements :

1/ eedomus détecte une intrusion et lance alors une notification dédiée de ce plugin.
Cette notification est paramétrée de cette façon :

[B]Intrusion détectée à [TIME] ! [/B] ([I][1576612][/I]) [CALLBACK:Lever le doute,1551496,5,Sirène maintenant,1551496,3,Fausse alerte,1551496,1,Désarmer l'alarme,1551496,1]

Elle inclut : un message en gras avec l'heure, un saut de ligne, le contenu du périphérique "Etat des ouvertures pour notification" en italique, ainsi que 4 actions au choix pour l'utilisateur (callback)

2/ J'appuie sur "Lever le doute" qui lance une notification dédiée de ce plugin pour fournir la capture d'une caméra, avec sauvegarde FTP en même temps :

Caméra Cour [http://login:pass@192.168.0.12/cgi-bin/snapshot.cgi&ftp]

3/ ou j'appuie sur "Désarmer l'alarme" car c'est moi qui rentre. La règle eedomus prévoit de lancer une notification dédiée pour confirmer le désarmement.

Tout ça depuis le smartphone donne cela en image :

Influman 2022 therealinfluman@gmail.com
eedomus-domotique-helpdesk

Le mode Premium a pour objectif de financer l'hébergement du bot Telegram sous OVH. Merci de votre support.
Paypal Me