Notifications Dot.
Configuration du compte
Section intitulée « Configuration du compte »- Ouvrez l’application mobile Dot. et récupérez votre jeton API (
dot_app_...) ainsi que le numéro de série de l’appareil (chaîne hexadécimale de 12 caractères). - Dans l’application, activez le contenu Text API et/ou Image API pour l’appareil.
- Utilisez le jeton et l’identifiant de l’appareil avec les URLs
dot://ci-dessous pour déclencher des notifications.
La syntaxe valide est la suivante :
dot://{token}@{device_id}/dot://{token}@{device_id}/?mode=image
Le mode par défaut est text. En mode texte, le corps et le titre sont envoyés vers l’API texte, et toute pièce jointe ou paramètre image= est envoyé vers l’API image. Lorsque les deux sont présents, le texte est envoyé en premier, puis l’image.
Comportement des modes
Section intitulée « Comportement des modes »| Mode | Comportement |
|---|---|
text (défaut) | Le corps et le titre vont vers l’API texte. Toute pièce jointe ou paramètre image= va également vers l’API image. Lorsque les deux sont présents, le texte est envoyé en premier, puis l’image. |
image | Seule l’API image est appelée. Le corps et le titre sont ignorés. Requiert image= ou une pièce jointe. |
Prise en charge des pièces jointes
Section intitulée « Prise en charge des pièces jointes »- Mode texte (défaut) : La pièce jointe est envoyée comme image plein écran (PNG 296×152) vers l’API image. Si un corps ou un titre est également présent, le texte est envoyé en premier. Le paramètre URL
icon=peut toujours être utilisé indépendamment pour définir l’icône de coin (40×40) dans la carte texte. - Mode image : La première pièce jointe est utilisée comme image plein écran (PNG 296×152) si aucun
image=n’est fourni dans l’URL. - Dans tous les modes, seule la première pièce jointe est utilisée ; les pièces jointes supplémentaires déclenchent un avertissement.
- Si
image=est déjà fourni dans l’URL, les pièces jointes sont ignorées.
Détail des paramètres
Section intitulée « Détail des paramètres »| Variable | Requis | Description |
|---|---|---|
| token | *Oui | Jeton API Dot. (dot_app_...) |
| device_id | *Oui | Numéro de série de l’appareil Dot. (12 caractères hexadécimaux) |
| mode | Non | text (défaut) ou image. Détermine quel point d’API est utilisé. En mode text, les deux APIs peuvent être appelées lors d’un seul envoi. |
| refresh | Non | Mettre à no pour différer l’affichage jusqu’au prochain rafraîchissement planifié (défaut : yes) |
| title | Non (texte) | Titre affiché sur l’appareil |
| message | Non (texte) | Texte du corps affiché sur l’appareil |
| signature | Non (texte) | Texte de pied de page affiché sur l’appareil |
| icon | Non (texte) | Icône PNG en base64 (40×40) pour le coin inférieur gauche de la carte texte. |
| image | Oui (image) | Image PNG en base64 (296×152) affichée en plein écran. Peut être fourni via le paramètre URL ou la première pièce jointe (convertie automatiquement). |
| link | Non | Cible de tap-to-interact (http/https ou schéma personnalisé) |
| border | Non (image) | 0=cadre blanc (défaut), 1=cadre noir |
| dither_type | Non (image) | DIFFUSION (défaut), ORDERED, ou NONE |
| dither_kernel | Non (image) | FLOYD_STEINBERG (défaut), THRESHOLD, ATKINSON, BURKES, SIERRA2, STUCKI, JARVIS_JUDICE_NINKE, DIFFUSION_ROW, DIFFUSION_COLUMN, DIFFUSION_2D |
| task_key | Non | Indique quel emplacement de contenu mettre à jour lorsque plusieurs contenus Text ou Image API existent sur un appareil |
Paramètres Globaux
Section intitulée « 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
Section intitulée « Exemples »Envoyer un rappel texte :
apprise -vv -t "Routine du matin" -b "N'oubliez pas d'arroser les plantes" \ "dot://dot_app_TOKEN@A1B2C3D4E5F6/?signature=Apprise"Envoyer texte et image ensemble (texte en premier, puis image) :
apprise -vv -t "Routine du matin" -b "N'oubliez pas d'arroser les plantes" \ -a /chemin/vers/image.png \ "dot://dot_app_TOKEN@A1B2C3D4E5F6/"Mettre à jour un emplacement spécifique avec task_key :
apprise -vv -t "Statut serveur" -b "Tous les systèmes opérationnels" \ "dot://dot_app_TOKEN@A1B2C3D4E5F6/?task_key=moniteur_statut"Envoyer une carte image (via paramètre URL) :
apprise -vv \ "dot://dot_app_TOKEN@A1B2C3D4E5F6/?mode=image&image=$(base64 -w0 affiche.png)&link=https://example.com"Envoyer une carte image via pièce jointe :
apprise -vv -a /chemin/vers/image.png \ "dot://dot_app_TOKEN@A1B2C3D4E5F6/?mode=image&link=https://example.com" Questions ou commentaires ?
Documentation
Vous avez repéré une faute de frappe ou une erreur ? Signalez-la ou proposez une correction .
Problèmes Techniques
Vous rencontrez un problème avec le code ? Ouvrez un ticket sur GitHub :
Conçu avec amour depuis le Canada