hyxi-cloud-api 1.2.2__tar.gz → 1.2.4__tar.gz

{hyxi_cloud_api-1.2.2/src/hyxi_cloud_api.egg-info → hyxi_cloud_api-1.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyxi-cloud-api
-Version: 1.2.2
+Version: 1.2.4
 Summary: An async API client for HYXi Cloud.
 Author-email: Veldkornet <Veldkornet@users.noreply.github.com>
 Classifier: Programming Language :: Python :: 3

{hyxi_cloud_api-1.2.2 → hyxi_cloud_api-1.2.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "hyxi-cloud-api"
-version = "1.2.2"
+version = "1.2.4"
 authors = [
   { name="Veldkornet", email="Veldkornet@users.noreply.github.com" },
 ]

{hyxi_cloud_api-1.2.2 → hyxi_cloud_api-1.2.4}/src/hyxi_cloud_api/__init__.py

@@ -2,5 +2,5 @@
 
 from .api import HyxiApiClient
 
-__version__ = "1.2.2"
+__version__ = "1.2.4"
 __all__ = ["HyxiApiClient"]

{hyxi_cloud_api-1.2.2 → hyxi_cloud_api-1.2.4}/src/hyxi_cloud_api/api.py

@@ -566,20 +566,19 @@ def _get_f(key: str, data_map: dict, mult: float = 1.0) -> float:
         return 0.0
 
 
-def _filter_collector_metrics(m_raw: dict) -> dict:
-    """Remove battery/power metrics that shouldn't be present on Collectors."""
-    return {k: v for k, v in m_raw.items() if not _COLLECTOR_FILTER_REGEX.search(k)}
+@functools.lru_cache(maxsize=1024)
+def _is_collector_key_allowed(key: str) -> bool:
+    """Check if metric key is allowed for Collectors and cache the result."""
+    return not _COLLECTOR_FILTER_REGEX.search(key)
 
 
-def _compute_derived_metrics(m_raw: dict, device_type: str = "") -> dict:
-    """Calculate derived metrics from raw metrics map.
+def _filter_collector_metrics(m_raw: dict) -> dict:
+    """Remove battery/power metrics that shouldn't be present on Collectors."""
+    return {k: v for k, v in m_raw.items() if _is_collector_key_allowed(k)}
 
-    Only keys that have relevant base data in m_raw will be included in the
-    resulting dictionary to avoid 'ghost' sensors for unsupported features.
-    """
-    derived = {}
 
-    # 1. Load Calculation
+def _compute_load_metrics(m_raw: dict, derived: dict[str, float]) -> None:
+    """Calculate home load metrics."""
     if "ph1Loadp" in m_raw or "ph2Loadp" in m_raw or "ph3Loadp" in m_raw:
         derived["home_load"] = (
             _get_f("ph1Loadp", m_raw)
@@ -587,21 +586,28 @@ def _compute_derived_metrics(m_raw: dict, device_type: str = "") -> dict:
             + _get_f("ph3Loadp", m_raw)
         )
 
-    # 2. Grid Metrics
+
+def _compute_grid_metrics(m_raw: dict, derived: dict[str, float]) -> None:
+    """Calculate grid import/export metrics."""
     if "gridP" in m_raw:
         grid = _get_f("gridP", m_raw, 1000.0)
         derived["grid_import"] = abs(grid) if grid < 0 else 0.0
         derived["grid_export"] = grid if grid > 0 else 0.0
 
-    # 3. Battery Metrics
+
+def _compute_battery_metrics(
+    m_raw: dict, derived: dict[str, float], device_type: str
+) -> None:
+    """Calculate battery charge/discharge metrics."""
     bat_p_dc = _get_f("batP", m_raw)
     pbat = _get_f("pbat", m_raw)
+    device_type_str = str(device_type or "").upper()
 
-    if "batP" in m_raw or "pbat" in m_raw:
+    if "batP" in m_raw or "pbat" in m_raw or device_type_str in ("EMS", "15", "16"):
         # ALL_IN_ONE: prefer pbat — batP can have an inverted sign convention,
         # while pbat is consistently negative-for-charging / positive-for-discharging.
         # Other devices: prefer batP (DC terminals), fall back to pbat.
-        if device_type.upper() == "ALL_IN_ONE":
+        if device_type_str == "ALL_IN_ONE":
             power_source = pbat if pbat != 0.0 else bat_p_dc
         else:
             power_source = bat_p_dc if bat_p_dc != 0.0 else pbat
@@ -614,7 +620,9 @@ def _compute_derived_metrics(m_raw: dict, device_type: str = "") -> dict:
     if "batDisCharge" in m_raw:
         derived["bat_discharge_total"] = _get_f("batDisCharge", m_raw)
 
-    # 4. PV String Powers (Derived if missing)
+
+def _compute_pv_metrics(m_raw: dict, derived: dict[str, float]) -> None:
+    """Calculate PV string powers."""
     for v_k, i_k, p_k in _PV_KEYS:
         if v_k in m_raw or i_k in m_raw or p_k in m_raw:
             derived[p_k] = _get_f(p_k, m_raw) or round(
@@ -631,15 +639,30 @@ def _compute_derived_metrics(m_raw: dict, device_type: str = "") -> dict:
         ppv_total = _get_f("ppv", m_raw)
         derived["pv1p"] = round(max(ppv_total - derived["pv2p"], 0), 2)
 
-    # 5. Fallback mappings for Micro ESS
-    # Derive standard Solar Power (ppv) from Micro ESS pvPower if ppv is missing
+
+def _compute_micro_ess_fallback_metrics(m_raw: dict, derived: dict[str, float]) -> None:
+    """Derive standard metrics from Micro ESS specific metrics."""
     if "pvPower" in m_raw and "ppv" not in m_raw:
         derived["ppv"] = _get_f("pvPower", m_raw)
 
-    # Derive standard Grid Frequency (f) from Micro ESS gridF if f is missing
     if "gridF" in m_raw and "f" not in m_raw:
         derived["f"] = _get_f("gridF", m_raw)
 
+
+def _compute_derived_metrics(m_raw: dict, device_type: str = "") -> dict:
+    """Calculate derived metrics from raw metrics map.
+
+    Only keys that have relevant base data in m_raw will be included in the
+    resulting dictionary to avoid 'ghost' sensors for unsupported features.
+    """
+    derived: dict[str, float] = {}
+
+    _compute_load_metrics(m_raw, derived)
+    _compute_grid_metrics(m_raw, derived)
+    _compute_battery_metrics(m_raw, derived, device_type)
+    _compute_pv_metrics(m_raw, derived)
+    _compute_micro_ess_fallback_metrics(m_raw, derived)
+
     return derived
 
 
@@ -1286,8 +1309,13 @@ class HyxiApiClient:  # pylint: disable=too-many-instance-attributes
         data_p = res_p.get("data", {})
         plants = data_p.get("list", []) if isinstance(data_p, dict) else []
 
-        # 👇 Log the discovered plants
-        if _LOGGER.isEnabledFor(logging.DEBUG):
+        if not plants:
+            _LOGGER.warning(
+                "HYXI API: No plants found associated with this account. "
+                "If your developer email differs from your app email, you must share "
+                "your Plant from the app to the developer email first."
+            )
+        elif _LOGGER.isEnabledFor(logging.DEBUG):
             _LOGGER.debug(
                 "HYXI Discovered Plants: [%s]",
                 ", ".join(_mask_id(p.get("plantId", "UNKNOWN")) for p in plants),
@@ -1647,19 +1675,18 @@ class HyxiApiClient:  # pylint: disable=too-many-instance-attributes
 
     # ── Microinverter Controls ───────────────────────────────────────────
 
-    async def set_micro_power_on(self, device_sn: str) -> dict:
-        """Turn on a Microinverter (controlId 3011).
+    async def set_micro_power(self, device_sn: str, power_on: bool) -> dict:
+        """Turn on or off a Microinverter (controlId 3011).
 
         For **MICRO_INVERTER** devices.
-        """
-        return await self.set_device_control(device_sn, {3011: "1"})
-
-    async def set_micro_power_off(self, device_sn: str) -> dict:
-        """Turn off a Microinverter (controlId 3011).
 
-        For **MICRO_INVERTER** devices.
+        Args:
+            device_sn: Device serial number.
+            power_on: True to turn on ("1"), False to turn off ("0").
         """
-        return await self.set_device_control(device_sn, {3011: "0"})
+        return await self.set_device_control(
+            device_sn, {3011: "1" if power_on else "0"}
+        )
 
     async def set_micro_power_limit(self, device_sn: str, percentage: int) -> dict:
         """Set Maximum Power Limitation for a Microinverter (controlId 3012).

{hyxi_cloud_api-1.2.2 → hyxi_cloud_api-1.2.4/src/hyxi_cloud_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyxi-cloud-api
-Version: 1.2.2
+Version: 1.2.4
 Summary: An async API client for HYXi Cloud.
 Author-email: Veldkornet <Veldkornet@users.noreply.github.com>
 Classifier: Programming Language :: Python :: 3

{hyxi_cloud_api-1.2.2 → hyxi_cloud_api-1.2.4}/tests/test_api.py

@@ -117,6 +117,26 @@ async def test_get_all_device_data_retry_exhaustion(monkeypatch, caplog):
     assert "HYXI Cloud connection failed after 3 attempts" in caplog.text
 
 
+@pytest.mark.asyncio
+async def test_get_all_device_data_timeout_error(monkeypatch, caplog):
+    """Test that get_all_device_data exhausts retries on TimeoutError."""
+    fake_session = MagicMock()
+    api = HyxiApiClient("ak", "sk", "https://api.com", fake_session)
+
+    # Mock _execute_fetch_all to raise TimeoutError
+    api._execute_fetch_all = AsyncMock(side_effect=TimeoutError("Connection timed out"))
+
+    mock_sleep = AsyncMock()
+    monkeypatch.setattr("asyncio.sleep", mock_sleep)
+
+    result = await api.get_all_device_data()
+
+    assert result is None
+    assert api._execute_fetch_all.call_count == 3
+    assert mock_sleep.call_count == 2
+    assert "HYXI Cloud connection failed after 3 attempts" in caplog.text
+
+
 @pytest.mark.asyncio
 async def test_get_all_device_data_auth_failed():
     """Test that get_all_device_data immediately fails on auth failure."""

{hyxi_cloud_api-1.2.2 → hyxi_cloud_api-1.2.4}/tests/test_device_control.py

@@ -176,28 +176,19 @@ async def test_set_mode_discharge_invalid_watts():
 
 
 @pytest.mark.asyncio
-async def test_set_micro_power_on():
-    """Test set_micro_power_on sends controlId 3011 with value '1'."""
+async def test_set_micro_power():
+    """Test set_micro_power sends controlId 3011 with value '1' or '0'."""
     api = HyxiApiClient("ak", "sk", "https://api.com", MagicMock())
     api._refresh_token = AsyncMock(return_value=True)
     api._request = AsyncMock(return_value=(200, {"success": True}))
 
-    await api.set_micro_power_on("SN123")
-
+    await api.set_micro_power("SN123", power_on=True)
     call_kwargs = api._request.call_args
     body = call_kwargs.kwargs.get("json") or call_kwargs[1].get("json")
     assert body["deviceControlMap"]["SN123"]["3011"] == "1"
 
-
-@pytest.mark.asyncio
-async def test_set_micro_power_off():
-    """Test set_micro_power_off sends controlId 3011 with value '0'."""
-    api = HyxiApiClient("ak", "sk", "https://api.com", MagicMock())
-    api._refresh_token = AsyncMock(return_value=True)
-    api._request = AsyncMock(return_value=(200, {"success": True}))
-
-    await api.set_micro_power_off("SN123")
-
+    api._request.reset_mock()
+    await api.set_micro_power("SN123", power_on=False)
     call_kwargs = api._request.call_args
     body = call_kwargs.kwargs.get("json") or call_kwargs[1].get("json")
     assert body["deviceControlMap"]["SN123"]["3011"] == "0"

{hyxi_cloud_api-1.2.2 → hyxi_cloud_api-1.2.4}/tests/test_fetch_plants.py

@@ -18,7 +18,7 @@ mock_aiohttp = sys.modules["aiohttp"]
 
 """Tests for fetching plants from the API."""
 
-from unittest.mock import AsyncMock, MagicMock
+from unittest.mock import AsyncMock, MagicMock, patch
 
 import aiohttp
 import pytest
@@ -87,3 +87,27 @@ async def test_fetch_plants_generic_failure():
     assert plants is None
     assert api.token == "Bearer good_token"
     assert api.token_expires_at == 9999999999.0
+
+
+@pytest.mark.asyncio
+async def test_fetch_plants_empty_list_warning():
+    """Verify that _fetch_plants logs a warning when the plant list is empty."""
+    api = HyxiApiClient("ak", "sk", "https://api.com", MagicMock())
+    api._request = AsyncMock(
+        return_value=(
+            200,
+            {
+                "success": True,
+                "data": {"list": []},
+            },
+        )
+    )
+
+    with patch("src.hyxi_cloud_api.api._LOGGER") as mock_logger:
+        plants = await api._fetch_plants()
+        assert plants == []
+        mock_logger.warning.assert_called_once_with(
+            "HYXI API: No plants found associated with this account. "
+            "If your developer email differs from your app email, you must share "
+            "your Plant from the app to the developer email first."
+        )