Aller au contenu

Voyant de notification Blink(1) USB LED

Aperçu

Blink(1) est un petit voyant USB RGB de notification fabrique par ThingM. Branchez-le sur n’importe quel port USB et Apprise pourra le faire clignoter dans une couleur correspondant au type de notification :

Type de NotificationCouleur
InfoBleu
SuccessVert
WarningJaune
FailureRouge

Le plugin communique directement avec l’appareil via USB HID a l’aide du paquet Python hidapi. Aucun service cloud, aucune API key et aucune connexion reseau ne sont necessaires.

blink1://
blink1://{serial}/
blink1://{serial}/?duration={ms}&fade={ms}&ledn={n}

Utilisez blink1://, ou blink1://_/, pour cibler le premier appareil connecte. Fournissez le numero de serie de l’appareil dans la position de l’hote si vous souhaitez viser un appareil precis lorsque plusieurs Blink(1) sont branches.

VariableObligatoireDescription
serialNonNumero de serie USB de l’appareil cible. Omettez cette valeur, ou utilisez _, pour viser le premier appareil disponible.
durationNonDuree, en millisecondes, pendant laquelle conserver la couleur de notification avant d’eteindre la LED. Valeur par defaut : 5000. Plage : 0 a 300000.
fadeNonDuree de transition en fondu, en millisecondes. 0 signifie instantane. Valeur par defaut : 0. Plage : 0 a 10000.
lednNonLED a adresser : 0 pour toutes, par defaut, 1 pour la premiere LED uniquement, 2 pour la seconde LED uniquement, sur les appareils mk2.
VariableDescription
overflowCe 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.
formatCe 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é.
verifyLes 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.
ctoSignifie 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.
rtoSignifie 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.
emojisActive 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.
tzIdentifie 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.

Faire clignoter le premier Blink(1) connecte avec les valeurs par defaut, bleu, instantane, 5 s :

Fenêtre de terminal
apprise -vv -t "Deploy finished" -b "All checks passed." \
blink1://

Cibler un appareil precis et utiliser un fondu de 250 ms avec un maintien de 2 secondes :

Fenêtre de terminal
apprise -vv -n warning -b "Disk almost full." \
"blink1://ABCD1234/?fade=250&duration=2000"

N’allumer que la deuxieme LED sur un appareil mk2 :

Fenêtre de terminal
apprise -vv -n failure -b "Build failed." \
"blink1://?ledn=2"
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