"""Nuki.io lock platform.""" from datetime import timedelta import logging import requests import voluptuous as vol from homeassistant.components.lock import ( DOMAIN, PLATFORM_SCHEMA, LockDevice, SUPPORT_OPEN, ) from homeassistant.const import ATTR_ENTITY_ID, CONF_HOST, CONF_PORT, CONF_TOKEN import homeassistant.helpers.config_validation as cv from homeassistant.helpers.service import extract_entity_ids _LOGGER = logging.getLogger(__name__) DEFAULT_PORT = 8080 DEFAULT_TIMEOUT = 20 ATTR_BATTERY_CRITICAL = "battery_critical" ATTR_NUKI_ID = "nuki_id" ATTR_UNLATCH = "unlatch" MIN_TIME_BETWEEN_FORCED_SCANS = timedelta(seconds=5) MIN_TIME_BETWEEN_SCANS = timedelta(seconds=30) NUKI_DATA = "nuki" SERVICE_LOCK_N_GO = "lock_n_go" SERVICE_CHECK_CONNECTION = "check_connection" PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend( { vol.Required(CONF_HOST): cv.string, vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port, vol.Required(CONF_TOKEN): cv.string, } ) LOCK_N_GO_SERVICE_SCHEMA = vol.Schema( { vol.Optional(ATTR_ENTITY_ID): cv.entity_ids, vol.Optional(ATTR_UNLATCH, default=False): cv.boolean, } ) CHECK_CONNECTION_SERVICE_SCHEMA = vol.Schema( {vol.Optional(ATTR_ENTITY_ID): cv.entity_ids} ) def setup_platform(hass, config, add_entities, discovery_info=None): """Set up the Nuki lock platform.""" from pynuki import NukiBridge bridge = NukiBridge( config[CONF_HOST], config[CONF_TOKEN], config[CONF_PORT], DEFAULT_TIMEOUT ) add_entities([NukiLock(lock) for lock in bridge.locks]) def service_handler(service): """Service handler for nuki services.""" entity_ids = extract_entity_ids(hass, service) all_locks = hass.data[NUKI_DATA][DOMAIN] target_locks = [] if not entity_ids: target_locks = all_locks else: for lock in all_locks: if lock.entity_id in entity_ids: target_locks.append(lock) for lock in target_locks: if service.service == SERVICE_LOCK_N_GO: unlatch = service.data[ATTR_UNLATCH] lock.lock_n_go(unlatch=unlatch) elif service.service == SERVICE_CHECK_CONNECTION: lock.check_connection() hass.services.register( "nuki", SERVICE_LOCK_N_GO, service_handler, schema=LOCK_N_GO_SERVICE_SCHEMA ) hass.services.register( "nuki", SERVICE_CHECK_CONNECTION, service_handler, schema=CHECK_CONNECTION_SERVICE_SCHEMA, ) class NukiLock(LockDevice): """Representation of a Nuki lock.""" def __init__(self, nuki_lock): """Initialize the lock.""" self._nuki_lock = nuki_lock self._locked = nuki_lock.is_locked self._name = nuki_lock.name self._battery_critical = nuki_lock.battery_critical self._available = nuki_lock.state != 255 async def async_added_to_hass(self): """Call when entity is added to hass.""" if NUKI_DATA not in self.hass.data: self.hass.data[NUKI_DATA] = {} if DOMAIN not in self.hass.data[NUKI_DATA]: self.hass.data[NUKI_DATA][DOMAIN] = [] self.hass.data[NUKI_DATA][DOMAIN].append(self) @property def name(self): """Return the name of the lock.""" return self._name @property def is_locked(self): """Return true if lock is locked.""" return self._locked @property def device_state_attributes(self): """Return the device specific state attributes.""" data = { ATTR_BATTERY_CRITICAL: self._battery_critical, ATTR_NUKI_ID: self._nuki_lock.nuki_id, } return data @property def supported_features(self): """Flag supported features.""" return SUPPORT_OPEN @property def available(self) -> bool: """Return True if entity is available.""" return self._available def update(self): """Update the nuki lock properties.""" try: self._nuki_lock.update(aggressive=False) except requests.exceptions.RequestException: self._available = False else: self._name = self._nuki_lock.name self._locked = self._nuki_lock.is_locked self._battery_critical = self._nuki_lock.battery_critical def lock(self, **kwargs): """Lock the device.""" self._nuki_lock.lock() def unlock(self, **kwargs): """Unlock the device.""" self._nuki_lock.unlock() def open(self, **kwargs): """Open the door latch.""" self._nuki_lock.unlatch() def lock_n_go(self, unlatch=False, **kwargs): """Lock and go. This will first unlock the door, then wait for 20 seconds (or another amount of time depending on the lock settings) and relock. """ self._nuki_lock.lock_n_go(unlatch, kwargs) def check_connection(self, **kwargs): """Update the nuki lock properties.""" try: self._nuki_lock.update(aggressive=True) except requests.exceptions.RequestException: self._available = False else: self._available = self._nuki_lock.state != 255