From 31165f4ed23542fc07482fbfba3e466749032f0d Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Tue, 7 Nov 2023 12:39:51 +1300 Subject: [PATCH] Pulse light effect transition updates (#3321) --- components/light/index.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/components/light/index.rst b/components/light/index.rst index 80bb9f668..9d44914eb 100644 --- a/components/light/index.rst +++ b/components/light/index.rst @@ -492,11 +492,21 @@ This effect makes a pulsating light. The period can be defined by ``update_inter name: "Slow Pulse" # transition_length: 1s # defaults to 1s update_interval: 2s + - pulse: + name: "Asymmetrical Pulse" + transition_length: + on_length: 1s + off_length: 500ms + update_interval: 1.5s Configuration variables: - **name** (*Optional*, string): The name of the effect. Defaults to ``Pulse``. -- **transition_length** (*Optional*, :ref:`config-time`): The duration of each transition. Defaults to ``1s``. +- **transition_length** (*Optional*, :ref:`config-time`): The duration of each transition. + Defaults to ``1s``. Can be a single time or split for on and off using these nested options. + + - **on_length** (*Optional*, :ref:`config-time`): The duration of the transition when the light is turned on. + - **off_length** (*Optional*, :ref:`config-time`): The duration of the transition when the light is turned off. - **update_interval** (*Optional*, :ref:`config-time`): The interval when the new transition is started. Defaults to ``1s``. - **min_brightness** (*Optional*, percentage): The minimum brightness value. Defaults to ``0%`` - **max_brightness** (*Optional*, percentage): The maximum brightness value. Defaults to ``100%``