Skip to main content
Category: Controls · Emits: transcribed text (to scripts) · Reads data: no

​
Mental model

A Voice to Text widget is a dictation mic. It listens, transcribes speech to text, and hands that text to your logic — hands-free input for a dashboard.

​
When to use it

  • Voice commands (“turn on the light”)
  • Hands-free text entry

​
Settings

​
General

  • Widget Title / ID
  • Language — recognition language
  • Continuous recognition — keep transcribing
  • Always listening — hands-free
  • Auto-send on speech end — emit when the user pauses

​
Triggers

EventFires when
speechResultA transcription is produced (carries the text)
speechStart / speechEndSpeaking starts / stops
(common)load, ready, destroy, update, visible, hidden

​
Acting on the transcription

Use the Script API — the event carries the recognized text: 
widget.on('voiceInput', 'speechResult', (text) => {
  if (text.toLowerCase().includes('turn on')) {
    ws.send(context.deviceId, { command: 'Operate', action: 'ON' });
  }
});

Text to Speech

The reverse — speak text aloud.