Liens de flotte : commandes CLI

Créer un lien de flotte et recevoir son URL de Player.

fleet-links create --name NAME [--tag TAG]... [--field NAME=VALUE]... [--playlist-id ID] [--max-screens N]
                   [--expires-at TIME] [--disabled]

screenrig fleet-links create --name "Lobby displays" --tag Lobby --tag Floor2 --playlist-id pl_01EXAMPLEPLAYLIST000000

screenrig fleet-links create --name "Trade show" --field booth=A12 --expires-at 2026-12-31T23:59:59Z

L’enveloppe est le lien de flotte avec son URL Player dans data.url. Mettez cette URL dans le gestionnaire d’appareils. Après une création interrompue ou ambiguë, relancez la même commande dans les 24 heures : elle réutilise la clé d’idempotence enregistrée, et le serveur renvoie le même lien au lieu d’en créer un autre.

Lister les liens de flotte de ce projet, les plus anciens d’abord.

fleet-links list

screenrig fleet-links list

Un identifiant en lecture seule reçoit chaque data.items[].url vide avec url_redacted: true. --human imprime ID, LABEL, ENABLED, SCREENS, TAGS et LAST_USED, ajoute EXPIRES tant qu’un lien listé a une expiration et marque (expired) celui qui l’a dépassée, et n’imprime jamais l’URL. SCREENS est le nombre d’écrans créés par le lien, ou créé/max avec --max-screens ; les récupérations ne sont pas comptées.

Inspecter un lien de flotte et recevoir son URL de lecteur.

fleet-links show <id> [--android-provisioning]

screenrig fleet-links show flk_01EXAMPLELINK0000

screenrig fleet-links show flk_01EXAMPLELINK0000 --android-provisioning

screens_created compte les écrans créés par le lien, et last_used_at est la dernière fois qu’il en a créé ou récupéré un. expires_at est présent quand le lien a une expiration, et la sortie lisible le marque (expired) une fois celle-ci passée.

Avec --android-provisioning, data.id et data.provisioning remplacent les détails du lien. Le JSON contient le secret du lien : ne montrez son code QR qu’à la personne présente à l’appareil. Un identifiant en lecture seule ne reçoit aucune URL à partir de laquelle le construire et obtient fleet_link_secret_unavailable (sortie 3). Propriétaire de l’appareil Android par code QR liste la charge.

Modifier ce que donne un lien de flotte aux écrans qu’il crée désormais.

fleet-links update <id> [--name NAME] [--enable | --disable] [--tag TAG]... [--clear-tags]
                        [--field NAME=VALUE]... [--clear-fields]
                        [--playlist-id ID | --clear-playlist] [--max-screens N | --clear-max-screens]
                        [--expires-at TIME | --clear-expires-at] [--expect-rev REVISION]

screenrig fleet-links update flk_01EXAMPLELINK0000 --playlist-id pl_01EXAMPLEPLAYLIST000000

update modifie uniquement les champs que vous passez, et seulement pour les écrans que le lien crée à partir de maintenant. Les écrans déjà créés conservent leurs balises, liste de lecture et étiquette. Un lien expiré se comporte comme un lien désactivé tant que son expiration n’est pas déplacée ou supprimée. L’URL reste inchangée ; utilisez rotate pour la remplacer.

Remplacer l’URL d’un lien de flotte et recevoir la nouvelle.

fleet-links rotate <id> [--expect-rev REVISION]

screenrig fleet-links rotate flk_01EXAMPLELINK0000

L’enveloppe transporte la nouvelle URL dans data.url. L’ancienne URL cesse de fonctionner immédiatement : un appareil qui l’ouvre affiche son code de jumelage. Les écrans ayant déjà créé le lien continuent la lecture, car un Player jumelé ne présente jamais à nouveau le lien. Mettez la nouvelle URL dans le gestionnaire d’appareils. Après une rotation interrompue ou ambiguë, relancez la même commande : elle réutilise la clé d’idempotence enregistrée, et le serveur renvoie la rotation déjà effectuée au lieu d’en refaire une.

Supprimer un lien de flotte. Son URL cesse de fonctionner immédiatement, et les écrans qu’il a créés restent.

fleet-links delete <id> [--expect-rev REVISION]

