Add support for TP-Link ArcherC9 to to device tracker component

homeassistant/components/device_tracker/tplink2.py

@@ -0,0 +1,128 @@
+"""
+homeassistant.components.device_tracker.tplink2
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Device tracker platform that supports scanning a newer model TP-Link router for device
+presence.
+
+Configuration:
+
+To use the TP-Link tracker you will need to add something like the following
+to your config/configuration.yaml
+
+device_tracker:
+  platform: tplink2
+  host: YOUR_ROUTER_IP
+  username: YOUR_ADMIN_USERNAME
+  password: YOUR_ADMIN_PASSWORD
+
+Variables:
+
+host
+*Required
+The IP address of your router, e.g. 192.168.1.1.
+
+username
+*Required
+The username of an user with administrative privileges, usually 'admin'.
+
+password
+*Required
+The password for your given admin account.
+
+"""
+import logging
+import base64
+from datetime import timedelta
+import threading
+import requests
+
+from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD
+from homeassistant.helpers import validate_config
+from homeassistant.util import Throttle
+from homeassistant.components.device_tracker import DOMAIN
+
+# Return cached results if last scan was less then this time ago
+MIN_TIME_BETWEEN_SCANS = timedelta(seconds=5)
+
+_LOGGER = logging.getLogger(__name__)
+
+
+def get_scanner(hass, config):
+    """ Validates config and returns a TP-Link scanner. """
+    if not validate_config(config,
+                           {DOMAIN: [CONF_HOST, CONF_USERNAME, CONF_PASSWORD]},
+                           _LOGGER):
+        return None
+
+    scanner = Tplink2DeviceScanner(config[DOMAIN])
+
+    return scanner if scanner.success_init else None
+
+
+class Tplink2DeviceScanner(object):
+    """ This class queries a wireless router running TP-Link firmware
+    for connected devices.
+    """
+
+    def __init__(self, config):
+        host = config[CONF_HOST]
+        username, password = config[CONF_USERNAME], config[CONF_PASSWORD]
+
+        self.host = host
+        self.username = username
+        self.password = password
+
+        self.last_results = {}
+        self.lock = threading.Lock()
+        self.success_init = self._update_info()
+
+    def scan_devices(self):
+        """ Scans for new devices and return a
+            list containing found device ids. """
+
+        self._update_info()
+        return self.last_results.keys()
+
+    # pylint: disable=no-self-use
+    def get_device_name(self, device):
+        """ The TP-Link firmware doesn't save the name of the wireless
+            device. """
+
+        return self.last_results.get(device)
+
+    @Throttle(MIN_TIME_BETWEEN_SCANS)
+    def _update_info(self):
+        """ Ensures the information from the TP-Link router is up to date.
+            Returns boolean if scanning successful. """
+
+        with self.lock:
+            _LOGGER.info("Loading wireless clients...")
+
+            url = 'http://{}/data/map_access_wireless_client_grid.json'.format(self.host)
+            referer = 'http://{}'.format(self.host)
+
+            # Router uses Authorization cookie instead of header
+            # Let's create the cookie
+            username_password = '{}:{}'.format(self.username, self.password)
+            b64_encoded_username_password = base64.b64encode(
+                username_password.encode('ascii')
+            ).decode('ascii')
+            authorization = 'Basic {}'.format(b64_encoded_username_password)
+            cookie = 'Authorization={}'.format(authorization)
+
+            response = requests.post(url, headers={'referer': referer,
+                                                   'cookie': cookie})
+
+            result = None
+            try:
+                result = response.json().get('data')
+            except ValueError:
+                _LOGGER.error("Router didn't respond with JSON. Check if credentials are correct.")
+
+            if result:
+                self.last_results = {device['mac_addr'].replace('-', ':'): device['name']
+                                     for device in result}
+                return True
+
+            return False