Estado de los dispositivos: comandos CLI

Reiniciar dispositivo de una pantalla o dispositivos de una flota.

screen reboot (<id>... | --tag TAG | --folder ID) [--yes] [--expires-in DURATION] [--expect-rev REVISION]

screenrig screen reboot scr_LOBBY
screenrig screen reboot scr_LOBBY --expires-in 2h
screenrig screen reboot --tag Lobby --yes
screenrig screen reboot --folder sfd_01EXAMPLEFOLDER000000000 --yes

El Player reinicia el dispositivo, no solo a sí mismo. A una pantalla en línea se le envía el reinicio de inmediato (state sent); una pantalla sin conexión lo mantiene queued y se le envía cuando se conecta antes de expires_at, 24 horas después de la solicitud salvo que --expires-in indique otra cosa. La respuesta incluye reboot_id, state y expires_at. Un reinicio más nuevo reemplaza a uno que siga en cola. screen show lista los commands de la pantalla: un reinicio enviado pasa a done cuando el dispositivo informa que arrancó, y screen command cancel cancela uno que siga en cola. En una flota, el reboot de cada resultado lleva el mismo state. Una solicitud rechazada o fallida, y una repetición exacta de la misma solicitud, no cuentan para el límite por pantalla. Desde el momento en que se envía un reinicio hasta que el dispositivo informa que arrancó o pasan diez minutos, la pantalla no abre ninguna alerta screen_offline o display_disconnected; un aviso de cualquiera de ellas que vence entonces espera hasta que termina ese período más su tiempo de espera, y un aviso crashing se omite como planned_reboot. Una condición que sigue vigente después se abre con normalidad.

Borrar las cachés del Player de una pantalla, o de los Players de una flota.

screen clear-cache (<id>... | --tag TAG | --folder ID) [--yes] [--expires-in DURATION] [--expect-rev REVISION]

screenrig screen clear-cache scr_LOBBY
screenrig screen clear-cache scr_LOBBY --expires-in 2h
screenrig screen clear-cache --tag Lobby --yes

El Player elimina sus medios descargados, paquetes de aplicación y cachés de datos, conserva su vinculación, identidad y ajustes, y luego obtiene de nuevo el manifiesto y el contenido; la pantalla puede mostrar su estado de carga mientras el contenido se repone. Solo llega a un Player que declara clear_cache. A una pantalla en línea se le envía la solicitud de inmediato (state sent); una pantalla sin conexión la mantiene queued y se le envía cuando vuelve a estar en línea antes de expires_at, 24 horas después de la solicitud salvo que --expires-in indique otra cosa. La respuesta lleva command_id, command, state y expires_at. Un Player que no declara la capacidad responde 409 command_unsupported y no se envía nada; en una flota esa pantalla falla por sí sola. screen show lista el comando en commands y, una vez que el Player informa, lo marca done o failed con un cause y un detail breve: cleared cuando las cachés están borradas y comenzó la nueva obtención, o clear_failed cuando no se puede borrar una caché. Un comando enviado sin informe permanece sent. Un comando más reciente del mismo tipo reemplaza a uno que sigue en cola, y screen command cancel cancela uno que sigue en cola. En una flota, el command de cada resultado lleva el mismo state. Una flota (varios ids, --tag o --folder) necesita --yes. Una solicitud rechazada o fallida, y una repetición exacta de la misma solicitud, no cuentan para el límite por pantalla de 2 solicitudes de clear-cache, restart-app y update-software en conjunto cada 10 minutos.

Reiniciar la aplicación del Player de una pantalla, o de los Players de una flota.

screen restart-app (<id>... | --tag TAG | --folder ID) [--yes] [--expires-in DURATION] [--expect-rev REVISION]

screenrig screen restart-app scr_LOBBY
screenrig screen restart-app scr_LOBBY --expires-in 2h
screenrig screen restart-app --tag Lobby --yes

