Merge pull request openviess#28 from crazyfx1/feat/batch

Proposal for batching requests

PyViCare/PyViCareCachedService.py

@@ -0,0 +1,24 @@
+from datetime import datetime
+
+from PyViCare.PyViCareService import apiURLBase, ViCareService
+
+class ViCareCachedService(ViCareService):
+
+    def __init__(self, username, password, cacheDuration, token_file=None,circuit=0):
+        ViCareService.__init__(self, username, password, token_file, circuit)
+        self.cacheDuration = cacheDuration
+        self.cache = None
+        self.cacheTime = None
+
+    def __setCache(self):
+        url = apiURLBase + '/operational-data/installations/' + str(self.id) + '/gateways/' + str(self.serial) + '/devices/0/features/'
+        self.cache = self.get(url)
+        self.cacheTime = datetime.now()
+
+    def getProperty(self,property_name):
+        if self.cache is None or self.cacheTime is None or (datetime.now() - self.cacheTime).seconds > self.cacheDuration:
+            self.__setCache()
+
+        entities = self.cache["entities"]
+        feature = next((f for f in entities if f["class"][0] == property_name and f["class"][1] == "feature"), {})
+        return feature

PyViCare/PyViCareDevice.py

@@ -3,6 +3,7 @@
 import os
 import logging
 from PyViCare.PyViCareService import ViCareService
+from PyViCare.PyViCareCachedService import ViCareCachedService
 
 logger = logging.getLogger('ViCare')
 logger.addHandler(logging.NullHandler())
@@ -24,7 +25,7 @@ class Device:
     """
 
     # TODO cirtcuit management should move at method level
-    def __init__(self, username, password,token_file=None,circuit=0):
+    def __init__(self, username, password,token_file=None,circuit=0,cacheDuration=0):
         """Init function. Create the necessary oAuth2 sessions
         Parameters
         ----------
@@ -37,7 +38,10 @@ def __init__(self, username, password,token_file=None,circuit=0):
         -------
         """
 
-        self.service = ViCareService(username, password, token_file, circuit)
+        if cacheDuration == 0:
+            self.service = ViCareService(username, password, token_file, circuit)
+        else:
+            self.service = ViCareCachedService(username, password, cacheDuration, token_file, circuit)
 
     """ Set the active mode
     Parameters
@@ -173,7 +177,6 @@ def getHeatingCurveSlope(self):
         except KeyError:
             return "error"
 
-
     def getActiveProgram(self):
         try:
             return self.service.getProperty("heating.circuits." + str(self.service.circuit) + ".operating.programs.active")["properties"]["value"]["value"]

PyViCare/PyViCareService.py

@@ -223,6 +223,9 @@ def _getInstallations(self):
     def getInstallations(self):
         return self.installations
 
+    def get(self, url):
+        return self.__get(url)
+
    #TODO should move to device after refactoring 
     def getProperty(self,property_name):
         url = apiURLBase + '/operational-data/installations/' + str(self.id) + '/gateways/' + str(self.serial) + '/devices/0/features/' + property_name

PyViCare/__init__.py

@@ -1 +1 @@
-__all__ = ['PyViCareService''PyViCareDevice','PyViCareGazBoiler','PyViCareHeatPump']
+__all__ = ['PyViCareService''PyViCareDevice','PyViCareGazBoiler','PyViCareHeatPump','PyViCareCachedService']