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 service calls in for example automations, or scripts.

Spook provides services 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 service tools, listing the new services to manage labels.

Services

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

Create a label

Adds a new label to your Home Assistant instance.

Screenshot of the create label service call in the developer tools.
Service properties
ServiceCreate an label 👻
Service namehomeassistant.create_label
Service targetsNo
Service responseNo response
Spook's influenceNewly added service
Developer toolsTry this service Open your Home Assistant instance and show your service developer tools with a specific service selected.
Service call data
AttributeTypeRequiredDefault / Example
namestringYesBattery powered
descriptionstringNoLabel to tag all battery powered devices
iconstringNomdi:battery
colorstringNoindigo

Delete a label

Delete a new label to your Home Assistant instance.

Screenshot of the delete label service call in the developer tools.
Service properties
ServiceDelete a label 👻
Service namehomeassistant.delete_label
Service targetsNo
Service responseNo response
Spook's influenceNewly added service
Developer toolsTry this service Open your Home Assistant instance and show your service developer tools with a specific service selected.
Service call data
AttributeTypeRequiredDefault / Example
label_idstringYesbattery_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 service call in the developer tools.
Service properties
ServiceAdd a label to an area 👻
Service namehomeassistant.add_label_to_area
Service targetsNo
Service responseNo response
Spook's influenceNewly added service
Developer toolsTry this service Open your Home Assistant instance and show your service developer tools with a specific service selected.
Service call data
AttributeTypeRequiredDefault / Example
label_idstring | list of stringsYesliving_space
area_idstring | list of stringsYesliving_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 service call in the developer tools.
Service properties
ServiceRemove a label from an area 👻
Service namehomeassistant.remove_label_from_area
Service targetsNo
Service responseNo response
Spook's influenceNewly added service
Developer toolsTry this service Open your Home Assistant instance and show your service developer tools with a specific service selected.
Service call data
AttributeTypeRequiredDefault / Example
label_idstring | list of stringsYesliving_space
area_idstring | list of stringsYesliving_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 service call in the developer tools.
Service properties
ServiceAdd a label to a device 👻
Service namehomeassistant.add_label_to_device
Service targetsNo
Service responseNo response
Spook's influenceNewly added service
Developer toolsTry this service Open your Home Assistant instance and show your service developer tools with a specific service selected.
Service call data
AttributeTypeRequiredDefault / Example
label_idstring | list of stringsYesbattery_powered
device_idstring | list of stringsYesdc23e666e6100f184e642a0ac345d3eb

Remove a label from a device

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

Screenshot of the remove a label from a device service call in the developer tools.
Service properties
ServiceRemove a label from a device 👻
Service namehomeassistant.remove_label_from_device
Service targetsNo
Service responseNo response
Spook's influenceNewly added service
Developer toolsTry this service Open your Home Assistant instance and show your service developer tools with a specific service selected.
Service call data
AttributeTypeRequiredDefault / Example
label_idstring | list of stringsYesbattery_powered
device_idstring | list of stringsYesdc23e666e6100f184e642a0ac345d3eb

Add a label to an entity

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

Screenshot of the add a label to an entity service call in the developer tools.
Service properties
ServiceAdd a label to an entity 👻
Service namehomeassistant.add_label_to_entity
Service targetsNo
Service responseNo response
Spook's influenceNewly added service
Developer toolsTry this service Open your Home Assistant instance and show your service developer tools with a specific service selected.
Service call data
AttributeTypeRequiredDefault / Example
label_idstring | list of stringsYesbattery_powered
entity_idstring | list of stringsYessensor.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 service call in the developer tools.
Service properties
ServiceRemove a label from an entity 👻
Service namehomeassistant.remove_label_from_entity
Service targetsNo
Service responseNo response
Spook's influenceNewly added service
Developer toolsTry this service Open your Home Assistant instance and show your service developer tools with a specific service selected.
Service call data
AttributeTypeRequiredDefault / Example
label_idstring | list of stringsYesbattery_powered
entity_idstring | list of stringsYessensor.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 service, 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.