2024.11.0
Home ▸ Integrations ▸

Alarm control panel

Home Assistant can give you an interface which is similar to a classic alarm system. Please see manual alarm or template alarm for alarm configuration.

Note

Building block integration

This alarm control panel is a building block integration that cannot be added to your Home Assistant directly but is used and provided by other integrations.

A building block integration differs from the typical integration that connects to a device or service. Instead, other integrations that do integrate a device or service into Home Assistant use this alarm control panel building block to provide entities, services, and other functionality that you can use in your automations or dashboards.

If one of your integrations features this building block, this page documents the functionality the alarm control panel building block offers.

The state of an alarm panel entity

An alarm panel entity can have the following states. Not all integrations implement all the different states.

  • Disarmed: The alarm is disarmed (off).
  • Armed home: The alarm is armed in home mode.
  • Armed away: The alarm is armed in away mode.
  • Armed night: The alarm is armed in night mode.
  • Armed vacation: The alarm is armed in vacation mode.
  • Armed custom bypass: The alarm is armed in bypass mode.
  • Pending: The alarm is pending (towards triggered).
  • Arming: The alarm is in the process of being armed.
  • Disarming: The alarm is in the process of being disarmed.
  • Triggered: The alarm has been triggered.
  • Unavailable: The entity is currently unavailable.
  • Unknown: The state is not yet known.

Actions

Depending on features supported by a specific integration alarm may expose the following actions:

Action Data Description
alarm_arm_home entity_id
code (optional)		 Arm the alarm in the home mode.
alarm_arm_away entity_id
code (optional)		 Arm the alarm in the away mode.
alarm_arm_night entity_id
code (optional)		 Arm the alarm in the night mode.
alarm_arm_vacation entity_id
code (optional)		 Arm the alarm in the vacation mode.
alarm_disarm entity_id
code (optional)		 Disarm the alarm.
alarm_trigger entity_id
code (optional)		 Trigger the alarm manually.
alarm_arm_custom_bypass entity_id
code (optional)		 Send arm custom bypass command.

Related topics