hyxi-cloud-api 1.3.6__tar.gz → 1.3.8__tar.gz

{hyxi_cloud_api-1.3.6/src/hyxi_cloud_api.egg-info → hyxi_cloud_api-1.3.8}/PKG-INFO

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

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

{hyxi_cloud_api-1.3.6 → hyxi_cloud_api-1.3.8}/src/hyxi_cloud_api/__init__.py

@@ -5,5 +5,5 @@ 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.3.6"
+__version__ = "1.3.8"
 __all__ = ["VPP_ACTIVE_MODES", "HyxiApiClient"]

{hyxi_cloud_api-1.3.6 → hyxi_cloud_api-1.3.8}/src/hyxi_cloud_api/api.py

@@ -72,6 +72,8 @@ _COLLECTOR_FILTER_REGEX = re.compile(
 
 _PV_KEYS = tuple((f"pv{i}v", f"pv{i}i", f"pv{i}p") for i in range(1, 5))
 
+_METRICS_EXCLUDED_KEYS = frozenset({"deviceSn", "reportTimestamp", "collectTime"})
+
 # Official HYXI Alarm Code Reference Table
 ALARM_CODE_MAP = {
     "704": "The ambient temperature is too high",
@@ -634,10 +636,54 @@ def _compute_battery_metrics(
         derived["bat_discharging"] = power_source if power_source > 0 else 0.0
         derived["bat_power_dc"] = bat_p_dc
 
-    if "batCharge" in m_raw:
-        derived["bat_charge_total"] = _get_f("batCharge", m_raw)
-    if "batDisCharge" in m_raw:
-        derived["bat_discharge_total"] = _get_f("batDisCharge", m_raw)
+    def _is_valid_metric(k: str) -> bool:
+        v = m_raw.get(k)
+        if v is None:
+            return False
+        if isinstance(v, str):
+            v_cleaned = v.strip().lower()
+            return bool(v_cleaned and v_cleaned not in ("null", "none", "na", "--"))
+        return True
+
+    # Unify cumulative battery charge energy telemetry keys to resolve polling/push mismatch
+    total_echg_val = (
+        _get_f("totalEchg", m_raw) if _is_valid_metric("totalEchg") else None
+    )
+    bat_charge_val = (
+        _get_f("batCharge", m_raw) if _is_valid_metric("batCharge") else None
+    )
+
+    if total_echg_val is not None:
+        derived["totalEchg"] = total_echg_val
+        derived["bat_charge_total"] = total_echg_val
+        if bat_charge_val is None:
+            derived["batCharge"] = total_echg_val
+
+    if bat_charge_val is not None:
+        derived["batCharge"] = bat_charge_val
+        if total_echg_val is None:
+            derived["totalEchg"] = bat_charge_val
+            derived["bat_charge_total"] = bat_charge_val
+
+    # Unify cumulative battery discharge energy telemetry keys to resolve polling/push mismatch
+    total_edchg_val = (
+        _get_f("totalEdchg", m_raw) if _is_valid_metric("totalEdchg") else None
+    )
+    bat_discharge_val = (
+        _get_f("batDisCharge", m_raw) if _is_valid_metric("batDisCharge") else None
+    )
+
+    if total_edchg_val is not None:
+        derived["totalEdchg"] = total_edchg_val
+        derived["bat_discharge_total"] = total_edchg_val
+        if bat_discharge_val is None:
+            derived["batDisCharge"] = total_edchg_val
+
+    if bat_discharge_val is not None:
+        derived["batDisCharge"] = bat_discharge_val
+        if total_edchg_val is None:
+            derived["totalEdchg"] = bat_discharge_val
+            derived["bat_discharge_total"] = bat_discharge_val
 
 
 def _compute_pv_metrics(m_raw: dict, derived: dict[str, float]) -> None:
@@ -2149,7 +2195,7 @@ class HyxiApiClient:  # pylint: disable=too-many-instance-attributes
             # Strip metadata/routing keys
             raw_metrics = {}
             for k, v in device.items():
-                if k in ("deviceSn", "reportTimestamp", "collectTime"):
+                if k in _METRICS_EXCLUDED_KEYS:
                     continue
                 raw_metrics[k] = v
 
@@ -2250,7 +2296,7 @@ class HyxiApiClient:  # pylint: disable=too-many-instance-attributes
             if not sn:
                 continue
 
-            alarm_code = str(item.get("alarmCode", ""))
+            alarm_code = f"{item.get('alarmCode', '')}"
 
             # Resolve alarm name: use payload name if present, fall back to ALARM_CODE_MAP
             alarm_name = item.get("alarmName") or ALARM_CODE_MAP.get(

{hyxi_cloud_api-1.3.6 → hyxi_cloud_api-1.3.8/src/hyxi_cloud_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyxi-cloud-api
-Version: 1.3.6
+Version: 1.3.8
 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.3.6 → hyxi_cloud_api-1.3.8}/tests/test_compute_battery_metrics.py

@@ -60,6 +60,37 @@ def test_compute_battery_metrics_totals():
     _compute_battery_metrics(m_raw, derived, "OTHER")
     assert derived["bat_charge_total"] == 12.5
     assert derived["bat_discharge_total"] == 45.6
+    assert derived["totalEchg"] == 12.5
+    assert derived["totalEdchg"] == 45.6
+    assert derived["batCharge"] == 12.5
+    assert derived["batDisCharge"] == 45.6
+
+
+def test_compute_battery_metrics_polling_keys():
+    """Test fallback and synchronization when only polling keys are present."""
+    derived: dict[str, float] = {}
+    m_raw = {"totalEchg": 100.5, "totalEdchg": 200.2}
+    _compute_battery_metrics(m_raw, derived, "OTHER")
+    assert derived["bat_charge_total"] == 100.5
+    assert derived["bat_discharge_total"] == 200.2
+    assert derived["totalEchg"] == 100.5
+    assert derived["totalEdchg"] == 200.2
+    assert derived["batCharge"] == 100.5
+    assert derived["batDisCharge"] == 200.2
+
+
+def test_compute_battery_metrics_null_and_empty_handling():
+    """Verify that null-equivalent and empty values do not pollute derived metrics."""
+    derived: dict[str, float] = {}
+    m_raw = {
+        "batCharge": 150.0,
+        "totalEchg": "null",
+        "batDisCharge": "None",
+        "totalEdchg": 250.0,
+    }
+    _compute_battery_metrics(m_raw, derived, "OTHER")
+    assert derived["bat_charge_total"] == 150.0
+    assert derived["bat_discharge_total"] == 250.0
 
 
 def test_compute_battery_metrics_empty():
@@ -76,3 +107,24 @@ def test_compute_battery_metrics_none_device_type():
     _compute_battery_metrics(m_raw, derived, None)  # type: ignore
     assert derived["bat_charging"] == 100.0
     assert derived["bat_power_dc"] == -100.0
+
+
+def test_compute_battery_metrics_both_present():
+    """Test that when both polling and daily keys are present, they are preserved.
+
+    Cumulative values should take priority for battery totals.
+    """
+    derived: dict[str, float] = {}
+    m_raw = {
+        "totalEchg": 366.3,
+        "totalEdchg": 371.3,
+        "batCharge": 2.3,
+        "batDisCharge": 4.4,
+    }
+    _compute_battery_metrics(m_raw, derived, "OTHER")
+    assert derived["bat_charge_total"] == 366.3
+    assert derived["bat_discharge_total"] == 371.3
+    assert derived["totalEchg"] == 366.3
+    assert derived["totalEdchg"] == 371.3
+    assert derived["batCharge"] == 2.3
+    assert derived["batDisCharge"] == 4.4

{hyxi_cloud_api-1.3.6 → hyxi_cloud_api-1.3.8}/tests/test_device_control.py

@@ -221,6 +221,30 @@ async def test_set_micro_power_limit_invalid_percentage():
         await api.set_micro_power_limit("SN123", percentage=-1)
 
 
+@pytest.mark.asyncio
+async def test_set_micro_power_limit_mocked_control():
+    """Test set_micro_power_limit by mocking set_device_control and checking edge cases."""
+    api = HyxiApiClient("ak", "sk", "https://api.com", MagicMock())
+    api.set_device_control = AsyncMock(return_value={"success": True})
+
+    # Test 80%
+    result = await api.set_micro_power_limit("SN123", percentage=80)
+    api.set_device_control.assert_awaited_once_with("SN123", {3012: "80"})
+    assert result == {"success": True}
+
+    # Test boundary 0%
+    api.set_device_control.reset_mock()
+    result = await api.set_micro_power_limit("SN123", percentage=0)
+    api.set_device_control.assert_awaited_once_with("SN123", {3012: "0"})
+    assert result == {"success": True}
+
+    # Test boundary 100%
+    api.set_device_control.reset_mock()
+    result = await api.set_micro_power_limit("SN123", percentage=100)
+    api.set_device_control.assert_awaited_once_with("SN123", {3012: "100"})
+    assert result == {"success": True}
+
+
 @pytest.mark.asyncio
 async def test_restart_device():
     """Test restart_device sends controlId 3013 with value '1'."""

{hyxi_cloud_api-1.3.6 → hyxi_cloud_api-1.3.8}/tests/test_subscriptions.py

@@ -57,6 +57,46 @@ async def test_subscribe_real_time_data():
     }
 
 
+@pytest.mark.asyncio
+async def test_subscribe_real_time_data_mock_post_subscription():
+    """Test real-time data subscription by mocking _post_subscription."""
+    api = _client()
+    api._post_subscription = AsyncMock(return_value={"success": True, "data": "mocked"})
+
+    # Test with data_code_list
+    result = await api.subscribe_real_time_data(
+        callback_url="https://example.com/hyxi",
+        device_sn_list=["SN1"],
+        post_rate=5000,
+        data_code_list=["pv1p"],
+    )
+    assert result == {"success": True, "data": "mocked"}
+    api._post_subscription.assert_called_with(
+        "/api/subscribe/v1/realTimeData",
+        {
+            "callBackUrl": "https://example.com/hyxi",
+            "deviceSnList": ["SN1"],
+            "postRate": 5000,
+            "dataCodeList": ["pv1p"],
+        },
+    )
+
+    # Test without data_code_list
+    result = await api.subscribe_real_time_data(
+        callback_url="https://example.com/hyxi",
+        device_sn_list=["SN1"],
+        post_rate=5000,
+    )
+    api._post_subscription.assert_called_with(
+        "/api/subscribe/v1/realTimeData",
+        {
+            "callBackUrl": "https://example.com/hyxi",
+            "deviceSnList": ["SN1"],
+            "postRate": 5000,
+        },
+    )
+
+
 @pytest.mark.asyncio
 async def test_subscribe_alarm():
     """Test alarm subscription payload."""
@@ -109,6 +149,23 @@ async def test_cancel_subscription():
     assert call_args.kwargs["json"] == {"subscribeCode": "sub-code"}
 
 
+@pytest.mark.asyncio
+async def test_cancel_subscription_return_value():
+    """Test subscription cancellation return value matches expected API response."""
+    api = _client()
+
+    # Execute the method
+    result = await api.cancel_subscription("valid-sub-code")
+
+    # Verify the return payload matches the API response
+    assert result == {
+        "code": "0",
+        "msg": "Success",
+        "data": {"subscribeCode": "sub-code"},
+        "success": True,
+    }
+
+
 @pytest.mark.asyncio
 async def test_subscription_error_on_auth_failed():
     """Test SubscriptionError is raised when authentication fails."""