Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-12-25 17:17:54 +01:00
Code Issues Projects Releases Wiki Activity

Migrate ESPColor to Color (#1036)

Browse Source 
* Migrate ESPColor to Color

* Fixed note indentation
This commit is contained in:
SenexCrenshaw 2021-03-02 09:09:13 -05:00 committed by GitHub
parent f2b2bd475f
commit bf3e251e2e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
components/light/index.rst
View File

@ -718,9 +718,13 @@ This effect allows you to access each LED individually in a custom light effect.
Available variables in the lambda: Available variables in the lambda:
- **it** - :apiclass:`AddressableLight <light::AddressableLight>` instance (see API reference for more info). - **it** - :apiclass:`AddressableLight <light::AddressableLight>` instance (see API reference for more info).
- **current_color** - :apistruct:`ESPColor <light::ESPColor>` instance (see API reference for more info). - **current_color** - :apistruct:`Color <Color>` instance (see API reference for more info).
- **initial_run** - A bool which is true on the first execution of the lambda. Useful to reset static variables when restarting a effect. - **initial_run** - A bool which is true on the first execution of the lambda. Useful to reset static variables when restarting a effect.
.. note::
ESPColor has been migrated to Color. See :apistruct:`Color <Color>` for more information.
.. code-block:: yaml .. code-block:: yaml
light: light:
@ -733,18 +737,18 @@ Available variables in the lambda:
// it.size() - Number of LEDs // it.size() - Number of LEDs
// it[num] - Access the LED at index num. // it[num] - Access the LED at index num.
// Set the LED at num to the given r, g, b values // Set the LED at num to the given r, g, b values
// it[num] = ESPColor(r, g, b); // it[num] = Color(r, g, b);
// Get the color at index num (ESPColor instance) // Get the color at index num (Color instance)
// it[num].get(); // it[num].get();
// Example: Simple color wipe // Example: Simple color wipe
for (int i = it.size() - 1; i > 0; i--) { for (int i = it.size() - 1; i > 0; i--) {
it[i] = it[i - 1].get(); it[i] = it[i - 1].get();
} }
it[0] = ESPColor::random_color(); it[0] = Color::random_color();
// Bonus: use .range() and .all() to set many LEDs without having to write a loop. // Bonus: use .range() and .all() to set many LEDs without having to write a loop.
it.range(0, 50) = ESPColor::BLACK; it.range(0, 50) = Color::BLACK;
it.all().fade_to_black(10); it.all().fade_to_black(10);
.. code-block:: yaml .. code-block:: yaml
@ -768,7 +772,7 @@ Available variables in the lambda:
// again you can use the initial_run variables // again you can use the initial_run variables
if (initial_run) { if (initial_run) {
progress = 0; progress = 0;
it.all() = ESPColor::BLACK; it.all() = Color::BLACK;
// optionally do a return so nothing happens until the next update_interval // optionally do a return so nothing happens until the next update_interval
return; return;
} }