PyFtdi 技术文档

1. 安装指南

1.1 系统要求

PyFtdi 需要 Python 3.8 或更高版本。支持的操作系统包括 macOS、Linux、FreeBSD 和 Windows（尽管 Windows 并未正式支持）。

1.2 安装步骤

你可以通过 pip 来安装 PyFtdi。打开终端并运行以下命令：

pip install pyftdi

1.3 依赖项

PyFtdi 依赖于以下 Python 包：

• pyusb
• pyserial

这些依赖项通常会在安装 PyFtdi 时自动安装。如果遇到问题，可以手动安装这些依赖项：

pip install pyusb pyserial

2. 项目的使用说明

2.1 概述

PyFtdi 是一个用纯 Python 编写的用户空间驱动程序，旨在支持流行的 FTDI 设备。它支持多种 FTDI 设备，包括 UART、GPIO、SPI、I2C 和 JTAG 桥接器。

2.2 支持的设备

PyFtdi 支持以下 FTDI 设备：

• UART 和 GPIO 桥接器：
  • FT232R（单端口，3Mbps）
  • FT230X/FT231X/FT234X（单端口，3Mbps）
• UART、GPIO 和多串行协议（SPI、I2C、JTAG）桥接器：
  • FT2232C/D（双端口，时钟高达 6 MHz）
  • FT232H（单端口，时钟高达 30 MHz）
  • FT2232H（双端口，时钟高达 30 MHz）
  • FT4232H（四端口，时钟高达 30 MHz）
  • FT4232HA（四端口，时钟高达 30 MHz）

2.3 功能

PyFtdi 目前支持以下功能：

• UART/串行 USB 转换器：最高可达 12Mbps（取决于 FTDI 设备的能力）。
• GPIO/位操作支持：支持 8 位异步、8 位同步和 8/16 位 MPSSE 变体。
• SPI 主控：支持同时 GPIO 操作，每个端口最多 12 个引脚，支持非字节大小的传输。
• I2C 主控：支持同时 GPIO 操作，每个端口最多 14 个引脚。
• 基本 JTAG 主控功能。
• EEPROM 支持：部分参数可以修改，但目前仅支持读取。
• 实验性 CBUS 支持：在选定设备上支持 4 个引脚。

3. 项目 API 使用文档

3.1 导入模块

首先，你需要导入 PyFtdi 模块：

from pyftdi.ftdi import Ftdi

3.2 初始化设备

使用 Ftdi.create_from_url() 方法来初始化设备：

ftdi = Ftdi.create_from_url('ftdi://ftdi:232h/1')

3.3 使用 UART

你可以使用 open_uart() 方法来打开 UART 端口：

ftdi.open_uart(baudrate=115200)

3.4 使用 GPIO

使用 open_gpio() 方法来打开 GPIO 端口：

ftdi.open_gpio()

3.5 使用 SPI

使用 open_spi() 方法来打开 SPI 端口：

ftdi.open_spi(cs=0)

3.6 使用 I2C

使用 open_i2c() 方法来打开 I2C 端口：

ftdi.open_i2c(frequency=100000)

4. 项目安装方式

4.1 通过 pip 安装

最简单的安装方式是通过 pip：

pip install pyftdi

4.2 从源码安装

你也可以从 GitHub 下载源码并手动安装：

git clone https://github.com/eblot/pyftdi.git
cd pyftdi
python setup.py install

4.3 验证安装

安装完成后，你可以通过以下命令验证安装是否成功：

python -c "import pyftdi; print(pyftdi.__version__)"

如果输出了版本号，说明安装成功。

---

通过以上文档，你应该能够顺利安装和使用 PyFtdi 项目。如果在使用过程中遇到任何问题，可以参考官方文档或提交 GitHub 问题。