Input boolean - Spook 👻 a scary powerful toolbox for Home Assistant.

The input boolean helper in Home Assistant is a toggle: on or off, controlled from the frontend or from automations, and usable as a trigger or condition.

Spook adds actions to the input boolean integration to create and delete these helpers from automations and scripts.

Devices & entities¶

Spook does not provide any new devices or entities for this integration.

Actions¶

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

Create an input boolean¶

Creates a new input boolean (toggle) helper, the same as adding one on the helpers page. Great for a script that needs a flag only for itself: it can make one, and delete it again when it is done.

Open your Home Assistant instance and show the Actions tool with a specific action selected.

Action properties
Action	Input boolean: Create an input boolean 👻
Action name	`input_boolean.create`
Action targets	No targets
Action response	Optional, the `entity_id` of the new input boolean
Spook's influence	Newly added action
Tools	Try this action

Action data parameters
Attribute	Type	Required	Default / Example
`name`	string	Yes	`Guest mode`
`input_boolean_id`	string	No	`guest_mode`
`initial`	boolean	No	`false`
`icon`	string	No	`mdi:account-multiple`

Without an input_boolean_id, the entity ID follows the name, as it does in the UI, and gets a number at the end if that name is already taken. With an input_boolean_id, you get exactly that entity ID or an error: one that is already taken is refused, rather than quietly given a number at the end.

Example action in YAML

1
2
3
4
5
6
action: input_boolean.create
data:
  name: "Guest mode"
  input_boolean_id: guest_mode
  initial: false
response_variable: created

The new input boolean’s entity ID is then in {{ created.entity_id }}.

Delete an input boolean¶

Deletes one or more input boolean helpers made in the UI or with the action above, disabled ones included. Input booleans set up in YAML can only be removed from the YAML.

Everything in the list is checked first: if one of them cannot be deleted, none of them are.

Action properties
Action	Input boolean: Delete an input boolean 👻
Action name	`input_boolean.delete`
Action targets	No targets
Action response	No response
Spook's influence	Newly added action
Tools	Try this action

Action data parameters
Attribute	Type	Required	Default / Example
`entity_id`	string \| list of strings	Yes	`input_boolean.guest_mode`

Example action in YAML

1
2
3
action: input_boolean.delete
data:
  entity_id: input_boolean.guest_mode

Repairs¶

Spook has no repair detections for this integration.

Use cases¶

Some use cases for the enhancements Spook provides for this integration:

Let a script make the flag it needs, and clean it up again afterwards, so the helpers page only has toggles you actually use.

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 Support page on where to go for help.