Merge pull request #143 from oischinger/pyvicare-2_28-1

Update PyViCare to 2.28.1
oischinger · Aug 12, 2023 · 7f68ab9 · 7f68ab9 · github-actions · Aug 12, 2023
2 parents 491c82a + 9de694e
commit 7f68ab9
Show file tree

Hide file tree

Showing 7 changed files with 64 additions and 33 deletions.
diff --git a/custom_components/vicare/binary_sensor.py b/custom_components/vicare/binary_sensor.py
@@ -25,7 +25,14 @@
 
 from . import ViCareRequiredKeysMixin
 from .const import DOMAIN, VICARE_DEVICE_CONFIG, VICARE_NAME
-from .helpers import get_device_name, get_unique_device_id, get_unique_id
+from .helpers import (
+    get_burners,
+    get_circuits,
+    get_compressors,
+    get_device_name,
+    get_unique_device_id,
+    get_unique_id,
+)
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -172,7 +179,7 @@ def create_all_entities(hass: HomeAssistant, config_entry: ConfigEntry):
                 name,
                 entities,
                 CIRCUIT_SENSORS,
-                api.circuits,
+                get_circuits(api),
                 config_entry,
                 device,
             )
@@ -181,7 +188,7 @@ def create_all_entities(hass: HomeAssistant, config_entry: ConfigEntry):
 
         try:
             _entities_from_descriptions(
-                hass, name, entities, BURNER_SENSORS, api.burners, config_entry, device
+                hass, name, entities, BURNER_SENSORS, get_burners(api), config_entry, device
             )
         except PyViCareNotSupportedFeatureError:
             _LOGGER.info("No burners found")
@@ -192,7 +199,7 @@ def create_all_entities(hass: HomeAssistant, config_entry: ConfigEntry):
                 name,
                 entities,
                 COMPRESSOR_SENSORS,
-                api.compressors,
+                get_compressors(api),
                 config_entry,
                 device,
             )

diff --git a/custom_components/vicare/climate.py b/custom_components/vicare/climate.py
@@ -37,7 +37,13 @@
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
 from .const import DOMAIN, VICARE_DEVICE_CONFIG, VICARE_NAME
-from .helpers import get_device_name, get_unique_device_id, get_unique_id
+from .helpers import (
+    get_burners,
+    get_circuits,
+    get_device_name,
+    get_unique_device_id,
+    get_unique_id,
+)
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -101,15 +107,6 @@
 }
 
 
-def _get_circuits(vicare_api):
-    """Return the list of circuits."""
-    try:
-        return vicare_api.circuits
-    except PyViCareNotSupportedFeatureError:
-        _LOGGER.info("No circuits found")
-        return []
-
-
 async def async_setup_entry(
     hass: HomeAssistant,
     config_entry: ConfigEntry,
@@ -122,7 +119,7 @@ async def async_setup_entry(
     for device in hass.data[DOMAIN][config_entry.entry_id][VICARE_DEVICE_CONFIG]:
         api = device.asAutoDetectDevice()
 
-        circuits = await hass.async_add_executor_job(_get_circuits, api)
+        circuits = await hass.async_add_executor_job(get_circuits, api)
         for circuit in circuits:
             suffix = ""
             if len(circuits) > 1:
@@ -261,7 +258,7 @@ def update(self) -> None:
             self._current_action = False
             # Update the specific device attributes
             with suppress(PyViCareNotSupportedFeatureError):
-                for burner in self._api.burners:
+                for burner in get_burners(self._api):
                     self._current_action = self._current_action or burner.getActive()
 
             with suppress(PyViCareNotSupportedFeatureError):

diff --git a/custom_components/vicare/helpers.py b/custom_components/vicare/helpers.py
@@ -1,4 +1,6 @@
 """Helpers for ViCare."""
+from PyViCare.PyViCareHeatingDevice import HeatingDevice
+from PyViCare.PyViCareUtils import PyViCareNotSupportedFeatureError
 
 
 def get_unique_id(api, device_config, entity_id) -> str:
@@ -17,3 +19,30 @@ def get_unique_device_id(device_config) -> str:
 def get_device_name(device_config) -> str:
     """Return name for this device."""
     return f"{device_config.getModel()}-{device_config.getConfig().id}-{device_config.getConfig().device_id}"
+
+def get_circuits(vicare_api):
+    """Return the list of circuits."""
+    if not isinstance(vicare_api, HeatingDevice):
+        return []
+    try:
+        return vicare_api.circuits
+    except PyViCareNotSupportedFeatureError:
+        return []
+
+def get_burners(vicare_api):
+    """Return the list of burners."""
+    if not isinstance(vicare_api, HeatingDevice):
+        return []
+    try:
+        return vicare_api.burners
+    except PyViCareNotSupportedFeatureError:
+        return []
+
+def get_compressors(vicare_api):
+    """Return the list of compressors."""
+    if not isinstance(vicare_api, HeatingDevice):
+        return []
+    try:
+        return vicare_api.compressors
+    except PyViCareNotSupportedFeatureError:
+        return []
diff --git a/custom_components/vicare/manifest.json b/custom_components/vicare/manifest.json
@@ -11,6 +11,6 @@
   "documentation": "https://www.home-assistant.io/integrations/vicare",
   "iot_class": "cloud_polling",
   "loggers": ["PyViCare"],
-  "requirements": ["PyViCare==2.25.0"],
+  "requirements": ["PyViCare==2.28.1"],
   "version": "2.0.0"
 }
diff --git a/custom_components/vicare/sensor.py b/custom_components/vicare/sensor.py
@@ -43,7 +43,14 @@
     VICARE_NAME,
     VICARE_UNIT_TO_UNIT_OF_MEASUREMENT,
 )
