hass-core/homeassistant/components/lock/august.py
Joe Lu a8444b22e7 Support for August doorbell (#11124)
* Add support for August doorbell

* Address PR comment for August platform

* Address PR comment for August binary sensor

* Address PR comment for August camera

* Addressed PR comment for August lock

* - Fixed houndci-bot error

* - Updated configurator description

* - Fixed stale docstring

* Added august module to .coveragerc
2018-02-18 09:24:51 +01:00

82 lines
2.3 KiB
Python

"""
Support for August lock.
For more details about this platform, please refer to the documentation at
https://home-assistant.io/components/lock.august/
"""
from datetime import timedelta
from homeassistant.components.august import DATA_AUGUST
from homeassistant.components.lock import LockDevice
from homeassistant.const import ATTR_BATTERY_LEVEL
DEPENDENCIES = ['august']
SCAN_INTERVAL = timedelta(seconds=5)
def setup_platform(hass, config, add_devices, discovery_info=None):
"""Set up August locks."""
data = hass.data[DATA_AUGUST]
devices = []
for lock in data.locks:
devices.append(AugustLock(data, lock))
add_devices(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
def lock(self, **kwargs):
"""Lock the device."""
self._data.lock(self._lock.device_id)
def unlock(self, **kwargs):
"""Unlock the device."""
self._data.unlock(self._lock.device_id)
def update(self):
"""Get the latest state of the sensor."""
self._lock_status = self._data.get_lock_status(self._lock.device_id)
self._lock_detail = self._data.get_lock_detail(self._lock.device_id)
from august.activity import ActivityType
activity = self._data.get_latest_device_activity(
self._lock.device_id,
ActivityType.LOCK_OPERATION)
if activity is not None:
self._changed_by = activity.operated_by
@property
def name(self):
"""Return the name of this device."""
return self._lock.device_name
@property
def is_locked(self):
"""Return true if device is on."""
from august.lock import LockStatus
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."""
return {
ATTR_BATTERY_LEVEL: self._lock_detail.battery_level,
}