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.
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.
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.
6 changes: 3 additions & 3 deletions docs/products/ESPHome-Starter-Kit/modules/button-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Connect the button module to the ESP32-C6 using one of the FPC ribbon cables tha

![](../../../assets/esphome-starter-kit-remove-usb.webp)

2\. Flip up the latch on the FPC connector then gently slide the ribbon cable in to the connector. Gently press the latch down to lock it in place
2\. Flip up the latch on the FPC connector then gently slide the ribbon cable in to the connector. Gently press the latch down to lock it in place.

![](../../../assets/esphome-starter-kit-attach-top-fpc-ribbon.webp)

Expand Down Expand Up @@ -112,10 +112,10 @@ With the device back online, the button entity is live on the web server. <a hre
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/esphome-device-builder-test-button-events.gif)

> Web server page showing the Button binary sensor toggling between ON and OFF as the button is pressed.

!!! success "Your button module is now ready for you to use in automations!"

Your Button Module is now ready for some fun tasks.. like toggling lights on and off in your room, watering your plants, and more!
91 changes: 48 additions & 43 deletions docs/products/ESPHome-Starter-Kit/modules/motion-module.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Adding the Motion Module
description: Wire up the ESPHome Starter Kit Motion Module which will turn your starter kit into an accurate motion sensor!
description: >-
Wire up the ESPHome Starter Kit Motion Module which will turn your starter kit
into an accurate motion sensor!
---
# Adding the Motion Module

Expand All @@ -26,90 +28,93 @@ The <a href="https://esphome.io/components/web_server/" target="_blank" rel="nor

![](../../../assets/device-builder-install-web-server-v3.gif)

## Install the PIR sensor into the module
## Attach PIR

The PIR sensor (the small white dome on a tiny PCB) ships separately from the PIR module board so it can be packed safely. Install it onto the module before plugging anything into the C6.
The PIR sensor (the small white dome on a tiny PCB) ships separately from the motion module so it can be packed safely. Install it onto the module before plugging anything into the C6.

1. Take the PIR sensor out of the box.
2. Line up its pins with the matching headers on the PIR module board.
2. Line up the **Out** name on each side as shown in the gif below.
3. Press it down firmly until the pins are fully seated.

**GIF PLACEHOLDER**
![](../../../assets/esphome-starter-kit-attach-pir-to-motion-module.webp)

## Plug in the PIR motion module
## Attach Motion module

Connect the PIR motion 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.
Connect the motion 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.

1. Unplug the USB-C cable from the ESP32-C6 so the board is powered off.
2. Flip up the latch on the FPC connector on both the C6 and the PIR motion module.
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.
1\. Unplug the USB-C cable from the ESP32-C6 so the board is powered off.

**GIF PLACEHOLDER**
![](../../../assets/esphome-starter-kit-remove-usb.webp)

!!! 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.
2\. Flip up the latch on the FPC connector then gently slide the ribbon cable in to the connector. Gently press the latch down to lock it in place

## Add the PIR motion component in ESPHome Device Builder
![](../../../assets/esphome-starter-kit-attach-top-fpc-ribbon.webp)

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.
3\. Slide the ribbon cable into the button module with the blue side facing upwards then press the latch down to lock it in place.

![](../../../assets/esphome-starter-kit-attach-fpc-to-motion-module.webp)

4\. Plug the C6 back into your computer.

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

## Add to 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 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 **PIR** and select the Apollo Starter Kit PIR motion component.
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.

??? note "What the PIR YAML does"
![](../../../assets/esphome-device-builder-add-motion-component.gif)

??? note "What the Motion YAML does"

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

```yaml
binary_sensor:
- platform: gpio
pin:
number: GPIO3
mode:
input: true
pulldown: false
id: io_pir
name: "PIR"
name: Motion Module
pin: 3
device_class: motion
id: motion_module
```

Each option does something specific:

| Option | What it does |
| --- | --- |
| `platform: gpio` | Reads a digital input on a GPIO pin. |
| `number: GPIO3` | The pin the PIR 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: io_pir` | Internal handle you can reference from automations and lambdas elsewhere in the config. |
| `name: "PIR"` | 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. \| \| `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. \|

## Install the firmware

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

1. Click **Install** on your device card in ESPHome Device Builder.
2. Choose **Plug into the computer running ESPHome Device Builder** for the first flash, or **Wirelessly** if the device is already on your Wi-Fi.
2. Choose **Plug into the computer running ESPHome Device Builder** for the first flash, or **On The Network** if the device is already on your Wi-Fi.
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**
![](../../../assets/esphome-device-builder-install-motion-component.gif)

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

