Aller au contenu

18 · Annexe

Ouvrage de référence. Les tableaux sont dérivés du code du firmware – à maintenir à jour lors des changements de code.

Modes de lecture

Ce que signifient les différents modes au quotidien – avec icône et description – est décrit au chapitre 8 → les modes de lecture. On ne trouve ici que les identifiants techniques, tels qu'ils apparaissent dans les messages MQTT, dans l'API REST et dans backup.txt.

Catégorie ID Constante
Titre unique 1 / 2 / 12 SINGLE_TRACK / _LOOP / _OF_DIR_RANDOM
Livre audio (position mémorisable) 3 / 4 / 16 AUDIOBOOK / _LOOP / _RECURSIVE
Dossier trié 5 / 7 / 15 ALL_TRACKS_OF_DIR_SORTED / _LOOP / _RECURSIVE
Dossier aléatoire 6 / 9 / 17 ALL_TRACKS_OF_DIR_RANDOM / _LOOP / _RECURSIVE
Sous-dossier aléatoire 13 / 14 RANDOM_SUBDIRECTORY_… (trié / aléatoire)
Radio web 8 WEBSTREAM
m3u local 11 LOCAL_M3U
MediaHub 18 MEDIAHUB
Interne 0 / 10 NO_PLAYLIST / BUSY

Cartes de modification

Cartes qui déclenchent une fonction plutôt que de la musique. Le catalogue complet en langage courant – classé par thème – se trouve au chapitre 8 → cartes de modification.

ID Effet
100 Verrouiller boutons + encodeur
101 / 102 / 103 / 104 Sommeil après 15 / 30 / 60 / 120 min (+ atténuation LED)
105 Sommeil à la fin du titre
106 Sommeil à la fin de la playlist
107 Sommeil après 5 titres
110 / 111 Boucle playlist / titre
120 Mode nuit LED (luminosité)
130 Wi-Fi activer/désactiver
140 / 141 / 142 Récepteur BT / source BT / changer de mode
150 Activer le serveur FTP
151 / 152 Annoncer l'adresse IP / l'heure
153 Basculer l'éclairage d'ambiance
154 / 155 Luminosité LED + / −

Commandes de contrôle (boutons / molette / MQTT)

Ce que fait chaque bouton par défaut est listé au chapitre 9 → boutons et combinaisons de boutons ; les commandes s'attribuent au chapitre 8 → molette rotative & boutons.

ID Commande
170 Play/Pause
171 / 172 Titre précédent / suivant
173 / 174 Premier / dernier titre
175 / 176 / 177 Volume : initial / + / −
178 Mesurer la tension de la batterie
179 Veille profonde (immédiate)
180 / 181 Avancer / reculer (distance de saut réglable dans l'interface web)
182 / 183 Arrêt / redémarrage
184 / 185 Dossier suivant / précédent (modes récursifs)
186 Prévisualisation de position (geste de la molette rotative uniquement)

Cartes RFID virtuelles

Leur utilité et la façon de les déclencher sont expliquées au chapitre 12 → cartes RFID virtuelles.

Les identifiants 241250 correspondent aux cartes 900000000001900000000010.

Topics MQTT

Modèle : [<base_topic>/]device_id/topic[/<setter_token>]. Les commandes utilisent le jeton de réglage (set par défaut), les topics d'état sont publiés sans lui. Tous les topics sont non retenus (non-retained).

Topic Direction / plage de valeurs Signification
sleep Cmnd 0/OFF ; State ON/OFF Extinction / état d'alimentation
rfid 12 chiffres Émuler une carte / carte actuelle
trackcontrol 1–9 Stop/Play/Pause/Next/Prev/First/Last/dossier±
loudness 0…max Définir/signaler le volume
sleep_timer EOP/EOT/EO5T/minutes/0 Définir/signaler la minuterie de sommeil
sleep_timer_state JSON (état) {mode,remainingMinutes,remainingTracks} ; mode = OFF/MINUTES/EOT/EOP/EO5T
lock_controls ON/OFF Verrouiller les commandes
repeatmode 0–3 aucune / titre / playlist / les deux
led_brightness 0–255 Luminosité des Neopixels
ambient_light ON/OFF Éclairage d'ambiance
track State Titre actuel
cover_changed State La pochette a peut-être changé
state Online/Offline État de fonctionnement
ipv4 State Adresse IP
pauseplay idle/play/pause État de lecture
playmode State Mode de lecture numérique
wifi_rssi State Signal Wi-Fi (dBm)
software_revision State Révision du firmware
battery_voltage / battery_soc State Tension / charge % (si la mesure de batterie est active)

Exemple : sleep_timer_state

Le topic sleep_timer_state renvoie la minuterie de sommeil sous forme d'objet JSON. Selon le mode, soit remainingMinutes, soit remainingTracks est renseigné (l'autre champ vaut 0) :

{"mode":"OFF","remainingMinutes":0,"remainingTracks":0}
{"mode":"MINUTES","remainingMinutes":29,"remainingTracks":0}
{"mode":"EOT","remainingMinutes":0,"remainingTracks":1}
{"mode":"EO5T","remainingMinutes":0,"remainingTracks":3}
{"mode":"EOP","remainingMinutes":0,"remainingTracks":7}

mode vaut soit OFF (aucune minuterie), MINUTES (minutes restantes), EOT (fin du titre), EO5T (après cinq titres) ou EOP (fin de la playlist). Pour EO5T/EOP, remainingTracks compte les titres restants.

API REST

L'API REST complète est maintenue sous forme de spécification OpenAPI directement dans le dépôt du firmware : REST-API.yaml. Elle reste ainsi synchronisée avec le code. (Ajout possible plus tard : l'intégrer au manuel sous forme de page Swagger interactive.)

Liens vers les fils de discussion du forum

(Tous les liens du forum ci-dessus sont en allemand.)

Changelog

Le changelog actuel est maintenu dans le dépôt du firmware et complété en continu à cet endroit : changelog.md sur la branche dev – correspondant à l'état décrit par ce manuel. La version sur la branche master ne contient que ce qui a déjà été publié sous forme de version stable.