Skip to content

Commit 68ece33

Browse files
committed
Mention the STATUS led
1 parent 2896cdf commit 68ece33

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,14 @@ packages:
138138
wifi_password: !secret wifi_password
139139
wifi_ap_password: !secret wifi_ap_password
140140
ota_password: !secret ota_password
141+
relay1_name: "Living Room Relay"
142+
relay2_name: "Bedroom Relay"
143+
relay3_name: "Kitchen Relay"
144+
relay4_name: "Bathroom Relay"
145+
relay5_name: "Dining Room Relay"
146+
relay6_name: "Office Relay"
147+
relay7_name: "Guest Room Relay"
148+
relay8_name: "Hallway Relay"
141149
ref: main # optional
142150
refresh: 1d # optional
143151
@@ -152,6 +160,17 @@ See e.g. [example-instance.yaml](./example-instance.yaml)
152160
and [example-instance-with-different-sensors.yaml](./example-instance-with-different-sensors.yaml).
153161

154162

163+
Also note that the [ESPHome package](./main.yaml) from this repo will use the board LED to act
164+
as the ESPHome [status LED](https://esphome.io/components/status_led/). So as summary:
165+
166+
* It will **blink slowly (about every second) when a warning is active**. Warnings are active when for example reading a sensor value fails temporarily, the WiFi/MQTT connections are disrupted, or if the native API component is included but no client is connected.
167+
168+
* It will **blink quickly (multiple times per second) when an error is active**. Errors indicate that ESPHome has found an error while setting up. In most cases, ESPHome will still try to recover from the error and continue with all other operations.
169+
170+
* It will **stay off otherwise**.
171+
172+
173+
155174
## First ESPHome install
156175

157176
When you receive your ESP32 relay board, you will need to carry out the first ESPHome installation
@@ -198,8 +217,6 @@ Here you can find a QR code I produced with the optimal [miniQR code generator](
198217

199218
* Write the [external component](https://esphome.io/components/external_components/) that will make it possible to control relays using the local temp sensor when connection to HA fails.
200219

201-
* Signal wifi connectivity through the LED
202-
203220

204221

205222
## Similar projects

example-instance.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ packages:
99
wifi_password: "supersecretpassword"
1010
wifi_ap_password: "deadbeefdead"
1111
ota_password: "deadbeefdeadbeefdeadbeefdeadbeef"
12+
relay1_name: "Living Room Relay"
13+
relay2_name: "Bedroom Relay"
14+
relay3_name: "Kitchen Relay"
15+
relay4_name: "Bathroom Relay"
16+
relay5_name: "Dining Room Relay"
17+
relay6_name: "Office Relay"
18+
relay7_name: "Guest Room Relay"
19+
relay8_name: "Hallway Relay"
1220
syslog_server: "1.1.1.1"
1321
ref: main # optional
1422
refresh: 1d # optional

0 commit comments

Comments
 (0)