Add support for HomeKit Controller Locks (#19867)

* Added HomeKit Controller Lock

* cleaned up code according to standards

* fixed lint issues

* added private constant for jammed state

* removed state_unknown

homeassistant/components/homekit_controller/__init__.py

@@ -25,6 +25,7 @@ HOMEKIT_ACCESSORY_DISPATCH = {
     'switch': 'switch',
     'thermostat': 'climate',
     'security-system': 'alarm_control_panel',
+    'lock-mechanism': 'lock'
 }
 
 HOMEKIT_IGNORE = [
@@ -116,6 +117,7 @@ class HKDevice():
             for service in accessory['services']:
                 service_info = {'serial': serial,
                                 'aid': aid,
+                                'model': self.model,
                                 'iid': service['iid']}
                 devtype = ServicesTypes.get_short(service['type'])
                 _LOGGER.debug("Found %s", devtype)

homeassistant/components/lock/homekit_controller.py

@@ -0,0 +1,111 @@
+"""
+Support for HomeKit Controller locks.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/lock.homekit_controller/
+"""
+
+import logging
+
+from homeassistant.components.homekit_controller import (HomeKitEntity,
+                                                         KNOWN_ACCESSORIES)
+from homeassistant.components.lock import LockDevice
+from homeassistant.const import (STATE_LOCKED, STATE_UNLOCKED,
+                                 ATTR_BATTERY_LEVEL)
+
+DEPENDENCIES = ['homekit_controller']
+
+_LOGGER = logging.getLogger(__name__)
+
+STATE_JAMMED = 'jammed'
+
+CURRENT_STATE_MAP = {
+    0: STATE_UNLOCKED,
+    1: STATE_LOCKED,
+    2: STATE_JAMMED,
+    3: None,
+}
+
+TARGET_STATE_MAP = {
+    STATE_UNLOCKED: 0,
+    STATE_LOCKED: 1
+}
+
+
+def setup_platform(hass, config, add_entities, discovery_info=None):
+    """Set up Homekit Lock support."""
+    if discovery_info is None:
+        return
+    accessory = hass.data[KNOWN_ACCESSORIES][discovery_info['serial']]
+    add_entities([HomeKitLock(accessory, discovery_info)],
+                 True)
+
+
+class HomeKitLock(HomeKitEntity, LockDevice):
+    """Representation of a HomeKit Controller Lock."""
+
+    def __init__(self, accessory, discovery_info):
+        """Initialise the Lock."""
+        super().__init__(accessory, discovery_info)
+        self._state = None
+        self._name = discovery_info['model']
+        self._battery_level = None
+
+    def update_characteristics(self, characteristics):
+        """Synchronise the Lock state with Home Assistant."""
+        # pylint: disable=import-error
+        from homekit.model.characteristics import CharacteristicsTypes
+
+        for characteristic in characteristics:
+            ctype = characteristic['type']
+            ctype = CharacteristicsTypes.get_short(ctype)
+            if ctype == "lock-mechanism.current-state":
+                self._chars['lock-mechanism.current-state'] = \
+                    characteristic['iid']
+                self._state = CURRENT_STATE_MAP[characteristic['value']]
+            elif ctype == "lock-mechanism.target-state":
+                self._chars['lock-mechanism.target-state'] = \
+                    characteristic['iid']
+            elif ctype == "battery-level":
+                self._chars['battery-level'] = characteristic['iid']
+                self._battery_level = characteristic['value']
+
+    @property
+    def name(self):
+        """Return the name of this device."""
+        return self._name
+
+    @property
+    def is_locked(self):
+        """Return true if device is locked."""
+        return self._state == STATE_LOCKED
+
+    @property
+    def available(self):
+        """Return True if entity is available."""
+        return self._state is not None
+
+    def lock(self, **kwargs):
+        """Lock the device."""
+        self._set_lock_state(STATE_LOCKED)
+
+    def unlock(self, **kwargs):
+        """Unlock the device."""
+        self._set_lock_state(STATE_UNLOCKED)
+
+    def _set_lock_state(self, state):
+        """Send state command."""
+        characteristics = [{'aid': self._aid,
+                            'iid': self._chars['lock-mechanism.target-state'],
+                            'value': TARGET_STATE_MAP[state]}]
+        self.put_characteristics(characteristics)
+
+    @property
+    def device_state_attributes(self):
+        """Return the optional state attributes."""
+        if self._battery_level is None:
+            return None
+
+        return {
+            ATTR_BATTERY_LEVEL: self._battery_level,
+        }