Support for security systems controlled by IFTTT #12975

maxclaey · 2018-03-07T20:54:57Z

Description:

Added support for security systems that have no open API but can be controlled via IFTTT (e.g. piper, ismartalarm, ...). To set the security system to a specific state, a webhook call is made to change the device state. Furthermore, applets have to be made to call home assistant's REST API when the device's state has changed.

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#4878

Example entry for `configuration.yaml` (if applicable):

ifttt:
  key: !secret webhook_key

alarm_control_panel:
  - platform: ifttt
    name: "IFTTT Alarm"
    code: !secret alarm_code

Checklist:

The code change is tested and works locally.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
New dependencies have been added to the REQUIREMENTS variable ([example][ex-requir]).
New dependencies are only imported inside functions that use them ([example][ex-import]).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

houndci-bot · 2018-03-07T20:55:06Z

homeassistant/components/alarm_control_panel/ifttt.py

+    def alarm_arm_night(self, code=None):
+        """Send arm night command."""
+        if not self._check_code(code)
+            return


unexpected indentation

houndci-bot · 2018-03-07T20:55:06Z

homeassistant/components/alarm_control_panel/ifttt.py

+    def alarm_arm_home(self, code=None):
+        """Send arm home command."""
+        if not self._check_code(code)
+            return


unexpected indentation

houndci-bot · 2018-03-07T20:55:06Z

homeassistant/components/alarm_control_panel/ifttt.py

+    def alarm_arm_away(self, code=None):
+        """Send arm away command."""
+        if not self._check_code(code)
+            return


unexpected indentation

houndci-bot · 2018-03-07T20:55:06Z

homeassistant/components/alarm_control_panel/ifttt.py

+    def alarm_disarm(self, code=None):
+        """Send disarm command."""
+        if not self._check_code(code)
+            return


unexpected indentation

houndci-bot · 2018-03-07T20:55:06Z

homeassistant/components/alarm_control_panel/ifttt.py

+
+    def alarm_disarm(self, code=None):
+        """Send disarm command."""
+        if not self._check_code(code)


SyntaxError: invalid syntax

maxclaey · 2018-03-08T19:00:11Z

I will add a documentation page on home-assistant.github.io to explain the required ifttt webhook setup when the pull request gets approved. Thanks in advance for reviewing!

c727 · 2018-03-08T19:35:26Z

If this gets merged there should be a warning in the docs that this shows an assumed state and not the real device state

maxclaey · 2018-03-08T19:38:52Z

Yes, for sure. But that's unavoidable if IFTTT is the only way to interact with the device off course :)

arsaboo · 2018-03-08T20:09:50Z

Super excited about this one. For a future PR, we should also think about including other platforms. For example, we could use binary sensors for door/window status.

balloob · 2018-03-10T18:25:06Z

homeassistant/components/alarm_control_panel/ifttt.py

+    CONF_NAME, CONF_CODE)
+import homeassistant.helpers.config_validation as cv
+
+REQUIREMENTS = ['requests==2.18.4', 'pyfttt==0.3']


Do not add requests. It's already a core dependency of Home Assistant. Also move the requests import to the top of the file.

Actually, thinking of it. This platform should depend on the ifttt component instead of asking for the key itself. The ifttt component should be added via DEPENDENCIES and should share the key via hass.data[DOMAIN]

ifttt component already requires the key. You can use DEPENDENCIES = ['ifttt'] to use the IFTTT component as a dependency and not require the user to enter the key again here. There are several components that do that, e.g., Arlo, Abode.

Thanks for the suggestions! It made me realize I don't even need the key. When I have the ifttt component as a dependency, I can just call the component's trigger service

Exactly...that is the point 👍

balloob · 2018-03-10T18:25:38Z

homeassistant/components/alarm_control_panel/ifttt.py

+
+        try:
+            # Translate the state to a service/event name
+            event = STATE_TO_SERVICE[state]


Either call it event or service, please don't mix 'n match.

Actually, stick with event since the method to sent it to IFTTT is called send_event

balloob · 2018-03-10T18:26:50Z

homeassistant/components/alarm_control_panel/ifttt.py

