Add modbus get_hub (#54277)

* Add dict with hubs.

* Update flexit to use get_hub.

* Remove executor_task for close.

homeassistant/components/flexit/climate.py

@@ -11,13 +11,13 @@ from homeassistant.components.climate.const import (
     SUPPORT_FAN_MODE,
     SUPPORT_TARGET_TEMPERATURE,
 )
+from homeassistant.components.modbus import get_hub
 from homeassistant.components.modbus.const import (
     CALL_TYPE_REGISTER_HOLDING,
     CALL_TYPE_REGISTER_INPUT,
     CALL_TYPE_WRITE_REGISTER,
     CONF_HUB,
     DEFAULT_HUB,
-    MODBUS_DOMAIN,
 )
 from homeassistant.components.modbus.modbus import ModbusHub
 from homeassistant.const import (
@@ -53,7 +53,7 @@ async def async_setup_platform(
     """Set up the Flexit Platform."""
     modbus_slave = config.get(CONF_SLAVE)
     name = config.get(CONF_NAME)
-    hub = hass.data[MODBUS_DOMAIN][config.get(CONF_HUB)]
+    hub = get_hub(hass, config[CONF_HUB])
     async_add_entities([Flexit(hub, modbus_slave, name)], True)
 
 

homeassistant/components/modbus/__init__.py

@@ -42,6 +42,7 @@ from homeassistant.const import (
     CONF_TYPE,
     CONF_UNIT_OF_MEASUREMENT,
 )
+from homeassistant.core import HomeAssistant
 import homeassistant.helpers.config_validation as cv
 
 from .const import (
@@ -114,7 +115,7 @@ from .const import (
     DEFAULT_TEMP_UNIT,
     MODBUS_DOMAIN as DOMAIN,
 )
-from .modbus import async_modbus_setup
+from .modbus import ModbusHub, async_modbus_setup
 from .validators import number_validator, scan_interval_validator, struct_validator
 
 _LOGGER = logging.getLogger(__name__)
@@ -357,6 +358,11 @@ SERVICE_WRITE_COIL_SCHEMA = vol.Schema(
 )
 
 
+def get_hub(hass: HomeAssistant, name: str) -> ModbusHub:
+    """Return modbus hub with name."""
+    return hass.data[DOMAIN][name]
+
+
 async def async_setup(hass, config):
     """Set up Modbus component."""
     return await async_modbus_setup(

homeassistant/components/modbus/binary_sensor.py

@@ -9,8 +9,8 @@ from homeassistant.core import HomeAssistant
 from homeassistant.helpers.restore_state import RestoreEntity
 from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
+from . import get_hub
 from .base_platform import BasePlatform
-from .const import MODBUS_DOMAIN
 
 PARALLEL_UPDATES = 1
 _LOGGER = logging.getLogger(__name__)
@@ -29,7 +29,7 @@ async def async_setup_platform(
         return
 
     for entry in discovery_info[CONF_BINARY_SENSORS]:
-        hub = hass.data[MODBUS_DOMAIN][discovery_info[CONF_NAME]]
+        hub = get_hub(hass, discovery_info[CONF_NAME])
         sensors.append(ModbusBinarySensor(hub, entry))
 
     async_add_entities(sensors)

homeassistant/components/modbus/climate.py

@@ -23,6 +23,7 @@ from homeassistant.core import HomeAssistant
 from homeassistant.helpers.restore_state import RestoreEntity
 from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
+from . import get_hub
 from .base_platform import BaseStructPlatform
 from .const import (
     ATTR_TEMPERATURE,
@@ -39,7 +40,6 @@ from .const import (
     DATA_TYPE_UINT16,
     DATA_TYPE_UINT32,
     DATA_TYPE_UINT64,
-    MODBUS_DOMAIN,
 )
 from .modbus import ModbusHub
 
@@ -59,7 +59,7 @@ async def async_setup_platform(
 
     entities = []
     for entity in discovery_info[CONF_CLIMATES]:
-        hub: ModbusHub = hass.data[MODBUS_DOMAIN][discovery_info[CONF_NAME]]
+        hub: ModbusHub = get_hub(hass, discovery_info[CONF_NAME])
         entities.append(ModbusThermostat(hub, entity))
 
     async_add_entities(entities)

homeassistant/components/modbus/cover.py

@@ -19,6 +19,7 @@ from homeassistant.core import HomeAssistant
 from homeassistant.helpers.restore_state import RestoreEntity
 from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
+from . import get_hub
 from .base_platform import BasePlatform
 from .const import (
     CALL_TYPE_COIL,
@@ -30,7 +31,6 @@ from .const import (
     CONF_STATE_OPENING,
     CONF_STATUS_REGISTER,
     CONF_STATUS_REGISTER_TYPE,
-    MODBUS_DOMAIN,
 )
 from .modbus import ModbusHub
 
@@ -50,7 +50,7 @@ async def async_setup_platform(
 
     covers = []
     for cover in discovery_info[CONF_COVERS]:
-        hub: ModbusHub = hass.data[MODBUS_DOMAIN][discovery_info[CONF_NAME]]
+        hub: ModbusHub = get_hub(hass, discovery_info[CONF_NAME])
         covers.append(ModbusCover(hub, cover))
 
     async_add_entities(covers)

homeassistant/components/modbus/fan.py

@@ -8,8 +8,9 @@ from homeassistant.const import CONF_NAME
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.typing import ConfigType
 
+from . import get_hub
 from .base_platform import BaseSwitch
-from .const import CONF_FANS, MODBUS_DOMAIN
+from .const import CONF_FANS
 from .modbus import ModbusHub
 
 PARALLEL_UPDATES = 1
@@ -25,7 +26,7 @@ async def async_setup_platform(
     fans = []
 
     for entry in discovery_info[CONF_FANS]:
-        hub: ModbusHub = hass.data[MODBUS_DOMAIN][discovery_info[CONF_NAME]]
+        hub: ModbusHub = get_hub(hass, discovery_info[CONF_NAME])
         fans.append(ModbusFan(hub, entry))
     async_add_entities(fans)
 

homeassistant/components/modbus/light.py

@@ -8,8 +8,8 @@ from homeassistant.const import CONF_LIGHTS, CONF_NAME
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.typing import ConfigType
 
+from . import get_hub
 from .base_platform import BaseSwitch
-from .const import MODBUS_DOMAIN
 from .modbus import ModbusHub
 
 PARALLEL_UPDATES = 1
@@ -25,7 +25,7 @@ async def async_setup_platform(
 
     lights = []
     for entry in discovery_info[CONF_LIGHTS]:
-        hub: ModbusHub = hass.data[MODBUS_DOMAIN][discovery_info[CONF_NAME]]
+        hub: ModbusHub = get_hub(hass, discovery_info[CONF_NAME])
         lights.append(ModbusLight(hub, entry))
     async_add_entities(lights)
 

homeassistant/components/modbus/modbus.py

@@ -1,4 +1,6 @@
 """Support for Modbus."""
+from __future__ import annotations
+
 import asyncio
 from collections import namedtuple
 import logging
@@ -57,6 +59,7 @@ from .const import (
 
 _LOGGER = logging.getLogger(__name__)
 
+
 ConfEntry = namedtuple("ConfEntry", "call_type attr func_name")
 RunEntry = namedtuple("RunEntry", "attr func")
 PYMODBUS_CALL = [
@@ -184,6 +187,8 @@ async def async_modbus_setup(
 class ModbusHub:
     """Thread safe wrapper class for pymodbus."""
 
+    name: str
+
     def __init__(self, hass, client_config):
         """Initialize the Modbus hub."""
 
@@ -193,7 +198,7 @@ class ModbusHub:
         self._in_error = False
         self._lock = asyncio.Lock()
         self.hass = hass
-        self._config_name = client_config[CONF_NAME]
+        self.name = client_config[CONF_NAME]
         self._config_type = client_config[CONF_TYPE]
         self._config_delay = client_config[CONF_DELAY]
         self._pb_call = {}
@@ -262,7 +267,7 @@ class ModbusHub:
         """Try to connect, and retry if needed."""
         async with self._lock:
             if not await self.hass.async_add_executor_job(self._pymodbus_connect):
-                err = f"{self._config_name} connect failed, retry in pymodbus"
+                err = f"{self.name} connect failed, retry in pymodbus"
                 self._log_error(err, error_state=False)
                 return
 
@@ -278,8 +283,11 @@ class ModbusHub:
         self._async_cancel_listener = None
         self._config_delay = 0
 
-    def _pymodbus_close(self):
-        """Close sync. pymodbus."""
+    async def async_close(self):
+        """Disconnect client."""
+        if self._async_cancel_listener:
+            self._async_cancel_listener()
+            self._async_cancel_listener = None
         if self._client:
             try:
                 self._client.close()
@@ -287,15 +295,6 @@ class ModbusHub:
                 self._log_error(str(exception_error))
         self._client = None
 
-    async def async_close(self):
-        """Disconnect client."""
-        if self._async_cancel_listener:
-            self._async_cancel_listener()
-            self._async_cancel_listener = None
-
-        async with self._lock:
-            return await self.hass.async_add_executor_job(self._pymodbus_close)
-
     def _pymodbus_connect(self):
         """Connect client."""
         try:

homeassistant/components/modbus/sensor.py

@@ -10,8 +10,8 @@ from homeassistant.core import HomeAssistant
 from homeassistant.helpers.restore_state import RestoreEntity
 from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
+from . import get_hub
 from .base_platform import BaseStructPlatform
-from .const import MODBUS_DOMAIN
 from .modbus import ModbusHub
 
 PARALLEL_UPDATES = 1
@@ -31,7 +31,7 @@ async def async_setup_platform(
         return
 
     for entry in discovery_info[CONF_SENSORS]:
-        hub = hass.data[MODBUS_DOMAIN][discovery_info[CONF_NAME]]
+        hub = get_hub(hass, discovery_info[CONF_NAME])
         sensors.append(ModbusRegisterSensor(hub, entry))
 
     async_add_entities(sensors)

homeassistant/components/modbus/switch.py

@@ -8,8 +8,8 @@ from homeassistant.const import CONF_NAME, CONF_SWITCHES
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.typing import ConfigType
 
+from . import get_hub
 from .base_platform import BaseSwitch
-from .const import MODBUS_DOMAIN
 from .modbus import ModbusHub
 
 PARALLEL_UPDATES = 1
@@ -26,7 +26,7 @@ async def async_setup_platform(
         return
 
     for entry in discovery_info[CONF_SWITCHES]:
-        hub: ModbusHub = hass.data[MODBUS_DOMAIN][discovery_info[CONF_NAME]]
+        hub: ModbusHub = get_hub(hass, discovery_info[CONF_NAME])
         switches.append(ModbusSwitch(hub, entry))
     async_add_entities(switches)