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 automationHome Assistant 中的自动化允许您自动响应在家中和周围发生的事情。 [Learn more]. This can for example be used to disable or enable certain automations by using them in their conditions条件是自动化的可选部分,如果不满足条件,将阻止动作触发。 [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.yamlconfiguration.yaml 文件是 Home Assistant 的主要配置文件。它列出了要加载的集成及其特定配置。在某些情况下,需要直接在 configuration.yaml 文件中手动编辑配置。大多数集成可以在 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.yamlconfiguration.yaml 文件是 Home Assistant 的主要配置文件。它列出了要加载的集成及其特定配置。在某些情况下,需要直接在 configuration.yaml 文件中手动编辑配置。大多数集成可以在 UI 中配置。 [Learn more] first, then you can use the UI.

Input booleans can also be configured via configuration.yamlconfiguration.yaml 文件是 Home Assistant 的主要配置文件。它列出了要加载的集成及其特定配置。在某些情况下,需要直接在 configuration.yaml 文件中手动编辑配置。大多数集成可以在 UI 中配置。 [Learn more] file:

Configuration Variables

input_boolean map Required

Alias for the input. Multiple entries are allowed.

name string (Optional)

Friendly name of the input.

initial boolean (Optional)

Initial value when Home Assistant starts.

Default:

a previous value is restored if available

icon icon (Optional)

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 actions动作在 Home Assistant 的多个地方使用。作为脚本或自动化的一部分,动作定义了触发器被激活后将发生的事情。在脚本中,动作被称为序列 [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; if there is no state to restore - an off value is set.

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