mirror of
https://github.com/home-assistant/core.git
synced 2025-11-09 02:49:40 +00:00
88 lines
2.7 KiB
Python
88 lines
2.7 KiB
Python
"""The Homee lock platform."""
|
|
|
|
from typing import Any
|
|
|
|
from pyHomee.const import AttributeChangedBy, AttributeType
|
|
from pyHomee.model import HomeeNode
|
|
|
|
from homeassistant.components.lock import LockEntity
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
|
|
|
|
from . import HomeeConfigEntry
|
|
from .entity import HomeeEntity
|
|
from .helpers import get_name_for_enum, setup_homee_platform
|
|
|
|
PARALLEL_UPDATES = 0
|
|
|
|
|
|
async def add_lock_entities(
|
|
config_entry: HomeeConfigEntry,
|
|
async_add_entities: AddConfigEntryEntitiesCallback,
|
|
nodes: list[HomeeNode],
|
|
) -> None:
|
|
"""Add homee lock entities."""
|
|
async_add_entities(
|
|
HomeeLock(attribute, config_entry)
|
|
for node in nodes
|
|
for attribute in node.attributes
|
|
if (attribute.type == AttributeType.LOCK_STATE and attribute.editable)
|
|
)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
config_entry: HomeeConfigEntry,
|
|
async_add_entities: AddConfigEntryEntitiesCallback,
|
|
) -> None:
|
|
"""Add the homee platform for the lock component."""
|
|
|
|
await setup_homee_platform(add_lock_entities, async_add_entities, config_entry)
|
|
|
|
|
|
class HomeeLock(HomeeEntity, LockEntity):
|
|
"""Representation of a Homee lock."""
|
|
|
|
_attr_name = None
|
|
|
|
@property
|
|
def is_locked(self) -> bool:
|
|
"""Return if lock is locked."""
|
|
return self._attribute.current_value == 1.0
|
|
|
|
@property
|
|
def is_locking(self) -> bool:
|
|
"""Return if lock is locking."""
|
|
return self._attribute.target_value > self._attribute.current_value
|
|
|
|
@property
|
|
def is_unlocking(self) -> bool:
|
|
"""Return if lock is unlocking."""
|
|
return self._attribute.target_value < self._attribute.current_value
|
|
|
|
@property
|
|
def changed_by(self) -> str:
|
|
"""Return by whom or what the lock was last changed."""
|
|
changed_id = str(self._attribute.changed_by_id)
|
|
changed_by_name = get_name_for_enum(
|
|
AttributeChangedBy, self._attribute.changed_by
|
|
)
|
|
if self._attribute.changed_by == AttributeChangedBy.USER:
|
|
user = self._entry.runtime_data.get_user_by_id(
|
|
self._attribute.changed_by_id
|
|
)
|
|
if user is not None:
|
|
changed_id = user.username
|
|
else:
|
|
changed_id = "Unknown"
|
|
|
|
return f"{changed_by_name}-{changed_id}"
|
|
|
|
async def async_lock(self, **kwargs: Any) -> None:
|
|
"""Lock specified lock. A code to lock the lock with may be specified."""
|
|
await self.async_set_homee_value(1)
|
|
|
|
async def async_unlock(self, **kwargs: Any) -> None:
|
|
"""Unlock specified lock. A code to unlock the lock with may be specified."""
|
|
await self.async_set_homee_value(0)
|