Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2025-03-01 03:51:36 +01:00
Code Issues Projects Releases Wiki Activity

Add triggers to voice assistant (#2849)

Browse Source
This commit is contained in:
Jesse Hills 2023-04-17 14:57:41 +12:00 committed by GitHub
parent 27c940ccd8
commit 6f3b7d6de0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
components/voice_assistant.rst
View File

@ -24,7 +24,22 @@ Configuration:
microphone: mic_id
- **microphone** (**Required**, :ref:`config-id`): The microphone to use for input.
- **on_start** (*Optional*, :ref:`Automation <automation>`): An automation to
perform when the voice assistant starts listening.
- **on_end** (*Optional*, :ref:`Automation <automation>`): An automation to perform
when the voice assistant is finished all tasks.
- **on_stt_end** (*Optional*, :ref:`Automation <automation>`): An automation to perform
when the voice assistant has finished speech-to-text. The resulting text is
available to automations as the variable ``x``.
- **on_tts_start** (*Optional*, :ref:`Automation <automation>`): An automation to perform
when the voice assistant has started text-to-speech. The text to be spoken is
available to automations as the variable ``x``.
- **on_tts_end** (*Optional*, :ref:`Automation <automation>`): An automation to perform
when the voice assistant has finished text-to-speech. A URL containing the audio response
is available to automations as the variable ``x``.
- **on_error** (*Optional*, :ref:`Automation <automation>`): An automation to perform
when the voice assistant has encountered an error. The error code and message are available to
automations as the variables ``code`` and ``message``.
.. _voice_assistant-actions: