pyenphase 2.2.2__tar.gz → 2.3.0__tar.gz

{pyenphase-2.2.2 → pyenphase-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyenphase
-Version: 2.2.2
+Version: 2.3.0
 Summary: Library to control enphase envoy
 License: MIT
 Author: pyenphase

{pyenphase-2.2.2 → pyenphase-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyenphase"
-version = "2.2.2"
+version = "2.3.0"
 description = "Library to control enphase envoy"
 authors = [{ name = "pyenphase", email = "cgarwood@gmail.com" }]
 license = "MIT"
@@ -10,7 +10,7 @@ dynamic = ["classifiers", "dependencies"]
 
 [tool.poetry]
 name = "pyenphase"
-version = "2.2.2"
+version = "2.3.0"
 description = "Library to control enphase envoy"
 authors = ["pyenphase <cgarwood@gmail.com>"]
 classifiers = [
@@ -46,7 +46,7 @@ pytest = ">=7,<9"
 pytest-cov = ">=5,<7"
 types-orjson = "^3.6.2"
 aioresponses = ">=0.7.6"
-pytest-asyncio = ">=0.21.1,<1.1.0"
+pytest-asyncio = ">=0.21.1,<1.2.0"
 syrupy = "^4.5.0"
 pytest-timeout = "^2.4.0"
 

{pyenphase-2.2.2 → pyenphase-2.3.0}/src/pyenphase/__init__.py

@@ -12,6 +12,8 @@ from .exceptions import (
     EnvoyProbeFailed,
 )
 from .models.acb import EnvoyACBPower, EnvoyBatteryAggregate
+from .models.c6combiner import EnvoyC6CC
+from .models.collar import EnvoyCollar
 from .models.dry_contacts import EnvoyDryContactSettings, EnvoyDryContactStatus
 from .models.encharge import EnvoyEncharge, EnvoyEnchargeAggregate, EnvoyEnchargePower
 from .models.enpower import EnvoyEnpower
@@ -45,5 +47,7 @@ __all__ = (
     "EnvoyBatteryAggregate",
     "EnvoyDryContactSettings",
     "EnvoyDryContactStatus",
+    "EnvoyCollar",
+    "EnvoyC6CC",
     "EnvoyTariff",
 )

{pyenphase-2.2.2 → pyenphase-2.3.0}/src/pyenphase/const.py

@@ -101,6 +101,8 @@ class SupportedFeatures(enum.IntFlag):
     GENERATOR = 2048  #: Envoy reports generator data
     ACB = 4096  #: Envoy reports ACB Battery data
     DETAILED_INVERTERS = 8192  #: Detailed inverter data is reported
+    COLLAR = 0x4000  #: Envoy reports a Collar
+    C6CC = 0x8000  #: Envoy reports a C6 Combiner controller
 
 
 class PhaseNames(enum.StrEnum):

pyenphase-2.3.0/src/pyenphase/models/c6combiner.py

@@ -0,0 +1,59 @@
+"""Model for the Enphase C6 Combiner."""
+
+# Data Source: URL_ENSEMBLE_INVENTORY
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any
+
+# Required keys for C6 Combiner Controller inventories
+C6CC_REQUIRED_KEYS: frozenset[str] = frozenset(
+    {
+        "admin_state",
+        "admin_state_str",
+        "communicating",
+        "img_load_date",
+        "installed",
+        "last_rpt_date",
+        "part_num",
+        "serial_num",
+        "dmir_version",
+        "fw_version",
+    }
+)
+
+
+@dataclass(slots=True)
+class EnvoyC6CC:
+    """Model for the Enphase C6 Combiner."""
+
+    admin_state: int
+    admin_state_str: str
+    firmware_loaded_date: int
+    firmware_version: str
+    installed_date: int
+    last_report_date: int
+    communicating: bool
+    part_number: str
+    serial_number: str
+    dmir_version: str
+
+    @classmethod
+    def from_api(cls, inventory: dict[str, Any]) -> EnvoyC6CC | None:
+        """Initialize from the API. Returns None if required keys are missing."""
+        missing_keys = C6CC_REQUIRED_KEYS - set(inventory)
+        if missing_keys:
+            return None
+        return cls(
+            admin_state=inventory["admin_state"],
+            admin_state_str=inventory["admin_state_str"],
+            communicating=inventory["communicating"],
+            firmware_loaded_date=inventory["img_load_date"],
+            firmware_version=inventory["fw_version"],
+            installed_date=inventory["installed"],
+            last_report_date=inventory["last_rpt_date"],
+            part_number=inventory["part_num"],
+            serial_number=inventory["serial_num"],
+            dmir_version=inventory["dmir_version"],
+        )

pyenphase-2.3.0/src/pyenphase/models/collar.py

@@ -0,0 +1,73 @@
+"""Model for the IQ Meter Collar."""
+
+# Data Source: URL_ENSEMBLE_INVENTORY
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any
+
+# Required keys for IQ Meter Collar inventories
+COLLAR_REQUIRED_KEYS: frozenset[str] = frozenset(
+    {
+        "admin_state",
+        "admin_state_str",
+        "communicating",
+        "img_load_date",
+        "img_pnum_running",
+        "installed",
+        "last_rpt_date",
+        "part_num",
+        "serial_num",
+        "temperature",
+        "mid_state",
+        "grid_state",
+        "control_error",
+        "collar_state",
+    }
+)
+
+
+@dataclass(slots=True)
+class EnvoyCollar:
+    """Model for the Enphase IQ Meter Collar."""
+
+    admin_state: int
+    admin_state_str: str
+    firmware_loaded_date: int
+    firmware_version: str
+    installed_date: int
+    last_report_date: int
+    communicating: bool
+    mid_state: str
+    grid_state: str
+    part_number: str
+    serial_number: str
+    temperature: int
+    temperature_unit: str
+    control_error: int
+    collar_state: str
+
+    @classmethod
+    def from_api(cls, inventory: dict[str, Any]) -> EnvoyCollar | None:
+        """Initialize from the API. Returns None if required keys are missing."""
+        missing_keys = COLLAR_REQUIRED_KEYS - set(inventory)
+        if missing_keys:
+            return None
+        return cls(
+            admin_state=inventory["admin_state"],
+            admin_state_str=inventory["admin_state_str"],
+            communicating=inventory["communicating"],
+            firmware_loaded_date=inventory["img_load_date"],
+            firmware_version=inventory["img_pnum_running"],
+            installed_date=inventory["installed"],
+            last_report_date=inventory["last_rpt_date"],
+            part_number=inventory["part_num"],
+            serial_number=inventory["serial_num"],
+            temperature=inventory["temperature"],
+            temperature_unit="C",
+            mid_state=inventory["mid_state"],
+            grid_state=inventory["grid_state"],
+            control_error=inventory["control_error"],
+            collar_state=inventory["collar_state"],
+        )

{pyenphase-2.2.2 → pyenphase-2.3.0}/src/pyenphase/models/dry_contacts.py

@@ -25,6 +25,7 @@ class DryContactType(StrEnum):
     NONE = "NONE"
     PV = "PV"
     LOAD = "LOAD"
+    THIRD_PARTY_PV = "3RD-PV"
 
 
 class DryContactMode(StrEnum):

{pyenphase-2.2.2 → pyenphase-2.3.0}/src/pyenphase/models/envoy.py

@@ -4,6 +4,8 @@ from dataclasses import dataclass, field
 from typing import Any
 
 from .acb import EnvoyACBPower, EnvoyBatteryAggregate
+from .c6combiner import EnvoyC6CC
+from .collar import EnvoyCollar
 from .dry_contacts import EnvoyDryContactSettings, EnvoyDryContactStatus
 from .encharge import EnvoyEncharge, EnvoyEnchargeAggregate, EnvoyEnchargePower
 from .enpower import EnvoyEnpower
@@ -36,6 +38,10 @@ class EnvoyData:
     acb_power: EnvoyACBPower | None = None
     #: aggregated Enphase and ACB battery SOC and total capacity
     battery_aggregate: EnvoyBatteryAggregate | None = None
+    #: IQ Meter collar, only for Envoy with IQ Meter Collar integrated consumption metering installed
+    collar: EnvoyCollar | None = None
+    #: Envoy C6 Combiner controller
+    c6cc: EnvoyC6CC | None = None
     #: Consumption power & energy values, only for Envoy metered with CT installed
     system_consumption: EnvoySystemConsumption | None = None
     #: Solar Production power & energy values

{pyenphase-2.2.2 → pyenphase-2.3.0}/src/pyenphase/updaters/ensemble.py

@@ -14,6 +14,8 @@ from ..const import (
 )
 from ..exceptions import ENDPOINT_PROBE_EXCEPTIONS
 from ..models.acb import EnvoyBatteryAggregate
+from ..models.c6combiner import EnvoyC6CC
+from ..models.collar import EnvoyCollar
 from ..models.dry_contacts import EnvoyDryContactSettings, EnvoyDryContactStatus
 from ..models.encharge import EnvoyEncharge, EnvoyEnchargeAggregate, EnvoyEnchargePower
 from ..models.enpower import EnvoyEnpower
@@ -51,6 +53,10 @@ class EnvoyEnembleUpdater(EnvoyUpdater):
                     self._supported_features |= SupportedFeatures.ENPOWER
                 if item["type"] == "ENCHARGE":
                     self._supported_features |= SupportedFeatures.ENCHARGE
+                if item["type"] == "COLLAR":
+                    self._supported_features |= SupportedFeatures.COLLAR
+                if item["type"] == "C6 COMBINER CONTROLLER":
+                    self._supported_features |= SupportedFeatures.C6CC
 
         return self._supported_features
 
@@ -132,3 +138,23 @@ class EnvoyEnembleUpdater(EnvoyUpdater):
             envoy_data.battery_aggregate = EnvoyBatteryAggregate.from_api(
                 ensemble_secctrl_data
             )
+
+        # IQ Meter collar seems like a single instance only
+        if supported_features & SupportedFeatures.COLLAR:
+            # Update Collar data
+            for item in ensemble_inventory_data:
+                if item["type"] != "COLLAR":
+                    continue
+                if item.get("devices"):
+                    collar_data = item["devices"][0]
+                    envoy_data.collar = EnvoyCollar.from_api(collar_data)
+
+        # C6 Combiner seems like a single instance only
+        if supported_features & SupportedFeatures.C6CC:
+            # Update C6CC data
+            for item in ensemble_inventory_data:
+                if item["type"] != "C6 COMBINER CONTROLLER":
+                    continue
+                if item.get("devices"):
+                    c6cc_data = item["devices"][0]
+                    envoy_data.c6cc = EnvoyC6CC.from_api(c6cc_data)