Add Yale Smart Alarm component #16377

domwillcode · 2018-09-02T22:22:20Z

Description:

Add a Yale Smart Alarm Component to control Yale Smart Alarm Hub through their API (currently only available for purchase in the UK).

Uses yalesmartalarmclient PyPi package (https://github.com/domwillcode/yale-smart-alarm-client) and Yale API to support 'arm_home', 'arm_away' and 'disarm'.

Documentation PR: home-assistant/home-assistant.io#6176

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

alarm_control_panel:
  - platform: yale_smart_alarm
    username: YOUR_USERNAME
    password: YOUR_PASSWORD

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass

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:

New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New or updated dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

If the code does not interact with devices:

Tests have been added to verify that the new code works.

…into add-yale-smart-alarm-component

homeassistant · 2018-09-02T22:22:21Z

Hi @domwillcode,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

MartinHjelmare · 2018-09-03T08:41:49Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+Yale Smart Alarm client for interacting with the Yale Smart Alarm System API.
+
+For more details about this platform, please refer to the documentation at
+https://github.com/domwillcode/yale-smart-alarm-client


Replace with a link to our docs. See other platforms for examples.

MartinHjelmare · 2018-09-03T08:42:10Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+
+import asyncio
+import logging
+import voluptuous as vol


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

MartinHjelmare · 2018-09-03T08:43:36Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+import logging
+import voluptuous as vol
+
+import homeassistant.components.alarm_control_panel as alarm


Import AlarmControlPanel instead and group the import with the line below.

MartinHjelmare · 2018-09-03T08:44:04Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+from homeassistant.components.alarm_control_panel import PLATFORM_SCHEMA
+from homeassistant.const import (
+    CONF_PASSWORD,
+    CONF_USERNAME,


Don't break line after each name.

MartinHjelmare · 2018-09-03T08:45:07Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+
+CONF_AREA_ID = 'area_id'
+
+YALE_SMART_ALARM_DOMAIN = 'yale_smart_alarm'


Rename this to YALE_SMART_ALARM_DATA.

MartinHjelmare · 2018-09-03T08:53:25Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+
+        from yalesmartalarmclient.client import YaleSmartAlarmClient
+
+        self._client = YaleSmartAlarmClient(


This client isn't async safe. Replace used coroutines with normal functions and use the home assistant sync api instead.

We should login and check credentials before creating the entity. If credentials are bad, we should log an error in setup_platform and return from that.

So move this out of the init method and pass the client in to the entity after login is successful instead.

It did check/fail before creating the entity, but you're right, it is horrendously unclear. Do you have a preferred way of handling authentication failure? Client exception -> catch, log and return?

MartinHjelmare · 2018-09-03T08:56:02Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+            password,
+            area_id)
+
+        _LOGGER.debug("Yale Smart Alarm client created and authenticated")


No logging in init method.

MartinHjelmare · 2018-09-03T08:56:27Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+        elif status == YALE_STATE_ARM_FULL:
+            state = STATE_ALARM_ARMED_AWAY
+        else:
+            state = STATE_UNKNOWN


Use None.

MartinHjelmare · 2018-09-03T08:58:52Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+
+        status = self._client.get_armed_status()
+
+        if status == YALE_STATE_DISARM:


Instead of this if/else you can create a dictionary that maps the Yale states to the home assistant states and store that as an instance attribute in init. Then look up the home assistant state here.

MartinHjelmare · 2018-09-03T08:59:16Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+
+        self._state = state
+
+    @asyncio.coroutine


Don't use async api.

fabaff

Just some quick comments.

Also, domwillcode/yale-smart-alarm-client#1 needs to be addressed.

fabaff · 2018-09-03T08:55:21Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+        self._name = name
+        self._username = username
+        self._password = password
+        self._state = STATE_UNKNOWN


Use None and let Home Assistant handle the unknown state.

fabaff · 2018-09-03T08:58:09Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+        config.get(CONF_NAME),
+        config.get(CONF_USERNAME),
+        config.get(CONF_PASSWORD),
+        config.get(CONF_AREA_ID))


YaleSmartAlarmClient() should be created during the setup of the platform and passed as an object to YaleAlarmDevice(). If the credentials are wrong then the platform setup should fail. Otherwise the users end up with a non-working platform in their instance.

fabaff · 2018-09-03T09:00:28Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+def async_setup_platform(hass, config, async_add_devices, discovery_info=None):
+    """Set up the alarm platform."""
+    if YALE_SMART_ALARM_DOMAIN not in hass.data:
+        hass.data[YALE_SMART_ALARM_DOMAIN] = []


Why is that needed?

domwillcode · 2018-09-03T23:13:52Z

Thanks for the feedback both, I'm new to Python/HA (and cobbled this together from other alarm components - copy paste is the devil) so your critique is appreciated. I'll make the changes shortly.

…en tcreation and improved authentication failure error. Added state map to replace nasty if blocks.

domwillcode · 2018-09-04T23:36:55Z

Alright, PR updated with changes.

I've added timeouts to the client package (thanks for that!), https://github.com/domwillcode/yale-smart-alarm-client/tree/v0.1.4.

MartinHjelmare · 2018-09-05T06:32:53Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+For more details about this platform, please refer to the documentation at
+https://www.home-assistant.io/components/alarm_control_panel.yale_smart_alarm
+"""
+


Remove this blank line.

MartinHjelmare · 2018-09-05T07:31:34Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Set up the alarm platform."""
+    name = config.get(CONF_NAME)
+    username = config.get(CONF_USERNAME)


Don't use dict.get for required config keys, use dict[key].

MartinHjelmare · 2018-09-05T07:34:00Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+})
+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):


