diff options
| author | cliechti <cliechti@f19166aa-fa4f-0410-85c2-fa1106f25c8a> | 2009-08-10 22:19:41 +0000 |
|---|---|---|
| committer | cliechti <cliechti@f19166aa-fa4f-0410-85c2-fa1106f25c8a> | 2009-08-10 22:19:41 +0000 |
| commit | 84d50f88f6e32e598df5b02753b6f49bd3e737ee (patch) | |
| tree | 7b56ddc54099978e601aa3b0bf2ba6bc53f80299 /documentation | |
| parent | 13b7b7dab435a2025d102973c55969ceab229967 (diff) | |
| download | pyserial-84d50f88f6e32e598df5b02753b6f49bd3e737ee.tar.gz | |
- add timeout option for RFC 2217 client
- update docs
git-svn-id: http://svn.code.sf.net/p/pyserial/code/trunk/pyserial@333 f19166aa-fa4f-0410-85c2-fa1106f25c8a
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/pyserial_api.rst | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/documentation/pyserial_api.rst b/documentation/pyserial_api.rst index c26ea3f..e634de3 100644 --- a/documentation/pyserial_api.rst +++ b/documentation/pyserial_api.rst @@ -746,6 +746,11 @@ accept the following types URL: most servers do). Enable this option when :meth:`getCTS` does not work as expected, i.e. for servers that do not send notifications. + - ``timeout=<value>``: Change network timeout (default 3 seconds). This is + useful when the server takes a little more time to send its answers. The + timeout applies to the initial Telnet / :rfc:`2271` negotiation as well + as changing port settings or control line change commands. + - ``debug``: Prints diagnostic messages (not useful for end users). ``socket://`` @@ -768,8 +773,10 @@ accept the following types URL: - ``debug``: Prints diagnostic messages (not useful for end users). -Examples:: +Examples: - rfc2217://localhost:7000 - rfc2217://localhost:7000/poll_modem - rfc2217://localhost:7000/ign_set_control/debug +- ``rfc2217://localhost:7000`` +- ``rfc2217://localhost:7000/poll_modem`` +- ``rfc2217://localhost:7000/ign_set_control/timeout=5.5`` +- ``socket://localhost:7777`` +- ``loop://`` |