Merge pull request #1027 from ApolloAutomation/dev

bharvey88 · web-flow · commit b9de4e5ae8c9 · 2026-07-10T13:10:28.000-05:00
Sync dev to main: ESK module YAML fixes
diff --git a/docs/assets/esphome-device-builder-add-i2c-temp-hum-component.gif b/docs/assets/esphome-device-builder-add-i2c-temp-hum-component.gif
diff --git a/docs/products/ESPHome-Starter-Kit/modules/button-module.md b/docs/products/ESPHome-Starter-Kit/modules/button-module.md
@@ -56,27 +56,27 @@ ESPHome Device Builder ships an **Add Component** flow that knows the pin layout
     ```yaml
     binary_sensor:
       - platform: gpio
+        name: Button Module
         pin:
-          number: GPIO6
           inverted: true
           mode:
             input: true
             pullup: true
-        id: my_button
-        name: "Button"
+          number: 6
+        id: button_module
     ```
 
     Each option does something specific:
 
     | Option | What it does |
     | --- | --- |
     | `platform: gpio` | Reads a digital input on a GPIO pin. |
-    | `number: GPIO6` | The pin the button module's FPC connector wires to on the ESP32-C6. |
+    | `name: Button Module` | The friendly name shown in Home Assistant and the web server. |
     | `inverted: true` | The pin reads LOW when the button is pressed, so this flips it to an intuitive on/off state. |
     | `mode.input: true` | Configures the pin as an input. |
     | `mode.pullup: true` | Enables the ESP32-C6's internal pull-up so the pin doesn't float when the button isn't pressed. |
-    | `id: my_button` | Internal handle you can reference from automations and lambdas elsewhere in the config. |
-    | `name: "Button"` | The friendly name shown in Home Assistant and the web server. |
+    | `number: 6` | The GPIO pin (GPIO6) the button module's FPC connector wires to on the ESP32-C6. |
+    | `id: button_module` | Internal handle you can reference from automations and lambdas elsewhere in the config. |
 
 ## Install the firmware
 
diff --git a/docs/products/ESPHome-Starter-Kit/modules/motion-module.md b/docs/products/ESPHome-Starter-Kit/modules/motion-module.md
@@ -73,7 +73,13 @@ ESPHome Device Builder ships an **Add Component** flow that knows the pin layout
 
     Each option does something specific:
 
-    \| Option \| What it does \| \| --- \| --- \| \| `platform: gpio` \| Reads a digital input on a GPIO pin. \| \| `number: GPIO3` \| The pin the Motion module's FPC connector wires to on the ESP32-C6. \| \| `mode.input: true` \| Configures the pin as an input. \| \| `mode.pulldown: false` \| The MH-SR602 drives its output both high and low on its own, so no internal pulldown is needed. \| \| `id: motion_module` \| Internal handle you can reference from automations and lambdas elsewhere in the config. \| \| `name: "Motion Module"` \| The friendly name shown in Home Assistant and the web server. \| \| `device_class: motion` \| Tells Home Assistant this is a motion sensor, so it shows the right icon and works in motion-related templates and blueprints. \|
+    | Option | What it does |
+    | --- | --- |
+    | `platform: gpio` | Reads a digital input on a GPIO pin. |
+    | `name: Motion Module` | The friendly name shown in Home Assistant and the web server. |
+    | `pin: 3` | The GPIO pin (GPIO3) the Motion module's FPC connector wires to on the ESP32-C6. |
+    | `device_class: motion` | Tells Home Assistant this is a motion sensor, so it shows the right icon and works in motion-related templates and blueprints. |
+    | `id: motion_module` | Internal handle you can reference from automations and lambdas elsewhere in the config. |
 
 ## Install the firmware
 
diff --git a/docs/products/ESPHome-Starter-Kit/modules/rgb-buzzer-module.md b/docs/products/ESPHome-Starter-Kit/modules/rgb-buzzer-module.md
@@ -56,33 +56,43 @@ ESPHome Device Builder ships an **Add Component** flow that knows the pin layout
     ```yaml
     light:
       - platform: esp32_rmt_led_strip
+        name: RGB LEDs
+        pin: 14
         id: rgb_leds
-        name: "RGB LEDs"
-        pin: GPIO14
         chipset: WS2812
         num_leds: 10
+        rgb_order: GRB
         rmt_symbols: 48
-        rgb_order: grb
-        default_transition_length: 0s
-        effects:
-          - addressable_rainbow:
-              name: "Rainbow"
-          - addressable_twinkle:
-              name: "Twinkle"
 
     output:
       - platform: ledc
-        pin: GPIO18
-        id: buzzer
+        pin: 18
+        id: buzzer_output
 
     rtttl:
-      id: rtttl_player
-      output: buzzer
+      - output: buzzer_output
+        id: rtttl_player
     ```
 
     Each option does something specific:
 
