feat: Add ventilation qickmode methods (#458)

* add qickmode methods * add qickmode methods * add more quickmodes * modify test case * add test case * add test case * add test case
openviess · Dec 2, 2024 · 7321c3e · 7321c3e
1 parent 10f5a7e
commit 7321c3e
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 2 deletions.
diff --git a/PyViCare/PyViCareVentilationDevice.py b/PyViCare/PyViCareVentilationDevice.py
@@ -107,3 +107,24 @@ def getVentilationLevel(self) -> str:
     @handleNotSupported
     def getVentilationReason(self) -> str:
         return str(self.service.getProperty("ventilation.operating.state")["properties"]["reason"]["value"])
+
+    @handleNotSupported
+    def getVentilationQuickmodes(self) -> list[str]:
+        available_quickmodes = []
+        for quickmode in ['comfort', 'eco', 'forcedLevelFour', 'holiday', 'standby', 'silent']:
+            with suppress(PyViCareNotSupportedFeatureError):
+                if self.service.getProperty(f"ventilation.quickmodes.{quickmode}") is not None:
+                    available_quickmodes.append(quickmode)
+        return available_quickmodes
+
+    @handleNotSupported
+    def getVentilationQuickmode(self, quickmode: str) -> bool:
+        return bool(self.service.getProperty(f"ventilation.quickmodes.{quickmode}")["properties"]["active"]["value"])
+
+    @handleNotSupported
+    def activateVentilationQuickmode(self, quickmode: str) -> None:
+        self.service.setProperty(f"ventilation.quickmodes.{quickmode}", "activate", {})
+
+    @handleNotSupported
+    def deactivateVentilationQuickmode(self, quickmode: str) -> None:
+        self.service.setProperty(f"ventilation.quickmodes.{quickmode}", "deactivate", {})
diff --git a/tests/test_TestForMissingProperties.py b/tests/test_TestForMissingProperties.py
@@ -80,7 +80,7 @@ def test_missingProperties(self):
             'ventilation.levels.levelTwo',
             'ventilation.levels.levelThree',
             'ventilation.levels.levelFour',
-            'ventilation.quickmodes.forcedLevelFour',
+            'ventilation.quickmodes.forcedLevelFour', # quickmode accessible via getVentilationQuickmode
             'ventilation.quickmodes.silent',
             'ventilation.quickmodes.standby',
             'ventilation.quickmodes.comfort',
@@ -129,6 +129,7 @@ def test_unverifiedProperties(self):
 
         ignore = [
             'heating.dhw.sensors.temperature.dhwCylinder.midBottom',  # FIXME: remove once test data is updated
+            'ventilation.quickmodes',
         ]
 
         all_features = self.read_all_features()
@@ -142,7 +143,7 @@ def test_unverifiedProperties(self):
             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'{burner}', '0', feature_name)
-                feature_name = re.sub(r'\.{(program|active_program)}', '', feature_name)
+                feature_name = re.sub(r'\.{(quickmode|program|active_program)}', '', feature_name)
                 used_features.append(feature_name)
 
         self.assertSetEqual(set([]), set(used_features) - set(all_features) - set(ignore))

diff --git a/tests/test_Vitopure350.py b/tests/test_Vitopure350.py
@@ -40,3 +40,25 @@ def test_ventilationState(self):
         self.assertEqual(self.device.getVentilationDemand(), "unknown")
         self.assertEqual(self.device.getVentilationLevel(), "unknown")
         self.assertEqual(self.device.getVentilationReason(), "sensorDriven")
+
+    def test_ventilationQuickmode(self):
+        self.assertEqual(self.device.getVentilationQuickmode("standby"), False)
+
+    def test_ventilationQuickmodes(self):
+        self.assertEqual(self.device.getVentilationQuickmodes(), [
+            "forcedLevelFour",
+            "standby",
+            "silent",
+        ])
+
+    def test_activateComfort(self):
+        self.device.activateVentilationQuickmode("standby")
+        self.assertEqual(len(self.service.setPropertyData), 1)
+        self.assertEqual(self.service.setPropertyData[0]['action'], 'activate')
+        self.assertEqual(self.service.setPropertyData[0]['property_name'], 'ventilation.quickmodes.standby')
+
+    def test_deactivateComfort(self):
+        self.device.deactivateVentilationQuickmode("standby")
+        self.assertEqual(len(self.service.setPropertyData), 1)
+        self.assertEqual(self.service.setPropertyData[0]['action'], 'deactivate')
+        self.assertEqual(self.service.setPropertyData[0]['property_name'], 'ventilation.quickmodes.standby')