refactor: abstract away service calls (#627)

* abstract service.setProperty

* abstract service.getProperty

Author: CFenner

PyViCare/PyViCareDevice.py

@@ -14,13 +14,19 @@ class Device:
     def __init__(self, service: ViCareService) -> None:
         self.service = service
 
+    def getProperty(self, property_name: str) -> Any:
+        return self.service.getProperty(property_name)
+
+    def setProperty(self, property_name: str, action: str, data: Any) -> Any:
+        return self.service.setProperty(property_name, action, data)
+
     @handleNotSupported
     def getSerial(self):
-        return self.service.getProperty("device.serial")["properties"]["value"]["value"]
+        return self.getProperty("device.serial")["properties"]["value"]["value"]
 
     @handleNotSupported
     def getDeviceErrors(self) -> list[Any]:
-        return list[Any](self.service.getProperty("device.messages.errors.raw")["properties"]["entries"]["value"])
+        return list[Any](self.getProperty("device.messages.errors.raw")["properties"]["entries"]["value"])
 
     def isLegacyDevice(self) -> bool:
         return self.service.hasRoles(["type:legacy"])
@@ -39,7 +45,7 @@ def isVentilationDevice(self):
 
     def _isTypeDevice(self, deviceType: str):
         try:
-            return self.service.getProperty(deviceType)["isEnabled"] and self.service.getProperty(deviceType)["properties"]["active"]["value"]
+            return self.getProperty(deviceType)["isEnabled"] and self.getProperty(deviceType)["properties"]["active"]["value"]
         except PyViCareNotSupportedFeatureError:
             return False
 
@@ -48,30 +54,30 @@ class ZigbeeDevice(Device):
 
     @handleNotSupported
     def getSerial(self) -> str:
-        return str(self.service.getProperty("device.zigbee.parent.id")["deviceId"])
+        return str(self.getProperty("device.zigbee.parent.id")["deviceId"])
 
     @handleNotSupported
     def getZigbeeParentID(self) -> str:
-        return str(self.service.getProperty("device.zigbee.parent.id")["properties"]["value"]["value"])
+        return str(self.getProperty("device.zigbee.parent.id")["properties"]["value"]["value"])
 
     @handleNotSupported
     def getZigbeeSignalStrength(self) -> int:
-        return int(self.service.getProperty("device.zigbee.lqi")["properties"]["strength"]["value"])
+        return int(self.getProperty("device.zigbee.lqi")["properties"]["strength"]["value"])
 
     @handleNotSupported
     def getName(self) -> str:
-        return str(self.service.getProperty("device.name")["properties"]["name"]["value"])
+        return str(self.getProperty("device.name")["properties"]["name"]["value"])
 
     @handleAPICommandErrors
     def setName(self, name: str) -> None:
-        self.service.setProperty("device.name", "setName", {'name': name})
+        self.setProperty("device.name", "setName", {'name': name})
 
     @handleNotSupported
     def getIdentification(self) -> bool:
-        return bool(self.service.getProperty("device.identification")["properties"]["triggered"]["value"])
+        return bool(self.getProperty("device.identification")["properties"]["triggered"]["value"])
 
 class ZigbeeBatteryDevice(ZigbeeDevice):
 
     @handleNotSupported
     def getBatteryLevel(self) -> int:
-        return int(self.service.getProperty("device.power.battery")["properties"]["level"]["value"])
+        return int(self.getProperty("device.power.battery")["properties"]["level"]["value"])

PyViCare/PyViCareElectricalEnergySystem.py

@@ -6,182 +6,182 @@ class ElectricalEnergySystem(Device):
 
     @handleNotSupported
     def getPointOfCommonCouplingTransferPowerExchange(self):
-        return self.service.getProperty("pcc.transfer.power.exchange")["properties"][
+        return self.getProperty("pcc.transfer.power.exchange")["properties"][
             "value"
         ]["value"]
 
     @handleNotSupported
     def getPhotovoltaicProductionCumulatedUnit(self):
-        return self.service.getProperty("photovoltaic.production.cumulated")[
+        return self.getProperty("photovoltaic.production.cumulated")[
             "properties"
         ]["currentDay"]["unit"]
 
     @handleNotSupported
     def getPhotovoltaicProductionCumulatedCurrentDay(self):
-        return self.service.getProperty("photovoltaic.production.cumulated")[
+        return self.getProperty("photovoltaic.production.cumulated")[
             "properties"
         ]["currentDay"]["value"]
 
     @handleNotSupported
     def getPhotovoltaicProductionCumulatedCurrentWeek(self):
-        return self.service.getProperty("photovoltaic.production.cumulated")[
+        return self.getProperty("photovoltaic.production.cumulated")[
             "properties"
         ]["currentWeek"]["value"]
 
     @handleNotSupported
     def getPhotovoltaicProductionCumulatedCurrentMonth(self):
-        return self.service.getProperty("photovoltaic.production.cumulated")[
+        return self.getProperty("photovoltaic.production.cumulated")[
             "properties"
         ]["currentMonth"]["value"]
 
     @handleNotSupported
     def getPhotovoltaicProductionCumulatedCurrentYear(self):
-        return self.service.getProperty("photovoltaic.production.cumulated")[
+        return self.getProperty("photovoltaic.production.cumulated")[
             "properties"
         ]["currentYear"]["value"]
 
     @handleNotSupported
     def getPhotovoltaicProductionCumulatedLifeCycle(self):
-        return self.service.getProperty("photovoltaic.production.cumulated")[
+        return self.getProperty("photovoltaic.production.cumulated")[
             "properties"
         ]["lifeCycle"]["value"]
 
     @handleNotSupported
     def getPhotovoltaicStatus(self):
-        return self.service.getProperty("photovoltaic.status")["properties"]["status"][
+        return self.getProperty("photovoltaic.status")["properties"]["status"][
             "value"
         ]
 
     @handleNotSupported
     def getPhotovoltaicProductionCurrent(self):
-        return self.service.getProperty("photovoltaic.production.current")[
+        return self.getProperty("photovoltaic.production.current")[
             "properties"
         ]["value"]["value"]
 
     @handleNotSupported
     def getPhotovoltaicProductionCurrentUnit(self):
-        return self.service.getProperty("photovoltaic.production.current")[
+        return self.getProperty("photovoltaic.production.current")[
             "properties"
         ]["value"]["unit"]
 
     @handleNotSupported
     def getPointOfCommonCouplingTransferConsumptionTotal(self):
-        return self.service.getProperty("pcc.transfer.consumption.total")["properties"][
+        return self.getProperty("pcc.transfer.consumption.total")["properties"][
             "value"
         ]["value"]
 
     @handleNotSupported
     def getPointOfCommonCouplingTransferConsumptionTotalUnit(self):
-        return self.service.getProperty("pcc.transfer.consumption.total")["properties"][
+        return self.getProperty("pcc.transfer.consumption.total")["properties"][
             "value"
         ]["unit"]
 
     @handleNotSupported
     def getPointOfCommonCouplingTransferFeedInTotal(self):
-        return self.service.getProperty("pcc.transfer.feedIn.total")["properties"][
+        return self.getProperty("pcc.transfer.feedIn.total")["properties"][
             "value"
         ]["value"]
 
     @handleNotSupported
     def getPointOfCommonCouplingTransferFeedInTotalUnit(self):
-        return self.service.getProperty("pcc.transfer.feedIn.total")["properties"][
+        return self.getProperty("pcc.transfer.feedIn.total")["properties"][
             "value"
         ]["unit"]
 
     @handleNotSupported
     def getElectricalEnergySystemTransferChargeCumulatedUnit(self):
-        return self.service.getProperty("ess.transfer.charge.cumulated")[
+        return self.getProperty("ess.transfer.charge.cumulated")[
             "properties"
         ]["currentDay"]["unit"]
 
     @handleNotSupported
     def getElectricalEnergySystemTransferChargeCumulatedCurrentDay(self):
-        return self.service.getProperty("ess.transfer.charge.cumulated")[
+        return self.getProperty("ess.transfer.charge.cumulated")[
             "properties"
         ]["currentDay"]["value"]
 
     @handleNotSupported
     def getElectricalEnergySystemTransferChargeCumulatedCurrentWeek(self):
-        return self.service.getProperty("ess.transfer.charge.cumulated")[
+        return self.getProperty("ess.transfer.charge.cumulated")[
             "properties"
         ]["currentWeek"]["value"]
 
     @handleNotSupported
     def getElectricalEnergySystemTransferChargeCumulatedCurrentMonth(self):
-        return self.service.getProperty("ess.transfer.charge.cumulated")[
+        return self.getProperty("ess.transfer.charge.cumulated")[
             "properties"
         ]["currentMonth"]["value"]
 
     @handleNotSupported
     def getElectricalEnergySystemTransferChargeCumulatedCurrentYear(self):
-        return self.service.getProperty("ess.transfer.charge.cumulated")[
+        return self.getProperty("ess.transfer.charge.cumulated")[
             "properties"
         ]["currentYear"]["value"]
 
     @handleNotSupported
     def getElectricalEnergySystemTransferChargeCumulatedLifeCycle(self):
-        return self.service.getProperty("ess.transfer.charge.cumulated")[
+        return self.getProperty("ess.transfer.charge.cumulated")[
             "properties"
         ]["lifeCycle"]["value"]
 
     @handleNotSupported
     def getElectricalEnergySystemTransferDischargeCumulatedUnit(self):
-        return self.service.getProperty("ess.transfer.discharge.cumulated")[
+        return self.getProperty("ess.transfer.discharge.cumulated")[
             "properties"
         ]["currentDay"]["unit"]
 
     @handleNotSupported
     def getElectricalEnergySystemTransferDischargeCumulatedCurrentDay(self):
-        return self.service.getProperty("ess.transfer.discharge.cumulated")[
+        return self.getProperty("ess.transfer.discharge.cumulated")[
             "properties"
         ]["currentDay"]["value"]
 
     @handleNotSupported
     def getElectricalEnergySystemTransferDischargeCumulatedCurrentWeek(self):
-        return self.service.getProperty("ess.transfer.discharge.cumulated")[
+        return self.getProperty("ess.transfer.discharge.cumulated")[
             "properties"
         ]["currentWeek"]["value"]
 
     @handleNotSupported
     def getElectricalEnergySystemTransferDischargeCumulatedCurrentMonth(self):
-        return self.service.getProperty("ess.transfer.discharge.cumulated")[
+        return self.getProperty("ess.transfer.discharge.cumulated")[
             "properties"
         ]["currentMonth"]["value"]
 
     @handleNotSupported
     def getElectricalEnergySystemTransferDischargeCumulatedCurrentYear(self):
-        return self.service.getProperty("ess.transfer.discharge.cumulated")[
+        return self.getProperty("ess.transfer.discharge.cumulated")[
             "properties"
         ]["currentYear"]["value"]
 
     @handleNotSupported
     def getElectricalEnergySystemTransferDischargeCumulatedLifeCycle(self):
-        return self.service.getProperty("ess.transfer.discharge.cumulated")[
+        return self.getProperty("ess.transfer.discharge.cumulated")[
             "properties"
         ]["lifeCycle"]["value"]
 
     @handleNotSupported
     def getElectricalEnergySystemSOC(self):
-        return self.service.getProperty("ess.stateOfCharge")["properties"]["value"][
+        return self.getProperty("ess.stateOfCharge")["properties"]["value"][
             "value"
         ]
 
     @handleNotSupported
     def getElectricalEnergySystemSOCUnit(self):
-        return self.service.getProperty("ess.stateOfCharge")["properties"]["value"][
+        return self.getProperty("ess.stateOfCharge")["properties"]["value"][
             "unit"
         ]
 
     @handleNotSupported
     def getElectricalEnergySystemPower(self):
-        return self.service.getProperty("ess.power")["properties"]["value"]["value"]
+        return self.getProperty("ess.power")["properties"]["value"]["value"]
 
     @handleNotSupported
     def getElectricalEnergySystemPowerUnit(self):
-        return self.service.getProperty("ess.power")["properties"]["value"]["unit"]
+        return self.getProperty("ess.power")["properties"]["value"]["unit"]
 
     @handleNotSupported
     def getElectricalEnergySystemOperationState(self):
-        return self.service.getProperty("ess.operationState")["properties"]["value"][
+        return self.getProperty("ess.operationState")["properties"]["value"][
             "value"
         ]

PyViCare/PyViCareFloorHeating.py

@@ -6,30 +6,30 @@ class FloorHeating(ZigbeeDevice):
 
     @handleNotSupported
     def getSupplyTemperature(self) -> float:
-        return float(self.service.getProperty("fht.sensors.temperature.supply")["properties"]["value"]["value"])
+        return float(self.getProperty("fht.sensors.temperature.supply")["properties"]["value"]["value"])
 
     @handleNotSupported
     def getActiveMode(self) -> str:
-        return str(self.service.getProperty("fht.operating.modes.active")["properties"]["value"]["value"])
+        return str(self.getProperty("fht.operating.modes.active")["properties"]["value"]["value"])
 
 
 class FloorHeatingChannel(Device):
 
     @handleNotSupported
     def getSerial(self) -> str:
-        return str(self.service.getProperty("device.name")["deviceId"])
+        return str(self.getProperty("device.name")["deviceId"])
 
     @handleNotSupported
     def getName(self) -> str:
-        return str(self.service.getProperty("device.name")["properties"]["name"]["value"])
+        return str(self.getProperty("device.name")["properties"]["name"]["value"])
 
     @handleAPICommandErrors
     def setName(self, name: str) -> None:
-        self.service.setProperty("device.name", "setName", {'name': name})
+        self.setProperty("device.name", "setName", {'name': name})
 
     @handleNotSupported
     def getValveState(self) -> str:
-        return str(self.service.getProperty("fht.valve.state")["properties"]["status"]["value"])
+        return str(self.getProperty("fht.valve.state")["properties"]["status"]["value"])
 
     @handleNotSupported
     def isValveOpen(self) -> bool: