Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-12-26 17:27:47 +01:00
Code Issues Projects Releases Wiki Activity

Add docs for additional VA triggers (#3382)

Browse Source
This commit is contained in:
Keith Burzinski 2023-11-15 21:29:58 -06:00 committed by GitHub
parent 1f7ad776c1
commit 97f37708d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
components/voice_assistant.rst
View File

@ -37,6 +37,8 @@ Configuration:
- **media_player** (*Optional*, :ref:`config-id`): The :doc:`media_player </components/media_player/index>` to use - **media_player** (*Optional*, :ref:`config-id`): The :doc:`media_player </components/media_player/index>` to use
to output the response. Cannot be used with ``speaker`` above. to output the response. Cannot be used with ``speaker`` above.
- **use_wake_word** (*Optional*, boolean): Enable wake word on the assist pipeline. Defaults to ``false``. - **use_wake_word** (*Optional*, boolean): Enable wake word on the assist pipeline. Defaults to ``false``.
- **on_intent_start** (*Optional*, :ref:`Automation <automation>`): An automation to perform when intent processing starts.
- **on_intent_end** (*Optional*, :ref:`Automation <automation>`): An automation to perform when intent processing ends.
- **on_listening** (*Optional*, :ref:`Automation <automation>`): An automation to - **on_listening** (*Optional*, :ref:`Automation <automation>`): An automation to
perform when the voice assistant microphone starts listening. perform when the voice assistant microphone starts listening.
- **on_start** (*Optional*, :ref:`Automation <automation>`): An automation to - **on_start** (*Optional*, :ref:`Automation <automation>`): An automation to
@ -48,6 +50,10 @@ Configuration:
- **on_stt_end** (*Optional*, :ref:`Automation <automation>`): An automation to perform - **on_stt_end** (*Optional*, :ref:`Automation <automation>`): An automation to perform
when the voice assistant has finished speech-to-text. The resulting text is when the voice assistant has finished speech-to-text. The resulting text is
available to automations as the variable ``x``. available to automations as the variable ``x``.
- **on_stt_vad_start** (*Optional*, :ref:`Automation <automation>`): An automation to perform when voice activity
detection starts speech-to-text processing.
- **on_stt_vad_end** (*Optional*, :ref:`Automation <automation>`): An automation to perform when voice activity
detection ends speech-to-text processing.
- **on_tts_start** (*Optional*, :ref:`Automation <automation>`): An automation to perform - **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 when the voice assistant has started text-to-speech. The text to be spoken is
available to automations as the variable ``x``. available to automations as the variable ``x``.