hue_apiv2: Initial commit - plugin is not feature complete at the moment

hue2/user_doc.rst

@@ -25,7 +25,7 @@ Neue Features
 
 Das Plugin bietet im Vergleich zum **hue** Plugin zusätzlich folgende Features:
 
-- Die Authorisierung an der Hue Bride ist in das Plugin integriert und erfolgt über das Webinferface des Plugins.
+- Die Authorisierung an der Hue Bridge ist in das Plugin integriert und erfolgt über das Webinferface des Plugins.
 - Das Plugin hat eine Funktion um aktive Hue Bridges im lokalen Netzwerk zu finden.
 - Das Plugin unterstützt je Instanz im Gegensatz zum alten Plugin nur eine Bridge. Dafür ist es Multi-Instance fähig,
   so dass bei Einsatz mehrerer Bridges einfach mehrere Instanzen des Plugins konfiguriert werden können.

hue_apiv2/discover_bridges.py

@@ -0,0 +1,289 @@
+#!/usr/bin/env python3
+# vim: set encoding=utf-8 tabstop=4 softtabstop=4 shiftwidth=4 expandtab
+#########################################################################
+#  Copyright 2021-      Martin Sinn                         [email protected]
+#########################################################################
+#  This file is part of the hue plugin for SmartHomeNG.
+#  https://www.smarthomeNG.de
+#  https://knx-user-forum.de/forum/supportforen/smarthome-py
+#
+#  SmartHomeNG is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  SmartHomeNG is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with SmartHomeNG. If not, see <http://www.gnu.org/licenses/>.
+#
+#########################################################################
+
+import socket
+import requests
+import xmltodict
+import logging
+logger = logging.getLogger('discover_bridges')
+
+from datetime import datetime
+import time
+
+
+def get_bridge_desciptrion(ip, port):
+    """
+    Get description of bridge
+
+    :param ip:
+    :param port:
+    :return:
+    """
+    br_info = {}
+
+    protocol = 'http'
+    if str(port) == '443':
+        protocol = 'https'
+
+    requests.packages.urllib3.disable_warnings(requests.packages.urllib3.exceptions.InsecureRequestWarning)
+    r = requests.get(protocol + '://' + ip + ':' + str(port) + '/description.xml', verify=False)
+    if r.status_code == 200:
+        xmldict = xmltodict.parse(r.text)
+        br_info['ip'] = ip
+        br_info['port'] = str(port)
+        br_info['friendlyName'] = str(xmldict['root']['device']['friendlyName'])
+        br_info['manufacturer'] = str(xmldict['root']['device']['manufacturer'])
+        br_info['manufacturerURL'] = str(xmldict['root']['device']['manufacturerURL'])
+        br_info['modelDescription'] = str(xmldict['root']['device']['modelDescription'])
+        br_info['modelName'] = str(xmldict['root']['device']['modelName'])
+        br_info['modelURL'] = str(xmldict['root']['device']['modelURL'])
+        br_info['modelNumber'] = str(xmldict['root']['device']['modelNumber'])
+        br_info['serialNumber'] = str(xmldict['root']['device']['serialNumber'])
+        br_info['UDN'] = str(xmldict['root']['device']['UDN'])
+        br_info['gatewayName'] = str(xmldict['root']['device'].get('gatewayName', ''))
+
+        br_info['URLBase'] = str(xmldict['root']['URLBase'])
+        if br_info['modelName'] == 'Philips hue bridge 2012':
+            br_info['version'] = 'v1'
+        elif br_info['modelName'] == 'Philips hue bridge 2015':
+            br_info['version'] = 'v2'
+        else:
+            br_info['version'] = 'unknown'
+
+    return br_info
+
+
+discovered_bridges = {}    # key: bridge_id, value: {, bridge_id, url_base}
+
+def add_discovered_bridge(ip, port):
+
+    if port == 443:
+        protocol = 'https'
+    else:
+        protocol = 'http'
+    url_base = protocol + '://' + ip + ':' + str(port)
+
+    bridge_id = '?'
+    requests.packages.urllib3.disable_warnings(requests.packages.urllib3.exceptions.InsecureRequestWarning)
+    r = requests.get(url_base + '/description.xml', verify=False)
+    if r.status_code == 200:
+        xmldict = xmltodict.parse(r.text)
+        bridge_id = xmldict['root']['device']['serialNumber']
+
+    if not bridge_id in discovered_bridges.keys():
+        discovered_bridges[bridge_id] = url_base
+
+    return
+
+
+# ======================================================================================
+#    Discover via mDNS
+#
+
+from zeroconf import ServiceBrowser, Zeroconf
+
+class MyListener:
+
+    services = {}
+
+    def remove_service(self, zeroconf, type, name):
+        pass
+
+    def update_service(self, zeroconf, type, name, info):
+        pass
+
+    def add_service(self, zeroconf, type, name):
+        info = zeroconf.get_service_info(type, name)
+        self.services[name] = info
+
+
+def discover_via_mdns():
+
+    zeroconf = Zeroconf()
+    listener = MyListener()
+    t1 = datetime.now()
+    browser = ServiceBrowser(zeroconf, "_hue._tcp.local.", listener)
+
+    time.sleep(2)
+
+    zeroconf.close()
+    t2 = datetime.now()
+
+    for sv in listener.services:
+        service = listener.services[sv]
+
+        ip = socket.gethostbyname(service.server)
+        if service.port == 443:
+            protocol = 'https'
+        else:
+            protocol = 'http'
+        bridge_id = service.properties[b'bridgeid'].decode()
+
+        add_discovered_bridge(ip, service.port)
+
+
+# ======================================================================================
+#    Discover via UPnP
+#
+
+try:
+    from .ssdp import discover as ssdp_discover
+except:
+    from ssdp import discover as ssdp_discover
+
+def discover_via_upnp():
+
+    t1 = datetime.now()
+    ssdp_list = ssdp_discover("ssdp:all", timeout=10)
+    t2 = datetime.now()
+
+    devices = [u for u in ssdp_list if (u.server is not None and 'IpBridge' in u.server)]
+    for d in devices:
+        ip_port = d.location.split('/')[2]
+        ip = ip_port.split(':')[0]
+        port = ip_port.split(':')[1]
+
+        add_discovered_bridge(ip, port)
+
+
+# ======================================================================================
+#    Discover via Signify broker server
+#
+
+def discover_via_broker():
+
+    import json
+
+    requests.packages.urllib3.disable_warnings(requests.packages.urllib3.exceptions.InsecureRequestWarning)
+    try:
+        r = requests.get('https://discovery.meethue.com', verify=False)
+        if r.status_code == 200:
+            bridge_list = json.loads(r.text)
+            for br in bridge_list:
+                ip = br['internalipaddress']
+                port = 443
+                add_discovered_bridge(ip, port)
+        else:
+            logger.error(f"Problem at broker server: {r.status_code}")
+    except Exception as e:
+        logger.error(f"Problem at broker url: {e}")
+    return
+
+
+# ======================================================================================
+#    Discover Hue bridges
+#
+
+def discover_bridges_by_method(mdns=True, upnp=True, broker=False, httponly=True):
+
+    global discovered_bridges
+    discovered_bridges = {}
+
+    if mdns:
+        discover_via_mdns()
+    if upnp:
+        discover_via_upnp()
+    if broker:
+        discover_via_broker()
+
+    if httponly:
+        for br_id in discovered_bridges:
+            discovered_bridges[br_id] = discovered_bridges[br_id].replace(':443', ':80')
+
+    return discovered_bridges
+
+
+def discover_bridges(upnp=False, httponly=False):
+
+    upnp_discovered_bridges = {}
+    if upnp:
+        # discover via upnp
+        discover_bridges_by_method(mdns=False, upnp=True, broker=False, httponly=httponly)
+        upnp_discovered_bridges = discovered_bridges.copy()
+
+    # discover via mDNS
+    discover_bridges_by_method(mdns=True, upnp=False, broker=False, httponly=httponly)
+    if discovered_bridges != {}:
+        if upnp_discovered_bridges != {}:
+            for key, value in upnp_discovered_bridges.items():
+                discovered_bridges[key] = value
+        return discovered_bridges
+
+    # discover via broker server
+    discover_bridges_by_method(mdns=False, upnp=False, broker=True, httponly=httponly)
+    if discovered_bridges != {}:
+        if upnp_discovered_bridges != {}:
+            for key, value in upnp_discovered_bridges.items():
+                discovered_bridges[key] = value
+        return discovered_bridges
+
+    return discovered_bridges
+
+
+def test_all_methods():
+
+    discover_bridges_by_method(mdns=False, upnp=False, broker=True, httponly=False)
+    print("\nDiscover via broker")
+    for br_id in discovered_bridges:
+        print(f"  {br_id}: {discovered_bridges[br_id]}")
+
+    discover_bridges_by_method(mdns=False, upnp=False, broker=True, httponly=True)
+    print("\nDiscover via broker (http-only):")
+    for br_id in discovered_bridges:
+        print(f"  {br_id}: {discovered_bridges[br_id]}")
+
+    discover_bridges_by_method(upnp=False, broker=False, httponly=False)
+    print("\nDiscover mDNS")
+    for br_id in discovered_bridges:
+        print(f"  {br_id}: {discovered_bridges[br_id]}")
+
+    discover_bridges_by_method(upnp=False, broker=False)
+    print("\nDiscover mDNS (http-only):")
+    for br_id in discovered_bridges:
+        print(f"  {br_id}: {discovered_bridges[br_id]}")
+
+    from ssdp import discover as ssdp_discover
+
+    discover_bridges_by_method(mdns=False, broker=False, httponly=False)
+    print("\nDiscover upnp")
+    for br_id in discovered_bridges:
+        print(f"  {br_id}: {discovered_bridges[br_id]}")
+
+    discover_bridges_by_method(mdns=False, broker=False)
+    print("\nDiscover upnp (http-only):")
+    for br_id in discovered_bridges:
+        print(f"  {br_id}: {discovered_bridges[br_id]}")
+
+    discover_bridges_by_method(broker=True)
+    print("\nDiscover all:")
+    for br_id in discovered_bridges:
+        print(f"  {br_id}: {discovered_bridges[br_id]}")
+
+
+if __name__ == '__main__':
+
+    my_discovered_bridges = discover_bridges(upnp=True, httponly=True)
+    print("\nDiscover all:")
+    for br_id in my_discovered_bridges:
+        print(f"  {br_id}: {my_discovered_bridges[br_id]}")

