[New] Allow for request on any Netatmo API

Author: philippelt

README.md

@@ -13,7 +13,6 @@ If you are using a single account with a single home and single weather station,
 If you have multiple homes or were supplying a station name in some method calls, you will have to adapt your code :
  - to supply a home name when looking for data for most class initializers
  - to use the new station name set by Netatmo (which is not your previously set value)
-   
 
 >BREAKING CHANGE: Netatmo seems no longer (july 2023) to allow grant_type "password", even for an app credentials that belong to the same account than the home. They have added the capability of creating access_token/refresh_token couple from the dev page (the location where app are created). As a consequence, the username/password credentials can no longer be used and you must replace them with a new parameter REFRESH_TOKEN that you will get from the web interface. To get this token, you are required to specify the scope you want to allow to this token. Select all that apply for your library use.
 

lnetatmo.py

@@ -732,9 +732,13 @@ class WelcomeData(HomeData):
     warnings.warn("The 'WelcomeData' class was renamed 'HomeData' to handle new Netatmo Home capabilities",
             DeprecationWarning )
     pass
-
 # Utilities routines
 
+def rawAPI(authData, url, parameters={}):
+    fullUrl = _BASE_URL + "api/" + url
+    parameters["access_token"] = authData.accessToken
+    resp = postRequest("rawAPI", fullUrl, parameters)
+    return resp["body"] if "body" in resp else None
 
 def filter_home_data(rawData, home):
     if home:
@@ -755,6 +759,8 @@ def postRequest(topic, url, params=None, timeout=10):
         req = urllib.request.Request(url)
         if params:
             req.add_header("Content-Type","application/x-www-form-urlencoded;charset=utf-8")
+            if "access_token" in params:
+                req.add_header("Authorization","Bearer %s" % params.pop("access_token"))
             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)
@@ -767,7 +773,9 @@ def postRequest(topic, url, params=None, timeout=10):
     else:
         if params:
             params = urlencode(params)
-            headers = {"Content-Type" : "application/x-www-form-urlencoded;charset=utf-8"}
+            headers = {"Content-Type"  : "application/x-www-form-urlencoded;charset=utf-8"}
+            if "access_token" in params:
+                headers["Authorization"] = "Bearer %s" % params.pop("access_token")
         req = urllib2.Request(url=url, data=params, headers=headers) if params else urllib2.Request(url)
         try:
             resp = urllib2.urlopen(req, timeout=timeout)

samples/printAllLastData samples/printAllLastData.pysamples/printAllLastData renamed to samples/printAllLastData.py

@@ -0,0 +1,25 @@
+#!/usr/bin/python3
+
+# 2023-07 : ph.larduinat@wanadoo.fr
+# Library 3.2.0
+
+# Direct call of Netatmo API with authentication token
+# Return a dictionary of body of Netatmo response
+
+import lnetatmo
+
+authorization = lnetatmo.ClientAuth()
+rawData = lnetatmo.rawAPI(authorization, "gethomesdata")
+
+print("Home name : home_id")
+for h in rawData["homes"]:
+  print(f"{h['name']} : {h['id']}")
+
+print("Radio communication strength by home")
+for h in rawData["homes"]:
+  print(f"\nFor {h['name']}:")
+  modules = lnetatmo.rawAPI(authorization, "homestatus", {"home_id" : h['id']})['home']
+  if not 'modules' in modules:
+    print("No modules available")
+  else:
+    print([(m['id'],m['rf_strength']) for m in modules['modules'] if 'rf_strength' in m])

samples/printThermostat samples/printThermostat.pysamples/printThermostat renamed to samples/printThermostat.py

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

samples/rawAPIsample.py

@@ -15,6 +15,8 @@ Python Netatmo API programmers guide
 
 >2023-07-12, Breaking changes due to deprecation of grant_type "password" for ALL apps
 
+>2023-07-24, Adding rawAPI call to direct access the netatmo API when no additional support is provided by the library
+
 No additional library other than standard Python library is required.
 
 Both Python V2.7x and V3.x.x are supported without change.
@@ -427,6 +429,7 @@ Methods :
 #### 4-5 Utilities functions ####
 
 
+  * **rawAPI** (authentication, APIkeyword, parameters) : Direct call an APIkeyword from Netatmo and return a dictionary with the raw response the APIkeywork is the path without the / before as specified in the documentation (eg. "gethomesdata" or "homestatus")
   * **toTimeString** (timestamp) : Convert a Netatmo time stamp to a readable date/time format.
   * **toEpoch**( dateString) : Convert a date string (form YYYY-MM-DD_HH:MM:SS) to timestamp
   * **todayStamps**() : Return a couple of epoch time (start, end) for the current day