El Player reinicia su aplicación, no el dispositivo (un Player web recarga su página) e informa desde el proceso reiniciado. Solo llega a un Player que declara restart_app; screen reboot reinicia el dispositivo. A una pantalla en línea se le envía la solicitud de inmediato (state sent); una pantalla sin conexión la mantiene queued y se le envía cuando vuelve a estar en línea antes de expires_at, 24 horas después de la solicitud salvo que --expires-in indique otra cosa. La respuesta lleva command_id, command, state y expires_at. Un Player que no declara la capacidad responde 409 command_unsupported y no se envía nada; en una flota esa pantalla falla por sí sola. screen show lista el comando en commands y, una vez que el Player informa, lo marca done o failed con un cause y un detail breve: restarted, o restart_failed cuando el reinicio no puede comenzar. Un comando enviado sin informe permanece sent. Un comando más reciente del mismo tipo reemplaza a uno que sigue en cola, y screen command cancel cancela uno que sigue en cola. En una flota, el command de cada resultado lleva el mismo state. Una flota (varios ids, --tag o --folder) necesita --yes. Una solicitud rechazada o fallida, y una repetición exacta de la misma solicitud, no cuentan para el límite por pantalla de 2 solicitudes de clear-cache, restart-app y update-software en conjunto cada 10 minutos.

Actualizar el Player de una pantalla a la versión más reciente, o los Players de una flota.

screen update-software (<id>... | --tag TAG | --folder ID) [--yes] [--expires-in DURATION] [--expect-rev REVISION]

screenrig screen update-software scr_LOBBY
screenrig screen update-software scr_LOBBY --expires-in 2h
screenrig screen update-software --tag Lobby --yes

El Player busca ahora la versión más reciente del Player y la instala donde su plataforma le permite actualizarse a sí mismo; un Player web actualiza su service worker y luego se recarga. Solo llega a un Player que declara update: un Player instalado desde una tienda o administrado por un administrador de dispositivos se actualiza por ese canal. A una pantalla en línea se le envía la solicitud de inmediato (state sent); una pantalla sin conexión la mantiene queued y se le envía cuando vuelve a estar en línea antes de expires_at, 24 horas después de la solicitud salvo que --expires-in indique otra cosa. La respuesta lleva command_id, command, state y expires_at. Un Player que no declara la capacidad responde 409 command_unsupported y no se envía nada; en una flota esa pantalla falla por sí sola. screen show lista el comando en commands y, una vez que el Player informa, lo marca done o failed con un cause y un detail breve: up_to_date cuando ya se ejecuta la versión más reciente, updated cuando la nueva versión ya se inició o, si falló, update_check_failed, download_failed, install_failed o no_update_channel. Un comando enviado sin informe permanece sent. Un comando más reciente del mismo tipo reemplaza a uno que sigue en cola, y screen command cancel cancela uno que sigue en cola. En una flota, el command de cada resultado lleva el mismo state. Una flota (varios ids, --tag o --folder) necesita --yes. Una solicitud rechazada o fallida, y una repetición exacta de la misma solicitud, no cuentan para el límite por pantalla de 2 solicitudes de clear-cache, restart-app y update-software en conjunto cada 10 minutos.

Cancelar un comando que sigue en cola para una pantalla sin conexión.

screen command cancel <id> <command_id> [--expect-rev REVISION]

screenrig screen command cancel scr_01EXAMPLESCREEN00000000 rbt_01EXAMPLEREBOOT00000000

Cancela un reboot, reload, clear_cache, restart_app o update que espera a una pantalla sin conexión, de modo que nunca se envía. Solo se puede cancelar un comando en cola. Uno que ya se envió (sent o done) responde 409 resource_conflict con "The command was already sent.", uno que ya no está en cola (expired, cancelled o superseded) responde 409 resource_conflict con "The command is no longer queued.", y un id que la pantalla no lista responde 404 not_found. La respuesta es la pantalla con el comando cancelled, y la revisión de la pantalla no cambia.

Encienda o apague la pantalla de un dispositivo o de una flota ahora, o borre esa anulación.

screen display [set] (<id>... | --tag TAG | --folder ID) --power on|off [--until TIME | --for DURATION] [--expect-rev REVISION]
screen display clear (<id>... | --tag TAG | --folder ID) [--expect-rev REVISION]

