core/homeassistant/components/august/lock.py

"""Support for August lock."""
from datetime import timedelta
import logging

from august.activity import ACTIVITY_ACTION_STATES, ActivityType
from august.lock import LockStatus

from homeassistant.components.lock import LockDevice
from homeassistant.const import ATTR_BATTERY_LEVEL
from homeassistant.util import dt

from . import DATA_AUGUST

_LOGGER = logging.getLogger(__name__)

SCAN_INTERVAL = timedelta(seconds=10)


def setup_platform(hass, config, add_entities, discovery_info=None):
    """Set up August locks."""
    data = hass.data[DATA_AUGUST]
    devices = []

    for lock in data.locks:
        _LOGGER.debug("Adding lock for %s", lock.device_name)
        devices.append(AugustLock(data, lock))

    add_entities(devices, True)


class AugustLock(LockDevice):
    """Representation of an August lock."""

    def __init__(self, data, lock):
        """Initialize the lock."""
        self._data = data
        self._lock = lock
        self._lock_status = None
        self._lock_detail = None
        self._changed_by = None
        self._available = False

    def lock(self, **kwargs):
        """Lock the device."""
        update_start_time_utc = dt.utcnow()
        lock_status = self._data.lock(self._lock.device_id)
        self._update_lock_status(lock_status, update_start_time_utc)

    def unlock(self, **kwargs):
        """Unlock the device."""
        update_start_time_utc = dt.utcnow()
        lock_status = self._data.unlock(self._lock.device_id)
        self._update_lock_status(lock_status, update_start_time_utc)

    def _update_lock_status(self, lock_status, update_start_time_utc):
        if self._lock_status != lock_status:
            self._lock_status = lock_status
            self._data.update_lock_status(
                self._lock.device_id, lock_status, update_start_time_utc
            )
            self.schedule_update_ha_state()

    def update(self):
        """Get the latest state of the sensor."""
        self._lock_status = self._data.get_lock_status(self._lock.device_id)
        self._available = self._lock_status is not None

        self._lock_detail = self._data.get_lock_detail(self._lock.device_id)

        lock_activity = self._data.get_latest_device_activity(
            self._lock.device_id, ActivityType.LOCK_OPERATION
        )

        if lock_activity is not None:
            self._changed_by = lock_activity.operated_by
            self._sync_lock_activity(lock_activity)

    def _sync_lock_activity(self, lock_activity):
        """Check the activity for the latest lock/unlock activity (events).

        We use this to determine the lock state in between calls to the lock
        api as we update it more frequently
        """
        last_lock_status_update_time_utc = self._data.get_last_lock_status_update_time_utc(
            self._lock.device_id
        )
        activity_end_time_utc = dt.as_utc(lock_activity.activity_end_time)

        if activity_end_time_utc > last_lock_status_update_time_utc:
            _LOGGER.debug(
                "The activity log has new events for %s: [action=%s] [activity_end_time_utc=%s] > [last_lock_status_update_time_utc=%s]",
                self.name,
                lock_activity.action,
                activity_end_time_utc,
                last_lock_status_update_time_utc,
            )
            activity_start_time_utc = dt.as_utc(lock_activity.activity_start_time)
            if lock_activity.action in ACTIVITY_ACTION_STATES:
                self._update_lock_status(
                    ACTIVITY_ACTION_STATES[lock_activity.action],
                    activity_start_time_utc,
                )
            else:
                _LOGGER.info(
                    "Unhandled lock activity action %s for %s",
                    lock_activity.action,
                    self.name,
                )

    @property
    def name(self):
        """Return the name of this device."""
        return self._lock.device_name

    @property
    def available(self):
        """Return the availability of this sensor."""
        return self._available

    @property
    def is_locked(self):
        """Return true if device is on."""

        return self._lock_status is LockStatus.LOCKED

    @property
    def changed_by(self):
        """Last change triggered by."""
        return self._changed_by

    @property
    def device_state_attributes(self):
        """Return the device specific state attributes."""
        if self._lock_detail is None:
            return None

        attributes = {ATTR_BATTERY_LEVEL: self._lock_detail.battery_level}

        if self._lock_detail.keypad is not None:
            attributes["keypad_battery_level"] = self._lock_detail.keypad.battery_level

        return attributes

    @property
    def unique_id(self) -> str:
        """Get the unique id of the lock."""
        return f"{self._lock.device_id:s}_lock"