Merge branch 'master' into fht

openviess · Nov 19, 2024 · 28b58f5 · 28b58f5
2 parents a703810 + 3b7103a
commit 28b58f5
Show file tree

Hide file tree

Showing 36 changed files with 10,027 additions and 1,918 deletions.
diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml
@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/[email protected].0
+        uses: actions/[email protected].2
       - name: 🚀 Sort test response data
         run: |
           find './tests/response' \

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -15,12 +15,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/[email protected].0
+        uses: actions/[email protected].2
       - name: 🏗 Set up Poetry
         run: pipx install poetry
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
         id: python
-        uses: actions/setup-python@v5.2.0
+        uses: actions/setup-python@v5.3.0
         with:
           python-version: ${{ env.DEFAULT_PYTHON }}
           cache: "poetry"
@@ -38,12 +38,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/[email protected].0
+        uses: actions/[email protected].2
       - name: 🏗 Set up Poetry
         run: pipx install poetry
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
         id: python
-        uses: actions/setup-python@v5.2.0
+        uses: actions/setup-python@v5.3.0
         with:
           python-version: ${{ env.DEFAULT_PYTHON }}
           cache: "poetry"
@@ -63,12 +63,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/[email protected].0
+        uses: actions/[email protected].2
       - name: 🏗 Set up Poetry
         run: pipx install poetry
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
         id: python
-        uses: actions/setup-python@v5.2.0
+        uses: actions/setup-python@v5.3.0
         with:
           python-version: ${{ env.DEFAULT_PYTHON }}
           cache: "poetry"

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -21,12 +21,12 @@ jobs:
       id-token: write
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/[email protected].0
+        uses: actions/[email protected].2
       - name: 🏗 Set up Poetry
         run: pipx install poetry
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
         id: python
-        uses: actions/setup-python@v5.2.0
+        uses: actions/setup-python@v5.3.0
         with:
           python-version: ${{ env.DEFAULT_PYTHON }}
           cache: "poetry"
@@ -45,7 +45,7 @@ jobs:
       - name: 🏗 Build package
         run: poetry build --no-interaction
       - name: 🚀 Publish to PyPi
-        uses: pypa/gh-action-pypi-publish@v1.10.2
+        uses: pypa/gh-action-pypi-publish@v1.12.2
         with:
           verbose: true
           print-hash: true

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -18,15 +18,15 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python: ["3.9", "3.10", "3.11", "3.12"]
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/[email protected].0
+        uses: actions/[email protected].2
       - name: 🏗 Set up Poetry
         run: pipx install poetry
       - name: 🏗 Set up Python ${{ matrix.python }}
         id: python
-        uses: actions/setup-python@v5.2.0
+        uses: actions/setup-python@v5.3.0
         with:
           python-version: ${{ matrix.python }}
           cache: "poetry"
@@ -39,7 +39,7 @@ jobs:
       - name: 🚀 Run pytest
         run: poetry run pytest --cov PyViCare
       - name: ⬆️ Upload coverage artifact
-        uses: actions/[email protected].0
+        uses: actions/[email protected].3
         with:
           name: coverage-${{ matrix.python }}
           path: .coverage
diff --git a/.github/workflows/type.yml b/.github/workflows/type.yml
@@ -18,12 +18,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/[email protected].0
+        uses: actions/[email protected].2
       - name: 🏗 Set up Poetry
         run: pipx install poetry
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
         id: python
-        uses: actions/setup-python@v5.2.0
+        uses: actions/setup-python@v5.3.0
         with:
           python-version: ${{ env.DEFAULT_PYTHON }}
           cache: "poetry"

diff --git a/PyViCare/PyViCareDevice.py b/PyViCare/PyViCareDevice.py
@@ -1,5 +1,5 @@
 from PyViCare.PyViCareService import ViCareService
-from PyViCare.PyViCareUtils import handleNotSupported
+from PyViCare.PyViCareUtils import PyViCareNotSupportedFeatureError, handleNotSupported
 
 
 class Device:
@@ -15,3 +15,24 @@ def __init__(self, service: ViCareService) -> None:
     @handleNotSupported
     def getSerial(self):
         return self.service.getProperty("device.serial")["properties"]["value"]["value"]
+
+    def isLegacyDevice(self) -> bool:
+        return self.service.hasRoles(["type:legacy"])
+
+    def isE3Device(self) -> bool:
+        return self.service.hasRoles(["type:E3"])
+
+    def isDomesticHotWaterDevice(self):
+        return self._isTypeDevice("heating.dhw")
+
+    def isSolarThermalDevice(self):
+        return self._isTypeDevice("heating.solar")
+
+    def isVentilationDevice(self):
+        return self._isTypeDevice("ventilation")
+
+    def _isTypeDevice(self, deviceType: str):
+        try:
+            return self.service.getProperty(deviceType)["isEnabled"] and self.service.getProperty(deviceType)["properties"]["active"]["value"]
+        except PyViCareNotSupportedFeatureError:
+            return False
diff --git a/PyViCare/PyViCareDeviceConfig.py b/PyViCare/PyViCareDeviceConfig.py
@@ -88,9 +88,12 @@ def asAutoDetectDevice(self):
             (self.asPelletsBoiler, r"Vitoligno|Ecotronic|VBC550P", []),
             (self.asElectricalEnergySystem, r"E3_VitoCharge_03", ["type:ees"]),
             (self.asVentilation, r"E3_ViAir", ["type:ventilation"]),
