feat: automatically discover inverter type: string or hybrid

Author: mkuthan

README.md

@@ -53,16 +53,15 @@ After successful configuration, the integration creates a new entity for your in
 
 ## Supported devices
 
-All Solis hybrid inverters should be supported, although the integration has been tested with the following models:
-
-* S6-EH3P(8-15)K02-NV-YD-L, model "3331"
-* S6-EH3P(5-10)K-H, model "3306"
-* RHI-3P(3-10)K-HVES-5G, model "CA"
-
-The integration also supports the following Solis string inverters:
-
-* S6-GR1P(2.5-6)K, model "0200"
-* S5-GR3P(3-20)K, model "0507"
+All Solis inverters should be supported, although the integration has been tested with the following models:
+
+| Name                     | Model | Hybrid |
+| ------------------------ | ----- | ------ |
+| S6-EH3P(8-15)K02-NV-YD-L | 3331  | ✅      |
+| S6-EH3P(5-10)K-H         | 3306  | ✅      |
+| RHI-3P(3-10)K-HVES-5G    | CA    | ✅      |
+| S6-GR1P(2.5-6)K          | 0200  | ❌      |
+| S5-GR3P(3-20)K           | 0507  | ❌      |
 
 > [!NOTE]
 > If your inverter is not listed above, please open a GitHub issue using the "New Solis Inverter Support Request" template.

custom_components/solis_cloud_control/inverters/inverter.py

@@ -9,17 +9,20 @@ class InverterInfo:
     model: str | None
     version: str | None
     machine: str | None
-    type: str | None
+    energy_storage_control: str | None
     smart_support: str | None
     generator_support: str | None
-    battery_num: str | None
     power: str | None
     power_unit: str | None
 
     @property
     def power_watts(self) -> float | None:
         return safe_convert_power_to_watts(self.power, self.power_unit)
 
+    @property
+    def is_string_inverter(self) -> bool:
+        return self.energy_storage_control is not None and self.energy_storage_control == "0"
+
 
 @dataclass(frozen=True)
 class InverterOnOff:

custom_components/solis_cloud_control/inverters/inverter_factory.py

@@ -15,10 +15,9 @@ async def create_inverter_info(api_client: SolisCloudControlApiClient, inverter_
         model=_get_inverter_detail(inverter_details, "model"),
         version=_get_inverter_detail(inverter_details, "version"),
         machine=_get_inverter_detail(inverter_details, "machine"),
-        type=_get_inverter_detail(inverter_details, "inverterType"),
+        energy_storage_control=_get_inverter_detail(inverter_details, "energyStorageControl"),
         smart_support=_get_inverter_detail(inverter_details, "smartSupport"),
         generator_support=_get_inverter_detail(inverter_details, "generatorSupport"),
-        battery_num=_get_inverter_detail(inverter_details, "batteryNum"),
         power=_get_inverter_detail(inverter_details, "power"),
         power_unit=_get_inverter_detail(inverter_details, "powerStr"),
     )
@@ -29,12 +28,15 @@ async def create_inverter(api_client: SolisCloudControlApiClient, inverter_info:
         inverter_model = inverter_info.model.lower()
         module_name = f"custom_components.solis_cloud_control.inverters.model_{inverter_model}"
         model_module = importlib.import_module(module_name)
-        inverter = await model_module.create_inverter(inverter_info, api_client)
-        _LOGGER.info("Inverter model '%s' created", inverter_info.model)
-        return inverter
+        _LOGGER.info("Supported inverter model '%s' found", inverter_info.model)
+        return await model_module.create_inverter(inverter_info, api_client)
     except ImportError:
-        _LOGGER.warning("Unknown inverter model '%s', fallback to generic hybrid inverter", inverter_info.model)
-        return Inverter.create_hybrid_inverter(inverter_info)
+        if inverter_info.is_string_inverter:
+            _LOGGER.warning("Unknown inverter model '%s', fallback to generic string inverter", inverter_info.model)
+            return Inverter.create_string_inverter(inverter_info)
+        else:
+            _LOGGER.warning("Unknown inverter model '%s', fallback to generic hybrid inverter", inverter_info.model)
+            return Inverter.create_hybrid_inverter(inverter_info)
 
 
 def _get_inverter_detail(inverter_details: dict[str, any], field: str) -> str | None:

tests/conftest.py

@@ -77,10 +77,9 @@ def any_inverter_info():
         model="any_model",
         machine="any_machine",
         version="any_version",
-        type="any_type",
+        energy_storage_control="any_energy_storage_control",
         smart_support="any_smart_support",
         generator_support="any_generator_support",
-        battery_num="any_battery_num",
         power="any_power",
         power_unit="any_power_unit",
     )