-    \| Option \| What it does \| \| --- \| --- \| \| **LED strip** \| \| \| `light.platform: esp32_rmt_led_strip` \| Uses the ESP32's RMT peripheral to drive addressable LEDs with precise timing. \| \| `light.pin: GPIO14` \| The data line going to the first LED on the PCB. \| \| `light.chipset: WS2812` \| Which addressable LED protocol to use. WS2812 is the most common, sometimes also called NeoPixel. \| \| `light.num_leds: 10` \| The number of LEDs on the RGB & Buzzer module. \| \| `light.rgb_order: grb` \| Color channel order. WS2812 LEDs receive color data in green-red-blue order, so this makes sure red looks red and not green. \| \| `light.rmt_symbols: 48` \| Low-level RMT setting needed on the ESP32-C6. Leave it at 48. \| \| `light.effects` \| Pre-loaded animations you can select from the web server or trigger from Home Assistant. \| \| **Piezo buzzer** \| \| \| `output.platform: ledc` \| PWM output for driving the buzzer. PWM is how digital pins create audio tones on a piezo. \| \| `output.pin: GPIO18` \| The pin the buzzer is wired to. \| \| `output.id: buzzer` \| Internal handle the rtttl component uses to send tones to this output. \| \| `rtttl.id: rtttl_player` \| Internal handle for triggering tunes from automations and lambdas. \| \| `rtttl.output: buzzer` \| Tells rtttl to use the buzzer output for playback. \|
+    | Option | What it does |
+    | --- | --- |
+    | **LED strip** | |
+    | `light.platform: esp32_rmt_led_strip` | Uses the ESP32's RMT peripheral to drive addressable LEDs with precise timing. |
+    | `light.name: RGB LEDs` | The friendly name shown in Home Assistant and the web server. |
+    | `light.pin: 14` | The data line (GPIO14) going to the first LED on the PCB. |
+    | `light.id: rgb_leds` | Internal handle you can reference from automations and lambdas elsewhere in the config. |
+    | `light.chipset: WS2812` | Which addressable LED protocol to use. WS2812 is the most common, sometimes also called NeoPixel. |
+    | `light.num_leds: 10` | The number of LEDs on the RGB & Buzzer module. |
+    | `light.rgb_order: GRB` | Color channel order. WS2812 LEDs receive color data in green-red-blue order, so this makes sure red looks red and not green. |
+    | `light.rmt_symbols: 48` | Low-level RMT setting needed on the ESP32-C6. Leave it at 48. |
+    | **Piezo buzzer** | |
+    | `output.platform: ledc` | PWM output for driving the buzzer. PWM is how digital pins create audio tones on a piezo. |
+    | `output.pin: 18` | The pin the buzzer is wired to (GPIO18). |
+    | `output.id: buzzer_output` | Internal handle the rtttl component uses to send tones to this output. |
+    | `rtttl.output: buzzer_output` | Tells rtttl to use the buzzer output for playback. |
+    | `rtttl.id: rtttl_player` | Internal handle for triggering tunes from automations and lambdas. |
 
 ## Install the firmware
 
@@ -99,22 +109,22 @@ Flash the device so the new RGB & Buzzer entities go live.
 
 With the device back online, the RGB LED light entity is live on the web server. <a href="http://esphome-starter-kit.local/" target="_blank" rel="noreferrer nofollow noopener">Open it in a browser</a> on the same network and play with it.
 
-1. In a browser, open `http://<your-device-name>.local/`. If you used `esphome-starter-kit` as the device name in Getting Started, that's `http://esphome-starter-kit.local/`.
-2. Toggle the **RGB LEDs** entity and play around with the colors and brightness.
-
-![](../../../assets/esphome-device-builder-test-rgb-leds.gif)
+<div class="annotate" markdown>
 
-!!! tip "For more effects check out this wiki on how to do advanced configurations with your RGB & Buzzer module!"
+1. In a browser, open `http://<your-device-name>.local/`. If you used `esphome-starter-kit` as the device name in Getting Started, that's `http://esphome-starter-kit.local/`.
+2. Toggle the **RGB LEDs** entity and play around with the colors and brightness. (1)
 
