Built-in system commands, product config items (config channel), and device-initiated event reports.
System Commands ({"system":...})
| Command | Notes |
|---|---|
| {"system":"info"} | System info (id/key/mode/bench/version...) |
| {"system":"network"} | Network info {"type","mac","ip","mask","gateway","dns"}: type is the current link (wifi/ether); ip/mask/gateway/dns describe the active adapter (WiFi-only fields like channel/signal/ssid have no desktop/mobile API and are omitted) |
| {"system":"state"} | Device attributes (empty {} when none registered) |
| {"system":"reg"} | Re-register (after rebind/bench transfer) |
| {"system":"ntp"} | Force time sync |
| {"system":"restart"} | Acknowledged only, not executed (a Flutter app cannot restart itself) |
| {"system":{"host":"..."}} | Switch server (takes effect on next connect) |
| {"system":"private"/"platform"} | Private/platform mode switch (no self-restart; applies after a manual restart) |
| ble_* / wifi_* etc. | Hardware network management commands are meaningless for a player — always answered as unsupported |
Device Config Items (config channel)
The platform declares config items in the product definition; they are read/written over the config topic (same mechanism as the console settings page). Current items:
| name | Meaning | Values |
|---|---|---|
| autorun | Launch on boot | 0 / 1 |
| restore | Restore display on launch (reopen areas with their content) | 0 / 1 |
| layout | Display area layout (AreaLayout JSON) | JSON |
| ctrlcode | Control code (credential for remotes without sign-in; empty = disabled) | 6 digits / empty |
| speech_engine | Speech engine: follow system / system / bundled offline engine | "" / system / sherpa |
| speech_lang | Speech language | sys / zh / en |
| speech_volume | Speech volume | 0~100 |
| speech_rate | Speech rate factor | 0.5~2.0 |
| bgm_volume | Background music volume | 0~100 |
| bgm_duck | Audio ducking while speaking | no / 10 / 20 / 30 / pause |
| orientation | Display orientation (phones/tablets only) | system / landscape / portrait |
| locale | On-device UI language | sys / zh / en |
- Cloud writes (config/server) apply immediately and persist; cloud reads (fetch) return the device's live state
- On-device local changes are published on the config topic as numeric values like
{"autorun":1}(not the event topic) - New config items added to the product definition later appear in the website settings panel automatically — no code changes needed
Device Event Reports (event/client)
One event concerns one display area; simultaneous changes across areas produce multiple events.
| name | When | data |
|---|---|---|
| online | Connected (SDK built-in) | {"name":"online","state":{...}} |
| offline | Last-will on disconnect (SDK built-in) | {"name":"offline"} |
| open | Area window opened | {"name":"open","area":"a6"} |
| close | Area window closed (incl. crash) | {"name":"close","area":"a6"} |
| change | Layout changed | {"name":"change","area":"a6","data":[t,l,w,h,layer]}; data is [] on removal |
| content | Area content changed (send/clear/restore) | {"name":"content","data":{"area":"a6","type":"video"}}; type is an empty string when cleared |
| user | Page reports via SS.report() (device-level rate limit 30/min) | {"name":"user","area":"a6","data":{...}} |
| custom | Page reports via the legacy superScreenEvent handler (kept for compatibility) | {"name":"custom","area":"a6","data":{...}} |
| toggle | User switched work mode locally (command-path switches only show in replies, no such event) | {"name":"toggle","data":{"mode":"console|screen|remote"}} (no area) |
Connectivity has only online/offline (SDK mechanism; no boot/shutdown). Subscribe to these events via the Open Platform's message push (see the API book).