Merge branch 'dev'

Author: janiversen

.pre-commit-config.yaml

@@ -11,8 +11,8 @@ repos:
     -   id: check-yaml
     -   id: check-added-large-files
 # run ruff with --fix before black
--   repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.0.277'
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 'v0.0.287'
     hooks:
     -   id: ruff
         args: [--fix, --exit-non-zero-on-fix]

API_changes.rst

@@ -2,6 +2,16 @@
 PyModbus - API changes.
 =======================
 
+-------------
+Version 3.6.0 (future)
+-------------
+
+
+-------------
+Version 3.5.1
+-------------
+No changes.
+
 -------------
 Version 3.5.0
 -------------

CHANGELOG.rst

@@ -1,6 +1,17 @@
 All these version were not possible without volunteers!
 `AUTHORS` contains a complete list for each major version.
 
+version 3.5.1
+----------------------------------------------------------
+- Always close socket on error (reset_sock). (#1767)
+- Revert reset_socket change.
+- add close_comm_on_error to example.
+- Test long term (HomeAsistant problem). (#1765)
+- Update ruff to 0.0.287 (#1764)
+- Remove references to ModbusSerialServer.start (#1759) (#1762)
+- Readd test to get 100% coverage.
+- transport: Don't raise a RunTimeError in ModbusProtocol.error_received() (#1758)
+
 version 3.5.0
 ----------------------------------------------------------
 - Async retry (#1752)

MAKE_RELEASE.rst

@@ -12,9 +12,9 @@ Prepare/make release on dev.
    * Update pymodbus/__init__.py with version number (__version__ X.Y.Zpre)
    * Update README.rst "Supported versions"
    * Update CHANGELOG.rst
-      * Add commits from last release, but selectively !
-        git log --oneline v3.3.0..HEAD > commit.log
-        git log --pretty="%an" v3.0.0..HEAD | sort -uf >> AUTHORS
+      * Add commits from last release, but kselectively !
+        git log --oneline v3.5.1..HEAD > commit.log
+        git log --pretty="%an" v3.5.1..HEAD | sort -uf >> AUTHORS
         update AUTHORS
    * Commit, push and merge.
 * Checkout master locally

examples/contrib/solar.py

@@ -0,0 +1,87 @@
+#!/usr/bin/env python3
+"""Pymodbus Synchronous Client Example.
+
+Modified to test long term connection.
+
+"""
+import logging
+from time import sleep
+
+from pymodbus import pymodbus_apply_logging_config
+
+# --------------------------------------------------------------------------- #
+# import the various client implementations
+# --------------------------------------------------------------------------- #
+from pymodbus.client import ModbusTcpClient
+from pymodbus.exceptions import ModbusException
+from pymodbus.transaction import ModbusSocketFramer
+
+
+logging.basicConfig()
+_logger = logging.getLogger(__file__)
+_logger.setLevel(logging.DEBUG)
+
+
+def main():
+    """Run client setup."""
+    pymodbus_apply_logging_config(logging.DEBUG)
+    _logger.info("### Client starting")
+    client = ModbusTcpClient(
+        "modbusServer.lan",
+        port=502,
+        # Common optional paramers:
+        framer=ModbusSocketFramer,
+        timeout=1,
+        retry_on_empty=True,
+        close_comm_on_error=True,
+    )
+    client.connect()
+    _logger.info("### Client connected")
+    sleep(5)
+    _logger.info("### Client starting")
+    sleep_time = 2
+    for count in range(int(60 / sleep_time) * 60 * 3):  # 3 hours
+        _logger.info(f"Running loop {count}")
+        solar_calls(client)
+        sleep(sleep_time)  # scan_interval
+    client.close()
+    _logger.info("### End of Program")
+
+
+def solar_calls(client):
+    """Test connection works."""
+    for addr, count in (
+        (32008, 1),
+        (32009, 1),
+        (32010, 1),
+        (32016, 1),
+        (32017, 1),
+        (32018, 1),
+        (32019, 1),
+        (32064, 2),
+        (32078, 2),
+        (32080, 2),
+        (32114, 2),
+        (37113, 2),
+        (32078, 2),
+        (32078, 2),
+    ):
+        lazy_error_count = 15
+        while lazy_error_count > 0:
+            try:
+                rr = client.read_coils(addr, count, slave=1)
+            except ModbusException as exc:
+                _logger.debug(f"TEST: exception lazy({lazy_error_count}) {exc}")
+                lazy_error_count -= 1
+                continue
+            if not hasattr(rr, "registers"):
+                _logger.debug(f"TEST: no registers lazy({lazy_error_count})")
+                lazy_error_count -= 1
+                continue
+            break
+        if not lazy_error_count:
+            raise RuntimeError("HARD ERROR, more than 15 retries!")
+
+
+if __name__ == "__main__":
+    main()  # pragma: no cover

pymodbus/__init__.py

@@ -12,5 +12,5 @@
 from pymodbus.logging import pymodbus_apply_logging_config
 
 
-__version__ = "3.5.0"
+__version__ = "3.5.1"
 __version_full__ = f"[pymodbus, version {__version__}]"

pymodbus/mei_message.py

@@ -203,7 +203,7 @@ def decode(self, data):
         while count < len(data):
             object_id, object_length = struct.unpack(">BB", data[count : count + 2])
             count += object_length + 2
-            if object_id not in self.information.keys():
+            if object_id not in self.information:
                 self.information[object_id] = data[count - object_length : count]
             elif isinstance(self.information[object_id], list):
                 self.information[object_id].append(data[count - object_length : count])

pymodbus/repl/client/helper.py

@@ -147,9 +147,7 @@ def get_meta(self, cmd):
     def __str__(self):
         """Return string representation."""
         if self.doc:
-            return "Command {:>50}{:<20}".format(  # pylint: disable=consider-using-f-string
-                self.name, self.doc
-            )
+            return f"Command {self.name:>50}{self.doc:<20}"
         return f"Command {self.name}"
 
 

pymodbus/repl/client/main.py

@@ -191,9 +191,9 @@ def _print_command_help(self, commands):
             if cmd != "help":
                 print_formatted_text(
                     HTML(
-                        "<skyblue>{:45s}</skyblue>"  # pylint: disable=consider-using-f-string
-                        "<seagreen>{:100s}"
-                        "</seagreen>".format(cmd, obj.help_text)
+                        f"<skyblue>{cmd:45s}</skyblue>"
+                        f"<seagreen>{obj.help_text:100s}"
+                        "</seagreen>"
                     )
                 )
 
@@ -263,11 +263,6 @@ def run(self):
     "--retry-on-error", is_flag=True, default=False, help="Retry on error response"
 )
 @click.option("--retries", default=3, help="Retry count")
-@click.option(
-    "--reset-socket/--no-reset-socket",
-    default=True,
-    help="Reset client socket on error",
-)
 @click.pass_context
 def main(
     ctx,
@@ -276,7 +271,6 @@ def main(
     retry_on_empty,
     retry_on_error,
     retries,
-    reset_socket,
 ):
     """Run Main."""
     if verbose:
@@ -291,7 +285,6 @@ def main(
         "retry_on_empty": retry_on_empty,
         "retry_on_invalid": retry_on_error,
         "retries": retries,
-        "reset_socket": reset_socket,
     }
 
 

pymodbus/server/reactive/main.py

@@ -237,18 +237,10 @@ async def start_modbus_server(self, app):
         """
         try:
             if hasattr(asyncio, "create_task"):
-                if isinstance(self._modbus_server, ModbusSerialServer):
-                    app["modbus_serial_server"] = asyncio.create_task(
-                        self._modbus_server.start()
-                    )
                 app["modbus_server"] = asyncio.create_task(
                     self._modbus_server.serve_forever()
                 )
             else:
-                if isinstance(self._modbus_server, ModbusSerialServer):
-                    app["modbus_serial_server"] = asyncio.ensure_future(
-                        self._modbus_server.start()
-                    )
                 app["modbus_server"] = asyncio.ensure_future(
                     self._modbus_server.serve_forever()
                 )