Add support for KIWI Door Locks by c7h · Pull Request #14485 · home-assistant/core

c7h · 2018-05-16T10:26:17Z

Description:

Added support for the KIWI Door lock platform (https://kiwi.ki).

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

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

lock:
  - platform: kiwi
    username: email@example.com
    password: supersecretpassword

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).
New dependencies are only imported inside functions that use them (example).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

bugfixes improved attribute display flake8 more style adjustments

flake8

reordered imports and flake8 attempt to pelase a very picky linter also pleasing pylint now :)

fabaff · 2018-05-16T13:34:35Z

Successor of #12304

Kane610 · 2018-05-18T09:40:07Z

+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Set up the KIWI lock platform."""
+    from kiwiki import KiwiClient
+    kiwi = KiwiClient(config.get(CONF_USERNAME), config.get(CONF_PASSWORD))


No need for get, you already require those parameters in the schema

Kane610 · 2018-05-18T09:40:47Z

+    def __init__(self, kiwi_lock, client):
+        """Initialize the lock."""
+        self._sensor = kiwi_lock
+        self._device_attrs = None


No need to set it to None if you assign it four lines down

Kane610 · 2018-05-18T09:44:25Z

+    @property
+    def is_locked(self):
+        """Return true if lock is locked."""
+        return True


Can it never be unlocked?

No, there's no way to detect the actual locked state. Therefore, the assumed state is locked (devices automatically lock after unlock within 5 seconds)

You could use this approach: #14419 Just change the state for some seconds.

Please implement the suggested approach. It changes the state of the lock for a short period of time and makes automations easier.

syssi · 2018-05-24T06:18:54Z

+            ATTR_CAN_INVITE: kiwi_lock.get('can_invite')}
+
+        self._device_attrs.update(address)
+        self._device_attrs.update({


Why do extract lat/lng and add it again separately? You could update the content of address and add it to the list by **address:

self._device_attrs { ATTR_ID: self.lock_I'd, **address }

ok this can be nested structure? cool - i'll change it 👍

fabaff · 2018-06-01T21:48:30Z

+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Set up the KIWI lock platform."""
+    from kiwiki import KiwiClient
+    kiwi = KiwiClient(config[CONF_USERNAME], config[CONF_PASSWORD])


I guess that there will be a traceback if the credentials are wrong. The setup should fails otherwise the users end up with a non-working platform.

fabaff · 2018-06-02T07:18:57Z

c7h/kiwiki_client#1 should be addressed upstream and the requirement updated.

fabaff · 2018-06-02T07:20:41Z

+    """Set up the KIWI lock platform."""
+    from kiwiki import KiwiClient
+    kiwi = KiwiClient(config[CONF_USERNAME], config[CONF_PASSWORD])
+    add_devices([KiwiLock(lock, kiwi) for lock in kiwi.get_locks()], True)


A log entry that there are no locks found would help the users. Also, the setup can be terminated if there are no locks.

MartinHjelmare · 2018-06-02T10:32:17Z

+    @property
+    def is_locked(self):
+        """Return true if lock is locked."""
+        if self._state is not None:


Remove this check. It doesn't add anything.

MartinHjelmare · 2018-06-02T12:23:05Z

+        kiwi = KiwiClient(config[CONF_USERNAME], config[CONF_PASSWORD])
+    except KiwiException as e:
+        _LOGGER.error(e.msg)
+        return False


Don't return False. Just return.

That is horrible to read. I prefer return False - there is no room for misinterpretation.

Nothing is checking the return value.

Check the platform example -
False is returned here on login failed. It makes sense even if its not checked because it improves the readability. https://developers.home-assistant.io/docs/en/creating_platform_example_light.html

That example needs updating.

It doesn't improve readability. It gives the wrong impression what happens when the function returns.

It also makes the return inconsistent.

