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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyxi-cloud-api
-Version: 1.2.4
+Version: 1.2.6
 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.4 → hyxi_cloud_api-1.2.6}/pyproject.toml

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

hyxi_cloud_api-1.2.6/src/hyxi_cloud_api/__init__.py

@@ -0,0 +1,9 @@
+"""Initialization module for HYXi Cloud API."""
+
+from .api import HyxiApiClient
+
+# Module-level alias so callers can do: from hyxi_cloud_api import VPP_ACTIVE_MODES
+VPP_ACTIVE_MODES: frozenset[str] = HyxiApiClient.VPP_ACTIVE_MODES
+
+__version__ = "1.2.6"
+__all__ = ["VPP_ACTIVE_MODES", "HyxiApiClient"]

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

@@ -752,6 +752,27 @@ _PEAK_SHAVING_VALUES = {
 class HyxiApiClient:  # pylint: disable=too-many-instance-attributes
     """Client for interacting with the HYXI Cloud API."""
 
+    DEFAULT_BASE_URL = "https://open.hyxicloud.com"
+
+    # ── VPP Awareness ────────────────────────────────────────────────────
+    # workMode values that indicate an active VPP program is controlling
+    # this device. The 'workMode' field is already returned in regular
+    # polling metrics — no separate API call is needed.
+    #
+    # Confirmed values (live observation + HYXI community research):
+    #   "16" = VPP mode (virtual power plant dispatch active)
+    #
+    # Standard non-VPP modes for reference (NOT included here):
+    #   "0" = Self-use / general
+    #   "1" = Backup priority
+    #   "2" = Time-of-use / peak shaving
+    #   "3" = Feed-in priority
+    #
+    # workMode is returned as a string from the API ("16", not 16).
+    # Source: live workMode value observed during active VPP dispatch,
+    # corroborated by HYXI community register documentation.
+    VPP_ACTIVE_MODES: frozenset[str] = frozenset({"16"})
+
     class ControlError(Exception):
         """Raised when a device control command fails."""
 
@@ -991,6 +1012,10 @@ class HyxiApiClient:  # pylint: disable=too-many-instance-attributes
         if hw_ver:
             entry["hw_version"] = hw_ver
 
+        detailed_model = i_raw.get("model")
+        if detailed_model and detailed_model != entry.get("model"):
+            entry["model"] = detailed_model
+
         base_info = {
             "hw_version": hw_ver,
             "_sw_ver_sys": sw_ver,
@@ -1069,6 +1094,17 @@ class HyxiApiClient:  # pylint: disable=too-many-instance-attributes
                     "HYXI EMS telemetry probe returned no data for %s", _mask_id(sn)
                 )
 
+        if not is_comm_unit:
+            # Always write VPP keys so HA sensor attributes are never missing.
+            # Pivot: VPP active detection is now driven by workMode.
+            # If workMode is "16" (VPP active), set vppMode to "16" to trigger HA lockout.
+            work_mode = entry["metrics"].get("workMode", "")
+            entry["metrics"]["vppMode"] = work_mode
+            entry["metrics"]["vppCode"] = ""
+            entry["metrics"]["vppName"] = ""
+            entry["metrics"]["vppManufacturer"] = ""
+            entry["metrics"]["vppSupplierName"] = ""
+
         return sn, entry
 
     async def _fetch_device_list_for_plant(self, plant_id: str) -> list[dict] | None:

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyxi-cloud-api
-Version: 1.2.4
+Version: 1.2.6
 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.4 → hyxi_cloud_api-1.2.6}/tests/test_api.py

@@ -286,8 +286,10 @@ async def test_fetch_ems_basic_data_success(caplog):
     # Assert query_ems_basic_details was called
     api.query_ems_basic_details.assert_called_once_with(ems_sn)
 
