{"display":{...}} envelope is deprecated — the player answers invalid param: display.web Command Format
| Field | Req. | Notes |
|---|---|---|
| url | yes | Page address. Use direct MP4 links for video (HTML5) and direct links for PDF (built-in viewer) |
| method | no | HTTP method, GET by default; POST carries data as the request body |
| data | no | POST body verbatim (form string or JSON string; set Content-Type via header) |
| cookie | no | "k=v; k2=v2", injected for the url's domain before loading |
| header | no | Custom request headers, first load only (in-site navigations don't carry them — browser semantics) |
| vars | no | Variables injected into the page (plugin params, any JSON). Persisted per area: pages read it via window.superScreen.data, and a superscreen event carrying it is dispatched after every load. The same plugin URL can carry different vars in different areas |
| interval | no | Auto-refresh interval in seconds, default 0 = off (adjust at runtime via control interval). New content resets it |
| cache | no | Boolean-compatible, default 1; cache:0 skips read/write cache for this load and deletes any existing cache entry for the URL (for private content) |
plugin Command (Plugin Content)
A dedicated envelope for plugins (equivalent to the plugin:// short link in web, but clearer):
| Field | Req. | Notes |
|---|---|---|
| name | yes | Plugin slug (string ID from the market/my-plugins list); missing or invalid answers invalid param: name |
| v | no | Version number (the plugin's update_time), part of the cache key — after the plugin is edited, a changed v makes the player re-download |
| vars | no | Plugin parameter object (any JSON), same semantics as web's vars |
| area | no | Target area; defaults to the default display area |
The player expands it to the API-site show URL https://app.thingboot.com/screen/plugin/show/<name>/ (with ?v= when v is set), then follows the local-hosting path. The persisted content is the expanded URL, so restart recovery self-heals.
plugin:// Short Links
The URL form for plugins (use directly in the web envelope's url field):
| Short link | Expands to |
|---|---|
plugin://slug | https://app.thingboot.com/screen/plugin/show/slug/ |
plugin://slug:zh-cn | https://app.thingboot.com/screen/plugin/show/slug/?lang=zh-cn |
plugin://slug:en | https://app.thingboot.com/screen/plugin/show/slug/?lang=en |
Local hosting: plugin:// and plugin-envelope content is not fetched directly — the device first downloads the page with its UA marker (SuperScreen/<deviceId>) into a local cache (keyed by md5(source URL), same LRU as the media cache), and the area window loads the local address http://127.0.0.1:<port>/plugin/<md5>/ instead. Benefits: isolated from the site's login origin, offline-capable, no mixed content. A failed first download does not fall back to HTTPS (nothing is shown); cached plugins work fully offline. Plain http(s) URLs never touch the local service.
Query Current Content
{"web":{"area":"a5"}} (without url/data) → returns the area's current content {"url":...,"method":...,"cookie":...,"header":{...}}; {} when empty. For plugin content, url is the persisted source address (the API-site show URL).
Notes
- An area receiving a web/plugin command rises to the front (without stealing focus)
- Omitting the area targets the default display area (see "Area Naming & Coordinates" on this book's home page)
- The website's "Plugin Center → Send to screen" builds exactly the plugin command (v = the plugin's update_time, forming a new cache key; vars = the DATA produced by the panel)
- Main-frame load failures or HTTP 4xx/5xx show a built-in friendly error page (dark, error code, URL); sub-resource failures don't trigger it