-from .helpers import get_device_name, get_unique_device_id, get_unique_id
+from .helpers import (
+    get_burners,
+    get_circuits,
+    get_compressors,
+    get_device_name,
+    get_unique_device_id,
+    get_unique_id,
+)
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -666,7 +673,7 @@ def create_all_entities(hass: HomeAssistant, config_entry: ConfigEntry):
                 name,
                 entities,
                 CIRCUIT_SENSORS,
-                api.circuits,
+                get_circuits(api),
                 config_entry,
                 device,
             )
@@ -675,7 +682,7 @@ def create_all_entities(hass: HomeAssistant, config_entry: ConfigEntry):
 
         try:
             _entities_from_descriptions(
-                hass, name, entities, BURNER_SENSORS, api.burners, config_entry, device
+                hass, name, entities, BURNER_SENSORS, get_burners(api), config_entry, device
             )
         except PyViCareNotSupportedFeatureError:
             _LOGGER.info("No burners found")
@@ -686,7 +693,7 @@ def create_all_entities(hass: HomeAssistant, config_entry: ConfigEntry):
                 name,
                 entities,
                 COMPRESSOR_SENSORS,
-                api.compressors,
+                get_compressors(api),
                 config_entry,
                 device,
             )

diff --git a/custom_components/vicare/water_heater.py b/custom_components/vicare/water_heater.py
@@ -26,7 +26,7 @@
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
 from .const import DOMAIN, VICARE_DEVICE_CONFIG, VICARE_NAME
-from .helpers import get_device_name, get_unique_device_id, get_unique_id
+from .helpers import get_circuits, get_device_name, get_unique_device_id, get_unique_id
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -60,15 +60,6 @@
 }
 
 
-def _get_circuits(vicare_api):
-    """Return the list of circuits."""
-    try:
-        return vicare_api.circuits
-    except PyViCareNotSupportedFeatureError:
-        _LOGGER.info("No circuits found")
-        return []
-
-
 async def async_setup_entry(
     hass: HomeAssistant,
     config_entry: ConfigEntry,
@@ -81,7 +72,7 @@ async def async_setup_entry(
     for device in hass.data[DOMAIN][config_entry.entry_id][VICARE_DEVICE_CONFIG]:
         api = device.asAutoDetectDevice()
 
-        circuits = await hass.async_add_executor_job(_get_circuits, api)
+        circuits = await hass.async_add_executor_job(get_circuits, api)
         for circuit in circuits:
             suffix = ""
             if len(circuits) > 1:

diff --git a/requirements_dev.txt b/requirements_dev.txt
@@ -1,2 +1,2 @@
-PyViCare == 2.25.0
+PyViCare >= 2.28.1
 homeassistant >= 2023.4.1
File	Stmts	Miss	Cover	Missing
__init__.py	68	11	83%	57, 61, 65, 74, 79–80, 89, 110–112, 118
binary_sensor.py	99	16	83%	114, 117, 186–187, 193–194, 206–207, 266–273
button.py	72	15	79%	58, 61, 63–64, 125–135
climate.py	216	83	61%	214–217, 219–221, 223–226, 228, 230–231, 233–234, 236–237, 240, 242–244, 246–247, 251–252, 256, 258, 260–262, 264–266, 270–277, 301–302, 304–306, 308–309, 313–314, 316–320, 328–335, 341, 361–363, 377–379, 383–384, 386–390, 392, 401–402, 404, 408
config_flow.py	14	0	100%
const.py	21	0	100%
diagnostics.py	19	19	0%	2, 4–5, 7–10, 12–13, 15, 18, 22, 24, 30, 32–36
helpers.py	32	6	81%	29–30, 38–39, 47–48
sensor.py	107	19	82%	608, 611, 680–681, 687–688, 700–701, 762–763, 766, 769–776
water_heater.py	106	20	81%	106–108, 112–113, 117–118, 120–127, 172–174, 189, 199
TOTAL	754	189	74%