Pymodbus v3.8.0

This is the biggest release since 3.0.0, it contains:

• new framer concept (utility class instead of direct)
• new much simpler transactionManager
• trace methods to trace/modify incoming/outgoing byte streams as well as PDUs
• A lot of bug fixes

Version 3.8.0

• slave_id -> dev_id (internally). (#2486)
• Pin python 3.13.0 and update ruff. (#2487)
• Add documentation link to README. (#2483)
• Add datatype bits to convert_to/from_registers. (#2480)
• Add trace API to server. (#2479)
• Add trace API for client. (#2478)
• Integrate TransactionManager in server. (#2475)
• Rename test/sub_. (#2473)
• Check server closes file descriptors. (#2472)
• Update http_server.py (#2471)
• Restrict write_registers etc to list[int]. (#2469)
• Write_registers/pdu typing again. (#2468)
• Remove ModbusExceptions enum. (#2467)
• Add special ssl socket handling of "no data". (#2466)
• Add tip that values= will be modified to list[int]. (#2465)
• client 100% test coverage (#2396)
• Extend TransactionManager to handle sync. (#2457)
• Add convert_from to simple examples. (#2458)
• New async transaction manager. (#2453)
• Deprecate BinaryPayloadDecoder / BinaryPayloadBuilder. (#2456)
• Correct close for server transport. (#2455)
• RTU frame problem, when received split. (#2452)
• pdu, 100% coverage. (#2450)
• Refactor PDU, add strong typing to base classes. (#2438)
• Enforce keyword only parameters. (#2448)
• Fix read_device_information with sync client. (#2441)
• Simplify syncTransactionManager. (#2443)
• Import examples direct. (#2442)
• rename ModbusExceptions enums to legal constants. (#2436)
• Add typing to examples. (#2435)
• Refactor PDU diag. (#2421)
• Fix client lock, Parallel API calls are not permitted. (#2434)
• Ensure accept_no_response_limit > retries. (#2433)
• Check client and frametype. (#2426)
• Add MDAP to TLS frame. (#2425)
• Clean/Finalize testing for bit functions. (#2420)
• Simplify pdu bit, remove skip_encode. (#2417)
• remove zero_mode parameter. (#2354)
• Prepare refactor messages. (#2416)
• Fixed handle local echo in serialserver (#2415)
• Correct minor framer/pdu errors. (#2407)
• Rtu decode frames without byte count. (#2412)
• Improve type of parameter values of write_registers (#2411)
• PDU lookupClass work with sub function code. (#2410)
• Correct wait_next_api link in README. (#2406)

Pymodbus v3.7.4

Version v3.7.3 contains a critical bug, that makes the sync. client disconnect/connect with every request, thus adding a large delay.

• Clean PDU init. (#2399)
• Wrong close, when transaction do not match. (#2401)
• Remove unmaintained (not working) example contributions. (#2400)
• All pdu (incl. function code) tests to pdu directory. (#2397)
• Add no_response_expected argument to requests (#2385)
• Resubmit: Don't close/reopen tcp connection on single modbus message timeout (#2350)
• 100% test coverage for PDU. (#2394)
• Type DecodePDU. (#2392)
• Update to use DecodePDU. (#2391)
• Client/Server decoder renamed and moved to pdu. (#2390)
• Move client/server decoder to pdu. (#2388)
• Introducing PyModbus Guru on Gurubase.io (#2387)
• Remove IllegalFunctionRequest. (#2384)
• remove ModbusResponse. (#2383)
• Add typing to pdu base classes. (#2380)
• Updated roadmap.
• remove databuffer from framer. (#2379)
• Improve retries for sync client. (#2377)
• Move process test to framer tests (#2376)
• Framer do not check ids (#2375)
• Remove callback from framer. (#2374)
• Auto fill device ids for clients. (#2372)
• Reenable multidrop tests. (#2370)
• write_register/s accept bytes or int. (#2369)
• roadmap corrections.
• Added roadmap (not written in stone). (#2367)
• Update README to show python 3.13.
• Test on Python 3.13 (#2366)
• Use @AbstractMethod (#2365)
• Corrected smaller documentation bugs. (#2364)
• README as landing page in readthedocs. (#2363)

Pymodbus v3.7.3

Bug fix release and framers updated.

Details:

• Readme file renamed (#2357)
• Remove old framers (#2358)
• frameProcessIncomingPacket removed (#2355)
• Cleanup framers (reduce old_framers) (#2342)
• Run CI on PR targeted at wait_next_api.
• Sync client, allow unknown recv msg size. (#2353)
• integrate old rtu framer in new framer (#2344)
• Update README.rst (#2351)
• Client.close should not allow reconnect= (#2347)
• Remove async client.idle_time(). (#2349)
• Client doc, add common methods (base). (#2348)
• Reset receive buffer with send(). (#2343)
• Remove unused protocol_id from pdu (#2340)
• CI run on demand on non-protected branches. (#2339)
• Server listener and client connections have is_server set. (#2338)
• Reopen listener in server if disconnected. (#2337)
• Regroup test. (#2335)
• Improve docs around sync clients and reconnection (#2321)
• transport 100% test coverage (again) (#2333)
• Update actions to new node.js. (#2332)
• Bump 3rd party (#2331)
• Documentation on_connect_callback (#2324)
• Fixes the unexpected implementation of the ModbusSerialClient.connected property (#2327)
• Forward error responses instead of timing out. (#2329)
• Add stacklevel=2 to logging functions (#2330)
• Fix encoding & decoding of ReadFileRecordResponse (#2319)
• Improvements for example/contib/solar (#2318)
• Update solar.py (#2316)
• Remove double conversion in int (#2315)
• Complete pull request #2310 (#2312)
• fixed type hints for write_register and write_registers (#2309)
• Remove _header from framers. (#2305)

pymodbus v3.7.2

v3.7.1 had wrong documentation.

• Correct README
• Rename branch wait3.8.0 to wait_next_API

pymodbus v3.7.1

• Better error message, when pyserial is missing.
• Slave=0 will return first response, used to identify device address. (#2298)
• Feature/add simulator api skeleton (#2274)
• Correct max. read size for registers. (#2295)
• Ruff complains, due to upgrade. (#2296)
• Properly process 'slaves' argument (#2292)
• Update repl requirement to >= 2.0.4 (#2291)
• Fix aiohttp < 3.9.0 (#2289)
• Simplify framer test setup (#2290)
• Clean up ModbusControlBlock (#2288)
• example docstrings diag_message -> pdu.diag_message (#2286)
• Explain version schema (#2284)
• Add more testing for WriteRegisters. (#2280)
• Proof for issue 2273. (#2277)
• Update simulator tests. (#2276)

pymodbus 3.7.0

Version 3.7.0

• Remove unneeded client parameters. (#2272)
• simulator: Fix context single parameter (#2264)
• buildPacket can be used for Request and Response (#2262)
• More descriptive decoder exceptions (#2260)
• Cleanup ReadWriteMultipleRegistersResponse and testing (#2261)
• Feature/simulator addressing (#2258)
• Framer optimization (apart from RTU). (#2146)
• Use mock.patch.object to avoid protected access errors. (#2251)
• Fix some mypy type checking errors in test_transaction.py (#2250)
• Update check for windows platform (#2247)
• Logging 100% coverage. (#2248)
• CI, Block draft PRs to use CPU minutes. (#2245, #2246)
• Remove kwargs client. (#2243, #2244, #2257)
• remove kwargs PDU messagees. (#2240)
• Remove message_generator example (not part of API). (#2239)
• Update dev dependencies (#2241)
• Fix ruff check in CI (#2242)
• Remove kwargs. (#2236, #2237)
• Simulator config, kwargs -> parameters. (#2235)
• Refactor transaction handling to better separate async and sync code. (#2232)
• Simplify some BinaryPayload pack operations (#2224)
• Fix writing to serial (rs485) on windows os. (#2191)
• Remember to remove serial writer. (#2209)
• Transaction_id for serial == 0. (#2208)
• Solve pylint error.
• Sync TLS needs time before reading frame (#2186)
• Update transaction.py (#2174)
• PDU classes --> pymodbus/pdu. (#2160)
• Speed up no data detection. (#2150)
• RTU decode hunt part. (#2138)
• Dislodge client classes from modbusProtocol. (#2137)
• Merge new message layer and old framer directory. (#2135)
• Coverage == 91%. (#2132)
• Remove binary_framer. (#2130)
• on_reconnect_callback --> on_connect_callback. (#2122)
• Remove certfile,keyfile,password from TLS client. (#2121)
• Drop support for python 3.8 (#2112)

API CHANGES:

• default slave changed to 1 from 0 (which is broadcast).
• broadcast_enable, retry_on_empty, no_resend_on_retry parameters removed.
• class method generate_ssl() added to TLS client (sync/async).
• removed certfile, keyfile, password from TLS client, please use generate_ssl()
• on_reconnect_callback() removed from clients (sync/async).
• on_connect_callback(true/false) added to async clients.
• binary framer no longer supported
• Framer. renamed to FramerType.
• PDU classes moved to pymodbus/pdu
• Simulator config custom actions kwargs -> parameters
• Non defined parameters (kwargs) no longer valid
• Drop support for Python 3.8 (its no longer tested, but will probably work)

pymodbus v3.6.9

• Remove python 3.8 from CI
• Log comm retries. (#2220)
• Solve serial unrequested frame. (#2219)
• test convert registers with 1234.... (#2217)
• Fix writing to serial (rs485) on windows os. (#2191)
• Remember to remove serial writer. (#2209)
• Update client.rst (#2199)
• Fix usage file names (#2194)
• Show error if example is run without support files. (#2189)
• Solve pylint error.
• Describe zero_mode in ModbusSlaveContext.init (#2187)
• Datastore will not return ExceptionResponse. (#2175)
• call async datastore from modbus server (#2144)
• Transaction id overrun.
• Add minimal devcontainer. (#2172)
• Sphinx: do not turn warnings into errors.
• Fix usage of AsyncModbusTcpClient in client docs page (#2169)
• Bump actions CI. (#2166)
• Request/Response: change execute to be async method (#2142)
• datastore: add async_setValues/getValues methods (#2165)
• fixed kwargs not being expanded for actions on bit registers, adjusted tests to catch this issue (#2161)
• Clean datastore setValues. (#2145)
• modbus_server: call execute in a way that those can be either coroutines or normal methods (#2139)
• Streamline message class. (#2133)
• Fix decode for wrong mdap len.
• SOCKET/TLS framer using message decode(). (#2129)
• ASCII framer using message decode() (#2128)
• Add generate_ssl() to TLS client as helper. (#2120)
• add _legacy_decoder to message rtu (#2119)

pymodbus v3.6.8

• Allow socket exception response with wrong length

Pymodbus v3.6.7

Solve problems with Home Assistant 2024.4.x modbus integration !!!

Include PRs from dev that do not have API changes.

• Add lock to async requests, correct logging and length calc. (FIX, not on dev)
• test_simulator: use unused_tcp_port fixture (#2141)
• streamline imports in Factory.py (#2140)
• Secure testing is done with pymodbus in PR. (#2136)
• Fix link to github in README (#2134)
• Wildcard exception catch from pyserial. (#2125)
• Problem with stale CI. (#2117)
• Add connection exception to list of exceptions catpured in retries (#2113)
• Move on_reconnect to client level (#2111)
• Bump github stale. (#2110)
• update package_test_tool (add 4 test scenarios) (#2107)
• Bump dependencies. (#2108)
• Cancel send if no connection. (#2103)

pymodbus v3.6.6

Version 3.6.6

• Solve transport close() as not inherited method. (#2098)
• enable mypy --check-untyped-defs (#2096)
• Add get_expected_response_length to transaction.
• Remove control encode in framersRemove control encode in framers. (#2095)
• Bump codeql in CI to v3. (#2093)
• Improve server types (#2092)
• Remove pointless try/except (#2091)
• Improve transport types (#2090)
• Use explicit ValueError when called with incorrect function code (#2089)
• update message tests (incorporate all old tests). (#2088)
• Improve simulator type hints (#2084)
• Cleanup dead resetFrame code (#2082)
• integrate message.encode() into framer.buildPacket. (#2062)
• Repair client close() (intern= is needed for ModbusProtocol). (#2080)
• Updated Message_Parser example (#2079)
• Fix #2069 use released repl from pypi (#2077)
• Fix field encoding of Read File Record Response (#2075)
• Improve simulator types (#2076)
• Bump actions. (#2071)