screenrig fleet-links delete flk_01EXAMPLELINK0000

Les écrans dont le lien a été créé conservent leurs listes de lecture et leurs étiquettes.

Lister les plateformes que lit migrate, ce que chacune accepte et comment créer sa clé en lecture seule.

migrate vendors [VENDOR]

screenrig migrate vendors
screenrig migrate vendors files

Fonctionne hors ligne et n’exige aucune connexion. data.vendors contient, pour chaque plateforme, son id et son name ; inputs, avec les flags qu’elle accepte (chacun avec flag et required, et values pour une région) et les lignes credentials que contient son fichier de clé (name, secret, required et help) ; connect, les étapes pour créer une clé en lecture seule ; maps, ce qui est transféré ; skips, ce qui ne l’est pas ; docs ; et example, une commande migrate scan fonctionnelle. Les plateformes sont triées par identifiant, avec files en dernier. files accepte un dossier ou .zip et un fuseau horaire facultatif, et n’exige aucune clé.

Lire un compte d’affichage et indiquer ce qui peut et ne peut pas être transféré. Écrit scan.json et n’envoie rien à screenRIG.

migrate scan --from VENDOR [--url ADDRESS] [--region REGION] [--timezone ZONE] [--files PATH]
    [--credentials FILE] [--dir DIR]

screenrig migrate scan --from files --files ./signage-media
screenrig migrate scan --from files --files ./signage-media.zip --dir ./old-signage --timezone America/Toronto

Un flag que la plateforme n’accepte pas, ou qu’elle exige et qui manque, donne usage_error (sortie 2), qui nomme ce que la plateforme accepte. Aucun flag ne reçoit la clé elle-même. Un nouveau scan remplace scan.json et conserve map.json, et se termine avec 0 quand il est terminé, même si certains éléments ne peuvent pas être transférés.

data est le rapport : vendor, label, scanned_at, found et importable (comptes de media, playlists, layouts, schedules, groups et screens), not_imported (chacun avec kind, source_id, name, un reason et généralement une étape next), lossy (chacun avec kind, source_id, name et le change qui se produit en chemin), notes, dir et scan_file. Un fichier que la plateforme fournit se télécharge lors de apply. Un fichier qu’elle ne fournit pas, ou qu’elle ne fournit que sous forme de copie réencodée, est associé par nom dans --files ; sans correspondance, ou avec plusieurs, il figure dans not_imported ou lossy avec l’étape qui le règle.

--from files n’exige aucune clé et lit chaque fichier image, vidéo et audio d’après son contenu, et non son extension. Un playlists.csv facultatif à la racine a les colonnes playlist, file (un chemin ou un nom de fichier unique), duration (secondes) et order ; sans lui, chaque dossier qui contient des médias devient une liste de lecture dans l’ordre naturel des noms de fichiers, et les fichiers à la racine en forment une nommée d’après le dossier ou le zip. Un screens.csv facultatif a name, group (plusieurs séparés par ;), playlist et timezone, et chaque ligne devient un écran en attente avec ses groupes comme étiquettes. Les autres fichiers et les entrées zip chiffrées figurent dans not_imported. Un scan files n’a aucun horaire : créez-les avec campaign create une fois les listes de lecture créées.

Importer ce que le scan a trouvé : médias, listes de lecture et dispositions, écrans en attente et campagnes. Sans risque à relancer.

migrate apply [--dir DIR] [--dry-run] [--only KINDS] [--folder ID] [--canvas WIDTHxHEIGHT]
    [--credentials FILE] [--concurrency N] [--no-transcode]

screenrig migrate apply --dry-run
screenrig migrate apply --dir ./screenrig-migration-files
screenrig migrate apply --only media,playlists --concurrency 2

apply importe dans l’ordre : les médias dans un seul dossier, les listes de lecture et les dispositions, un écran en attente par ancien écran, et une campagne par horaire que les campagnes peuvent exprimer. La plateforme n’est relue que pour télécharger les fichiers de médias. Une liste de lecture a une page par élément : les images et les vidéos remplissent la toile, une adresse web devient une page iframe, l’audio devient la bande sonore et une liste de lecture imbriquée est intégrée. Une disposition devient une liste de lecture sur sa propre toile, avec une page par élément de sa zone principale. Un horaire qui se répète par mois, par année, par heure ou par minute, ou un jour de semaine numéroté du mois, ne peut pas devenir une campagne : scan le liste dans not_imported.

