Feeds
Un feed es un dato de terceros que screenRIG obtiene y almacena en caché, como clima, alertas, tarifas y titulares. feeds get lee un documento de feed, el mismo documento que una tarjeta integrada con los mismos parámetros lee. El comando nunca llama a un proveedor externo.
feeds get#
Lea un feed una vez. Un feed sin documento aún responde pending y su tiempo de reintento.
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]| Parámetro | Tipo | Requerido | Predeterminado | Notas |
|---|---|---|---|---|
<family> | string | sí | ninguno | weather, airquality, alerts, rates, crypto, earthquakes, cyclones, headlines, cap, tides, launches, drugalerts, respiratory, almanac, outdoorsafety, departures o bikeshare. |
--lat DEGREES | number | por familia | ninguno | Latitud, de -90 a 90, con --lon. Obligatoria para weather, airquality, alerts, earthquakes, outdoorsafety y bikeshare; opcional para cyclones, cap, tides y almanac. |
--lon DEGREES | number | por familia | ninguno | Longitud, de -180 a 180, con --lat. |
--radius-km KM | number | no | 500 para earthquakes | earthquakes radio, o el área cyclones, de 10 a 20000 km. Requiere --lat y --lon. |
--min-magnitude MAGNITUDE | number | no | 2.5 | earthquakes: magnitud mínima, de 0 a 9. |
--hours HOURS | number | no | 24 | earthquakes: ventana en horas, de 1 a 168. |
--basins LIST | string | no | todas las cuencas | cyclones: cuencas separadas por comas at, ep, cp, wp. |
--base CODE | string | no | EUR | rates: moneda base. |
--symbols IDS | string | sí, para crypto | ninguno | IDs o símbolos de criptomonedas separados por comas, máximo 20. |
--currency CODE | string | no | usd | crypto: moneda cotizada. |
--station ID | string | no | ninguno | tides: un id de estación de predicción de mareas de NOAA, de siete letras o dígitos, como 9414290. Sin él, --lat y --lon eligen la estación más cercana en un radio de 100 km. |
--country CODE | string | por familia | ninguno | drugalerts: us, ca o gb (obligatorio). respiratory: us o gb (obligatorio). almanac: el país ISO 3166-1 cuyos días festivos enumera. |
--category CATEGORY | string | no | drug | drugalerts: drug o food. |
--region NAME | string | no | todo el país | respiratory: un estado, territorio o DC de EE. UU. por nombre o código postal, o Inglaterra o una región de la UKHSA, de hasta 48 caracteres. |
--date YYYY-MM-DD | string | no | los días en torno a hoy | almanac: un día fijo. |
--provider PROVIDER | string | sí, para departures | ninguno | departures: el proveedor de transporte de las paradas, tfl, entur o digitransit. |
--stops IDS | string | sí, para departures | ninguno | departures: de uno a cuatro id de parada del proveedor, separados por comas, como el id StopPoint de TfL 940GZZLUOXC, los id de Entur NSR:StopPlace:337 y NSR:Quay:568, o el gtfsId de Digitransit HSL:1040129. |
--system ID | string | no | el sistema más cercano | bikeshare: un id de sistema de bicicletas compartidas, como Mobibikes_CA_Vancouver. Sin él, se usa el sistema listado más cercano que cubra --lat y --lon. |
--url URL | string | sí, para headlines | ninguno | headlines: URL de un feed RSS o Atom. cap: URL de una alerta CAP o índice ATOM/RSS; repítalo, máximo 5. |
--public | boolean | no | encendido sin --url | cap: también lee los feeds públicos de alertas que cubren --lat y --lon. Requiere --lat y --lon. |
--geocode NAME:VALUE | string | no | ninguno | cap: un código de área de la ubicación, como UGC:WAC033. Repetible. Requiere --lat y --lon. |
--min-severity LEVEL | string | no | ninguno | cap: solo alertas en o por encima de minor, moderate, severe o extreme. |
--max-severity LEVEL | string | no | ninguno | cap: solo alertas en o por debajo de minor, moderate, severe o extreme. |
--min-urgency LEVEL | string | no | ninguno | cap: solo alertas al menos tan urgentes: past, future, expected o immediate. |
--min-certainty LEVEL | string | no | ninguno | cap: solo alertas al menos tan ciertas: unlikely, possible, likely o observed. |
--event NAME | string | no | cualquier evento | cap: solo este evento; * coincide con cualquier secuencia de caracteres. Repetible. |
--exclude-event NAME | string | no | ninguno | cap: omitir este evento. Repetible. |
--sender NAME | string | no | cualquier remitente | cap: solo alertas de este remitente. Repetible. |
--status STATUS | string | no | Actual | cap: estado de alerta para leer: Actual, Exercise, Test o System. Repetible. |
--scope SCOPE | string | no | Public | cap: alcance de alerta para leer: Public, Restricted o Private. Repetible. |
--language TAG | string | no | en para almanac | cap: preferencia de idioma; gana la primera que esté presente. Repetible. almanac: la edición de «Tal día como hoy», una de ar, bs, cs, de, en, es, fr, it, pt, ru, sv, tr, uk o zh. |
--area-unknown MODE | string | no | hide | cap: una alerta comunicada solo por códigos de área que la ubicación no tiene: hide o 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 y bikeshare requieren --lat y --lon, que siempre van juntos; earthquakes también acepta --radius-km, --min-magnitude y --hours, y bikeshare acepta --system. cyclones acepta --basins, y con --lat, --lon y --radius-km juntos, solo las tormentas cercanas a ese lugar. rates acepta --base, crypto requiere --symbols y acepta --currency, y headlines requiere --url. tides requiere --station, o --lat y --lon para la estación de predicción más cercana. drugalerts requiere --country y acepta --category, respiratory requiere --country y acepta --region, y almanac acepta --country, --language, --lat, --lon y --date. departures requiere --provider y --stops, y launches no acepta indicadores. Se rechaza un indicador que la familia no acepta. Tarjetas integradas describe los datos de cada familia.
cap lee las alertas CAP que coinciden con un lugar. Necesita --url (repetible, hasta 5 URLs de índice de alertas CAP o ATOM/RSS) o --lat y --lon, que leen los feeds públicos que cubren la ubicación; --public añade esos feeds públicos a las fuentes --url. Las banderas del filtro reflejan los miembros de un objeto triggers create --pull.
Un documento en caché responde 200 con fetchedAt y attribution: muestre la atribución dondequiera que los datos lo indiquen. Sin documento aún, el sobre informa estado pending, retry_after_seconds y retry_at con salida 0; el CLI no hace bucle, así que ejecute el comando nuevamente después de retry_at. Una organización registra como máximo 50 nuevas claves de feed al día, y rate_limited sigue después de eso. Las tarjetas derivan claves de feed de parámetros estáticos; no escriba claves feed o feed: usted mismo.
Fuentes de datos
Una fuente de datos lee una dirección externa según un horario y escribe el resultado en los datos de una tarjeta, de modo que la tarjeta se mantiene al día sin que nadie vuelva a publicar y las pantallas recuperan el documento cuando cambia. Los tipos son ics, sheets, csv, json, microsoft365, google_calendar, square, shopify, toast y momentus. Una fuente escribe una tarjeta, y una organización tiene hasta 200 en todos sus proyectos. Una sincronización que falla nunca escribe: la tarjeta conserva su último buen documento y el estado de la fuente muestra el error. Los ajustes de cada tipo, los códigos de estado y las reglas de privacidad están en Fuentes de datos.
Una opción predefinida es una fuente json lista para usar y probada para un servicio, como un canal de Slack, una bolsa de trabajo o un tablero de compilaciones: source presets las lista, source presets NAME muestra los campos y secretos de una opción predefinida, y source create --preset NAME crea la fuente.
Dé cada credencial como --secret NAME=@FILE, o NAME=- para la entrada estándar, para que no quede en el historial de su shell ni en la lista de procesos. Los secretos se almacenan sellados y solo se muestran como una pista enmascarada. Los nombres de los secretos son calendar_url.KEY para ics (uno por calendario), token para una dirección csv o json que lo necesite (password, client_secret, header.NAME y query.NAME sirven para las demás formas de iniciar sesión, descritas en Solicitudes, inicio de sesión y páginas), client_secret para microsoft365 y toast, service_account_key para google_calendar, access_token para square y shopify, api_key y api_secret para momentus, y client_secret con el ajuste client_id para una aplicación shopify instalada en la tienda.
--settings recibe todo el objeto de ajustes de la fuente como JSON, @FILE o -. --set KEY=VALUE establece un miembro de primer nivel y se puede repetir; el valor es JSON cuando se puede interpretar (days=14, calendars='[{"key":"lobby"}]') y texto en caso contrario (time_zone=America/Vancouver). Con ambos, los miembros de --set reemplazan los mismos miembros de --settings; source update con solo --set cambia esos miembros de los ajustes guardados. La opción --config de la CLI nombra su archivo de credenciales y no tiene nada que ver con las fuentes.
source list#
Lista las fuentes de datos del proyecto, las más recientes primero, con su estado.
source list [--after CURSOR]| Parámetro | Tipo | Requerido | Predeterminado | Notas |
|---|---|---|---|---|
--after CURSOR | string | no | primera página | El data.next_cursor de la página anterior. |
screenrig source listsource show#
Inspecciona una fuente: sus ajustes, sus secretos enmascarados, la última ejecución y el último error.
source show <source_id>| Parámetro | Tipo | Requerido | Predeterminado | Notas |
|---|---|---|---|---|
<source_id> | string | sí | ninguno | La fuente (src_…). |
screenrig source show src_01EXAMPLESOURCE000000source presets#
Lista las opciones predefinidas de fuente listas para usar, o muestra una con sus campos, secretos y cómo conseguirlos.
source presets [<name>]| Parámetro | Tipo | Requerido | Predeterminado | Notas |
|---|---|---|---|---|
<name> | string | no | todas las opciones predefinidas | El nombre de una opción predefinida: palabras en minúsculas unidas por guiones, como slack-channel. |
screenrig source presets
screenrig source presets slack-channelLa lista muestra el título de cada opción predefinida, los tipos de tarjeta que rellena (el primero es aquel para el que está hecha) y su categoría. Un nombre muestra los campos que se definen (--set NAME=VALUE: texto con su patrón y un ejemplo, una elección, o una lista que admite un arreglo JSON), los secretos que se introducen (--secret NAME=@FILE) con el lugar donde el proveedor emite cada uno, con qué frecuencia se actualiza, cuánto tiempo conserva una tarjeta sus últimos datos, y de quién son los datos que lee y bajo qué condiciones. No se crea nada.
source create#
Crea una fuente. Se ejecuta en segundos y después según su horario. Cree primero la tarjeta y haga una vista previa con 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]| Parámetro | Tipo | Requerido | Predeterminado | Notas |
|---|---|---|---|---|
--kind KIND | string | sin --preset | ninguno | ics, sheets, csv, json, microsoft365, google_calendar, square, shopify, momentus o toast. |
--preset NAME | string | sin --kind | ninguno | Crea la fuente a partir de una opción predefinida lista para usar y probada (source presets las lista): --set y --settings indican entonces los campos de la opción predefinida y --secret sus credenciales. No con --kind. |
--card CARD_ID | string | sí | ninguno | La tarjeta (crd_…) que escribe la fuente. Una tarjeta tiene una fuente; source_target_taken responde a una segunda. |
--name NAME | string | sí | ninguno | De 1 a 80 caracteres. |
--settings SETTINGS | string | no | {} | El objeto de ajustes completo de la fuente, en JSON, @FILE o - para stdin. Con --preset, los campos de la opción predefinida. |
--connection-id ID | string | no | ninguno | microsoft365 y google_calendar: leen a través de una conexión del proyecto (pcn_…, connection list) en lugar de un tenant, client_id y un secreto propios de la fuente. Define el ajuste connection_id. No se combina con --preset. |
--set KEY=VALUE | string | no | ninguno | Un ajuste de nivel superior: JSON si el valor se interpreta (days=14, calendars='[{"key":"lobby"}]'), texto en caso contrario (time_zone=America/Vancouver). Repetible. Con --preset, un campo de la opción predefinida: el texto tal como se escribe, salvo que sea un array u objeto JSON (los elementos de un campo de lista). |
--secret NAME=VALUE | string | no | ninguno | Una credencial por nombre: NAME=@FILE, NAME=- (como máximo una opción lee stdin) o NAME=VALUE. Repetible. Con --preset, las credenciales de la opción predefinida. |
--refresh DURATION | string | no | según el tipo | Con qué frecuencia sincronizar, de 30s a 24h, por ejemplo 90s, 5m o 1h30m. El tipo fija el valor predeterminado y el intervalo más corto: 5 minutos y 1 minuto para ics, sheets, csv y json; 2 minutos y 1 minuto para microsoft365 y google_calendar; 5 minutos y 2 minutos para square, shopify y toast; 1 minuto y 30 segundos para momentus. Una opción predefinida fija el suyo. |
--stale-after DURATION | string | no | según el tipo | Cuánto tiempo conserva la tarjeta los últimos datos buenos cuando la fuente no puede actualizarse, de 1m a 7d, como mínimo el doble de --refresh; none los conserva hasta la próxima actualización. Después, los datos caducan en todas las pantallas. momentus es 30m por defecto, y una opción predefinida fija la suya. |
--disabled | boolean | no | apagado | Crea la fuente detenida; no se recupera nada hasta 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#
Cambia una fuente. Un cambio distinto de cambiar el nombre restablece su contador de fallos y la ejecuta de nuevo.
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]| Parámetro | Tipo | Requerido | Predeterminado | Notas |
|---|---|---|---|---|
<source_id> | string | sí | ninguno | La fuente (src_…). |
--name NAME | string | no | sin cambios | Cambia el nombre de la fuente. |
--card CARD_ID | string | no | sin cambios | Escribir otra tarjeta. |
--settings SETTINGS | string | no | sin cambios | Reemplaza todo el objeto de ajustes: JSON, @FILE o - para stdin. Para una fuente creada a partir de una opción predefinida, combina estos campos con sus ajustes. |
--connection-id ID | string | no | sin cambios | Como en source create. Para que una fuente deje de usar sus propias credenciales se requiere --settings sin tenant ni client_id, y --unset-secret client_secret. |
--set KEY=VALUE | string | no | ninguno | Cambia un ajuste de nivel superior de los guardados, como en source create. Repetible. Para una fuente creada a partir de una opción predefinida, un campo de la opción predefinida; el valor null elimina un campo opcional. |
--secret NAME=VALUE | string | no | ninguno | Establece o reemplaza un secreto. Repetible. Un secreto que no envía conserva su valor, salvo que el cambio apunte la fuente a un lugar que ese secreto no cubre (otro origen, tienda, entorno o inquilino): entonces source_secret_required lo vuelve a pedir. |
--unset-secret NAME | string | no | ninguno | Quita un secreto. Repetible. |
--refresh DURATION | string | no | sin cambios | De 30s a 24h; se aplica el intervalo más corto del tipo. |
--stale-after DURATION | string | no | sin cambios | Como en source create; none quita el periodo. |
--enable, --disable | boolean | no | sin cambios | Reanuda el horario, o lo detiene; la tarjeta conserva su último documento. Como máximo una de las dos. |
--expect-rev REVISION | integer | no | la revisión leída | Rechaza el cambio salvo que la fuente esté en esta revisión. --set protege la revisión que leyó, salvo que indique otra. |
Se requiere al menos un cambio.
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#
Muestra una vista previa de una fuente sin guardar ni escribir nada: obtiene la dirección, da forma a la respuesta para la tarjeta y la comprueba contra la tarjeta. El sobre lleva el documento, valid, la ruta y el motivo cuando la tarjeta lo rechaza, advertencias y recuentos. Pase un <source_id> guardado para probarla con las demás opciones como sustituciones, o --kind (o --preset) y --card para probar una que no está guardada. Un fallo de obtención o de conformado es source_test_failed con el motivo. Una fuente csv o json también informa de la solicitud enviada como data.request: su dirección con los marcadores sustituidos y los parámetros de consulta secretos enmascarados, los nombres de los encabezados enviados, el inicio del cuerpo y las páginas leídas. Como máximo 30 vistas previas por minuto por organización.
source test [<source_id>] [--kind KIND | --preset NAME] [--card CARD_ID] [--settings JSON|@FILE|-] [--set KEY=VALUE]...
[--connection-id ID] [--secret NAME=VALUE]...| Parámetro | Tipo | Requerido | Predeterminado | Notas |
|---|---|---|---|---|
<source_id> | string | no | ninguno | Una fuente guardada para probar. |
--kind KIND | string | sin <source_id> ni --preset | ninguno | Igual que para source create. |
--preset NAME | string | no | ninguno | Muestra una vista previa de una fuente creada a partir de esta opción predefinida, con --set y --settings como sus campos y --secret como sus credenciales, en lugar de --kind. No se combina con <source_id>. |
--card CARD_ID | string | sin <source_id> | ninguno | La tarjeta que se rellena. |
--settings SETTINGS | string | no | los ajustes guardados | Los ajustes del tipo: JSON, @FILE o - para la entrada estándar. |
--connection-id ID | string | no | ninguno | Igual que para source create. |
--set KEY=VALUE | string | no | ninguno | Un ajuste de nivel superior, como en source create; con un <source_id>, sustituye ese ajuste de los guardados. Repetible. |
--secret NAME=VALUE | string | no | los secretos guardados | Una credencial para probar. Repetible. |
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#
Sincroniza una fuente ahora y muestra el resultado. Se ejecuta en línea hasta 60 segundos, restablece el contador de fallos y lee la dirección completa. Una sincronización fallida nunca cambia la tarjeta. source_busy (código de salida 5) responde mientras se ejecuta una sincronización programada. Como máximo 6 por minuto y por fuente.
source refresh <source_id>| Parámetro | Tipo | Requerido | Predeterminado | Notas |
|---|---|---|---|---|
<source_id> | string | sí | ninguno | La fuente (src_…). |
screenrig source refresh src_01EXAMPLESOURCE000000source rooms#
Comprueba cómo se asignan las pantallas a las salas de una fuente de sistema de reservas (momentus). Lee las salas de la última actualización correcta de la fuente y las pantallas del proyecto, y no consulta nada. Lista las salas y áreas que ninguna pantalla muestra y cada pantalla que tiene un valor de sala o de área o cuya lista de reproducción lee la clave de sala o de área de la fuente, cada una mapped, missing (la lista lee el campo y la pantalla no tiene ninguno) o unknown (el valor no nombra ninguna sala ni área, con la que probablemente quiso decir). Corrige una pantalla con screen update scr_ID --field room=ROOM_KEY.
source rooms <source_id>| Parámetro | Tipo | Requerido | Predeterminado | Notas |
|---|---|---|---|---|
<source_id> | string | sí | ninguno | Una fuente (src_…) que lee las salas de un sistema de reservas. |
screenrig source rooms src_01EXAMPLESOURCE000000source delete#
Elimina una fuente. La tarjeta conserva el último documento que escribió la fuente.
source delete <source_id> [--expect-rev REVISION]| Parámetro | Tipo | Requerido | Predeterminado | Notas |
|---|---|---|---|---|
<source_id> | string | sí | ninguno | La fuente (src_…). |
--expect-rev REVISION | integer | no | ninguno | Rechaza la eliminación salvo que la fuente esté en esta revisión. |
screenrig source delete src_01EXAMPLESOURCE000000Conexiones
Una conexión es el acceso guardado del proyecto a Microsoft o Google para el trabajo que se ejecuta sin nadie con la sesión iniciada. Una fuente de datos microsoft365 o google_calendar (source create --connection-id), una conexión de Power BI (bi connection create powerbi --connection-id) y una cuenta de sincronización de medios de SharePoint (media sync account add microsoft365 --connection-id) leen a través de una en lugar de llevar cada una un tenant, un ID de cliente y un secreto. Un ID de conexión empieza por pcn_, y una organización tiene hasta 50 conexiones en todos sus proyectos. Los modos, estados y pasos de aprobación están en Conectar Microsoft y Google.
El modo own_app contiene su propia aplicación: para Microsoft, un registro de aplicación de Microsoft Entra (--tenant-id, --client-id y el valor de un secreto de cliente); para Google, la clave JSON de una cuenta de servicio. El modo screenrig_app usa la propia aplicación de screenRIG y no necesita ningún secreto: create imprime un enlace de consentimiento de un solo uso (data.consent_url, que caduca en data.consent_expires_at) para la persona que lo completa, un administrador de Microsoft 365 que da su consentimiento para el tenant, o el titular de una cuenta de Google que concede acceso de solo lectura al calendario. Envíe el enlace solo a esa persona y lea después status y last_error con connection show. Una conexión de Power BI solo acepta una conexión own_app.
Indique un secreto de cliente con --secret-file FILE y una clave de Google con --service-account-key-file FILE, o - para stdin, nunca como argumento. Leer requiere acceso Read, y cualquier cambio requiere acceso Manage.
connection list#
Lista las conexiones de este proyecto con su estado.
connection listSin parámetros.
screenrig connection listconnection show#
Inspecciona una conexión: su estado, el último error y la última prueba.
connection show <id>| Parámetro | Tipo | Requerido | Predeterminado | Notas |
|---|---|---|---|---|
<id> | string | sí | ninguno | La conexión (pcn_…). |
screenrig connection show pcn_01EXAMPLECONNECTION0000connection create microsoft#
Agrega una conexión de Microsoft 365: su propia aplicación de Entra, o la aplicación de screenRIG con un enlace de consentimiento.
connection create microsoft --mode own_app|screenrig_app [--name NAME]
[--tenant-id ID --client-id ID --secret-file FILE]| Parámetro | Tipo | Requerido | Predeterminado | Notas |
|---|---|---|---|---|
--mode MODE | string | sí | ninguno | own_app: su propio registro de aplicación de Microsoft Entra con un secreto de cliente. screenrig_app: la aplicación de screenRIG, a la que un administrador de Microsoft 365 da su consentimiento mediante el enlace de un solo uso que imprime este comando. |
--name NAME | string | no | Microsoft 365 | De 1 a 80 caracteres. |
--tenant-id ID | string | con own_app | ninguno | Su Directory (tenant) ID de Microsoft Entra, o su dominio principal, como contoso.onmicrosoft.com. Junto con --client-id y --secret-file. |
--client-id ID | string | con own_app | ninguno | El Application (client) ID del registro de la aplicación. |
--secret-file FILE | string | con own_app | ninguno | Lee el valor del secreto de cliente desde este archivo, o - para stdin (nunca un argumento); el archivo contiene solo el valor. |
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"El modo screenrig_app no admite ninguno de --tenant-id, --client-id y --secret-file: imprime el enlace de consentimiento (data.consent_url) para el administrador de Microsoft 365, que da su consentimiento a la aplicación de screenRIG para el tenant. El registro de la aplicación enumera Calendars.Read para los calendarios de salas de reuniones, Sites.Selected o Files.Read.All para la sincronización de medios de SharePoint y, para Power BI, los ajustes de tenant y la pertenencia al área de trabajo en lugar de permisos de Graph; connection test informa de qué permisos lleva el token. Un servidor sin la aplicación de screenRIG responde connection_app_not_configured: el modo own_app sigue funcionando.
connection create google#
Agrega una conexión de Google: la clave de su propia cuenta de servicio, o la aplicación de screenRIG con un enlace de inicio de sesión.
connection create google --mode own_app|screenrig_app [--name NAME]
[--service-account-key-file FILE]| Parámetro | Tipo | Requerido | Predeterminado | Notas |
|---|---|---|---|---|
--mode MODE | string | sí | ninguno | own_app: la clave de su propia cuenta de servicio. screenrig_app: la aplicación de screenRIG, en la que el titular de una cuenta de Google inicia sesión y concede acceso de solo lectura al calendario mediante el enlace de un solo uso que imprime este comando. |
--name NAME | string | no | Google Calendar | De 1 a 80 caracteres. |
--service-account-key-file FILE | string | con own_app | ninguno | Lee el archivo de clave JSON de la cuenta de servicio desde este archivo, o - para stdin (nunca un argumento). |
screenrig connection create google --mode own_app --service-account-key-file key.json
screenrig connection create google --mode screenrig_app --name "Venue calendars"En modo own_app, comparta cada calendario de sala con la dirección de la cuenta de servicio, o indique un subject en la fuente (delegación en todo el dominio). El modo screenrig_app no recibe ninguna clave e imprime el enlace de inicio de sesión (data.consent_url) para el titular de la cuenta de Google: la cuenta debe ver todos los calendarios de sala que lista una fuente, y esa fuente no puede nombrar un subject. Un servidor sin la aplicación de screenRIG responde connection_app_not_configured: el modo own_app sigue funcionando.
connection update#
Cambia el nombre de una conexión o, en modo own_app, su tenant, aplicación o secreto.
connection update <id> [--name NAME] [--tenant-id ID] [--client-id ID]
[--secret-file FILE] [--service-account-key-file FILE] [--expect-rev REVISION]| Parámetro | Tipo | Requerido | Predeterminado | Notas |
|---|---|---|---|---|
<id> | string | sí | ninguno | La conexión (pcn_…). |
--name NAME | string | no | sin cambios | Cambia el nombre de la conexión. |
--tenant-id ID | string | no | sin cambios | Microsoft own_app: el Directory (tenant) ID o el dominio principal. |
--client-id ID | string | no | sin cambios | Microsoft own_app: el Application (client) ID. |
--secret-file FILE | string | no | sin cambios | Microsoft own_app: lee el valor del secreto de cliente desde este archivo, o - para stdin; sustituye el secreto almacenado. |
--service-account-key-file FILE | string | no | sin cambios | Google own_app: lee la clave JSON de la cuenta de servicio desde este archivo, o - para stdin; sustituye la clave almacenada. |
--expect-rev REVISION | integer | no | ninguno | Rechaza el cambio salvo que la conexión esté en esta revisión (revision_conflict, salida 6). |
screenrig connection update pcn_01EXAMPLECONNECTION0000 --secret-file new-secret.txt
screenrig connection update pcn_01EXAMPLECONNECTION0000 --name "Contoso rooms" --expect-rev 2Se requiere al menos un cambio. Un cambio de las credenciales devuelve la conexión a ready, borra su último error y su última prueba, y retira todos los tokens emitidos para las anteriores: pruébela de nuevo. Una conexión screenrig_app solo puede cambiar de nombre: connection connect crea un nuevo enlace de consentimiento para cambiar quién dio su consentimiento. Un secreto omitido se conserva.
connection test#
Inicia sesión con una conexión y comprueba qué permiten sus credenciales.
connection test <id>| Parámetro | Tipo | Requerido | Predeterminado | Notas |
|---|---|---|---|---|
<id> | string | sí | ninguno | La conexión (pcn_…). |
screenrig connection test pcn_01EXAMPLECONNECTION0000Para Microsoft informa de credentials (un token de aplicación para el tenant) y permissions (cuáles de Calendars.Read, Sites.Selected, Files.Read.All, Sites.Read.All y Place.Read.All lleva el token; si no lleva ninguno, falla, y Sites.Selected por sí solo es una advertencia porque cada sitio necesita su propia concesión). Para Google informa de credentials, que nombra la cuenta a la que deben ser visibles los calendarios. Un rechazo pasa la conexión a error con last_error; un éxito la devuelve a ready. La prueba no juzga el uso compartido de un calendario, una política de acceso a buzones ni una concesión de sitio. Como máximo 30 por minuto por organización.
connection connect#
Genera un nuevo enlace de consentimiento de un solo uso para una conexión screenrig_app.
connection connect <id>| Parámetro | Tipo | Requerido | Predeterminado | Notas |
|---|---|---|---|---|
<id> | string | sí | ninguno | La conexión (pcn_…). |
screenrig connection connect pcn_01EXAMPLECONNECTION0000data.consent_url es el enlace para la persona que completa el consentimiento: el administrador de Microsoft 365 o el titular de la cuenta de Google. Sustituye a cualquier enlace anterior. Una conexión que funciona se queda como está hasta que se completa el nuevo consentimiento, así que esto también renueva una que pasó a error (consentimiento retirado, acceso revocado) o la mueve a otro tenant o cuenta. Una conexión en modo own_app no tiene paso de consentimiento. Como máximo 20 por minuto por organización.
connection delete#
Elimina una conexión por la que no lee nada.
connection delete <id> [--expect-rev REVISION]| Parámetro | Tipo | Requerido | Predeterminado | Notas |
|---|---|---|---|---|
<id> | string | sí | ninguno | La conexión (pcn_…). |
--expect-rev REVISION | integer | no | ninguno | Rechaza la eliminación salvo que la conexión esté en esta revisión (revision_conflict, salida 6). |
screenrig connection delete pcn_01EXAMPLECONNECTION0000
screenrig connection delete pcn_01EXAMPLECONNECTION0000 --expect-rev 2Mientras una fuente de datos, una conexión de Power BI o una cuenta de sincronización de medios lea a través de la conexión, la respuesta es resource_conflict (salida 5), que los nombra. Eliminar no pone fin al acceso del lado del proveedor: un tenant de Microsoft 365 conserva la aplicación de screenRIG hasta que su administrador la quite, y una cuenta de Google conserva su concesión hasta que su titular la revoque.