Skip to content
Permalink
Browse files

Add a link to the generated documentation

  • Loading branch information...
eblot committed Jul 26, 2017
1 parent 945299d commit dd326e48fcc2cd9f1bb95f7a30133a4e8d8f0038
Showing with 50 additions and 25 deletions.
  1. +6 −0 README.rst
  2. +44 −25 pyftdi/doc/features.rst
@@ -41,3 +41,9 @@ PyFtdi currently supports the following features:

PyFtdi provides a pyserial compliant API, so it can be used as a drop-in
module to access USB-serial converters based on FTDI devices.


Documentation
-------------

PyFtdi documentation is available from http://eblot.github.io/pyftdi/
@@ -1,7 +1,10 @@
.. include:: defs.rst

Supported features
------------------
Features
--------

Devices
~~~~~~~

* All FTDI device ports (UART, MPSSE) can be used simultaneously.

@@ -11,37 +14,53 @@ Supported features
* Several FTDI adapters can be accessed simultaneously from the same Python
runtime instance.

* Serial port, up to 12 Mbps. PyFtdi_ includes a pyserial_ emulation layer that
offers transparent access to the FTDI serial ports through a pyserial_-
compliant API. The ``serialext`` directory contains a minimal serial terminal
demonstrating the use of this extension, and a dispatcher automatically
selecting the serial backend (pyserial_, PyFtdi_), based on the serial port
name.
Supported features
~~~~~~~~~~~~~~~~~~

UART
....

Serial port, up to 12 Mbps. PyFtdi_ includes a pyserial_ emulation layer that
offers transparent access to the FTDI serial ports through a pyserial_-
compliant API. The ``serialext`` directory contains a minimal serial terminal
demonstrating the use of this extension, and a dispatcher automatically
selecting the serial backend (pyserial_, PyFtdi_), based on the serial port
name.


SPI master
..........

Supported devices:

===== ===== ====== ====================================================
Mode CPol CPha Status
===== ===== ====== ====================================================
0 0 0 Supported on all MPSEE devices
1 0 1 Supported on -H series (FT232H_/FT2232H_/FT4232H_)
2 1 0 Not supported (FTDI HW limitation)
3 1 1 Supported on -H series (FT232H_/FT2232H_/FT4232H_)
===== ===== ====== ====================================================

PyFtdi_ can be used with pyspiflash_ module that demonstrates how to
use the FTDI SPI master with a pure-Python serial flash device driver for
several common devices.

* SPI master.
Only half-duplex communication is supported for now.

Supported devices:

===== ===== ====== ====================================================
Mode CPol CPha Status
===== ===== ====== ====================================================
0 0 0 Supported on all MPSEE devices
1 0 1 Supported on -H series (FT232H_/FT2232H_/FT4232H_)
2 1 0 Not supported (FTDI HW limitation)
3 1 1 Supported on -H series (FT232H_/FT2232H_/FT4232H_)
===== ===== ====== ====================================================
|I2C| master
............

PyFtdi_ can be used with pyspiflash_ module that demonstrates how to
use the FTDI SPI master with a pure-Python serial flash device driver for
several common devices.
Supported devices: FT232H_, FT2232H_, FT4232H_

Only half-duplex communication is supported for now.
For now, only 7-bit address are supported.

* |I2C| master. For now, only 7-bit address are supported.

Supported devices: FT232H_, FT2232H_, FT4232H_
JTAG
....

* JTAG is under development and is not fully supported yet.
JTAG is under development and is not fully supported yet.

Status
~~~~~~

0 comments on commit dd326e4

Please sign in to comment.
You can’t perform that action at this time.