Every channel between the display page and the device: the injected object, DATA, custom events and the UA marker.
window.superScreen (injected at document start — readable before any page script runs)
SS facade (injected at document start — the recommended API)
| Method | Notes |
|---|---|
| SS.info | Same as window.superScreen (device info object) |
| SS.data | vars sent by the plugin/web command (null when absent) |
| SS.speech(text, {lang, volume}) | Speak with the device TTS; Promise resolves {ok:true} / {ok:false,error}. Only on locally-hosted plugin pages; purely local, no cloud traffic |
| SS.stopSpeech() | Stop page-triggered speech |
| SS.report(data) | Report a user event to the platform; device-level sliding-window limit 30/min, over-limit returns {ok:false,error:"rate limited"} and nothing is sent |
| SS.onCommand(fn) | Register a callback for control send payloads (any JSON, interpreted by the page author); the same payload is also dispatched via the superscreen event |
Receiving Data
Two equivalent paths — one listener covers both:
Reporting Custom Events
UA Marker
The User-Agent carries SuperScreen/<deviceId> (SuperScreen/0 without an ID), usable for server-side checks on the main document request. Sub-requests (fetch, images) are not guaranteed to carry it — pages should always rely on window.superScreen instead.
Pre-Publish Checklist
- Adapts to any resolution and orientation
- Dark background, no keyboard/mouse required, no external login dependency
- All assets use absolute HTTPS URLs
- Parameters read from window.superScreen.data / the superscreen event, with sane defaults when no DATA was ever pushed