+DEFAULT_NAME = "Home"
+
+STATE_TO_SERVICE = {
+    STATE_ALARM_ARMED_AWAY: SERVICE_ALARM_ARM_AWAY,


You should not use the service names from Home Assistant. There is no guarantee that they will remain the same. Instead I suggest you create your own constants (named could be the same)

balloob · 2018-03-10T18:27:17Z

homeassistant/components/alarm_control_panel/ifttt.py

+CONF_WEBHOOK_KEY = "webhook_key"
+DEFAULT_NAME = "Home"
+
+STATE_TO_SERVICE = {


Why have this constant instead of the methods like alarm_arm_night just pass in the right constant directly?

balloob · 2018-03-10T18:28:55Z

Please add the assumed_state property and have it return True

balloob · 2018-03-10T18:29:31Z

homeassistant/components/alarm_control_panel/ifttt.py

+    code = config.get(CONF_CODE)
+
+    alarmpanel = IFTTTAlarmPanel(name, webhook_key, code)
+    add_devices([alarmpanel], True)


There is no update method so no need to add True. Please remove

balloob · 2018-03-10T18:30:21Z

Make sure to write extensive docs as to how to configure IFTTT.

arsaboo · 2018-03-11T18:54:23Z

Ok...so, I have been testing this for 24 hours and there is some issue. The alarm_control_panel goes right back to disarmed after changing the state. Basically, the alarm_control_panel does not reflect the current state. See the logbook entries:

(btw...I am not sure why the case of the entity changes in the logbook).

Also, not sure if it matters, but I have the regular Abode integration as well, which is entirely separate from the IFTTT Abode.

maxclaey · 2018-03-11T20:16:30Z

Apparently, when you call the REST api to set the state of the entity, it is not reflected to the state property. Could someone tell me how to make sure that some kind of setter is called on the entity when the API is used to set the state?

balloob · 2018-03-11T21:40:41Z

That won't work. It's the opposite direction. States represent entities, not the other way around. Add a new rest endpoint if you want to interact with your entity

MartinHjelmare · 2018-03-11T22:30:26Z

homeassistant/components/alarm_control_panel/ifttt.py

+Interfaces with alarm control panels that have to be controlled through IFTTT.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/alarm_control_panel.ifttt_securitysystem/


The url should end with the platform name after the period, in this case that's ifttt.

MartinHjelmare · 2018-03-11T22:30:56Z

homeassistant/components/alarm_control_panel/ifttt.py

+https://home-assistant.io/components/alarm_control_panel.ifttt_securitysystem/
+"""
+import logging
+import voluptuous as vol


Please add a blank line between standard library and 3rd party imports.

MartinHjelmare · 2018-03-11T22:32:03Z

homeassistant/components/alarm_control_panel/ifttt.py

+class IFTTTAlarmPanel(alarm.AlarmControlPanel):
+    """Representation of an alarm control panel controlled throught IFTTT."""
+
+    def __init__(self, hass, name, code):


Don't pass in hass. It will be set on the entity when it has been added to home assistant.

MartinHjelmare · 2018-03-11T22:32:49Z

homeassistant/components/alarm_control_panel/ifttt.py

+        self._name = name
+        self._code = code
+        # Set default state to disarmed
+        self._state = STATE_ALARM_DISARMED


An unknown state should be initialized with None.

MartinHjelmare · 2018-03-11T22:34:38Z

homeassistant/components/alarm_control_panel/ifttt.py

+            return
+        self.set_alarm_state(EVENT_ALARM_ARM_NIGHT, code)
+
+    def set_alarm_state(self, event, code):


Code isn't used in the method.

MartinHjelmare · 2018-03-11T22:36:46Z

homeassistant/components/alarm_control_panel/ifttt.py

+        """Call the IFTTT trigger service to change the alarm state."""
+        data = {ATTR_EVENT: event}
+
+        self._hass.services.call(IFTTT_DOMAIN, SERVICE_TRIGGER, data)


self.hass.services.call(...)

maxclaey · 2018-03-12T08:20:37Z

Thanks for the clarification about the state updates. I will try another approach tonight or tomorrow

… manually Take into account review comments

arsaboo · 2018-03-14T18:32:39Z

Have been testing this for the last 24 hours and it is working perfectly 👍

balloob · 2018-03-15T04:53:08Z

homeassistant/components/alarm_control_panel/ifttt.py

+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Set up a control panel managed through IFTTT."""
+    if DATA_IFTT_ALARM not in hass.data:


You miss a T in IFTTT

balloob · 2018-03-15T04:54:02Z

homeassistant/components/alarm_control_panel/ifttt.py

+                           schema=PUSH_ALARM_STATE_SERVICE_SCHEMA)
+
+
+class IFTTTAlarmData:


No need for an extra class, you can just store the list directly in hass.data

balloob · 2018-03-15T04:55:32Z

homeassistant/components/alarm_control_panel/ifttt.py

+    vol.Optional(CONF_CODE): cv.string,
+})
+
+SERVICE_PUSH_ALARM_STATE = "push_alarm_state"


Prefix platform specific services with the platform name. So this should be ifttt_push_alarm_state

balloob · 2018-03-15T04:58:34Z

