Input boolean
The Input boolean helper integration allows you to define boolean values that can be controlled via the user interface and can be used within conditions of an automationAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more]. This can for example be used to disable or enable certain automations by using them in their conditionsConditions are an optional part of an automation that will prevent an action from firing if they are not met. [Learn more].
Configuration
The preferred way to configure input boolean helpers is via the user interface, in which they are known as Toggle Helpers. To add one, go to Settings > Devices & services > Helpers and click the add button; next choose the Toggle option.
To be able to add Helpers via the user interface you should have
default_config:
in your configuration.yaml
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more], it should already be there by
default unless you removed it. If you removed default_config:
from your
configuration, you must add input_boolean:
to your configuration.yaml
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] first,
then you can use the UI.
Input booleans can also be configured via configuration.yaml
The configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file:
Configuration Variables
Alias for the input. Multiple entries are allowed.
Icon to display in front of the input element in the frontend.
# Example configuration.yaml entry
input_boolean:
notify_home:
name: Notify when someone arrives home
icon: mdi:car
Actions
This integration provides the following actionsActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called sequence. [Learn more] to modify the state of the
input_boolean
and an action to reload the configuration without restarting
Home Assistant itself.
Action | Data | Description |
---|---|---|
turn_on |
entity_id(s) area_id(s)
|
Set the value of specific input_boolean entities to on
|
turn_off |
entity_id(s) area_id(s)
|
Set the value of specific input_boolean entities to off
|
toggle |
entity_id(s) area_id(s)
|
Toggle the value of specific input_boolean entities |
reload |
Reload input_boolean configuration |
Restore state
If you set a valid value for initial
this integration will start with the state
set to that value. Otherwise, it will restore the state it had prior to
Home Assistant stopping.
Automation examples
Here’s an example of an automation using the above input_boolean
. This action
will only occur if the input_boolean
is on.
automation:
alias: "Arriving home"
triggers:
- trigger: state
entity_id: binary_sensor.motion_garage
to: "on"
conditions:
- condition: state
entity_id: input_boolean.notify_home
state: "on"
actions:
- action: notify.pushbullet
data:
title: ""
message: "Honey, I'm home!"
You can also set or change the status of an input_boolean
by using
input_boolean.turn_on
, input_boolean.turn_off
or input_boolean.toggle
in
your automation action.
action: input_boolean.turn_on
target:
entity_id: input_boolean.notify_home