Merge pull request #243 from persandstrom/asuswrt

ASUSWRT based routers

.coveragerc

@@ -26,6 +26,7 @@ omit =
     homeassistant/components/*/vera.py
 
     homeassistant/components/browser.py
+    homeassistant/components/device_tracker/asuswrt.py
     homeassistant/components/device_tracker/ddwrt.py
     homeassistant/components/device_tracker/luci.py
     homeassistant/components/device_tracker/netgear.py

README.md

@@ -8,7 +8,7 @@ Check out [the website](https://home-assistant.io) for installation instructions
 
 Examples of devices it can interface it:
 
- * Monitoring connected devices to a wireless router: [OpenWrt](https://openwrt.org/), [Tomato](http://www.polarcloud.com/tomato), [Netgear](http://netgear.com), [DD-WRT](http://www.dd-wrt.com/site/index), [TPLink](http://www.tp-link.us/)
+ * Monitoring connected devices to a wireless router: [OpenWrt](https://openwrt.org/), [Tomato](http://www.polarcloud.com/tomato), [Netgear](http://netgear.com), [DD-WRT](http://www.dd-wrt.com/site/index), [TPLink](http://www.tp-link.us/), [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/)
  * [Philips Hue](http://meethue.com) lights, [WeMo](http://www.belkin.com/us/Products/home-automation/c/wemo-home-automation/) switches, and [Tellstick](http://www.telldus.se/products/tellstick) devices and sensors
  * [Google Chromecasts](http://www.google.com/intl/en/chrome/devices/chromecast), [Music Player Daemon](http://www.musicpd.org/) and [Kodi (XBMC)](http://kodi.tv/)
  * Support for [ISY994](https://www.universal-devices.com/residential/isy994i-series/) (Insteon and X10 devices), [Z-Wave](http://www.z-wave.com/), [Nest Thermostats](https://nest.com/), and [Modbus](http://www.modbus.org/)

homeassistant/components/device_tracker/asuswrt.py

@@ -0,0 +1,167 @@
+"""
+homeassistant.components.device_tracker.asuswrt
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Device tracker platform that supports scanning a ASUSWRT router for device
+presence.
+
+This device tracker needs telnet to be enabled on the router
+
+Configuration:
+
+To use the ASUSWRT tracker you will need to add something like the following
+to your config/configuration.yaml
+
+device_tracker:
+  platform: asuswrt
+  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
+from datetime import timedelta
+import re
+import threading
+import telnetlib
+
+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__)
+
+_LEASES_REGEX = re.compile(
+    r'\w+\s' +
+    r'(?P<mac>(([0-9a-f]{2}[:-]){5}([0-9a-f]{2})))\s' +
+    r'(?P<ip>([0-9]{1,3}[\.]){3}[0-9]{1,3})\s' +
+    r'(?P<host>([^\s]+))')
+
+_IP_NEIGH_REGEX = re.compile(
+    r'(?P<ip>([0-9]{1,3}[\.]){3}[0-9]{1,3})\s' +
+    r'\w+\s' +
+    r'\w+\s' +
+    r'(\w+\s(?P<mac>(([0-9a-f]{2}[:-]){5}([0-9a-f]{2}))))?\s' +
+    r'(?P<status>(\w+))')
+
+
+# pylint: disable=unused-argument
+def get_scanner(hass, config):
+    """ Validates config and returns a DD-WRT scanner. """
+    if not validate_config(config,
+                           {DOMAIN: [CONF_HOST, CONF_USERNAME, CONF_PASSWORD]},
+                           _LOGGER):
+        return None
+
+    scanner = AsusWrtDeviceScanner(config[DOMAIN])
+
+    return scanner if scanner.success_init else None
+
+
+class AsusWrtDeviceScanner(object):
+    """ This class queries a router running ASUSWRT firmware
+    for connected devices. Adapted from DD-WRT scanner.
+    """
+
+    def __init__(self, config):
+        self.host = config[CONF_HOST]
+        self.username = config[CONF_USERNAME]
+        self.password = config[CONF_PASSWORD]
+
+        self.lock = threading.Lock()
+
+        self.last_results = {}
+
+        # Test the router is accessible
+        data = self.get_asuswrt_data()
+        self.success_init = data is not None
+
+    def scan_devices(self):
+        """ Scans for new devices and return a
+            list containing found device ids. """
+
+        self._update_info()
+        return [client['mac'] for client in self.last_results]
+
+    def get_device_name(self, device):
+        """ Returns the name of the given device or None if we don't know. """
+        if not self.last_results:
+            return None
+        for client in self.last_results:
+            if client['mac'] == device:
+                return client['host']
+        return None
+
+    @Throttle(MIN_TIME_BETWEEN_SCANS)
+    def _update_info(self):
+        """ Ensures the information from the ASUSWRT router is up to date.
+            Returns boolean if scanning successful. """
+        if not self.success_init:
+            return False
+
+        with self.lock:
+            _LOGGER.info("Checking ARP")
+            data = self.get_asuswrt_data()
+            if not data:
+                return False
+
+            active_clients = [client for client in data.values() if
+                              client['status'] == 'REACHABLE' or
+                              client['status'] == 'DELAY' or
+                              client['status'] == 'STALE']
+            self.last_results = active_clients
+            return True
+
+    def get_asuswrt_data(self):
+        """ Retrieve data from ASUSWRT and return parsed result.  """
+        try:
+            telnet = telnetlib.Telnet(self.host)
+            telnet.read_until(b'login: ')
+            telnet.write((self.username + '\n').encode('ascii'))
+            telnet.read_until(b'Password: ')
+            telnet.write((self.password + '\n').encode('ascii'))
+            prompt_string = telnet.read_until(b'#').split(b'\n')[-1]
+            telnet.write('ip neigh\n'.encode('ascii'))
+            neighbors = telnet.read_until(prompt_string).split(b'\n')[1:-1]
+            telnet.write('cat /var/lib/misc/dnsmasq.leases\n'.encode('ascii'))
+            leases_result = telnet.read_until(prompt_string).split(b'\n')[1:-1]
+            telnet.write('exit\n'.encode('ascii'))
+        except EOFError:
+            _LOGGER.exception("Unexpected response from router")
+            return
+        except ConnectionRefusedError:
+            _LOGGER.exception("Connection refused by router," +
+                              " is telnet enabled?")
+            return
+
+        devices = {}
+        for lease in leases_result:
+            match = _LEASES_REGEX.search(lease.decode('utf-8'))
+            devices[match.group('ip')] = {
+                'ip': match.group('ip'),
+                'mac': match.group('mac').upper(),
+                'host': match.group('host')
+                }
+
+        for neighbor in neighbors:
+            match = _IP_NEIGH_REGEX.search(neighbor.decode('utf-8'))
+            if match.group('ip') in devices:
+                devices[match.group('ip')]['status'] = match.group('status')
+        return devices