Vendor pymodbus, rather than relying on the version which HA installs

This should protect us from HA breaking things in the future!

Fixes: #748

Author: canton7

Diff for: .pre-commit-config.yaml

@@ -5,6 +5,7 @@ repos:
       - id: check-added-large-files
       - id: check-yaml
       - id: end-of-file-fixer
+        exclude: ^custom_components\/foxess_modbus\/vendor
       - id: trailing-whitespace
   - repo: local
     hooks:

Diff for: .prettierignore

@@ -1 +1,2 @@
 tests/__snapshots__
+custom_components/foxess_modbus/vendor

Diff for: .vscode/settings.json

@@ -27,5 +27,8 @@
       "source.fixAll": "explicit"
     },
     "editor.defaultFormatter": "ms-python.black-formatter"
-  }
+  },
+  "python.analysis.extraPaths": [
+    "./custom_components/foxess_modbus/vendor/pymodbus/pymodbus-3.6.9"
+  ]
 }

Diff for: custom_components/foxess_modbus/client/custom_modbus_tcp_client.py

@@ -5,23 +5,23 @@
 from typing import Any
 from typing import cast
 
-from pymodbus.client import ModbusTcpClient
-from pymodbus.exceptions import ConnectionException
+from ..vendor.pymodbus import ConnectionException
+from ..vendor.pymodbus import ModbusTcpClient
 
 _LOGGER = logging.getLogger(__name__)
 
 
 class CustomModbusTcpClient(ModbusTcpClient):
     """Custom ModbusTcpClient subclass with some hacks"""
 
-    def __init__(self, delay_on_connect: int | None = None, **kwargs: Any) -> None:
+    def __init__(self, delay_on_connect: int | None, **kwargs: Any) -> None:
         super().__init__(**kwargs)
         self._delay_on_connect = delay_on_connect
 
     def connect(self) -> bool:
         was_connected = self.socket is not None
         if not was_connected:
-            _LOGGER.debug("Connecting to %s", self.comm_params)
+            _LOGGER.debug("Connecting to %s", self.params)
         is_connected = cast(bool, super().connect())
         # pymodbus doesn't disable Nagle's algorithm. This slows down reads quite substantially as the
         # TCP stack waits to see if we're going to send anything else. Disable it ourselves.
@@ -34,7 +34,7 @@ def connect(self) -> bool:
 
     # Replacement of ModbusTcpClient to use poll rather than select, see
     # https://github.com/nathanmarlor/foxess_modbus/issues/275
-    def recv(self, size: int | None) -> bytes:
+    def recv(self, size: int) -> bytes:
         """Read data from the underlying descriptor."""
         super(ModbusTcpClient, self).recv(size)
         if not self.socket:
@@ -48,9 +48,9 @@ def recv(self, size: int | None) -> bytes:
         # is received or timeout is expired.
         # If timeout expires returns the read data, also if its length is
         # less than the expected size.
-        self.socket.setblocking(False)
+        self.socket.setblocking(0)
 
-        timeout = self.comm_params.timeout_connect or 0
+        timeout = self.comm_params.timeout_connect
 
         # If size isn't specified read up to 4096 bytes at a time.
         if size is None:
@@ -90,5 +90,20 @@ def recv(self, size: int | None) -> bytes:
             if time_ > end:
                 break
 
-        self.last_frame_end = round(time.time(), 6)
         return b"".join(data)
+
+    # Replacement of ModbusTcpClient to use poll rather than select, see
+    # https://github.com/nathanmarlor/foxess_modbus/issues/275
+    def _check_read_buffer(self) -> bytes | None:
+        """Check read buffer."""
+        time_ = time.time()
+        end = time_ + self.params.timeout
+        data = None
+
+        assert self.socket is not None
+        poll = select.poll()
+        poll.register(self.socket, select.POLLIN)
+        poll_res = poll.poll(end - time_)
+        if len(poll_res) > 0:
+            data = self.socket.recv(1024)
+        return data

Diff for: custom_components/foxess_modbus/client/modbus_client.py

@@ -11,14 +11,6 @@
 
 import serial
 from homeassistant.core import HomeAssistant
-from pymodbus.client import ModbusSerialClient
-from pymodbus.client import ModbusUdpClient
-from pymodbus.framer import FramerType
-from pymodbus.pdu import ModbusPDU
-from pymodbus.pdu.register_read_message import ReadHoldingRegistersResponse
-from pymodbus.pdu.register_read_message import ReadInputRegistersResponse
-from pymodbus.pdu.register_write_message import WriteMultipleRegistersResponse
-from pymodbus.pdu.register_write_message import WriteSingleRegisterResponse
 
 from .. import client
 from ..common.types import ConnectionType
@@ -28,6 +20,15 @@
 from ..const import TCP
 from ..const import UDP
 from ..inverter_adapters import InverterAdapter
+from ..vendor.pymodbus import ModbusResponse
+from ..vendor.pymodbus import ModbusRtuFramer
+from ..vendor.pymodbus import ModbusSerialClient
+from ..vendor.pymodbus import ModbusSocketFramer
+from ..vendor.pymodbus import ModbusUdpClient
+from ..vendor.pymodbus import ReadHoldingRegistersResponse
+from ..vendor.pymodbus import ReadInputRegistersResponse
+from ..vendor.pymodbus import WriteMultipleRegistersResponse
+from ..vendor.pymodbus import WriteSingleRegisterResponse
 from .custom_modbus_tcp_client import CustomModbusTcpClient
 
 _LOGGER = logging.getLogger(__name__)
@@ -38,19 +39,19 @@
 _CLIENTS: dict[str, dict[str, Any]] = {
     SERIAL: {
         "client": ModbusSerialClient,
-        "framer": FramerType.RTU,
+        "framer": ModbusRtuFramer,
     },
     TCP: {
         "client": CustomModbusTcpClient,
-        "framer": FramerType.SOCKET,
+        "framer": ModbusSocketFramer,
     },
     UDP: {
         "client": ModbusUdpClient,
-        "framer": FramerType.SOCKET,
+        "framer": ModbusSocketFramer,
     },
     RTU_OVER_TCP: {
         "client": CustomModbusTcpClient,
-        "framer": FramerType.RTU,
+        "framer": ModbusRtuFramer,
     },
 }
 
@@ -69,16 +70,14 @@ def __init__(self, hass: HomeAssistant, protocol: str, adapter: InverterAdapter,
 
         client = _CLIENTS[protocol]
 
+        # Delaying for a second after establishing a connection seems to help the inverter stability,
+        # see https://github.com/nathanmarlor/foxess_modbus/discussions/132
         config = {
             **config,
             "framer": client["framer"],
+            "delay_on_connect": 1 if adapter.connection_type == ConnectionType.LAN else None,
         }
 
-        # Delaying for a second after establishing a connection seems to help the inverter stability,
-        # see https://github.com/nathanmarlor/foxess_modbus/discussions/132
-        if adapter.connection_type == ConnectionType.LAN:
-            config["delay_on_connect"] = 1
-
         # If our custom PosixPollSerial hack is supported, use that. This uses poll rather than select, which means we
         # don't break when there are more than 1024 fds. See #457.
         # Only supported on posix, see https://github.com/pyserial/pyserial/blob/7aeea35429d15f3eefed10bbb659674638903e3a/serial/__init__.py#L31
@@ -225,7 +224,7 @@ def __str__(self) -> str:
 class ModbusClientFailedError(Exception):
     """Raised when the ModbusClient fails to read/write"""
 
-    def __init__(self, message: str, client: ModbusClient, response: ModbusPDU | Exception) -> None:
+    def __init__(self, message: str, client: ModbusClient, response: ModbusResponse | Exception) -> None:
         super().__init__(f"{message} from {client}: {response}")
         self.message = message
         self.client = client

Diff for: custom_components/foxess_modbus/flow/adapter_flow_segment.py

@@ -7,8 +7,6 @@
 from homeassistant.data_entry_flow import FlowResult
 from homeassistant.helpers import config_validation as cv
 from homeassistant.helpers.selector import selector
-from pymodbus.exceptions import ConnectionException
-from pymodbus.exceptions import ModbusIOException
 
 from ..client.modbus_client import ModbusClient
 from ..client.modbus_client import ModbusClientFailedError
@@ -23,6 +21,8 @@
 from ..inverter_adapters import InverterAdapter
 from ..inverter_adapters import InverterAdapterType
 from ..modbus_controller import ModbusController
+from ..vendor.pymodbus import ConnectionException
+from ..vendor.pymodbus import ModbusIOException
 from .flow_handler_mixin import FlowHandlerMixin
 from .flow_handler_mixin import ValidationFailedError
 from .inverter_data import InverterData

Diff for: custom_components/foxess_modbus/manifest.json

@@ -8,6 +8,5 @@
   "integration_type": "service",
   "iot_class": "local_push",
   "issue_tracker": "https://github.com/nathanmarlor/foxess_modbus/issues",
-  "requirements": ["pymodbus>=3.7.4"],
   "version": "1.0.0"
 }

