summaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
authorChris Liechti <cliechti@gmx.net>2021-05-23 00:02:32 +0200
committerChris Liechti <cliechti@gmx.net>2021-05-23 00:02:32 +0200
commit9e3b4f364aa50bd62d3044ed0d5221bd42a1c1f4 (patch)
tree625b4a7f528c69c2857b7e0f14f3bcd9bf5e7605 /documentation
parentbce419352b22b2605df6c2158f3e20a15b8061cb (diff)
downloadpyserial-git-9e3b4f364aa50bd62d3044ed0d5221bd42a1c1f4.tar.gz
spy: option to write to log instead of file/stdout
Diffstat (limited to 'documentation')
-rw-r--r--documentation/url_handlers.rst11
1 files changed, 9 insertions, 2 deletions
diff --git a/documentation/url_handlers.rst b/documentation/url_handlers.rst
index 42a53fa..5c57615 100644
--- a/documentation/url_handlers.rst
+++ b/documentation/url_handlers.rst
@@ -140,6 +140,13 @@ Supported options in the URL are:
hex dump). In this mode, no control line and other commands are logged.
- ``all`` also show ``in_waiting`` and empty ``read()`` calls (hidden by
default because of high traffic).
+- ``log`` or ``log=LOGGERNAME`` output to stdlib ``logging`` module. Default
+ channel name is ``serial``. This variant outputs hex dump.
+- ``rawlog`` or ``rawlog=LOGGERNAME`` output to stdlib ``logging`` module. Default
+ channel name is ``serial``. This variant outputs text (``repr``).
+
+The ``log`` and ``rawlog`` options require that the logging is set up, in order
+to see the log output.
Example::
@@ -208,6 +215,7 @@ not interpreted by the shell::
The spy output will be live in the second terminal window.
.. versionadded:: 3.0
+.. versionchanged:: 3.6 Added ``log`` and ``rawlog`` options
``alt://``
@@ -236,9 +244,9 @@ Examples::
.. versionadded:: 3.0
+
``cp2110://``
=============
-
This backend implements support for HID-to-UART devices manufactured by Silicon
Labs and marketed as CP2110 and CP2114. The implementation is (mostly)
OS-independent and in userland. It relies on `cython-hidapi`_.
@@ -264,4 +272,3 @@ Examples
- ``spy://COM54?file=log.txt``
- ``alt:///dev/ttyUSB0?class=PosixPollSerial``
- ``cp2110://0001:004a:00``
-