hue_apiv2/locale.yaml

@@ -0,0 +1,26 @@
+# translations for the web interface
+plugin_translations:
+    # Translations for the plugin specially for the web interface
+    'Bridge suchen':         {'de': '=', 'en': 'Look for Bridge'}
+    'Gefundene Bridges':     {'de': '=', 'en': 'Discovered Bridges'}
+    'Verbinden':             {'de': '=', 'en': 'Connect'}
+    'Serien-Nr.':            {'de': '=', 'en': 'Serial'}
+    'Hersteller':            {'de': '=', 'en': 'Manufacturer'}
+    'Version':               {'de': '=', 'en': '='}
+    'Modell Name':           {'de': '=', 'en': 'Model Name'}
+    'Modell Nr.':            {'de': '=', 'en': 'Model No'}
+    'IP':                    {'de': '=', 'en': 'IP address'}
+    'UDN':                   {'de': '=', 'en': '='}
+    'Konfigurierte Bridge':  {'de': '=', 'en': 'Configured Bridges'}
+    'Anwendungsschlüssel':   {'de': '=', 'en': 'Application Key'}
+    'True':                  {'de':'Ja', 'en': 'Yes'}
+    'False':                 {'de':'Nein', 'en': 'No'}
+
+    # Alternative format for translations of longer texts:
+    'Es ist keine Bridge mit dieser Plugin Instanz verbunden.':
+        de: '='
+        en: 'No bridge is commected to this plugin instance.'
+    'Zum Verbinden den Knopf an der Hue Bridge drücken und anschließend in der Liste der gefundenen Bridges den Button "Verbinden" drücken.':
+        de: '='
+        en: 'To connect first press the link button on the hue bridge and then press the button "Connect" in the list of found bridges.'
+