Skip to content

Commit

Permalink
Update doc to open an Ftdi connection
Browse files Browse the repository at this point in the history
  • Loading branch information
eblot committed Nov 19, 2019
1 parent 39a179c commit 40d0263
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions pyftdi/doc/urlscheme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,32 @@ 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
open_from_url()
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).
Expand All @@ -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
~~~~~
Expand Down

0 comments on commit 40d0263

Please sign in to comment.