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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/esphome-starter-kit-button-module.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/esphome-starter-kit-main-board-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/esphome-starter-kit-main-board-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/esphome-starter-kit-main-board.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/esphome-starter-kit-module-board.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/esphome-starter-kit-pir-module.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/sotoh-graphic-detailed.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 28 additions & 7 deletions docs/products/ESPHome-Starter-Kit/first-steps.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
title: ESPHome Starter Kit - First Steps
title: ESPHome Starter Kit - Introduction
description: Landing page of the ESPHome Starter Kit QR Code.
---
# Welcome to the ESPHome Starter Kit
# Welcome to the ESPHome Starter Kit!

Welcome to the start of your ESPHome journey with the all-new **ESPHome Starter Kit**!

![](../../assets/esphome-starter-kit-exploded-with-box-1.png)

By the end of this wiki you'll know how to:

* Identify each part of your kit
Expand All @@ -15,7 +17,7 @@ By the end of this wiki you'll know how to:

Your kit arrives as a single snap-apart panel that includes the ESP32-C6 main board along with a selection of interchangeable modules. The kit also includes three ribbon cables used to connect the modules together.

![](../../assets/starter-kit-graphic.png)
![](../../assets/esphome-starter-kit-whats-in-the-box.png)

## Snapping the panel apart

Expand All @@ -29,23 +31,42 @@ Each module is connected to the panel by small breakaway tabs. Follow the steps
2. Gently flex the panel along the tab line until the tab snaps cleanly.

<video autoplay="" loop="" muted="" playsinline="" width="100%">
<source src="/assets/ESPHome_Starter_Kit_Break_Apart_Modules.mp4" type="video/mp4" /><p></p><p></p>
<source src="/assets/ESPHome_Starter_Kit_Break_Apart_Modules.mp4" type="video/mp4" /><p></p><p></p><p></p><p></p><p></p>
Your browser does not support embedded video.
</video>

## Meet the modules

The kit includes:

![](../../assets/sotoh-graphic-detailed.jpg)

* **ESP32-C6 main board.** The brain of every project you'll build with the kit. It handles Wi-Fi and Bluetooth, runs your ESPHome config, and exposes the GPIO pins the modules plug into.
* **Motion module.** Detects movement in a room and a great way to get started automating your home. Comes with a separate 3 pin header and PIR motion sensor.

![](../../assets/esphome-starter-kit-main-board-only.jpg)

* **Casita LED and Buzzer module.** The starter kit's notification module, a strip of ten addressable RGB LEDs and a small piezo buzzer behind the ESPHome logo silkscreen. *Use the included stand to show it off!*

![](../../assets/esphome-starter-kit-casita-module-only.jpg)

* **Motion module.** Detects movement in a room and a great way to get started automating your home. It comes in two parts, and the PIR sensor easily plugs into the PIR module board.

![](../../assets/esphome-starter-kit-pir-module-only.jpg)

* **Button module.** Premium feel button perfect to trigger automations for lights and more.

![](../../assets/esphome-starter-kit-button-module-only.jpg)

* **Temperature and Humidity module.** Extremely accurate temp and humidity sensor trustworthy enough to track a room comfort level with ease!

Each module connects to the ESP32-C6 board through the FPC connectors which are the thin white ribbon cables.
![](../../assets/esphome-starter-kit-temp-hum-module-only-1.jpg)

* **FPC cables.** Each module connects to the main board through the FPC connector using one of the three provided cables. *Tear the brown paper bag open from one of the ends. Please DO NOT use scissors as you could accidentally cut the cables!*

![](../../assets/esphome-starter-kit-fpc-cables-only.jpg)

## Next: bring it online

Once you've identified your modules and snapped them off the panel, the next step is to connect the ESP32-C6 to your computer and walk through your first ESPHome configuration.
Once you've identified your modules and snapped them off the panel, the next step is to connect the main board to your computer and walk through your first ESPHome configuration.

<a href="../setup/getting-started/" class="md-button md-button--primary"> <img src="/assets/esphome-logo.svg" /> Open ESPHome Getting Started </a>
109 changes: 47 additions & 62 deletions docs/products/ESPHome-Starter-Kit/modules/button-module.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,31 @@
---
title: Adding the button module
description: Wire up the ESPHome Starter Kit button module, add it through ESPHome Device Builder, and verify presses in the web server.
description: >-
Wire up the ESPHome Starter Kit button module, add it through ESPHome Device
Builder, and verify presses in the web server.
---
# Adding the button module