tests/inverters/test_inverter.py

@@ -21,3 +21,18 @@ async def test_inverter_info_power_watts(mock_api_client, any_inverter_info, pow
     inverter = replace(any_inverter_info, power=power, power_unit=power_unit)
 
     assert inverter.power_watts == expected_power
+
+
+@pytest.mark.parametrize(
+    "energy_storage_control,expected",
+    [
+        ("0", True),
+        ("1", False),
+        (None, False),
+        ("", False),
+        ("unexpected", False),
+    ],
+)
+def test_inverter_info_is_string_inverter(any_inverter_info, energy_storage_control, expected):
+    inverter = replace(any_inverter_info, energy_storage_control=energy_storage_control)
+    assert inverter.is_string_inverter == expected

tests/inverters/test_inverter_factory.py

@@ -17,10 +17,9 @@ async def test_create_inverter_info(mock_api_client):
         "model": "any model",
         "version": "any version",
         "machine": "any machine",
-        "inverterType": "any type",
+        "energyStorageControl": "any energy storage control",
         "smartSupport": "any smart support",
         "generatorSupport": "any generator support",
-        "batteryNum": "any battery num",
         "power": 10,
         "powerStr": "kW",
     }
@@ -32,10 +31,9 @@ async def test_create_inverter_info(mock_api_client):
     assert result.model == "any model"
     assert result.version == "any version"
     assert result.machine == "any machine"
-    assert result.type == "any type"
+    assert result.energy_storage_control == "any energy storage control"
     assert result.smart_support == "any smart support"
     assert result.generator_support == "any generator support"
-    assert result.battery_num == "any battery num"
     assert result.power == "10"
     assert result.power_unit == "kW"
 
@@ -51,17 +49,33 @@ async def test_create_inverter_info_missing_fields(mock_api_client):
     assert result.model is None
     assert result.version is None
     assert result.machine is None
-    assert result.type is None
+    assert result.energy_storage_control is None
     assert result.smart_support is None
     assert result.generator_support is None
-    assert result.battery_num is None
     assert result.power is None
     assert result.power_unit is None
 
 
 @pytest.mark.asyncio
-async def test_create_inverter_unknown_model(mock_api_client, any_inverter_info):
-    inverter_info = replace(any_inverter_info, model="unknown model")
+async def test_create_inverter_unknown_hybrid_model(mock_api_client, any_inverter_info):
+    inverter_info = replace(any_inverter_info, model="unknown model", energy_storage_control="1")
     result = await create_inverter(mock_api_client, inverter_info)
 
     assert result == Inverter.create_hybrid_inverter(inverter_info)
+
+
+@pytest.mark.asyncio
+async def test_create_inverter_unknown_string_model(mock_api_client, any_inverter_info):
+    inverter_info = replace(any_inverter_info, model="unknown model", energy_storage_control="0")
+    result = await create_inverter(mock_api_client, inverter_info)
+
+    assert result == Inverter.create_string_inverter(inverter_info)
+
+
+@pytest.mark.asyncio
+async def test_create_inverter_3331(mock_api_client, any_inverter_info):
+    inverter_info = replace(any_inverter_info, model="3331")
+    result = await create_inverter(mock_api_client, inverter_info)
+
+    assert result != Inverter.create_hybrid_inverter(inverter_info)
+    assert result != Inverter.create_string_inverter(inverter_info)