Merge branch 'master' of https://github.com/balloob/netdisco

Author: balloob

netdisco/discoverables/tellstick.py

@@ -0,0 +1,13 @@
+""" Discovers Tellstick devices. """
+
+from . import BaseDiscoverable
+
+
+class Discoverable(BaseDiscoverable):
+    """ Adds support for discovering a Tellstick device. """
+
+    def __init__(self, netdis):
+        self._netdis = netdis
+
+    def get_entries(self):
+        return self._netdis.tellstick.entries

netdisco/discovery.py

@@ -10,6 +10,7 @@
 from .mdns import MDNS
 from .gdm import GDM
 from .lms import LMS
+from .tellstick import Tellstick
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -22,6 +23,7 @@ class NetworkDiscovery(object):
     SSDP scans in the foreground.
     GDM scans in the foreground.
     LMS scans in the foreground.
+    Tellstick scans in the foreground
 
     start: is ready to scan
     scan: scan the network
@@ -37,6 +39,7 @@ def __init__(self, limit_discovery=None):
         self.ssdp = SSDP()
         self.gdm = GDM()
         self.lms = LMS()
+        self.tellstick = Tellstick()
         self.discoverables = {}
 
         self._load_device_support()
@@ -52,6 +55,7 @@ def scan(self):
         self.ssdp.scan()
         self.gdm.scan()
         self.lms.scan()
+        self.tellstick.scan()
 
     def stop(self):
         """ Turn discovery off. """
@@ -124,3 +128,6 @@ def print_raw_data(self):
         print("")
         print("LMS")
         pprint(self.lms.entries)
+        print("")
+        print("Tellstick")
+        pprint(self.tellstick.entries)

netdisco/ssdp.py

@@ -11,7 +11,7 @@
 
 import requests
 
-from .util import etree_to_dict
+from .util import etree_to_dict, interface_addresses
 
 DISCOVER_TIMEOUT = 5
 SSDP_MX = 1
@@ -205,30 +205,33 @@ def scan(st=None, timeout=DISCOVER_TIMEOUT, max_entries=None):
         'ST: {}'.format(ssdp_st),
         '', '']).encode('ascii')
 
-    entries = []
-
-    calc_now = datetime.now
-    start = calc_now()
+    stop_wait = datetime.now() + timedelta(0, timeout)
 
-    try:
+    sockets = []
+    for addr in interface_addresses():
         sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
 
-        sock.sendto(ssdp_request, ssdp_target)
+        # Set the time-to-live for messages for local network
+        sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, 1)
+        sock.bind((addr, 0))
 
-        sock.setblocking(0)
-
-        while True:
-            time_diff = calc_now() - start
+        sockets.append(sock)
 
-            # pylint: disable=maybe-no-member
-            seconds_left = timeout - time_diff.seconds
+    entries = []
+    try:
+        for sock in sockets:
+            sock.sendto(ssdp_request, ssdp_target)
+            sock.setblocking(0)
 
+        while True:
+            time_diff = stop_wait - datetime.now()
+            seconds_left = time_diff.total_seconds()
             if seconds_left <= 0:
-                return entries
+                break
 
-            ready = select.select([sock], [], [], seconds_left)[0]
+            ready = select.select(sockets, [], [], seconds_left)[0]
 
-            if ready:
+            for sock in ready:
                 response = sock.recv(1024).decode("ascii")
 
                 entry = UPNPEntry.from_response(response)
@@ -237,14 +240,18 @@ def scan(st=None, timeout=DISCOVER_TIMEOUT, max_entries=None):
                     entries.append(entry)
 
                     if max_entries and len(entries) == max_entries:
-                        return entries
+                        raise StopIteration
 
     except socket.error:
         logging.getLogger(__name__).exception(
             "Socket error while discovering SSDP devices")
 
+    except StopIteration:
+        pass
+
     finally:
-        sock.close()
+        for sock in sockets:
+            sock.close()
 
     return entries
 

netdisco/tellstick.py

@@ -0,0 +1,58 @@
+"""
+Tellstick device discovery.
+"""
+import socket
+import threading
+from datetime import timedelta
+
+
+DISCOVERY_PORT = 30303
+DISCOVERY_ADDRESS = '<broadcast>'
+DISCOVERY_PAYLOAD = b"D"
+DISCOVERY_TIMEOUT = timedelta(seconds=5)
+
+
+class Tellstick(object):
+    """Base class to discover Tellstick devices."""
+
+    def __init__(self):
+        self.entries = []
+        self._lock = threading.RLock()
+
+    def scan(self):
+        """Scan the network."""
+        with self._lock:
+            self.update()
+
+    def all(self):
+        """Scan and return all found entries."""
+        self.scan()
+        return self.entries
+
+    def update(self):
+        """Scan network for Tellstick devices."""
+        entries = []
+        with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as sock:
+            sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
+            sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+            sock.settimeout(DISCOVERY_TIMEOUT.seconds)
+            sock.sendto(DISCOVERY_PAYLOAD, (DISCOVERY_ADDRESS, DISCOVERY_PORT))
+            while True:
+                try:
+                    data, (address, port) = sock.recvfrom(1024)
+                    entry = data.decode("ascii").split(":")
+                    if len(entry) != 4: # expecting product, mac, activation code, version
+                        continue
+                    entry = (address,) + tuple(entry)
+                    entries.append(entry)
+                except socket.timeout:
+                    break
+
+            self.entries = entries
+
+if __name__ == "__main__":
+    from pprint import pprint
+    tellstick = Tellstick()
+    pprint("Scanning for Tellstick devices..")
+    tellstick.update()
+    pprint(tellstick.entries)

netdisco/util.py

@@ -3,6 +3,8 @@
 """
 from collections import defaultdict
 
+import netifaces
+
 
 # Taken from http://stackoverflow.com/a/10077069
 def etree_to_dict(t):
@@ -29,3 +31,12 @@ def etree_to_dict(t):
         else:
             d[tag_name] = text
     return d
+
+
+def interface_addresses(family=netifaces.AF_INET):
+    """Returns local addresses of any network associated with a local interface
+    that has broadcast (and probably multicast) capability."""
+    return [addr['addr']
+            for i in netifaces.interfaces()
+            for addr in netifaces.ifaddresses(i).get(family) or []
+            if 'broadcast' in addr]

requirements.txt

@@ -1,2 +1,3 @@
 zeroconf>=0.17.4
 requests>=2.0
+netifaces>=0.10.0

setup.py

@@ -7,6 +7,6 @@
       author='Paulus Schoutsen',
       author_email='Paulus@PaulusSchoutsen.nl',
       license='MIT',
-      install_requires=['requests>=2.0', 'zeroconf>=0.17.4'],
+      install_requires=['netifaces>=0.10.0', 'requests>=2.0', 'zeroconf>=0.17.4'],
       packages=find_packages(),
       zip_safe=False)