Entity template functions

These template functions let you work with entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] in Home Assistant. Get entity names, check visibility, and look up which integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] or config entry an entity belongs to.

Home Assistant extends the Jinja2 template engine with many custom functions, filters, and tests. Each function on this page has its own page with detailed descriptions, parameters, and practical examples.

New to templates? Start with the templating documentation to learn the basics.

• Get config entry attribute config_entry_attr Gets a specific attribute from a config entry.
• Get config entry ID config_entry_id Gets the config entry ID from an entity ID.
• Get entity name entity_name Gets the friendly name of an entity from its entity ID.
• Get entities for an integration integration_entities Returns a list of entity IDs tied to an integration or config entry.
• Test if entity is hidden is_hidden_entity Tests if an entity is hidden in the entity registry.