デバイスの状態 CLI コマンド

スクリーンのデバイスまたはフリートのデバイスを再起動します。

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

Player はそれ自身だけでなくデバイスを再起動します。オンラインのスクリーンには再起動がすぐに送信されます（state sent）。オフラインのスクリーンは queued として保持し、expires_at の前にオンラインになると送信されます。その期限は、--expires-in に別の指定がなければ依頼から24時間後です。応答には reboot_id、state、expires_at が含まれます。より新しい再起動は、キューにある再起動を置き換えます。screen show はスクリーンの commands を一覧します。送信された再起動は、デバイスが起動を報告すると done になり、screen command cancel はキューにあるものをキャンセルします。フリートでは、各結果の reboot が同じ state を持ちます。拒否または失敗したリクエストと、同一リクエストの完全な再実行は、スクリーンごとの上限に数えられません。再起動が送信されてから、デバイスが起動を報告するか10分が経過するまで、スクリーンは screen_offline や display_disconnected のアラートを発生させません。その間に送信期限を迎えたどちらかの通知は、その期間の終了に待機時間を加えた時刻まで待機し、crashing の通知は planned_reboot としてスキップされます。その後も続く条件は通常どおり発生します。

スクリーンの Player、またはフリートの Player のキャッシュをクリアします。

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

Player はダウンロード済みのメディア、アプリケーションパッケージ、データキャッシュを削除し、ペアリング、ID、設定は保持したまま、マニフェストとコンテンツを再び取得します。コンテンツが再び満たされるまで、スクリーンは読み込み状態を表示することがあります。対象となるのは clear_cache を宣言した Player のみです。オンラインのスクリーンにはリクエストが直ちに送信されます（state sent）。オフラインのスクリーンでは queued として保持され、リクエストの24時間後（--expires-in で別途指定しない限り）である expires_at より前にオンラインになった時点で送信されます。応答には command_id、command、state、expires_at が含まれます。この機能を宣言していない Player は 409 command_unsupported で応答し、何も送信されません。フリートでは、そのスクリーンだけが失敗します。screen show は commands の下にコマンドを一覧表示し、Player が報告すると、cause と短い detail を付けて done または failed にします。キャッシュがクリアされ再取得が始まった場合は cleared、キャッシュをクリアできない場合は clear_failed です。報告のない sent のコマンドは sent のままです。同じ種類のより新しいコマンドは、まだ queued のコマンドを置き換え、screen command cancel はまだ queued のコマンドをキャンセルします。フリートでは、各結果の command に同じ state が含まれます。フリート（複数の ID、--tag または --folder）には --yes が必要です。拒否または失敗したリクエスト、および同一リクエストの完全なリプレイは、スクリーンごとの clear-cache、restart-app、update-software を合わせた10分間に2件の上限に数えられません。

スクリーンの Player、またはフリートの Player のアプリケーションを再起動します。

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

Player はアプリケーションを再起動し（デバイスではありません。Web Player はページを再読み込みします）、再起動したプロセスから報告します。対象となるのは restart_app を宣言した Player のみで、デバイスを再起動するのは screen reboot です。オンラインのスクリーンにはリクエストが直ちに送信されます（state sent）。オフラインのスクリーンでは queued として保持され、リクエストの24時間後（--expires-in で別途指定しない限り）である expires_at より前にオンラインになった時点で送信されます。応答には command_id、command、state、expires_at が含まれます。この機能を宣言していない Player は 409 command_unsupported で応答し、何も送信されません。フリートでは、そのスクリーンだけが失敗します。screen show は commands の下にコマンドを一覧表示し、Player が報告すると、cause と短い detail を付けて done または failed にします。restarted、または再起動を開始できない場合は restart_failed です。報告のない sent のコマンドは sent のままです。同じ種類のより新しいコマンドは、まだ queued のコマンドを置き換え、screen command cancel はまだ queued のコマンドをキャンセルします。フリートでは、各結果の command に同じ state が含まれます。フリート（複数の ID、--tag または --folder）には --yes が必要です。拒否または失敗したリクエスト、および同一リクエストの完全なリプレイは、スクリーンごとの clear-cache、restart-app、update-software を合わせた10分間に2件の上限に数えられません。

スクリーンの Player、またはフリートの Player を最新リリースに更新します。

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

