Update lnetatmo.py

Added Class Homesdata

Author: JurgenLB

lnetatmo.py

@@ -88,6 +88,7 @@ def getParameter(key, default):
 _GETCAMERAPICTURE_REQ  = _BASE_URL + "api/getcamerapicture"
 _GETEVENTSUNTIL_REQ    = _BASE_URL + "api/geteventsuntil"
 _HOME_STATUS           = _BASE_URL + "api/homestatus"         # Used for Home+ Control Devices 
+_GETHOMES_DATA         = _BASE_URL + "api/homesdata"                   # New API
 
 
 #TODO# Undocumented (but would be very usefull) API : Access currently forbidden (403)
@@ -121,6 +122,59 @@ def getParameter(key, default):
 # Not working yet
 #_CAM_FTP_ACTIVE        = "/command/ftp_set_config?config=on_off:%s"   # "on"|"off"
 
+#Known TYPE used by Netatmo services + API,      there can be more types possible
+TYPES = {
+    'BFII'         : ["Bticino IP Indoor unit", 'Home + Security'],
+    'BFIC'         : ["Bticino IP Guard station", 'Home + Security'],
+    'BFIO'         : ["Bticino IP Entrance panel", 'Home + Security'],
+    'BFIS'         : ["Bticino Server DES", 'Home + Security'],
+    'BNS'          : ["Smarther with Netatmo Thermostat", 'Home+Control'],
+    'BNCU'         : ["Bticino Bticino Alarm Central Unit", 'Home + Security'],
+    'BNCS'         : ["Bticino module Controlled Socket", 'Home+Control'],
+    'BNCX'         : ["Bticino Class 300 EOS", 'Home + Security'],
+    'BNDL'         : ["Bticino Doorlock", 'Home + Security'],
+    'BNEU'         : ["Bticino external unit", 'Home + Security'],
+    'BNFC'         : ["Bticino Thermostat", 'Home+Control'],
+    'BNMH'         : ["Bticino My Home Server 1", 'Home + Security'],  # also API Home+Control  GATEWAY
+    'BNSE'         : ["Bticino Alarm Sensor", 'Home + Security'],
+    'BNSL'         : ["Bticino Staircase Light", 'Home + Security'],
+    'BNTH'         : ["Bticino Thermostat", 'Home+Control'],
+    'BNTR'         : ["Bticino module towel rail", 'Home+Control'],
+    'BNXM'         : ["Bticino X meter", 'Home+Control'],
+
+        'NACamera'     : ["indoor camera", 'Home + Security'],
+    'NACamDoorTag' : ["door tag", 'Home + Security'],
+    'NAMain'       : ["weather station", 'Weather'],
+    'NAModule1'    : ["outdoor unit", 'Weather'],
+    'NAModule2'    : ["wind unit", 'Weather'],
+    'NAModule3'    : ["rain unit", 'Weather'],
+    'NAModule4'    : ["indoor unit", 'Weather'],
+    'NAPlug'       : ["thermostat relais station", 'Energy'],          # A smart thermostat exist of a thermostat$
+                                                                       # The relais module is also the bridge bet$
+    'NATherm1'     : ["thermostat",  'Energy'],
+    'NCO'          : ["co2 sensor", 'Home + Security'],                # The same API as smoke sensor
+    'NDB'          : ["doorbell", 'Home + Security'],
+    'NOC'          : ["outdoor camera", 'Home + Security'],
+    'NRV'          : ["thermostat valves", 'Energy'],                  # also API Home+Control
+    'NSD'          : ["smoke sensor", 'Home + Security'],
+    'NHC'          : ["home coach", 'Aircare'],
+        'NIS'          : ["indoor sirene", 'Home + Security'],
+
+    'NLC'          : ["Cable Outlet", 'Home+Control'],
+    'NLE'          : ["Ecometer", 'Home+Control'],
+    'NLG'          : ["Gateway", 'Home+Control'],
+    'NLGS'         : ["Standard DIN Gateway", 'Home+Control'],
+    'NLP'          : ["Power Outlet", 'Home+Control'],
+    'NLPC'         : ["DIN Energy meter", 'Home+Control'],
+    'NLPD'         : ["Dry contact", 'Home+Control'],
+    'NLPM'         : ["Mobile Socket", 'Home+Control'],
+    'NLPO'         : ["Contactor", 'Home+Control'],
+    'NLPT'         : ["Teleruptor", 'Home+Control'],
+
+    'OTH'          : ["Opentherm Thermostat Relay", 'Home+Control'],
+    'OTM'          : ["Smart modulating Thermostat", 'Home+Control']
+    }
+
 # UNITS used by Netatmo services
 UNITS = {
     "unit" : {
@@ -138,6 +192,18 @@ def getParameter(key, default):
         0: "mbar",
         1: "inHg",
         2: "mmHg"
+    },
+    "Health index" : {                                                 # Homecoach
+        0: "Healthy",
+        1: "Fine",
+        2: "Fair",
+        3: "Poor",
+        4: "Unhealthy"
+    },
+    "Wifi status" : {                                                  # Wifi Signal quality
+        86: "Bad",
+        71: "Average",
+        56: "Good"
     }
 }
 
@@ -317,11 +383,11 @@ def getThermostat(self, name=None):
         else: return
         return self.thermostat[self.defaultThermostatId]
 
-    def moduleNamesList(self, name=None, tid=None):
+    def moduleNamesList(self, name=None, tid=None):                                 # ERROR   getThermostat() got an unexpected keyword argument 'tid'
         thermostat = self.getThermostat(name=name, tid=tid)
         return [m['name'] for m in thermostat['modules']] if thermostat else None
 
-    def getModuleByName(self, name, thermostatId=None):
+    def getModuleByName(self, name, thermostatId=None):                             # ERROR  'NoneType' object is not subscriptable
         thermostat = self.getThermostat(tid=thermostatId)
         for m in thermostat['modules']:
             if m['name'] == name: return m
@@ -792,6 +858,39 @@ class WelcomeData(HomeData):
     warnings.warn("The 'WelcomeData' class was renamed 'HomeData' to handle new Netatmo Home capabilities",
             DeprecationWarning )
     pass
+
+class HomesData:
+    """
+    List the Data of most modules
+
+    Args:
+        authData (clientAuth): Authentication information with a working access Token
+        home : Home name or id of the home who's module belongs to
+    """
+    def __init__(self, authData, home=None):
+        #
+        self.getAuthToken = authData.accessToken
+        postParams = {
+                "access_token" : self.getAuthToken,
+                "home_id": home
+                }
+        #
+        resp = postRequest("Module", _GETHOMES_DATA, postParams)
+#        self.rawData = resp['body']['devices']
+        self.rawData = resp['body']['homes']
+        if not self.rawData : raise NoHome("No home %s found" % home)
+        #
+        if home:
+            # Find a home who's home id or name is the one requested
+            for h in self.rawData:
+                #print (h.keys())
+                if h["name"] == home or h["id"] == home:
+                   self.Homes_Data = h
+#        print (self.Homes_Data)
+        if not self.Homes_Data : raise NoDevice("No Devices available")
+
+
+
 # Utilities routines
 
 def rawAPI(authData, url, parameters={}):