Diff for: custom_components/foxess_modbus/modbus_controller.py

@@ -18,7 +18,6 @@
 from homeassistant.helpers import issue_registry
 from homeassistant.helpers.event import async_track_time_interval
 from homeassistant.helpers.issue_registry import IssueSeverity
-from pymodbus.exceptions import ConnectionException
 
 from .client.modbus_client import ModbusClient
 from .client.modbus_client import ModbusClientFailedError
@@ -38,6 +37,7 @@
 from .inverter_profiles import INVERTER_PROFILES
 from .inverter_profiles import InverterModelConnectionTypeProfile
 from .remote_control_manager import RemoteControlManager
+from .vendor.pymodbus import ConnectionException
 
 _LOGGER = logging.getLogger(__name__)
 

Diff for: custom_components/foxess_modbus/services/update_charge_period_service.py

@@ -10,13 +10,13 @@
 from homeassistant.core import ServiceCall
 from homeassistant.exceptions import HomeAssistantError
 from homeassistant.helpers import config_validation as cv
-from pymodbus.exceptions import ModbusIOException
 
 from ..const import DOMAIN
 from ..entities.modbus_charge_period_sensors import is_time_value_valid
 from ..entities.modbus_charge_period_sensors import parse_time_value
 from ..entities.modbus_charge_period_sensors import serialize_time_to_value
 from ..modbus_controller import ModbusController
+from ..vendor.pymodbus import ModbusIOException
 from .utils import get_controller_from_friendly_name_or_device_id
 
 _LOGGER: logging.Logger = logging.getLogger(__package__)

Diff for: custom_components/foxess_modbus/services/write_registers_service.py

@@ -8,10 +8,10 @@
 from homeassistant.core import ServiceCall
 from homeassistant.exceptions import HomeAssistantError
 from homeassistant.helpers import config_validation as cv
-from pymodbus.exceptions import ModbusIOException
 
 from ..const import DOMAIN
 from ..modbus_controller import ModbusController
+from ..vendor.pymodbus import ModbusIOException
 from .utils import get_controller_from_friendly_name_or_device_id
 
 _LOGGER: logging.Logger = logging.getLogger(__package__)

Diff for: custom_components/foxess_modbus/vendor/pymodbus/__init__.py

@@ -0,0 +1,37 @@
+import sys
+from pathlib import Path
+
+# Update python.analysis.extraPaths in .vscode/settings.json if you change this.
+# If changed, make sure subclasses in modbus_client are still valid!
+sys.path.insert(0, str((Path(__file__).parent / "pymodbus-3.6.9").absolute()))
+
+from pymodbus.client import ModbusSerialClient
+from pymodbus.client import ModbusTcpClient
+from pymodbus.client import ModbusUdpClient
+from pymodbus.exceptions import ConnectionException
+from pymodbus.exceptions import ModbusIOException
+from pymodbus.register_read_message import ReadHoldingRegistersResponse
+from pymodbus.register_read_message import ReadInputRegistersResponse
+from pymodbus.register_write_message import WriteMultipleRegistersResponse
+from pymodbus.register_write_message import WriteSingleRegisterResponse
+from pymodbus.pdu import ModbusResponse
+from pymodbus.transaction import ModbusRtuFramer
+from pymodbus.transaction import ModbusSocketFramer
+
+sys.path.pop(0)
+
+__all__ = [
+    "ModbusSerialClient",
+    "ModbusTcpClient",
+    "ModbusUdpClient",
+    "ConnectionException",
+    "ModbusIOException",
+    "ModbusPDU",
+    "ReadHoldingRegistersResponse",
+    "ReadInputRegistersResponse",
+    "WriteMultipleRegistersResponse",
+    "WriteSingleRegisterResponse",
+    "ModbusResponse",
+    "ModbusRtuFramer",
+    "ModbusSocketFramer",
+]

Diff for: custom_components/foxess_modbus/vendor/pymodbus/pymodbus-3.6.9/bin/pymodbus.simulator

@@ -0,0 +1,8 @@
+#!/usr/local/bin/python3.13
+# -*- coding: utf-8 -*-
+import re
+import sys
+from pymodbus.server.simulator.main import main
+if __name__ == '__main__':
+    sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0])
+    sys.exit(main())