summaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
authorzsquareplusc <cliechti@gmx.net>2019-08-13 14:02:43 +0200
committerGitHub <noreply@github.com>2019-08-13 14:02:43 +0200
commit3a6ae5a630589a29af8d8bd45616d7aadb2fb3db (patch)
tree78319dc6740b1cda38bb99899f9d476d201f6d06 /documentation
parente20b773c9bc9aabd93504071ffcd30851be5a430 (diff)
parent8b24cbb6131a97a3e91aabe5299c834a75ae8964 (diff)
downloadpyserial-git-3a6ae5a630589a29af8d8bd45616d7aadb2fb3db.tar.gz
Merge pull request #411 from Flameeyes/master
Add a backend for Silicon Labs CP2110/4 HID-to-UART bridge.
Diffstat (limited to 'documentation')
-rw-r--r--documentation/url_handlers.rst18
1 files changed, 17 insertions, 1 deletions
diff --git a/documentation/url_handlers.rst b/documentation/url_handlers.rst
index 5cc1aaa..42a53fa 100644
--- a/documentation/url_handlers.rst
+++ b/documentation/url_handlers.rst
@@ -16,6 +16,7 @@ The function :func:`serial_for_url` accepts the following types of URLs:
- ``hwgrep://<regexp>[&skip_busy][&n=N]``
- ``spy://port[?option[=value][&option[=value]]]``
- ``alt://port?class=<classname>``
+- ``cp2110://<bus>:<dev>:<if>``
.. versionchanged:: 3.0 Options are specified with ``?`` and ``&`` instead of ``/``
@@ -235,6 +236,21 @@ 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`_.
+
+.. _cython-hidapi: https://github.com/trezor/cython-hidapi
+
+Examples::
+
+ cp2110://0001:004a:00
+ cp2110://0002:0077:00
+
+.. versionadded:: 3.5
Examples
========
@@ -247,5 +263,5 @@ Examples
- ``hwgrep://0451:f432`` (USB VID:PID)
- ``spy://COM54?file=log.txt``
- ``alt:///dev/ttyUSB0?class=PosixPollSerial``
-
+- ``cp2110://0001:004a:00``