Sky hub (#5509)

* Added new platform sky_hub

* added env to virtual environment gitingore

* Removed unuseful imports

* BT home hub 5 renamed to sky hub in the comments

* Added sky_hub to .coveragerc

* Added example configuration in sky_hub docstring

* sky_hub made compliant with test style standards

* homehub functions renamed to skyhub

* Update .gitignore

* Update .coveragerc

.coveragerc

@@ -168,6 +168,7 @@ omit =
     homeassistant/components/device_tracker/netgear.py
     homeassistant/components/device_tracker/nmap_tracker.py
     homeassistant/components/device_tracker/ping.py
+    homeassistant/components/device_tracker/sky_hub.py
     homeassistant/components/device_tracker/snmp.py
     homeassistant/components/device_tracker/swisscom.py
     homeassistant/components/device_tracker/thomson.py

homeassistant/components/device_tracker/sky_hub.py

@@ -0,0 +1,130 @@
+"""
+Support for Sky Hub.
+
+# Example configuration.yaml entry
+device_tracker:
+  - platform: sky_hub
+    host: 192.168.1.254
+"""
+import logging
+import re
+import threading
+from datetime import timedelta
+
+import requests
+import voluptuous as vol
+
+import homeassistant.helpers.config_validation as cv
+from homeassistant.components.device_tracker import (
+    DOMAIN, PLATFORM_SCHEMA, DeviceScanner)
+from homeassistant.const import CONF_HOST
+from homeassistant.util import Throttle
+
+# Return cached results if last scan was less then this time ago.
+MIN_TIME_BETWEEN_SCANS = timedelta(seconds=10)
+
+_LOGGER = logging.getLogger(__name__)
+
+_MAC_REGEX = re.compile(r'(([0-9A-Fa-f]{1,2}\:){5}[0-9A-Fa-f]{1,2})')
+
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+    vol.Required(CONF_HOST): cv.string
+})
+
+
+# pylint: disable=unused-argument
+def get_scanner(hass, config):
+    """Return a Sky Hub 5 scanner if successful."""
+    scanner = SkyHubDeviceScanner(config[DOMAIN])
+
+    return scanner if scanner.success_init else None
+
+
+class SkyHubDeviceScanner(DeviceScanner):
+    """This class queries a Sky Hub router."""
+
+    def __init__(self, config):
+        """Initialise the scanner."""
+        _LOGGER.info('Initialising Sky Hub')
+        self.host = config.get(CONF_HOST, '192.168.1.254')
+
+        self.lock = threading.Lock()
+
+        self.last_results = {}
+
+        self.url = 'http://{}/'.format(self.host)
+
+        # Test the router is accessible
+        data = _get_skyhub_data(self.url)
+        self.success_init = data is not None
+
+    def scan_devices(self):
+        """Scan for new devices and return a list with found device IDs."""
+        self._update_info()
+
+        return (device for device in self.last_results)
+
+    def get_device_name(self, device):
+        """Return the name of the given device or None if we don't know."""
+        with self.lock:
+            # If not initialised and not already scanned and not found.
+            if device not in self.last_results:
+                self._update_info()
+
+                if not self.last_results:
+                    return None
+
+            return self.last_results.get(device)
+
+    @Throttle(MIN_TIME_BETWEEN_SCANS)
+    def _update_info(self):
+        """Ensure the information from the Sky Hub is up to date.
+
+        Return boolean if scanning successful.
+        """
+        if not self.success_init:
+            return False
+
+        with self.lock:
+            _LOGGER.info('Scanning')
+
+            data = _get_skyhub_data(self.url)
+
+            if not data:
+                _LOGGER.warning('Error scanning devices')
+                return False
+
+            self.last_results = data
+
+            return True
+
+
+def _get_skyhub_data(url):
+    """Retrieve data from Sky Hub and return parsed result."""
+    try:
+        response = requests.get(url, timeout=5)
+    except requests.exceptions.Timeout:
+        _LOGGER.exception("Connection to the router timed out")
+        return
+    if response.status_code == 200:
+        return _parse_skyhub_response(response.text)
+    else:
+        _LOGGER.error("Invalid response from Sky Hub: %s", response)
+
+
+def _parse_skyhub_response(data_str):
+    """Parse the Sky Hub data format."""
+    pattmatch = re.search('attach_dev = \'(.*)\'', data_str)
+    patt = pattmatch.group(1)
+
+    dev = [patt1.split(',') for patt1 in patt.split('<lf>')]
+
+    devices = {}
+    for dvc in dev:
+        if _MAC_REGEX.match(dvc[1]):
+            devices[dvc[1]] = dvc[0]
+        else:
+            raise RuntimeError('Error: MAC address ' + dvc[1] +
+                               ' not in correct format.')
+
+    return devices