diff options
| author | cliechti <cliechti@f19166aa-fa4f-0410-85c2-fa1106f25c8a> | 2009-08-04 02:24:03 +0000 |
|---|---|---|
| committer | cliechti <cliechti@f19166aa-fa4f-0410-85c2-fa1106f25c8a> | 2009-08-04 02:24:03 +0000 |
| commit | b086e4c65b80baecd09f633077552f2080041810 (patch) | |
| tree | c9cc525480c817052ff83863b2fcb5b2597707fe /documentation/examples.rst | |
| parent | 23b97cf6b6f9aeb0579dd8aa4a3e978610255f6c (diff) | |
| download | pyserial-b086e4c65b80baecd09f633077552f2080041810.tar.gz | |
update example description with RFC-2217 feature
git-svn-id: http://svn.code.sf.net/p/pyserial/code/trunk/pyserial@292 f19166aa-fa4f-0410-85c2-fa1106f25c8a
Diffstat (limited to 'documentation/examples.rst')
| -rw-r--r-- | documentation/examples.rst | 25 |
1 files changed, 23 insertions, 2 deletions
diff --git a/documentation/examples.rst b/documentation/examples.rst index a925ea8..1cd3da0 100644 --- a/documentation/examples.rst +++ b/documentation/examples.rst @@ -98,8 +98,26 @@ TCP/IP - serial bridge This program opens a TCP/IP port. When a connection is made to that port (e.g. with telnet) it forwards all data to the serial port and vice versa. -The serial port settings are set on the command line when starting the program. -There is no possibility to change settings from remote. +There are two modes of operation: + +raw socket (default): + +- The serial port settings are set on the command line when starting the + program. +- There is no possibility to change settings from remote. +- All data is passed through as-is. + +:rfc:`2217` (use ``--rfc2217`` command line option): + +- The initial serial port settings are set on the command line when starting + the program. +- The port settings and control lines (RTS/DTR) can changed at any time using + :rfc:`2217` requests. The status lines (DSR/CTS/RI/CD) are polled every + second and notifications are sent to the client. +- Telnet character IAC (0xff) needs to be doubled in data stream. IAC followed + by an other value is interpreted as telnet command sequence. +- Telnet negotiation commands are sent when connecting to the server. + :: Usage: tcp_serial_redirect.py [options] [port [baudrate]] @@ -130,6 +148,7 @@ There is no possibility to change settings from remote. -P LOCAL_PORT, --localport=LOCAL_PORT local TCP port + --rfc2217 allow control commands with Telnet extension RFC-2217 Newline Settings: Convert newlines between network and serial port. Conversion is @@ -147,6 +166,8 @@ There is no possibility to change settings from remote. this service over the network. Only one connection at once is supported. When the connection is terminated it waits for the next connect. +.. versionchanged:: 2.5 added ``--rfc2217`` option + tcp_serial_redirect.py_ Main program. |