Flux
Un flux est des données tierces que screenRIG récupère et met en cache, comme la météo, les alertes, les taux et les titres. feeds get lit un document de flux, le même document qu’une carte intégrée avec les mêmes paramètres lit. La commande n’appelle jamais un fournisseur tiers.
feeds get#
Lire un flux une fois. Un flux sans document répond pending et son temps de nouvelle tentative.
feeds get <family> [--lat DEGREES --lon DEGREES] [--radius-km KM] [--min-magnitude N] [--hours N]
[--basins LIST] [--base CODE] [--symbols IDS] [--currency CODE] [--url URL]...
[--station ID] [--country CODE] [--category drug|food] [--region NAME] [--date YYYY-MM-DD]
[--provider tfl|entur|digitransit] [--stops IDS] [--system ID]
[--public] [--geocode NAME:VALUE]... [--min-severity LEVEL] [--max-severity LEVEL]
[--min-urgency LEVEL] [--min-certainty LEVEL] [--event NAME]... [--exclude-event NAME]...
[--sender NAME]... [--status STATUS]... [--scope SCOPE]... [--language TAG]...
[--area-unknown hide|show]| Paramètre | Type | Requis | Par défaut | Notes |
|---|---|---|---|---|
<family> | string | oui | aucun | weather, airquality, alerts, rates, crypto, earthquakes, cyclones, headlines, cap, tides, launches, drugalerts, respiratory, almanac, outdoorsafety, departures ou bikeshare. |
--lat DEGREES | number | par famille | aucun | Latitude, de -90 à 90, avec --lon. Obligatoire pour weather, airquality, alerts, earthquakes, outdoorsafety et bikeshare ; optionnelle pour cyclones, cap, tides et almanac. |
--lon DEGREES | number | par famille | aucun | Longitude, de -180 à 180, avec --lat. |
--radius-km KM | number | non | 500 pour earthquakes | earthquakes rayon, ou la zone cyclones, de 10 à 20 000 km. Nécessite --lat et --lon. |
--min-magnitude MAGNITUDE | number | non | 2.5 | earthquakes : magnitude minimale, de 0 à 9. |
--hours HOURS | number | non | 24 | earthquakes : fenêtre en heures, de 1 à 168. |
--basins LIST | string | non | tous les bassins | cyclones : bassins séparés par des virgules at, ep, cp, wp. |
--base CODE | string | non | EUR | rates : devise de base. |
--symbols IDS | string | oui, pour crypto | aucun | Identifiants ou symboles cryptos séparés par des virgules, au maximum 20. |
--currency CODE | string | non | usd | crypto : devise de cotation. |
--station ID | string | non | aucun | tides : un identifiant de station de prévision des marées de la NOAA, de sept lettres ou chiffres, comme 9414290. Sans lui, --lat et --lon choisissent la station la plus proche dans un rayon de 100 km. |
--country CODE | string | par famille | aucun | drugalerts : us, ca ou gb (obligatoire). respiratory : us ou gb (obligatoire). almanac : le pays ISO 3166-1 dont il liste les jours fériés. |
--category CATEGORY | string | non | drug | drugalerts : drug ou food. |
--region NAME | string | non | le pays entier | respiratory : un État, un territoire ou DC des États-Unis par nom ou code postal, ou l’Angleterre ou une région de l’UKHSA, au plus 48 caractères. |
--date YYYY-MM-DD | string | non | les jours autour d’aujourd’hui | almanac : un jour fixe. |
--provider PROVIDER | string | oui, pour departures | aucun | departures : le fournisseur de transport des arrêts, tfl, entur ou digitransit. |
--stops IDS | string | oui, pour departures | aucun | departures : un à quatre identifiants d’arrêt du fournisseur, séparés par des virgules, comme l’identifiant TfL StopPoint 940GZZLUOXC, les identifiants Entur NSR:StopPlace:337 et NSR:Quay:568, ou le gtfsId Digitransit HSL:1040129. |
--system ID | string | non | le système le plus proche | bikeshare : un identifiant de système de vélos en libre-service, comme Mobibikes_CA_Vancouver. Sans lui, le système listé le plus proche qui couvre --lat et --lon est utilisé. |
--url URL | string | oui, pour headlines | aucun | headlines : URL d’un flux RSS ou Atom. cap : URL d’une alerte CAP ou index ATOM/RSS ; répétez-la, au maximum 5 fois. |
--public | boolean | non | activé sans --url | cap : lire aussi les flux d’alerte publics qui couvrent --lat et --lon. Nécessite --lat et --lon. |
--geocode NAME:VALUE | string | non | aucun | cap : un code régional du lieu, tel que UGC:WAC033. Répétable. Nécessite --lat et --lon. |
--min-severity LEVEL | string | non | aucun | cap : uniquement les alertes au niveau ou au-dessus de minor, moderate, severe ou extreme. |
--max-severity LEVEL | string | non | aucun | cap : uniquement les alertes au niveau ou en dessous de minor, moderate, severe ou extreme. |
--min-urgency LEVEL | string | non | aucun | cap : uniquement les alertes au moins aussi urgentes : past, future, expected ou immediate. |
--min-certainty LEVEL | string | non | aucun | cap : uniquement les alertes au moins aussi certaines : unlikely, possible, likely ou observed. |
--event NAME | string | non | n’importe quel événement | cap : uniquement cet événement ; * correspond à n’importe quelle suite de caractères. Répétable. |
--exclude-event NAME | string | non | aucun | cap : exclure cet événement. Répétable. |
--sender NAME | string | non | n’importe quel expéditeur | cap : uniquement les alertes de cet expéditeur. Répétable. |
--status STATUS | string | non | Actual | cap : statut d’alerte à lire : Actual, Exercise, Test ou System. Répétable. |
--scope SCOPE | string | non | Public | cap : scope d’alerte à lire : Public, Restricted ou Private. Répétable. |
--language TAG | string | non | en pour almanac | cap : préférence de langue ; la première présente l’emporte. Répétable. almanac : l’édition de « Ce jour-là », parmi ar, bs, cs, de, en, es, fr, it, pt, ru, sv, tr, uk ou zh. |
--area-unknown MODE | string | non | hide | cap : une alerte communiquée uniquement par les codes régionaux que le lieu ne possède pas : hide ou show. |
screenrig feeds get weather --lat 49.25 --lon -123
screenrig feeds get rates --base EUR
screenrig feeds get crypto --symbols btc,eth --currency usd
screenrig feeds get earthquakes --lat 49.25 --lon -123 --radius-km 500 --min-magnitude 4 --hours 72
screenrig feeds get cyclones --basins at,ep
screenrig feeds get headlines --url https://example.com/news.xml
screenrig feeds get cap --lat 49.25 --lon -123 --geocode UGC:WAC033 --min-severity moderate --event '*warning'
screenrig feeds get cap --url https://example.com/alerts.atom --url https://example.com/other.xml
screenrig feeds get tides --station 9414290
screenrig feeds get drugalerts --country us --category food
screenrig feeds get respiratory --country us --region California
screenrig feeds get almanac --country CA --date 2026-12-25
screenrig feeds get departures --provider tfl --stops 940GZZLUOXC
screenrig feeds get bikeshare --lat 49.25 --lon -123
screenrig feeds get launchesweather, airquality, alerts, earthquakes, outdoorsafety et bikeshare exigent --lat et --lon, qui vont toujours ensemble ; earthquakes accepte aussi --radius-km, --min-magnitude et --hours, et bikeshare accepte --system. cyclones accepte --basins, et avec --lat, --lon et --radius-km ensemble, seulement les tempêtes proches de ce lieu. rates accepte --base, crypto exige --symbols et accepte --currency, et headlines exige --url. tides exige --station, ou --lat et --lon pour la station de prévision la plus proche. drugalerts exige --country et accepte --category, respiratory exige --country et accepte --region, et almanac accepte --country, --language, --lat, --lon et --date. departures exige --provider et --stops, et launches n’accepte aucun indicateur. Un indicateur que la famille n’accepte pas est refusé. Cartes intégrées décrit les données de chaque famille.
cap lit les alertes CAP correspondant à un lieu. Il nécessite --url (répétable, jusqu’à 5 URL d’index d’alertes CAP ou ATOM/RSS) ou --lat et --lon, qui lisent les flux publics couvrant l’emplacement ; --public ajoute ces flux publics aux sources --url. Les indicateurs de filtre reflètent les membres d’un objet triggers create --pull.
Un document mis en cache répond 200 avec fetchedAt et attribution : afficher l’attribution partout où les données apparaissent. Sans document encore, l’enveloppe rapporte l’état pending, retry_after_seconds et retry_at avec sortie 0 ; le CLI ne boucle pas, donc exécutez la commande à nouveau après retry_at. Une organisation enregistre au maximum 50 nouvelles clés de flux par jour, et rate_limited suit au-delà. Les cartes dérivent les clés de flux des paramètres statiques ; n’écrivez pas vous-même les clés feed ou feed:.
Sources de données
Une source de données lit une adresse extérieure selon un horaire et écrit le résultat dans les données d’une carte, de sorte que la carte reste à jour sans que personne ne republie et que les écrans récupèrent de nouveau le document quand il change. Les types sont ics, sheets, csv, json, microsoft365, google_calendar, square, shopify, toast et momentus. Une source alimente une carte, et une organisation en compte jusqu’à 200, tous projets confondus. Une synchronisation qui échoue n’écrit jamais : la carte garde son dernier bon document et le statut de la source affiche l’erreur. Les paramètres de chaque type, les codes de statut et les règles de confidentialité figurent dans Sources de données.
Un préréglage est une source json toute prête et testée pour un service, comme un canal Slack, un tableau d’offres d’emploi ou un tableau de construction : source presets les liste, source presets NAME montre les champs et les secrets d’un préréglage, et source create --preset NAME crée la source.
Donnez chaque identifiant sous la forme --secret NAME=@FILE, ou NAME=- pour l’entrée standard, afin qu’il reste hors de l’historique de votre shell et de la liste des processus. Les secrets sont stockés chiffrés et ne sont renvoyés que sous forme d’indice masqué. Les noms de secrets sont calendar_url.KEY pour ics (un par calendrier), token pour une adresse csv ou json qui en exige un (password, client_secret, header.NAME et query.NAME servent aux autres façons de se connecter, décrites sous Requêtes, connexion et pages), client_secret pour microsoft365 et toast, service_account_key pour google_calendar, access_token pour square et shopify, api_key et api_secret pour momentus, et client_secret avec le paramètre client_id pour une application shopify installée sur la boutique.
--settings prend l’objet complet des paramètres de la source en JSON, en @FILE ou en -. --set KEY=VALUE définit un membre de premier niveau et peut être répété; la valeur est du JSON lorsqu’elle s’analyse (days=14, calendars='[{"key":"lobby"}]') et du texte sinon (time_zone=America/Vancouver). Avec les deux, les membres de --set remplacent les mêmes membres de --settings; source update avec seulement --set modifie ces membres des paramètres enregistrés. L’option --config de la CLI nomme son fichier d’identifiants et n’a rien à voir avec les sources.
source list#
Liste les sources de données du projet, les plus récentes d’abord, avec leur statut.
source list [--after CURSOR]| Paramètre | Type | Requis | Par défaut | Notes |
|---|---|---|---|---|
--after CURSOR | string | non | première page | Le data.next_cursor de la page précédente. |
screenrig source listsource show#
Consultez une source : ses paramètres, ses secrets masqués, sa dernière exécution et sa dernière erreur.
source show <source_id>| Paramètre | Type | Requis | Par défaut | Notes |
|---|---|---|---|---|
<source_id> | string | oui | aucun | La source (src_…). |
screenrig source show src_01EXAMPLESOURCE000000source presets#
Liste les préréglages de source prêts à l’emploi, ou en affiche un avec ses champs, ses secrets et la façon de les obtenir.
source presets [<name>]| Paramètre | Type | Requis | Par défaut | Notes |
|---|---|---|---|---|
<name> | string | non | chaque préréglage | Le nom d’un préréglage : des mots en minuscules reliés par des traits d’union, comme slack-channel. |
screenrig source presets
screenrig source presets slack-channelLa liste montre le titre de chaque préréglage, les types de cartes qu’il alimente (le premier est celui pour lequel il est conçu) et sa catégorie. Un nom montre les champs à définir (--set NAME=VALUE : du texte avec son motif et un exemple, un choix, ou une liste qui prend un tableau JSON), les secrets à saisir (--secret NAME=@FILE) avec l’endroit où le fournisseur délivre chacun, la fréquence d’actualisation, la durée pendant laquelle une carte garde ses dernières données, et les données de qui il lit, selon quelles conditions. Rien n’est créé.
source create#
Créez une source. Elle s’exécute en quelques secondes, puis selon son horaire. Créez d’abord la carte et faites un aperçu avec source test.
source create (--kind KIND | --preset NAME) --card CARD_ID --name NAME [--settings JSON|@FILE|-] [--set KEY=VALUE]...
[--connection-id ID] [--secret NAME=VALUE]... [--refresh DURATION] [--stale-after DURATION|none] [--disabled]| Paramètre | Type | Requis | Par défaut | Notes |
|---|---|---|---|---|
--kind KIND | string | sans --preset | aucun | ics, sheets, csv, json, microsoft365, google_calendar, square, shopify, momentus ou toast. |
--preset NAME | string | sans --kind | aucun | Crée la source à partir d’un préréglage prêt à l’emploi et testé (source presets les liste) : --set et --settings donnent alors les champs du préréglage et --secret ses identifiants. Pas avec --kind. |
--card CARD_ID | string | oui | aucun | La carte (crd_…) que la source écrit. Une carte a une source; source_target_taken répond à une deuxième. |
--name NAME | string | oui | aucun | 1 à 80 caractères. |
--settings SETTINGS | string | non | {} | L’objet de paramètres complet de la source, en JSON, @FILE ou - pour stdin. Avec --preset, les champs du préréglage. |
--connection-id ID | string | non | aucun | microsoft365 et google_calendar : lisent par une connexion de projet (pcn_…, connection list) au lieu d’un locataire, de client_id et d’un secret propres à la source. Cela définit le paramètre connection_id. Incompatible avec --preset. |
--set KEY=VALUE | string | non | aucun | Un paramètre de premier niveau : JSON si la valeur s’analyse (days=14, calendars='[{"key":"lobby"}]'), texte sinon (time_zone=America/Vancouver). Répétable. Avec --preset, un champ du préréglage : le texte tel qu’écrit, sauf s’il s’agit d’un tableau ou d’un objet JSON (les éléments d’un champ liste). |
--secret NAME=VALUE | string | non | aucun | Un identifiant par nom : NAME=@FILE, NAME=- (au plus une option lit l’entrée standard) ou NAME=VALUE. Répétable. Avec --preset, les identifiants du préréglage. |
--refresh DURATION | string | non | selon le type | Fréquence de synchronisation, de 30s à 24h, par exemple 90s, 5m ou 1h30m. Le type fixe l’intervalle par défaut et le plus court : 5 minutes et 1 minute pour ics, sheets, csv et json ; 2 minutes et 1 minute pour microsoft365 et google_calendar ; 5 minutes et 2 minutes pour square, shopify et toast ; 1 minute et 30 secondes pour momentus. Un préréglage fixe le sien. |
--stale-after DURATION | string | non | selon le type | Durée pendant laquelle la carte garde les dernières bonnes données quand la source ne peut pas s'actualiser, de 1m à 7d, au moins le double de --refresh ; none les garde jusqu'à la prochaine actualisation. Ensuite, les données expirent sur chaque écran. momentus vaut 30m par défaut, et un préréglage fixe le sien. |
--disabled | boolean | non | désactivé | Crée la source à l’arrêt; rien n’est récupéré avant source update --enable. |
screenrig source create --kind ics --card crd_01EXAMPLECARD000000000 --name "Lobby calendar" --set calendars='[{"key":"lobby"}]' --set time_zone=America/Vancouver --secret calendar_url.lobby=@lobby.url
screenrig source create --kind sheets --card crd_01EXAMPLEMENU0000000000 --name "Cafe menu" --settings @menu-sheet.json
screenrig source create --kind json --card crd_01EXAMPLEKPI00000000000 --name "Daily numbers" --settings @kpi-api.json --secret token=@api.token
screenrig source create --kind square --card crd_01EXAMPLEMENU0000000000 --name "Counter menu" --secret access_token=@square.token
screenrig source create --kind microsoft365 --card crd_01EXAMPLEROOMS0000000000 --name "Meeting rooms" --settings @rooms.json --connection-id pcn_01EXAMPLECONNECTION0000
screenrig source create --preset slack-channel --card crd_01EXAMPLEWALL00000000000 --name "Team wall" --set channel=C0123456789 --secret token=@slack.tokensource update#
Modifiez une source. Un changement autre qu’un renommage remet son compteur d’échecs à zéro et la relance.
source update <source_id> [--name NAME] [--card CARD_ID] [--settings JSON|@FILE|-] [--set KEY=VALUE]...
[--connection-id ID] [--secret NAME=VALUE]... [--unset-secret NAME]... [--refresh DURATION]
[--stale-after DURATION|none] [--enable | --disable] [--expect-rev REVISION]| Paramètre | Type | Requis | Par défaut | Notes |
|---|---|---|---|---|
<source_id> | string | oui | aucun | La source (src_…). |
--name NAME | string | non | inchangé | Renomme la source. |
--card CARD_ID | string | non | inchangé | Écrire une autre carte. |
--settings SETTINGS | string | non | inchangé | Remplace tout l’objet de paramètres : JSON, @FILE ou - pour stdin. Pour une source créée à partir d’un préréglage, fusionne ces champs dans ses paramètres. |
--connection-id ID | string | non | inchangé | Comme pour source create. Détacher une source de ses propres identifiants exige --settings sans tenant ni client_id, et --unset-secret client_secret. |
--set KEY=VALUE | string | non | aucun | Modifie un paramètre de premier niveau parmi ceux enregistrés, comme pour source create. Répétable. Pour une source créée à partir d’un préréglage, un champ du préréglage ; la valeur null retire un champ facultatif. |
--secret NAME=VALUE | string | non | aucun | Définit ou remplace un secret. Répétable. Un secret que vous n’envoyez pas garde sa valeur, sauf si le changement pointe la source vers un endroit que ce secret ne couvre pas (autre origine, boutique, environnement ou locataire) : source_secret_required le redemande alors. |
--unset-secret NAME | string | non | aucun | Retire un secret. Répétable. |
--refresh DURATION | string | non | inchangé | De 30s à 24h ; le minimum du type s’applique. |
--stale-after DURATION | string | non | inchangé | Comme pour source create ; none supprime la période. |
--enable, --disable | boolean | non | inchangé | Reprend l’horaire, ou l’arrête; la carte garde son dernier document. Au plus une des deux. |
--expect-rev REVISION | integer | non | la révision lue | Refuse le changement sauf si la source est à cette révision. --set protège la révision lue, sauf si vous en nommez une autre. |
Au moins un changement est requis.
screenrig source update src_01EXAMPLESOURCE000000 --set days=14
screenrig source update src_01EXAMPLESOURCE000000 --secret calendar_url.lobby=@new.url --refresh 10m
screenrig source update src_01EXAMPLESOURCE000000 --disable
screenrig source update src_01EXAMPLEPRESET0000000 --set channel=C0123456789 --secret token=@new.tokensource test#
Prévisualisez une source sans rien enregistrer ni écrire : récupérer l’adresse, mettre la réponse en forme pour la carte et la vérifier auprès de la carte. L’enveloppe porte le document, valid, le chemin et la raison quand la carte le refuse, les avertissements et les compteurs. Passez un <source_id> enregistré pour le tester, les autres options remplaçant ses valeurs, ou --kind (ou --preset) et --card pour en tester un qui n’est pas enregistré. Un échec de récupération ou de mise en forme donne source_test_failed avec la raison. Une source csv ou json rapporte aussi la requête envoyée sous data.request : son adresse avec les paramètres substitués et les paramètres de requête secrets masqués, les noms des en-têtes envoyés, le début du corps et les pages lues. Au plus 30 aperçus par minute et par organisation.
source test [<source_id>] [--kind KIND | --preset NAME] [--card CARD_ID] [--settings JSON|@FILE|-] [--set KEY=VALUE]...
[--connection-id ID] [--secret NAME=VALUE]...| Paramètre | Type | Requis | Par défaut | Notes |
|---|---|---|---|---|
<source_id> | string | non | aucun | Une source enregistrée à tester. |
--kind KIND | string | sans <source_id> ni --preset | aucun | Comme pour source create. |
--preset NAME | string | non | aucun | Prévisualise une source créée à partir de ce préréglage, avec --set et --settings comme champs et --secret comme identifiants, au lieu de --kind. Incompatible avec <source_id>. |
--card CARD_ID | string | sans <source_id> | aucun | La carte à alimenter. |
--settings SETTINGS | string | non | les paramètres enregistrés | Les paramètres du type : JSON, @FILE ou - pour l’entrée standard. |
--connection-id ID | string | non | aucun | Comme pour source create. |
--set KEY=VALUE | string | non | aucun | Un paramètre de premier niveau, comme pour source create ; avec un <source_id>, il remplace ce paramètre parmi ceux enregistrés. Répétable. |
--secret NAME=VALUE | string | non | les secrets enregistrés | Un identifiant à essayer. Répétable. |
screenrig source test --kind ics --card crd_01EXAMPLECARD000000000 --set calendars='[{"key":"lobby"}]' --secret calendar_url.lobby=@lobby.url
screenrig source test src_01EXAMPLESOURCE000000
screenrig source test --preset slack-channel --card crd_01EXAMPLEWALL00000000000 --set channel=C0123456789 --secret token=@slack.tokensource refresh#
Synchronisez une source maintenant et affichez le résultat. Elle s’exécute en ligne jusqu’à 60 secondes, remet le compteur d’échecs à zéro et lit l’adresse en entier. Une synchronisation échouée ne modifie jamais la carte. source_busy (code de sortie 5) répond pendant qu’une synchronisation planifiée est en cours. Au plus 6 par minute et par source.
source refresh <source_id>| Paramètre | Type | Requis | Par défaut | Notes |
|---|---|---|---|---|
<source_id> | string | oui | aucun | La source (src_…). |
screenrig source refresh src_01EXAMPLESOURCE000000source rooms#
Vérifie comment les écrans correspondent aux salles d'une source de système de réservation (momentus). Elle lit les salles de la dernière bonne actualisation de la source et les écrans du projet, et ne récupère rien. Elle liste les salles et les zones qu'aucun écran n'affiche et chaque écran qui a une valeur de salle ou de zone ou dont la liste de lecture lit la clé de salle ou de zone de la source, chacun mapped, missing (la liste de lecture lit le champ et l'écran n'en a pas) ou unknown (la valeur ne désigne ni salle ni zone, avec celle qui était probablement visée). Corrigez un écran avec screen update scr_ID --field room=ROOM_KEY.
source rooms <source_id>| Paramètre | Type | Requis | Par défaut | Notes |
|---|---|---|---|---|
<source_id> | string | oui | aucun | Une source (src_…) qui lit les salles d'un système de réservation. |
screenrig source rooms src_01EXAMPLESOURCE000000source delete#
Supprimez une source. La carte garde le dernier document que la source a écrit.
source delete <source_id> [--expect-rev REVISION]| Paramètre | Type | Requis | Par défaut | Notes |
|---|---|---|---|---|
<source_id> | string | oui | aucun | La source (src_…). |
--expect-rev REVISION | integer | non | aucun | Refuse la suppression sauf si la source est à cette révision. |
screenrig source delete src_01EXAMPLESOURCE000000Connexions
Une connexion est l’accès enregistré du projet à Microsoft ou à Google, pour le travail qui s’exécute sans personne de connecté. Une source de données microsoft365 ou google_calendar (source create --connection-id), une connexion Power BI (bi connection create powerbi --connection-id) et un compte de synchronisation de médias SharePoint (media sync account add microsoft365 --connection-id) lisent par une connexion au lieu de porter chacun un locataire, un ID client et un secret. Un ID de connexion commence par pcn_, et une organisation compte jusqu’à 50 connexions pour l’ensemble de ses projets. Les modes, les statuts et les étapes d’approbation sont sur Connectez Microsoft et Google.
Le mode own_app détient votre propre application : pour Microsoft, une inscription d’application Microsoft Entra (--tenant-id, --client-id et la Value d’un secret client), pour Google, la clé JSON d’un compte de service. Le mode screenrig_app utilise l’application propre de screenRIG et n’a besoin d’aucun secret : create affiche un lien de consentement à usage unique (data.consent_url, qui expire à data.consent_expires_at) pour la personne qui le mène à terme, un administrateur Microsoft 365 qui donne son consentement pour le locataire, ou le titulaire d’un compte Google qui accorde un accès en lecture seule aux calendriers. Envoyez le lien à cette personne seulement, puis lisez status et last_error avec connection show. Une connexion Power BI n’accepte qu’une connexion own_app.
Donnez un secret client avec --secret-file FILE et une clé Google avec --service-account-key-file FILE, ou - pour l’entrée standard, jamais comme argument. La lecture exige l’accès Read, et tout changement exige l’accès Manage.
connection list#
Liste les connexions de ce projet avec leur statut.
connection listAucun paramètre.
screenrig connection listconnection show#
Consultez une connexion : son statut, sa dernière erreur et son dernier test.
connection show <id>| Paramètre | Type | Requis | Par défaut | Notes |
|---|---|---|---|---|
<id> | string | oui | aucun | La connexion (pcn_…). |
screenrig connection show pcn_01EXAMPLECONNECTION0000connection create microsoft#
Ajoutez une connexion Microsoft 365 : votre propre application Entra, ou l’application de screenRIG avec un lien de consentement.
connection create microsoft --mode own_app|screenrig_app [--name NAME]
[--tenant-id ID --client-id ID --secret-file FILE]| Paramètre | Type | Requis | Par défaut | Notes |
|---|---|---|---|---|
--mode MODE | string | oui | aucun | own_app : votre propre inscription d’application Microsoft Entra avec un secret client. screenrig_app : l’application de screenRIG, à laquelle un administrateur Microsoft 365 donne son consentement par le lien à usage unique qu’affiche cette commande. |
--name NAME | string | non | Microsoft 365 | 1 à 80 caractères. |
--tenant-id ID | string | avec own_app | aucun | Votre Directory (tenant) ID Microsoft Entra, ou son domaine principal, comme contoso.onmicrosoft.com. En même temps que --client-id et --secret-file. |
--client-id ID | string | avec own_app | aucun | L’Application (client) ID de l’inscription d’application. |
--secret-file FILE | string | avec own_app | aucun | Lit la Value du secret client depuis ce fichier, ou - pour l’entrée standard (jamais un argument) ; le fichier ne contient que la Value. |
screenrig connection create microsoft --mode own_app --tenant-id contoso.onmicrosoft.com --client-id 0b1d2f3a-4c5e-4f60-8a7b-9c0d1e2f3a4b --secret-file secret.txt
screenrig connection create microsoft --mode screenrig_app --name "Contoso rooms"Le mode screenrig_app n’accepte aucun de --tenant-id, --client-id ni --secret-file : il affiche le lien de consentement (data.consent_url) pour l’administrateur Microsoft 365, qui donne son consentement à l’application de screenRIG pour le locataire. L’inscription de l’application liste Calendars.Read pour les calendriers de salles de réunion, Sites.Selected ou Files.Read.All pour la synchronisation de médias SharePoint et, pour Power BI, les paramètres du locataire et l’appartenance à l’espace de travail au lieu des autorisations Graph ; connection test rapporte quelles autorisations le jeton porte. Un serveur sans l’application de screenRIG répond connection_app_not_configured : le mode own_app fonctionne toujours.
connection create google#
Ajoutez une connexion Google : votre propre clé de compte de service, ou l’application de screenRIG avec un lien de connexion.
connection create google --mode own_app|screenrig_app [--name NAME]
[--service-account-key-file FILE]| Paramètre | Type | Requis | Par défaut | Notes |
|---|---|---|---|---|
--mode MODE | string | oui | aucun | own_app : votre propre clé de compte de service. screenrig_app : l’application de screenRIG, à laquelle le titulaire d’un compte Google se connecte et accorde un accès en lecture seule aux calendriers par le lien à usage unique qu’affiche cette commande. |
--name NAME | string | non | Google Calendar | 1 à 80 caractères. |
--service-account-key-file FILE | string | avec own_app | aucun | Lit la clé JSON du compte de service depuis ce fichier, ou - pour l’entrée standard (jamais un argument). |
screenrig connection create google --mode own_app --service-account-key-file key.json
screenrig connection create google --mode screenrig_app --name "Venue calendars"En mode own_app, partagez chaque calendrier de salle avec l’adresse du compte de service, ou donnez à la source un sujet (délégation à l’échelle du domaine). Le mode screenrig_app n’accepte aucune clé et affiche le lien de connexion (data.consent_url) pour le titulaire du compte Google : le compte doit voir chaque calendrier de salle qu’une source liste, et une telle source ne peut pas nommer de sujet. Un serveur sans l’application de screenRIG répond connection_app_not_configured : le mode own_app fonctionne toujours.
connection update#
Renommez une connexion ou, en mode own_app, modifiez son locataire, son application ou son secret.
connection update <id> [--name NAME] [--tenant-id ID] [--client-id ID]
[--secret-file FILE] [--service-account-key-file FILE] [--expect-rev REVISION]| Paramètre | Type | Requis | Par défaut | Notes |
|---|---|---|---|---|
<id> | string | oui | aucun | La connexion (pcn_…). |
--name NAME | string | non | inchangé | Renomme la connexion. |
--tenant-id ID | string | non | inchangé | Microsoft own_app : le Directory (tenant) ID ou le domaine principal. |
--client-id ID | string | non | inchangé | Microsoft own_app : l’Application (client) ID. |
--secret-file FILE | string | non | inchangé | Microsoft own_app : lit la Value du secret client depuis ce fichier, ou - pour l’entrée standard ; elle remplace le secret stocké. |
--service-account-key-file FILE | string | non | inchangé | Google own_app : lit la clé JSON du compte de service depuis ce fichier, ou - pour l’entrée standard ; elle remplace la clé stockée. |
--expect-rev REVISION | integer | non | aucun | Refuse le changement sauf si la connexion est à cette révision (revision_conflict, sortie 6). |
screenrig connection update pcn_01EXAMPLECONNECTION0000 --secret-file new-secret.txt
screenrig connection update pcn_01EXAMPLECONNECTION0000 --name "Contoso rooms" --expect-rev 2Au moins un changement est requis. Un changement d’identifiants ramène la connexion à ready, efface sa dernière erreur et son dernier test, et retire tous les jetons émis pour les anciens : testez-la de nouveau. Une connexion screenrig_app ne peut qu’être renommée : connection connect crée un nouveau lien de consentement pour changer la personne qui a donné son consentement. Un secret omis est conservé.
connection test#
Ouvrez une session avec une connexion et vérifiez ce que ses identifiants permettent.
connection test <id>| Paramètre | Type | Requis | Par défaut | Notes |
|---|---|---|---|---|
<id> | string | oui | aucun | La connexion (pcn_…). |
screenrig connection test pcn_01EXAMPLECONNECTION0000Pour Microsoft, le test rapporte credentials (un jeton d’application pour le locataire) et permissions (lesquelles de Calendars.Read, Sites.Selected, Files.Read.All, Sites.Read.All et Place.Read.All le jeton porte ; aucune fait échouer le test, et Sites.Selected seule est un avertissement, car chaque site a besoin de sa propre autorisation). Pour Google, il rapporte credentials, en nommant le compte auquel les calendriers doivent être visibles. Un refus fait passer la connexion à error avec last_error ; un succès la ramène à ready. Le test ne juge ni le partage d’un calendrier, ni une politique d’accès à une boîte aux lettres, ni l’autorisation d’un site. Au plus 30 par minute et par organisation.
connection connect#
Créez un nouveau lien de consentement à usage unique pour une connexion screenrig_app.
connection connect <id>| Paramètre | Type | Requis | Par défaut | Notes |
|---|---|---|---|---|
<id> | string | oui | aucun | La connexion (pcn_…). |
screenrig connection connect pcn_01EXAMPLECONNECTION0000data.consent_url est le lien destiné à la personne qui effectue le consentement : l’administrateur Microsoft 365, ou le titulaire du compte Google. Il remplace tout lien précédent. Une connexion qui fonctionne reste telle quelle jusqu’à ce que le nouveau consentement soit terminé ; cela permet donc aussi de renouveler une connexion passée à error (consentement retiré, accès révoqué) ou de la déplacer vers un autre locataire ou compte. Une connexion en mode own_app n’a pas d’étape de consentement. Au plus 20 par minute et par organisation.
connection delete#
Supprimez une connexion par laquelle rien n’est lu.
connection delete <id> [--expect-rev REVISION]| Paramètre | Type | Requis | Par défaut | Notes |
|---|---|---|---|---|
<id> | string | oui | aucun | La connexion (pcn_…). |
--expect-rev REVISION | integer | non | aucun | Refuse la suppression sauf si la connexion est à cette révision (revision_conflict, sortie 6). |
screenrig connection delete pcn_01EXAMPLECONNECTION0000
screenrig connection delete pcn_01EXAMPLECONNECTION0000 --expect-rev 2Tant qu’une source de données, une connexion Power BI ou un compte de synchronisation de médias lit par la connexion, la réponse est resource_conflict (sortie 5), en les nommant. La suppression ne met pas fin à l’accès côté fournisseur : un locataire Microsoft 365 garde l’application de screenRIG jusqu’à ce que son administrateur la retire, et un compte Google garde son autorisation jusqu’à ce que son titulaire la révoque.