screenrig screen display scr_LOBBY --power off --for 2h
screenrig screen display --tag Lobby --power on
screenrig screen display scr_A scr_B --power off --for 8h
screenrig screen display clear --tag Lobby

screen display ID es la forma abreviada de screen display set ID; clear no admite --power, --until ni --for. screen display es una anulación manual del horario de pantalla. Sin --until o --for termina en el siguiente límite del horario; un cambio posterior de horario de pantalla o zona horaria mueve ese fin al nuevo límite. Sin límite en los próximos ocho días, por ejemplo sin horario habilitado, se mantiene hasta screen display clear o un reemplazo. screen display clear termina la anulación, para que el horario de pantalla se aplique de nuevo; sin uno, la pantalla está encendida.

Guardar una anulación no espera al Player. display.override_status compara con ella un informe de pantalla más reciente: matches, mismatch, pending, stale o unknown; matches describe el informe, no que el comando se ejecutó. La advertencia display_power_mismatch señala un informe reciente que difiere y display_power_unconfirmed indica que hace falta un informe más nuevo y utilizable, así que revise screen show antes de hacer una captura de pantalla. display_scrim_only significa que el Player solo controla una superposición negra: on la quita y no envía ningún comando de activación de hardware. Una pantalla de una carpeta protegida rechaza un cambio de pantalla (protected_target).

Mostrar, configurar o borrar cuándo está encendida la pantalla de un monitor.

screen display-schedule show <id>
screen display-schedule set (<id>... | --tag TAG | --folder ID) --file FILE [--expect-rev REVISION]
screen display-schedule clear (<id>... | --tag TAG | --folder ID) [--expect-rev REVISION]

screenrig screen display-schedule set scr_LOBBY --file hours.json
screenrig screen display-schedule set --tag Cafe --file hours.json

Un horario de pantalla es {enabled, windows}, ambos obligatorios, y windows enumera de 1 a 16 ventanas en las que la pantalla está encendida, en la zona horaria de la pantalla; fuera de toda ventana, la pantalla pasa a espera. El Player la evalúa en el dispositivo, por lo que sigue funcionando sin conexión. Una ventana cuyo end es igual o anterior a su start cruza medianoche, y una ventana sin start ni end cubre todo el día. enabled: false mantiene las ventanas y deja la pantalla encendida. display-schedule show responde con display_schedule (null cuando no hay ninguno) y el estado display de la pantalla. Su salida guardada se puede editar y volver a enviar con set --file. Una pantalla de una carpeta protegida rechaza un cambio de su horario de pantalla (protected_target).

{"enabled": true, "windows": [{"days": ["mon", "tue", "wed", "thu", "fri"], "start": "07:00", "end": "19:00"}, {"days": ["sat"]}]}

screen show --human imprime Display: con la potencia solicitada, su fuente (anulación manual, programación de pantalla o predeterminada) y hasta cuándo en la zona horaria de la pantalla, las ventanas de programación y la potencia reportada por el Player, marcada como obsoleta tras 35 minutos sin informe.

Establece el volumen de una pantalla, o la silencia, en una pantalla o en una flota.

screen volume (<id>... | --tag TAG) [--level 0-100] [--mute | --unmute] [--expect-rev REVISION]

screenrig screen volume scr_LOBBY --level 40
screenrig screen volume scr_LOBBY --mute
screenrig screen volume scr_LOBBY --unmute
screenrig screen volume --tag Lobby --level 25 --unmute

Una pantalla tiene un solo volumen: un nivel de 0 a 100 y un silenciamiento. Silenciar conserva el nivel, así que quitar el silencio lo restaura. Una pantalla en línea aplica el cambio de inmediato; una pantalla sin conexión aplica la última solicitud cuando vuelve a conectarse, y una solicitud más reciente reemplaza a la anterior. Un cambio hecho después en el menú de configuración del propio Player prevalece hasta el siguiente screen volume, y cambiar allí el nivel quita el silencio. screen show informa volume con el último cambio requested y, como reported, los valores level y muted que alcanzó el Player y hardware: true cuando el nivel llega a la salida del dispositivo o del panel, false cuando es la ganancia propia del Player; stale pasa a true tras 35 minutos sin un informe. Solo un Player que declara la capacidad volume lo aplica: cualquier otra pantalla responde 409 volume_unsupported (código de salida 5) y no se registra nada. Una pantalla archivada responde screen_archived y una pantalla que aún espera emparejarse responde resource_conflict. Una pantalla en una carpeta protegida rechaza el cambio (protected_target), y en una flota una sola pantalla protegida hace rechazar toda la solicitud. La página de la pantalla en el panel tiene el mismo control Volumen.

