config.get and config.set
- Commands
config.get,config.set- Area
- device (
config) - Profile
- manageable
- Response
- key and value, or
ok
Request and response#
{"v":1,"cmd":"config.get","key":"idle.timeout_s"}
{"v":1,"ok":true,"result":{"key":"idle.timeout_s","value":90}}
{"v":1,"cmd":"config.set","key":"idle.timeout_s","value":120}
{"v":1,"ok":true}
Every display decides for itself which keys it exposes. An unknown key yields
404 unknown_key, an unusable value 400 bad_request – in both cases the
existing setting remains unchanged.
Recommended keys#
| Key | Kind | Meaning |
|---|---|---|
idle.timeout_s |
number | idle time until the idle screen, in seconds |
saver.timeout_s |
number | idle time until the screen saver; 0 switches it off |
farewell.seconds |
number | default duration of the goodbye |
display.lang |
text | language the display uses when none is sent |
What does not belong here#
config.set is meant for daily operation, not for installation: typefaces,
colours, background images and layout remain the business of the display and its
own settings.
Whether a display keeps values set here permanently or only until it is next started is left to it. A controlling program must therefore not rely on a value surviving a restart.