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: ESPHome Devices/README.md
+35-13Lines changed: 35 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,30 @@ This directory contains the ESPHome YAML configuration files for the IRK Capture
4
4
5
5
## Files
6
6
7
+
### irk-capture-device-remote.yaml
8
+
9
+
Remote Device Configuration (Recommended)
10
+
11
+
This is the simplest configuration option. It pulls both the YAML package and IRK Capture component directly from GitHub at build time. No need to download or copy any files to your Home Assistant filesystem.
12
+
13
+
**Usage:**
14
+
15
+
- Use this as a template for your own device configuration
16
+
- Replace all substitution values with your device-specific settings
17
+
- Tip: Create a dummy device in ESPHome Device Builder, grab the API/OTA keys, then use this YAML template
18
+
19
+
**Required substitutions:**
20
+
21
+
-`device_name` - Unique device name (lowercase, hyphens only)
22
+
-`friendly_name` - Human-readable name shown in Home Assistant
23
+
-`api_key` - ESPHome API encryption key
24
+
-`ota_password` - OTA update password
25
+
-`esp32_variant` - Your ESP32 variant (esp32, esp32c3, esp32c6, esp32s3, etc.)
26
+
-`esp32_board` - Your board type (see ESPHome board list)
27
+
-`ble_name` - BLE advertising name shown in Bluetooth settings
28
+
29
+
---
30
+
7
31
### irk-capture-base.yaml
8
32
9
33
Generic ESP32 IRK Capture Package
@@ -59,7 +83,7 @@ This is a single-file configuration that merges the base package and device sett
59
83
60
84
Example Secrets File
61
85
62
-
This is an example secrets file showing the required Wi-Fi credentials. ESPHome Device Builder typically manages this file automatically. Make sure these substituations are in the secrets file.
86
+
This is an example secrets file showing the required Wi-Fi credentials. ESPHome Device Builder typically manages this file automatically. Make sure these substituations are in the secrets file. The ESPHome device builder secrets can be accessed directly via the UI.
63
87
64
88
**Required secrets:**
65
89
@@ -71,19 +95,26 @@ This is an example secrets file showing the required Wi-Fi credentials. ESPHome
71
95
72
96
## Which Configuration Should I Use
73
97
74
-
### Use the Package Approach (base + device) if
98
+
### Use the Remote Configuration (Recommended) if
99
+
100
+
- You want the simplest setup with no local file management
101
+
- You want automatic updates when the component is updated on GitHub
102
+
- You don't need to modify the base package
103
+
- You're new to ESPHome
104
+
105
+
### Use the Local Package Approach (base + device) if
75
106
76
107
- You have multiple ESP32 devices running IRK Capture
77
108
- You want to maintain consistency across devices
78
109
- You prefer separation between base functionality and device settings
79
-
- You're comfortable with the ESPHome package system
110
+
- You need to customize the base package
80
111
81
112
### Use the Standalone Configuration (full) if
82
113
83
114
- You have a single ESP32 device
84
115
- You prefer everything in one file
85
116
- You want simplicity over modularity
86
-
- You're new to ESPHome packages
117
+
- You want an offline copy of the YAML configuration. However, the IRK Capture component is still pulled from GitHub at build time.
87
118
88
119
---
89
120
@@ -97,12 +128,3 @@ When using the package approach, your ESPHome directory should look like this:
97
128
│ └── irk-capture-base.yaml
98
129
└── my-irk-capture.yaml (your device file)
99
130
```
100
-
101
-
## Directory Structure for Standalone Approach
102
-
103
-
When using the standalone approach:
104
-
105
-
```text
106
-
/config/esphome/
107
-
└── irk-capture-full.yaml (renamed to your preference)
Copy file name to clipboardExpand all lines: README.md
+31-5Lines changed: 31 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,11 +53,37 @@ When your Apple or Android device pairs with the ESP32:
53
53
54
54
## Installation
55
55
56
-
I cover two methods for deploying your ESPHome device. First, you can use an ESPHome package which has a device independent YAML configuration file, plus a tiny device-specific YAML file. Second, you can use a single standalone YAML file that has all of the configuration details. Both accomplish the same end result. Personally I use the package method, as I have various ESP32 device types.
56
+
I cover three methods for deploying your ESPHome device:
57
+
58
+
-**Option 1 - Remote (Recommended):** Pulls the YAML and IRK Capture components directly from GitHub. Simplest method with no local file downloads required. This is the recommended option, as it will always pull the latest version at build time.
59
+
-**Option 2 - Local Package:** Uses a base YAML file plus a device-specific YAML file. Best for managing multiple ESP32 device types. Requires accessing the Home Assistant filesystem to manually copy files into the esphome directory tree.
60
+
-**Option 3 - Local Standalone:** A single self-contained YAML file with all configuration details. Only pulls the IRK Capture component from GitHub at build time.
57
61
58
62
If you use either the Seeed ESP32-C3 or Seeed ESP32-C6, I've built dedicated IRK capture YAML files. You can find those IRK YAML files in my repos: [ESPHome-Seeed-Xiao-ESP32-c3-Config](https://github.com/DerekSeaman/ESPHome-Seeed-Xiao-ESP32-c3-Config) and [ESPHome-Seeed-Xiao-ESP32-C6-Config](https://github.com/DerekSeaman/ESPHome-Seeed-Xiao-ESP32-C6-Config).
59
63
60
-
### Using ESPHome Device Builder Packages (Option 1)
64
+
### Using ESPHome Device Builder Package - Remote (Option 1)
65
+
66
+
This is the simplest installation method. It pulls the component directly from GitHub without requiring any local file downloads.
67
+
68
+
1. Create a new dummy device in ESPHome, and save the unique API and OTA keys.
69
+
2. Delete all of the pre-populated YAML from the dummy device.
70
+
3.**Create your device YAML** using [irk-capture-device-remote.yaml](ESPHome%20Devices/irk-capture-device-remote.yaml) as a template and replace the OTA and API keys with the ones ESPHome generated.
71
+
- Modify the YAML parameters `esp32_variant` and `esp32_board` as needed to match your ESP32 device and board type
72
+
- Change the `device_name` and `friendly_name` as desired.
73
+
74
+
4.**Secrets File (managed by ESPHome device builder UI):**
75
+
76
+
```yaml
77
+
wifi_ssid: "Your WiFi Network"
78
+
wifi_password: "your_wifi_password"
79
+
wifi_captive: "fallback_password"
80
+
```
81
+
82
+
5. **Flash to your ESP32:**
83
+
- In ESPHome, click "Install" and choose your connection method
84
+
- IMPORTANT: After the flashing is complete, either power cycle your ESP32 or do a 'Restart Device' from the ESPHome interface. This will randomize the BLE MAC address.
85
+
86
+
### Using ESPHome Device Builder Package - Local (Option 2)
61
87
62
88
1. **In the Home Assistant filesystem create the 'common' directory under esphome, if not already present:**
63
89
@@ -91,7 +117,7 @@ If you use either the Seeed ESP32-C3 or Seeed ESP32-C6, I've built dedicated IRK
91
117
ble_name: "IRK Capture"# Change: BLE advertising name (max 12 characters, shown in Bluetooth settings)
92
118
```
93
119
94
-
4. **Secrets File** (managed by ESPHome device builder):
120
+
4. **Secrets File (managed by ESPHome device builder UI):**
95
121
- Modify the Wi-Fi secrets as needed
96
122
97
123
```yaml
@@ -104,7 +130,7 @@ If you use either the Seeed ESP32-C3 or Seeed ESP32-C6, I've built dedicated IRK
104
130
- In ESPHome Device Builder, click "Install" and choose your connection method
105
131
- IMPORTANT: After the flashing is complete, either power cycle your ESP32 or do a 'Restart Device' from the ESPHome interface. This will randomize the BLE MAC address.
106
132
107
-
### Using a Standalone ESPHome Device (Option 2)
133
+
### Using a Standalone ESPHome Device - Local (Option 3)
108
134
109
135
1. Create a new dummy device in ESPHome, and save the unique API and OTA keys.
110
136
2. Delete all of the pre-populated YAML from the dummy device.
@@ -124,7 +150,7 @@ If you use either the Seeed ESP32-C3 or Seeed ESP32-C6, I've built dedicated IRK
124
150
ble_name: "IRK Capture" # Change: BLE advertising name (max 12 characters, shown in Bluetooth settings)
125
151
```
126
152
127
-
7. **Secrets File** (managed by ESPHome device builder):
153
+
7. **Secrets File (managed by ESPHome device builder UI):**
0 commit comments