Restart, reload or power screens
control_screensSend a device action to one or many screens.
When to use:
A change has not appeared, a screen is frozen, an old or broken file keeps playing, or the TV must go on or off.
When NOT to use:
Changing content: use set_screen_content. New data from a feed or web page: use refresh_data.
What to know:
Devices act within seconds; offline ones act when they come back. Check the result with capture_screenshot. Needs screen.edit.
Parameters:
action: refresh (reload content, no restart; try first), reboot (restart; about a minute blank), clear_cache (delete stored files so they download again; media shows late meanwhile), tv_on or tv_off (HDMI-CEC TVs only; the player keeps running).
screenId and screenIds: give either or both; they combine into one set, each screen gets the action once, and screens out of reach are skipped.
Example: {action:"refresh", screenIds:["scr_7", "scr_8"]}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | Device action. | |
| screenId | No | Screen id. | |
| screenIds | No | Screen ids. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| queued | No | How many screens the action was sent to. | |
| skipped | No | Screens skipped as out of reach. | |
| commandIds | No | Ids of the queued commands. |