Docs

Install, bind and drive your SuperScreen displays

Quick Start

SuperScreen turns any screen into a cloud-managed web display. The desktop build has two processes: console.exe (UI and cloud connection) and player.exe (one borderless browser window per display area).

Three steps

  1. Get the Windows package from the download page, unzip and run the console.
  2. The home screen shows your device ID. Enter your bench ID on the device to bind it.
  3. Push content from the Remote or the ScreenHub — it appears on screen instantly.

Bind Bench

SuperScreen uses ThingBoot platform accounts, and a bench is the tenant: devices belong to a bench, and every member of that bench can manage its devices.

  • Device already bound: any member of the bench can open the Remote right away.
  • Not bound yet: type your bench ID on the device home screen (both device ID and bench ID are shown there).

Display Areas

A screen can be split into multiple areas. Each area is an independent borderless browser window positioned in pixels: [top, left, width, height, layer?]. With no layout, a full-screen default area exists.

操作Description
add / updateAdd / update an area (position and layer)
renameRename an area
removeRemove an area
infoList all areas
clearClear area content
open / closeOpen / close windows (all areas if no name given)
show / hideRestore / minimize (content kept)

Content Push

Push a URL to an area and the device loads it full-screen. Use direct MP4 links for video (HTML5 playback) and direct PDF links (built-in viewer). Cookies, custom headers and POST data are supported; headers apply to the first load only. An area receiving new content rises to the front without stealing focus.

{"display":{"area":"a5","url":"https://example.com/board"}}

Omit the url to query what the area is currently showing.

Browser Control

Remote-control the browser window of each area. Keys can be combined freely; unknown keys are ignored.

keyDescription
back / forward后退 / 前进
reload / force_reloadReload / hard reload
scroll / scroll_toRelative / absolute scroll [x,y]
zoomPage zoom (integer percent)
clear清除内容
sendSend custom JSON data to the page

Text-to-Speech

Push text from the cloud and the device speaks it. Announcements play in FIFO order.

  • text to speak; lang zh/en (defaults to system);
  • volume (default 60); repeat (default 1);
  • Setting lang or volume alone persists it; stop silences the queue.
{"speech":{"text":"Welcome","lang":"zh","volume":80,"repeat":3}}

页面 JS 桥

On-screen pages can talk to the device (for ScreenHub developers):

  • UA marker: SuperScreen/<deviceId> (0 when unregistered);
  • Injected object: window.superScreen = {deviceId, area, bench, version};
  • Receive cloud send data: window.addEventListener('superscreen', e => e.detail);
  • Report custom events: window.flutter_inappwebview.callHandler('superScreenEvent', data).

Pages should adapt to any resolution and orientation, prefer dark backgrounds (the device defaults to black), and never require keyboard or mouse.

System command

Device maintenance commands: info, network, state, reg (re-register) and ntp (time sync). Full-package OTA is triggered by pushing a package name — the device downloads, upgrades and reboots itself.

Event Reports

Devices continuously report events that the Remote page can show live: online / offline, open / close (area windows, including crashes), change (layout changes) and custom events sent by pages via the JS bridge.