Arm alarm with custom bypass

The Arm alarm with custom bypass action arms your alarm control panel while allowing you to bypass specific zones. Think of it as arming the house but leaving the dog door zone active so your pet can come and go, or skipping a sensor on a window you want to keep open for fresh air.

This action works with any alarm control panel 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] in Home Assistant that supports custom bypass. If the alarm is already armed with custom bypass, calling the action does nothing.

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 arm an alarm with custom bypass from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create to start a new one.
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), pick the area your alarm panel is in (like your hallway or entryway). You can also select a floor, a device, a specific entity, or a label.
6. From the actions shown for that target, select Arm alarm with custom bypass.
7. Optional: enter the Code if your alarm panel requires one.
8. Select Save.

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 alarm_control_panel.alarm_arm_custom_bypass. A basic example looks like this:

action: alarm_control_panel.alarm_arm_custom_bypass
target:
  entity_id: alarm_control_panel.home_alarm

This arms alarm_control_panel.home_alarm with custom bypass without a code.

If your alarm panel requires a code, include it in the data section:

action: alarm_control_panel.alarm_arm_custom_bypass
target:
  entity_id: alarm_control_panel.home_alarm
data:
  code: "1234"

Options in YAML

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 alarm_control_panel entity behind that target.

• Entity: one specific alarm_control_panel entity, such as alarm_control_panel.living_room.
• Device: every alarm_control_panel entity that belongs to a device.
• Area: every alarm_control_panel entity in a room or area.
• Floor: every alarm_control_panel entity on a floor.
• Label: every alarm_control_panel 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

• The Arm alarm with custom bypass action works on any alarm control panel 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] in Home Assistant that supports custom bypass.
• Which zones are bypassed depends on your alarm panel’s configuration. The bypass rules are typically set up in the alarm panel itself, not in Home Assistant.
• Whether a code is required depends on your alarm panel and its configuration.
• For full protection without any bypasses, use Arm alarm away or Arm alarm home. To disarm the alarm, use Disarm alarm.

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.

Action: arm with bypass from a dashboard

Set up a quick action on your dashboard to arm the alarm while keeping certain zones open. Useful when you know a window is cracked or the dog door is in use.

• Action: Alarm control panel: Arm alarm with custom bypass
• Target: Home alarm
• Code: 1234

action: alarm_control_panel.alarm_arm_custom_bypass
target:
  entity_id: alarm_control_panel.home_alarm
data:
  code: "1234"

Automation: arm with bypass when a window is left open

If you leave the house and a window is still open, arm the alarm with custom bypass instead of leaving the alarm off entirely. This way, the rest of the house stays protected.

• Trigger: Person: Paulus changes to not_home
• Condition: Window sensor is open
• Action: Alarm control panel: Arm alarm with custom bypass
• Target: Home alarm

alias: "Arm with bypass when window open"
triggers:
  - trigger: state
    entity_id: person.paulus
    to: not_home
conditions:
  - condition: state
    entity_id: binary_sensor.living_room_window
    state: "on"
actions:
  - action: alarm_control_panel.alarm_arm_custom_bypass
    target:
      entity_id: alarm_control_panel.home_alarm
    data:
      code: "1234"

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:

• Disarm alarm: Disarm an alarm control panel. Optionally provide a code if your alarm panel requires one.

• Arm alarm away: Arm an alarm control panel in away mode. Optionally provide a code if your alarm panel requires one.