mirror of https://github.com/home-assistant/core
159 lines
4.2 KiB
Python
159 lines
4.2 KiB
Python
"""Component to interface with locks that can be controlled remotely."""
|
|
from datetime import timedelta
|
|
import functools as ft
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.loader import bind_hass
|
|
from homeassistant.helpers.entity_component import EntityComponent
|
|
from homeassistant.helpers.entity import Entity
|
|
from homeassistant.helpers.config_validation import ( # noqa
|
|
ENTITY_SERVICE_SCHEMA,
|
|
PLATFORM_SCHEMA,
|
|
PLATFORM_SCHEMA_BASE,
|
|
)
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.const import (
|
|
ATTR_CODE,
|
|
ATTR_CODE_FORMAT,
|
|
STATE_LOCKED,
|
|
STATE_UNLOCKED,
|
|
SERVICE_LOCK,
|
|
SERVICE_UNLOCK,
|
|
SERVICE_OPEN,
|
|
)
|
|
from homeassistant.components import group
|
|
|
|
|
|
# mypy: allow-untyped-defs, no-check-untyped-defs
|
|
|
|
ATTR_CHANGED_BY = "changed_by"
|
|
|
|
DOMAIN = "lock"
|
|
SCAN_INTERVAL = timedelta(seconds=30)
|
|
|
|
ENTITY_ID_ALL_LOCKS = group.ENTITY_ID_FORMAT.format("all_locks")
|
|
ENTITY_ID_FORMAT = DOMAIN + ".{}"
|
|
|
|
GROUP_NAME_ALL_LOCKS = "all locks"
|
|
|
|
MIN_TIME_BETWEEN_SCANS = timedelta(seconds=10)
|
|
|
|
LOCK_SERVICE_SCHEMA = ENTITY_SERVICE_SCHEMA.extend({vol.Optional(ATTR_CODE): cv.string})
|
|
|
|
# Bitfield of features supported by the lock entity
|
|
SUPPORT_OPEN = 1
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
PROP_TO_ATTR = {"changed_by": ATTR_CHANGED_BY, "code_format": ATTR_CODE_FORMAT}
|
|
|
|
|
|
@bind_hass
|
|
def is_locked(hass, entity_id=None):
|
|
"""Return if the lock is locked based on the statemachine."""
|
|
entity_id = entity_id or ENTITY_ID_ALL_LOCKS
|
|
return hass.states.is_state(entity_id, STATE_LOCKED)
|
|
|
|
|
|
async def async_setup(hass, config):
|
|
"""Track states and offer events for locks."""
|
|
component = hass.data[DOMAIN] = EntityComponent(
|
|
_LOGGER, DOMAIN, hass, SCAN_INTERVAL, GROUP_NAME_ALL_LOCKS
|
|
)
|
|
|
|
await component.async_setup(config)
|
|
|
|
component.async_register_entity_service(
|
|
SERVICE_UNLOCK, LOCK_SERVICE_SCHEMA, "async_unlock"
|
|
)
|
|
component.async_register_entity_service(
|
|
SERVICE_LOCK, LOCK_SERVICE_SCHEMA, "async_lock"
|
|
)
|
|
component.async_register_entity_service(
|
|
SERVICE_OPEN, LOCK_SERVICE_SCHEMA, "async_open"
|
|
)
|
|
|
|
return True
|
|
|
|
|
|
async def async_setup_entry(hass, entry):
|
|
"""Set up a config entry."""
|
|
return await hass.data[DOMAIN].async_setup_entry(entry)
|
|
|
|
|
|
async def async_unload_entry(hass, entry):
|
|
"""Unload a config entry."""
|
|
return await hass.data[DOMAIN].async_unload_entry(entry)
|
|
|
|
|
|
class LockDevice(Entity):
|
|
"""Representation of a lock."""
|
|
|
|
@property
|
|
def changed_by(self):
|
|
"""Last change triggered by."""
|
|
return None
|
|
|
|
@property
|
|
def code_format(self):
|
|
"""Regex for code format or None if no code is required."""
|
|
return None
|
|
|
|
@property
|
|
def is_locked(self):
|
|
"""Return true if the lock is locked."""
|
|
return None
|
|
|
|
def lock(self, **kwargs):
|
|
"""Lock the lock."""
|
|
raise NotImplementedError()
|
|
|
|
def async_lock(self, **kwargs):
|
|
"""Lock the lock.
|
|
|
|
This method must be run in the event loop and returns a coroutine.
|
|
"""
|
|
return self.hass.async_add_job(ft.partial(self.lock, **kwargs))
|
|
|
|
def unlock(self, **kwargs):
|
|
"""Unlock the lock."""
|
|
raise NotImplementedError()
|
|
|
|
def async_unlock(self, **kwargs):
|
|
"""Unlock the lock.
|
|
|
|
This method must be run in the event loop and returns a coroutine.
|
|
"""
|
|
return self.hass.async_add_job(ft.partial(self.unlock, **kwargs))
|
|
|
|
def open(self, **kwargs):
|
|
"""Open the door latch."""
|
|
raise NotImplementedError()
|
|
|
|
def async_open(self, **kwargs):
|
|
"""Open the door latch.
|
|
|
|
This method must be run in the event loop and returns a coroutine.
|
|
"""
|
|
return self.hass.async_add_job(ft.partial(self.open, **kwargs))
|
|
|
|
@property
|
|
def state_attributes(self):
|
|
"""Return the state attributes."""
|
|
state_attr = {}
|
|
for prop, attr in PROP_TO_ATTR.items():
|
|
value = getattr(self, prop)
|
|
if value is not None:
|
|
state_attr[attr] = value
|
|
return state_attr
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state."""
|
|
locked = self.is_locked
|
|
if locked is None:
|
|
return None
|
|
return STATE_LOCKED if locked else STATE_UNLOCKED
|