Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/products/ESPHome-Starter-Kit/automations/play-a-tune.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ This tutorial uses the Button module and the LED & Buzzer module connected to th
* [First Steps](../setup/first-steps.md) to create your starter kit device in ESPHome Device Builder.
* [Adding the Button Module](../modules/button-module.md) to wire up the input.
* [Adding the LED & Buzzer Module](../modules/rgb-buzzer-module.md) to wire up the buzzer output.
* [Accessory Power Rail](../learning-the-basics/core-components.md#accessory-power-rail) to confirm your project includes it. The LED & Buzzer module gets its power from the rail, and the buzzer doesn't get enough power to play without it.

## How the buzzer plays tunes

Expand Down Expand Up @@ -114,7 +115,10 @@ With the device back online, press the button on the Button module. You should h

!!! tip "No sound?"

The buzzer is an output, not a switch, so it has no web server control of its own. The only way to hear it is to trigger it, like the button click above. If it stays silent, confirm the LED & Buzzer module is connected and that the install finished without errors.
The buzzer is an output, not a switch, so it has no web server control of its own. The only way to hear it is to trigger it, like the button click above. If it stays silent:

* Check that the **Accessory Power** switch is on in the web server and still in your project's **Components** section. The LED & Buzzer module gets its power from the [Accessory Power Rail](../learning-the-basics/core-components.md#accessory-power-rail), and the buzzer doesn't get enough power to play without it.
* Confirm the LED & Buzzer module is connected and that the install finished without errors.

## Find more tunes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -647,6 +647,7 @@ With the device back online, press the button on the Button module. The Onboard
### Troubleshooting

- **The colors don't reflect what I just did to the sensor.** The temp and humidity sensors publish on a schedule (every 60 seconds by default), so the colors show the most recent reading, not a fresh check at the moment of the press. Lower the sensor's `update_interval` while testing for snappier feedback.
- **The LED never lights up.** The Onboard RGB LED gets its power from the [Accessory Power Rail](../learning-the-basics/core-components.md#accessory-power-rail). Check that the **Accessory Power** switch is on in the web server and still in your project's **Components** section.
- **First press after boot does nothing.** Right after boot, the sensor hasn't published a reading yet, so the `If` comparisons silently come back false and the LED stays as-is. Wait one publish cycle (60 seconds by default) and try again.

### Next steps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,10 @@ With the device back online, each action you added shows up in Home Assistant. T

1. For a slot, pick its action (like `esphome.esphome_starter_kit_play_song_2`) with no extra data. For `esphome.esphome_starter_kit_play_buzzer`, set a **song_str** to any RTTTL string, for example `scale_up:d=32,o=5,b=100:c,c#,d,d#,e,f,f#,g,g#,a,a#,b`. Handy triggers: a doorbell chime, a wash cycle finishing, or a morning wake-up scale.

!!! tip "No sound?"

If the action runs but the buzzer stays silent, check that your kit's **Accessory Power** switch is on in Home Assistant. The LED & Buzzer module gets its power from the [Accessory Power Rail](../learning-the-basics/core-components.md#accessory-power-rail), so with the switch off the buzzer doesn't get enough power to play.

## Find more tunes

Any valid RTTTL line works as a tune. The [Play a Tune page](../automations/play-a-tune.md#find-more-tunes) has a set of ready-to-paste songs (Mario, Cantina, the Imperial March) and links for browsing and previewing more. For seasonal ones, see the [Holiday Songs](https://wiki.apolloautomation.com/products/general/holiday-songs/) collection.
Expand Down
4 changes: 4 additions & 0 deletions docs/products/ESPHome-Starter-Kit/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ description: Frequently asked questions about the ESPHome Starter Kit, ESPHome D

* The ESP32-C6 is a modern microcontroller from Espressif that brings Wi-Fi, Bluetooth LE, and Thread support to a single chip. It is the same family of silicon used in commercially certified smart home products, and gives learners a future-ready platform that supports the same open standards used in production smart home devices.

16\. **Why won't my LEDs light up, my buzzer play, or my module respond?**

* Check the **Accessory Power Rail** first. The Onboard RGB LED and every module get their power from it, so if your project doesn't include it, or its **Accessory Power** switch is off, they don't get enough power to work. Projects created from the ESPHome Starter Kit board include the rail and turn it on at boot. If yours is missing it, see [Accessory Power Rail](learning-the-basics/core-components.md#accessory-power-rail) to add it back.

[Click here to join our Discord for fast support! :simple-discord:](https://link.apolloautomation.com/discord){ .md-button .md-button--primary }


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ The **Accessory Power Rail** is a software switch that controls power to the kit

When the rail is **on**, your modules and the Onboard RGB LED have power and respond. When the rail is **off**, those accessories go dark. The ESP32-C6 itself stays on.

That makes the rail a requirement for any project that uses the Onboard RGB LED or a module. Without it, they don't get enough power to work, even when the rest of your config is correct.

Apollo ships the rail enabled and set to come back on after a reboot, so the kit "just works" out of the box. The reason it exists as a switch (rather than always-on) is that turning the rail off briefly is the cleanest way to reset a misbehaving module without unplugging the kit, and it can be automated from Home Assistant.

### Common settings
Expand All @@ -70,6 +72,8 @@ If you remove the rail, **the Onboard RGB LED and any plugged-in modules will st
2. Click **Add component**, scroll to **Accessory Power Rail**, and click **Add**.
3. Click **Add** once more to confirm.

The component picker only lists **Accessory Power Rail** when your project doesn't already have it. If you can't find the card, look in your **Components** section for a **GPIO Switch** named **Accessory Power**. If it's there, your project already has the rail.

<a href="https://esphome.io/components/switch/gpio/" target="_blank" rel="noreferrer nofollow noopener" class="md-button md-button--primary"><img src="/assets/esphome-logo.svg" alt="ESPHome logo" /> ESPHome GPIO Switch docs</a>


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,11 @@ The Breakout Module is covered in connectors, each labeled on the board. Most of

## Add to ESPHome Device Builder

The Breakout Module is different from the other starter kit modules. There's no single **Add Component** entry to select, because the module doesn't have a fixed sensor on it. Instead it breaks the ESP32-C6's pins out so you can wire up your own parts. Pick the component that matches what you connected:
The Breakout Module is different from the other starter kit modules. There's no single **Add Component** entry to select, because the module doesn't have a fixed sensor on it. Instead it breaks the ESP32-C6's pins out so you can wire up your own parts.

Whatever you connect, the Breakout Module gets its power from the **Accessory Power Rail**. Before you add anything, check your project's **Components** section for a **GPIO Switch** named **Accessory Power**. If it isn't there, click **Add component**, find the **Accessory Power Rail** card, and click **Add**. Without it, nothing plugged into the breakout gets enough power to work. See [Accessory Power Rail](/products/ESPHome-Starter-Kit/learning-the-basics/core-components.md#accessory-power-rail) for what the switch does.

Then pick the component that matches what you connected:

* For I2C devices (most sensor breakouts), add the component for your sensor, set SCL to pin 0 and SDA to pin 1, and turn on the pullup toggle for both pins.
* For a DS18B20 probe on the 1Wire connector, add the <a href="https://esphome.io/components/one_wire/" target="_blank" rel="noreferrer nofollow noopener">One Wire</a> component on GPIO6, then a <a href="https://esphome.io/components/sensor/dallas_temp/" target="_blank" rel="noreferrer nofollow noopener">Dallas temperature sensor</a>.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ In your device config, add two components:
1. The <a href="https://esphome.io/components/one_wire/" target="_blank" rel="noreferrer nofollow noopener">One Wire</a> component, set to **GPIO6**. This sets up the bus the probe talks on.
2. A <a href="https://esphome.io/components/sensor/dallas_temp/" target="_blank" rel="noreferrer nofollow noopener">Dallas Temperature</a> sensor, which reads the probe on that bus.

Both rely on the **Accessory Power** switch that powers the Breakout Module. Projects created from the Apollo ESPHome Starter Kit board already have it. If yours doesn't, add the [Accessory Power Rail](/products/ESPHome-Starter-Kit/learning-the-basics/core-components.md#accessory-power-rail) component first, or the probe won't get enough power to answer on the bus.

Flash the device, and the temperature reading shows up alongside your other entities. You can wire more than one probe to the same 1Wire port and read each one separately.

??? example "Working YAML"
Expand Down
17 changes: 13 additions & 4 deletions docs/products/ESPHome-Starter-Kit/modules/button-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,19 @@ Connect the button module to the ESP32-C6 using one of the FPC ribbon cables tha
ESPHome Device Builder ships an **Add Component** flow that knows the pin layout for every Apollo Starter Kit module. Use it instead of writing the binary sensor by hand, and you'll get the right GPIO and inversion settings on the first try.

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 **Button** and select the **Button Module**.
5. Click **Add**. Device Builder inserts the button's binary sensor block into your YAML.
2. Navigate to the **Components** section and look for a **GPIO Switch** named **Accessory Power**. The Button module gets its power from that switch, so without it the module doesn't get enough power to work. (1)
{ .annotate }

1. Projects you created from the Apollo ESPHome Starter Kit board already include it, and the component picker hides it once your device has it. That's why it isn't in the list of components you can add.

3. If it isn't there, click **Add Component**, find the **Accessory Power Rail** card, and click **Add**. (1)
{ .annotate }

1. [Accessory Power Rail](/products/ESPHome-Starter-Kit/learning-the-basics/core-components.md#accessory-power-rail) covers what the switch does and the settings worth knowing about.

4. Click **Add Component** in the editor toolbar.
5. Search for **Button** and select the **Button Module**.
6. Click **Add**. Device Builder inserts the button's binary sensor block into your YAML.

![Searching for button in the Add component dialog, choosing Button Module on GPIO6, and clicking Add](../../../assets/esphome-device-builder-add-button-module.gif)

Expand Down
16 changes: 13 additions & 3 deletions docs/products/ESPHome-Starter-Kit/modules/motion-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,19 @@ Connect the motion module to the ESP32-C6 using one of the FPC ribbon cables tha
ESPHome Device Builder ships an **Add Component** flow that knows the pin layout for every Apollo Starter Kit module. Use it instead of writing the binary sensor by hand, and you'll get the right GPIO and pin mode on the first try.

1. Open your starter kit device in Device Builder and click **Edit**.
2. Click **Add Component** in the editor toolbar.
3. Search for **Motion** and select the Apollo Starter Kit PIR motion component.
4. Click **Add**. Device Builder inserts the PIR's binary sensor block into your YAML.
2. Navigate to the **Components** section and look for a **GPIO Switch** named **Accessory Power**. The Motion module gets its power from that switch, so without it the PIR sensor doesn't get enough power to work. (1)
{ .annotate }

1. Projects you created from the Apollo ESPHome Starter Kit board already include it, and the component picker hides it once your device has it. That's why it isn't in the list of components you can add.

3. If it isn't there, click **Add Component**, find the **Accessory Power Rail** card, and click **Add**. (1)
{ .annotate }

1. [Accessory Power Rail](/products/ESPHome-Starter-Kit/learning-the-basics/core-components.md#accessory-power-rail) covers what the switch does and the settings worth knowing about.

4. Click **Add Component** in the editor toolbar.
5. Search for **Motion** and select the Apollo Starter Kit PIR motion component.
6. Click **Add**. Device Builder inserts the PIR's binary sensor block into your YAML.

![ESPHome Device Builder Add component dialog: searching motion and adding the Motion Module](../../../assets/esphome-device-builder-add-motion-component.gif)

Expand Down
21 changes: 17 additions & 4 deletions docs/products/ESPHome-Starter-Kit/modules/rgb-buzzer-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,19 @@ Connect the LED & Buzzer module to the ESP32-C6 using one of the FPC ribbon cabl
ESPHome Device Builder ships an **Add Component** flow that knows the pin layout for every Apollo Starter Kit module. Use it instead of writing the LED strip and buzzer config by hand, and you'll get the right GPIOs, chipset, and PWM setup on the first try.

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. Select the **RGB LED + Buzzer Module Bundle** at the top.
5. Click **Add** -&gt; Click **Add** -&gt; Click **Add** -&gt; Click **Add**. Each section lets you make changes but we will leave them at defaults for now. Device Builder inserts the light, output, and rtttl blocks into your YAML.
2. Navigate to the **Components** section and look for a **GPIO Switch** named **Accessory Power**. The LED & Buzzer module gets its power from that switch, so without it the LEDs and buzzer don't get enough power to work. (1)
{ .annotate }

1. Projects you created from the Apollo ESPHome Starter Kit board already include it, and the component picker hides it once your device has it. That's why it isn't in the list of components you can add.

3. If it isn't there, click **Add Component**, find the **Accessory Power Rail** card, and click **Add**. (1)
{ .annotate }

1. [Accessory Power Rail](/products/ESPHome-Starter-Kit/learning-the-basics/core-components.md#accessory-power-rail) covers what the switch does and the settings worth knowing about.

4. Click **Add Component** in the editor toolbar.
5. Select the **RGB LED + Buzzer Module Bundle** at the top.
6. Click **Add** -&gt; Click **Add** -&gt; Click **Add** -&gt; Click **Add**. Each section lets you make changes but we will leave them at defaults for now. Device Builder inserts the light, output, and rtttl blocks into your YAML.

![ESPHome Device Builder adding the RGB LED + Buzzer Module bundle and clicking Add through each step](../../../assets/esphome-device-builder-add-rgb-buzzer-bundle-module.gif)

Expand Down Expand Up @@ -124,6 +133,10 @@ With the device back online, the RGB LED light entity is live on the web server.

![Starter kit web server turning on the RGB LEDs and picking a new color](../../../assets/esphome-device-builder-test-rgb-leds.gif)

!!! tip "LEDs stay dark?"

Check that the **Accessory Power** switch on the same web page is on, and that it's still in your project's **Components** section. The module runs off the [Accessory Power Rail](/products/ESPHome-Starter-Kit/learning-the-basics/core-components.md#accessory-power-rail), so without it the LEDs and buzzer don't get enough power to work.

!!! 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!
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,22 @@ Connect the Temperature and Humidity module to the ESP32-C6 using one of the FPC
ESPHome Device Builder ships an **Add Component** flow that knows the pin layout for every Apollo Starter Kit module. Use it instead of writing the I2C bus and sensor block by hand, and you'll get the right pins, address, and variant on the first try.

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. 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. Toggle the **Humidity** and **Temperature** selections on.
8. Click **Add**. Device Builder inserts the AHT20F sensor block into your YAML.
2. Navigate to the **Components** section and look for a **GPIO Switch** named **Accessory Power**. The temperature and humidity module gets its power from that switch, so without it the sensor doesn't get enough power to answer on the I2C bus. (1)
{ .annotate }

1. Projects you created from the Apollo ESPHome Starter Kit board already include it, and the component picker hides it once your device has it. That's why it isn't in the list of components you can add.

3. If it isn't there, click **Add Component**, find the **Accessory Power Rail** card, and click **Add**. (1)
{ .annotate }

1. [Accessory Power Rail](/products/ESPHome-Starter-Kit/learning-the-basics/core-components.md#accessory-power-rail) covers what the switch does and the settings worth knowing about.

4. Click **Add Component** in the editor toolbar.
5. Select the **I2C** component.
6. Click **Add**. Device Builder inserts the I2C bus into your YAML.
7. Search for **Temperature and Humidity** and select the Apollo Starter Kit temperature and humidity component.
8. Toggle the **Humidity** and **Temperature** selections on.
9. Click **Add**. Device Builder inserts the AHT20F sensor block into your YAML.

![ESPHome Device Builder adding the I2C bus, then the AHT20 module with Humidity and Temperature on](../../../assets/esphome-device-builder-add-i2c-temp-hum-component.gif)

Expand Down
4 changes: 4 additions & 0 deletions docs/products/ESPHome-Starter-Kit/setup/first-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,10 @@ With the app installed, it's time to tell it about your kit. If you took the gui

When you create a new ESPHome Starter Kit project in ESPHome Device Builder, the **Web Server** and **Accessory Power Rail** components are already configured for you, so there's nothing extra to do for those. In this tutorial we'll add one more component: the **Onboard RGB LED**.

!!! warning "Keep the Accessory Power Rail in every project"

The Onboard RGB LED and every module you plug in get their power from the **Accessory Power Rail**. Leave it in your project. Without it, the LED and modules don't get enough power to work. [Core components](../learning-the-basics/core-components.md#accessory-power-rail) explains what it does.

### Onboard RGB LED

The Onboard RGB LED is a small LED above the Reset button of your ESP32-C6. Useful for testing automations and doubles as a status light.
Expand Down
Loading