Entities in Home Assistant are the building blocks of your home automation. Spook enhances the core of Home Assistant by adding services to control those entities programmatically.
Services¶
The following entity management services are added to your Home Assistant instance:
Disable an entity¶
This service allows you to disable an entity on the fly.
Service properties | |
---|---|
Service | Disable an entity 👻 |
Service name | homeassistant.disable_entity |
Service targets | No |
Service response | No response |
Spook's influence | Newly added service. |
Developer tools | Try this service |
Service call data | |||
---|---|---|---|
Attribute | Type | Required | Default / Example |
entity_id | string | list of strings | Yes | "light.living_room" |
Example service call in YAML
1 2 3
service: homeassistant.disable_entity data: entity_id: light.living_room
Or multiple entities at once:
1 2 3 4 5
service: homeassistant.disable_entity data: entity_id: - light.living_room - light.kitchen_ceiling
Enable an entity¶
This service allows you to enable an entity on the fly.
Service properties | |
---|---|
Service | Enable an entity 👻 |
Service name | homeassistant.enable_entity |
Service targets | No |
Service response | No response |
Spook's influence | Newly added service. |
Developer tools | Try this service |
Service call data | |||
---|---|---|---|
Attribute | Type | Required | Default / Example |
entity_id | string | list of strings | Yes | "light.living_room" |
Example service call in YAML
1 2 3
service: homeassistant.enable_entity data: entity_id: light.living_room
Or multiple entities at once:
1 2 3 4 5
service: homeassistant.enable_entity data: entity_id: - light.living_room - light.kitchen_ceiling
Hide an entity¶
This service allows you to hide an entity on the fly.
It can be particularly useful when you have a lot of entities, and you want to hide some of them from the generated UI based programmatically. Hidden entities are also not exposed to external voice assistants, like Google Assistant or Alexa.
Service properties | |
---|---|
Service | Hide an entity 👻 |
Service name | homeassistant.hide_entity |
Service targets | No |
Service response | No response |
Spook's influence | Newly added service. |
Developer tools | Try this service |
Service call data | |||
---|---|---|---|
Attribute | Type | Required | Default / Example |
entity_id | string | list of strings | Yes | "light.living_room" |
Example service call in YAML
1 2 3
service: homeassistant.hide_entity data: entity_id: light.living_room
Or multiple entities at once:
1 2 3 4 5
service: homeassistant.hide_entity data: entity_id: - light.living_room - light.kitchen_ceiling
Unhide an entity¶
This service allows you to unhide an entity on the fly.
Service properties | |
---|---|
Service | Unide an entity 👻 |
Service name | homeassistant.unhide_entity |
Service targets | No |
Service response | No response |
Spook's influence | Newly added service. |
Developer tools | Try this service |
Service call data | |||
---|---|---|---|
Attribute | Type | Required | Default / Example |
entity_id | string | list of strings | Yes | "light.living_room" |
Example service call in YAML
1 2 3
service: homeassistant.unhide_entity data: entity_id: light.living_room
Or multiple entities at once:
1 2 3 4 5
service: homeassistant.unhide_entity data: entity_id: - light.living_room - light.kitchen_ceiling
Update an entity’s ID¶
This service allows you to update an entity’s ID on the fly.
Service properties | |
---|---|
Service | Update an entity’s ID 👻 |
Service name | homeassistant.update_entity_id |
Service targets | No |
Service response | No response |
Spook's influence | Newly added service. |
Developer tools | Try this service |
Service call data | |||
---|---|---|---|
Attribute | Type | Required | Default / Example |
entity_id | string | Yes | "light.living_room" |
new_entity_id | string | Yes | "light.dining_room" |
Example service call in YAML
1 2 3 4
service: homeassistant.update_entity_id data: entity_id: light.living_room new_entity_id: light.dining_room
Delete all orphaned entities¶
Mass clean up your Home Assistant by deleting all orphaned entities in one go.
Orphaned entities are entities that are no longer claimed by an integration. This can happen when an integration is removed or when an integration is no longer working. Home Assistant considers an entity only orphaned if it has been unclaimed since the last restart of Home Assistant.
Service properties | |
---|---|
Service | Delete all orphaned entities 👻 |
Service name | homeassistant.delete_all_orphaned_entities |
Service targets | No |
Service response | No response |
Spook's influence | Newly added service. |
Developer tools | Try this service |
Example service call in YAML
1
service: homeassistant.delete_all_orphaned_entities
Blueprints & tutorials¶
There are currently no known blueprints or tutorials for the enhancements Spook provides for these features. 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, 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.