124 lines
3.7 KiB
Python
124 lines
3.7 KiB
Python
"""
|
|
Support for ISY994 locks.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/lock.isy994/
|
|
"""
|
|
import logging
|
|
from typing import Callable # noqa
|
|
|
|
from homeassistant.components.lock import LockDevice, DOMAIN
|
|
import homeassistant.components.isy994 as isy
|
|
from homeassistant.const import STATE_LOCKED, STATE_UNLOCKED, STATE_UNKNOWN
|
|
from homeassistant.helpers.typing import ConfigType
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
VALUE_TO_STATE = {
|
|
0: STATE_UNLOCKED,
|
|
100: STATE_LOCKED
|
|
}
|
|
|
|
UOM = ['11']
|
|
STATES = [STATE_LOCKED, STATE_UNLOCKED]
|
|
|
|
|
|
# pylint: disable=unused-argument
|
|
def setup_platform(hass, config: ConfigType,
|
|
add_devices: Callable[[list], None], discovery_info=None):
|
|
"""Set up the ISY994 lock platform."""
|
|
if isy.ISY is None or not isy.ISY.connected:
|
|
_LOGGER.error('A connection has not been made to the ISY controller.')
|
|
return False
|
|
|
|
devices = []
|
|
|
|
for node in isy.filter_nodes(isy.NODES, units=UOM,
|
|
states=STATES):
|
|
devices.append(ISYLockDevice(node))
|
|
|
|
for program in isy.PROGRAMS.get(DOMAIN, []):
|
|
try:
|
|
status = program[isy.KEY_STATUS]
|
|
actions = program[isy.KEY_ACTIONS]
|
|
assert actions.dtype == 'program', 'Not a program'
|
|
except (KeyError, AssertionError):
|
|
pass
|
|
else:
|
|
devices.append(ISYLockProgram(program.name, status, actions))
|
|
|
|
add_devices(devices)
|
|
|
|
|
|
class ISYLockDevice(isy.ISYDevice, LockDevice):
|
|
"""Representation of an ISY994 lock device."""
|
|
|
|
def __init__(self, node) -> None:
|
|
"""Initialize the ISY994 lock device."""
|
|
isy.ISYDevice.__init__(self, node)
|
|
self._conn = node.parent.parent.conn
|
|
|
|
@property
|
|
def is_locked(self) -> bool:
|
|
"""Get whether the lock is in locked state."""
|
|
return self.state == STATE_LOCKED
|
|
|
|
@property
|
|
def state(self) -> str:
|
|
"""Get the state of the lock."""
|
|
return VALUE_TO_STATE.get(self.value, STATE_UNKNOWN)
|
|
|
|
def lock(self, **kwargs) -> None:
|
|
"""Send the lock command to the ISY994 device."""
|
|
# Hack until PyISY is updated
|
|
req_url = self._conn.compileURL(['nodes', self.unique_id, 'cmd',
|
|
'SECMD', '1'])
|
|
response = self._conn.request(req_url)
|
|
|
|
if response is None:
|
|
_LOGGER.error('Unable to lock device')
|
|
|
|
self._node.update(0.5)
|
|
|
|
def unlock(self, **kwargs) -> None:
|
|
"""Send the unlock command to the ISY994 device."""
|
|
# Hack until PyISY is updated
|
|
req_url = self._conn.compileURL(['nodes', self.unique_id, 'cmd',
|
|
'SECMD', '0'])
|
|
response = self._conn.request(req_url)
|
|
|
|
if response is None:
|
|
_LOGGER.error('Unable to lock device')
|
|
|
|
self._node.update(0.5)
|
|
|
|
|
|
class ISYLockProgram(ISYLockDevice):
|
|
"""Representation of a ISY lock program."""
|
|
|
|
def __init__(self, name: str, node, actions) -> None:
|
|
"""Initialize the lock."""
|
|
ISYLockDevice.__init__(self, node)
|
|
self._name = name
|
|
self._actions = actions
|
|
|
|
@property
|
|
def is_locked(self) -> bool:
|
|
"""Return true if the device is locked."""
|
|
return bool(self.value)
|
|
|
|
@property
|
|
def state(self) -> str:
|
|
"""Return the state of the lock."""
|
|
return STATE_LOCKED if self.is_locked else STATE_UNLOCKED
|
|
|
|
def lock(self, **kwargs) -> None:
|
|
"""Lock the device."""
|
|
if not self._actions.runThen():
|
|
_LOGGER.error('Unable to lock device')
|
|
|
|
def unlock(self, **kwargs) -> None:
|
|
"""Unlock the device."""
|
|
if not self._actions.runElse():
|
|
_LOGGER.error('Unable to unlock device')
|