Ease netatmo comm debugging as suggested in #31

Author: philippelt

lnetatmo.py

@@ -18,9 +18,13 @@
 import json, time
 import imghdr
 import warnings
+import logging
+
+# Just in case method could change
+PYTHON3 = (version_info.major > 2)
 
 # HTTP libraries depends upon Python 2 or 3
-if version_info.major == 3 :
+if PYTHON3 :
     import urllib.parse, urllib.request
 else:
     from urllib import urlencode
@@ -38,15 +42,18 @@
 #  1 - Values hard coded in the library
 #  2 - The .netatmo.credentials file in JSON format in your home directory
 #  3 - Values defined in environment variables : CLIENT_ID, CLIENT_SECRET, USERNAME, PASSWORD
+#      Note: The USERNAME environment variable may interfer with the envvar used by Windows for login name
+#            if you have this issue, do not forget to "unset USERNAME" before running your program
 
 # Each level override values defined in the previous level. You could define CLIENT_ID and CLIENT_SECRET hard coded in the library
 # and username/password in .netatmo.credentials or environment variables
 
-cred = {                       # You can hard code authentication information in the following lines
-        "CLIENT_ID" :  "",     #   Your client ID from Netatmo app registration at http://dev.netatmo.com/dev/listapps
-        "CLIENT_SECRET" : "",  #   Your client app secret   '     '
-        "USERNAME" : "",       #   Your netatmo account username
-        "PASSWORD" : ""        #   Your netatmo account password
+# 1 : Embedded credentials
+cred = {                           # You can hard code authentication information in the following lines
+        "CLIENT_ID" :  "",         #   Your client ID from Netatmo app registration at http://dev.netatmo.com/dev/listapps
+        "CLIENT_SECRET" : "",      #   Your client app secret   '     '
+        "USERNAME" : "",           #   Your netatmo account username
+        "PASSWORD" : ""            #   Your netatmo account password
         }
 
 # Other authentication setup management (optionals)
@@ -114,6 +121,10 @@ def getParameter(key, default):
 #_CAM_FTP_ACTIVE        = "/command/ftp_set_config?config=on_off:%s"   # "on"|"off"
 
 
+# Logger context
+logger = logging.getLogger("lnetatmo")
+
+
 class NoDevice( Exception ):
     pass
 
@@ -580,7 +591,7 @@ def personSeenByCamera(self, name, home=None, camera=None):
         try:
             cam_id = self.cameraByName(camera=camera, home=home)['id']
         except TypeError:
-            print("personSeenByCamera: Camera name or home is unknown")
+            logger.warning("personSeenByCamera: Camera name or home is unknown")
             return False
         #Check in the last event is someone known has been seen
         if self.lastEvent[cam_id]['type'] == 'person':
@@ -604,7 +615,7 @@ def someoneKnownSeen(self, home=None, camera=None):
         try:
             cam_id = self.cameraByName(camera=camera, home=home)['id']
         except TypeError:
-            print("personSeenByCamera: Camera name or home is unknown")
+            logger.warning("personSeenByCamera: Camera name or home is unknown")
             return False
         #Check in the last event is someone known has been seen
         if self.lastEvent[cam_id]['type'] == 'person':
@@ -619,7 +630,7 @@ def someoneUnknownSeen(self, home=None, camera=None):
         try:
             cam_id = self.cameraByName(camera=camera, home=home)['id']
         except TypeError:
-            print("personSeenByCamera: Camera name or home is unknown")
+            logger.warning("personSeenByCamera: Camera name or home is unknown")
             return False
         #Check in the last event is someone known has been seen
         if self.lastEvent[cam_id]['type'] == 'person':
@@ -634,7 +645,7 @@ def motionDetected(self, home=None, camera=None):
         try:
             cam_id = self.cameraByName(camera=camera, home=home)['id']
         except TypeError:
-            print("personSeenByCamera: Camera name or home is unknown")
+            logger.warning("personSeenByCamera: Camera name or home is unknown")
             return False
         if self.lastEvent[cam_id]['type'] == 'movement':
             return True
@@ -697,14 +708,15 @@ def cameraCommand(cameraUrl, commande, parameters=None, timeout=3):
     return postRequest(url, timeout=timeout)
 
 def postRequest(url, params=None, timeout=10):
-    if version_info.major == 3:
+    if PYTHON3:
         req = urllib.request.Request(url)
         if params:
             req.add_header("Content-Type","application/x-www-form-urlencoded;charset=utf-8")
             params = urllib.parse.urlencode(params).encode('utf-8')
         try:
             resp = urllib.request.urlopen(req, params, timeout=timeout) if params else urllib.request.urlopen(req, timeout=timeout)
-        except urllib.error.URLError:
+        except urllib.error.HTTPError as err:
+            logger.error("code=%s, reason=%s" % (err.code, err.reason))
             return None
     else:
         if params:
@@ -713,12 +725,13 @@ def postRequest(url, params=None, timeout=10):
         req = urllib2.Request(url=url, data=params, headers=headers) if params else urllib2.Request(url)
         try:
             resp = urllib2.urlopen(req, timeout=timeout)
-        except urllib2.URLError:
+        except urllib2.HTTPError as err:
+            logger.error("code=%s, reason=%s" % (err.code, err.reason))
             return None
     data = b""
     for buff in iter(lambda: resp.read(65535), b''): data += buff
     # Return values in bytes if not json data to handle properly camera images
-    returnedContentType = resp.getheader("Content-Type") if version_info.major == 3 else resp.info()["Content-Type"]
+    returnedContentType = resp.getheader("Content-Type") if PYTHON3 else resp.info()["Content-Type"]
     return json.loads(data.decode("utf-8")) if "application/json" in returnedContentType else data
 
 def toTimeString(value):
@@ -761,6 +774,8 @@ def getStationMinMaxTH(station=None, module=None):
 if __name__ == "__main__":
 
     from sys import exit, stdout, stderr
+    
+    logging.basicConfig(format='%(name)s - %(levelname)s: %(message)s', level=logging.INFO)
 
     if not _CLIENT_ID or not _CLIENT_SECRET or not _USERNAME or not _PASSWORD :
            stderr.write("Library source missing identification arguments to check lnetatmo.py (user/password/etc...)")
@@ -771,28 +786,22 @@ def getStationMinMaxTH(station=None, module=None):
     try:
         weatherStation = WeatherStationData(authorization)         # Test DEVICELIST
     except NoDevice:
-        if stdout.isatty():
-            print("lnetatmo.py : warning, no weather station available for testing")
+        logger.warning("No weather station available for testing")
     else:
         weatherStation.MinMaxTH()                          # Test GETMEASUR
 
 
     try:
         homes = HomeData(authorization)
     except NoDevice :
-        if stdout.isatty():
-            print("lnetatmo.py : warning, no home available for testing")
+        logger.warning("No home available for testing")
 
     try:
         thermostat = ThermostatData(authorization)
     except NoDevice:
-        if stdout.isatty():
-            print("lnetatmo.py : warning, no thermostat avaible for testing")
+        logger.warning("No thermostat avaible for testing")
 
     # If we reach this line, all is OK
-
-    # If launched interactively, display OK message
-    if stdout.isatty():
-        print("lnetatmo.py : OK")
+    logger.info("OK")
 
     exit(0)

setup.py

@@ -4,7 +4,7 @@
 
 setup(
     name='lnetatmo',
-    version='1.5.0',
+    version='1.5.1',
     classifiers=[
         'Development Status :: 5 - Production/Stable',
         'Intended Audience :: Developers',
@@ -17,7 +17,7 @@
     scripts=[],
     data_files=[],
     url='https://github.com/philippelt/netatmo-api-python',
-    download_url='https://github.com/philippelt/netatmo-api-python/tarball/v1.5.0.tar.gz',
+    download_url='https://github.com/philippelt/netatmo-api-python/tarball/v1.5.1.tar.gz',
     license='GPL V3',
     description='Simple API to access Netatmo weather station data from any python script.'
 )