Skip to article frontmatterSkip to article content
Core extensions

Label management

If you liked it then you should have put a label on it 🏷️

Labels in Home Assistant can be freely created / be made up by you and used to create your own organizational structure by tagging devices, entities, or areas with one or more labels. Labels can be used to filter items shows in tables in the user interface, or to target actions in for example automations, or scripts.

Spook provides that allows you to manage and automate the areas in Home Assistant programatically. Great for creating “dynamic” labels, or for creating labels on the fly.

Screenshot of the developer actions tools, listing the new actions to manage labels.

Actions

Spook adds the following new actions to your Home Assistant instance:

Create a label

Adds a new label to your Home Assistant instance.

Screenshot of the create label action in the developer tools.

Action properties

Action

Create an label 👻

Action name

homeassistant.create_label

Action targets

No

Action response

No response

Spook's influence

Newly added action

Developer tools

Try this action Open your Home Assistant instance and show your actions developer tools with a specific action selected.

Action data parameters

Attribute

Type

Required

Default / Example

name

string

Yes

Battery powered

description

string

No

Label to tag all battery powered devices

icon

string

No

mdi:battery

color

string

No

indigo

Delete a label

Delete a new label to your Home Assistant instance.

Screenshot of the delete label action in the developer tools.

Action properties

Action

Delete a label 👻

Action name

homeassistant.delete_label

Action targets

No

Action response

No response

Spook's influence

Newly added action

Developer tools

Try this action Open your Home Assistant instance and show your actions developer tools with a specific action selected.

Action data parameters

Attribute

Type

Required

Default / Example

label_id

string

Yes

battery_powered

Add a label to an area

Adds one or more labels(s) to an area.

Screenshot of the add a label to an area action in the developer tools.

Action properties

Action

Add a label to an area 👻

Action name

homeassistant.add_label_to_area

Action targets

No

Action response

No response

Spook's influence

Newly added action

Developer tools

Try this action Open your Home Assistant instance and show your actions developer tools with a specific action selected.

Action data parameters

Attribute

Type

Required

Default / Example

label_id

string | list of strings

Yes

living_space

area_id

string | list of strings

Yes

living_room

Remove a label from an area

Removes one or more label(s) from an area.

Screenshot of the remove a label from an area action in the developer tools.

Action properties

Action

Remove a label from an area 👻

Action name

homeassistant.remove_label_from_area

Action targets

No

Action response

No response

Spook's influence

Newly added action

Developer tools

Try this action Open your Home Assistant instance and show your actions developer tools with a specific action selected.

Action data parameters

Attribute

Type

Required

Default / Example

label_id

string | list of strings

Yes

living_space

area_id

string | list of strings

Yes

living_room

Add a label to a device

Adds one or more labels(s) to a device.

Screenshot of the add a label to a device action in the developer tools.

Action properties

Action

Add a label to a device 👻

Action name

homeassistant.add_label_to_device

Action targets

No

Action response

No response

Spook's influence

Newly added action

Developer tools

Try this action Open your Home Assistant instance and show your actions developer tools with a specific action selected.

Action data parameters

Attribute

Type

Required

Default / Example

label_id

string | list of strings

Yes

battery_powered

device_id

string | list of strings

Yes

dc23e666e6100f184e642a0ac345d3eb

Remove a label from a device

Removes one or more label(s) from a device.

Screenshot of the remove a label from a device action in the developer tools.

Action properties

Action

Remove a label from a device 👻

Action name

homeassistant.remove_label_from_device

Action targets

No

Action response

No response

Spook's influence

Newly added action

Developer tools

Try this action Open your Home Assistant instance and show your actions developer tools with a specific action selected.

Action data parameters

Attribute

Type

Required

Default / Example

label_id

string | list of strings

Yes

battery_powered

device_id

string | list of strings

Yes

dc23e666e6100f184e642a0ac345d3eb

Add a label to an entity

Adds one or more labels(s) to an entity.

Screenshot of the add a label to an entity action in the developer tools.

Action properties

Action

Add a label to an entity 👻

Action name

homeassistant.add_label_to_entity

Action targets

No

Action response

No response

Spook's influence

Newly added action

Developer tools

Try this action Open your Home Assistant instance and show your actions developer tools with a specific action selected.

Action data parameters

Attribute

Type

Required

Default / Example

label_id

string | list of strings

Yes

battery_powered

entity_id

string | list of strings

Yes

sensor.outside_temperature

Remove a label from an entity

Removes one or more label(s) from an entity.

Screenshot of the remove a label from an entity action in the developer tools.

Action properties

Action

Remove a label from an entity 👻

Action name

homeassistant.remove_label_from_entity

Action targets

No

Action response

No response

Spook's influence

Newly added action

Developer tools

Try this action Open your Home Assistant instance and show your actions developer tools with a specific action selected.

Action data parameters

Attribute

Type

Required

Default / Example

label_id

string | list of strings

Yes

battery_powered

entity_id

string | list of strings

Yes

sensor.outside_temperature

Blueprints & tutorials

There are currently no known blueprints or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, please let us know in our discussion forums.

Features requests, ideas, and support

If you have an idea on how to further enhance this integration, for example, by adding a new action, entity, or repairs detection; feel free to let us know in our discussion forums.

Are you stuck using these new features? Or maybe you’ve run into a bug? Please check the page on where to go for help.