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

Add new Action and Condition. (#3953)

Browse Source 
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
NP v/d Spek 2024-08-14 05:42:46 +02:00 committed by GitHub
parent ab3781ab3a
commit 11ade94a73
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
components/speaker/index.rst
View File

@ -60,6 +60,17 @@ Configuration variables:
- **id** (*Optional*, :ref:`config-id`): The speaker to control. Defaults to the only one in YAML.
.. _speaker-finish:
``speaker.finish`` Action
^^^^^^^^^^^^^^^^^^^^^^^^^
This action will stop playing audio data from the speaker after all data **is** played.
Configuration variables:
- **id** (*Optional*, :ref:`config-id`): The speaker to control. Defaults to the only one in YAML.
.. _speaker-conditions:
Speaker Conditions
@ -79,6 +90,21 @@ Configuration variables:
- **id** (*Optional*, :ref:`config-id`): The speaker to check. Defaults to the only one in YAML.
.. _speaker-is_stopped:
``speaker.is_stopped`` Condition
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This condition will check if the speaker is fully stopped audio data and is in idle mode.
.. note:
Between the time ``speaker.is_playing`` is false and ``speaker.is_stopped`` is true the 'speaker' component is closing down structures that where used to play the data correctly. *It better to check if the speaker is stopped then that if it plays.*
Configuration variables:
- **id** (*Optional*, :ref:`config-id`): The speaker to check. Defaults to the only one in YAML.
Platforms
---------