home-assistant/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-12-11 02:43:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add object_id to modern template syntax as default_entity_id (#40409)

Browse Source
This commit is contained in:
Petro31 2025-08-27 12:21:07 -04:00 committed by GitHub
parent df8bdb9ff9
commit c767f40cc8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
source/_integrations/template.markdown
View File

@ -186,7 +186,8 @@ Each entity platform has its own set of configuration options, but there are som
template:
- binary_sensor:
# Common configuration options
- unique_id: my_unique_sensor_id
- default_entity_id: binary_sensor.my_alert
unique_id: my_unique_sensor_id
variables:
my_entity: sensor.watts
availability: "{{ my_entity | has_value }}"
@ -205,6 +206,10 @@ template:
required: false
type: template
default: true
default_entity_id:
description: Use `default_entity_id` instead of name for automatic generation of the entity id. E.g. `sensor.my_awesome_sensor`. When used without a `unique_id`, the entity id will update during restart or reload if the entity id is available. If the entity id already exists, the entity id will be created with a number at the end. When used with a `unique_id`, the `default_entity_id` is only used when the entity is added for the first time. When set, this overrides a user-customized Entity ID in case the entity was deleted and added again.
required: false
type: string
icon:
description: Defines a template for the icon of the entity.
required: false
@ -218,7 +223,7 @@ template:
required: false
type: template
unique_id:
description: An ID that uniquely identifies this entity. Will be combined with the unique ID of the configuration block if available. This allows changing the `name`, `icon` and `entity_id` from the web interface.
description: An ID that uniquely identifies this entity. Will be combined with the unique ID of the configuration block if available. This allows changing the `name`, `icon` and `entity_id` from the web interface. Changing the `entity_id` from the web interface will overwrite the value in `default_entity_id`.
required: false
type: string
variables: