Skip to content

Add supported functionality to ESPHome #38614

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
merged 4 commits into from
Apr 18, 2025
Merged

Add supported functionality to ESPHome #38614

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8d3a543
Add supported functionality to ESPHome
bdraco Apr 18, 2025
576bd7e
Merge branch 'current' into bdraco-patch-12
bdraco Apr 18, 2025
bd396e8
Merge branch 'current' into bdraco-patch-12
bdraco Apr 18, 2025
94ac7be
Merge branch 'current' into bdraco-patch-12
bdraco Apr 18, 2025
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
28 changes: 25 additions & 3 deletions source/_integrations/esphome.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Expand All @@ -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

Expand Down