Notifications Enigma2

Aperçu

• Prise en charge des images: Non
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • Corps: 1000
• Créer votre URL Apprise

Configuration du Compte

Un E2OpenPlugin appele OpenWebif vous permet de communiquer avec vos appareils Enigma2, comme Dreambox, Vu+, etc., a l’aide d’une API.

Une fois OpenWebif installe, Apprise peut utiliser son API pour envoyer des notifications a votre appareil Enigma2.

Les instructions d’installation d’OpenWebif sur votre appareil Enigma2 sont disponibles sur sa page GitHub.

Syntaxe

La syntaxe valide est la suivante :

• enigma2://{host}
• enigma2://{host}/{fullpath}
• enigma2://{host}:{port}
• enigma2://{host}:{port}/{fullpath}
• enigma2://{user}@{host}
• enigma2://{user}@{host}/{fullpath}
• enigma2://{user}@{host}:{port}
• enigma2://{user}@{host}:{port}/{fullpath}
• enigma2://{user}:{password}@{host}
• enigma2://{user}:{password}@{host}/{fullpath}
• enigma2://{user}:{password}@{host}:{port}
• enigma2://{user}:{password}@{host}:{port}/{fullpath}
• enigma2s://{host}
• enigma2s://{host}/{fullpath}
• enigma2s://{host}:{port}
• enigma2s://{host}:{port}/{fullpath}
• enigma2s://{user}@{host}
• enigma2s://{user}@{host}/{fullpath}
• enigma2s://{user}@{host}:{port}
• enigma2s://{user}@{host}:{port}/{fullpath}
• enigma2s://{user}:{password}@{host}
• enigma2s://{user}:{password}@{host}/{fullpath}
• enigma2s://{user}:{password}@{host}:{port}
• enigma2s://{user}:{password}@{host}:{port}/{fullpath}

Détail des Paramètres

Variable	Obligatoire	Description
hostname	Oui	Adresse IP ou nom d’hote de l’appareil Enigma2.
port	Non	Port sur lequel votre serveur web ecoute. La valeur par defaut est 80 pour enigma2:// et 443 pour toutes les references enigma2s://.
user	Non	Si votre systeme est configure pour utiliser HTTP-AUTH, vous pouvez fournir le username pour vous authentifier.
password	Non	Si votre systeme est configure pour utiliser HTTP-AUTH, vous pouvez fournir le password pour vous authentifier.
timeout	Non	Nombre de secondes pendant lesquelles la notification envoyee reste affichee a l’ecran. La valeur par defaut est 13.
fullpath	Non	Les personnes hebergeant ce service en interne peuvent souhaiter preciser le chemin, prefixe, sur lequel il ecoute.

Paramètres Globaux

Variable	Description
overflow	Ce paramètre peut être défini sur split, truncate ou upstream. Il détermine la manière dont Apprise remet le message que vous lui transmettez. Par défaut, il vaut upstream. 👉 upstream : ne fait aucune modification et transmet le message exactement tel qu’il a été reçu au service. 👉 truncate : veille à ce que le message tienne dans la limite amont documentée par le service. Si plus d’informations sont fournies que la limite définie, l’excédent est tronqué. 👉 split : similaire à truncate, sauf que si le message dépasse la limite amont documentée par le service, il est découpé en plusieurs morceaux plus petits puis envoyés séquentiellement.
format	Ce paramètre peut être défini sur text, html ou markdown. Certains services prennent en charge plusieurs formats de publication du contenu. La valeur par défaut varie selon le service choisi et peut correspondre à l’un de ces trois formats. Vous pouvez facultativement forcer cette option pour vous écarter du comportement par défaut. Si le service ne prend pas en charge plusieurs formats de transmission, ce champ est ignoré.
verify	Les requêtes externes vers des emplacements sécurisés, par exemple via https, utilisent des certificats. Par défaut, Apprise vérifie la validité de ces certificats ; si ce n’est pas le cas, aucune notification n’est envoyée à la source. Dans certains cas, un utilisateur ne dispose pas d’une autorité de certification pour valider la clé ou fait simplement confiance à la source ; dans ce cas, vous pouvez définir ce drapeau sur no. Par défaut, il vaut yes.
cto	Signifie Socket Connect Timeout. Il s’agit du nombre de secondes pendant lesquelles Requests attend que votre client établisse une connexion avec une machine distante, ce qui correspond à l’appel connect() sur la socket. La valeur par défaut est de 4.0 secondes.
rto	Signifie Socket Read Timeout. Il s’agit du nombre de secondes pendant lesquelles le client attend que le serveur envoie une réponse. La valeur par défaut est de 4.0 secondes.
emojis	Active la prise en charge des emojis, par exemple :+1: qui sera traduit en 👍. Par défaut, cette option vaut no. Remarque : selon la configuration côté serveur, l’administrateur peut désactiver globalement la prise en charge des emojis ; mais par défaut, ce n’est pas le cas.
tz	Identifie le fuseau horaire de la base IANA que vous souhaitez utiliser. Par défaut, celui-ci est détecté à partir de la configuration du serveur qui exécute Apprise. Vous pouvez le définir sur des valeurs comme America/Toronto, ou sur tout autre fuseau correctement formaté correspondant à votre région.

Exemples

Envoyer une notification a notre appareil Enigma2 :

# Supposons que notre {hostname} soit dreambox
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   enigma2://dreambox

# Si votre service est heberge sous /enigma2, l'exemple suivant peut gerer cela :
# Supposons que notre {hostname} soit dreambox
# Supposons que notre {fullpath} soit /enigma2

apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "enigma2://dreambox/enigma2"

Manipulation des en-tetes

Certains utilisateurs peuvent avoir besoin d’en-tetes HTTP speciaux lors de l’envoi de leurs donnees vers leur serveur. Pour cela, il suffit d’ajouter un symbole moins, -, devant n’importe quel parametre precise dans votre URL.

# L'exemple ci-dessous definirait l'en-tete :
#    X-Token: abcdefg
#
# Supposons que notre {hostname} soit vu-device
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "enigma2://localhost/?-X-Token=abcdefg"

# Pour plusieurs en-tetes, il suffit d'ajouter plus d'entrees precedees d'un symbole moins :
# L'exemple ci-dessous definirait les en-tetes :
#    X-Token: abcdefg
#    X-Apprise: is great
#
# Supposons que notre {hostname} soit localhost
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "enigma2://localhost/path/?-X-Token=abcdefg&-X-Apprise=is%20great"