Home AssistantHome AssistantContributors

    ↑↓ to moveEnter to openEsc to close

    Entity ID

    The ID of an entity: its domain and an object ID, like `light.kitchen`.

    In code
    entity_id
    Also
    entity IDs, object ID

    Users see and type entity IDs in automations, templates, and YAML, and they can change them. Code should never depend on an entity ID. To recognize an entity, use its unique ID.

    Related terms

    • EntityOne thing Home Assistant can show, measure, or control, like a light, a temperature sensor, or a switch. Every entity has a state.
    • Unique IDAn ID that an integration gives an entity or config entry, which never changes, so Home Assistant recognizes it after a restart.
    • DomainThe short, unique identifier of an integration, like `hue` or `light`. It is also the first part of every entity ID.