Moved ihc platform to sub folder and optimizations for faster startup

Author: dingusdk

custom_components/binary_sensor/ihc.py

@@ -1,15 +1,15 @@
 """
 IHC binary sensor platform.
 """
-# pylint: disable=too-many-arguments, too-many-instance-attributes, bare-except
+# pylint: disable=too-many-arguments, too-many-instance-attributes, bare-except, missing-docstring
 import logging
-import xml.etree.ElementTree
 import voluptuous as vol
 import homeassistant.helpers.config_validation as cv
 from homeassistant.components.binary_sensor import (
     BinarySensorDevice, PLATFORM_SCHEMA, DEVICE_CLASSES_SCHEMA)
 from homeassistant.const import STATE_UNKNOWN, CONF_NAME, CONF_TYPE
-from ..ihc import IHCDevice, get_ihc_instance
+from ..ihc import get_ihc_platform
+from ..ihc.ihcdevice import IHCDevice
 
 DEPENDENCIES = ['ihc']
 
@@ -72,10 +72,10 @@
 # pylint: disable=unused-argument
 def setup_platform(hass, config, add_devices, discovery_info=None):
     """Set up the IHC binary setsor platform."""
-    ihccontroller = get_ihc_instance(hass)
+    ihcplatform = get_ihc_platform(hass)
     devices = []
     if config.get(CONF_AUTOSETUP):
-        auto_setup(ihccontroller, devices)
+        auto_setup(ihcplatform, devices)
 
     ids = config.get(CONF_IDS)
     if ids != None:
@@ -85,30 +85,22 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
             name = data[CONF_NAME]
             sensortype = sensortype = data[CONF_TYPE] if CONF_TYPE in data else None
             inverting = data[CONF_INVERTING] if CONF_INVERTING in data else False
-            add_sensor(devices, ihccontroller, int(ihcid), name, sensortype, True, inverting)
+            add_sensor(devices, ihcplatform.ihc, int(ihcid), name, sensortype, True, inverting)
 
     add_devices(devices)
     # Start notification after devices has been added
     for device in devices:
-        device.ihc.add_notify_event(device.get_ihcid(), device.on_ihc_change)
+        device.ihc.add_notify_event(device.get_ihcid(), device.on_ihc_change, True)
 
-def auto_setup(ihccontroller, devices):
+def auto_setup(ihcplatform, devices):
     """auto setup ihc binary sensors from ihc project."""
     _LOGGER.info("Auto setup - IHC Binary sensors")
-    project = ihccontroller.get_project()
-    xdoc = xml.etree.ElementTree.fromstring(project)
-    groups = xdoc.findall(r'.//group')
-    for group in groups:
-        groupname = group.attrib['name']
-        for productcfg in PRODUCTAUTOSETUP:
-            products = group.findall(productcfg['xpath'])
-            for product in products:
-                node = product.find(productcfg['node'])
-                ihcid = int(node.attrib['id'].strip('_'), 0)
-                name = groupname + "_" + str(ihcid)
-                add_sensor_from_node(devices, ihccontroller, ihcid, name,
-                                     product, productcfg['type'],
-                                     productcfg['inverting'])
+    def setup_product(ihcid, name, product, productcfg):
+        add_sensor_from_node(devices, ihcplatform.ihc, ihcid, name,
+                             product, productcfg['type'],
+                             productcfg['inverting'])
+    ihcplatform.autosetup(PRODUCTAUTOSETUP, setup_product)
+
 
 class IHCBinarySensor(IHCDevice, BinarySensorDevice):
     """IHC Binary Sensor."""

custom_components/ihc.py

@@ -0,0 +1,125 @@
+"""
+IHC platform.
+"""
+# pylint: disable=too-many-arguments, too-many-instance-attributes, bare-except
+import time
+import logging
+import os.path
+import asyncio
+import xml.etree.ElementTree
+import voluptuous as vol
+
+import homeassistant.helpers.config_validation as cv
+from homeassistant.const import CONF_URL, CONF_USERNAME, CONF_PASSWORD
+from homeassistant.config import load_yaml_config_file
+
+from . import const
+
+REQUIREMENTS = ['ihcsdk==2.1.0']
+DOMAIN = 'ihc'
+
+CONF_INFO = 'info'
+
+CONFIG_SCHEMA = vol.Schema({
+    DOMAIN: vol.Schema({
+        vol.Required(CONF_URL): cv.string,
+        vol.Required(CONF_USERNAME): cv.string,
+        vol.Required(CONF_PASSWORD): cv.string,
+        vol.Required(CONF_INFO): cv.boolean
+    }),
+}, extra=vol.ALLOW_EXTRA)
+
+_LOGGER = logging.getLogger(__name__)
+
+def setup(hass, config):
+    """Setyp the IHC platform."""
+    from ihcsdk.ihccontroller import IHCController
+    url = config[DOMAIN].get(CONF_URL)
+    username = config[DOMAIN].get(CONF_USERNAME)
+    password = config[DOMAIN].get(CONF_PASSWORD)
+    ihc = IHCController(url, username, password)
+    ihc.info = config[DOMAIN].get(CONF_INFO)
+
+    if  not ihc.authenticate():
+        _LOGGER.error("Unable to authenticate on ihc controller. Username/password may be wrong")
+        return False
+
+    hass.data[DOMAIN] = IHCPlatform(ihc)
+
+    #Service functions
+
+    def set_runtime_value_bool(call):
+        """Set a IHC runtime bool value service function """
+        ihcid = int(call.data.get('ihcid', 0))
+        value = bool(call.data.get('value', 0))
+        ihc.set_runtime_value_bool(ihcid, value)
+
+    def set_runtime_value_int(call):
+        """Set a IHC runtime integer value service function """
+        ihcid = int(call.data.get('ihcid', 0))
+        value = int(call.data.get('value', 0))
+        ihc.set_runtime_value_int(ihcid, value)
+
+    def set_runtime_value_float(call):
+        """Set a IHC runtime float value service function """
+        ihcid = int(call.data.get('ihcid', 0))
+        value = float(call.data.get('value', 0))
+        ihc.set_runtime_value_float(ihcid, value)
+
+    descriptions = load_yaml_config_file(
+        os.path.join(os.path.dirname(__file__), 'services.yaml'))
+
+    hass.services.register(DOMAIN, const.SERVICE_SET_RUNTIME_VALUE_BOOL,
+                           set_runtime_value_bool,
+                           descriptions[const.SERVICE_SET_RUNTIME_VALUE_BOOL])
+    hass.services.register(DOMAIN, const.SERVICE_SET_RUNTIME_VALUE_INT,
+                           set_runtime_value_int,
+                           descriptions[const.SERVICE_SET_RUNTIME_VALUE_INT])
+    hass.services.register(DOMAIN, const.SERVICE_SET_RUNTIME_VALUE_FLOAT,
+                           set_runtime_value_float,
+                           descriptions[const.SERVICE_SET_RUNTIME_VALUE_FLOAT])
+
+    #hass.http.register_view(IHCSetupView())
+    return True
+
+
+
+class IHCPlatform:
+    """Wraps the IHCController for caching of ihc project and autosetup"""
+    def __init__(self, ihccontroller):
+        self.ihc = ihccontroller
+        project = self.ihc.get_project()
+        self._project = xml.etree.ElementTree.fromstring(project)
+        self._groups = self._project.findall(r'.//group')
+
+    def get_project_xml(self):
+        """Get the cached ihc project as xml"""
+        return self._project
+
+    def get_groups_xml(self):
+        """Get the groups from the ihc project and cache the result"""
+        return self._groups
+
+    def autosetup(self, productautosetup, callback):
+        """Do autosetup of a component usign the specified productautosetup"""
+        groups = self.get_groups_xml()
+        for group in groups:
+            groupname = group.attrib['name']
+            for productcfg in productautosetup:
+                products = group.findall(productcfg['xpath'])
+                for product in products:
+                    nodes = product.findall(productcfg['node'])
+                    for node in nodes:
+                        if 'setting' in node.attrib and node.attrib['setting'] == 'yes':
+                            continue
+                        ihcid = int(node.attrib['id'].strip('_'), 0)
+                        name = groupname + "_" + str(ihcid)
+                        callback(ihcid, name, product, productcfg)
+
+def get_ihc_platform(hass) -> IHCPlatform:
+    """Get the ihc platform instance from the hass configuration
+    This is a singleton object.
+    """
+    while not DOMAIN in hass.data:
+        time.sleep(0.1)
+    return hass.data[DOMAIN]

custom_components/ihc/__init__.py

@@ -0,0 +1,7 @@
+"""
+IHC platform constants
+"""
+
+SERVICE_SET_RUNTIME_VALUE_BOOL = "set_runtime_value_bool"
+SERVICE_SET_RUNTIME_VALUE_INT = "set_runtime_value_int"
+SERVICE_SET_RUNTIME_VALUE_FLOAT = "set_runtime_value_float"

custom_components/ihc/const.py

@@ -0,0 +1,36 @@
+# pylint: disable=missing-docstring, too-many-arguments
+
+class IHCDevice:
+    """Base class for all ihc devices"""
+    def __init__(self, ihccontroller, name, ihcid, ihcname: str, ihcnote: str, ihcposition: str):
+        self.ihc = ihccontroller
+        self._name = name
+        self._ihcid = ihcid
+        self.ihcname = ihcname
+        self.ihcnote = ihcnote
+        self.ihcposition = ihcposition
+
+    @property
+    def name(self):
+        """Return the device name"""
+        return self._name
+
+    def get_ihcid(self) -> int:
+        """Return the ihc resource id."""
+        return self._ihcid
+
+    def set_name(self, name):
+        """Set the name"""
+        self._name = name
+
+    @property
+    def device_state_attributes(self):
+        """Return the state attributes."""
+        if not self.ihc.info:
+            return {}
+        return {
+            'ihcid': self._ihcid,
+            'ihcname' : self.ihcname,
+            'ihcnote' : self.ihcnote,
+            'ihcposition' : self.ihcposition
+        }

custom_components/ihc/ihcdevice.py

@@ -0,0 +1,26 @@
+# Describes the format for available ihc services
+
+set_runtime_value_bool:
+  description: Set a boolean runtime value on the ihc controller
+  fields:
+    ihcid:
+      description: The integer ihc resource id
+    value:
+      description: The boolean value to set
+
+set_runtime_value_int:
+  description: Set a integer runtime value on the ihc controller
+  fields:
+    ihcid:
+      description: The integer ihc resource id
+    value:
+      description: The integer value to set
+
+set_runtime_value_float:
+  description: Set a float runtime value on the ihc controller
+  fields:
+    ihcid:
+      description: The integer ihc resource id
+    value:
+      description: The float value to set
+