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

Add light on_state trigger (#1700)

Browse Source 
Co-authored-by: Oxan van Leeuwen <oxan@oxanvanleeuwen.nl>
This commit is contained in:
tony 2021-12-12 15:20:00 -05:00 committed by GitHub
parent 43be2c045e
commit c4d3376857
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
components/light/index.rst
View File

@ -50,6 +50,8 @@ Configuration variables:
when the light is turned on. See :ref:`light-on_turn_on_off_trigger`.
- **on_turn_off** (*Optional*, :ref:`Action <config-action>`): An automation to perform
when the light is turned off. See :ref:`light-on_turn_on_off_trigger`.
- **on_state** (*Optional*, :ref:`Action <config-action>`): An automation to perform
when the light's set state is changed. See :ref:`light-on_state_trigger`.
Additional configuration variables for addressable lights:
@ -398,6 +400,25 @@ with the behavior of the ``light.is_on`` and ``light.is_off`` condition above.
on_turn_off:
- logger.log: "Light Turned Off!"
.. _light-on_state_trigger:
``light.on_state`` Trigger
**************************
This trigger is activated each time the set light state is changed. It is not triggered
based on current state, but rather, it triggers on the set state which can differ from
the current state due to transitions. For example, the ``light.on_state`` trigger can
be used for immediate action when the light is set to off; while ``light.on_turn_off``
does not trigger until the light actually achieves the off state.
.. code-block:: yaml
light:
- platform: binary # or any other platform
# ...
on_state:
- logger.log: "Light State Changed!"
.. _light-effects:
Light Effects