Rename add_devices to add_entities.

MartinHjelmare · 2018-09-05T07:34:51Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+        """Return the state of the device."""
+        armed_status = self._client.get_armed_status()
+
+        self._state = self._state_map.get(armed_status, None)


None is already the default value returned if the key is missing in the dict.

MartinHjelmare · 2018-09-05T07:36:24Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+        """Send arm away command."""
+        self._client.arm_full()
+
+    def alarm_arm_night(self, code=None):


Don't implement this method if it has the same result as alarm_arm_home.

MartinHjelmare · 2018-09-05T07:38:24Z

homeassistant/components/alarm_control_panel/yale_smart_alarm.py

+    try:
+        client = YaleSmartAlarmClient(username, password, area_id)
+    except AuthenticationError:
+        _LOGGER.error("Authentication failed. Check credentials.")


We don't end log messages with period.

domwillcode · 2018-09-05T18:55:49Z

Updated :)

MartinHjelmare

Nice!

Are you happy too @fabaff?

robmarkcole · 2018-09-15T06:38:04Z

@domwillcode is there a risk this API will be removed as it appears to be for a discontinued app..?

domwillcode · 2018-09-15T22:40:10Z

It seems to be just the UI 'app' and the API remains functional, it's been that way for months. I don't know of an alternative API (I'll see if Yale will tell me any secrets), but I wouldn't be surprised if their Android and iOS apps use the same API. I'll see what I can dig up and monitor the situation/update the client if anything changes.

domwillcode added 5 commits August 31, 2018 22:39

Add Smart Alarm Component

37b07cd

Lint fixes

1e502dc

Merge branch 'dev' of https://github.com/home-assistant/home-assistant …

631f36d

…into add-yale-smart-alarm-component

Update coverage

bd1ede1

Update coverage with the correct file name

36334e7

homeassistant added cla-needed new-platform platform: alarm_control_panel.yale_smart_alarm labels Sep 2, 2018

ghost added the in progress label Sep 2, 2018

homeassistant added cla-signed and removed cla-needed labels Sep 2, 2018

MartinHjelmare requested changes Sep 3, 2018

View reviewed changes

fabaff requested changes Sep 3, 2018

View reviewed changes

domwillcode added 3 commits September 4, 2018 23:51

PR Fixes. Update client version (to include timeouts). Cleaned up cli…

9434e2e

…en tcreation and improved authentication failure error. Added state map to replace nasty if blocks.

PR Fixes. Update client version (to include timeouts). Cleaned up cli…

588e688

…en tcreation and improved authentication failure error. Added state map to replace nasty if blocks.

Remove test file added in error.

5371242

domwillcode mentioned this pull request Sep 4, 2018

Yale Smart Alarm component docs home-assistant/home-assistant.io#6176

Merged

2 tasks

MartinHjelmare reviewed Sep 5, 2018

View reviewed changes

PR Fixes

4fbca88

MartinHjelmare approved these changes Sep 5, 2018

View reviewed changes

fabaff approved these changes Sep 7, 2018

View reviewed changes

fabaff merged commit 1f73840 into home-assistant:dev Sep 7, 2018

ghost removed the in progress label Sep 7, 2018

domwillcode deleted the add-yale-smart-alarm-component branch September 7, 2018 16:33

balloob mentioned this pull request Sep 17, 2018

0.78.0 #16666

Merged

home-assistant locked and limited conversation to collaborators Feb 5, 2019

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Yale Smart Alarm component #16377

Add Yale Smart Alarm component #16377

domwillcode commented Sep 2, 2018

homeassistant commented Sep 2, 2018

MartinHjelmare Sep 3, 2018

MartinHjelmare Sep 3, 2018

MartinHjelmare Sep 3, 2018

MartinHjelmare Sep 3, 2018

MartinHjelmare Sep 3, 2018

MartinHjelmare Sep 3, 2018

MartinHjelmare Sep 3, 2018

domwillcode Sep 3, 2018

MartinHjelmare Sep 3, 2018

MartinHjelmare Sep 3, 2018

MartinHjelmare Sep 3, 2018

MartinHjelmare Sep 3, 2018

fabaff left a comment

fabaff Sep 3, 2018

fabaff Sep 3, 2018

fabaff Sep 3, 2018

domwillcode commented Sep 3, 2018

domwillcode commented Sep 4, 2018

MartinHjelmare Sep 5, 2018

MartinHjelmare Sep 5, 2018

MartinHjelmare Sep 5, 2018

MartinHjelmare Sep 5, 2018

MartinHjelmare Sep 5, 2018

MartinHjelmare Sep 5, 2018

domwillcode commented Sep 5, 2018

MartinHjelmare left a comment

robmarkcole commented Sep 15, 2018

domwillcode commented Sep 15, 2018


		CONF_AREA_ID = 'area_id'

		YALE_SMART_ALARM_DOMAIN = 'yale_smart_alarm'


		from yalesmartalarmclient.client import YaleSmartAlarmClient

		self._client = YaleSmartAlarmClient(


		status = self._client.get_armed_status()

		if status == YALE_STATE_DISARM:

		})


		def setup_platform(hass, config, add_devices, discovery_info=None):

Add Yale Smart Alarm component #16377

Add Yale Smart Alarm component #16377

Conversation

domwillcode commented Sep 2, 2018

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

homeassistant commented Sep 2, 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

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

fabaff left a 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

domwillcode commented Sep 3, 2018

domwillcode commented Sep 4, 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

domwillcode commented Sep 5, 2018

MartinHjelmare left a comment

Choose a reason for hiding this comment

robmarkcole commented Sep 15, 2018

domwillcode commented Sep 15, 2018

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