Python-Periphery 开源项目教程

Python-Periphery 开源项目教程

python-periphery A pure Python 2/3 library for peripheral I/O (GPIO, LED, PWM, SPI, I2C, MMIO, Serial) in Linux. 项目地址: https://gitcode.com/gh_mirrors/py/python-periphery

1. 项目目录结构及介绍

Python-Periphery 是一个纯 Python 库，专为在Linux系统中进行外设输入输出操作设计，支持包括GPIO、LED、PWM、SPI、I2C、MMIO和Serial等接口。下面是对项目主要目录结构的解析：

• 根目录
  • docs: 包含项目的文档资料，用于本地构建和查看详细使用指南。
  • periphery: 源代码主体，实现了所有对外设的操作接口。
  • tests: 测试套件，用于验证库的功能性和正确性。
  • flake8, flake8 yapf, .gitignore, LICENSE, README.md, setup.cfg, setup.py: 标准的项目管理文件，如代码规范检查、忽略列表、许可证、项目描述、配置文件以及安装脚本。
  • github/workflows: GitHub Actions的工作流配置文件，自动化构建或测试流程。
  • readthedocs.yml: ReadTheDocs的配置文件，用于自动构建在线文档。

2. 项目启动文件介绍

虽然Python-Periphery不是一个运行服务或应用的项目，其“启动”更多指的是引入库到你的Python程序中并开始调用相关API。因此，重要的是你的应用程序如何“启动”使用这个库。通常，你可以在你的Python脚本顶部通过导入模块来“启动”：

import periphery

之后，你可以利用periphery中的类（如GPIO, LED, PWM, 等）来直接进行设备交互。

3. 项目的配置文件介绍

Python-Periphery本身并不依赖于特定的外部配置文件来运行。它的配置主要通过代码内部实现，比如设置GPIO的方向、SPI的速度等，都是在使用相应功能时直接在代码中指定的。然而，在实际的应用场景下，开发者可能会选择创建自己的配置文件（如.ini或.yaml），来存储外设的路径、初始状态等信息，以便于管理和复用配置。这些配置文件并不是项目自带的一部分，而是依据个人或项目需求自定义实现的。

例如，一个简单的配置示例可能如下所示（但这不是项目内置的）:

[gpio]
pin_1_path=/dev/gpiochip0
pin_1_mode=out

[spi_device]
device_path=/dev/spidev1.0
mode=0
speed_hz=1000000

然后在代码中读取这些配置来初始化外设。

总结，Python-Periphery的核心在于简洁的API调用而非复杂的配置管理，确保了对Linux外设操作的高效和便捷。

python-periphery A pure Python 2/3 library for peripheral I/O (GPIO, LED, PWM, SPI, I2C, MMIO, Serial) in Linux. 项目地址: https://gitcode.com/gh_mirrors/py/python-periphery