diff options
| author | Chris Liechti <cliechti@gmx.net> | 2015-10-21 17:37:38 +0200 |
|---|---|---|
| committer | Chris Liechti <cliechti@gmx.net> | 2015-10-21 17:37:38 +0200 |
| commit | e015b40c2f127edba2bc5041dca73ea871a959bf (patch) | |
| tree | 1fd8ef3dfc3ea9eeff3d2830e3b58e1718384c22 /documentation | |
| parent | 2a1befc9a5e7ca1ba2c11fead5115682fbe8d8c4 (diff) | |
| download | pyserial-git-e015b40c2f127edba2bc5041dca73ea871a959bf.tar.gz | |
doc update: add description of alt:// URL handler
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/url_handlers.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/documentation/url_handlers.rst b/documentation/url_handlers.rst index 9814f24..dad518c 100644 --- a/documentation/url_handlers.rst +++ b/documentation/url_handlers.rst @@ -186,6 +186,32 @@ Outputs:: .. versionadded:: 3.0 +``alt://`` +========== +This handler allows to select alternate implementations of the native serial port. + +Currently only the Posix platform provides alternative implementations. + +``PosixPollSerial`` + Poll based read implementation. Not all systems support poll properly. + However this one has better handling of errors, such as a device + disconnecting while it's in use (e.g. USB-serial unplugged). + +``VTIMESerial`` + Implement timeout using ``VTIME``/``VMIN`` of tty device instead of using + ``select``. This means that inter character timeout and overall timeout + can not be used at the same time. Overall timeout is disabled when + inter-character timeout is used. The error handling is degraded. + + +Examples:: + + alt:///dev/ttyUSB0?class=PosixPollSerial + alt:///dev/ttyUSB0?class=VTIMESerial + +.. versionadded:: 3.0 + + Examples ======== @@ -196,5 +222,6 @@ Examples - ``loop://?logging=debug`` - ``hwgrep://0451:f432`` (USB VID:PID) - ``spy://COM54?file=log.txt`` +- ``alt:///dev/ttyUSB0?class=PosixPollSerial`` |