Customizing entities: update procedure (#32995)

This commit is contained in:
c0ffeeca7 2024-06-07 22:17:07 +02:00 committed by GitHub
parent 7c328c5439
commit 3ed0283884
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 15 additions and 11 deletions

View File

@ -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/).

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 82 KiB

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB