lock.py

Go to the documentation of this file.

"""Support for Sesame, by CANDY HOUSE."""
 
from __future__ import annotations
 
from typing import Any
 
import pysesame2
import voluptuous as vol
 
from homeassistant.components.lock import (
    PLATFORM_SCHEMA as LOCK_PLATFORM_SCHEMA,
    LockEntity,
)
from homeassistant.const import ATTR_BATTERY_LEVEL, ATTR_DEVICE_ID, CONF_API_KEY
from homeassistant.core import HomeAssistant
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
ATTR_SERIAL_NO = "serial"
 
PLATFORM_SCHEMA = LOCK_PLATFORM_SCHEMA.extend({vol.Required(CONF_API_KEY): cv.string})
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the Sesame platform."""
    api_key = config.get(CONF_API_KEY)
 
    add_entities(
        [SesameDevice(sesame) for sesame in pysesame2.get_sesames(api_key)],
        update_before_add=True,
    )
 
 
class SesameDevice(LockEntity):
    """Representation of a Sesame device."""
 
    def __init__(self, sesame: pysesame2.Sesame) -> None:
        """Initialize the Sesame device."""
        self._sesame: pysesame2.Sesame = sesame
 
        # Cached properties from pysesame object.
        self._device_id_device_id: str | None = None
        self._serial_serial = None
        self._nickname_nickname: str | None = None
        self._is_locked_is_locked = False
        self._responsive_responsive = False
        self._battery_battery = -1
 
    @property
    def name(self) -> str | None:
        """Return the name of the device."""
        return self._nickname_nickname
 
    @property
    def available(self) -> bool:
        """Return True if entity is available."""
        return self._responsive_responsive
 
    @property
    def is_locked(self) -> bool:
        """Return True if the device is currently locked, else False."""
        return self._is_locked_is_locked
 
    def lock(self, **kwargs: Any) -> None:
        """Lock the device."""
        self._sesame.lock()
 
    def unlock(self, **kwargs: Any) -> None:
        """Unlock the device."""
        self._sesame.unlock()
 
    def update(self) -> None:
        """Update the internal state of the device."""
        status = self._sesame.get_status()
        self._nickname_nickname = self._sesame.nickname
        self._device_id_device_id = str(self._sesame.id)
        self._serial_serial = self._sesame.serial
        self._battery_battery = status["battery"]
        self._is_locked_is_locked = status["locked"]
        self._responsive_responsive = status["responsive"]
 
    @property
    def extra_state_attributes(self) -> dict[str, Any]:
        """Return the state attributes."""
        return {
            ATTR_DEVICE_ID: self._device_id_device_id,
            ATTR_SERIAL_NO: self._serial_serial,
            ATTR_BATTERY_LEVEL: self._battery_battery,
        }