PyViCare 2.32.0__tar.gz → 2.33.0__tar.gz

{PyViCare-2.32.0 → pyvicare-2.33.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyViCare
-Version: 2.32.0
+Version: 2.33.0
 Summary: Library to communicate with the Viessmann ViCare API
 Home-page: https://github.com/somm15/PyViCare
 Author: Simon Gillet

{PyViCare-2.32.0 → pyvicare-2.33.0}/PyViCare/PyViCare.py

@@ -12,10 +12,9 @@ from PyViCare.PyViCareUtils import PyViCareInvalidDataError
 logger = logging.getLogger('ViCare')
 logger.addHandler(logging.NullHandler())
 
-""""Viessmann ViCare API Python tools"""
-
 
 class PyViCare:
+    """"Viessmann ViCare API Python tools"""
     def __init__(self) -> None:
         self.cacheDuration = 60
 
@@ -36,8 +35,7 @@ class PyViCare:
     def __buildService(self, accessor, roles):
         if self.cacheDuration > 0:
             return ViCareCachedService(self.oauth_manager, accessor, roles, self.cacheDuration)
-        else:
-            return ViCareService(self.oauth_manager, accessor, roles)
+        return ViCareService(self.oauth_manager, accessor, roles)
 
     def __loadInstallations(self):
         installations = self.oauth_manager.get(
@@ -54,26 +52,14 @@ class PyViCare:
         for installation in self.installations:
             for gateway in installation.gateways:
                 for device in gateway.devices:
-                    if device.deviceType != "heating" and device.deviceType != "zigbee" and device.deviceType != "vitoconnect" and device.deviceType != "electricityStorage" and device.deviceType != "EEBus" and device.deviceType != "hems" and device.deviceType != "tcu" and device.deviceType != "ventilation":
-                        continue  # we are only interested in heating, photovoltaic, electricityStorage, hems and ventilation devices
-
-                    if device.id == "gateway" and device.deviceType == "vitoconnect":
-                        device.id = "0"  # vitoconnect has no device id, so we use 0
-
-                    if device.id == "gateway" and device.deviceType == "tcu":
-                        device.id = "0"  # tcu has no device id, so we use 0
-
-                    if device.id == "HEMS" and device.deviceType == "hems":
-                        device.id = "0"  # hems has no device id, so we use 0
-
-                    if device.id == "EEBUS" and device.deviceType == "EEBus":
-                        device.id = "0" # EEBus has no device id,
+                    if device.deviceType not in ["heating", "zigbee", "vitoconnect", "electricityStorage", "tcu", "ventilation"]:
+                        continue  # we are only interested in heating, photovoltaic, electricityStorage, and ventilation devices
 
                     accessor = ViCareDeviceAccessor(
                         installation.id, gateway.serial, device.id)
                     service = self.__buildService(accessor, device.roles)
 
-                    logger.info(f"Device found: {device.modelId}")
+                    logger.info("Device found: %s", device.modelId)
 
                     yield PyViCareDeviceConfig(service, device.id, device.modelId, device.status)
 
@@ -91,5 +77,4 @@ def Wrap(v):
         return DictWrap(v)
     if isinstance(v, str) and len(v) == 24 and v[23] == 'Z' and v[10] == 'T':
         return datetime.strptime(v, '%Y-%m-%dT%H:%M:%S.%f%z')
-    else:
-        return v
+    return v

{PyViCare-2.32.0 → pyvicare-2.33.0}/PyViCare/PyViCareAbstractOAuthManager.py

@@ -35,7 +35,7 @@ class AbstractViCareOAuthManager:
         try:
             logger.debug(self.__oauth)
             response = self.__oauth.get(f"{API_BASE_URL}{url}", timeout=31).json()
-            logger.debug(f"Response to get request: {response}")
+            logger.debug("Response to get request: %s", response)
             self.__handle_expired_token(response)
             self.__handle_rate_limit(response)
             self.__handle_server_error(response)
@@ -69,21 +69,20 @@ class AbstractViCareOAuthManager:
         if ("statusCode" in response and response["statusCode"] >= 400):
             raise PyViCareCommandError(response)
 
-    """POST URL using OAuth session. Automatically renew the token if needed
-    Parameters
-    ----------
-    url : str
-        URL to get
-    data : str
-        Data to post
-
-    Returns
-    -------
-    result: json
-        json representation of the answer
-    """
-
     def post(self, url, data) -> Any:
+        """POST URL using OAuth session. Automatically renew the token if needed
+        Parameters
+        ----------
+        url : str
+            URL to get
+        data : str
+            Data to post
+
+        Returns
+        -------
+        result: json
+            json representation of the answer
+        """
         headers = {"Content-Type": "application/json",
                    "Accept": "application/vnd.siren+json"}
         try:

{PyViCare-2.32.0 → pyvicare-2.33.0}/PyViCare/PyViCareBrowserOAuthManager.py

@@ -75,14 +75,14 @@ class ViCareBrowserOAuthManager(AbstractViCareOAuthManager):
             logger.debug("Timeout reached")
             raise PyViCareBrowserOAuthTimeoutReachedError()
 
-        logger.debug(f"Location: {location}")
+        logger.debug("Location: %s", location)
 
         oauth_session.fetch_token(TOKEN_URL, authorization_response=location, code_verifier=code_verifier)
 
         if oauth_session.token is None:
             raise PyViCareInvalidCredentialsError()
 
-        logger.debug(f"Token received: {oauth_session.token}")
+        logger.debug("Token received: %s", oauth_session.token)
         self.__storeToken(oauth_session.token)
         logger.info("New token created")
         return oauth_session

{PyViCare-2.32.0 → pyvicare-2.33.0}/PyViCare/PyViCareDeviceConfig.py

@@ -55,7 +55,7 @@ class PyViCareDeviceConfig:
 
     def asElectricalEnergySystem(self):
         return ElectricalEnergySystem(self.service)
-    
+
     def asGateway(self):
         return Gateway(self.service)
 
@@ -84,21 +84,18 @@ class PyViCareDeviceConfig:
             (self.asPelletsBoiler, r"Vitoligno|Ecotronic|VBC550P", []),
             (self.asRadiatorActuator, r"E3_RadiatorActuator", ["type:radiator"]),
             (self.asRoomSensor, r"E3_RoomSensor", ["type:climateSensor"]),
-            (self.asElectricalEnergySystem, r"E3_HEMS", ["type:hems"]),
-            (self.asElectricalEnergySystem, r"E3_TCU10_x07", ["type:tcu"]),
-            (self.asElectricalEnergySystem, r"E3_EEBus", ["type:eebus"]),
-            (self.asElectricalEnergySystem, r"E3_VitoCharge_03", ["type:energy_storage"]),
+            (self.asGateway, r"E3_TCU10_x07", ["type:gateway;TCU300"]),
+            (self.asElectricalEnergySystem, r"E3_VitoCharge_03", ["type:ees"]),
             (self.asVentilation, r"E3_ViAir", ["type:ventilation"]),
             (self.asGateway, r"Heatbox1", ["type:gateway;VitoconnectOpto1"])
         ]
 
         for (creator_method, type_name, roles) in device_types:
             if re.search(type_name, self.device_model) or self.service.hasRoles(roles):
-                logger.info(f"detected {self.device_model} {creator_method.__name__}")
+                logger.info("detected %s %s", self.device_model, creator_method.__name__)
                 return creator_method()
 
-        logger.info(
-            f"Could not auto detect {self.device_model}. Use generic device.")
+        logger.info("Could not auto detect %s. Use generic device.", self.device_model)
         return self.asGeneric()
 
     def get_raw_json(self):

{PyViCare-2.32.0 → pyvicare-2.33.0}/PyViCare/PyViCareElectricalEnergySystem.py

@@ -1,13 +1,9 @@
 from PyViCare.PyViCareDevice import Device
 from PyViCare.PyViCareUtils import handleNotSupported
-from PyViCare.PyViCareService import ViCareService
 
 
 class ElectricalEnergySystem(Device):
 
-    def __init__(self, service: ViCareService) -> None:
-        self.service = service
-
     @handleNotSupported
     def getPointOfCommonCouplingTransferPowerExchange(self):
         return self.service.getProperty("pcc.transfer.power.exchange")["properties"][

{PyViCare-2.32.0 → pyvicare-2.33.0}/PyViCare/PyViCareGateway.py

@@ -4,6 +4,10 @@ from PyViCare.PyViCareUtils import handleNotSupported
 
 class Gateway(Device):
 
+    @handleNotSupported
+    def getSerial(self):
+        return self.service.getProperty("gateway.devices")["gatewayId"]
+
     @handleNotSupported
     def getWifiSignalStrength(self):
         return self.service.getProperty("gateway.wifi")["properties"]["strength"]["value"]

{PyViCare-2.32.0 → pyvicare-2.33.0}/PyViCare/PyViCareGazBoiler.py

@@ -180,7 +180,7 @@ class GazBoiler(HeatingDevice):
     # Gas consumption for Domestic Hot Water data:
     @handleNotSupported
     def getGasSummaryConsumptionDomesticHotWaterUnit(self):
-        return self.service.getProperty("heating.gas.consumption.summary.dhw")["properties"]["day"]["unit"]
+        return self.service.getProperty("heating.gas.consumption.summary.dhw")["properties"]["unit"]["value"]
 
     @handleNotSupported
     def getGasSummaryConsumptionDomesticHotWaterCurrentDay(self):

pyvicare-2.33.0/PyViCare/PyViCareHeatPump.py

@@ -0,0 +1,293 @@
+from contextlib import suppress
+from typing import Any, List
+
+from PyViCare.PyViCareHeatingDevice import (HeatingDevice,
+                                            HeatingDeviceWithComponent)
+from PyViCare.PyViCareUtils import PyViCareNotSupportedFeatureError, handleAPICommandErrors, handleNotSupported
+
+
+class HeatPump(HeatingDevice):
+
+    @property
+    def compressors(self) -> List[Any]:
+        return list([self.getCompressor(x) for x in self.getAvailableCompressors()])
+
+    def getCompressor(self, compressor):
+        return Compressor(self, compressor)
+
+    @handleNotSupported
+    def getAvailableCompressors(self):
+        return self.service.getProperty("heating.compressors")["properties"]["enabled"]["value"]
+
+    @handleNotSupported
+    def getBufferMainTemperature(self):
+        return self.service.getProperty("heating.buffer.sensors.temperature.main")["properties"]['value']['value']
+
+    @handleNotSupported
+    def getBufferTopTemperature(self):
+        return self.service.getProperty("heating.buffer.sensors.temperature.top")["properties"]['value']['value']
+
+    # Power consumption for Heating:
+    @handleNotSupported
+    def getPowerSummaryConsumptionHeatingUnit(self):
+        return self.service.getProperty("heating.power.consumption.summary.heating")["properties"]["currentDay"]["unit"]
+
+    @handleNotSupported
+    def getPowerSummaryConsumptionHeatingCurrentDay(self):
+        return self.service.getProperty("heating.power.consumption.summary.heating")["properties"]["currentDay"]["value"]
+
+    @handleNotSupported
+    def getPowerSummaryConsumptionHeatingCurrentMonth(self):
+        return self.service.getProperty("heating.power.consumption.summary.heating")["properties"]["currentMonth"]["value"]
+
+    @handleNotSupported
+    def getPowerSummaryConsumptionHeatingCurrentYear(self):
+        return self.service.getProperty("heating.power.consumption.summary.heating")["properties"]["currentYear"]["value"]
+
+    @handleNotSupported
+    def getPowerSummaryConsumptionHeatingLastMonth(self):
+        return self.service.getProperty("heating.power.consumption.summary.heating")["properties"]["lastMonth"]["value"]
+
+    @handleNotSupported
+    def getPowerSummaryConsumptionHeatingLastSevenDays(self):
+        return self.service.getProperty("heating.power.consumption.summary.heating")["properties"]["lastSevenDays"]["value"]
+
+    @handleNotSupported
+    def getPowerSummaryConsumptionHeatingLastYear(self):
+        return self.service.getProperty("heating.power.consumption.summary.heating")["properties"]["lastYear"]["value"]
+
+    @handleNotSupported
+    def getPowerConsumptionUnit(self):
+        return self.service.getProperty("heating.power.consumption.total")["properties"]["day"]["unit"]
+
+    @handleNotSupported
+    def getPowerConsumptionToday(self):
+        return self.service.getProperty("heating.power.consumption.total")["properties"]["day"]["value"][0]
+
+    @handleNotSupported
+    def getPowerConsumptionDomesticHotWaterToday(self):
+        return self.service.getProperty("heating.power.consumption.dhw")["properties"]["day"]["value"][0]
+
+    # Power consumption for Domestic Hot Water:
+    @handleNotSupported
+    def getPowerSummaryConsumptionDomesticHotWaterUnit(self):
+        return self.service.getProperty("heating.power.consumption.summary.dhw")["properties"]["currentDay"]["unit"]
+
+    @handleNotSupported
+    def getPowerSummaryConsumptionDomesticHotWaterCurrentDay(self):
+        return self.service.getProperty("heating.power.consumption.summary.dhw")["properties"]["currentDay"]["value"]
+
+    @handleNotSupported
+    def getPowerSummaryConsumptionDomesticHotWaterCurrentMonth(self):
+        return self.service.getProperty("heating.power.consumption.summary.dhw")["properties"]["currentMonth"]["value"]
+
+    @handleNotSupported
+    def getPowerSummaryConsumptionDomesticHotWaterCurrentYear(self):
+        return self.service.getProperty("heating.power.consumption.summary.dhw")["properties"]["currentYear"]["value"]
+
+    @handleNotSupported
+    def getPowerSummaryConsumptionDomesticHotWaterLastMonth(self):
+        return self.service.getProperty("heating.power.consumption.summary.dhw")["properties"]["lastMonth"]["value"]
+
+    @handleNotSupported
+    def getPowerSummaryConsumptionDomesticHotWaterLastSevenDays(self):
+        return self.service.getProperty("heating.power.consumption.summary.dhw")["properties"]["lastSevenDays"]["value"]
+
+    @handleNotSupported
+    def getPowerSummaryConsumptionDomesticHotWaterLastYear(self):
+        return self.service.getProperty("heating.power.consumption.summary.dhw")["properties"]["lastYear"]["value"]
+
+    @handleNotSupported
+    def getVolumetricFlowReturn(self):
+        return self.service.getProperty("heating.sensors.volumetricFlow.allengra")["properties"]['value']['value']
+
+    @handleNotSupported
+    def getAvailableVentilationModes(self):
+        return self.service.getProperty("ventilation.operating.modes.active")["commands"]["setMode"]["params"]["mode"]["constraints"]["enum"]
+
+    @handleNotSupported
+    def getActiveVentilationMode(self):
+        return self.service.getProperty("ventilation.operating.modes.active")["properties"]["value"]["value"]
+
+    def setActiveVentilationMode(self, mode):
+        """ Set the active mode
+        Parameters
+        ----------
+        mode : str
+            Valid mode can be obtained using getModes()
+
+        Returns
+        -------
+        result: json
+            json representation of the answer
+        """
+        return self.service.setProperty("ventilation.operating.modes.active", "setMode", {'mode': mode})
+
+    @handleNotSupported
+    def getAvailableVentilationPrograms(self):
+        available_programs = []
+        for program in ['basic', 'intensive', 'reduced', 'standard', 'standby', 'comfort', 'eco', 'forcedLevelFour',
+                        'holiday', 'holidayAtHome', 'levelFour', 'levelOne', 'levelThree', 'levelTwo', 'permanent', 'silent']:
+            with suppress(PyViCareNotSupportedFeatureError):
+                if self.service.getProperty(f"ventilation.operating.programs.{program}") is not None:
+                    available_programs.append(program)
+        return available_programs
+
+    @handleNotSupported
+    def getActiveVentilationProgram(self):
+        return self.service.getProperty("ventilation.operating.programs.active")["properties"]["value"]["value"]
+
+    def activateVentilationProgram(self, program):
+        """ Activate a ventilation program
+            NOTE
+            DEVICE_COMMUNICATION_ERROR can just mean that the program is already on
+        Parameters
+        ----------
+        program : str
+
+        Returns
+        -------
+        result: json
+            json representation of the answer
+        """
+        return self.service.setProperty(f"ventilation.operating.programs.{program}", "activate", {})
+
+    @handleNotSupported
+    def getDomesticHotWaterHysteresisUnit(self) -> str:
+        return str(self.service.getProperty("heating.dhw.temperature.hysteresis")["properties"]["value"]["unit"])
+
+    @handleNotSupported
+    def getDomesticHotWaterHysteresis(self) -> float:
+        return float(self.service.getProperty("heating.dhw.temperature.hysteresis")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getDomesticHotWaterHysteresisMin(self) -> float:
+        return float(self.service.getProperty("heating.dhw.temperature.hysteresis")["commands"]["setHysteresis"]["params"]["hysteresis"]["constraints"]["min"])
+
+    @handleNotSupported
+    def getDomesticHotWaterHysteresisMax(self) -> float:
+        return float(self.service.getProperty("heating.dhw.temperature.hysteresis")["commands"]["setHysteresis"]["params"]["hysteresis"]["constraints"]["max"])
+
+    @handleNotSupported
+    def getDomesticHotWaterHysteresisStepping(self) -> float:
+        return float(self.service.getProperty("heating.dhw.temperature.hysteresis")["commands"]["setHysteresis"]["params"]["hysteresis"]["constraints"]["stepping"])
+
+    @handleAPICommandErrors
+    def setDomesticHotWaterHysteresis(self, temperature: float) -> Any:
+        """ Set the hysteresis temperature for domestic host water
+        Parameters
+        ----------
+        temperature : float
+            hysteresis temperature
+
+        Returns
+        -------
+        result: json
+            json representation of the answer
+        """
+        return self.service.setProperty("heating.dhw.temperature.hysteresis", "setHysteresis", {'hysteresis': temperature})
+
+    @handleNotSupported
+    def getDomesticHotWaterHysteresisSwitchOn(self) -> float:
+        return float(self.service.getProperty("heating.dhw.temperature.hysteresis")["properties"]["switchOnValue"]["value"])
+
+    @handleNotSupported
+    def getDomesticHotWaterHysteresisSwitchOnMin(self) -> float:
+        return float(self.service.getProperty("heating.dhw.temperature.hysteresis")["commands"]["setHysteresisSwitchOnValue"]["params"]["hysteresis"]["constraints"]["min"])
+
+    @handleNotSupported
+    def getDomesticHotWaterHysteresisSwitchOnMax(self) -> float:
+        return float(self.service.getProperty("heating.dhw.temperature.hysteresis")["commands"]["setHysteresisSwitchOnValue"]["params"]["hysteresis"]["constraints"]["max"])
+
+    @handleNotSupported
+    def getDomesticHotWaterHysteresisSwitchOnStepping(self) -> float:
+        return float(self.service.getProperty("heating.dhw.temperature.hysteresis")["commands"]["setHysteresisSwitchOnValue"]["params"]["hysteresis"]["constraints"]["stepping"])
+
+    @handleAPICommandErrors
+    def setDomesticHotWaterHysteresisSwitchOn(self, temperature: float) -> Any:
+        """ Set the hysteresis switch on temperature for domestic host water
+        Parameters
+        ----------
+        temperature : float
+            hysteresis switch on temperature
+
+        Returns
+        -------
+        result: json
+            json representation of the answer
+        """
+        return self.service.setProperty("heating.dhw.temperature.hysteresis", "setHysteresisSwitchOnValue", {'hysteresis': temperature})
+
+    @handleNotSupported
+    def getDomesticHotWaterHysteresisSwitchOff(self) -> float:
+        return float(self.service.getProperty("heating.dhw.temperature.hysteresis")["properties"]["switchOffValue"]["value"])
+
+    @handleNotSupported
+    def getDomesticHotWaterHysteresisSwitchOffMin(self) -> float:
+        return float(self.service.getProperty("heating.dhw.temperature.hysteresis")["commands"]["setHysteresisSwitchOffValue"]["params"]["hysteresis"]["constraints"]["min"])
+
+    @handleNotSupported
+    def getDomesticHotWaterHysteresisSwitchOffMax(self) -> float:
+        return float(self.service.getProperty("heating.dhw.temperature.hysteresis")["commands"]["setHysteresisSwitchOffValue"]["params"]["hysteresis"]["constraints"]["max"])
+
+    @handleNotSupported
+    def getDomesticHotWaterHysteresisSwitchOffStepping(self) -> float:
+        return float(self.service.getProperty("heating.dhw.temperature.hysteresis")["commands"]["setHysteresisSwitchOffValue"]["params"]["hysteresis"]["constraints"]["stepping"])
+
+    @handleAPICommandErrors
+    def setDomesticHotWaterHysteresisSwitchOff(self, temperature: float) -> Any:
+        """ Set the hysteresis switch off temperature for domestic host water
+        Parameters
+        ----------
+        temperature : float
+            hysteresis switch off temperature
+
+        Returns
+        -------
+        result: json
+            json representation of the answer
+        """
+        return self.service.setProperty("heating.dhw.temperature.hysteresis", "setHysteresisSwitchOffValue", {'hysteresis': temperature})
+
+
+class Compressor(HeatingDeviceWithComponent):
+
+    @property
+    def compressor(self) -> str:
+        return self.component
+
+    @handleNotSupported
+    def getStarts(self):
+        return self.service.getProperty(f"heating.compressors.{self.compressor}.statistics")["properties"]["starts"]["value"]
+
+    @handleNotSupported
+    def getHours(self):
+        return self.service.getProperty(f"heating.compressors.{self.compressor}.statistics")["properties"]["hours"]["value"]
+
+    @handleNotSupported
+    def getHoursLoadClass1(self):
+        return self.service.getProperty(f"heating.compressors.{self.compressor}.statistics")["properties"]["hoursLoadClassOne"]["value"]
+
+    @handleNotSupported
+    def getHoursLoadClass2(self):
+        return self.service.getProperty(f"heating.compressors.{self.compressor}.statistics")["properties"]["hoursLoadClassTwo"]["value"]
+
+    @handleNotSupported
+    def getHoursLoadClass3(self):
+        return self.service.getProperty(f"heating.compressors.{self.compressor}.statistics")["properties"]["hoursLoadClassThree"]["value"]
+
+    @handleNotSupported
+    def getHoursLoadClass4(self):
+        return self.service.getProperty(f"heating.compressors.{self.compressor}.statistics")["properties"]["hoursLoadClassFour"]["value"]
+
+    @handleNotSupported
+    def getHoursLoadClass5(self):
+        return self.service.getProperty(f"heating.compressors.{self.compressor}.statistics")["properties"]["hoursLoadClassFive"]["value"]
+
+    @handleNotSupported
+    def getActive(self):
+        return self.service.getProperty(f"heating.compressors.{self.compressor}")["properties"]["active"]["value"]
+
+    @handleNotSupported
+    def getPhase(self):
+        return self.service.getProperty(f"heating.compressors.{self.compressor}")["properties"]["phase"]["value"]