Oscurezca el vidrio de una pantalla tras un tiempo sin uso, o desactive esa función.

screen display-idle <id> --after SECONDS --wake WAKE [--expect-rev REVISION]
screen display-idle <id> --off [--expect-rev REVISION]

screenrig screen display-idle scr_LOBBY --after 300 --wake touch
screenrig screen display-idle scr_LOBBY --after 600 --wake touch,presence --expect-rev 4
screenrig screen display-idle scr_LOBBY --off

La pantalla se oscurece tras --after segundos sin un toque ni una tecla o, cuando --wake incluye presence, sin nadie frente a la pantalla. Mientras está oscura, el Player deja la reproducción en pausa, sin reproducciones ni anuncios, e informa de que la energía del monitor está apagada; un evento de activación enciende la pantalla de inmediato y la reproducción se reanuda, y el toque que activa una pantalla oscura no se transmite a la página. Un horario o una anulación de pantalla que mantiene el panel apagado prevalece, y también una aplicación que mantiene device.display mientras su página está en pantalla. Solo cambia display.idle. Un Player lo aplica cuando screen show incluye display_power.idle entre sus capacidades del host; el ajuste se guarda en ambos casos, y screen show lo lista como Display idle. El acceso Propose no puede cambiarlo (insufficient_access), y una pantalla de una carpeta protegida lo rechaza (protected_target).

Defina si el brillo de una pantalla sigue el sensor de luz del dispositivo.

screen brightness <id> --mode auto|fixed [--expect-rev REVISION]

screenrig screen brightness scr_LOBBY --mode auto
screenrig screen brightness scr_LOBBY --mode fixed --expect-rev 4

Solo cambia display.brightness. Un Player aplica auto cuando screen show incluye brightness.auto entre sus capacidades del host, que un dispositivo declara solo si tiene un sensor de luz; una aplicación que establece el brillo del monitor prevalece mientras su página se muestra. El ajuste se guarda en ambos casos, y screen show lo lista como Display brightness. Se aplican las reglas de acceso de screen display-idle.

Defina el modo de video que el Player de una pantalla pone en su salida, o bórrelo.

screen display-output <id> (--mode MODE | --clear) [--expect-rev REVISION]

screenrig screen display-output scr_LOBBY --mode 3840x2160x60p
screenrig screen display-output scr_LOBBY --mode auto --expect-rev 4
screenrig screen display-output scr_LOBBY --clear

screen show lista los modos que el Player puede establecer ahora, bajo Output modes the Player can set, y el modo en vigor. Cuando el Player ya los ha informado, un modo fuera de esa lista es invalid_request, así que elija uno de los que lista. Solo cambia display.output. Un Player lo aplica cuando screen show incluye display_output.mode entre sus capacidades del host, que declara un reproductor BrightSign; cualquier otro modo distinto de auto en otro Player responde display_output_unsupported, y borrar siempre funciona. El Player aplica un modo una vez, puede reiniciarse para hacerlo e informa del modo alcanzado. Se aplican las reglas de acceso de screen display-idle.

Haga que el Player de una pantalla tome la entrada HDMI del TV por CEC, o deje de hacerlo.

screen display-cec <id> (--on | --off | --clear) [--expect-rev REVISION]

screenrig screen display-cec scr_LOBBY --on
screenrig screen display-cec scr_LOBBY --off --expect-rev 4
screenrig screen display-cec scr_LOBBY --clear

