diff --git a/source/_docs/configuration/customizing-devices.markdown b/source/_docs/configuration/customizing-devices.markdown index 2e47158f0be..decc7d5529f 100644 --- a/source/_docs/configuration/customizing-devices.markdown +++ b/source/_docs/configuration/customizing-devices.markdown @@ -9,23 +9,35 @@ related: - docs: /docs/organizing/labels/ --- -## Customizing an entity - After adding a new device, you might find the automatically assigned entity ID too technical and the entity lacking a friendly name. You can personalize these elements to better fit your naming conventions or modify other attributes like the icon. To change entity attributes, follow these steps: 1. Go to {% my entities title="**Settings** > **Devices & services** > **Entities**" %} and select the entity from the list. -2. In the top right corner, select the cog icon. +2. In the top-right corner, select the {% icon "mdi:cog" %} cog icon. ![Entity dialog box with cog icon.](/images/docs/configuration/customizing-entity-dialog.png) 3. Enter or edit the attributes: - - For example, the entity ID here could be shortened to `binary_sensor.living_room_motion_1`. - - Do not change the domain of the entity - the part before the `.` (binary_sensor, in this example). + - For example, the entity ID here could be shortened to `binary_sensor.lumi_sensor_aq2_opening`. - You can use lowercase letters, numbers, and underscores. - The ID must not start or end with an underscore. + - To undo the change and revert the ID to the default, select the {% icon "mdi:restore" %} icon. + - **Note**: You can only reset the ID to the default ID for entities with a unique ID. + - IDs of entities that are disabled or for which the integration is not set up cannot be reverted. + - To revert all the entity IDs for a device, on the device page, select the three dots {% icon "mdi:dots-vertical" %} menu, then select **Recreate entity IDs**. + - **Result**: This resets the entity ID and applies the current default naming convention. + - The terms used to generate the entity ID depends on a few factors. Prioritization is as follows: + 1. If you changed the friendly name of the entity, the friendly name will be used. + 2. The entity ID suggested by the integration (just a few integrations do this). + 3. The default name in the user language, if using Latin script. + - If the something other than Latin script is used, the entity ID is based on the English default name. + - This is because entity IDs must use lowercase alphanumeric characters in the range of [a-z,1-9]. + + ![revert all entity IDs for a device from the device page](/images/docs/configuration/device-page-revert-entity-id.png) + - Enter or edit the friendly name. + - In this example, this would change "Opening". - If needed, from the **Shown as** menu, you can select a different [device class](/integrations/homeassistant/#device-class). - If you like, add a [label](/docs/organizing/labels/). diff --git a/source/images/docs/configuration/customizing-entity-dialog.png b/source/images/docs/configuration/customizing-entity-dialog.png index d6076b446a9..9188d665115 100644 Binary files a/source/images/docs/configuration/customizing-entity-dialog.png and b/source/images/docs/configuration/customizing-entity-dialog.png differ diff --git a/source/images/docs/configuration/customizing-entity.png b/source/images/docs/configuration/customizing-entity.png index 63e8760af07..71b67832312 100644 Binary files a/source/images/docs/configuration/customizing-entity.png and b/source/images/docs/configuration/customizing-entity.png differ