home-assistant.io/source/_components/alarm_control_panel.ifttt.markdown
Fabian Affolter d42f6dfacf
Some fixes (#5091)
* Some fixes (missing logo and links)

* Add header
2018-04-02 22:57:57 +02:00

4.7 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 IFTTT Alarm Control Panel Instructions on how to integrate IFTTT-controlled security systems into Home Assistant. 2018-03-10 21:00 true false true true ifttt.png Alarm 0.66

The ifttt platform allows you to integrate security systems that have no open API but can be controlled through IFTTT.

This platform depends on the IFTTT Home Assistant component. See the component's documentation to set it up.

It is important to note that this platform fully relies on IFTTT to receive updates when the security system's state changes. Therefore, this platform shows an assumed state.

To enable this, setup the required IFTTT applets as listed below and add the following lines to your configuration.yaml file:

# Example configuration.yaml entry
ifttt:
  key: YOUR_WEBHOOK_KEY
  
alarm_control_panel:
  - platform: ifttt
    name: YOUR_ALARM_NAME
    code: YOUR_ALARM_CODE
    event_arm_away: YOUR_ARM_AWAY_EVENT
    event_arm_home: YOUR_ARM_HOME_EVENT
    event_arm_night: YOUR_ARM_NIGHT_EVENT
    event_disarm: YOUR_DISARM_EVENT

It is strongly discouraged to use this platform when you don't use encryption; otherwise, your API password will be send unprotected through the IFTTT Webhooks. It is adviced to [setup encryption using Let's Encrypt](https://home-assistant.io/blog/2017/09/27/effortless-encryption-with-lets-encrypt-and-duckdns/).

{% linkable_title Required IFTTT applets %}

This platform supports the services alarm_disarm, alarm_arm_away, alarm_arm_home and alarm_arm_night. For each of these services, an IFTTT webhook will be triggered.

For this system to operate correctly, the following IFTTT applets have to be setup. Obviously, if your alarm device does not support some states, no applets have to be provided for those.

  • IF Webhook event YOUR_DISARM_EVENT is called, THEN disarm the alarm system.
  • IF Webhook event YOUR_ARM_HOME_EVENT is called, THEN set the alarm system to armed home.
  • IF Webhook event YOUR_ARM_NIGHT_EVENT is called, THEN set the alarm system to armed away.
  • IF Webhook event YOUR_DISARM_EVENT is called, THEN set the alarm system to armed night.
  • IF the alarm system was disarmed, THEN perform a Webhook POST web request to url https://HASS_URL/api/services/alarm_control_panel/ifttt_push_alarm_state?api_password=API_PASSWORD with content type application/json and body {"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "disarmed"}.
  • IF the alarm system state changed to armed home, THEN perform a Webhook POST web request to url https://HASS_URL/api/services/alarm_control_panel/ifttt_push_alarm_state?api_password=API_PASSWORD with content type application/json and body {"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_home"}.
  • IF the alarm system state changed to armed away, THEN perform a Webhook POST web request to url https://HASS_URL/api/services/alarm_control_panel/ifttt_push_alarm_state?api_password=API_PASSWORD with content type application/json and body {"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_away"}.
  • IF the alarm system state changed to armed night, THEN perform a Webhook POST web request to url https://HASS_URL/api/services/alarm_control_panel/ifttt_push_alarm_state?api_password=API_PASSWORD with content type application/json and body {"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_night"}.

{% configuration %} name: description: The name of your Home Assistant alarm control panel. required: false type: string code: description: The code for the alarm control panel. required: false type: string event_arm_away: description: IFTTT webhook event to call when the state is set to armed away. required: false type: string default: alarm_arm_away event_arm_home: description: IFTTT webhook event to call when the state is set to armed home. required: false type: string default: alarm_arm_home event_arm_night: description: IFTTT webhook event to call when the state is set to armed night. required: false type: string default: alarm_arm_night event_disarm: description: IFTTT webhook event to call when the state is set to disarmed. required: false type: string default: alarm_disarm optimistic: description: Specify if the state will be updated by a ifttt_push_alarm_state call (false) or can be set immediately (true). required: false type: boolean default: false {% endconfiguration %}