Add environmental abnormality state and deprecate grid code register in Modbus v. 2.7

Author: TypQxQ

custom_components/sigen/modbusregisterdefinitions.py

@@ -43,6 +43,7 @@ class RunningState(IntEnum):
     RUNNING = 1
     FAULT = 2
     SHUTDOWN = 3
+    ENVIRONMENTAL_ABNORMALITY = 7
 
 # Alarm code mappings based on Sigenergy Modbus Protocol appendices
 ALARM_CODES = {
@@ -1937,17 +1938,16 @@ class ModbusRegisterDefinition:
         applicable_to=["hybrid_inverter", "pv_inverter"],
     ),
     # This register is deprecated in Modbus v. 2.7 and is now marked as reserved.
-    # It still functions in the current implementation but may be removed in future versions.
-    "inverter_grid_code": ModbusRegisterDefinition(
-        address=40501,
-        count=1,
-        register_type=RegisterType.HOLDING,
-        data_type=DataType.U16,
-        gain=1,
-        description="Grid code setting",
-        applicable_to=["hybrid_inverter", "pv_inverter"],
-        update_frequency=UpdateFrequencyType.LOW,
-    ),
+    # "inverter_grid_code": ModbusRegisterDefinition(
+    #     address=40501,
+    #     count=1,
+    #     register_type=RegisterType.HOLDING,
+    #     data_type=DataType.U16,
+    #     gain=1,
+    #     description="Grid code setting",
+    #     applicable_to=["hybrid_inverter", "pv_inverter"],
+    #     update_frequency=UpdateFrequencyType.LOW,
+    # ),
     "inverter_remote_ems_dispatch_enable": ModbusRegisterDefinition(
         address=41500,
         count=1,

custom_components/sigen/select.py

@@ -8,7 +8,7 @@
 
 from homeassistant.components.select import SelectEntity, SelectEntityDescription
 from homeassistant.config_entries import ConfigEntry  #pylint: disable=no-name-in-module, syntax-error
-from homeassistant.const import CONF_NAME, EntityCategory
+from homeassistant.const import CONF_NAME#, EntityCategory
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity import DeviceInfo
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
@@ -21,65 +21,65 @@
 )
 from .modbusregisterdefinitions import (RemoteEMSControlMode)
 from .coordinator import SigenergyDataUpdateCoordinator # Import coordinator
-from .modbus import SigenergyModbusError
+# from .modbus import SigenergyModbusError
 from .common import generate_sigen_entity # Added generate_device_id
 from .sigen_entity import SigenergyEntity # Import the new base class
 
 _LOGGER = logging.getLogger(__name__)
 
+# This register is deprecated in Modbus v. 2.7 and is now marked as reserved.
 # Map of grid codes to country names
-GRID_CODE_MAP = {
-    1: "Germany",
-    2: "UK",
-    3: "Italy",
-    4: "Spain",
-    5: "Portugal",
-    6: "France",
-    7: "Poland",
-    8: "Hungary",
-    9: "Belgium",
-    10: "Norway",
-    11: "Sweden",
-    12: "Finland",
-    13: "Denmark",
-    19: "Australia",
-    26: "Austria",
-    36: "Ireland",
-    # Add more mappings as they are discovered
-}
+# GRID_CODE_MAP = {
+#     1: "Germany",
+#     2: "UK",
+#     3: "Italy",
+#     4: "Spain",
+#     5: "Portugal",
+#     6: "France",
+#     7: "Poland",
+#     8: "Hungary",
+#     9: "Belgium",
+#     10: "Norway",
+#     11: "Sweden",
+#     12: "Finland",
+#     13: "Denmark",
+#     19: "Australia",
+#     26: "Austria",
+#     36: "Ireland",
+#     # Add more mappings as they are discovered
+# }
 
 # Reverse mapping for looking up codes by country name
-COUNTRY_TO_CODE_MAP = {country: code for code, country in GRID_CODE_MAP.items()}
+# COUNTRY_TO_CODE_MAP = {country: code for code, country in GRID_CODE_MAP.items()}
 # Debug log the grid code map
 
-def _get_grid_code_display(data, device_name): # Changed inverter_id to device_name
-    """Get the display value for grid code with debug logging."""
-    # This register is deprecated in Modbus v. 2.7 and is now marked as reserved.
-    # It still functions in the current implementation but may be removed in future versions.
-
-    # Get the raw grid code value using device_name
-    grid_code = data["inverters"].get(device_name, {}).get("inverter_grid_code")
-    
-    # Handle None case
-    if grid_code is None:
-        return "Unknown"
-        
-    # Try to convert to int and look up in map
-    try:
-        grid_code_int = int(grid_code)
-        # _LOGGER.debug("Converted grid code to int: %s", grid_code_int)
-        
-        # Look up in map
-        result = GRID_CODE_MAP.get(grid_code_int)
-        # _LOGGER.debug("Grid code map lookup result: %s", result)
-        
-        if result is not None:
-            return result
-        else:
-            return f"Unknown ({grid_code})"
-    except (ValueError, TypeError) as e:
-        _LOGGER.debug("Error converting grid code for %s: %s", device_name, e)
-        return f"Unknown ({grid_code})"
+# This register is deprecated in Modbus v. 2.7 and is now marked as reserved.
+# def _get_grid_code_display(data, device_name): # Changed inverter_id to device_name
+#     """Get the display value for grid code with debug logging."""
+
+#     # Get the raw grid code value using device_name
+#     grid_code = data["inverters"].get(device_name, {}).get("inverter_grid_code")
+
+#     # Handle None case
+#     if grid_code is None:
+#         return "Unknown"
+
+#     # Try to convert to int and look up in map
+#     try:
+#         grid_code_int = int(grid_code)
+#         # _LOGGER.debug("Converted grid code to int: %s", grid_code_int)
+
+#         # Look up in map
+#         result = GRID_CODE_MAP.get(grid_code_int)
+#         # _LOGGER.debug("Grid code map lookup result: %s", result)
+
+#         if result is not None:
+#             return result
+#         else:
+#             return f"Unknown ({grid_code})"
+#     except (ValueError, TypeError) as e:
+#         _LOGGER.debug("Error converting grid code for %s: %s", device_name, e)
+#         return f"Unknown ({grid_code})"
 
 
 