Player は最新の Player リリースを今すぐ確認し、プラットフォームが Player 自身による更新を許可している場合はインストールします。Web Player はサービスワーカーを更新してから再読み込みします。対象となるのは update を宣言した Player のみです。ストアからインストールされた Player やデバイスマネージャーで管理されている Player は、そのチャネルで更新されます。オンラインのスクリーンにはリクエストが直ちに送信されます（state sent）。オフラインのスクリーンでは queued として保持され、リクエストの24時間後（--expires-in で別途指定しない限り）である expires_at より前にオンラインになった時点で送信されます。応答には command_id、command、state、expires_at が含まれます。この機能を宣言していない Player は 409 command_unsupported で応答し、何も送信されません。フリートでは、そのスクリーンだけが失敗します。screen show は commands の下にコマンドを一覧表示し、Player が報告すると、cause と短い detail を付けて done または failed にします。最新リリースがすでに動作している場合は up_to_date、新しいバージョンが起動した場合は updated、失敗した場合は update_check_failed、download_failed、install_failed、no_update_channel のいずれかです。報告のない sent のコマンドは sent のままです。同じ種類のより新しいコマンドは、まだ queued のコマンドを置き換え、screen command cancel はまだ queued のコマンドをキャンセルします。フリートでは、各結果の command に同じ state が含まれます。フリート（複数の ID、--tag または --folder）には --yes が必要です。拒否または失敗したリクエスト、および同一リクエストの完全なリプレイは、スクリーンごとの clear-cache、restart-app、update-software を合わせた10分間に2件の上限に数えられません。

オフラインのスクリーン宛てにキューに残っているコマンドをキャンセルします。

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

screenrig screen command cancel scr_01EXAMPLESCREEN00000000 rbt_01EXAMPLEREBOOT00000000

オフラインのスクリーンを待っている reboot、reload、clear_cache、restart_app、または update をキャンセルし、送信されないようにします。キャンセルできるのは、キューに入っているコマンドだけです。すでに送信されたコマンド（sent または done）には 409 resource_conflict と "The command was already sent." が返り、キューに入っていないコマンド（expired、cancelled、superseded のいずれか）には 409 resource_conflict と "The command is no longer queued." が返ります。スクリーンのコマンド一覧にない ID には 404 not_found が返ります。回答は、コマンドが cancelled になったスクリーンで、スクリーンのリビジョンは変わりません。

スクリーンの表示、またはフリートの表示を今すぐオンまたはオフにするか、そのオーバーライドを解除します。

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 は screen display set ID の省略形です。clear は --power、--until、--for を受け付けません。screen display は、ディスプレイスケジュールの手動オーバーライドです。--until または --for がない場合、スケジュールの次の境界で終了します。後からディスプレイスケジュールやタイムゾーンを変更すると、その終了も新しい境界に移動します。今後8日以内に境界がない場合（有効なスケジュールがない場合など）は、screen display clear または置き換えまで継続します。screen display clear でオーバーライドが終了し、ディスプレイスケジュールが再び適用されます。スケジュールがなければディスプレイはオンになります。

オーバーライドの保存は Player を待ちません。display.override_status は、より新しいディスプレイ報告とこれを比較します：matches、mismatch、pending、stale、unknown。matches は報告の内容を表すもので、コマンドが実行されたことを示すものではありません。警告 display_power_mismatch は、食い違う最新の報告を示し、display_power_unconfirmed は、より新しい利用可能な報告が必要であることを示します。スクリーンショットを撮る前に screen show を確認してください。display_scrim_only は、Player が黒いオーバーレイしか制御できないことを意味します。on はそれを取り除きますが、ハードウェアのウェイクコマンドは送信しません。保護されたフォルダー内のスクリーンは、ディスプレイの変更を拒否します（protected_target）。

スクリーンのディスプレイがオンのときに表示、設定、またはクリアします。

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

ディスプレイスケジュールは {enabled, windows} で、どちらも必須です。windows には、ディスプレイがオンになる 1 ～ 16 個のウィンドウをスクリーンのタイムゾーンで列挙します。どのウィンドウにも該当しない間は、ディスプレイはスタンバイになります。Player はこれをデバイス上で評価するため、オフラインでも動作し続けます。end が start 以前のウィンドウは日跨ぎになり、start と end がないウィンドウは終日を対象にします。enabled: false はウィンドウを保持したまま、ディスプレイをオンのままにします。display-schedule show は display_schedule（ない場合は null）とスクリーンの display の状態を返します。保存した出力は編集して、set --file で送り返せます。保護されたフォルダー内のスクリーンは、ディスプレイスケジュールの変更を拒否します（protected_target）。

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

screen show --human は Display: をリクエストされた電源状態、そのソース（手動操作・ディスプレイスケジュール・デフォルト）、スクリーンのタイムゾーンでの有効期限、スケジュールウィンドウ、プレーヤーが報告した電源状態を表示します。35分以上報告がない場合は古い情報とみなされます。

スクリーンの音量を設定、またはミュートします。1 台でもフリート全体でも指定できます。

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

