diff --git a/source/_docs/configuration/customizing-devices.markdown b/source/_docs/configuration/customizing-devices.markdown index d39bb0e3976..2e47158f0be 100644 --- a/source/_docs/configuration/customizing-devices.markdown +++ b/source/_docs/configuration/customizing-devices.markdown @@ -6,31 +6,35 @@ related: - docs: /docs/configuration/ title: configuration.yaml file - docs: /docs/configuration/troubleshooting/ + - docs: /docs/organizing/labels/ --- -## Changing entity name and entity ID +## Customizing an entity -After adding a new device, the entity may not have a name and the automatically assigned entity ID might look very technical. If you like, you can use your own naming concept for devices. +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 the entity ID and friendly name of supported entities, follow these steps: +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. ![Entity dialog box with cog icon.](/images/docs/configuration/customizing-entity-dialog.png) -3. Enter the new name or the new entity ID. - - For example, the entity ID here could be `light.bedroom_lightstrip_3`. - - Do not change the domain of the entity - the part before the `.` (period). - - You can use lowercase letters, numbers, and underscores. - - The name must not start or end with an underscore. +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). + - You can use lowercase letters, numbers, and underscores. + - The ID must not start or end with an underscore. + - Enter or edit the friendly name. + - 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/). ![Settings for entity.](/images/docs/configuration/customizing-entity.png) -4. Select **Update**. +4. To apply the changes, select **Update**. 5. If you have used this entity in automations and scripts, you need to rename the entity ID there, too. - Go to {% my automations title="**Settings** > **Automations & Scenes**" %} open the respective tab and find your automation or script. - ![Edit entity ID in automation.](/images/docs/configuration/edit_entity-id_in_automation.png) +### Customizing an entity in YAML -If your entity is not supported, or you cannot customize what you need via this method, you need to edit the settings in your {% term "`configuration.yaml`" %} file. For a detailed description of the entity configuration variables and device class information, refer to the [Home Assistant Core integration documentation](/integrations/homeassistant/). +If your entity is not supported, or you could not customize what you need via the user interface, you need to edit the settings in your {% term "`configuration.yaml`" %} file. For a detailed description of the entity configuration variables and [device class](/integrations/homeassistant/#device-class) information, refer to the [Home Assistant Core integration documentation](/integrations/homeassistant/). diff --git a/source/images/docs/configuration/customizing-entity-dialog.png b/source/images/docs/configuration/customizing-entity-dialog.png index 5dda10ee232..d6076b446a9 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 e1ccaa269cc..63e8760af07 100644 Binary files a/source/images/docs/configuration/customizing-entity.png and b/source/images/docs/configuration/customizing-entity.png differ diff --git a/source/images/docs/configuration/edit_entity-id_in_automation.png b/source/images/docs/configuration/edit_entity-id_in_automation.png deleted file mode 100644 index 1b20b856cf9..00000000000 Binary files a/source/images/docs/configuration/edit_entity-id_in_automation.png and /dev/null differ