Add nuki lock'n'go and unlatch services and add attributes #8687

pschmitt · 2017-07-28T12:25:30Z

Description:

The Nuki locks have a Lock'n'go feature which consists in unlocking, waiting for a certain amount of time (20 seconds by default) then locking again.
https://nuki.io/en/support/smart-lock/sl-features/locking-with-the-smart-lock/

Also there is an unlatch function which will effectively open the door.

TL;DR

Add 2 new services: nuki.nuki_lock_n_go and nuki.nuki_unlatch
Add 2 new attributes: battery_critical and nuki_id

Related issue (if applicable): Fixes #5988

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

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

lock:
  - platform: nuki
    host: 192.168.10.13
    token: XXXXXXX

Checklist:

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 · 2017-07-28T12:25:38Z

homeassistant/components/lock/nuki.py

+        """Callback when entity is added to hass."""
+        if not DOMAIN in self.hass.data:
+            self.hass.data[DOMAIN] = {}
+        if not 'lock' in self.hass.data[DOMAIN]:


test for membership should be 'not in'

houndci-bot · 2017-07-28T12:25:38Z

homeassistant/components/lock/nuki.py

+    @asyncio.coroutine
+    def async_added_to_hass(self):
+        """Callback when entity is added to hass."""
+        if not DOMAIN in self.hass.data:


test for membership should be 'not in'

MartinHjelmare · 2017-08-07T08:21:47Z

homeassistant/components/lock/nuki.py

@@ -5,27 +5,47 @@
 https://home-assistant.io/components/lock.nuki/
 """
 from datetime import timedelta
+from os import path


Move this line below import logging.

MartinHjelmare · 2017-08-07T08:22:20Z

homeassistant/components/lock/nuki.py

@@ -5,27 +5,47 @@
 https://home-assistant.io/components/lock.nuki/
 """
 from datetime import timedelta
+from os import path
+import asyncio


Move this line above from datatime...

MartinHjelmare · 2017-08-07T08:23:52Z

homeassistant/components/lock/nuki.py

+ATTR_BATTERY_CRITICAL = 'battery_critical'
+ATTR_NUKI_ID = 'nuki_id'
+ATTR_UNLATCH = 'unlatch'
+DOMAIN = 'nuki'


Platforms always inherit the domain from their base component, in this case that's lock. You should call this constant something else, like NUKI_DATA. You can import DOMAIN too from homeassistant.components.lock and use that below in the service handler.

MartinHjelmare · 2017-08-07T08:27:34Z

homeassistant/components/lock/nuki.py

+    def service_handler(service):
+        """Service handler for nuki services."""
+        entity_ids = extract_entity_ids(hass, service)
+        all_locks = hass.data[DOMAIN]['lock']


Update to use the new name for 'nuki' eg:

all_locks = hass.data[NUKI_DATA][DOMAIN]

MartinHjelmare · 2017-08-07T08:39:58Z

homeassistant/components/lock/nuki.py

+        entity_ids = extract_entity_ids(hass, service)
+        all_locks = hass.data[DOMAIN]['lock']
+        target_locks = []
+        if entity_ids is None:


extract_entity_ids will return an empty list if missing entity_id in service data. It won't return None. Just change to:

if not entity_ids:

MartinHjelmare · 2017-08-07T08:43:20Z

homeassistant/components/lock/nuki.py



 class NukiLock(LockDevice):
    """Representation of a Nuki lock."""

-    def __init__(self, nuki_lock):
+    def __init__(self, nuki_lock, hass):


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

MartinHjelmare · 2017-08-07T08:43:31Z

homeassistant/components/lock/nuki.py

        """Initialize the lock."""
+        self.hass = hass


MartinHjelmare · 2017-08-07T08:44:11Z

homeassistant/components/lock/nuki.py

+    @asyncio.coroutine
+    def async_added_to_hass(self):
+        """Callback when entity is added to hass."""
+        if DOMAIN not in self.hass.data:


Use NUKI_DATA instead of DOMAIN, and DOMAIN instead of 'lock' in this method.

MartinHjelmare · 2017-08-07T08:51:26Z

homeassistant/components/lock/nuki.py

@@ -72,3 +140,15 @@ def lock(self, **kwargs):
    def unlock(self, **kwargs):
        """Unlock the device."""
        self._nuki_lock.unlock()
+
+    def lock_n_go(self, **kwargs):


def lock_n_go(self, unlatch=False, **kwargs):

MartinHjelmare · 2017-08-07T10:02:53Z

homeassistant/components/lock/nuki.py

+            ATTR_BATTERY_CRITICAL: self._battery_critical,
+            ATTR_NUKI_ID: self._nuki_lock.nuki_id}
+        return data
+
    @Throttle(MIN_TIME_BETWEEN_SCANS, MIN_TIME_BETWEEN_FORCED_SCANS)


