feat(heat pump): add condenser, evaporator and compressor data points (#654)

* Update PyViCareHeatPump.py

Add refrigeration circuit pressure and temperature sensors:
heating.compressors.N.sensors.pressure.outlet
heating.compressors.N.sensors.pressure.inlet
heating.compressors.N.sensors.temperature.outlet
heating.compressors.N.sensors.temperature.inlet
heating.evaporators.N.sensors.temperature.liquid
heating.evaporators.N.sensors.temperature.overheat

* Update PyViCareHeatPump.py

Adding subcooling of the first condensor.
heating.condensors.N.sensors.temperature.subcooling

* Apply suggestions from code review

* Refactor compressor and evaporator methods

* Rename methods for consistency in naming

* add test cases

* fix

* add test case

* add test case

* add test case

* add test case

---------

Co-authored-by: Christopher Fenner <9592452+CFenner@users.noreply.github.com>
Co-authored-by: Christopher Fenner <Christopher.Fenner@me.com>

Author: ckoeber83

PyViCare/PyViCareHeatPump.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 from typing import Any, List
 from deprecated import deprecated
 
@@ -9,16 +10,30 @@
 class HeatPump(HeatingDevice, VentilationDevice):
 
     @property
-    def compressors(self) -> List[Any]:
-        return list([self.getCompressor(x) for x in self.getAvailableCompressors()])
+    def compressors(self) -> List[Compressor]:
+        return [self.getCompressor(x) for x in self.getAvailableCompressors()]
 
-    def getCompressor(self, compressor):
+    def getCompressor(self, compressor) -> Compressor:
         return Compressor(self, compressor)
 
     @handleNotSupported
     def getAvailableCompressors(self):
         return self.getProperty("heating.compressors")["properties"]["enabled"]["value"]
 
+    @property
+    def condensors(self) -> List[Condensor]:
+        return [self.getCondensor(x) for x in self.getAvailableCompressors()]
+
+    def getCondensor(self, condensor) -> Condensor:
+        return Condensor(self, condensor)
+
+    @property
+    def evaporators(self) -> List[Evaporator]:
+        return [self.getEvaporator(x) for x in self.getAvailableCompressors()]
+
+    def getEvaporator(self, evaporator) -> Evaporator:
+        return Evaporator(self, evaporator)
+
     @handleNotSupported
     def getBufferMainTemperature(self):
         return self.getProperty("heating.bufferCylinder.sensors.temperature.main")["properties"]['value']['value']
@@ -376,3 +391,97 @@ def getPowerConsumptionTotalThisYear(self) -> float:
     @handleNotSupported
     def getPowerConsumptionTotalUnit(self) -> str:
         return str(self.getProperty(f"heating.compressors.{self.compressor}.power.consumption.total")["properties"]["year"]["unit"])
+
+    @handleNotSupported
+    def getCompressorOutletPressureUnit(self) -> str:
+        # Shows the unit of measurement of the outlet pressure.
+        return str(self.getProperty(f"heating.compressors.{self.compressor}.sensors.pressure.outlet")["properties"]["value"]["unit"])
+
+    @handleNotSupported
+    def getCompressorOutletPressure(self) -> float:
+        # Shows the outlet pressure of the compressor.
+        return float(self.getProperty(f"heating.compressors.{self.compressor}.sensors.pressure.outlet")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getCompressorInletPressureUnit(self) -> str:
+        # Shows the unit of measurement of the inlet pressure.
+        return str(self.getProperty(f"heating.compressors.{self.compressor}.sensors.pressure.inlet")["properties"]["value"]["unit"])
+
+    @handleNotSupported
+    def getCompressorInletPressure(self) -> float:
+        # Shows the inlet pressure of the compressor.
+        return float(self.getProperty(f"heating.compressors.{self.compressor}.sensors.pressure.inlet")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getCompressorOutletTemperatureUnit(self) -> str:
+        # Shows the unit of measurement of the outlet temperature.
+        return str(self.getProperty(f"heating.compressors.{self.compressor}.sensors.temperature.outlet")["properties"]["value"]["unit"])
+
+    @handleNotSupported
+    def getCompressorOutletTemperature(self) -> float:
+        # Shows the outlet temperature of the compressor.
+        return float(self.getProperty(f"heating.compressors.{self.compressor}.sensors.temperature.outlet")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getCompressorInletTemperatureUnit(self) -> str:
+        # Shows the unit of measurement of the inlet temperature.
+        return str(self.getProperty(f"heating.compressors.{self.compressor}.sensors.temperature.inlet")["properties"]["value"]["unit"])
+
+    @handleNotSupported
+    def getCompressorInletTemperature(self) -> float:
+        # Shows the inlet temperature of the compressor.
+        return float(self.getProperty(f"heating.compressors.{self.compressor}.sensors.temperature.inlet")["properties"]["value"]["value"])
+
+
+class Evaporator(HeatingDeviceWithComponent):
+
+    @property
+    def evaporator(self) -> str:
+        return self.component
+
+    @handleNotSupported
+    def getEvaporatorLiquidTemperatureUnit(self) -> str:
+        # Shows the unit of measurement of the liquid temperature of the evaporator.
+        return str(self.getProperty(f"heating.evaporators.{self.evaporator}.sensors.temperature.liquid")["properties"]["value"]["unit"])
+
+    @handleNotSupported
+    def getEvaporatorLiquidTemperature(self) -> float:
+        # Shows the liquid temperature of the evaporator.
+        return float(self.getProperty(f"heating.evaporators.{self.evaporator}.sensors.temperature.liquid")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getEvaporatorOverheatTemperatureUnit(self) -> str:
+        # Shows the unit of measurement of the overheat temperature of the evaporator.
+        return str(self.getProperty(f"heating.evaporators.{self.evaporator}.sensors.temperature.overheat")["properties"]["value"]["unit"])
+
+    @handleNotSupported
+    def getEvaporatorOverheatTemperature(self) -> float:
+        # Shows the overheat temperature of the evaporator.
+        return float(self.getProperty(f"heating.evaporators.{self.evaporator}.sensors.temperature.overheat")["properties"]["value"]["value"])
+
+
+class Condensor(HeatingDeviceWithComponent):
+
+    @property
+    def condensor(self) -> str:
+        return self.component
+
+    @handleNotSupported
+    def getCondensorSubcoolingTemperatureUnit(self) -> str:
+        # Shows the unit of measurement of the subcooling temperature of the condensor.
+        return str(self.getProperty(f"heating.condensors.{self.condensor}.sensors.temperature.subcooling")["properties"]["value"]["unit"])
+
+    @handleNotSupported
+    def getCondensorSubcoolingTemperature(self) -> float:
+        # Shows the subcooling temperature of the condensor.
+        return float(self.getProperty(f"heating.condensors.{self.condensor}.sensors.temperature.subcooling")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getCondensorLiquidTemperatureUnit(self) -> str:
+        # Shows the unit of measurement of the liquid temperature of the condensor.
+        return str(self.getProperty(f"heating.condensors.{self.condensor}.sensors.temperature.liquid")["properties"]["value"]["unit"])
+
+    @handleNotSupported
+    def getCondensorLiquidTemperature(self) -> float:
+        # Shows the liquid temperature of the condensor.
+        return float(self.getProperty(f"heating.condensors.{self.condensor}.sensors.temperature.liquid")["properties"]["value"]["value"])

tests/test_TestForMissingProperties.py

@@ -55,7 +55,6 @@ def test_missingProperties(self):
             'heating.compressors.0.sensors.temperature.oil',
             'heating.compressors.0.sensors.temperature.outlet',
             'heating.compressors.0.speed.current',
-            'heating.condensors.0.sensors.temperature.liquid',
             'heating.configuration.heatingRod.dhw',
             'heating.configuration.heatingRod.heating',
             'heating.configuration.internalPumpOne',
@@ -168,7 +167,6 @@ def test_missingProperties(self):
             'heating.compressors.0.sensors.temperature.ambient',
             'heating.compressors.0.sensors.temperature.overheat',
             'heating.compressors.0.statistics.load',
-            'heating.condensors.0.sensors.temperature.subcooling',
             'heating.configuration.buffer.temperature.max',
             'heating.configuration.flow.temperature.max',
             'heating.configuration.flow.temperature.min',
@@ -271,6 +269,7 @@ def test_unverifiedProperties(self):
             'heating.compressors.0.power.consumption.total',
             'ventilation.sensors.temperature.outside',
             'ventilation.sensors.humidity.outdoor',
+            'heating.compressors.0.sensors.pressure.outlet',
         ]
 
         all_features = self.read_all_features()
@@ -282,7 +281,7 @@ def test_unverifiedProperties(self):
                 continue
 
             for match in re.findall(r'getProperty\(\s*?f?"(.*)"\s*?\)', all_python_files[python]):
-                feature_name = re.sub(r'{self.(circuit|burner|compressor)}', '0', match)
+                feature_name = re.sub(r'{self.(circuit|burner|compressor|condensor|evaporator)}', '0', match)
                 feature_name = re.sub(r'{burner}', '0', feature_name)
                 feature_name = re.sub(r'\.{(quickmode|mode|program|active_program)}', '', feature_name)
                 used_features.append(feature_name)

tests/test_Vitocal222S.py

@@ -0,0 +1,22 @@
+import unittest
+
+from PyViCare.PyViCareHeatPump import HeatPump
+from tests.ViCareServiceMock import ViCareServiceMock
+
+
+class Vitocal222S(unittest.TestCase):
+    def setUp(self):
+        self.service = ViCareServiceMock('response/Vitocal222S.json')
+        self.device = HeatPump(self.service)
+
+    def test_getCondensorsLiquidTemperature(self):
+        self.assertEqual(self.device.getCondensor(0).getCondensorLiquidTemperature(), 26.1)
+        self.assertEqual(self.device.getCondensor(0).getCondensorLiquidTemperatureUnit(), "celsius")
+
+    def test_getCompressorInletTemperature(self):
+        self.assertEqual(self.device.getCompressor(0).getCompressorInletTemperature(), 0.0)
+        self.assertEqual(self.device.getCompressor(0).getCompressorInletTemperatureUnit(), "celsius")
+
+    def test_getCompressorOutletTemperature(self):
+        self.assertEqual(self.device.getCompressor(0).getCompressorOutletTemperature(), 32.8)
+        self.assertEqual(self.device.getCompressor(0).getCompressorOutletTemperatureUnit(), "celsius")

tests/test_Vitocal333G_with_Vitovent300F.py

@@ -15,3 +15,19 @@ def test_getHeatExchangerFrostProtectionActive(self):
     def test_getVolumeFlow(self):
         self.assertEqual(self.device.getSupplyVolumeFlow(), 257)
         self.assertEqual(self.device.getExhaustVolumeFlow(), 257)
+
+    def test_getCondensorSubcoolingTemperature(self):
+        self.assertEqual(self.device.getCondensor("0").getCondensorSubcoolingTemperature(), -2.8)
+        self.assertEqual(self.device.getCondensor("0").getCondensorSubcoolingTemperatureUnit(), "celsius")
+
+    def test_getEvaporatorOverheatTemperature(self):
+        self.assertEqual(self.device.getEvaporator("0").getEvaporatorOverheatTemperature(), 0.0)
+        self.assertEqual(self.device.getEvaporator("0").getEvaporatorOverheatTemperatureUnit(), "celsius")
+
+    def test_getEvaporatorLiquidTemperature(self):
+        self.assertEqual(self.device.getEvaporator("0").getEvaporatorLiquidTemperature(), 18.2)
+        self.assertEqual(self.device.getEvaporator("0").getEvaporatorLiquidTemperatureUnit(), "celsius")
+
+    def test_getCompressorInletPressure(self):
+        self.assertEqual(self.device.getCompressor("0").getCompressorInletPressure(), 12.9)
+        self.assertEqual(self.device.getCompressor("0").getCompressorInletPressureUnit(), "bar")