External Generator: own sub-device with dependency-driven availability

The 33 generator entities were gated by the Dry Contact Box option, which
is a different feature - in the SolaX app the external generator is its
own tree. They move to a "<hub> External Generator" device behind a new
"External Generator Support" option (read_gen, off by default, translated
in all shipped languages), and each entity only exists while its parent in
that tree is active:

  External Generator (0xC7): Disabled | ATS Control | Dry Contact
    Start Gen Method (0xE3): only with Dry Contact
      Switch On/Off SoC (0xE4/0xE5): only with Reference SOC
    Max Run Time (0xE6), Max Rest Time (0xE7), Hold Min Power (0x10E)
    Allow Work Start/Stop Time (0xE8/0xE9), Max Charge (0xC8)
    Charge Battery from Generator (0x109 on Gen4, 0x10C on Gen5/Gen6)
      Charge Battery To (0x10A on Gen4, 0x10D on Gen5/Gen6)
    Schedule 2 (0x104 on Gen4, 0x107 on Gen5/Gen6): unlocks the second
    Charge Period and Allowed Discharge Period time pair

Names follow the cloud app now that the device provides the context, with
keys and entity ids unchanged: Generator Max Charge -> Max Charge (in kW,
0.01 scale, 0-300 kW instead of a raw 10 W register), Generator Charge ->
Charge Battery from Generator, Generator Min Power -> Hold Min Power,
Generator Time 2 -> Schedule 2, Generator Charge SOC -> Charge Battery To.

Verified live on an X3-Hybrid-G4 15kW by changing each setting in the
SolaX app and tracking the readbacks.

Stacked on the sub-device infrastructure PR.

Author: Bl00d-B0b

custom_components/solax_modbus/__init__.py

@@ -105,6 +105,9 @@
 from .const import (
     CONF_READ_EPS as CONF_READ_EPS,
 )
+from .const import (
+    CONF_READ_GEN as CONF_READ_GEN,
+)
 from .const import (
     CONF_READ_PM as CONF_READ_PM,
 )
@@ -129,6 +132,9 @@
 from .const import (
     DEFAULT_READ_EPS as DEFAULT_READ_EPS,
 )
+from .const import (
+    DEFAULT_READ_GEN as DEFAULT_READ_GEN,
+)
 from .const import (
     DEFAULT_READ_PM as DEFAULT_READ_PM,
 )
@@ -445,11 +451,13 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
 # Device groups that a config option can switch off, and the option controlling each.
 # Display names for sub-devices, where a plain title-case of the group key would read badly.
 DEVICE_GROUP_NAMES: dict[str, str] = {
+    "external_generator": "External Generator",
     "eps": "EPS",
     "pm": "Parallel",
 }
 
 GATED_DEVICE_GROUPS: dict[str, tuple[str, bool]] = {
+    "external_generator": (CONF_READ_GEN, DEFAULT_READ_GEN),
     "eps": (CONF_READ_EPS, DEFAULT_READ_EPS),
     "pm": (CONF_READ_PM, DEFAULT_READ_PM),
     "ENERGY_DASHBOARD": (CONF_ENERGY_DASHBOARD_DEVICE, DEFAULT_ENERGY_DASHBOARD_DEVICE),

custom_components/solax_modbus/config_flow.py

@@ -46,6 +46,7 @@
     CONF_READ_BATTERY,
     CONF_READ_DCB,
     CONF_READ_EPS,
+    CONF_READ_GEN,
     CONF_READ_PM,
     CONF_SCAN_INTERVAL_FAST,
     CONF_SCAN_INTERVAL_MEDIUM,
@@ -64,6 +65,7 @@
     DEFAULT_READ_BATTERY,
     DEFAULT_READ_DCB,
     DEFAULT_READ_EPS,
+    DEFAULT_READ_GEN,
     DEFAULT_READ_PM,
     DEFAULT_SCAN_INTERVAL,
     DEFAULT_SERIAL_PORT,
@@ -155,6 +157,7 @@ def _configured_hub_names(handler: SchemaCommonFlowHandler) -> set[str]:
         vol.Optional(CONF_ENERGY_DASHBOARD_DEVICE, default=DEFAULT_ENERGY_DASHBOARD_DEVICE): bool,
         vol.Optional(CONF_READ_EPS, default=DEFAULT_READ_EPS): bool,
         vol.Optional(CONF_READ_DCB, default=DEFAULT_READ_DCB): bool,
+        vol.Optional(CONF_READ_GEN, default=DEFAULT_READ_GEN): bool,
         vol.Optional(CONF_READ_PM, default=DEFAULT_READ_PM): bool,
         vol.Optional(CONF_TIME_OUT, default=DEFAULT_TIME_OUT): int,
     }
@@ -177,6 +180,7 @@ def _configured_hub_names(handler: SchemaCommonFlowHandler) -> set[str]:
         vol.Optional(CONF_ENERGY_DASHBOARD_DEVICE, default=DEFAULT_ENERGY_DASHBOARD_DEVICE): bool,
         vol.Optional(CONF_READ_EPS, default=DEFAULT_READ_EPS): bool,
         vol.Optional(CONF_READ_DCB, default=DEFAULT_READ_DCB): bool,
+        vol.Optional(CONF_READ_GEN, default=DEFAULT_READ_GEN): bool,
         vol.Optional(CONF_READ_PM, default=DEFAULT_READ_PM): bool,
         vol.Optional(CONF_TIME_OUT, default=DEFAULT_TIME_OUT): int,
     }
@@ -376,6 +380,8 @@ async def _option_schema(handler: SchemaCommonFlowHandler) -> vol.Schema:
     """Options schema without the feature switches the selected plugin does not implement."""
     plugin_name = handler.options.get(CONF_PLUGIN)
     hidden: set[str] = set()
+    if not _plugin_supports_device_group(plugin_name, "external_generator"):
+        hidden.add(CONF_READ_GEN)
     if not _plugin_supports_energy_dashboard(plugin_name):
         hidden.add(CONF_ENERGY_DASHBOARD_DEVICE)
     for option, flag_name in ((CONF_READ_EPS, "EPS"), (CONF_READ_PM, "PM")):

custom_components/solax_modbus/const.py

@@ -50,6 +50,7 @@ class UnitOfReactivePower(StrEnum):  # type: ignore[no-redef]
 CONF_INVERTER_POWER_KW = "inverter_power_kw"
 CONF_READ_EPS = "read_eps"
 CONF_READ_DCB = "read_dcb"
+CONF_READ_GEN = "read_gen"
 CONF_READ_PM = "read_pm"
 CONF_MODBUS_ADDR = "read_modbus_addr"
 CONF_INTERFACE = "interface"
@@ -66,6 +67,7 @@ class UnitOfReactivePower(StrEnum):  # type: ignore[no-redef]
 DEFAULT_SERIAL_PORT = "/dev/ttyUSB0"
 DEFAULT_READ_EPS = False
 DEFAULT_READ_DCB = False
+DEFAULT_READ_GEN = False
 DEFAULT_READ_PM = False
 DEFAULT_BAUDRATE = "19200"
 DEFAULT_PLUGIN = "solax"