-    # Assert entry['metrics'] is updated
-    assert entry["metrics"] == {"existing_metric": "value", "new_metric": "new_value"}
+    # Assert entry['metrics'] contains the merged EMS data (subset check — VPP
+    # keys are always written too, so we don't assert the exact full dict).
+    assert entry["metrics"]["existing_metric"] == "value"
+    assert entry["metrics"]["new_metric"] == "new_value"
 
 
 @pytest.mark.asyncio
@@ -309,8 +311,9 @@ async def test_fetch_ems_basic_data_no_data(caplog):
     # Assert query_ems_basic_details was called
     api.query_ems_basic_details.assert_called_once_with("EMS123")
 
-    # Assert entry['metrics'] is unchanged
-    assert entry["metrics"] == {"existing_metric": "value"}
+    # Assert the original metric is still present (VPP keys are added but
+    # existing_metric must be untouched).
+    assert entry["metrics"]["existing_metric"] == "value"
 
     # Assert the correct debug log was emitted
     assert "HYXI EMS telemetry probe returned no data for " in caplog.text

{hyxi_cloud_api-1.2.4 → hyxi_cloud_api-1.2.6}/tests/test_extract_device_info_metadata.py

@@ -110,3 +110,17 @@ def test_extract_device_info_metadata_micro_ess():
     assert base_info["wifiVer"] == "V01.00.00.01"
     assert base_info["ratedFrequency"] == "50"
     assert "batCap" in entry["metrics"]
+
+
+def test_extract_device_info_metadata_model():
+    """Test that the model field is extracted and updates the entry when changed."""
+    entry = {"metrics": {}, "device_type_code": "UNKNOWN", "model": "generic inverter"}
+    i_raw = {"model": "H10K-HT"}
+    HyxiApiClient._extract_device_info_metadata(entry, i_raw)
+    assert entry["model"] == "H10K-HT"
+
+    # Verify model is NOT overwritten if not present in response
+    entry2 = {"metrics": {}, "device_type_code": "UNKNOWN", "model": "H10K-HT"}
+    i_raw2 = {}
+    HyxiApiClient._extract_device_info_metadata(entry2, i_raw2)
+    assert entry2["model"] == "H10K-HT"

{hyxi_cloud_api-1.2.4 → hyxi_cloud_api-1.2.6}/tests/test_metrics_errors.py

@@ -139,8 +139,8 @@ async def test_fetch_ems_basic_data_no_data(caplog):
     await api._fetch_all_for_device("10602251600016", entry, "INVERTER")
 
     assert "HYXI EMS telemetry probe returned no data for fefbfd75" in caplog.text
-    # Ensure entry was not updated with EMS metrics
-    assert not entry["metrics"]
+    # VPP keys are always written for INVERTER types; no EMS data should be present.
+    assert "new_metric" not in entry["metrics"]
 
 
 @pytest.mark.asyncio
@@ -150,6 +150,7 @@ async def test_fetch_ems_basic_data_error(caplog):
     mock_session = MagicMock()
     api = HyxiApiClient("ak", "sk", "https://api.com", mock_session)
 
+    # Raise inside _request so query_ems_basic_details catches it and returns {}
     api._request = AsyncMock(side_effect=Exception("EMS data fetch failed"))
     api._fetch_device_info = AsyncMock()
     api._fetch_device_metrics = AsyncMock()
@@ -157,7 +158,8 @@ async def test_fetch_ems_basic_data_error(caplog):
     entry = {"metrics": {}, "device_type_code": "EMS"}
     await api._fetch_all_for_device("10602251600016", entry, "INVERTER")
 
-    assert not entry["metrics"]
+    # No EMS data should be present; VPP keys are written regardless.
+    assert "batSoc" not in entry["metrics"]
     assert "HYXI EMS telemetry probe returned no data for fefbfd75" in caplog.text
 
 

hyxi_cloud_api-1.2.4/src/hyxi_cloud_api/__init__.py

@@ -1,6 +0,0 @@
-"""Initialization module for HYXi Cloud API."""
-
-from .api import HyxiApiClient
-
-__version__ = "1.2.4"
-__all__ = ["HyxiApiClient"]