mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-08 12:08:58 +00:00
92 lines
2.4 KiB
Markdown
92 lines
2.4 KiB
Markdown
---
|
|
title: ESPHome
|
|
description: Support for ESPHome devices using the native ESPHome API.
|
|
featured: true
|
|
ha_category:
|
|
- Alarm
|
|
- DIY
|
|
- Update
|
|
ha_release: 0.85
|
|
ha_iot_class: Local Push
|
|
ha_config_flow: true
|
|
ha_codeowners:
|
|
- '@OttoWinter'
|
|
- '@jesserockz'
|
|
- '@kbx81'
|
|
- '@bdraco'
|
|
ha_domain: esphome
|
|
ha_zeroconf: true
|
|
ha_platforms:
|
|
- alarm_control_panel
|
|
- binary_sensor
|
|
- button
|
|
- camera
|
|
- climate
|
|
- cover
|
|
- diagnostics
|
|
- fan
|
|
- light
|
|
- lock
|
|
- media_player
|
|
- number
|
|
- select
|
|
- sensor
|
|
- switch
|
|
- text
|
|
- update
|
|
ha_integration_type: device
|
|
ha_dhcp: true
|
|
works_with:
|
|
- local
|
|
---
|
|
|
|
This integration allows [ESPHome](https://esphome.io) devices to connect directly to Home Assistant with the [native ESPHome API](https://esphome.io/components/api.html).
|
|
|
|
{% include integrations/config_flow.md %}
|
|
|
|
## Home Assistant service calls
|
|
|
|
ESPHome devices can make service calls to any [Home Assistant service](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.
|
|
|
|
{% include integrations/option_flow.md %}
|
|
|
|
## Entity naming and IDs
|
|
|
|
ESPHome uses different naming and entity ID rules based on the configuration of the ESPHome device. It is recommended to set a `friendly_name` in the ESPHome `configuration.yaml` to take advantage of the newer naming structure, which is consistent with Home Assistant naming standards and makes it much easier to tell similar devices apart. The legacy naming rules apply when the `friendly_name` is not set in the `configuration.yaml`.
|
|
|
|
### Friendly naming
|
|
|
|
- Entity name is a combination of the friendly name and component name
|
|
- Entity ID is derived from the entity name with the device name prepended
|
|
|
|
Example:
|
|
|
|
```yaml
|
|
esphome:
|
|
name: "livingroomdesk"
|
|
friendly_name: "Living room desk"
|
|
|
|
sensor:
|
|
name: "Temperature"
|
|
```
|
|
|
|
The entity will be named `Living room desk Temperature` and will default to having an entity ID of `sensor.livingroomdesk_temperature`.
|
|
|
|
### Legacy naming
|
|
|
|
- Entity name is the component name
|
|
- Device name is not prepended to the entity name
|
|
- Entity ID is derived solely from the entity name
|
|
|
|
Example:
|
|
|
|
```yaml
|
|
esphome:
|
|
name: "livingroomdesk"
|
|
|
|
sensor:
|
|
name: "Temperature"
|
|
```
|
|
|
|
The entity will be named `Temperature` and will default to having an entity_id of `sensor.temperature`.
|