Solo cambia display.cec. Un Player lo aplica cuando screen show incluye display_power.cec_active_source entre sus capacidades del host, que declara un reproductor BrightSign; --on en otro Player responde display_cec_unsupported, mientras que --off y --clear siempre funcionan. El Player no envía nada mientras una programación de pantalla o una anulación mantiene apagado el monitor, y un fallo de CEC nunca afecta a la reproducción. screen show lista el ajuste como Display CEC. Se aplican las reglas de acceso de screen display-idle.

Fije el Player de una pantalla a la pantalla, o libérelo.

screen kiosk-lock <id> (--on | --off) [--expect-rev REVISION]

screenrig screen kiosk-lock scr_LOBBY --on
screenrig screen kiosk-lock scr_LOBBY --off --expect-rev 4

--on usa la fijación de pantalla de Android: la persona que está frente a la pantalla lo confirma la primera vez, y la barra de estado, el botón de inicio y las aplicaciones recientes quedan bloqueados mientras el Player está fijado. El panel de configuración del operador puede salir del bloqueo hasta que el siguiente manifiesto o reinicio lo aplique de nuevo. Un Player lo aplica cuando screen show incluye kiosk_lock entre sus capacidades del host; el ajuste se guarda en ambos casos, y screen show lista Kiosk lock mientras está activado. El acceso Propose no puede cambiarla (insufficient_access).

Mostrar, definir o borrar cuándo el backend reinicia el dispositivo de una pantalla.

screen reboot-schedule show <id>
screen reboot-schedule set (<id>... | --tag TAG | --folder ID) (--window SPEC... | --file FILE) [--disabled] [--expect-rev REVISION]
screen reboot-schedule clear (<id>... | --tag TAG | --folder ID) [--expect-rev REVISION]

screenrig screen reboot-schedule set scr_LOBBY --window "Mon-Sun 04:00-04:30"
screenrig screen reboot-schedule set --tag Cafe --window "Mon-Fri 04:00-04:30" --window "Sat,Sun 05:00-06:00"
screenrig screen reboot-schedule set scr_LOBBY --file reboots.json --expect-rev 4
screenrig screen reboot-schedule set --folder sfd_01EXAMPLEFOLDER000000000 --window "Mon-Sun 04:00-04:30"

Al inicio de cada ventana, en la zona horaria de la pantalla, screenRIG emite el mismo reinicio que screen reboot, por lo que "Mon-Sun 04:00-04:30" reinicia la pantalla a las 04:00 hora local todos los días. commands en screen show lo lista con source schedule, y screen show y reboot-schedule show imprimen next_reboot_at. Una ventana cuyo final es igual o anterior a su inicio cruza la medianoche, y una ventana sin horas cubre todo el día. La salida guardada de reboot-schedule show se puede editar y volver a enviar con set --file:

{"enabled": true, "windows": [{"days": ["mon", "tue", "wed", "thu", "fri", "sat", "sun"], "start": "04:00", "end": "04:30"}]}

A una pantalla en línea se le envía el reinicio de inmediato. Una pantalla sin conexión lo mantiene en cola solo hasta que termina su ventana, de modo que un reinicio nunca cae fuera de la ventana: una pantalla que vuelve después no recibe ninguno. Un inicio dentro de un salto por cambio de hora de primavera se ejecuta en el primer minuto válido de la ventana, y una repetición por cambio de hora de otoño se ejecuta una vez por ventana y fecha local. Un reinicio programado nunca reemplaza uno solicitado por una persona que aún espera a la pantalla; la repetición se omite con screen.reboot_skipped (reboot_pending). La pantalla necesita un Player que declare reboot; una pantalla que pierde reboot más tarde omite cada ventana y conserva su programación. Cambiar la zona horaria cancela los reinicios programados que siguen esperando y mueve next_reboot_at a la nueva zona. Un reinicio enviado por una programación no genera ninguna alerta de desconexión, como bajo screen reboot. screen.reboot_schedule_changed registra cada definición o borrado. Un archivo es {enabled, windows}, ambos obligatorios. Los horarios de reinicio están en todos los planes. En una flota, cada resultado es el de esa pantalla: reboot_unsupported para una pantalla cuyo Player no puede reiniciar.

Lea la disponibilidad diaria de una pantalla en días UTC.

screen uptime <id> [--day-from YYYY-MM-DD] [--day-to YYYY-MM-DD] [--format json|csv|xlsx|pdf] [--output FILE]

screenrig screen uptime scr_01EXAMPLESCREEN00000000
screenrig screen uptime scr_01EXAMPLESCREEN00000000 --day-from 2026-09-01 --day-to 2026-09-30
screenrig screen uptime scr_01EXAMPLESCREEN00000000 --format xlsx --output uptime.xlsx

data.items lista una fila por día UTC con un estado registrado, el más antiguo primero: online_s, offline_s, availability (en línea durante el tiempo registrado; null cuando no se registró nada), coverage (la proporción del día con un estado registrado), intervals y live para un día que incluye el intervalo abierto hasta ahora. El tiempo sin estado registrado reduce coverage y nunca es tiempo de inactividad. Los días sin registros no tienen fila.

Listar transiciones en línea y fuera de línea de una pantalla, las más recientes primero.

screen presence <id> [--since TIME] [--until TIME]

screenrig screen presence scr_01EXAMPLESCREEN00000000 --since 7d
screenrig screen presence scr_01EXAMPLESCREEN00000000 --since 2026-09-01T00:00:00Z --until 2026-09-08T00:00:00Z

data.items lleva at, state y detected_on_reconnect en un servidor sin conexión que solo se detectó cuando la pantalla se reconectó (at es entonces cuando terminó su arrendamiento de presencia). La CLI sigue next_cursor hasta el final y responde cada transición con next_cursor null, así que reduzca un rango largo con --since.

Listar el estado que una pantalla reportó a lo largo del tiempo, cada informe o un resumen por hora.

screen health-history <id> [--from TIME] [--to TIME] [--resolution raw|hour] [--format json|csv|xlsx|pdf] [--output FILE]

screenrig screen health-history scr_01EXAMPLESCREEN00000000 --from 6h
screenrig screen health-history scr_01EXAMPLESCREEN00000000 --from 30d --resolution hour
screenrig screen health-history scr_01EXAMPLESCREEN00000000 --from 30d --resolution hour --format csv --output health.csv

raw responde data.samples, cada informe aceptado con forma de health de screen show sin stale. hour responde data.hours, un resumen por hora UTC: informes, temperatura máxima y promedio, carga máxima y proporción de memoria, señal Wi-Fi más débil, display_disconnected, y recuentos máximos de fallos y reinicios del renderizador. La CLI sigue next_cursor hasta el final, así que reduzca un rango largo sin procesar o use --resolution hour. Los informes sin procesar llegan en segundos y los resúmenes horarios en unos 5 minutos.

Comprueba si una lista de reproducción cabe en el almacenamiento que el Player de una pantalla informó por última vez, antes de asignarla.

screen storage-forecast <id> --playlist-id ID [--playlist-rev REVISION]

screenrig screen storage-forecast scr_01EXAMPLESCREEN00000000 --playlist-id pl_01EXAMPLEPLAYLIST000000
screenrig screen storage-forecast scr_01EXAMPLESCREEN00000000 --playlist-id pl_01EXAMPLEPLAYLIST000000 --playlist-rev 7

No escribe nada: ni asignación, ni revisión de pantalla, ni evento. El acceso de solo lectura basta, y una pantalla admite como máximo 30 comprobaciones por minuto. data.fit es fits, partial (se omiten algunas páginas), none_fit (no se carga nada) o unknown (la pantalla nunca ha informado de su almacenamiento, o el contenido de la lista de reproducción no está listo). data.excluded_page_count cuenta las páginas omitidas, data.required_bytes es lo que necesita toda la lista de reproducción, data.capacity_bytes lo que el Player informó que puede usar, data.basis es reported_capacity y data.received_at es cuándo informó el Player. Con fit unknown, los recuentos de bytes y received_at son null. Un informe de más de 24 horas se marca como obsoleto, pero se sigue usando. Cuando la lista de reproducción no cabe, la respuesta incluye una advertencia storage_full: libere almacenamiento en el dispositivo que ejecuta el Player y vuelva a comprobar. Caché y almacenamiento explica el plan. Una asignación guardada no confirma la reproducción.