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-15 21:36:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove legacy format exception for ESPHome entity naming (#38559)

Browse Source
This commit is contained in:
J. Nick Koston 2025-04-19 00:41:12 -10:00 committed by GitHub
parent ba1d3e7043
commit 46be8fb743
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
source/_integrations/esphome.markdown
View File

@ -58,14 +58,10 @@ ESPHome devices can perform actions to any [Home Assistant action](https://espho
## 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 {% term "`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 {% term "`configuration.yaml`" %}.
### Friendly naming
- Entity name is a combination of the friendly name and component name
- Entity name is a combination of the friendly name (or name if unset) and component name
- Entity ID is derived from the entity name with the device name prepended
Example:
Example with `friendly_name` set:
```yaml
esphome:
@ -78,13 +74,7 @@ sensor:
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:
Example without `friendly_name` set:
```yaml
esphome:
@ -94,7 +84,7 @@ sensor:
name: "Temperature"
```
The entity will be named `Temperature` and will default to having an entity_id of `sensor.temperature`.
The entity will be named `livingroomdesk Temperature` and will default to having an entity ID of `sensor.livingroomdesk_temperature`.
## Obtaining logs from the device