Merge pull request #28 from fboundy/patch

[codex] Gate optional controls and format version sensors

Author: fboundy

custom_components/solisconnect/config_flow.py

@@ -88,7 +88,7 @@
     vol.Required("has_parallel", default=False): bool,
     vol.Required("has_battery", default=True): bool,
     vol.Required("has_hv_battery", default=False): bool,
-    vol.Required("has_generator", default=True): bool,
+    vol.Required("has_generator", default=False): bool,
 }
 
 # Combined schema that accepts both TCP and Serial fields (all optional except connection_type)
@@ -142,7 +142,7 @@
     vol.Required("has_parallel", default=False): bool,
     vol.Required("has_battery", default=True): bool,
     vol.Required("has_hv_battery", default=False): bool,
-    vol.Required("has_generator", default=True): bool,
+    vol.Required("has_generator", default=False): bool,
 }
 
 OPTIONS_SCHEMA = vol.Schema(
@@ -159,7 +159,7 @@
         vol.Required("has_parallel", default=False): bool,
         vol.Required("has_battery", default=True): bool,
         vol.Required("has_hv_battery", default=False): bool,
-        vol.Required("has_generator", default=True): bool,
+        vol.Required("has_generator", default=False): bool,
     }
 )
 
@@ -675,7 +675,7 @@ def async_get_options_flow(config_entry):
         vol.Required("has_parallel", default=False): bool,
         vol.Required("has_battery", default=True): bool,
         vol.Required("has_hv_battery", default=False): bool,
-        vol.Required("has_generator", default=True): bool,
+        vol.Required("has_generator", default=False): bool,
     }
 )
 

custom_components/solisconnect/data/solis_config.py

@@ -90,7 +90,7 @@ def inverter_options_from_config(config: dict, template: InverterConfig) -> Inve
         pv=config.get("has_pv", template.type in (InverterType.HYBRID, InverterType.GRID, InverterType.WAVESHARE)),
         ac_coupling=config.get("has_ac_coupling", False),
         parallel=config.get("has_parallel", False),
-        generator=config.get("has_generator", True),
+        generator=config.get("has_generator", False),
         battery=config.get("has_battery", True),
         hv_battery=config.get("has_hv_battery", False),
     )

custom_components/solisconnect/sensor_data/hybrid_sensors.py

@@ -33,13 +33,15 @@
                 "category": Category.BASIC_INFORMATION,
                 "register": ["33001"],
                 "multiplier": 0,
