Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-09-30 04:37:44 +02:00
Code Issues Projects Releases Wiki Activity

[voice_assistant] Timer triggers (#3877)

Browse Source 
Co-authored-by: Keith Burzinski <kbx81x@gmail.com>
This commit is contained in:
Jesse Hills 2024-05-30 13:09:23 +12:00 committed by GitHub
parent 9ecb529cc2
commit 9e52a9816c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
components/voice_assistant.rst
View File

@ -82,6 +82,19 @@ Configuration:
- **volume_multiplier** (*Optional*, float): Volume multiplier to apply to the assist pipeline.
Must be larger than 0. Defaults to 1 (disabled).
- **on_timer_started** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a voice assistant
timer has started. The timer is available as ``timer`` of type :apistruct:`voice_assistant::Timer`.
- **on_timer_finished** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a voice assistant
timer has finished. The timer is available as ``timer`` of type :apistruct:`voice_assistant::Timer`.
- **on_timer_cancelled** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a voice assistant
timer has been cancelled. The timer is available as ``timer`` of type :apistruct:`voice_assistant::Timer`.
- **on_timer_updated** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a voice assistant
timer has been updated (paused/resumed/duration changed). The timer is available as ``timer`` of type :apistruct:`voice_assistant::Timer`.
- **on_timer_tick** (*Optional*, :ref:`Automation <automation>`): An automation to perform when the voice assistant timers
tick is triggered.
This is called every **1 second** while there are timers on this device.
The timers are available as ``timers`` which is a ``std::vector`` (array) of type :apistruct:`voice_assistant::Timer`.
.. _voice_assistant-actions:
Voice Assistant Actions