Push commands to SuperScreen, query devices and subscribe to events via the cloud open API. Command bodies are identical to the Commands book.
Pushing Commands
Endpoint: http(s)://api.thingboot.com/{AppID}/order/?sign={sign}&ts={ts} (or MQTT topic api/{AppID}/order). Parameters and responses are documented in "Send Command to Device".
For SuperScreen, the order payload is simply a command wrapper key:
Common Scenarios
| Scenario | Command |
|---|---|
| Store posters | web an image/poster page URL (direct MP4 links for video) |
| Scheduled content | Your scheduler issues different web commands on a timetable |
| Split-screen | screen add/update to define areas, then web each |
| Closing time | screen clear or control clear |
| Welcome messages | speech with the greeting text |
| Plugin casting | plugin with the slug and vars (see the Plugins book) |
Queries & Event Subscription
- Device/network/state info:
{"system":"info"}/{"system":"network"}/{"system":"state"}; - Layout and current content:
{"screen":{"action":"list"}},{"web":{"area":"a5"}}(queries return data directly); - Device events (online/offline, area open/close, layout changes, page custom events, local setting changes) are delivered via the platform's message push — see the message push section of the Platform API documentation;
- OTA follows the platform firmware OTA flow, with artifacts distinguished by this product's productKey.
Notes
- You can target multiple devices in one call (the device parameter accepts separators), but they must all be the same product;
- Replies return asynchronously over the same channel with the original mid — pair requests with replies and handle timeouts in your system;
- Keep the push rate to a few commands per second to avoid pressuring devices and the channel.
API-Site Endpoints (app.thingboot.com/screen/, for remotes & the plugin ecosystem)
A set of HTTPS endpoints parallel to the Open Platform's AppID system, used by the remote pages and the plugin ecosystem. Auth is either ?token= (login token; the Authorization: Bearer header works too) or ?code= (the device control code). JSON replies look like {"code","data","msg"}.
| Endpoint | Notes |
|---|---|
| GET device/channel/?id= | Cloud channel info (Pusher connection params + code-auth flag + online state) |
| POST device/config/?id= | Config read/write (names batch read / fetch full read / write) |
| POST device/system/?id= | System ops (bench transfer / reg / restart / mode) |
| GET device/info/?id= | Read device name & remark (control code or login) |
| POST device/rename/?id= | Change name/remark (name 4~32 chars: CJK/letters/digits/_/-; empty remark clears) |
| POST auth/control/ | Pusher remote-channel auth (bench members free; otherwise the control code is checked) |
| GET plugin/show/<slug>/ | Plugin display page (content only for SuperScreen/ UA or ?preview=1) |
| GET plugin/panel/?id= | Plugin panel page (DATA changes are postMessage'd to the parent — the cross-origin way to read params) |
| GET plugin/list/ | Market plugin list (on-shelf; id/slug/title/icon/orient/has_panel/update_time) |
| GET plugin/my/ | My plugins (login token required; lists the current user's plugins) |
| GET tts/sources/ | Extra download sources for speech models |
Login tokens come from POST /user/login/ (account + md5 password + client device identifier; the identifier is issued by POST /user/device/register/).