mirror of
https://github.com/nekorevend/esphome-emporia-vue-utility.git
synced 2026-01-09 13:00:38 -07:00
Clarify docs and make example yamls consistent. (#12)
This commit is contained in:
12
docs/faq.md
12
docs/faq.md
@@ -41,10 +41,11 @@ api:
|
||||
key: "M3d8zXcnwM4Uo2fRybLjFUNVs+mnlC1XbEfnlvUNI2c="
|
||||
```
|
||||
|
||||
- Just a security measure. It’s a shared secret between your device and Home Assistant.
|
||||
- This key is a shared secret between your device and Home Assistant.
|
||||
- Ensures all ESPHome API traffic (state updates, commands, etc.) is encrypted and authenticated.
|
||||
- Without it, someone on your LAN could spoof commands to the device.
|
||||
- To generate one manually:
|
||||
- The [official documentation](https://esphome.io/components/api/#configuration-variables) can generate a key. Find it under "If you need a key, you can use the key below; it is randomly generated by your browser each time this page loads:"
|
||||
- Or, to generate one manually:
|
||||
|
||||
```
|
||||
python3 -c "import base64, os; print(base64.b64encode(os.urandom(32)).decode())"
|
||||
@@ -57,12 +58,13 @@ python3 -c "import base64, os; print(base64.b64encode(os.urandom(32)).decode())"
|
||||
Looks like this in the YAML:
|
||||
```
|
||||
ota:
|
||||
platform: esphome
|
||||
password: "blah"
|
||||
```
|
||||
- Just a security measure. It’s a shared secret between your device and Home Assistant.
|
||||
- Used only when flashing new firmware over Wi-Fi (OTA updates).
|
||||
- This password is a shared secret between your device and ESPHome.
|
||||
- Other instances of ESPHome would need to know this password in order to update your device with a new firmware.
|
||||
- Prevents anyone on your LAN from pushing firmware to the device without authorization.
|
||||
- ESPHome generates one the first time if you don’t set it yourself.
|
||||
- The `password:` is optional, but `ota:` is **required** if you want the ability to deploy firmware updates wirelessly.
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user