@@ -139,23 +139,22 @@ class SigenergySelectEntityDescription(SelectEntityDescription):
 
 INVERTER_SELECTS = [
     # This register is deprecated in Modbus v. 2.7 and is now marked as reserved.
-    # It still functions in the current implementation but may be removed in future versions.
-    SigenergySelectEntityDescription(
-        key="inverter_grid_code",
-        name="Grid Code",
-        icon="mdi:transmission-tower",
-        options=list(GRID_CODE_MAP.values()),
-        entity_category=EntityCategory.CONFIG,
-        # Use identifier (device_name for inverters)
-        current_option_fn=lambda data, identifier: _get_grid_code_display(data, identifier),
-        # Use identifier (device_name for inverters)
-        select_option_fn=lambda coordinator, identifier, option: coordinator.async_write_parameter(
-            "inverter", identifier, "inverter_grid_code",
-            COUNTRY_TO_CODE_MAP.get(option, 0)  # Default to 0 if country not found
-        ),
-        entity_registry_enabled_default=False,
+    # SigenergySelectEntityDescription(
+    #     key="inverter_grid_code",
+    #     name="Grid Code",
+    #     icon="mdi:transmission-tower",
+    #     options=list(GRID_CODE_MAP.values()),
+    #     entity_category=EntityCategory.CONFIG,
+    #     # Use identifier (device_name for inverters)
+    #     current_option_fn=lambda data, identifier: _get_grid_code_display(data, identifier),
+    #     # Use identifier (device_name for inverters)
+    #     select_option_fn=lambda coordinator, identifier, option: coordinator.async_write_parameter(
+    #         "inverter", identifier, "inverter_grid_code",
+    #         COUNTRY_TO_CODE_MAP.get(option, 0)  # Default to 0 if country not found
+    #     ),
+    #     entity_registry_enabled_default=False,
 
-    ),
+    # ),
 ]
 
 AC_CHARGER_SELECTS = []
@@ -170,7 +169,7 @@ async def async_setup_entry(
     coordinator: SigenergyDataUpdateCoordinator = (
         hass.data[DOMAIN][config_entry.entry_id]["coordinator"])
     plant_name = config_entry.data[CONF_NAME]
-    _LOGGER.debug(f"Starting to add {SigenergySelect}")
+    _LOGGER.debug("Starting to add %s", SigenergySelect)
     # Add plant Selects
     entities : list[SigenergySelect] = generate_sigen_entity(plant_name, None, None, coordinator,
                                                              SigenergySelect,
@@ -234,19 +233,29 @@ def current_option(self) -> str:
         """Return the selected entity option."""
         if self.coordinator.data is None:
             return self.options[0] if self.options else ""
-            
+
         # Use device_name as the primary identifier passed to the lambda/function
         identifier = self._device_name
         try:
             option = self.entity_description.current_option_fn(self.coordinator.data, identifier)
             return option if option is not None else ""
         except Exception as e:
-            _LOGGER.error(f"Error getting current_option for {self.entity_id} (identifier: {identifier}): {e}")
+            _LOGGER.error("Error getting current_option for %s (identifier: %s): %s",
+                          self.entity_id, identifier, e)
             return ""
 
     async def async_select_option(self, option: str) -> None:
         """Change the selected option."""
         # Use device_name as the primary identifier passed to the lambda/function
         identifier = self._device_name
         # Exceptions are handled and logged in coordinator.async_write_parameter
-        await self.entity_description.select_option_fn(self.coordinator, identifier, option)
+        await self.entity_description.select_option_fn(self.coordinator, identifier, option)
+
+    def select_option(self, option: str) -> None:
+        """Change the selected option."""
+        # This is the synchronous version of the method.
+        # We are using an async function so we need to wrap this in a task
+        # and wait for it to complete.
+        asyncio.run_coroutine_threadsafe(
+            self.async_select_option(option), self.hass.loop
+        ).result()

custom_components/sigen/sensor.py

@@ -555,13 +555,15 @@ def native_value(self) -> Any:
                     RunningState.RUNNING: "Running",
                     RunningState.FAULT: "Fault",
                     RunningState.SHUTDOWN: "Shutdown",
+                    RunningState.ENVIRONMENTAL_ABNORMALITY: "Environmental Abnormality",
                 }.get(value, f"Unknown: {value}")
             if self.entity_description.key == "inverter_running_state":
                 return {
                     RunningState.STANDBY: "Standby",
                     RunningState.RUNNING: "Running",
                     RunningState.FAULT: "Fault",
                     RunningState.SHUTDOWN: "Shutdown",
+                    RunningState.ENVIRONMENTAL_ABNORMALITY: "Environmental Abnormality",
                 }.get(value, f"Unknown: {value}")
             if self.entity_description.key == "ac_charger_system_state":
                 return {