status
- Command
status- Area
- basics
- Profile
- mandatory
- Response
- state and key figures of the display
Request and response#
{"v":1,"cmd":"status"}
{"v":1,"ok":true,"result":{
"state":"active","session":true,
"monitor":{"index":1,"w":1920,"h":1080},
"uptime_s":38412}}
| Field | Required | Content |
|---|---|---|
state |
yes | idle, active, farewell or saver |
session |
yes | whether a session is currently open |
monitor.index |
no | number of the screen being used |
monitor.w, monitor.h |
no | its resolution in pixels |
uptime_s |
no | uptime of the display in seconds |
What it is for#
status is meant for troubleshooting and for management interfaces: it answers
the question "what is actually on that screen?" without anyone having to stand
in front of it.
Day-to-day operation does not need the command. A controlling program keeps its own state and does not query the display for it – in particular it must not poll at short intervals to notice changes.