Ok, I created an Issue (home-assistant/developers.home-assistant#21) and will change it to return

MartinHjelmare · 2018-06-02T12:23:38Z

+    if not available_locks:
+        # No locks found; abort setup routine.
+        _LOGGER.info("No KIWI locks found in your account.")
+        return False


Same as above.

MartinHjelmare

Sorry I missed this one.

MartinHjelmare · 2018-06-04T10:44:35Z

+            _LOGGER.error("failed to open door")
+        else:
+            self._state = STATE_UNLOCKED
+            async_call_later(self.hass, UNLOCK_MAINTAIN_TIME,


This is a callback so have to be run from within the event loop. Use hass.add_job to schedule async_call_later on the event loop.

doesn't async_call_later already do that for you?

async_call_later schedules the passed in callback yes, but async_call_later itself needs to be called from within the event loop. The unlock method here will not be run within the event loop but in a worker thread. So to make sure that async_call_later is called from the event loop, we need to use hass.add_job.

self.hass.add_job( async_call_later, self.hass, UNLOCK_MAINTAIN_TIME, self.clear_unlock_state)

MartinHjelmare · 2018-06-12T05:16:07Z

+    from kiwiki import KiwiClient, KiwiException
+    try:
+        kiwi = KiwiClient(config[CONF_USERNAME], config[CONF_PASSWORD])
+    except KiwiException as e:


Linter is failing here. Please use eg exc instead of e.

that's sad.... 😢

c7h added 7 commits May 16, 2018 12:16

initial commit for kiwi door locks

d9a0d7d

bugfixes improved attribute display flake8 more style adjustments

added session handling

8624d6e

flake8

added requirements_all

b823b06

reordered imports and flake8 attempt to pelase a very picky linter also pleasing pylint now :)

re-try the build

15483cd

added kiwi.py to .coveragerc

41f7ea8

reorganized datetime handling and attribute naming

2ba5154

created pypi package for door lock library

c4f4a00

homeassistant added cla-signed new-platform platform: lock.kiwi labels May 16, 2018

updated requirements_all.txt

a14adc6

homeassistant added the cla-signed label May 16, 2018

fabaff changed the title ~~New Component: KIWI Door Lock~~ Add support for KIWI Door Locks May 16, 2018

c7h mentioned this pull request May 16, 2018

Add documentation for KIWI.KI smartlock home-assistant/home-assistant.io#5381

Merged

2 tasks

Kane610 reviewed May 18, 2018

View reviewed changes

code review changes

19891aa

homeassistant added the cla-signed label May 18, 2018

syssi reviewed May 24, 2018

View reviewed changes

c7h added 3 commits May 29, 2018 12:39

added async lock state reset for locking state

41422b3

refactored lat/lon attribute updates

9644328

initial locked state changed from undefined to locked

9c1792b

fabaff reviewed Jun 1, 2018

View reviewed changes

fabaff reviewed Jun 2, 2018

View reviewed changes

MartinHjelmare reviewed Jun 2, 2018

View reviewed changes

c7h added 2 commits June 2, 2018 13:16

refactored is_locked property check

ec8d4d9

handling authentication exception in setup_platform

d917dd3

added more check in setup_platform

7107c3f

MartinHjelmare reviewed Jun 2, 2018

View reviewed changes

c7h mentioned this pull request Jun 4, 2018

Update Platform Example Code home-assistant/developers.home-assistant#21

Closed

code review changes: return type in setup_platform

4593daf

MartinHjelmare reviewed Jun 4, 2018

View reviewed changes

c7h added 2 commits June 4, 2018 13:02

fixed logging issue

2e796d7

event handling in main thread

428ed07

ghost added the in progress label Jun 7, 2018

updated kiwiki-client to version 0.1.1

b6894ef

homeassistant added the cla-signed label Jun 11, 2018

MartinHjelmare reviewed Jun 12, 2018

View reviewed changes

renamed alias e to exc

a32744b

MartinHjelmare approved these changes Jun 12, 2018

View reviewed changes

MartinHjelmare merged commit 6755ae2 into home-assistant:dev Jun 12, 2018

ghost removed the in progress label Jun 12, 2018

balloob mentioned this pull request Jun 22, 2018

0.72 #15088

Merged

home-assistant locked and limited conversation to collaborators Dec 10, 2018

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

Uh oh!

Conversation

c7h commented May 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

fabaff commented May 16, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

c7h May 18, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

c7h May 29, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fabaff commented Jun 2, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

c7h Jun 2, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare Jun 2, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

c7h commented May 16, 2018 •

edited

Loading

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

c7h May 18, 2018 •

edited

Loading

c7h May 29, 2018 •

edited

Loading

c7h Jun 2, 2018 •

edited

Loading

MartinHjelmare Jun 2, 2018 •

edited

Loading