jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-26 02:37:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add supported functionality to ESPHome (#38614)

Browse Source
This commit is contained in:
J. Nick Koston 2025-04-17 22:30:30 -10:00 committed by GitHub
parent c74127550f
commit 839e28e04d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 25 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
source/_integrations/esphome.markdown
View File

@ -98,6 +98,8 @@ This integration follows the standard integration removal process; no extra step
{% include integrations/remove_device_service.md %}
{% include integrations/option_flow.md %}
## Supported devices
The ESPHome integration works with devices that run ESPHome firmware and expose their functionality through the [native ESPHome API](https://esphome.io/components/api.html). This API is designed for tight, efficient integration with Home Assistant, enabling ESPHome devices to push updates directly to Home Assistant in **near real time**.
@ -112,11 +114,31 @@ Rather than polling for sensor values or device states, Home Assistant maintains
This real-time behavior enables fast, reactive automations and a smooth user experience compared to traditional polling-based integrations.
## Home Assistant actions
## Supported Functionality
ESPHome devices can perform actions to any [Home Assistant action](https://esphome.io/components/api.html#homeassistant-service-action). This functionality is not enabled by default for newly configured device, but can be turned on the options flow on a per device basis.
### Entities
{% include integrations/option_flow.md %}
The available entities depend on the components defined in the ESPHome YAML configuration for each device. These entities are exposed through the [Native API Component](https://esphome.io/components/api.html).
### Firing Events on the Home Assistant Event Bus
When using the native API with Home Assistant, you can trigger events on the Home Assistant event bus directly from ESPHome. For more details, see the [homeassistant.event Action](https://esphome.io/components/api.html#homeassistant-event-action).
### Actions
Each device can define Home Assistant Actions based on its ESPHome YAML configuration. For more information, refer to the [Actions](https://esphome.io/components/api.html#actions) section in the [Native API Component](https://esphome.io/components/api.html) documentation.
### Retrieving Data from Home Assistant
ESPHome can retrieve the state of Home Assistant entities using the [Native API](https://esphome.io/components/api.html) with [User-Defined Actions](https://esphome.io/components/api.html#user-defined-actions).
### Home Assistant Actions
ESPHome devices can call any [Home Assistant Action](https://esphome.io/components/api.html#homeassistant-service-action). This feature is not enabled by default for newly added devices but can be enabled through the options flow on a per-device basis.
### Tag Scanning Support
The [Native API Component](https://esphome.io/components/api.html) also supports sending tag scan events to Home Assistant. See the [homeassistant.tag_scanned Action](https://esphome.io/components/api.html#homeassistant-tag-scanned-action) for more information.
## Entity naming and IDs