diff --git a/docs/products/ESPHome-Starter-Kit/automations/button-controlled-leds.md b/docs/products/ESPHome-Starter-Kit/automations/button-controlled-leds.md index 730dc6adad..be9a127791 100644 --- a/docs/products/ESPHome-Starter-Kit/automations/button-controlled-leds.md +++ b/docs/products/ESPHome-Starter-Kit/automations/button-controlled-leds.md @@ -87,4 +87,8 @@ With the device back online, press the button on the Button module. You should h !!! success "You've built your first GUI automation!" - The same trigger-then-action pattern works for every automation you'll build in Device Builder. Swap the trigger (motion, temperature crossing a threshold, a schedule) or the action (turn on, dim, play a buzzer tone) and you have a new automation. \ No newline at end of file + The same trigger-then-action pattern works for every automation you'll build in Device Builder. Swap the trigger (motion, temperature crossing a threshold, a schedule) or the action (turn on, dim, play a buzzer tone) and you have a new automation. + +#### Next Steps + + Next - Light Effects \ No newline at end of file diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md b/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md new file mode 100644 index 0000000000..7608ffb5c4 --- /dev/null +++ b/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md @@ -0,0 +1,54 @@ +--- +title: Light Effects +description: >- + Add built-in ESPHome light effects (rainbow, color wipe, and more) to your + RGB module by pasting a few lines into the Effects field. +--- +# Add Light Effects to Your RGB Module + +Out of the box, your RGB module turns on, turns off, and changes color. ESPHome ships a library of built-in light effects (rainbow cycles, color wipes, flickers, and more) that you can drop in with a couple of lines of YAML. This tutorial adds two effects to get you started. + +!!! note "Before you start" + + Work through these pages first. This tutorial assumes your device is flashed and has an addressable RGB light component already configured (either the **Onboard RGB LED** or the **RGB LEDs** from the LED & Buzzer module): + + * [First Steps](/products/ESPHome-Starter-Kit/setup/first-steps/) to create your starter kit device in ESPHome Device Builder. + * [Adding the LED & Buzzer Module](/products/ESPHome-Starter-Kit/modules/rgb-buzzer-module/) if you're using the LED & Buzzer module. + +## Add the effects + +1. Open your starter kit device in ESPHome Device Builder and click **Edit**. +2. In the editor's left pane, scroll to **Components** and click the RGB light you want to add effects to (either **Onboard RGB LED** or **RGB LEDs**). +3. Toggle on **Show advanced settings**, then scroll down to the **Effects** field. +4. Paste the following into the **Effects** field: + + ```yaml + - addressable_rainbow: + - addressable_color_wipe: + ``` + + This adds two effects to the light: a continuously cycling rainbow and a sweeping color wipe. + +??? info "Browse more effects" + + ESPHome's full effect library lives at esphome.io/components/light. Open it in a new tab and pick anything you want to try. + + The starter kit RGB modules are **addressable** lights (each LED can be controlled individually), so look for effect names that start with `addressable_`. Non-addressable effects like `pulse` or `strobe` will not apply. + +## Install the firmware + +The effects are saved in Device Builder, but the device is still running its old firmware. Compile and install the new code to push the change. + +1. Click **Save** in the bottom right of the editor. +2. Click **Install**, then pick **On the Network** to push the new firmware over Wi-Fi. +3. Wait for the compile and flash to finish. The device reboots once the install is done. + +## Try the effects + +With the device back online, open the local web page at `http://esphome-starter-kit.local/` (or whatever you named your device) in a browser on the same Wi-Fi network. Find the RGB light entity and pick **Rainbow** or **Color Wipe** from the **Effect** dropdown. The LEDs start animating right away. + +If you've already followed [Connect to Home Assistant](/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant/), the same **Effect** dropdown shows up on the light entity card in Home Assistant. + +!!! success "You just edited YAML!" + + Every component you add to your device has a set of advanced fields like this one. Pasting a few lines into the right field is all it takes to unlock more behavior, and the YAML pane on the right of the editor will show you exactly what changed. diff --git a/mkdocs.yml b/mkdocs.yml index 90f9fde75a..22c555ab9d 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -514,6 +514,7 @@ nav: - Tutorials: - Using Secrets: products/ESPHome-Starter-Kit/tutorials/using-secrets.md - Connect to Home Assistant: products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md + - Light Effects: products/ESPHome-Starter-Kit/tutorials/light-effects.md - Automations: - Button Controlled LEDs: products/ESPHome-Starter-Kit/automations/button-controlled-leds.md - Learn the Basics: