Simplify clients.

Author: janiversen

pymodbus/client/base.py

@@ -52,20 +52,13 @@ class ModbusBaseClient(ModbusClientMixin, ModbusProtocol):
     class _params:
         """Parameter class."""
 
-        host: str = None
-        port: str | int = None
-        timeout: float = None
         retries: int = None
         retry_on_empty: bool = None
         close_comm_on_error: bool = None
         strict: bool = None
         broadcast_enable: bool = None
         reconnect_delay: int = None
 
-        baudrate: int = None
-        bytesize: int = None
-        parity: str = None
-        stopbits: int = None
         handle_local_echo: bool = None
 
         source_address: tuple[str, int] = None
@@ -89,28 +82,30 @@ def __init__(  # pylint: disable=too-many-arguments
         """Initialize a client instance."""
         ModbusClientMixin.__init__(self)
         self.use_sync = kwargs.get("use_sync", False)
+        setup_params = CommParams(
+            comm_type=kwargs.get("CommType"),
+            comm_name="comm",
+            reconnect_delay=reconnect_delay,
+            reconnect_delay_max=reconnect_delay_max,
+            timeout_connect=timeout,
+            host=kwargs.get("host", None),
+            port=kwargs.get("port", None),
+            sslctx=kwargs.get("sslctx", None),
+            baudrate=kwargs.get("baudrate", None),
+            bytesize=kwargs.get("bytesize", None),
+            parity=kwargs.get("parity", None),
+            stopbits=kwargs.get("stopbits", None),
+        )
         if not self.use_sync:
             ModbusProtocol.__init__(
                 self,
-                CommParams(
-                    comm_type=kwargs.get("CommType"),
-                    comm_name="comm",
-                    reconnect_delay=reconnect_delay,
-                    reconnect_delay_max=reconnect_delay_max,
-                    timeout_connect=timeout,
-                    host=kwargs.get("host", None),
-                    port=kwargs.get("port", None),
-                    sslctx=kwargs.get("sslctx", None),
-                    baudrate=kwargs.get("baudrate", None),
-                    bytesize=kwargs.get("bytesize", None),
-                    parity=kwargs.get("parity", None),
-                    stopbits=kwargs.get("stopbits", None),
-                ),
+                setup_params,
                 False,
             )
+        else:
+            self.comm_params = setup_params
         self.framer = framer
         self.params = self._params()
-        self.params.timeout = float(timeout)
         self.params.retries = int(retries)
         self.params.retry_on_empty = bool(retry_on_empty)
         self.params.close_comm_on_error = bool(close_comm_on_error)
@@ -199,7 +194,9 @@ async def async_execute(self, request=None):
             resp = b"Broadcast write sent - no response expected"
         else:
             try:
-                resp = await asyncio.wait_for(req, timeout=self.params.timeout)
+                resp = await asyncio.wait_for(
+                    req, timeout=self.comm_params.timeout_connect
+                )
             except asyncio.exceptions.TimeoutError:
                 self.close(reconnect=True)
                 raise
@@ -315,4 +312,6 @@ def __str__(self):
 
         :returns: The string representation
         """
-        return f"{self.__class__.__name__} {self.params.host}:{self.params.port}"
+        return (
+            f"{self.__class__.__name__} {self.comm_params.host}:{self.comm_params.port}"
+        )

pymodbus/client/serial.py

@@ -68,11 +68,6 @@ def __init__(
             stopbits=stopbits,
             **kwargs,
         )
-        self.params.port = port
-        self.params.baudrate = baudrate
-        self.params.bytesize = bytesize
-        self.params.parity = parity
-        self.params.stopbits = stopbits
         self.params.handle_local_echo = handle_local_echo
 
     @property
@@ -138,18 +133,23 @@ def __init__(
         """Initialize Modbus Serial Client."""
         self.transport = None
         kwargs["use_sync"] = True
-        super().__init__(framer=framer, **kwargs)
-        self.params.port = port
-        self.params.baudrate = baudrate
-        self.params.bytesize = bytesize
-        self.params.parity = parity
-        self.params.stopbits = stopbits
+        ModbusBaseClient.__init__(
+            self,
+            framer=framer,
+            CommType=CommType.SERIAL,
+            host=port,
+            baudrate=baudrate,
+            bytesize=bytesize,
+            parity=parity,
+            stopbits=stopbits,
+            **kwargs,
+        )
         self.params.handle_local_echo = handle_local_echo
         self.socket = None
 
         self.last_frame_end = None
 
-        self._t0 = float(1 + 8 + 2) / self.params.baudrate
+        self._t0 = float(1 + 8 + 2) / self.comm_params.baudrate
 
         """
         The minimum delay is 0.01s and the maximum can be set to 0.05s.
@@ -161,7 +161,7 @@ def __init__(
             else 0.05
         )
 
-        if self.params.baudrate > 19200:
+        if self.comm_params.baudrate > 19200:
             self.silent_interval = 1.75 / 1000  # ms
         else:
             self.inter_char_timeout = 1.5 * self._t0
@@ -179,12 +179,12 @@ def connect(self):  # pylint: disable=invalid-overridden-method
             return True
         try:
             self.socket = serial.serial_for_url(
-                self.params.port,
-                timeout=self.params.timeout,
-                bytesize=self.params.bytesize,
-                stopbits=self.params.stopbits,
-                baudrate=self.params.baudrate,
-                parity=self.params.parity,
+                self.comm_params.host,
+                timeout=self.comm_params.timeout_connect,
+                bytesize=self.comm_params.bytesize,
+                stopbits=self.comm_params.stopbits,
+                baudrate=self.comm_params.baudrate,
+                parity=self.comm_params.parity,
             )
             if isinstance(self.framer, ModbusRtuFramer):
                 if self.params.strict:
@@ -244,10 +244,13 @@ def _wait_for_data(self):
         """Wait for data."""
         size = 0
         more_data = False
-        if self.params.timeout is not None and self.params.timeout:
+        if (
+            self.comm_params.timeout_connect is not None
+            and self.comm_params.timeout_connect
+        ):
             condition = partial(
                 lambda start, timeout: (time.time() - start) <= timeout,
-                timeout=self.params.timeout,
+                timeout=self.comm_params.timeout_connect,
             )
         else:
             condition = partial(lambda dummy1, dummy2: True, dummy2=None)
@@ -286,11 +289,11 @@ def is_socket_open(self):
 
     def __str__(self):
         """Build a string representation of the connection."""
-        return f"ModbusSerialClient({self.framer} baud[{self.params.baudrate}])"
+        return f"ModbusSerialClient({self.framer} baud[{self.comm_params.baudrate}])"
 
     def __repr__(self):
         """Return string representation."""
         return (
             f"<{self.__class__.__name__} at {hex(id(self))} socket={self.socket}, "
-            f"framer={self.framer}, timeout={self.params.timeout}>"
+            f"framer={self.framer}, timeout={self.comm_params.timeout_connect}>"
         )

pymodbus/client/tcp.py

@@ -54,8 +54,6 @@ def __init__(
             port=port,
             **kwargs,
         )
-        self.params.host = host
-        self.params.port = port
         self.params.source_address = source_address
 
     async def connect(self) -> bool:
@@ -111,11 +109,11 @@ def __init__(
         **kwargs: Any,
     ) -> None:
         """Initialize Modbus TCP Client."""
+        if "CommType" not in kwargs:
+            kwargs["CommType"] = CommType.TCP
         kwargs["use_sync"] = True
         self.transport = None
         super().__init__(framer=framer, host=host, port=port, **kwargs)
-        self.params.host = host
-        self.params.port = port
         self.params.source_address = source_address
         self.socket = None
 
@@ -130,8 +128,8 @@ def connect(self):  # pylint: disable=invalid-overridden-method
             return True
         try:
             self.socket = socket.create_connection(
-                (self.params.host, self.params.port),
-                timeout=self.params.timeout,
+                (self.comm_params.host, self.comm_params.port),
+                timeout=self.comm_params.timeout_connect,
                 source_address=self.params.source_address,
             )
             Log.debug(
@@ -141,8 +139,8 @@ def connect(self):  # pylint: disable=invalid-overridden-method
         except OSError as msg:
             Log.error(
                 "Connection to ({}, {}) failed: {}",
-                self.params.host,
-                self.params.port,
+                self.comm_params.host,
+                self.comm_params.port,
                 msg,
             )
             self.close()
@@ -157,7 +155,7 @@ def close(self):  # pylint: disable=arguments-differ
     def _check_read_buffer(self):
         """Check read buffer."""
         time_ = time.time()
-        end = time_ + self.params.timeout
+        end = time_ + self.comm_params.timeout_connect
         data = None
         ready = select.select([self.socket], [], [], end - time_)
         if ready[0]:
@@ -193,7 +191,7 @@ def recv(self, size):
         # less than the expected size.
         self.socket.setblocking(0)
 
-        timeout = self.params.timeout
+        timeout = self.comm_params.timeout_connect
 
         # If size isn't specified read up to 4096 bytes at a time.
         if size is None:
@@ -270,11 +268,11 @@ def __str__(self):
 
         :returns: The string representation
         """
-        return f"ModbusTcpClient({self.params.host}:{self.params.port})"
+        return f"ModbusTcpClient({self.comm_params.host}:{self.comm_params.port})"
 
     def __repr__(self):
         """Return string representation."""
         return (
             f"<{self.__class__.__name__} at {hex(id(self))} socket={self.socket}, "
-            f"ipaddr={self.params.host}, port={self.params.port}, timeout={self.params.timeout}>"
+            f"ipaddr={self.comm_params.host}, port={self.comm_params.port}, timeout={self.comm_params.timeout_connect}>"
         )

pymodbus/client/tls.py

@@ -127,7 +127,9 @@ def __init__(
     ):
         """Initialize Modbus TLS Client."""
         self.transport = None
-        super().__init__(host, port=port, framer=framer, **kwargs)
+        super().__init__(
+            host, CommType=CommType.TLS, port=port, framer=framer, **kwargs
+        )
         self.sslctx = CommParams.generate_ssl(
             False, certfile, keyfile, password, sslctx=sslctx
         )
@@ -147,28 +149,28 @@ def connect(self):
             if self.params.source_address:
                 sock.bind(self.params.source_address)
             self.socket = self.sslctx.wrap_socket(
-                sock, server_side=False, server_hostname=self.params.host
+                sock, server_side=False, server_hostname=self.comm_params.host
             )
-            self.socket.settimeout(self.params.timeout)
-            self.socket.connect((self.params.host, self.params.port))
+            self.socket.settimeout(self.comm_params.timeout_connect)
+            self.socket.connect((self.comm_params.host, self.comm_params.port))
         except OSError as msg:
             Log.error(
                 "Connection to ({}, {}) failed: {}",
-                self.params.host,
-                self.params.port,
+                self.comm_params.host,
+                self.comm_params.port,
                 msg,
             )
             self.close()
         return self.socket is not None
 
     def __str__(self):
         """Build a string representation of the connection."""
-        return f"ModbusTlsClient({self.params.host}:{self.params.port})"
+        return f"ModbusTlsClient({self.comm_params.host}:{self.comm_params.port})"
 
     def __repr__(self):
         """Return string representation."""
         return (
             f"<{self.__class__.__name__} at {hex(id(self))} socket={self.socket}, "
-            f"ipaddr={self.params.host}, port={self.params.port}, sslctx={self.sslctx}, "
-            f"timeout={self.params.timeout}>"
+            f"ipaddr={self.comm_params.host}, port={self.comm_params.port}, sslctx={self.sslctx}, "
+            f"timeout={self.comm_params.timeout_connect}>"
         )

pymodbus/client/udp.py

@@ -54,7 +54,6 @@ def __init__(
         ModbusBaseClient.__init__(
             self, framer=framer, CommType=CommType.UDP, host=host, port=port, **kwargs
         )
-        self.params.port = port
         self.params.source_address = source_address
 
     @property
@@ -117,9 +116,9 @@ def __init__(
         """Initialize Modbus UDP Client."""
         kwargs["use_sync"] = True
         self.transport = None
-        super().__init__(framer=framer, **kwargs)
-        self.params.host = host
-        self.params.port = port
+        super().__init__(
+            framer=framer, port=port, host=host, CommType=CommType.UDP, **kwargs
+        )
         self.params.source_address = source_address
 
         self.socket = None
@@ -137,9 +136,9 @@ def connect(self):  # pylint: disable=invalid-overridden-method
         if self.socket:
             return True
         try:
-            family = ModbusUdpClient._get_address_family(self.params.host)
+            family = ModbusUdpClient._get_address_family(self.comm_params.host)
             self.socket = socket.socket(family, socket.SOCK_DGRAM)
-            self.socket.settimeout(self.params.timeout)
+            self.socket.settimeout(self.comm_params.timeout_connect)
         except OSError as exc:
             Log.error("Unable to create udp socket {}", exc)
             self.close()
@@ -161,7 +160,9 @@ def send(self, request):
         if not self.socket:
             raise ConnectionException(str(self))
         if request:
-            return self.socket.sendto(request, (self.params.host, self.params.port))
+            return self.socket.sendto(
+                request, (self.comm_params.host, self.comm_params.port)
+            )
         return 0
 
     def recv(self, size):
@@ -183,11 +184,11 @@ def is_socket_open(self):
 
     def __str__(self):
         """Build a string representation of the connection."""
-        return f"ModbusUdpClient({self.params.host}:{self.params.port})"
+        return f"ModbusUdpClient({self.comm_params.host}:{self.comm_params.port})"
 
     def __repr__(self):
         """Return string representation."""
         return (
             f"<{self.__class__.__name__} at {hex(id(self))} socket={self.socket}, "
-            f"ipaddr={self.params.host}, port={self.params.port}, timeout={self.params.timeout}>"
+            f"ipaddr={self.comm_params.host}, port={self.comm_params.port}, timeout={self.comm_params.timeout_connect}>"
         )

pymodbus/framer/rtu_framer.py

@@ -248,7 +248,7 @@ def sendPacket(self, message):
         :return:
         """
         start = time.time()
-        timeout = start + self.client.params.timeout
+        timeout = start + self.client.comm_params.timeout_connect
         while self.client.state != ModbusTransactionState.IDLE:
             if self.client.state == ModbusTransactionState.TRANSACTION_COMPLETE:
                 timestamp = round(time.time(), 6)
@@ -272,7 +272,7 @@ def sendPacket(self, message):
             elif self.client.state == ModbusTransactionState.RETRYING:
                 # Simple lets settle down!!!
                 # To check for higher baudrates
-                time.sleep(self.client.params.timeout)
+                time.sleep(self.client.comm_params.timeout_connect)
                 break
             elif time.time() > timeout:
                 Log.debug(