feat(deprecation): remove usage of deprecated data points

PyViCare/PyViCareHeatPump.py

@@ -21,11 +21,11 @@ def getAvailableCompressors(self):
 
     @handleNotSupported
     def getBufferMainTemperature(self):
-        return self.service.getProperty("heating.buffer.sensors.temperature.main")["properties"]['value']['value']
+        return self.service.getProperty("heating.bufferCylinder.sensors.temperature.main")["properties"]['value']['value']
 
     @handleNotSupported
     def getBufferTopTemperature(self):
-        return self.service.getProperty("heating.buffer.sensors.temperature.top")["properties"]['value']['value']
+        return self.service.getProperty("heating.bufferCylinder.sensors.temperature.top")["properties"]['value']['value']
 
     # Power consumption for Heating:
     @handleNotSupported
@@ -126,8 +126,7 @@ def setActiveVentilationMode(self, 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']:
+        for program in ['basic', 'intensive', 'reduced', 'standard', 'standby', 'holidayAtHome', 'permanent']:
             with suppress(PyViCareNotSupportedFeatureError):
                 if self.service.getProperty(f"ventilation.operating.programs.{program}") is not None:
                     available_programs.append(program)

PyViCare/PyViCareHeatingDevice.py

@@ -68,13 +68,13 @@ def getDomesticHotWaterConfiguredTemperature(self):
 
     @handleNotSupported
     def getHotWaterStorageTemperatureTop(self):
-        return self.service.getProperty("heating.dhw.sensors.temperature.hotWaterStorage.top")["properties"]["value"][
+        return self.service.getProperty("heating.dhw.sensors.temperature.dhwCylinder.top")["properties"]["value"][
             "value"]
 
     @handleNotSupported
     def getHotWaterStorageTemperatureBottom(self):
         return \
-            self.service.getProperty("heating.dhw.sensors.temperature.hotWaterStorage.bottom")["properties"]["value"][
+            self.service.getProperty("heating.dhw.sensors.temperature.dhwCylinder.bottom")["properties"]["value"][
                 "value"]
 
     @handleNotSupported
@@ -115,7 +115,7 @@ def getDomesticHotWaterDesiredTemperature(self):
 
     @handleNotSupported
     def getDomesticHotWaterStorageTemperature(self):
-        return self.service.getProperty("heating.dhw.sensors.temperature.hotWaterStorage")["properties"]["value"][
+        return self.service.getProperty("heating.dhw.sensors.temperature.dhwCylinder")["properties"]["value"][
             "value"]
 
     @handleNotSupported
@@ -592,7 +592,7 @@ def getPrograms(self):
                         'comfortHeating', 'dhwPrecedence', 'eco', 'external', 'fixed', 'forcedLastFromSchedule',
                         'frostprotection', 'holiday', 'holidayAtHome', 'manual', 'normal', 'normalCooling',
                         'normalCoolingEnergySaving', 'normalEnergySaving', 'normalHeating', 'reduced', 'reducedCooling',
-                        'reducedCoolingEnergySaving', 'reducedEnergySaving', 'reducedHeating', 'standby', 'summerEco']:
+                        'reducedCoolingEnergySaving', 'reducedEnergySaving', 'reducedHeating', 'standby']:
             with suppress(PyViCareNotSupportedFeatureError):
                 if self.service.getProperty(
                         f"heating.circuits.{self.circuit}.operating.programs.{program}") is not None:

PyViCare/PyViCareVentilationDevice.py

@@ -36,8 +36,7 @@ def setActiveMode(self, mode):
     @handleNotSupported
     def getAvailablePrograms(self):
         available_programs = []
-        for program in ['basic', 'intensive', 'reduced', 'standard', 'standby', 'comfort', 'eco', 'forcedLevelFour',
-                        'holiday', 'holidayAtHome', 'levelFour', 'levelOne', 'levelThree', 'levelTwo', 'permanent', 'silent']:
+        for program in ['basic', 'intensive', 'reduced', 'standard', 'standby', 'holidayAtHome', 'permanent']:
             with suppress(PyViCareNotSupportedFeatureError):
                 if self.service.getProperty(f"ventilation.operating.programs.{program}") is not None:
                     available_programs.append(program)

tests/test_TestForMissingProperties.py

@@ -1,4 +1,3 @@
-import json
 import re
 import unittest
 from os import listdir
@@ -58,12 +57,18 @@ def test_missingProperties(self):
             'heating.circuits.0.name',  # TODO: to analyse, from Vitodens 100W
             'heating.circuits.0.zone.mode',  # TODO: to analyse, from Vitocal 250A
 
+            'heating.buffer.sensors.temperature.main',  # deprecated, removed 2024-09-15 FIXME: remove once data point is removed and test data is updated
+            'heating.buffer.sensors.temperature.top',  # deprecated, removed 2024-09-15 FIXME: remove once data point is removed and test data is updated
+            'heating.dhw.sensors.temperature.hotWaterStorage',  # deprecated, removed 2024-09-15 FIXME: remove once data point is removed and test data is updated
+            'heating.dhw.sensors.temperature.hotWaterStorage.top',  # deprecated, removed 2024-09-15 FIXME: remove once data point is removed and test data is updated
+            'heating.dhw.sensors.temperature.hotWaterStorage.bottom',  # deprecated, removed 2024-09-15 FIXME: remove once data point is removed and test data is updated
+
             # Ignored for now as both are not documented in https://documentation.viessmann.com/static/iot/data-points
             'device.messages.errors.raw',
             'device.productIdentification',
 
             # gateway
-            'gateway.devices', # not used
+            'gateway.devices',  # not used
         ]
 
         all_features = self.read_all_features()
@@ -77,13 +82,20 @@ def test_missingProperties(self):
             if not found and len(foundInFiles) > 0 and feature not in ignore:
                 missing_features[feature] = foundInFiles
 
-        has_missing_features = len(missing_features) > 0
-        self.assertFalse(has_missing_features, json.dumps(missing_features, sort_keys=True, indent=2))
+        self.assertDictEqual({}, missing_features)
 
     def test_unverifiedProperties(self):
         # with this test we want to verify if we access
         # properties which are not in any test response data
 
+        ignore = [
+            'heating.dhw.sensors.temperature.dhwCylinder',  # FIXME: remove once test data is updated
+            'heating.dhw.sensors.temperature.dhwCylinder.top',  # FIXME: remove once test data is updated
+            'heating.dhw.sensors.temperature.dhwCylinder.bottom',  # FIXME: remove once test data is updated
+            'heating.bufferCylinder.sensors.temperature.main',  # FIXME: remove once test data is updated
+            'heating.bufferCylinder.sensors.temperature.top',  # FIXME: remove once test data is updated
+        ]
+
         all_features = self.read_all_features()
         all_python_files = self.read_all_python_code()
 
@@ -98,7 +110,7 @@ def test_unverifiedProperties(self):
                 feature_name = re.sub(r'\.{(program|active_program)}', '', feature_name)
                 used_features.append(feature_name)
 
-        self.assertSetEqual(set([]), set(used_features) - set(all_features))
+        self.assertSetEqual(set([]), set(used_features) - set(all_features) - set(ignore))
 
     def find_feature_in_code(self, all_python_files, feature):
         search_string = f'[\'"]{feature}[\'"]'.replace(".", r"\.")

tests/test_VitoairFs300E.py

@@ -20,7 +20,7 @@ def test_getAvailableModes(self):
         self.assertListEqual(self.device.getAvailableModes(), expected_modes)
 
     def test_getAvailablePrograms(self):
-        expected_programs = ['standby', 'forcedLevelFour', 'levelFour', 'levelOne', 'levelThree', 'levelTwo', 'silent']
+        expected_programs = ['standby']
         self.assertListEqual(self.device.getAvailablePrograms(), expected_programs)
 
     def test_getSchedule(self):

tests/test_Vitocal250A.py

@@ -36,7 +36,7 @@ def test_getSupplyTemperaturePrimaryCircuit(self):
             self.device.getSupplyTemperaturePrimaryCircuit(), 5.9)
 
     def test_getPrograms(self):