homeassistant/components/alarm_control_panel/ifttt.py

+    hass.data[DATA_IFTT_ALARM].devices.append(alarmpanel)
+    add_devices([alarmpanel])
+
+    def push_state_update(service):


Make this async by changing:

async def push_state_update(service): … for device in devices: … device.async_schedule_update_ha_state()

arsaboo · 2018-03-15T12:35:48Z

homeassistant/components/alarm_control_panel/services.yaml

@@ -69,3 +69,13 @@ alarmdecoder_alarm_toggle_chime:
    code:
      description: A required code to toggle the alarm control panel chime with.
      example: 1234
+
+push_alarm_state:


Should be changed to ifttt_push_alarm_state

Indeed, forgot about it when renaming the service. Updating it

balloob · 2018-03-15T17:09:47Z

🎉 great work! 🐬

maxclaey · 2018-03-16T08:16:05Z

I think all changes requested by @MartinHjelmare are fixed as well

MartinHjelmare

Great!

MartinHjelmare · 2018-03-16T08:36:01Z

Please update the config example in the description in this PR to reflect the latest changes. Then we can merge.

homeassistant added cla-signed new-platform platform: alarm_control_panel.ifttt labels Mar 7, 2018

houndci-bot reviewed Mar 7, 2018

View reviewed changes

homeassistant added the cla-signed label Mar 7, 2018

maxclaey requested a review from andrey-git as a code owner March 8, 2018 18:39

homeassistant added the cla-signed label Mar 8, 2018

balloob reviewed Mar 10, 2018

View reviewed changes

balloob added the docs-missing label Mar 10, 2018

homeassistant added cla-signed labels Mar 10, 2018

maxclaey mentioned this pull request Mar 10, 2018

Documentation for IFTTT alarm control panel home-assistant/home-assistant.io#4878

Merged

2 tasks

MartinHjelmare requested changes Mar 11, 2018

View reviewed changes

maxclaey added 3 commits March 13, 2018 18:39

Add IFTTT alarm control panel

059df27

Update .coveragerc

d857889

Add support for code

b6cf6ff

maxclaey added 9 commits March 13, 2018 18:39

Bugfix

8d2cca9

Fix logging problem

5db70a8

Pin requirements

1e1a5e1

Update requirements_all.txt

057cf3f

Fix lint errors

efa6647

Use ifttt component as a dependency instead of interacting with ifttt…

a2dcccf

… manually Take into account review comments

No default value for code

5ada1e6

Take into account review comments

e9e7c25

Provide a "push_alarm_state" service to change the state from IFTTT

ebd1499

homeassistant added the cla-signed label Mar 13, 2018

Add service description

1b1203f

balloob reviewed Mar 15, 2018

View reviewed changes

Fix @balloob review comments. Thanks!

42c55f7

arsaboo reviewed Mar 15, 2018

View reviewed changes

Fix service description name

22eae5a

balloob approved these changes Mar 15, 2018

View reviewed changes

MartinHjelmare approved these changes Mar 16, 2018

View reviewed changes

balloob merged commit 022d8fb into home-assistant:dev Mar 18, 2018

maxclaey deleted the ifttt_security_systems branch March 20, 2018 16:57

balloob mentioned this pull request Mar 30, 2018

0.66.0 #13554

Merged

home-assistant locked and limited conversation to collaborators Jul 26, 2018

ghost added integration: ifttt and removed platform: alarm_control_panel.ifttt labels Mar 21, 2019

		schema=PUSH_ALARM_STATE_SERVICE_SCHEMA)


		class IFTTTAlarmData:

Support for security systems controlled by IFTTT #12975

Support for security systems controlled by IFTTT #12975

Conversation

maxclaey commented Mar 7, 2018 • edited Loading

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maxclaey commented Mar 8, 2018

c727 commented Mar 8, 2018

maxclaey commented Mar 8, 2018

arsaboo commented Mar 8, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arsaboo Mar 10, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

balloob commented Mar 10, 2018

Choose a reason for hiding this comment

balloob commented Mar 10, 2018

arsaboo commented Mar 11, 2018 • edited Loading

maxclaey commented Mar 11, 2018

balloob commented Mar 11, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maxclaey commented Mar 12, 2018

arsaboo commented Mar 14, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

balloob commented Mar 15, 2018

maxclaey commented Mar 16, 2018

MartinHjelmare left a comment

Choose a reason for hiding this comment

MartinHjelmare commented Mar 16, 2018

maxclaey commented Mar 7, 2018 •

edited

Loading

Example entry for `configuration.yaml` (if applicable):

arsaboo Mar 10, 2018 •

edited

Loading

arsaboo commented Mar 11, 2018 •

edited

Loading