Turn on input boolean

Use this action to set one or more input booleans to on. An input boolean is a toggle helper you can use in automations and scripts, for example to enable or disable a behavior.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To turn on an input boolean from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. Select what you want to control. Under By target (see Targets), select the input boolean you want to turn on.
6. From the actions shown for that target, select Turn on input boolean.
7. Select Save.

Options in the UI

This action has no additional options in the UI.

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as input_boolean.turn_on. A basic example looks like this:

action: input_boolean.turn_on
target:
  entity_id: input_boolean.guest_mode

This turns on the input_boolean.guest_mode helper.

Targets of the action

This action requires a target. The target is the object of the action. You can point the action at a single entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more], a device, an area, a floor, or a label, and Home Assistant will run the action on every matching input_boolean entity behind that target.

• Entity: one specific input_boolean entity, such as input_boolean.living_room.
• Device: every input_boolean entity that belongs to a device.
• Area: every input_boolean entity in a room or area.
• Floor: every input_boolean entity on a floor.
• Label: every input_boolean entity that shares a label.

You can also select different target types in one action. For example, you can add a specific entity and an area as targets in the same action to run the action on both of them at once.

Good to know

• Use an input boolean as a switch in your automations. For example, turn it on to enable a notification routine and turn it off to pause it.

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup.

Automation: enable guest mode when a guest arrives

Turn on a guest mode helper that other automations check.

• Trigger: A guest’s phone connects to the Wi-Fi
• Action: Turn on input boolean
  • Target: Guest mode

- alias: "Enable guest mode when a guest arrives"
  triggers:
    - trigger: state
      entity_id: device_tracker.guest_phone
      to: "home"
  actions:
    - action: input_boolean.turn_on
      target:
        entity_id: input_boolean.guest_mode

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Related actions

These actions work well alongside this one:

• Turn off input boolean: Turns an input boolean off.

• Toggle input boolean: Toggles an input boolean between on and off.