+                "value_format": "hex",
             },
             {
                 "name": "HMI Version",
                 "unique": "solisconnect_inverter_hmi_version",
                 "category": Category.BASIC_INFORMATION,
                 "register": ["33002"],
                 "multiplier": 0,
+                "value_format": "hex",
             },
             {
                 "name": "Protocol Version",

custom_components/solisconnect/sensor_data/switch_sensors.py

@@ -0,0 +1,25 @@
+from homeassistant.helpers.entity import EntityCategory
+
+from custom_components.solisconnect.data.enums import Category
+
+SETTING_CATEGORIES = {
+    Category.BASIC_SETTING,
+    Category.BATTERY_SETTING,
+    Category.AC_PORT_SETTING,
+    Category.GRID_CODE_SETTING,
+    Category.POWER_CONTROL_SETTING,
+    Category.FUNCTIONAL_SETTING,
+    Category.HYBRID_MODE_SETTING,
+    Category.BACKUP_PORT_SETTING,
+    Category.REMOTE_CONTROL_SETTING,
+    Category.SMART_PORT_SETTING,
+    Category.GENERATOR_SETTING,
+    Category.HISTORY_DATA_QUERY_SETTING,
+    Category.REMOTE_DISPATCH_SETTING,
+}
+
+
+def entity_category_for_sensor_category(category: Category | None) -> EntityCategory | None:
+    if category in SETTING_CATEGORIES:
+        return EntityCategory.CONFIG
+    return None

custom_components/solisconnect/sensors/entity_category.py

@@ -52,6 +52,7 @@ def __init__(
         identification=None,
         poll_speed=PollSpeed.NORMAL,
         data_type: str | None = None,
+        value_format: str | None = None,
     ):
         """
         :param name: Sensor name
@@ -90,6 +91,7 @@ def __init__(
         self.poll_speed = poll_speed
         self.category = category
         self.identification = identification
+        self.value_format = value_format
 
         self.dynamic_adjustments()
 
@@ -169,7 +171,9 @@ def _convert_raw_value(self, values: list[int]):
             if getattr(self, "data_type", None) == DataType.S16.value and raw > 32767:
                 raw -= 65536
 
-            if self.multiplier == 0 or self.multiplier == 1:
+            if self.value_format == "hex":
+                n_value = f"0x{raw & 0xFFFF:04X}"
+            elif self.multiplier == 0 or self.multiplier == 1:
                 n_value = round(raw)
             else:
                 n_value = raw * self.multiplier
@@ -229,6 +233,7 @@ def __init__(self, hass, definition, controller, identification=None):
                     default=entity.get("default", 0),
                     multiplier=entity.get("multiplier", 1),
                     data_type=entity.get("data_type", None),
+                    value_format=entity.get("value_format", None),
                     unique_id=unique_id_generator(controller, entity),
                     poll_speed=definition.get("poll_speed", PollSpeed.NORMAL),
                 ),

custom_components/solisconnect/sensors/solis_base_sensor.py

@@ -4,6 +4,7 @@
 from homeassistant.components.switch import SwitchEntity
 from homeassistant.core import callback
 from homeassistant.helpers.dispatcher import async_dispatcher_connect
+from homeassistant.helpers.entity import EntityCategory
 from homeassistant.helpers.restore_state import RestoreEntity
 
 from custom_components.solisconnect import ModbusController
@@ -36,6 +37,7 @@ def __init__(self, hass, modbus_controller, entity_definition):
         self._attr_unique_id = unique_id_generator_binary(modbus_controller, self._register, self._bit_position, self._on_value)
         self._attr_name = entity_definition["name"]
         self._attr_available = False
+        self._attr_entity_category = EntityCategory.CONFIG
 
     async def async_added_to_hass(self) -> None:
         """Called when entity is added to HA."""

custom_components/solisconnect/sensors/solis_binary_sensor.py

@@ -6,6 +6,7 @@
 
 from custom_components.solisconnect.const import REGISTER, VALUE
 from custom_components.solisconnect.helpers import cache_get, is_correct_controller, register_update_signal
+from custom_components.solisconnect.sensors.entity_category import entity_category_for_sensor_category
 from custom_components.solisconnect.sensors.solis_base_sensor import SolisBaseSensor
 
 _LOGGER = logging.getLogger(__name__)
@@ -43,6 +44,7 @@ def __init__(self, hass, sensor: SolisBaseSensor):
         self._attr_state_class = sensor.state_class
         self._attr_native_unit_of_measurement = sensor.unit_of_measurement
         self._attr_available = not sensor.hidden and sensor.enabled
+        self._attr_entity_category = entity_category_for_sensor_category(getattr(sensor, "category", None))
 
         self._received_values = {}
 

custom_components/solisconnect/sensors/solis_number_sensor.py

@@ -1,6 +1,7 @@
 import logging
 
 from homeassistant.components.select import SelectEntity
+from homeassistant.helpers.entity import EntityCategory
 from homeassistant.helpers.restore_state import RestoreEntity
 
 from custom_components.solisconnect import ModbusController
@@ -16,6 +17,7 @@ def __init__(self, hass, modbus_controller, entity_definition) -> None:
         self._register = entity_definition["register"]
         self._attr_name = entity_definition["name"]
         self._attr_unique_id = unique_id_generator(modbus_controller, entity_definition["register"], "select")
+        self._attr_entity_category = EntityCategory.CONFIG
 
         self._attr_options = [e["name"] for e in entity_definition["entities"]]
         self._attr_options_raw = entity_definition["entities"]

custom_components/solisconnect/sensors/solis_select_entity.py

@@ -8,6 +8,7 @@
 from custom_components.solisconnect.const import REGISTER, VALUE
 from custom_components.solisconnect.data.enums import InverterType, PollSpeed
 from custom_components.solisconnect.helpers import cache_get, is_correct_controller, register_update_signal
+from custom_components.solisconnect.sensors.entity_category import entity_category_for_sensor_category
 from custom_components.solisconnect.sensors.solis_base_sensor import SolisBaseSensor
 
 _LOGGER = logging.getLogger(__name__)
@@ -34,6 +35,7 @@ def __init__(self, hass: HomeAssistant, sensor: SolisBaseSensor):
         self._attr_native_unit_of_measurement = sensor.unit_of_measurement
         self._attr_available = not sensor.hidden and sensor.enabled
         self._attr_suggested_display_precision = self.decimal_count(sensor.multiplier)
+        self._attr_entity_category = entity_category_for_sensor_category(getattr(sensor, "category", None))
 
         self.is_added_to_hass = False
         self._state = None