All SuperScreen commands by group: screen (layout), web/plugin & type keys (content), control (manipulation), cache, speech (TTS), bgm, system & config.
The Channel
Commands travel over ThingBoot MQTT. Topic format: thing/{productKey}/{deviceKey}/{topic}/{side} (/server cloud→device, /client device→cloud). This product's productKey is fixed at xtjhFX4o8x.
Message envelope (same both directions):
Wrapper Keys
Product commands are distinguished by wrapper key (bare commands are rejected):
| Key | Purpose |
|---|---|
| screen | Layout & windows: add/update/remove areas, open/close/show/hide/clear |
| web | Content: push a page URL to an area (cookie/header/POST/vars/interval) |
| plugin | Plugin content by slug (name required, v/vars optional) |
| image etc. | Content shortcuts: image / document / video / audio / text templates |
| control | Manipulation: scroll/zoom/page/volume/seek/refresh/pass-through (flat envelope) |
| cache | Device-level media cache switch and cleanup |
| speech | TTS: text, language, volume, rate, queue control |
| bgm | Background music (does not occupy any display area) |
| system | System commands (built into the SDK): info/network/state/reg/ntp... |
Note: the old {"display":{...}} envelope is deprecated — the player answers invalid param: display. Use web for page content.
Reply Convention
- Success:
{"ret":"ok"}; queries return data directly (noretwrapper) - Failure:
{"ret":"error","msg":"..."}(no such area /invalid param: <key>/ validation failure /unsupportedfor wrong content type) - Replies carry the original command's
midso the platform can pair request and reply
Area Naming & Coordinates (all commands)
- On first launch the player auto-creates area
a1covering the whole monitor and makes it the default area; - Default area: recorded as the layout's
defaultfield; when unset, the earliest added surviving area is the default. A device must always have one; - At least one area must exist (the last one cannot be removed); auto naming fills gaps from
a1(with a1/a3 present, the next area is a2); - Areas can be renamed to letters+digits, unique, never
default(reserved); positionis a pixel array[top, left, width, height, layer?]; the 5th elementlayeris stacking order (bigger = closer to front, default 0); rendering stacks by ascending layer, then by name;- Content/screen commands without an area act on the default area; control requires area; open/close/show/hide without an area act on all;
- An empty area shows a grey translucent placeholder (name, resolution, position).