lock.py

Go to the documentation of this file.

"""Support for Vera locks."""
 
from __future__ import annotations
 
from typing import Any
 
import pyvera as veraApi
 
from homeassistant.components.lock import ENTITY_ID_FORMAT, LockEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import Platform
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from .common import ControllerData, get_controller_data
from .entity import VeraEntity
 
ATTR_LAST_USER_NAME = "changed_by_name"
ATTR_LOW_BATTERY = "low_battery"
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the sensor config entry."""
    controller_data = get_controller_data(hass, entry)
    async_add_entities(
        [
            VeraLock(device, controller_data)
            for device in controller_data.devices[Platform.LOCK]
        ],
        True,
    )
 
 
class VeraLock(VeraEntity[veraApi.VeraLock], LockEntity):
    """Representation of a Vera lock."""
 
    def __init__(
        self, vera_device: veraApi.VeraLock, controller_data: ControllerData
    ) -> None:
        """Initialize the Vera device."""
        VeraEntity.__init__(self, vera_device, controller_data)
        self.entity_identity_identity_id = ENTITY_ID_FORMAT.format(self.vera_id)
 
    def lock(self, **kwargs: Any) -> None:
        """Lock the device."""
        self.vera_device.lock()
        self._attr_is_locked_attr_is_locked = True
 
    def unlock(self, **kwargs: Any) -> None:
        """Unlock the device."""
        self.vera_device.unlock()
        self._attr_is_locked_attr_is_locked = False
 
    @property
    def extra_state_attributes(self) -> dict[str, Any] | None:
        """Who unlocked the lock and did a low battery alert fire.
 
        Reports on the previous poll cycle.
        changed_by_name is a string like 'Bob'.
        low_battery is 1 if an alert fired, 0 otherwise.
        """
        data = super().extra_state_attributes or {}
 
        last_user = self.vera_device.get_last_user_alert()
        if last_user is not None:
            data[ATTR_LAST_USER_NAME] = last_user[1]
 
        data[ATTR_LOW_BATTERY] = self.vera_device.get_low_battery_alert()
        return data
 
    @property
    def changed_by(self) -> str | None:
        """Who unlocked the lock.
 
        Reports on the previous poll cycle.
        changed_by is an integer user ID.
        """
        last_user = self.vera_device.get_last_user_alert()
        if last_user is not None:
            return last_user[0]
        return None
 
    def update(self) -> None:
        """Update state by the Vera device callback."""
        self._attr_is_locked_attr_is_locked = self.vera_device.is_locked(True)