diff options
| author | Chris Liechti <cliechti@gmx.net> | 2016-09-18 23:54:49 +0200 |
|---|---|---|
| committer | Chris Liechti <cliechti@gmx.net> | 2016-09-18 23:54:49 +0200 |
| commit | 961234d714b29032aca01ae03408e69a45a92863 (patch) | |
| tree | ab5e5b987a896740e0a934dc97f964f3c9b86690 | |
| parent | 2a7ed538a2c4e31c4297ee0a0c691ba92b967baf (diff) | |
| download | pyserial-git-961234d714b29032aca01ae03408e69a45a92863.tar.gz | |
docs: extend how-to section, link to old releases
| -rw-r--r-- | documentation/appendix.rst | 16 | ||||
| -rw-r--r-- | documentation/pyserial.rst | 2 | ||||
| -rw-r--r-- | documentation/url_handlers.rst | 2 |
3 files changed, 17 insertions, 3 deletions
diff --git a/documentation/appendix.rst b/documentation/appendix.rst index aff9cdd..8bc2c1a 100644 --- a/documentation/appendix.rst +++ b/documentation/appendix.rst @@ -5,10 +5,18 @@ How To ====== -Enable :rfc:`2217` in programs using pySerial. - Patch the code where the :class:`serial.Serial` is instantiated. Replace +Enable :rfc:`2217` (and other URL handlers) in programs using pySerial. + Patch the code where the :class:`serial.Serial` is instantiated. + E.g. replace:: + + s = serial.Serial(...) + it with:: + s = serial.serial_for_url(...) + + or for backwards compatibility to old pySerial installations:: + try: s = serial.serial_for_url(...) except AttributeError: @@ -33,6 +41,10 @@ Test your setup. on the screen, then at least RX and TX work (they still could be swapped though). + There is also a ``spy:://`` URL handler. It prints all calls (read/write, + control lines) to the serial port to a file or stderr. See :ref:`spy` + for details. + FAQ === diff --git a/documentation/pyserial.rst b/documentation/pyserial.rst index f063385..602134d 100644 --- a/documentation/pyserial.rst +++ b/documentation/pyserial.rst @@ -124,7 +124,7 @@ win32all). WinXP is supported up to 3.0.1. .. _`old download`: https://sourceforge.net/projects/pyserial/files/pyserial/ -.. _download: https://pypi.python.org/pypi/pyserial +.. _download: https://pypi.python.org/simple/pyserial/ .. _pywin32: http://pypi.python.org/pypi/pywin32 .. _`2.7`: https://pypi.python.org/pypi/pyserial/2.7 .. _`1.21`: https://sourceforge.net/projects/pyserial/files/pyserial/1.21/pyserial-1.21.zip/download diff --git a/documentation/url_handlers.rst b/documentation/url_handlers.rst index ae331f9..81e6ff8 100644 --- a/documentation/url_handlers.rst +++ b/documentation/url_handlers.rst @@ -122,6 +122,8 @@ Supported options in the URL are: not locked automatically (e.g. Posix). +.. _spy: + ``spy://`` ========== Wrapping the native serial port, this protocol makes it possible to |