-        expected_programs = ['comfortCooling', 'comfortCoolingEnergySaving', 'comfortEnergySaving', 'comfortHeating', 'fixed', 'forcedLastFromSchedule', 'frostprotection', 'normalCooling', 'normalCoolingEnergySaving', 'normalEnergySaving', 'normalHeating', 'reducedCooling', 'reducedCoolingEnergySaving', 'reducedEnergySaving', 'reducedHeating', 'standby', 'summerEco']
+        expected_programs = ['comfortCooling', 'comfortCoolingEnergySaving', 'comfortEnergySaving', 'comfortHeating', 'fixed', 'forcedLastFromSchedule', 'frostprotection', 'normalCooling', 'normalCoolingEnergySaving', 'normalEnergySaving', 'normalHeating', 'reducedCooling', 'reducedCoolingEnergySaving', 'reducedEnergySaving', 'reducedHeating', 'standby']
         self.assertListEqual(
             self.device.circuits[0].getPrograms(), expected_programs)
 
@@ -85,6 +85,7 @@ def test_getPowerSummaryConsumptionHeatingUnit(self):
         self.assertEqual(
             self.device.getPowerSummaryConsumptionHeatingUnit(), "kilowattHour")
 
+    @unittest.skip("dump is not up to date, underlying data point was rernamed")
     def test_getBufferMainTemperature(self):
         self.assertAlmostEqual(
             self.device.getBufferMainTemperature(), 31.9)

tests/test_Vitocaldens222F.py

@@ -21,10 +21,12 @@ def test_getAvailableCompressors(self):
     def test_getActive(self):
         self.assertEqual(self.device.burners[0].getActive(), False)
 
+    @unittest.skip("dump is not up to date, underlying data point was rernamed")
     def test_getBufferTopTemperature(self):
         self.assertEqual(
             self.device.getBufferTopTemperature(), 36)
 
+    @unittest.skip("dump is not up to date, underlying data point was rernamed")
     def test_getBufferMainTemperature(self):
         self.assertEqual(
             self.device.getBufferMainTemperature(), 36)
@@ -71,6 +73,7 @@ def test_getOutsideTemperature(self):
         self.assertEqual(
             self.device.getOutsideTemperature(), 15.3)
 
+    @unittest.skip("dump is not up to date, underlying data point was rernamed")
     def test_getHotWaterStorageTemperatureTop(self):
         self.assertEqual(
             self.device.getHotWaterStorageTemperatureTop(), 50.9)

tests/test_VitolaUniferral.py

@@ -25,5 +25,6 @@ def test_getBurnerHours(self):
     def test_getBoilerTemperature(self):
         self.assertEqual(self.device.getBoilerTemperature(), 26.6)
 
+    @unittest.skip("dump is not up to date, underlying data point was rernamed")
     def test_getDomesticHotWaterStorageTemperature(self):
         self.assertEqual(self.device.getDomesticHotWaterStorageTemperature(), 56.9)