Device Tracker for Linksys Access Points (home-assistant#4933)

* Implementation for Linksys Access Points

* update .coveragerc

* update requirements

* add default timeout of 10sec

* address lint issues

Author: lukas-hetzenecker

.coveragerc

@@ -167,6 +167,7 @@ omit =
     homeassistant/components/device_tracker/fritz.py
     homeassistant/components/device_tracker/gpslogger.py
     homeassistant/components/device_tracker/icloud.py
+    homeassistant/components/device_tracker/linksys_ap.py
     homeassistant/components/device_tracker/luci.py
     homeassistant/components/device_tracker/netgear.py
     homeassistant/components/device_tracker/nmap_tracker.py

homeassistant/components/device_tracker/linksys_ap.py

@@ -0,0 +1,108 @@
+"""
+Support for Linksys Access Points.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/device_tracker.linksys_ap/
+"""
+import base64
+import logging
+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
+from homeassistant.const import (CONF_HOST, CONF_PASSWORD, CONF_USERNAME,
+                                 CONF_VERIFY_SSL)
+from homeassistant.util import Throttle
+
+# Return cached results if last scan was less then this time ago.
+MIN_TIME_BETWEEN_SCANS = timedelta(seconds=5)
+INTERFACES = 2
+DEFAULT_TIMEOUT = 10
+
+REQUIREMENTS = ['beautifulsoup4==4.5.3']
+
+_LOGGER = logging.getLogger(__name__)
+
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+    vol.Required(CONF_HOST): cv.string,
+    vol.Required(CONF_PASSWORD): cv.string,
+    vol.Required(CONF_USERNAME): cv.string,
+    vol.Optional(CONF_VERIFY_SSL, default=True): cv.boolean,
+})
+
+
+def get_scanner(hass, config):
+    """Validate the configuration and return a Linksys AP scanner."""
+    try:
+        return LinksysAPDeviceScanner(config[DOMAIN])
+    except ConnectionError:
+        return None
+
+
+class LinksysAPDeviceScanner(object):
+    """This class queries a Linksys Access Point."""
+
+    def __init__(self, config):
+        """Initialize the scanner."""
+        self.host = config[CONF_HOST]
+        self.username = config[CONF_USERNAME]
+        self.password = config[CONF_PASSWORD]
+        self.verify_ssl = config[CONF_VERIFY_SSL]
+
+        self.lock = threading.Lock()
+        self.last_results = []
+
+        # Check if the access point is accessible
+        response = self._make_request()
+        if not response.status_code == 200:
+            raise ConnectionError('Cannot connect to Linksys Access Point')
+
+    def scan_devices(self):
+        """Scan for new devices and return a list with found device IDs."""
+        self._update_info()
+
+        return self.last_results
+
+    # pylint: disable=no-self-use
+    def get_device_name(self, mac):
+        """
+        Return the name (if known) of the device.
+
+        Linksys does not provide an API to get a name for a device,
+        so we just return None
+        """
+        return None
+
+    @Throttle(MIN_TIME_BETWEEN_SCANS)
+    def _update_info(self):
+        """Check for connected devices."""
+        from bs4 import BeautifulSoup as BS
+
+        with self.lock:
+            _LOGGER.info('Checking Linksys AP')
+
+            self.last_results = []
+            for interface in range(INTERFACES):
+                request = self._make_request(interface)
+                self.last_results.extend(
+                    [x.find_all('td')[1].text
+                     for x in BS(request.content, "html.parser")
+                     .find_all(class_='section-row')]
+                )
+
+            return True
+
+    def _make_request(self, unit=0):
+        # No, the '&&' is not a typo - this is expected by the web interface.
+        login = base64.b64encode(bytes(self.username, 'utf8')).decode('ascii')
+        pwd = base64.b64encode(bytes(self.password, 'utf8')).decode('ascii')
+        return requests.get(
+            'https://%s/StatusClients.htm&&unit=%s&vap=0' % (self.host, unit),
+            timeout=DEFAULT_TIMEOUT,
+            verify=self.verify_ssl,
+            cookies={'LoginName': login,
+                     'LoginPWD': pwd})

requirements_all.txt

@@ -59,6 +59,7 @@ astral==1.3.3
 # homeassistant.components.sensor.linux_battery
 batinfo==0.4.2
 
+# homeassistant.components.device_tracker.linksys_ap
 # homeassistant.components.sensor.hydroquebec
 # homeassistant.components.sensor.scrape
 beautifulsoup4==4.5.3