Set Entity

Update entity properties in the entity registry.

Allows modifying entity metadata such as area assignment, display name, icon, "Show As" device class override, per-domain registry options, enabled/disabled state, visibility, aliases, labels, voice assistant exposure, and entity_id rename in a single call.

BULK OPERATIONS: When entity_id is a list, only labels, expose_to, and categories parameters are supported. Other parameters (area_id, name, icon, device_class, options, enabled, hidden, aliases, new_entity_id, new_device_name) require single entity.

LABEL OPERATIONS:

• label_operation="set" (default): Replace all labels with the provided list. Use [] to clear.

• label_operation="add": Add labels to existing ones without removing any.

• label_operation="remove": Remove specified labels from the entity.

SHOW AS / DEVICE CLASS: device_class overrides the entity's display device class — equivalent to the HA UI's "Show As" dropdown. Use empty string '' to clear. Applies instantly, no reload needed.

REGISTRY OPTIONS: options carries per-domain registry options (sensor display_precision, weather forecast_type, etc). Pass {domain: {key: value}}; multi-domain dicts are sent as separate registry updates because HA's WS schema requires options_domain + options to be paired one domain at a time.

ENTITY ID RENAME: Use new_entity_id to change an entity's ID (e.g., sensor.old -> sensor.new). Domain must match. Voice exposure settings are preserved automatically.

WARNING: Renaming an entity_id does NOT update references in automations, scripts, templates, or dashboards. All consumers of the old entity_id must be updated manually — HA does not propagate the rename automatically.

Rename limitations:

• Entity history is preserved (HA 2022.4+)

• Entities without unique IDs cannot be renamed

• Entities disabled by their integration cannot be renamed

DEVICE RENAME: Use new_device_name to rename the associated device. Can be combined with new_entity_id to rename both in one call. The device is looked up automatically.

Use ha_search() or ha_get_device() to find entity IDs. Use ha_config_get_label() to find available label IDs.

EXAMPLES: Single entity:

• Assign to area: ha_set_entity("sensor.temp", area_id="living_room")

• Rename display name: ha_set_entity("sensor.temp", name="Living Room Temperature")

• Set Show As: ha_set_entity("binary_sensor.zone_10", device_class="window")

• Clear Show As: ha_set_entity("binary_sensor.zone_10", device_class="")

• Set sensor precision: ha_set_entity("sensor.power", options={"sensor": {"display_precision": 2}})

• Rename entity_id: ha_set_entity("light.old_name", new_entity_id="light.new_name")

• Rename entity and device: ha_set_entity("light.old", new_entity_id="light.new", new_device_name="New Lamp")

• Rename entity_id with friendly name: ha_set_entity("sensor.old", new_entity_id="sensor.new", name="New Name")

• Set labels: ha_set_entity("light.lamp", labels=["outdoor", "smart"])

• Add labels: ha_set_entity("light.lamp", labels=["new_label"], label_operation="add")

• Remove labels: ha_set_entity("light.lamp", labels=["old_label"], label_operation="remove")

• Clear labels: ha_set_entity("light.lamp", labels=[])

• Expose to Alexa: ha_set_entity("light.lamp", expose_to={"cloud.alexa": True})

Bulk operations:

• Set labels on multiple: ha_set_entity(["light.a", "light.b"], labels=["outdoor"])

• Add labels to multiple: ha_set_entity(["light.a", "light.b"], labels=["new"], label_operation="add")

• Expose multiple to Alexa: ha_set_entity(["light.a", "light.b"], expose_to={"cloud.alexa": True})

ENABLED/DISABLED WARNING: Setting enabled=False performs a registry-level disable — the entity is completely removed from the Home Assistant state machine and hidden from the UI. It will NOT appear in state queries, dashboards, or automations until re-enabled AND the integration is reloaded. This is NOT the same as "turning off" an entity.

For automations and scripts, enabled=False is blocked. Use these instead:

• ha_call_service("automation", "turn_off", entity_id="automation.xxx")

• ha_call_service("script", "turn_off", entity_id="script.xxx")