Reorganization to support DeviceFactory

Author: ldotlopez

hnap/__init__.py

@@ -18,12 +18,14 @@
 # USA.
 
 
-from .devices import Motion, Router, Siren, Sound, Water
+from .devices import Camera, DeviceFactory, Motion, Router, Siren, Sound, Water
 from .soapclient import AuthenticationError, MethodCallError
 
 __all__ = [
     "AuthenticationError",
     "MethodCallError",
+    "DeviceFactory",
+    "Camera",
     "Motion",
     "Router",
     "Siren",

hnap/devices.py

@@ -24,27 +24,44 @@
 from .soapclient import MethodCallError, SoapClient
 
 
+def DeviceFactory(hostname, password, username="Admin", port=80, **kwargs):
+    device = SoapClient(hostname, password, username, port)
+    device.authenticate()
+    info = device.device_info()
+
+    module_types = info["ModuleTypes"]
+    if not isinstance(module_types, list):
+        module_types = [module_types]
+
+    if "Audio Renderer" in module_types:
+        cls = Siren
+    # 'Optical Recognition', 'Environmental Sensor', 'Camera']
+    elif "Camera" in module_types:
+        cls = Camera
+    elif "Motion Sensor" in module_types:
+        cls = Motion
+    else:
+        raise TypeError(module_types)
+
+    return cls(hostname, password, username=username, port=port, **kwargs)
+
+
 class _Device(SoapClient):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        self._device_info = {}
+        self._info = None
 
-    def login(self):
-        super().login()
-        info = dict(self.call('GetDeviceSettings'))
-        for k in ['@xmlns', 'SOAPActions', 'GetDeviceSettingsResult']:
-            info.pop(k, None)
+    def authenticate(self):
+        super().authenticate()
+        self._info = self.device_info()
 
-        try:
-            info['ModuleTypes'] = info['ModuleTypes']['string']
-        except KeyError:
-            pass
+    @property
+    def info(self):
+        return self._info
 
-        self._device_info = info
 
-    @property
-    def device_info(self):
-        return self._device_info
+class Camera(_Device):
+    pass
 
 
 class Motion(_Device):

hnap/soapclient.py

@@ -138,14 +138,14 @@ def call(self, method, **parameters):
             res = parsed["soap:Envelope"]["soap:Body"][f"{method}Response"][
                 f"{method}Result"
             ]
+            if res.lower() not in ("ok", "success"):
+                _LOGGER.error(f"{method} returned {res}")
         except KeyError:
             _LOGGER.warning(f"Missing {method}Result key")
-        if res.lower() not in ("ok", "success"):
-            _LOGGER.error(f"{method} returned {res}")
 
         return parsed["soap:Envelope"]["soap:Body"][f"{method}Response"]
 
-    def login(self):
+    def authenticate(self):
         url = self.HNAP_AUTH["url"]
         method = self.HNAP_METHOD
         data = self._build_method_envelope(
@@ -187,7 +187,19 @@ def login(self):
         )
 
         if res["LoginResult"] != "success":
-            raise AuthenticationError()
+            raise AuthenticationError(res["LoginResult"])
+
+    def device_info(self):
+        info = dict(self.call("GetDeviceSettings"))
+        for k in ["@xmlns", "SOAPActions", "GetDeviceSettingsResult"]:
+            info.pop(k, None)
+
+        try:
+            info["ModuleTypes"] = info["ModuleTypes"]["string"]
+        except KeyError:
+            pass
+
+        return info
 
     def device_actions(self):
         idx = len(self.HNAP1_XMLNS)

setup.cfg

@@ -2,7 +2,7 @@
 
 [metadata]
 name = hnap
-version = 0.0.3
+version = 0.0.5
 author = Luis López
 author_email = luis@cuarentaydos.com
 description = Python clients for HNAP devices