Home AssistantHome AssistantContributors

    ↑↓ to moveEnter to openEsc to close

    Unique ID

    An ID that an integration gives an entity or config entry, which never changes, so Home Assistant recognizes it after a restart.

    In code
    unique_id_attr_unique_id
    Also
    unique IDs

    An entity with a unique ID gets an entry in the entity registry. Only then can users change its name, area, icon, and entity ID in the UI.

    A unique ID comes from something that does not change, like a serial number or a MAC address. Not a name, IP address, or host name: those can change.

    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.
    • RegistryWhere Home Assistant keeps what it knows about entities, devices, areas, floors, and labels, and what users changed about them.
    • Config entryOne set-up instance of an integration, like one Hue bridge, with the configuration Home Assistant stores for it.
    • Entity IDThe ID of an entity: its domain and an object ID, like `light.kitchen`.