ESPHome for Home Assistant (built-in integration)

About

ESPHome is a built-in integration that connects Home Assistant to ESPHome devices over the local network. It exposes the device's features as many entity types, including sensors, switches, lights, climate, covers, cameras, media players, and update entities, and it also supports an Assist satellite. Home Assistant can discover devices on the network and offer to add them, and the connection is encrypted with a key from the device's configuration, with passwords deprecated. Setup happens in the UI by entering the device host and port. Options cover whether a device may perform Home Assistant actions, the Bluetooth scanning mode, and whether device logs are sent to Home Assistant. New devices appear without repeating setup, removed devices are cleaned up, and repair notices can flag deprecated or blocked behavior.

Automatic summary of Home Assistant's source code. Something wrong? Get in touch

Supports

Works locally Talks to your devices on your own network. No vendor cloud in between.
Set up in the UI Add it in Settings, Devices and services. Nothing to download.
Found by itself Home Assistant spots it on the network and offers to add it.
Adds new devices New devices show up without setting it up again.
Cleans up devices Devices that are gone are removed by themselves.
Change settings later Its connection settings can change without removing it.
Platinum quality Home Assistant's own rating of its code and setup experience.
Updated with Home Assistant Ships and updates with every Home Assistant release.

Provides

Lights
Climate
Water heaters
Fans
Covers
Valves
Cameras
Locks
Alarms
Media
Switches
Sensors

Setting it up

Home Assistant usually finds it on the network and offers to add it. It can also be added by hand under Settings, Devices and services.

Connect

HostIP address or hostname of the ESPHome device
PortPort that the native API is running on

Authenticate

PasswordPasswords are deprecated and will be removed in a future version. Please update your ESPHome device YAML configuration to use an encryption key instead.

Encryption key

Encryption keyThe encryption key is used to encrypt the connection between Home Assistant and the ESPHome device. You can find this in the api: section of your ESPHome device YAML configuration.

Also asked when signing in again.

After setup

Allow the device to perform Home Assistant actions.When enabled, ESPHome devices can perform Home Assistant actions or send events. Only enable this if you trust the device.
Bluetooth scanning modeAuto is recommended for most setups. It saves battery on your Bluetooth devices while still catching new devices and updates quickly.
Subscribe to logs from the device.When enabled, the device will send logs to Home Assistant and you can view them in the logs panel.

Texts from Home Assistant's source code, Apache License 2.0.

Entities

assist_satelliteAssist satellite
SelectsAssistant, Finished speaking detection, Wake word

Troubleshooting

DiagnosticsDownloads a diagnostics file to attach to a bug report.
Repair noticesNotices it can show in Settings, Repairs:In progress binary sensors are deprecated, Is not permitted to perform Home Assistant actions