Improve docs around sync clients and reconnection #2321
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sync clients don't do reconnection in the same way as async clients, and should have a little more explanation as to what they do. See issue pymodbus-dev#2320
janiversen
requested changes
Sep 15, 2024
|
|
||
| from pymodbus.client import ModbusTcpClient | ||
|
|
||
| client = ModbusTcpClient('MyDevice.lan') # Create client object | ||
| client.connect() # connect to device, reconnect automatically |
There was a problem hiding this comment.
This is missing the fact, that a reconnect is done with the next request.
doc/source/client.rst
Outdated
| @@ -153,6 +166,9 @@ The line :mod:`result = await client.read_coils(2, 3, slave=1)` is an example of | |||
|
|
|||
| The last line :mod:`client.close()` closes the connection and render the object inactive. | |||
|
|
|||
| Usage notes | |||
There was a problem hiding this comment.
The notes have nothing to do with the usage! it merely an information.
pymodbus/client/tcp.py
Outdated
| **reconnect_delay** doubles automatically with each unsuccessful connect, from | ||
| **reconnect_delay** to **reconnect_delay_max**. | ||
| Set `reconnect_delay=0` to avoid automatic reconnection. | ||
| Note that unlike the async client, the sync client does not perform |
There was a problem hiding this comment.
missing an empty line,
pymodbus/client/tls.py
Outdated
| **reconnect_delay** doubles automatically with each unsuccessful connect, from | ||
| **reconnect_delay** to **reconnect_delay_max**. | ||
| Set `reconnect_delay=0` to avoid automatic reconnection. | ||
| Note that unlike the async client, the sync client does not perform |
There was a problem hiding this comment.
missing an empty line.
pymodbus/client/udp.py
Outdated
| **reconnect_delay** doubles automatically with each unsuccessful connect, from | ||
| **reconnect_delay** to **reconnect_delay_max**. | ||
| Set `reconnect_delay=0` to avoid automatic reconnection. | ||
| Note that unlike the async client, the sync client does not perform |
There was a problem hiding this comment.
missing an empty line.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sync clients don't do reconnection in the same way as async clients, and should have a little more explanation as to what they do.
fixes #2320
Verified that docs successfully build and look right.