This is old code, but Throttle should only be used in a common data instance method to protect from multiple updates from different entity against a common API. Applying the throttle here will just limit updates for the same NukiLock entity. It will not limit updates from other NukiLock entities during the same time. So for this use case, there's already built in functionality in the EntityComponent class that the lock base component uses. Just define SCAN_INTERVAL in this module if you want to override the default SCAN_INTERVAL = timedelta(seconds=30).

I'll just remove that. There is no reason to alter the scan interval here.

MartinHjelmare

Two fixes left, then this is good to merge.

MartinHjelmare · 2017-08-07T11:44:23Z

homeassistant/components/lock/nuki.py

@@ -80,19 +79,18 @@ def service_handler(service):
        path.join(path.dirname(__file__), 'services.yaml'))

    hass.services.register(
-        DOMAIN, SERVICE_LOCK_N_GO, service_handler,
+        NUKI_DATA, SERVICE_LOCK_N_GO, service_handler,


No, services are registered under the base component domain, even from the platforms. So use DOMAIN here.

Woops. I'll fix that in a minute.

MartinHjelmare · 2017-08-07T11:44:40Z

homeassistant/components/lock/nuki.py

        descriptions.get(SERVICE_LOCK_N_GO), schema=LOCK_N_GO_SERVICE_SCHEMA)
    hass.services.register(
-        DOMAIN, SERVICE_UNLATCH, service_handler,
+        NUKI_DATA, SERVICE_UNLATCH, service_handler,


MartinHjelmare · 2017-08-07T11:56:32Z

Btw if this fixes #5988 you can prefix the issue tag with "fixes " in the description to auto close that issue when this PR is merged.

MartinHjelmare

Nice!

@MartinHjelmare

…stant#8687) * Add lock'n'go service * Add unlatch service * Implement changes requested by @MartinHjelmare * Fix service domain

Add lock'n'go service

07df913

homeassistant added platform: lock.nuki cla-signed labels Jul 28, 2017

houndci-bot reviewed Jul 28, 2017

View reviewed changes

pschmitt changed the title ~~WIP: Add lock'n'go service~~ WIP: Add nuki lock'n'go and unlatch services and add attributes Jul 28, 2017

Add unlatch service

15fbef9

homeassistant added the cla-signed label Jul 28, 2017

balloobbot added platform requirement labels Jul 28, 2017

pschmitt changed the title ~~WIP: Add nuki lock'n'go and unlatch services and add attributes~~ Add nuki lock'n'go and unlatch services and add attributes Jul 28, 2017

pschmitt mentioned this pull request Jul 28, 2017

Add documentation about nuki services home-assistant/home-assistant.io#3078

Merged

MartinHjelmare requested changes Aug 7, 2017

View reviewed changes

MartinHjelmare self-assigned this Aug 7, 2017

Implement changes requested by @MartinHjelmare

3ec935a

homeassistant added the cla-signed label Aug 7, 2017

MartinHjelmare requested changes Aug 7, 2017

View reviewed changes

Fix service domain

33d0861

MartinHjelmare approved these changes Aug 7, 2017

View reviewed changes

MartinHjelmare merged commit 3aceca9 into home-assistant:dev Aug 7, 2017

fabaff mentioned this pull request Aug 12, 2017

0.51 #8919

Merged

home-assistant locked and limited conversation to collaborators Dec 11, 2017

ghost added integration: nuki and removed platform: lock.nuki labels Mar 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add nuki lock'n'go and unlatch services and add attributes #8687

Add nuki lock'n'go and unlatch services and add attributes #8687

pschmitt commented Jul 28, 2017 •

edited

Loading

houndci-bot Jul 28, 2017

houndci-bot Jul 28, 2017

MartinHjelmare Aug 7, 2017

MartinHjelmare Aug 7, 2017

MartinHjelmare Aug 7, 2017

MartinHjelmare Aug 7, 2017

MartinHjelmare Aug 7, 2017

MartinHjelmare Aug 7, 2017

MartinHjelmare Aug 7, 2017

MartinHjelmare Aug 7, 2017

MartinHjelmare Aug 7, 2017

MartinHjelmare Aug 7, 2017

pschmitt Aug 7, 2017

MartinHjelmare left a comment

MartinHjelmare Aug 7, 2017

pschmitt Aug 7, 2017

MartinHjelmare Aug 7, 2017

MartinHjelmare commented Aug 7, 2017 •

edited

Loading

MartinHjelmare left a comment

Add nuki lock'n'go and unlatch services and add attributes #8687

Add nuki lock'n'go and unlatch services and add attributes #8687

Conversation

pschmitt commented Jul 28, 2017 • 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

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

MartinHjelmare 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

MartinHjelmare commented Aug 7, 2017 • edited Loading

MartinHjelmare left a comment

Choose a reason for hiding this comment

pschmitt commented Jul 28, 2017 •

edited

Loading

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

MartinHjelmare commented Aug 7, 2017 •

edited

Loading