jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-05-20 09:58:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_integrations/alarm_control_panel.markdown
c0ffeeca7 ee248f20e6
Alarm control panel: add state (#34680) 
* Alarm control panel: add state

* Fix formatting

* Fix typo

* Add related topics
2024-09-11 13:39:18 +02:00

2.4 KiB
Raw Blame History

title, description, ha_category, ha_release, ha_quality_scale, ha_domain, ha_codeowners, ha_integration_type, related
title description ha_category ha_release ha_quality_scale ha_domain ha_codeowners ha_integration_type related
Alarm control panel Instructions on how to integrate Alarm control panels into Home Assistant.
Alarm
0.7.3 internal alarm_control_panel
@home-assistant/core
entity
docs title
/integrations/manual/ Manual alarm
docs title
/integrations/alarm_control_panel.template/ Template alarm

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.

{% include integrations/building_block_integration.md %}

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.

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.