Category management

Categories in Home Assistant let you sort your automations, scripts, scenes, and helpers into groups on their own pages in the user interface. Each of those pages has its own set of categories, and something can be in one category per page.

Spook adds actions to manage categories, and to put things in them, from your own automations and scripts. Great for filing new automations away automatically, or for tidying up in bulk.

Actions¶

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

Create a category¶

Adds a new category to your Home Assistant instance. The scope says which page it is for: automation, script, scene, or helpers.

The action responds with the ID of the new category, in case you want to use it right away.

1
2
3
4
5
6
action: homeassistant.create_category
data:
  scope: automation
  name: Lighting
  icon: mdi:lightbulb
response_variable: category

Update a category¶

Updates an existing category. Anything you leave out keeps the value it already has. Setting icon to null clears it.

1
2
3
4
5
action: homeassistant.update_category
data:
  scope: automation
  category_id: Lighting
  name: Lights

Delete a category¶

Deletes a category. Everything that was in it is left without a category on that page.

1
2
3
4
action: homeassistant.delete_category
data:
  scope: automation
  category_id: Lighting

Add a category to an entity¶

Puts one or more automations, scripts, scenes, or helpers in a category. Which page the category belongs to follows from the entity: an automation gets an automation category, a script a script category, and so on. Anything else counts as a helper.

Since something can only be in one category per page, this replaces the category it was in before.

1
2
3
4
5
6
action: homeassistant.add_category_to_entity
data:
  category_id: Lighting
  entity_id:
    - automation.porch_lights
    - automation.garden_lights

Remove a category from an entity¶

Takes one or more automations, scripts, scenes, or helpers out of a category. Anything that is in a different category is left alone.

1
2
3
4
action: homeassistant.remove_category_from_entity
data:
  category_id: Lighting
  entity_id: automation.porch_lights

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.

Feature 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.