Skip to main content

Idle

A general idle screen that can be used in idle states.

Screen Type Id : idle

Properties

KeyTypeDescription
backgroundascii stringName of the asset to use as background image on UI. See assets for details.
The asset must be a 320x480 px png file.

Example

curl -X 'POST' ${CPS_UI_URL} \
-H 'Authorization: CPS apikey="'${CPS_API_KEY}'"' \
-H 'Content-Type: application/json' \
-d '{
"id": "my-idle-screen",
"type": "idle",
"properties": {
}
}

Idle Screen