Metadata-Version: 1.1
Name: pyftdi
Version: 0.13.4
Summary: FTDI device driver (pure Python)
Home-page: http://github.com/eblot/pyftdi
Author: Emmanuel Blot
Author-email: emmanuel.blot@free.fr
License: LGPL v2
Download-URL: https://github.com/eblot/pyftdi/archive/v0.13.4.tar.gz
Description: ========
         PyFtdi
        ========
        
        Overview
        ~~~~~~~~
        
        PyFtdi aims at providing a user-space driver for modern FTDI_ devices,
        implemented in pure Python language.
        
        Modern FTDI_ devices include:
        
        * FT232R (single port, clock up to 6 MHz, 3Mbps)
        * FT2232D (dual port, clock up to 6 MHz)
        * FT232H (single port, clock up to 30 MHz)
        * FT2232H (dual port, clock up to 30 MHz)
        * FT4232H (quad port, clock up to 30 MHz)
        * FT230X (single port, clock up to 48 Mhz, 3Mbps)
        
        Other FTDI_ devices could also be supported (including FT232* devices),
        although these devices are not a primary goal for PyFtdi, and therefore have
        not been tested with PyFtdi.
        
        Primary goals
        ~~~~~~~~~~~~~
        
        It should support the following modes:
        
        * UART/Serial USB converter, up to 12Mbps (depending on the FTDI device
          capability)
        * SPI master
        * JTAG master
        * Bitbang/GPIO support (not a primary goal)
        
        PyFtdi should provide a pyserial_ compliant API, to be used as a drop-in module
        to access USB-serial converters based on FTDI_ devices.
        
        .. _FTDI: http://www.ftdichip.com/
        .. _pyserial: http://pyserial.sourceforge.net/
        
        
        Requirements
        ~~~~~~~~~~~~
        
        Python_ 2.6 or above is required. Python_ 3.3+ is also supported.
        
        PyFtdi relies on PyUSB_, which itself depends on one of the following native
        libraries:
        
        * libusb-1.0 (recommended), tested with 1.0.20
        * libusb-0.1 (deprecated), tested with 0.1.4
        * openusb (not tested with pyftdi)
        
        Since PyFtdi 0.13, Six_ compatibility library is also required.
        
        Please note that versions >= 0.20 require Python_ 3.5, 0.1x series keep
        supporting Python_ 2.6+
        
        PyFtdi does not depend on any other native library, and only uses standard
        Python modules along with PyUSB_
        
        PyFTDI has been tested with PyUSB_ 1.0.0b1, 1.0.0b2 and 1.0.0rc1 and
        automatically deals with the API break introduced with PyUSB_ 1.0.0b2 (using
        the latest PyUSB_ version is nevertheless recommended)
        
        To use the serial port feature of PyFtdi, pyserial_ 2.6+ module should be
        installed. Previous versions of pyserial_ will NOT work. pyserial_ 3.0+ is also
        supported.
        
        .. _PyUSB: http://sourceforge.net/projects/pyusb/
        .. _Python: http://python.org/
        .. _Six: https://pythonhosted.org/six/
        
        
        Status
        ~~~~~~
        
        This project is still in beta development stage.
        
        However, PyFtdi is being forked from a closed-source software implementation
        that has been successfully used for over several years - including serial, spi
        and jtag protocols. PyFtdi is developed as an open-source solution.
        
        Supported features
        ------------------
        
        * All FTDI device ports (UART, MPSSE) can be used simultaneously.
        
        * 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.
        
        * SPI master. For now, SPI Mode 0 (CPOL=0, CPHA=0) is the only supported
          mode. It should be easy to extend the SPI master to deal with less common
          modes. 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.
        
        * JTAG is under development and is not fully supported yet.
        
        .. _libftdi: http://www.intra2net.com/en/developer/libftdi/
        .. _pyspiflash: https://github.com/eblot/pyspiflash
        
        Installation
        ~~~~~~~~~~~~
        * Download & install pyusb-1.0.0r1: ``pip install pyusb``
        
        * Download & install pyserial: ``pip install pyserial``
        
        * Download & install six: ``pip install six``
        
        * Install pyftdi
        
        Troubleshooting
        ---------------
        
        *"Error: No backend available"*
          libusb native library cannot be loaded. Try helping the dynamic loader:
        
          * On Linux: ``export LD_LIBRARY_PATH=<path>``
        
            where <path> is the directory containing the ``libusb-1.*.so`` library file
        
          * On OS X: ``export DYLD_LIBRARY_PATH=.../lib``
        
            where <path> is the directory containing the ``libusb-1.*.dylib`` library
            file
        
        *"Error: Access denied (insufficient permissions)"*
          The system may already be using the device.
        
          * On OS X 10.9+: starting with Mavericks, OS X ships with a native FTDI
            driver that preempts access to the FTDI device.
        
            The driver can be unloaded this way:
        
              ``sudo kextunload [-v] -bundle com.apple.driver.AppleUSBFTDI``
        
            Please note that the system automatically reloads the driver, so it may be
            useful to move the kernel extension so that the system never loads it.
        
          * This error message may also be triggered whenever the communication port is
            already in use.
        
        *"serial.serialutil.SerialException: Unable to open USB port"*
          May be caused by a conflict with the FTDI virtual COM port (VCOM). Try
          uninstalling the driver. On OS X, refer to this FTDI guide_.
        
        *Slow initialisation on OS X El Capitan*
         It may take several seconds to open or enumerate FTDI devices.
        
         If you run libusb <= v1.20.0, be sure to read the
         `issue <https://github.com/libusb/libusb/commit/5e45e0741daee4fa295c6cc977edfb986c872152>`_
         with OS X 10.11+.
        
        .. _guide: http://www.ftdichip.com/Support/Documents/AppNotes/AN_134_FTDI_Drivers_Installation_Guide_for_MAC_OSX.pdf
        
        Development
        ~~~~~~~~~~~
        
        PyFtdi is developed on Mac OS X platforms (including 64-bit kernels), and is
        validated on a regular basis on Linux hosts.
        
        As it contains no native code, it should work on any PyUSB_ and libusb_
        supported platforms. However, Ms Windows is a seamless source of issues and is
        not supported. Your mileage may vary.
        
        .. _libusb: http://www.libusb.org/
        
        Examples
        ~~~~~~~~
        
        See pyftdi/tests directory for GPIO examples.
        See pyspiflash_ module for SPI examples.
        
        .. include:: serialext/README.rst
        
Keywords: driver ftdi usb serial spi rs232 gpio bit-bang
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Hardware :: Hardware Drivers
Requires: pyusb (>= 1.0.0b1)
Requires: pyserial (>= 2.6)
Requires: six
