From 0ce9c22b2c5837d84982ef4538f15e39770dc897 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Major=20P=C3=A9ter?= Date: Tue, 4 Jun 2019 12:16:09 +0200 Subject: [PATCH] Scaneffectlength (#264) * Added documentation for scan_length in Addressable Scan Effect * Renamed scan_length to scan_width in Addressable Scan Effect, fixed default value in example --- components/light/index.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/components/light/index.rst b/components/light/index.rst index 3d339f89f..dbd3cb2bb 100644 --- a/components/light/index.rst +++ b/components/light/index.rst @@ -563,12 +563,15 @@ currently active light color. - addressable_scan: name: Scan Effect With Custom Values move_interval: 100ms + scan_width: 1 Configuration variables: - **name** (*Optional*, string): The name of the effect. Defaults to ``Scan``. -- **move_interval** (*Optional*, :ref:`config-time`): The interval with which to move the dot one LED forward. +- **move_interval** (*Optional*, :ref:`config-time`): The interval with which to move the dot/line one LED forward. Defaults to ``100ms``. +- **scan_width** (*Optional*, integer): The number of LEDs to use. + Defaults to ``1``. Addressable Twinkle Effect **************************