+            (self.asVentilation, r"E3_ViAir", ["type:ventilation;central"]),
+            (self.asVentilation, r"E3_VitoPure", ["type:ventilation;purifier"]),
             (self.asRadiatorActuator, r"E3_RadiatorActuator", ["type:radiator"]),
             (self.asFloorHeating, r"E3_FloorHeatingCircuitDistributorBox", ["type:fhtMain"]),
             (self.asRoomSensor, r"E3_RoomSensor", ["type:climateSensor"]),
+            (self.asGateway, r"E3_TCU41_x04", ["type:gateway;TCU100"]),
             (self.asGateway, r"E3_TCU19_x05", ["type:gateway;TCU200"]),
             (self.asGateway, r"E3_TCU10_x07", ["type:gateway;TCU300"]),
             (self.asGateway, r"Heatbox1", ["type:gateway;VitoconnectOpto1"]),

diff --git a/PyViCare/PyViCareHeatingDevice.py b/PyViCare/PyViCareHeatingDevice.py
@@ -66,16 +66,30 @@ def getOutsideTemperature(self):
     def getDomesticHotWaterConfiguredTemperature(self):
         return self.service.getProperty("heating.dhw.temperature.main")["properties"]["value"]["value"]
 
+    @handleNotSupported
+    def getDomesticHotWaterStorageTemperature(self):
+        return self.service.getProperty("heating.dhw.sensors.temperature.dhwCylinder")["properties"]["value"][
+            "value"]
+
     @handleNotSupported
     def getHotWaterStorageTemperatureTop(self):
         return self.service.getProperty("heating.dhw.sensors.temperature.dhwCylinder.top")["properties"]["value"][
             "value"]
 
+    @handleNotSupported
+    def getDomesticHotWaterStorageTemperatureMiddle(self):
+        return self.service.getProperty("heating.dhw.sensors.temperature.dhwCylinder.middle")["properties"]["value"][
+            "value"]
+
+    @handleNotSupported
+    def getDomesticHotWaterStorageTemperatureMidBottom(self):
+        return self.service.getProperty("heating.dhw.sensors.temperature.dhwCylinder.midBottom")["properties"]["value"][
+            "value"]
+
     @handleNotSupported
     def getHotWaterStorageTemperatureBottom(self):
-        return \
-            self.service.getProperty("heating.dhw.sensors.temperature.dhwCylinder.bottom")["properties"]["value"][
-                "value"]
+        return self.service.getProperty("heating.dhw.sensors.temperature.dhwCylinder.bottom")["properties"]["value"][
+            "value"]
 
     @handleNotSupported
     def getDomesticHotWaterConfiguredTemperature2(self):
@@ -113,11 +127,6 @@ def getDomesticHotWaterDesiredTemperature(self):
 
         return None
 
-    @handleNotSupported
-    def getDomesticHotWaterStorageTemperature(self):
-        return self.service.getProperty("heating.dhw.sensors.temperature.dhwCylinder")["properties"]["value"][
-            "value"]
-
     @handleNotSupported
     def getDomesticHotWaterOutletTemperature(self):
         return self.service.getProperty("heating.dhw.sensors.temperature.outlet")["properties"]["value"]["value"]

diff --git a/PyViCare/PyViCareRadiatorActuator.py b/PyViCare/PyViCareRadiatorActuator.py
@@ -1,8 +1,8 @@
-from PyViCare.PyViCareHeatingDevice import HeatingDevice
+from PyViCare.PyViCareDevice import Device
 from PyViCare.PyViCareUtils import handleAPICommandErrors, handleNotSupported
 
 
-class RadiatorActuator(HeatingDevice):
+class RadiatorActuator(Device):
 
     @handleNotSupported
     def getTemperature(self):

diff --git a/PyViCare/PyViCareService.py b/PyViCare/PyViCareService.py
@@ -48,7 +48,7 @@ def hasRoles(self, requested_roles) -> bool:
         return hasRoles(requested_roles, self.roles)
 
     def _isGateway(self) -> bool:
-        return self.hasRoles(["type:gateway;VitoconnectOpto1"]) or self.hasRoles(["type:gateway;VitoconnectOpto2/OT2"]) or self.hasRoles(["type:gateway;TCU300"])
+        return self.hasRoles(["type:gateway;VitoconnectOpto1"]) or self.hasRoles(["type:gateway;VitoconnectOpto2/OT2"]) or self.hasRoles(["type:gateway;TCU100"]) or self.hasRoles(["type:gateway;TCU200"]) or self.hasRoles(["type:gateway;TCU300"])
 
     def setProperty(self, property_name: str, action: str, data: Any) -> Any:
         url = buildSetPropertyUrl(