HomeKit Restructure (new config options) (#12997)

* Restructure
* Pincode will now be autogenerated and display using a persistence notification
* Added 'homekit.start' service
* Added config options
* Renamed files for types
* Improved tests
* Changes (based on feedback)
* Removed CONF_PIN_CODE
* Added services.yaml
* Service will only be registered if auto_start=False
* Bugfix names, changed default port
* Generate aids with zlib.adler32
* Added entity filter, minor changes
* Small changes

homeassistant/components/homekit/accessories.py

@@ -2,15 +2,31 @@
 import logging
 
 from pyhap.accessory import Accessory, Bridge, Category
+from pyhap.accessory_driver import AccessoryDriver
 
 from .const import (
-    SERV_ACCESSORY_INFO, SERV_BRIDGING_STATE, MANUFACTURER,
-    CHAR_MODEL, CHAR_MANUFACTURER, CHAR_NAME, CHAR_SERIAL_NUMBER)
-
+    ACCESSORY_MODEL, ACCESSORY_NAME, BRIDGE_MODEL, BRIDGE_NAME,
+    MANUFACTURER, SERV_ACCESSORY_INFO, SERV_BRIDGING_STATE,
+    CHAR_MANUFACTURER, CHAR_MODEL, CHAR_NAME, CHAR_SERIAL_NUMBER)
+from .util import (
+    show_setup_message, dismiss_setup_message)
 
 _LOGGER = logging.getLogger(__name__)
 
 
+def add_preload_service(acc, service, chars=None):
+    """Define and return a service to be available for the accessory."""
+    from pyhap.loader import get_serv_loader, get_char_loader
+    service = get_serv_loader().get(service)
+    if chars:
+        chars = chars if isinstance(chars, list) else [chars]
+        for char_name in chars:
+            char = get_char_loader().get(char_name)
+            service.add_characteristic(char)
+    acc.add_service(service)
+    return service
+
+
 def set_accessory_info(acc, name, model, manufacturer=MANUFACTURER,
                        serial_number='0000'):
     """Set the default accessory information."""
@@ -21,36 +37,23 @@ def set_accessory_info(acc, name, model, manufacturer=MANUFACTURER,
     service.get_characteristic(CHAR_SERIAL_NUMBER).set_value(serial_number)
 
 
-def add_preload_service(acc, service, chars=None, opt_chars=None):
-    """Define and return a service to be available for the accessory."""
-    from pyhap.loader import get_serv_loader, get_char_loader
-    service = get_serv_loader().get(service)
-    if chars:
-        chars = chars if isinstance(chars, list) else [chars]
-        for char_name in chars:
-            char = get_char_loader().get(char_name)
-            service.add_characteristic(char)
-    if opt_chars:
-        opt_chars = opt_chars if isinstance(opt_chars, list) else [opt_chars]
-        for opt_char_name in opt_chars:
-            opt_char = get_char_loader().get(opt_char_name)
-            service.add_opt_characteristic(opt_char)
-    acc.add_service(service)
-    return service
+def override_properties(char, properties=None, valid_values=None):
+    """Override characteristic property values and valid values."""
+    if properties:
+        char.properties.update(properties)
 
-
-def override_properties(char, new_properties):
-    """Override characteristic property values."""
-    char.properties.update(new_properties)
+    if valid_values:
+        char.properties['ValidValues'].update(valid_values)
 
 
 class HomeAccessory(Accessory):
-    """Class to extend the Accessory class."""
+    """Adapter class for Accessory."""
 
-    def __init__(self, display_name, model, category='OTHER', **kwargs):
+    def __init__(self, name=ACCESSORY_NAME, model=ACCESSORY_MODEL,
+                 category='OTHER', **kwargs):
         """Initialize a Accessory object."""
-        super().__init__(display_name, **kwargs)
-        set_accessory_info(self, display_name, model)
+        super().__init__(name, **kwargs)
+        set_accessory_info(self, name, model)
         self.category = getattr(Category, category, Category.OTHER)
 
     def _set_services(self):
@@ -58,13 +61,37 @@ class HomeAccessory(Accessory):
 
 
 class HomeBridge(Bridge):
-    """Class to extend the Bridge class."""
+    """Adapter class for Bridge."""
 
-    def __init__(self, display_name, model, pincode, **kwargs):
+    def __init__(self, hass, name=BRIDGE_NAME,
+                 model=BRIDGE_MODEL, **kwargs):
         """Initialize a Bridge object."""
-        super().__init__(display_name, pincode=pincode, **kwargs)
-        set_accessory_info(self, display_name, model)
+        super().__init__(name, **kwargs)
+        set_accessory_info(self, name, model)
+        self._hass = hass
 
     def _set_services(self):
         add_preload_service(self, SERV_ACCESSORY_INFO)
         add_preload_service(self, SERV_BRIDGING_STATE)
+
+    def setup_message(self):
+        """Prevent print of pyhap setup message to terminal."""
+        pass
+
+    def add_paired_client(self, client_uuid, client_public):
+        """Override super function to dismiss setup message if paired."""
+        super().add_paired_client(client_uuid, client_public)
+        dismiss_setup_message(self._hass)
+
+    def remove_paired_client(self, client_uuid):
+        """Override super function to show setup message if unpaired."""
+        super().remove_paired_client(client_uuid)
+        show_setup_message(self, self._hass)
+
+
+class HomeDriver(AccessoryDriver):
+    """Adapter class for AccessoryDriver."""
+
+    def __init__(self, *args, **kwargs):
+        """Initialize a AccessoryDriver object."""
+        super().__init__(*args, **kwargs)