The button module is the first input your starter kit gets, and the fastest way to feel ESPHome respond to a physical action. By the end of this tutorial you'll have the button wired to your ESP32-C6, surfaced as a binary sensor in your YAML, and toggling live in the web server when you press it.

!!! info "Before you start"
!!! note "Before you start"

Work through the two prerequisites first:

* [First Steps](../first-steps.md) to snap the button module off the panel.
* [Getting Started](../setup/getting-started.md) to install ESPHome Device Builder and create your starter kit device.
- [First Steps](../first-steps/) to snap the button module off the panel.
- [Getting Started](../setup/getting-started/) to install ESPHome Device Builder and create your starter kit device.

---

### Start with your base config
## Start with your base config

The starter kit project template gets you online, but it doesn't enable the web server yet. Add it now so you have a live page to test the button against after flashing.

1. In ESPHome Device Builder, open your starter kit device and click **Edit**.
2. Add the `web_server` component, make sure to select version 3

2. Add the `web_server` component, making sure to select version 3.
3. Click **Save**. Don't install yet, the button gets added in the next section.

![](../../../assets/webserver.gif)

---

### Plug in the button module
## Plug in the button module

Connect the button module to the ESP32-C6 using one of the FPC ribbon cables that came with the kit. Either FPC connector on the C6 works, top or bottom.

Expand All @@ -37,17 +34,13 @@ Connect the button module to the ESP32-C6 using one of the FPC ribbon cables tha
3. Slide one end of the ribbon cable into each connector with the contacts facing the board, then press each latch back down to lock the cable in.
4. Plug the C6 back into your computer.

** GIF PLACEHOLDER **
**GIF PLACEHOLDER**

!!! success "Handle the FPC connectors gently"
!!! warning "Handle the FPC connectors gently" The latches are small and the ribbon cable is fragile. Lift the latch with a fingernail, slide the cable in, and press the latch down. Never pull on the cable itself.

The latches are small and the ribbon cable is fragile. Lift the latch with a fingernail, slide the cable in, and press the latch down. Never pull on the cable itself.
## Add the button component in ESPHome Device Builder

---

### Add the button component in ESPHome Device Builder

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.
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. Click **Add Component** in the editor toolbar.
Expand All @@ -56,40 +49,36 @@ ESPHome Device Builder ships an **Add Component** flow that knows the pin layout

![](../../../assets/button_component.gif)

---

### What the button YAML does

The block Add Component drops into your config looks like this:

```yaml
binary_sensor:
- platform: gpio
pin:
number: GPIO6
inverted: true
mode:
input: true
pullup: true
id: my_button
name: "Button"
```

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. |
| `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 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. |

---

### Install the firmware
??? note "What the button YAML does"

The block Add Component drops into your config looks like this:

```yaml
binary_sensor:
- platform: gpio
pin:
number: GPIO6
inverted: true
mode:
input: true
pullup: true
id: my_button
name: "Button"
```

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. |
| `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 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. |

## Install the firmware

Flash the device so the new web server and button entity go live.

Expand All @@ -98,22 +87,18 @@ Flash the device so the new web server and button entity go live.
3. Wait for the compile and flash to finish. First builds can take a few minutes.
4. The device reboots and reconnects to your Wi-Fi on its own.

## GIF PLACEHOLDER
**GIF PLACEHOLDER**

---

### Test it in the web server
## Test it in the web server

With the device back online, the button entity is live on the web server. Open it in a browser on the same network and watch it react in real time.

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. Find the **Button** entity in the binary sensor list.
3. Press the button on the module. The entity flips from **OFF** to **ON** while the button is held, then back to **OFF** when you release it.

![Web server page showing the Button binary sensor toggling between ON and OFF as the button is pressed](../../../assets/esk-button-module-webserver-test.gif)
> Web server page showing the Button binary sensor toggling between ON and OFF as the button is pressed.

## GIF PLACEHOLDER
**GIF PLACEHOLDER**

!!! success "Your button module is wired up"


95 changes: 56 additions & 39 deletions docs/products/ESPHome-Starter-Kit/modules/casita-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ description: >-

The Casita is the starter kit's notification module, a strip of ten addressable RGB LEDs and a small piezo buzzer behind the ESPHome logo silkscreen. By the end of this tutorial you'll have the lights and buzzer wired to your ESP32-C6, surfaced in your YAML, and ready to flash, animate, or sing in response to anything else you build.

