diff options
| author | Diego Elio Pettenò <flameeyes@flameeyes.com> | 2019-02-08 12:02:34 +0000 |
|---|---|---|
| committer | Diego Elio Pettenò <flameeyes@flameeyes.com> | 2019-02-08 12:18:53 +0000 |
| commit | 8b24cbb6131a97a3e91aabe5299c834a75ae8964 (patch) | |
| tree | 826d89bb2900c4fcf9356e2523a92b7999c845c8 /documentation | |
| parent | a27715f322bb08b1fccffebab776c94df50057e9 (diff) | |
| download | pyserial-git-8b24cbb6131a97a3e91aabe5299c834a75ae8964.tar.gz | |
Add a backend for Silicon Labs CP2110/4 HID-to-UART bridge.
These two chips implement UART access via a HID protocol, which can be
implemented purely in user space. The protocol is documented by Silicon
Labs AN434:
https://www.silabs.com/documents/public/application-notes/AN434-CP2110-4-Interface-Specification.pdf
The backend is implemented based on cython-hidapi
(https://github.com/trezor/cython-hidapi), making it OS-independent, if a
bit awkward.
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/url_handlers.rst | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/documentation/url_handlers.rst b/documentation/url_handlers.rst index b4f0da7..f8b1698 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`` |