Skip to content

Remove legacy format exception for ESPHome entity naming #38559

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 1 commit into from
Apr 19, 2025
Merged

Remove legacy format exception for ESPHome entity naming #38559

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 4 additions & 14 deletions source/_integrations/esphome.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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

Expand Down