rename entity_group to scan_group; enhance debugging code

also remove some too heavy debug outputs

Author: Jan C

custom_components/solax_modbus/__init__.py

@@ -163,7 +163,7 @@ async def config_entry_update_listener(hass: HomeAssistant, entry: ConfigEntry)
 async def async_setup(hass, config):
     """Set up the SolaX modbus component."""
     hass.data[DOMAIN] = {}
-    _LOGGER.debug("solax data %d", hass.data)
+    #_LOGGER.debug("solax data %d", hass.data)
     return True
 
 
@@ -190,7 +190,7 @@ def _load_plugin(plugin_name: str) -> ModuleType:
 
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry):
     """Set up a SolaX modbus."""
-    _LOGGER.debug(f"setup entries - data: {entry.data}, options: {entry.options}")
+    _LOGGER.info(f"setup config entries - data: {entry.data}, options: {entry.options}")
     config = entry.options
     plugin_name = config[CONF_PLUGIN]
 
@@ -376,7 +376,7 @@ def __init__(
         self.blocks_changed = False
         self.initial_groups = {} # as returned by the sensor setup - holdingRegs and inputRegs should not change 
 
-        _LOGGER.debug("solax modbushub done %s", self.__dict__)
+        #_LOGGER.debug("solax modbushub done %s", self.__dict__)
 
 
     async def async_init(self, *args: Any) -> None:  # noqa: D102
@@ -447,14 +447,16 @@ def loadLocalData(self):
 
     # end of save and load section
 
-    def entity_group(self, sensor): # seems to be called for non-sensor entities also - strange
+    def scan_group(self, sensor): # seems to be called for non-sensor entities also - strange
         # scan group
         g = getattr(sensor.entity_description, "scan_group", None)
         if not g:
             regtype = getattr(sensor.entity_description, "register_type", None)
             if   regtype == REG_HOLDING: g = self.plugin.default_holding_scangroup
             elif regtype == REG_INPUT:   g = self.plugin.default_input_scangroup
-            else: g = SCAN_GROUP_DEFAULT # should not occur
+            else: 
+                _LOGGER.debug(f"**** default scan_group for {sensor.entity_description.key} returned {g} - {SCAN_GROUP_DEFAULT}")
+                g = SCAN_GROUP_DEFAULT # should not occur
 
         if g == SCAN_GROUP_AUTO:
             unit = getattr(sensor.entity_description, "native_unit_of_measurement", None)
@@ -471,8 +473,10 @@ def entity_group(self, sensor): # seems to be called for non-sensor entities als
         # scan interval
         g = self.config.get(g, None)
         # when declared but not present in config, use default; this MUST exist
-        if not g:
+        if g is None:
+            _LOGGER.warning(f"Fast or Medium scan groups do not seem to exist in config: {g} using default {self.config[SCAN_GROUP_DEFAULT]}")
             g = self.config[SCAN_GROUP_DEFAULT]
+        else: _LOGGER.debug(f"**** returning scan_group interval {g} for {sensor.entity_description.key}")
         return g
 
     def device_group_key(self, device_info: DeviceInfo):
@@ -488,7 +492,7 @@ def device_group_key(self, device_info: DeviceInfo):
     async def async_add_solax_modbus_sensor(self, sensor: SolaXModbusSensor):
         """Listen for data updates."""
         # This is the first sensor, set up interval.
-        interval = self.entity_group(sensor)
+        interval = self.scan_group(sensor)
         interval_group = self.groups.setdefault(interval, empty_hub_interval_group_lambda())
         if not interval_group.device_groups:
             interval_group.interval = interval
@@ -510,7 +514,7 @@ async def _refresh(_now: Optional[int] = None) -> None:
     @callback
     async def async_remove_solax_modbus_sensor(self, sensor):
         """Remove data update."""
-        interval = self.entity_group(sensor)
+        interval = self.scan_group(sensor)
         interval_group = self.groups.get(interval, None)
         if interval_group is None:
             return
@@ -1144,8 +1148,8 @@ def rebuild_blocks(self, initial_groups): #, computedRegs):
                 #self.computedSensors = computedRegs # moved outside the loops
                 for i in hub_device_group.holdingBlocks: _LOGGER.info(f"{device_name} - interval {interval}s: adding holding block: {', '.join('0x{:x}'.format(num) for num in i.regs)}")
                 for i in hub_device_group.inputBlocks: _LOGGER.info(f"{device_name} - interval {interval}s: adding input block: {', '.join('0x{:x}'.format(num) for num in i.regs)}")
-                _LOGGER.debug(f"holdingBlocks: {hub_device_group.holdingBlocks}")
-                _LOGGER.debug(f"inputBlocks: {hub_device_group.inputBlocks}")
+                #_LOGGER.debug(f"holdingBlocks: {hub_device_group.holdingBlocks}")
+                #_LOGGER.debug(f"inputBlocks: {hub_device_group.inputBlocks}")
         self.blocks_changed = False
         _LOGGER.info(f"done rebuilding groups and blocks - post: {self.initial_groups.keys()}")
 

custom_components/solax_modbus/number.py

@@ -98,12 +98,12 @@ def __init__(
         self.entity_description = number_info
         self._write_method = number_info.write_method
 
-    async def async_added_to_hass(self) -> None:
-        """Register callbacks."""
-        await self._hub.async_add_solax_modbus_sensor(self)
+    #async def async_added_to_hass(self) -> None:
+    #    """Register callbacks."""
+    #    await self._hub.async_add_solax_modbus_sensor(self)
 
-    async def async_will_remove_from_hass(self) -> None:
-        await self._hub.async_remove_solax_modbus_sensor(self)
+    #async def async_will_remove_from_hass(self) -> None:
+    #    await self._hub.async_remove_solax_modbus_sensor(self)
 
     """ remove duplicate declaration
     async def async_set_value(self, native_value: float) -> None:

custom_components/solax_modbus/select.py

@@ -61,12 +61,15 @@ def __init__(self,
         self._attr_options = list(select_info.option_dict.values())
         self._write_method = select_info.write_method
 
-    async def async_added_to_hass(self):
-        """Register callbacks."""
-        await self._hub.async_add_solax_modbus_sensor(self)
+    
+    ##sync def async_added_to_hass(self):
+    #    """Register callbacks."""
+    #    await self._hub.async_add_solax_modbus_sensor(self)
+
+    #async def async_will_remove_from_hass(self) -> None:
+    #    await self._hub.async_remove_solax_modbus_sensor(self)
+
 
-    async def async_will_remove_from_hass(self) -> None:
-        await self._hub.async_remove_solax_modbus_sensor(self)
     @callback
     def modbus_data_updated(self):
         self.async_write_ha_state()

custom_components/solax_modbus/sensor.py

@@ -177,7 +177,7 @@ def entityToListSingle(hub, hub_name, entities, groups, computedRegs, device_inf
         else: _LOGGER.warning(f"entity without modbus register address and without value_function found: {newdescr.key}")
     else:
         #target group
-        interval_group = groups.setdefault(hub.entity_group(sensor), empty_input_interval_group_lambda())
+        interval_group = groups.setdefault(hub.scan_group(sensor), empty_input_interval_group_lambda())
         device_group_key = hub.device_group_key(device_info)
         device_group = interval_group.device_groups.setdefault(device_group_key, empty_input_device_group_lambda())
         holdingRegs  = device_group.holdingRegs

docs/developer_guide.md

@@ -80,6 +80,10 @@ To be documented:
 * _write_method_: int = `WRITE_SINGLE_MODBUS`  # `WRITE_SINGLE_MOBUS` or `WRITE_MULTI_MODBUS` or `WRITE_DATA_LOCAL`
 * _sensor_key_: str = None  # The associated sensor key
 * _initvalue_: int = None  # initial default value for WRITE_DATA_LOCAL entities
+* _value_function_: callable = None
+
+Currently switch entities are used when the modbus register contains different switches in one modbus register. 
+If a switch entity has a `value_function, the value function will take 4 parameters: bit, state, key, datadict). The value function must extract the bit and return the state of that single bit.
 
 
 ## Local Data Entities