Script API Overview - Hyperwisor

The Script tab lets you add JavaScript logic to a dashboard — react to widget changes, talk over the realtime channel, read and write the database, and more. The script runs once, when the dashboard loads. Everything reactive happens through the listeners you register in it (widget.on, ws.onMessage, timers) — so the typical shape is: set up state, register handlers, done. Your code runs in a sandboxed context with a fixed set of globals.

The sandbox globals

Your script is executed with these variables already in scope — you don’t import anything:

Global	Purpose
`widget`	Read and control widgets (reference)
`ws`	Send and receive realtime messages (reference)
`storage`	Persist small values on the client (reference)
`db`	Query and insert database records (reference)
`location`	Read device geolocation (reference)
`context`	Product, device, and user info (reference)
`sensor`	Product sensor helpers
`usb`	Product USB helpers
`pdf`	PDF export helpers
`console`	Logging — output appears in the script console
`fetch`	Standard `fetch` for HTTP requests
`setTimeout` / `setInterval`	Standard timers

A first script

// Update a label when a slider changes
widget.on('brightnessSlider', 'change', (value) => {
  widget.setText('brightnessLabel', `Brightness: ${value}%`);
});

Fetch & timers

fetch is the standard Fetch API — call external HTTP APIs directly from a script:

// Pull data from an external API and show it
const response = await fetch('https://api.example.com/data');
const data = await response.json();
widget.setText('externalValue', String(data.value));

setTimeout / setInterval are the standard timers. Keep interval handles so you can clear them:

const id = setInterval(async () => {
  const rows = await db.query('status', {}, { limit: 1 });
  if (rows.length) widget.setText('statusLabel', rows[0].state);
}, 5000);
// later: clearInterval(id);

console.log/warn/error/info output appears in the script console panel below the editor — your main debugging tool.

When to use scripts

Glue logic between widgets — when one changes, update another
Custom realtime handling — interpret incoming device messages your own way
Client-side persistence — remember a user’s last choice
Data-driven UI — query the database and render the result

widget

Values, text, visibility, layout, config, events.

ws

Realtime send / receive.

db

Query and insert records.

Events

The full widget event vocabulary.

​The sandbox globals

​A first script

​Fetch & timers

​When to use scripts