lock.py

Go to the documentation of this file.

"""Support for Homematic locks."""
 
from __future__ import annotations
 
from typing import Any
 
from homeassistant.components.lock import LockEntity, LockEntityFeature
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
from .const import ATTR_DISCOVER_DEVICES
from .entity import HMDevice
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the Homematic lock platform."""
    if discovery_info is None:
        return
 
    add_entities((HMLock(conf) for conf in discovery_info[ATTR_DISCOVER_DEVICES]), True)
 
 
class HMLock(HMDevice, LockEntity):
    """Representation of a Homematic lock aka KeyMatic."""
 
    _attr_supported_features = LockEntityFeature.OPEN
 
    @property
    def is_locked(self) -> bool:
        """Return true if the lock is locked."""
        return not bool(self._hm_get_state_hm_get_state())
 
    def lock(self, **kwargs: Any) -> None:
        """Lock the lock."""
        self._hmdevice_hmdevice.lock()
 
    def unlock(self, **kwargs: Any) -> None:
        """Unlock the lock."""
        self._hmdevice_hmdevice.unlock()
 
    def open(self, **kwargs: Any) -> None:
        """Open the door latch."""
        self._hmdevice_hmdevice.open()
 
    def _init_data_struct(self):
        """Generate the data dictionary (self._data) from metadata."""
        self._state_state_state = "STATE"
        self._data.update({self._state_state_state: None})