--dry-run ne lit que le projet et répond data.plan (pour media, playlists, layouts, screens et schedules : les comptes create, reuse, recreate, waiting et fail), data.items, data.bytes à télécharger, les comptes data.placeholders et data.project, les liens de flotte et les campagnes utilisés par rapport à leurs maximums de 50 et 100. La progression va vers stderr sous forme de lignes JSON (migrate_progress avec phase, done et total), ou sous forme de texte avec --human. Une réexécution réutilise ce qui existe encore, refait tout ce que vous avez supprimé et ne modifie jamais ce qu’elle a créé. Une exécution réelle répond data.applied (les mêmes comptes), data.waiting (éléments qui attendent un média ou une liste de lecture non importée, chacun avec un reason), data.failed, data.placeholders (une entrée par ancien écran avec ses source_id, name et state : linked, unlinked, paired, finished ou waiting), data.tags et data.folder_id.

Un groupe devient une étiquette composée de lettres et de chiffres, numérotée lorsqu’elle entre en collision avec une étiquette qu’un autre écran porte. Une campagne cible les étiquettes des groupes et des écrans que nomme son horaire, avec ses dates, jours, heures et sa priorité. Une campagne lit ses dates et ses heures dans le fuseau horaire propre à chaque écran et exige une liste de lecture par défaut (no_default_playlist) : scan signale les écrans qui en sont dépourvus, et screen assign la définit après le jumelage.

Un écran en attente est un lien de flotte d’un seul écran qui porte l’ancien nom, les groupes comme étiquettes et la liste de lecture. Une organisation compte au plus 50 liens de flotte dans l’ensemble de ses projets ; les autres sont unlinked dans data.placeholders et attendent un code de Player (migrate pair). Un Player qui ouvre un lien devient un écran, et exécuter apply à nouveau lui donne l’ancien nom et le fuseau horaire et supprime le lien. apply n’affiche jamais l’URL d’un lien de flotte : fleet-links show le fait.

Un élément en échec conserve ok true avec data.failed (chacun avec key, name, code, status et detail) et l’avertissement migration_items_failed ; les éléments qui en dépendent attendent, et le code de sortie suit le statut du dernier échec. Un fichier de médias qui échoue seul (une adresse expirée, une réponse qui n’est pas un fichier, un téléchargement qui devient silencieux) n’échoue que pour ce média ; pour une adresse expirée, exécutez migrate scan à nouveau. Un refus qui se répéterait pour chaque élément (quota_exceeded, campaign_limit_reached, insufficient_access, pending_review, la plateforme qui refuse la clé, une connexion perdue) met fin à l’exécution avec data.stopped (code, detail et next) et le code de sortie de ce problème. Corrigez la cause et exécutez de nouveau la même commande : elle reprend là où elle s’est arrêtée.

Jumeler un code de Player à un écran en attente, sous son ancien nom, avec sa liste de lecture, son fuseau horaire et ses étiquettes.

migrate pair <CODE...> --screen ID_OR_NAME [--dir DIR]

screenrig migrate pair ABC 234 --screen "Front desk"
screenrig migrate pair ABC234 --screen 3 --dir ./old-signage

Exécutez d’abord migrate apply : le jumelage a besoin de la correspondance et de la liste de lecture créées par cette commande. pair réclame le code pour l’écran sous son ancien nom, définit sa liste de lecture, son fuseau horaire et son champ migrated_from, définit ses étiquettes, supprime le lien de l’écran en attente et enregistre le résultat. data contient source_id, name, screen_id, steps (paired, updated, tagged, link deleted, recorded), next et, quand cette exécution a réclamé le code, public_url. Chaque étape est enregistrée au fur et à mesure, de sorte qu’une réexécution termine ce qu’un jumelage interrompu a laissé. Un écran déjà jumelé donne resource_conflict (sortie 5), qui le nomme. Le Player termine le jumelage la prochaine fois qu’il contacte le service ; screen show rapporte alors state active.