Skip to content

docs: align README with the MQTT transport switch #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
basmeerman merged 1 commit into from
Jun 28, 2026
Merged

docs: align README with the MQTT transport switch #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 |
|---|---|---|
Expand Down