With the device back online, the PIR entity is live on the web server. Open it in a browser on the same network and watch it react.
With the device back online, the Motion 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 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 **PIR** entity in the binary sensor list.
2. Find the **Motion** entity in the binary sensor list.
3. Wave your hand in front of the sensor. The entity flips from OFF to ON while motion is detected, then back to OFF a few seconds after motion stops.

!!! tip "Give the PIR a moment to settle" PIR sensors need a brief warm-up after powering on, usually 5 to 10 seconds, before their readings stabilize. If the sensor reports motion right after boot even when nothing is moving, give it a moment.
!!! tip "Give the Motion sensor a moment to settle"

PIR sensors need a brief warm-up after powering on, usually 5 to 10 seconds, before their readings stabilize. If the sensor reports motion right after boot even when nothing is moving, give it a moment.

![](../../../assets/esphome-device-builder-test-motion-occupancy.gif)

> Web server page showing the PIR binary sensor toggling between ON and OFF as motion is detected.
> Web server page showing the Motion binary sensor toggling between ON and OFF as motion is detected.

**GIF PLACEHOLDER**
!!! success "Your Motion module is now ready to use in automations!"

!!! success "Your PIR motion module is wired up"
You're now ready to make automations around occupancy in your home!
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: Adding the Temperature and Humidity Module
description: Wire up the ESPHome Starter Kit Temperature and Humidity module. This is a trustworthy aht20 great for accurate temp and humidity measurements in any room!
description: >-
Wire up the ESPHome Starter Kit Temperature and Humidity module. This is a
trustworthy aht20 great for accurate temp and humidity measurements in any
room!
---
# Adding the Temperature and Humidity Module

Expand All @@ -26,27 +29,41 @@ The <a href="https://esphome.io/components/web_server/" target="_blank" rel="nor

![](../../../assets/device-builder-install-web-server-v3.gif)

## Plug in the temperature and humidity module
## Attach Temp and Humidity module

Connect the temperature and humidity 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.
Connect the Temperature and Humidity 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.

1. Unplug the USB-C cable from the ESP32-C6 so the board is powered off.
2. Flip up the latch on the FPC connector on both the C6 and the temperature and humidity module.
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.
1\. Unplug the USB-C cable from the ESP32-C6 so the board is powered off.

**GIF PLACEHOLDER**
![](../../../assets/esphome-starter-kit-remove-usb.webp)

!!! 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.
2\. Flip up the latch on the FPC connector then gently slide the ribbon cable in to the connector. Gently press the latch down to lock it in place.

## Add the temperature and humidity component in ESPHome Device Builder
![](../../../assets/esphome-starter-kit-attach-top-fpc-ribbon.webp)

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.
3\. Slide the ribbon cable into the button module with the blue side facing upwards then press the latch down to lock it in place.

![](../../../assets/esphome-starter-kit-attach-fpc-to-temp-hum-module.webp)

4\. Plug the C6 back into your computer.

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

## Add to 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 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. Click **Add Component** in the editor toolbar.
3. Search for **Temperature and Humidity** and select the Apollo Starter Kit temperature and humidity component.
4. Click **Add**. Device Builder inserts the I2C bus and the AHT20F sensor block into your YAML.
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.
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.

![](../../../assets/esphome-device-builder-add-i2c-temp-hum-component.gif)

??? note "What the temperature and humidity YAML does"

Expand Down Expand Up @@ -88,22 +105,24 @@ ESPHome Device Builder ships an Add Component flow that knows the pin layout for
Flash the device so the new web server and the temperature and humidity entities go live.

1. Click **Install** on your device card in ESPHome Device Builder.
2. Choose **Plug into the computer running ESPHome Device Builder** for the first flash, or **Wirelessly** if the device is already on your Wi-Fi.
2. Choose **Plug into the computer running ESPHome Device Builder** for the first flash, or **On The Network** if the device is already on your Wi-Fi.
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**
![](../../../assets/esphome-device-builder-install-temp-hum-component.gif)

## Test it in the web server
## Test the Temp and Humidity

With the device back online, the temperature and humidity entities are live on the web server. Open it in a browser on the same network and watch the values come in.
With the device back online, the temperature and humidity entities are 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 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 **Temperature** and **Humidity** entities in the sensor list.
3. Watch the values update on the interval you set. Cup your hand over the sensor or breathe on it, the humidity reading will respond within a few cycles.

![](../../../assets/esphome-device-builder-test-temp-humidity.gif)

> Web server page showing the Temperature and Humidity sensors with live readings.

**GIF PLACEHOLDER**
!!! success "Your Temperature and Humidity module is wired up"

!!! success "Your temperature and humidity module is wired up"
You now have a trustworthy temp and humidity sensor to place anywhere in your home!