From 07e46139ee47973725936b585dd9f30ab31f2cf7 Mon Sep 17 00:00:00 2001 From: Bas Meerman <30606346+basmeerman@users.noreply.github.com> Date: Sun, 28 Jun 2026 23:23:29 +0200 Subject: [PATCH] docs: align README with the MQTT transport switch Two leftover native-API references in README.md after the api: -> mqtt: switch (PR #11): - Quick start: replaced "generate an API encryption key" with the MQTT broker host/user/password setup (mqtt_host is a bare IP, no port). The api_encryption_key is unused now that the api: block is commented out. - Home Assistant integration: rewrote the auto-discovery paragraph to describe MQTT broker auto-discovery instead of the native ESPHome integration. Co-Authored-By: Claude Opus 4.8 (1M context) --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ce16df2..01256f1 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,8 @@ pipx install esphome # 2. Configure secrets cp secrets.yaml.example secrets.yaml -# Edit secrets.yaml — fill in WiFi creds and pick strong passwords -# (generate an API encryption key with: openssl rand -base64 32) +# Edit secrets.yaml — fill in WiFi creds, the OTA password, and the +# MQTT broker host/user/password (mqtt_host is a bare IP — no port) # 3. Plug the LOLIN D32 into USB, then flash the first time over USB: esphome run fancontrol.yaml @@ -65,8 +65,10 @@ esphome run fancontrol.yaml --device /dev/cu.wchusbserial10 # adjust the seria ## Home Assistant integration -Once on the network, HA auto-discovers the device via the ESPHome integration. -No manual MQTT configuration needed. Exposed entities: +The device publishes to an MQTT broker (configured via `mqtt_host` / `mqtt_user` +/ `mqtt_password` in `secrets.yaml`). With MQTT auto-discovery enabled, Home +Assistant picks up the entities automatically once the device connects to the +broker — no manual entity setup needed. Exposed entities: | Entity | Type | Notes | |---|---|---|