From 40d026343f2d3dcc47e9d7f2b6a784bfda6ce3f2 Mon Sep 17 00:00:00 2001 From: Emmanuel Blot Date: Tue, 19 Nov 2019 15:17:36 +0100 Subject: [PATCH] Update doc to open an Ftdi connection --- pyftdi/doc/urlscheme.rst | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/pyftdi/doc/urlscheme.rst b/pyftdi/doc/urlscheme.rst index 893cc724..26d56ff3 100644 --- a/pyftdi/doc/urlscheme.rst +++ b/pyftdi/doc/urlscheme.rst @@ -68,7 +68,8 @@ Note that if there's only one FTDI device connected to the host, the FTDI URL can be as simple as ``ftdi:///n``, where n is the FTDI port to use, starting from 1. -URL-based methods to open a connection: +URL-based methods to open a connection +...................................... .. code-block:: python @@ -76,6 +77,23 @@ URL-based methods to open a connection: open_mpsse_from_url() open_bitbang_from_url() + +Device-based method to open a connection +........................................ + +You may also open an Ftdi device from an existing PyUSB_ device, with the help +of the ``open_from_device()`` helper method. + +.. code-block:: python + + open_from_device() + open_mpsse_from_device() + open_bitbang_from_device() + + +Legacy methods to open a connection +................................... + The old, deprecated method to open a connection is to use the ``open()`` methods without the ``_from_url`` suffix, which accept VID, PID, and serial parameters (among others). @@ -86,8 +104,6 @@ parameters (among others). open_mpsse() open_bitbang() -You may also open an Ftdi device from an existing PyUSB_ device, with the help -of the ``open_from_device()`` helper method. Tools ~~~~~