From 46be8fb743a36d8742e0791ac38bcb8afd4357f5 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Sat, 19 Apr 2025 00:41:12 -1000 Subject: [PATCH] Remove legacy format exception for ESPHome entity naming (#38559) --- source/_integrations/esphome.markdown | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-) diff --git a/source/_integrations/esphome.markdown b/source/_integrations/esphome.markdown index 11c0552bdc1..56777eb0a09 100644 --- a/source/_integrations/esphome.markdown +++ b/source/_integrations/esphome.markdown @@ -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