[Change] Added UserInfo class to get units for weatherdata info

Author: philippelt

lnetatmo.py

@@ -120,6 +120,25 @@ def getParameter(key, default):
 # Not working yet
 #_CAM_FTP_ACTIVE        = "/command/ftp_set_config?config=on_off:%s"   # "on"|"off"
 
+# UNITS used by Netatmo services
+UNITS = {
+    "unit" : {
+        0: "metric",
+        1: "imperial"
+    },
+    "windunit" : {
+        0: "kph",
+        1: "mph",
+        2: "ms",
+        3: "beaufort",
+        4: "knot"
+    },
+    "pressureunit" : {
+        0: "mbar",
+        1: "inHg",
+        2: "mmHg"
+    }
+}
 
 # Logger context
 logger = logging.getLogger("lnetatmo")
@@ -198,6 +217,8 @@ class User:
     Args:
         authData (ClientAuth): Authentication information with a working access Token
     """
+    warnings.warn("The 'User' class is no longer maintained by Netatmo",
+            DeprecationWarning )
     def __init__(self, authData):
         postParams = {
                 "access_token" : authData.accessToken
@@ -208,6 +229,14 @@ def __init__(self, authData):
         self.ownerMail = self.rawData['user']['mail']
 
 
+class UserInfo:
+    """
+    This class is populated with data from various Netatmo requests to provide
+    complimentary data (eg Units for Weatherdata)
+    """
+    pass
+
+
 class ThermostatData:
     """
     List the Thermostat and temperature modules
@@ -269,6 +298,7 @@ def __init__(self, authData):
                 }
         resp = postRequest(_GETSTATIONDATA_REQ, postParams)
         self.rawData = resp['body']['devices']
+        # Weather data
         if not self.rawData : raise NoDevice("No weather station available")
         self.stations = { d['_id'] : d for d in self.rawData }
         self.modules = dict()
@@ -278,6 +308,16 @@ def __init__(self, authData):
                 for m in self.rawData[i]['modules']:
                     self.modules[ m['_id'] ] = m
         self.default_station = list(self.stations.values())[0]['station_name']
+        # User data
+        userData = resp['body']['user']
+        self.user = UserInfo()
+        setattr(self.user, "mail", userData['mail'])
+        for k,v in userData['administrative'].items():
+            if k in UNITS:
+                setattr(self.user, k, UNITS[k][v])
+            else:
+                setattr(self.user, k, v)
+
 
     def modulesNamesList(self, station=None):
         res = [m['module_name'] for m in self.modules.values()]

samples/printAllLastData

@@ -13,10 +13,17 @@ import time
 import lnetatmo
 
 authorization = lnetatmo.ClientAuth()
-devList = lnetatmo.WeatherStationData(authorization)
+weather = lnetatmo.WeatherStationData(authorization)
+
+user = weather.user
+
+print("Station owner : ", user.mail)
+print("Data units    : ", user.unit)
+
+print()
 
 # For each available module in the returned data that should not be older than one hour (3600 s) from now
-for module, moduleData in devList.lastData(exclude=3600).items() :
+for module, moduleData in weather.lastData(exclude=3600).items() :
 
     # Name of the module (or station embedded module), the name you defined in the web netatmo account station management
     print(module)
@@ -32,6 +39,10 @@ for module, moduleData in devList.lastData(exclude=3600).items() :
 #
 # $ printAllLastData
 #
+#Station owner :  ph.larduinat@wanadoo.fr
+#Data units    :  metric
+#
+#
 #Office
 #    AbsolutePressure : 988.7
 #                 CO2 : 726

setup.py

@@ -4,7 +4,7 @@
 
 setup(
     name='lnetatmo',
-    version='1.5.1',
+    version='1.6.0',
     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.1.tar.gz',
+    download_url='https://github.com/philippelt/netatmo-api-python/tarball/v1.6.0.tar.gz',
     license='GPL V3',
     description='Simple API to access Netatmo weather station data from any python script.'
 )