Floors management

Floors in Home Assistant is a logical grouping of areas that are meant to match floors (or levels) in the physical world: your home. Floors are used to group areas together that are on the same floor in your home. Floors give a better overview of your home and can be used to target actions to a specific floor, like turning off all the lights on the first floor.

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

Actions¶

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

Create a floor¶

Adds a new floor to your Home Assistant instance.

Action properties
Action	Create a floor 👻
Action name	homeassistant.create_floor
Action targets	No
Action response	No response
Spook's influence	Newly added action
Developer tools	Try this action

The use of aliases is helpful if you want to create an floor with multiple names. For example, if you want to create an floor called “First floor”, but also want to be able to refer to it as “Ground floor” or “Downstairs”, you can add those names as aliases. This is used by Home Assistant Assist.

1
2
3
4
5
6
7
8
action: homeassistant.create_floor
data:
  name: "First floor"
  icon: "mdi:floor-1"
  level: 1
  aliases:
    - "Ground floor"
    - "Downstairs"

Delete a floor¶

Delete a floor from your Home Assistant instance.

Action properties
Action	Delete a floor 👻
Action name	homeassistant.delete_floor
Action targets	No
Action response	No response
Spook's influence	Newly added action
Developer tools	Try this action

floor_id: "{{ floor_id('First floor') }}"

1
2
3
action: homeassistant.delete_floor
data:
  floor_id: "first_floor"

1
2
3
action: homeassistant.delete_floor
data:
  floor_id: "{{ floor_id('First floor') }}"

Add an alias to a floor¶

Adds one or more aliases to an existing floor. This action does not remove existing aliases, but adds the new ones to the existing ones.

As floor aliases are used by voice assistants, you could add (and also remove) aliases to a floor using automations, which allows you to make them available/unavailable programatically.

Action properties
Action	Add an alias to a floor 👻
Action name	homeassistant.add_alias_to_floor
Action targets	No
Action response	No response
Spook's influence	Newly added action
Developer tools	Try this action

floor_id: "{{ floor_id('First floor') }}"

1
2
3
4
5
6
action: homeassistant.add_alias_to_floor
data:
  floor_id: "first_floor"
  aliases:
    - "Ground floor"
    - "Downstairs"

1
2
3
4
5
6
action: homeassistant.add_alias_to_floor
data:
  floor_id: "{{ floor_id('First floor') }}"
  aliases:
    - "Ground floor"
    - "Downstairs"

Remove an alias from a floor¶

Removes one or more aliases from an existing floor. This action will leave the other aliases intact.

As floor aliases are used by voice assistants, you could remove (and also add) aliases to a floor using automations, which allows you to make them available/unavailable programatically.

Action properties
Action	Add an alias to a floor 👻
Action name	homeassistant.remove_alias_from_floor
Action targets	No
Action response	No response
Spook's influence	Newly added action
Developer tools	Try this action

floor_id: "{{ floor_id('First floor') }}"

1
2
3
4
5
6
action: homeassistant.remove_alias_from_floor
data:
  floor_id: "first_floor"
  aliases:
    - "Ground floor"
    - "Downstairs"

1
2
3
4
5
6
action: homeassistant.remove_alias_from_floor
data:
  floor_id: "{{ floor_id('First floor') }}"
  aliases:
    - "Ground floor"
    - "Downstairs"

Set aliases for a floor¶

Sets the aliases for a floor. This action will overwrite/remove all existing aliases.

As floor aliases are used by voice assistants, you could remove (and also add) aliases to a floor using automations, which allows you to make them available/unavailable programatically.

Action properties
Action	Sets aliases for a floor 👻
Action name	homeassistant.set_floor_aliases
Action targets	No
Action response	No response
Spook's influence	Newly added action
Developer tools	Try this action

floor_id: "{{ floor_id('First floor') }}"

1
2
3
4
5
6
action: homeassistant.set_floor_aliases
data:
  floor_id: "first_floor"
  aliases:
    - "Ground floor"
    - "Downstairs"

1
2
3
4
5
6
action: homeassistant.set_floor_aliases
data:
  floor_id: "{{ floor_id('First floor') }}"
  aliases:
    - "Ground floor"
    - "Downstairs"

Add an area to a floor¶

Adds one or more area(s) to a floor. This action will leave the other areas on the floor untouched.

Action properties
Action	Add an area to a floor 👻
Action name	homeassistant.add_area_to_floor
Action targets	No
Action response	No response
Spook's influence	Newly added action
Developer tools	Try this action

floor_id: "{{ floor_id('First floor') }}"

area_id: "{{ area_id('Living room') }}"

1
2
3
4
action: homeassistant.add_area_to_floor
data:
  floor_id: "first_floor"
  area_id: "living_room"

1
2
3
4
action: homeassistant.add_area_to_floor
data:
  floor_id: "{{ floor_id('First floor') }}"
  area_id: "{{ area_id('Living room') }}"

1
2
3
4
5
6
action: homeassistant.add_area_to_floor
data:
  floor_id: "first_floor"
  area_id:
    - "living_room"
    - "kitchen"

Remove an area from a floor¶

Removes one or more area(s) from a floor. This action will leave the other area on the floor untouched.

Action properties
Action	Remove an area from a floor 👻
Action name	homeassistant.remove_area_from_floor
Action targets	No
Action response	No response
Spook's influence	Newly added action
Developer tools	Try this action

area_id: "{{ area_id('Living room') }}"

1
2
3
action: homeassistant.remove_area_from_floor
data:
  area_id: "living_room"

1
2
3
4
5
action: homeassistant.remove_area_from_floor
data:
  area_id:
    - "living_room"
    - "kitchen"

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.