-    There are a lot of advanced things you can do with a light entity. Check out the [ESPHome light strip effects documentation](https://esphome.io/components/light/#strip-animations) to learn more!
+</div>
 
-The buzzer doesn't have its own web server control, since it's an output rather than a switch. Once you've added the device to Home Assistant, you can trigger tunes with the `rtttl.play` action or by exposing your own service.
+1. There's a lot you can do with a light entity. See the [Light Effects tutorial](/products/ESPHome-Starter-Kit/tutorials/light-effects.md) for advanced configurations, or the [ESPHome light strip effects documentation](https://esphome.io/components/light/#strip-animations) to go deeper.
 
-> Web server page showing the RGB Light controls on the LED & Buzzer Module.
+![](../../../assets/esphome-device-builder-test-rgb-leds.gif)
 
 !!! success "Your LED & Buzzer notification module is wired up!"
 
-    Your LED & Buzzer Module is now ready for some fun tasks.. like toggling lights on and off, playing with the colors, or using the buzzer to play fun tunes!
+    Your LED & Buzzer Module is now ready for some fun tasks, like toggling lights on and off, playing with the colors, or using the buzzer to play fun tunes!
+
+    The buzzer doesn't have its own web server control, since it's an output rather than a switch. Once you've added the device to Home Assistant, you can trigger tunes with the `rtttl.play` action or by exposing your own service. See [Play a Tune from Home Assistant](/products/ESPHome-Starter-Kit/everyday-use/play-a-tune-from-home-assistant.md) to learn how to set it up.
 
 ## Try it in an automation
 
diff --git a/docs/products/ESPHome-Starter-Kit/modules/temperature-humidity-module.md b/docs/products/ESPHome-Starter-Kit/modules/temperature-humidity-module.md
@@ -45,10 +45,11 @@ ESPHome Device Builder ships an **Add Component** flow that knows the pin layout
 1. Open your starter kit device in Device Builder and click **Edit**.
 2. In the ESPHome Device Builder, navigate to the **Components** section.
 3. Click **Add Component** in the editor toolbar.
-4. Search for **Temperature and Humidity** and select the Apollo Starter Kit temperature and humidity component.
-5. Click **Add**. Device Builder inserts I2C bus into your YAML.
+4. Select the **I2C** component.
+5. Click **Add**. Device Builder inserts the I2C bus into your YAML.
 6. Search for **Temperature and Humidity** and select the Apollo Starter Kit temperature and humidity component.
-7. Click **Add**. Device Builder inserts the AHT20F sensor block into your YAML.
+7. Toggle the **Humidity** and **Temperature** selections on.
+8. Click **Add**. Device Builder inserts the AHT20F sensor block into your YAML.
 
 ![](../../../assets/esphome-device-builder-add-i2c-temp-hum-component.gif)
 
@@ -58,34 +59,32 @@ ESPHome Device Builder ships an **Add Component** flow that knows the pin layout
 
     ```yaml
     i2c:
-      sda: GPIO1
-      scl: GPIO0
-      scan: true
+      - scl: 0
+        sda: 1
+        id: i2c_bus
 
     sensor:
       - platform: aht10
         variant: AHT20
-        id: aht_20
-        temperature:
-          name: "Temperature"
-          id: aht_temperature
         humidity:
-          name: "Humidity"
-          id: aht_humidity
-        update_interval: 60s
+          id: aht20_humidity
+          name: Humidity
+        temperature:
+          id: aht20_temperature
+          name: Temperature
+        id: aht20
     ```
 
     Each option does something specific:
 
     | Option | What it does |
     | --- | --- |
-    | `i2c.sda` / `i2c.scl` | The data and clock pins for the I2C bus the AHT20F speaks on. The starter kit wires them to GPIO1 and GPIO0. |
-    | `i2c.scan: true` | Lists every I2C device the ESP32-C6 finds at boot, useful for confirming the sensor is connected. |
+    | `i2c.scl: 0` / `i2c.sda: 1` | The clock (SCL) and data (SDA) pins for the I2C bus the AHT20F speaks on. The starter kit wires them to GPIO0 and GPIO1. |
+    | `i2c.id: i2c_bus` | Internal handle for the I2C bus so other components can share it. |
     | `platform: aht10` | The ESPHome platform that drives AHT10, AHT20, and AHT30 sensors. |
     | `variant: AHT20` | Tells the platform which variant of the chip is connected. |
-    | `id: aht_20` | Internal handle you can reference from automations and lambdas elsewhere in the config. |
     | `temperature` / `humidity` | Two sub-sensors. Each has a `name` shown in Home Assistant and the web server, and an `id` you can reference from automations and lambdas. |
-    | `update_interval: 60s` | How often the sensor reports. 60 seconds is a reasonable default. Lower it for more responsive readings, raise it to cut down on network traffic. |
+    | `id: aht20` | Internal handle you can reference from automations and lambdas elsewhere in the config. |
 
 ## Install the firmware
 