スクリーンの音量は1つで、0から100までのレベルとミュートで構成されます。ミュートしてもレベルは保たれるため、ミュートを解除すると元のレベルに戻ります。オンラインのスクリーンは変更を即座に適用し、オフラインのスクリーンは復帰したときに最新のリクエストを適用し、新しいリクエストは以前のものを置き換えます。Player自体の設定メニューで後から行った変更は、次の screen volume まで優先され、そこでレベルを変更するとミュートも解除されます。screen show は最新の requested の変更を伴う volume を報告し、reported として、Player が到達した level と muted、および hardware（レベルがデバイスまたはパネルの出力に反映される場合は true、Player 自身のゲインの場合は false）を報告します。stale は、35 分間レポートがないと true になります。volume 機能を宣言する Player だけがこれを適用します。それ以外のスクリーンは 409 volume_unsupported（終了コード 5）を返し、何も記録されません。アーカイブ済みのスクリーンは screen_archived を返し、ペアリング待ちのスクリーンは resource_conflict を返します。保護されたフォルダー内のスクリーンは変更を拒否し（protected_target）、フリートでは保護されたスクリーンが 1 つあるだけでリクエスト全体が拒否されます。ダッシュボードのスクリーンページにも同じ音量コントロールがあります。

一定時間使用されないとスクリーンの画面を暗転させる、またはそれをオフにします。

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

タッチやキー操作がないまま、または --wake に presence が含まれる場合は画面の前に誰もいないまま --after 秒が経過すると、画面が暗転します。暗転中、Player は再生を停止し（再生回数の記録も広告もなし）、ディスプレイの電源オフを報告します。復帰イベントで画面が即座に点灯して再生が再開され、暗転した画面を復帰させたタッチはページに渡されません。パネルをオフに保つディスプレイスケジュールまたはオーバーライドが優先され、ページが画面に表示されている間に device.display を保持しているアプリケーションも優先されます。変更されるのは display.idle のみです。Player は、screen show のホスト機能に display_power.idle が含まれる場合にこれを適用します。設定はどちらの場合も保存され、screen show はそれを Display idle として表示します。Propose アクセスでは変更できず (insufficient_access)、保護されたフォルダー内のスクリーンでは拒否されます (protected_target)。

スクリーンの明るさをデバイスの光センサーに連動させるかどうかを設定します。

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

変更されるのは display.brightness のみです。Player は、screen show のホスト機能に brightness.auto が含まれる場合に auto を適用します。デバイスがこれを宣言するのは光センサーがある場合だけです。ディスプレイの明るさを設定するアプリケーションは、そのページが表示されている間は優先されます。設定はどちらの場合も保存され、screen show はそれを Display brightness として表示します。screen display-idle のアクセスルールが適用されます。

スクリーンの Player が出力に設定するビデオモードを設定する、または解除します。

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 は、Player が現在設定できるモードを Output modes the Player can set の下に一覧表示し、現在有効なモードも表示します。Player が報告した後は、その一覧にないモードは invalid_request となるため、一覧にあるモードを選んでください。変更されるのは display.output のみです。Player は、screen show のホスト機能に display_output.mode が含まれる場合にこれを適用します。BrightSign プレーヤーはこれを宣言します。ほかの Player で auto 以外のモードを指定すると display_output_unsupported が返ります。解除は常に可能です。Player はモードを一度だけ適用し、適用のために再起動することがあり、到達したモードを報告します。screen display-idle のアクセスルールが適用されます。

スクリーンの Player に、CEC 経由でテレビの HDMI 入力を取得させる、または停止します。

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

変更されるのは display.cec のみです。Player は、screen show のホスト機能に display_power.cec_active_source が含まれる場合にこれを適用します。BrightSign プレーヤーはこれを宣言します。ほかの Player で --on を指定すると display_cec_unsupported が返りますが、--off と --clear は常に使えます。ディスプレイスケジュールまたはオーバーライドでディスプレイがオフになっている間、Player は何も送信しません。CEC の失敗が再生に影響することはありません。screen show は設定を Display CEC として表示します。screen display-idle のアクセスルールが適用されます。

スクリーンの Player を画面に固定する、または固定を解除します。

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 は Android の画面固定を使います。初回は画面の前にいる人が確認し、Player が固定されている間はステータスバー、ホーム、最近使ったアプリが無効になります。オペレーター設定パネルからロックを解除でき、次のマニフェストまたは再起動で再び適用されるまで解除されたままになります。Player は、screen show のホスト機能に kiosk_lock が含まれる場合にこれを適用します。設定はどちらの場合も保存され、有効な間は screen show が Kiosk lock を一覧に表示します。Propose アクセスでは変更できません（insufficient_access）。

