You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/products/ESPHome-Starter-Kit/modules/apollo-breakout-module.md
+80-25Lines changed: 80 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,30 +8,13 @@ description: >-
8
8
9
9
The Breakout Module gives your starter kit room to grow. It breaks the ESP32-C6's pins out so you can wire up your own parts, the components the kit doesn't include. By the end of this tutorial you'll have it attached to your ESP32-C6 and be ready to build something of your own.
10
10
11
-
!!! note "More detail coming soon"
12
-
13
-
This page covers the basics for getting the Breakout Module attached and online. We'll fill out the module-specific wiring, pinout, and example automations in a follow-up update.
14
-
15
11
!!! note "Before you start"
16
12
17
13
Work through the two prerequisites first:
18
14
19
15
* [Start Here](/products/ESPHome-Starter-Kit/start-here.md) to snap the module off the panel.
20
16
* [First Steps](/products/ESPHome-Starter-Kit/setup/first-steps.md) to install ESPHome Device Builder and create your starter kit device.
21
17
22
-
#### Prerequisite
23
-
24
-
The <ahref="https://esphome.io/components/web_server/"target="_blank"rel="noreferrer nofollow noopener">Web Server</a> is used to broadcast a local website using your device. This allows you to navigate to the IP address of your device or hostname such as <ahref="http://esphome-starter-kit.local/"target="_blank"rel="noreferrer nofollow noopener">esphome-starter-kit.local</a> to easily control your new device!
25
-
26
-
1. In the ESPHome Device Builder, navigate to the **Core configuration** section.
27
-
2. Click **Add component**.
28
-
3. Scroll to **Web Server** and click **Add**.
29
-
4. Click **Add** once more to confirm.
30
-
5. Toggle **Show advanced settings**.
31
-
6. Scroll down to **Version** and select **3** from the dropdown.
Connect the Breakout Module to the ESP32-C6 using one of the FPC ribbon cables that came with the kit. Either FPC connector on the ESP32-C6 works, top or bottom.
@@ -50,17 +33,91 @@ Connect the Breakout Module to the ESP32-C6 using one of the FPC ribbon cables t
50
33
51
34
3\. Slide the ribbon cable into the Breakout Module with the blue side facing upwards then press the latch down to lock it in place.
The Breakout Module is covered in connectors, each labeled on the board. Most of them carry the same I2C bus at different voltages, plus a 1Wire port and a GPIO header for everything else.
Five connectors share the I2C bus, so most sensor breakouts plug straight in no matter which ecosystem they come from:
49
+
50
+
* **3.5mm jack**, top left, for an optional SHT20 temperature and humidity probe
51
+
* **STEMMA QT (3.3V)**, middle left of the board
52
+
* **STEMMA (5V, 4-pin)**, bottom center
53
+
* **Grove**, bottom left
54
+
* **SEN6x**, bottom right, a dedicated port for Sensirion SEN6x air quality sensors
55
+
56
+
| Signal | ESP32-C6 pin |
57
+
| --- | --- |
58
+
| SCL | GPIO0 |
59
+
| SDA | GPIO1 |
60
+
61
+
Each connector also carries power and ground at its labeled voltage, so a single cable powers the sensor and wires up the bus.
62
+
63
+
=== "1Wire"
64
+
65
+
The connector labeled **1Wire** (top right of the board) is for 1-Wire sensors like the <a href="https://cdn-shop.adafruit.com/datasheets/DS18B20.pdf" target="_blank" rel="noreferrer nofollow noopener">DS18B20 temperature probe</a> (1), the same probe our [TEMP-1](/products/temp1/introduction.md) and [TEMP-1B](/products/temp1b/introduction.md) use.
66
+
{ .annotate }
67
+
68
+
1. Probe options:
69
+
70
+
<a href="https://apolloautomation.com/products/long-temperature-probe" target="_blank" rel="noreferrer nofollow noopener">**1.5m (~5ft) Waterproof Flat Cable (DS18B20)**</a>: -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc.
56
71
57
-
The Breakout Module is different from the other starter kit modules. Instead of a single fixed sensor with a ready-made component in Device Builder, it breaks the ESP32-C6's pins out to the module so you can wire up your own buttons, sensors, LEDs, and other parts. This is the module for tinkering and building something that isn't in the kit.
72
+
<a href="https://apolloautomation.com/products/short-temperature-probe" target="_blank" rel="noreferrer nofollow noopener">**20cm (~8in) Waterproof Flat Cable (DS18B20)**</a>: -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy.
58
73
59
-
Because the wiring is up to you, there's no **Add Component** entry to select. You decide what to connect, then add the matching ESPHome component to your YAML by hand. The <ahref="https://esphome.io/components/"target="_blank"rel="noreferrer nofollow noopener">ESPHome component index</a> lists every supported sensor, switch, light, and more, along with the config each one needs.
74
+
Data is on **GPIO6**. In your config, the <a href="https://esphome.io/components/one_wire/" target="_blank" rel="noreferrer nofollow noopener">One Wire</a> component sets up the bus on that pin, and the <a href="https://esphome.io/components/sensor/dallas_temp/" target="_blank" rel="noreferrer nofollow noopener">Dallas temperature sensor</a> reads each probe on it.
60
75
61
-
!!! note "Pinout coming soon"
76
+
Plug the probe's connector into the 1Wire port with the latch side facing up.
62
77
63
-
We'll add the Breakout Module pinout (which module pin maps to which ESP32-C6 GPIO) and a worked example or two once the module-specific docs are ready. For now, match your wiring to the GPIO numbers in your component's ESPHome config.
* SCL and SDA are the same I2C bus as the connectors (GPIO0 and GPIO1).
99
+
* IO6 is shared with the 1Wire port and the 3-pin STEMMA.
100
+
* TX and RX are the ESP32-C6's UART.
101
+
102
+
??? note "Advanced: keeping 3.3V power on during sleep"
103
+
104
+
Out of the box, the module's 3.3V pin runs on the ESP32-C6's controlled power rail (**3vCTRL**). That's the battery-friendly setting: when the ESP sleeps, power to your connected components shuts off too.
105
+
106
+
If your project needs 3.3V that stays on through sleep, there's a solder jumper on the back of the board, top right, labeled **J5**. The existing bridge between the center pad and the **3vCTRL** pad looks like an H. Cut that bridge, then solder a new bridge from the center pad to the **3V** pad for always-on power.
This involves cutting a trace and soldering on the board itself, so skip it unless you know you need it. Most projects are fine with the default.
111
+
112
+
## Add to ESPHome Device Builder
113
+
114
+
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:
115
+
116
+
* 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.
117
+
* For a DS18B20 probe on the 1Wire connector, add the <ahref="https://esphome.io/components/one_wire/"target="_blank"rel="noreferrer nofollow noopener">One Wire</a> component on GPIO6, then a <ahref="https://esphome.io/components/sensor/dallas_temp/"target="_blank"rel="noreferrer nofollow noopener">Dallas temperature sensor</a>.
118
+
* For anything on the GPIO header, add the matching component and point it at the GPIO you wired.
119
+
120
+
The <ahref="https://esphome.io/components/"target="_blank"rel="noreferrer nofollow noopener">ESPHome component index</a> lists every supported sensor, switch, light, and more, along with the config each one needs.
64
121
65
122
## Install the firmware
66
123
@@ -79,8 +136,6 @@ With the device back online, whatever you wired up shows up on the web server al
79
136
2. Find the entity for the component you added in the list.
80
137
3. Trigger it (press your button, cover your sensor, and so on) and watch the value update.
81
138
82
-
!!! success "Your Breakout Module is wired up and ready!"
83
-
84
-
From here, the Breakout Module is your sandbox. Mix in any ESPHome component and build something that's all your own.
139
+
From here, the Breakout Module is your sandbox. Mix in any ESPHome component and build something that's all your own.
Copy file name to clipboardExpand all lines: docs/products/ESPHome-Starter-Kit/modules/button-module.md
+1-14Lines changed: 1 addition & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,19 +15,6 @@ The button module is the first input your starter kit gets, and the fastest way
15
15
* [Start Here](/products/ESPHome-Starter-Kit/start-here.md) to snap the button module off the panel.
16
16
* [First Steps](/products/ESPHome-Starter-Kit/setup/first-steps.md) to install ESPHome Device Builder and create your starter kit device.
17
17
18
-
#### Prerequisite
19
-
20
-
The <ahref="https://esphome.io/components/web_server/"target="_blank"rel="noreferrer nofollow noopener">Web Server</a> is used to broadcast a local website using your device. This allows you to navigate to the IP address of your device or hostname such as <ahref="http://esphome-starter-kit.local/"target="_blank"rel="noreferrer nofollow noopener">esphome-starter-kit.local</a> to easily control your new device!
21
-
22
-
1. In the ESPHome Device Builder, navigate to the **Core configuration** section.
23
-
2. Click **Add component**.
24
-
3. Scroll to **Web Server** and click **Add**.
25
-
4. Click **Add** once more to confirm.
26
-
5. Toggle **Show advanced settings**.
27
-
6. Scroll down to **Version** and select **3** from the dropdown.
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 ESP32-C6 works, top or bottom.
@@ -93,7 +80,7 @@ ESPHome Device Builder ships an **Add Component** flow that knows the pin layout
93
80
94
81
## Install the firmware
95
82
96
-
Flash the device so the new web server and button entity go live.
83
+
Flash the device so the new button entity goes live.
97
84
98
85
1. Click **Install** on your device card in ESPHome Device Builder.
99
86
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.
0 commit comments