!!! note "Before you start" Work through the two prerequisites first:
!!! note "Before you start"

```
- [First Steps](../first-steps/) to snap the Casita module off the panel.
- [Getting Started](../setup/getting-started/) to install ESPHome Device Builder and create your starter kit device.
```
Work through the two prerequisites first:

- [First Steps](../first-steps/) to snap the Casita module off the panel.
- [Getting Started](../setup/getting-started/) to install ESPHome Device Builder and create your starter kit device.

## Start with your base config

Expand All @@ -23,6 +23,8 @@ The starter kit project template gets you online, but it doesn't enable the web
2. Add the `web_server` component, making sure to select version 3.
3. Click **Save**. Don't install yet, the Casita gets added in the next section.

![](../../../assets/webserver.gif)

## Plug in the Casita module

Connect the Casita module to the ESP32-C6 using one of the FPC ribbon cables that came with the kit. Either FPC connector on the C6 works, top or bottom.
Expand All @@ -45,40 +47,55 @@ ESPHome Device Builder ships an Add Component flow that knows the pin layout for
3. Search for **Casita** and select the Apollo Starter Kit Casita notification component.
4. Click **Add**. Device Builder inserts the light, output, and rtttl blocks into your YAML.

## What the Casita YAML does

The blocks Add Component drops into your config look like this:

```yaml
light:
- platform: esp32_rmt_led_strip
id: rgb_module
name: "RGB Module Light"
pin: GPIO14
chipset: WS2812
num_leds: 10
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

rtttl:
id: rtttl_buzzer
output: buzzer
```

Each option does something specific:

<table><thead><tr><th><p>Option</p></th><th><p>What it does</p></th></tr></thead><tbody><tr><td><p><strong>LED strip</strong></p></td><td><p></p></td></tr><tr><td><p><code>light.platform: esp32_rmt_led_strip</code></p></td><td><p>Uses the ESP32's RMT peripheral to drive addressable LEDs with precise timing.</p></td></tr><tr><td><p><code>light.pin: GPIO14</code></p></td><td><p>The data line going to the first LED on the Casita.</p></td></tr><tr><td><p><code>light.chipset: WS2812</code></p></td><td><p>Which addressable LED protocol to use. WS2812 is the most common, sometimes also called NeoPixel.</p></td></tr><tr><td><p><code>light.num_leds: 10</code></p></td><td><p>The number of LEDs on the Casita module.</p></td></tr><tr><td><p><code>light.rgb_order: grb</code></p></td><td><p>Color channel order. WS2812 LEDs receive color data in green-red-blue order, so this makes sure red looks red and not green.</p></td></tr><tr><td><p><code>light.rmt_symbols: 48</code></p></td><td><p>Low-level RMT setting needed on the ESP32-C6. Leave it at 48.</p></td></tr><tr><td><p><code>light.effects</code></p></td><td><p>Pre-loaded animations you can select from the web server or trigger from Home Assistant.</p></td></tr><tr><td><p><strong>Piezo buzzer</strong></p></td><td><p></p></td></tr><tr><td><p><code>output.platform: ledc</code></p></td><td><p>PWM output for driving the buzzer. PWM is how digital pins create audio tones on a piezo.</p></td></tr><tr><td><p><code>output.pin: GPIO18</code></p></td><td><p>The pin the buzzer is wired to.</p></td></tr><tr><td><p><code>output.id: buzzer</code></p></td><td><p>Internal handle the rtttl component uses to send tones to this output.</p></td></tr><tr><td><p><code>rtttl.id: rtttl_buzzer</code></p></td><td><p>Internal handle for triggering tunes from automations and lambdas.</p></td></tr><tr><td><p><code>rtttl.output: buzzer</code></p></td><td><p>Tells rtttl to use the buzzer output for playback.</p></td></tr></tbody></table>
??? note "What the Casita YAML does"

The blocks Add Component drops into your config look like this:

```yaml
light:
- platform: esp32_rmt_led_strip
id: rgb_module
name: "RGB Module Light"
pin: GPIO14
chipset: WS2812
num_leds: 10
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

rtttl:
id: rtttl_buzzer
output: buzzer
```

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 Casita. |
| `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 Casita 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_buzzer` | Internal handle for triggering tunes from automations and lambdas. |
| `rtttl.output: buzzer` | Tells rtttl to use the buzzer output for playback. |

## Install the firmware

Expand Down
Loading