バックエンドがスクリーンのデバイスを再起動するタイミングを表示、設定、またはクリアします。

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"

各ウィンドウの開始時に、スクリーンのタイムゾーンで、screenRIG は screen reboot と同じ再起動を発行します。たとえば "Mon-Sun 04:00-04:30" は、毎日現地時間の04:00にスクリーンを再起動します。screen show の commands は source schedule とともにそれを一覧し、screen show と reboot-schedule show は next_reboot_at を表示します。終了が開始と同じかそれより前のウィンドウは日付をまたぎ、時刻のないウィンドウは1日全体を対象とします。reboot-schedule show の保存済み出力は編集して set --file で送り返せます:

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

オンラインのスクリーンには再起動がすぐに送信されます。オフラインのスクリーンでは、ウィンドウが終わるまでのみキューに保持されます。そのため、再起動がウィンドウ外で実行されることはなく、ウィンドウ後に復帰したスクリーンには再起動は行われません。春の時刻前進で存在しない時間帯に入る開始は、ウィンドウ内の最初の有効な分に実行され、秋の時刻後退による繰り返しはウィンドウごと、現地の日付ごとに1回実行されます。予定された再起動が、人が依頼してスクリーンを待っている再起動を置き換えることはありません。その実行は screen.reboot_skipped（reboot_pending）でスキップされます。スクリーンには、reboot を宣言する Player が必要です。後から reboot を失ったスクリーンは各ウィンドウをスキップし、スケジュールは保持されます。タイムゾーンを変更すると、待機中の予定された再起動はキャンセルされ、next_reboot_at が新しいゾーンに移動します。スケジュールが送信した再起動は、screen reboot と同様にオフラインアラートを発生させません。screen.reboot_schedule_changed は設定とクリアをそれぞれ記録します。ファイルは {enabled, windows} で、どちらも必須です。再起動スケジュールはすべてのプランで使えます。フリートでは、各結果はそのスクリーン自身のものです。Player が再起動できないスクリーンには reboot_unsupported が返されます。

スクリーンの 1 日ごとの利用可能状況を 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 は記録された状態ごとに UTC 日単位で 1 行ずつ、古い順に一覧表示します：online_s, offline_s, availability（記録された時間のオンライン；null は何も記録されていない場合）、coverage（その日の記録された状態の割合）、intervals, live（現在までのオープン区間を含む日）。記録のない時間は coverage を下げますが、ダウンタイムにはなりません。何も記録されていない日は行がありません。

スクリーンのオンライン・オフライン遷移を新しい順に一覧表示

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 は at、state、detected_on_reconnect を保持し、サーバーがスクリーンの再接続時にのみ検知したオフライン状態を示します（at はそのプレゼンスリースが終了した時点です）。CLI は next_cursor に従って最後まで進み、すべての遷移に next_cursor null で応答します。範囲が広い場合は --since で絞り込んでください。

スクリーンが報告したヘルスを時間ごとに一覧表示、各報告または1時間ごとの要約

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 は data.samples に応答し、各受理レポートは screen show の health の形（stale なし）です。hour は data.hours に応答し、UTC 時間ごとに1件のサマリー：レポート数、最高・平均温度、ピーク負荷・メモリ比、最弱 Wi-Fi 信号、display_disconnected、ピーククラッシュ・レンダラー再起動回数。CLI は next_cursor の終端まで追従するため、生データが長い場合は範囲を絞るか --resolution hour を使います。生レポートは数秒以内、時間サマリーは約5分以内に届きます。

プレイリストを割り当てる前に、スクリーンの Player が最後に報告したストレージにそのプレイリストが収まるかを確認します。

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

何も書き込みません。割り当て、スクリーンのリビジョン、イベントのいずれも発生しません。読み取り専用アクセスで足り、1台のスクリーンにつき1分あたり最大30回確認できます。data.fit は fits、partial（一部のページが除外される）、none_fit（何も読み込まれない）、または unknown（スクリーンがストレージを一度も報告していない、またはプレイリストのコンテンツが準備できていない）のいずれかです。data.excluded_page_count は除外されたページ数、data.required_bytes はプレイリスト全体に必要な量、data.capacity_bytes は Player が使用できると報告した量、data.basis は reported_capacity、data.received_at は Player が報告した時刻です。fit が unknown の場合、バイト数と received_at は null になります。24 時間より古い報告は古いものとして示されますが、そのまま使われます。プレイリストが収まらない場合、応答には警告 storage_full が付きます。Player が動作しているデバイスのストレージを空けてから、もう一度確認してください。キャッシュとストレージでこのプランを説明しています。保存された割り当ては、再生を保証するものではありません。