home-assistant.io/source/_components/alarm_control_panel.manual.markdown
Phill Price a8814bceb1
Manual Alarm Panel arming options (#3445)
* Manual Alarm Panel arming options

Coming out on the site as very strangely styled, currently.

Not sure if this fixes as not sure how to test, willing to do so if there are docs anywhere to show me.

* Update alarm_control_panel.manual.markdown
2017-10-21 09:56:30 +02:00

2.3 KiB

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release
layout title description date sidebar comments sharing footer logo ha_category ha_release
page Manual Alarm Control Panel Instructions how to integrate manual alarms into Home Assistant. 2015-10-13 19:10 true false true true home-assistant.png Alarm 0.7.6

This platform enables you to set manual alarms in Home Assistant.

# Example configuration.yaml entry
alarm_control_panel:
  - platform: manual

Configuration variables:

  • name (Optional): The name of the alarm. Default is "HA Alarm".
  • code (Optional): If defined, specifies a code to enable or disable the alarm in the frontend.
  • pending_time (Optional): The time in seconds of the pending time before arming the alarm. Default is 60 seconds.
  • trigger_time (Optional): The time in seconds of the trigger time in which the alarm is firing. Default is 120 seconds.
  • disarm_after_trigger (Optional): If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state.
  • armed_home/armed_away/armed_night/triggered (Optional): State specific settings
    • pending_time: State specific pending time override.

In the config example below, armed_home state will have no pending time and triggered state will have pending time of 20 second whereas armed_away state will have a default pending time of 30 seconds.

# Example configuration.yaml entry
alarm_control_panel:
  - platform: manual
    name: Home Alarm
    code: 1234
    pending_time: 30
    armed_home:
      pending_time: 0
    triggered:
      pending_time: 20
    trigger_time: 4 

{% linkable_title Examples %}

In this section, you find some real-life examples of how to use this panel.

{% linkable_title Sensors %}

Using sensors to trigger the alarm.

automation:
- alias: 'Trigger alarm while armed away'
  trigger:
    - platform: state
      entity_id: sensor.pir1
      to: 'active'
    - platform: state
      entity_id: sensor.pir2
      to: 'active'
    - platform: state
      entity_id: sensor.door
      to: 'open'
    - platform: state
      entity_id: sensor.window
      to: 'open'
  condition:
    - condition: state
      entity_id: alarm_control_panel.ha_alarm
      state: armed_away
  action:
    service: alarm_control_panel.alarm_trigger
    entity_id: alarm_control_panel.ha_alarm