Add support for Tapo lock device DL110 and implement lock control features #1646
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| """Module for cli lock control commands.""" | ||
|
|
||
| from typing import TYPE_CHECKING | ||
|
|
||
| import asyncclick as click | ||
|
|
||
| from kasa import Device | ||
|
|
||
| from .common import echo, error, pass_dev_or_child | ||
|
|
||
| if TYPE_CHECKING: | ||
| from kasa.smartcam.modules import Lock, LockHistory | ||
|
|
||
|
|
||
| @click.group() | ||
| @pass_dev_or_child | ||
| def lock(dev: Device) -> None: | ||
| """Commands to control lock settings.""" | ||
|
|
||
|
|
||
| @lock.command() | ||
| @pass_dev_or_child | ||
| async def state(dev: Device) -> None: | ||
| """Get lock state.""" | ||
| mod = dev.modules.get("Lock") | ||
| if not mod: | ||
| error("This device does not support lock control.") | ||
| return | ||
|
|
||
| lock_module: Lock = mod # type: ignore[assignment] | ||
| echo(f"Lock state: {'locked' if lock_module.is_locked else 'unlocked'}") # type: ignore[attr-defined] | ||
| echo(f"Battery level: {lock_module.battery_level}%") # type: ignore[attr-defined] | ||
| if lock_module.auto_lock_enabled: # type: ignore[attr-defined] | ||
| echo(f"Auto-lock enabled: {lock_module.auto_lock_time}s") # type: ignore[attr-defined] | ||
| else: | ||
| echo("Auto-lock enabled: false") | ||
|
|
||
| if last_user := lock_module.last_unlock_user: # type: ignore[attr-defined] | ||
| echo(f"Last unlocked by: {last_user} ({lock_module.last_unlock_method.value})") # type: ignore[attr-defined] | ||
|
|
||
|
|
||
| @lock.command() | ||
| @pass_dev_or_child | ||
| async def unlock(dev: Device) -> None: | ||
| """Unlock the device.""" | ||
| mod = dev.modules.get("Lock") | ||
| if not mod: | ||
| error("This device does not support lock control.") | ||
| return | ||
|
|
||
| lock_module: Lock = mod # type: ignore[assignment] | ||
| echo("Unlocking...") | ||
| await lock_module.unlock() # type: ignore[attr-defined] | ||
| await dev.update() | ||
| echo(f"Lock state: {'locked' if lock_module.is_locked else 'unlocked'}") # type: ignore[attr-defined] | ||
|
|
||
|
|
||
| @lock.command(name="lock") | ||
| @pass_dev_or_child | ||
| async def lock_device(dev: Device) -> None: | ||
| """Lock the device.""" | ||
| mod = dev.modules.get("Lock") | ||
| if not mod: | ||
| error("This device does not support lock control.") | ||
| return | ||
|
|
||
| lock_module: Lock = mod # type: ignore[assignment] | ||
| echo("Locking...") | ||
| await lock_module.lock() # type: ignore[attr-defined] | ||
| await dev.update() | ||
| echo(f"Lock state: {'locked' if lock_module.is_locked else 'unlocked'}") # type: ignore[attr-defined] | ||
|
|
||
|
|
||
| @lock.command() | ||
| @pass_dev_or_child | ||
| async def history(dev: Device) -> None: | ||
| """Get lock history.""" | ||
| mod = dev.modules.get("LockHistory") | ||
| if not mod: | ||
| error("This device does not support lock history.") | ||
| return | ||
|
|
||
| history_module: LockHistory = mod # type: ignore[assignment] | ||
| echo(f"Total lock events: {history_module.total_log_count}\n") # type: ignore[attr-defined] | ||
|
|
||
| if not history_module.logs: # type: ignore[attr-defined] | ||
| echo("No lock events recorded.") | ||
| return | ||
|
|
||
| echo("Recent lock events:") | ||
| for i, entry in enumerate(history_module.logs[:10], 1): # type: ignore[attr-defined] | ||
| user_info = f" by {entry.user}" if entry.user else "" | ||
| echo( | ||
| f" {i}. {entry.timestamp.strftime('%Y-%m-%d %H:%M:%S')} - " | ||
| f"{entry.event_type.value.title()}{user_info} ({entry.method.value})" | ||
| ) | ||
|
|
||
| if history_module.last_lock: # type: ignore[attr-defined] | ||
| timestamp = history_module.last_lock.timestamp.strftime("%Y-%m-%d %H:%M:%S") # type: ignore[attr-defined] | ||
| echo(f"\nLast locked: {timestamp}") | ||
|
|
||
| if history_module.last_unlock: # type: ignore[attr-defined] | ||
| timestamp = history_module.last_unlock.timestamp.strftime("%Y-%m-%d %H:%M:%S") # type: ignore[attr-defined] | ||
| echo(f"Last unlocked: {timestamp}") | ||
|
|
||
| return history_module.logs # type: ignore |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| """Module for lock interface.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from abc import ABC, abstractmethod | ||
| from enum import Enum | ||
| from typing import TYPE_CHECKING | ||
|
|
||
| if TYPE_CHECKING: | ||
| pass | ||
|
|
||
|
|
||
| class LockEvent(Enum): | ||
| """Lock event type.""" | ||
|
|
||
| Lock = "lock" | ||
| Unlock = "unlock" | ||
| Unknown = "unknown" | ||
|
|
||
|
|
||
| class LockMethod(Enum): | ||
| """Method used to lock/unlock.""" | ||
|
|
||
| App = "app" | ||
| Manual = "manual" | ||
| Keypad = "keypad" | ||
| NFC = "nfc" | ||
| Fingerprint = "fingerprint" | ||
| HomeKit = "homekit" | ||
| Unknown = "unknown" | ||
|
|
||
| @classmethod | ||
| def from_value(cls, value: str) -> LockMethod: | ||
| """Return lock method from string value.""" | ||
| try: | ||
| return cls(value.lower()) | ||
| except ValueError: | ||
| return cls.Unknown | ||
|
|
||
|
|
||
| class Lock(ABC): | ||
| """Interface for lock devices.""" | ||
|
|
||
| @property | ||
| @abstractmethod | ||
| def is_locked(self) -> bool: | ||
| """Return True if the device is locked.""" | ||
|
|
||
| @property | ||
| @abstractmethod | ||
| def battery_level(self) -> int | None: | ||
| """Return battery level percentage or None if not available.""" | ||
|
|
||
| @property | ||
| @abstractmethod | ||
| def auto_lock_enabled(self) -> bool: | ||
| """Return True if auto-lock is enabled.""" | ||
|
|
||
| @property | ||
| @abstractmethod | ||
| def auto_lock_time(self) -> int | None: | ||
| """Return auto-lock time in seconds or None if not available.""" | ||
|
|
||
| @abstractmethod | ||
| async def lock(self) -> None: | ||
| """Lock the device.""" | ||
|
|
||
| @abstractmethod | ||
| async def unlock(self) -> None: | ||
| """Unlock the device.""" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's avoid polluting the main command namespace given how specific these are to the locks (albeit history could be something similar to trigger logs on some devices, but that's for another discussion).