Python-Periphery 开源项目教程

Python-Periphery 开源项目教程

python-peripheryA 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 库。项目的目录结构如下：

python-periphery/
├── LICENSE
├── README.md
├── periphery
│   ├── __init__.py
│   ├── gpio.py
│   ├── i2c.py
│   ├── mmio.py
│   ├── serial.py
│   ├── spi.py
│   └── tools
│       ├── gpio-int.py
│       ├── gpio-poll.py
│       ├── i2c-detect.py
│       ├── i2c-scan.py
│       ├── mmio-dump.py
│       ├── serial-loopback.py
│       ├── spi-flash.py
│       └── spi-loopback.py
├── setup.py
└── tests
    ├── test_gpio.py
    ├── test_i2c.py
    ├── test_mmio.py
    ├── test_serial.py
    └── test_spi.py

目录结构介绍

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• periphery/: 核心库文件夹，包含与各种硬件外设交互的模块。
  • __init__.py: 初始化文件。
  • gpio.py: GPIO 模块。
  • i2c.py: I2C 模块。
  • mmio.py: 内存映射 I/O 模块。
  • serial.py: 串行通信模块。
  • spi.py: SPI 模块。
  • tools/: 工具脚本，用于测试和演示各种外设功能。
• setup.py: 安装脚本。
• tests/: 测试脚本，用于测试各个模块的功能。

2. 项目的启动文件介绍

Python-Periphery 项目的启动文件主要是 setup.py，它负责项目的安装和分发。用户可以通过以下命令安装该库：

pip install .

setup.py 文件介绍

setup.py 是一个标准的 Python 安装脚本，它使用 setuptools 来定义项目的元数据和依赖关系。以下是 setup.py 的主要内容：

from setuptools import setup, find_packages

setup(
    name="python-periphery",
    version="2.3.0",
    description="A Python library for interfacing with Linux peripherals",
    long_description=open("README.md").read(),
    long_description_content_type="text/markdown",
    author="Vanya Sergeev",
    author_email="vsergeev@gmail.com",
    url="https://github.com/vsergeev/python-periphery",
    packages=find_packages(),
    classifiers=[
        "Development Status :: 5 - Production/Stable",
        "Intended Audience :: Developers",
        "License :: OSI Approved :: MIT License",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.6",
        "Programming Language :: Python :: 3.7",
        "Programming Language :: Python :: 3.8",
        "Programming Language :: Python :: 3.9",
    ],
    python_requires='>=3.6',
    install_requires=[],
    extras_require={},
    package_data={},
    data_files=[],
    entry_points={},
)

3. 项目的配置文件介绍

Python-Periphery 项目本身没有特定的配置文件，因为它主要通过代码直接与硬件外设交互。用户在使用各个模块时，通常需要根据具体的硬件设备和接口进行配置。

示例配置

以下是一个使用 GPIO 模块的简单示例：

from periphery import GPIO

# 打开 GPIO 引脚
gpio = GPIO(123, "out")

# 设置 GPIO 引脚输出高电平
gpio.write(True)

# 关闭 GPIO 引脚
gpio.close()

在这个示例中，用户需要根据具体的硬件设备和引脚编号进行配置。其他模块如 I2C、SPI、串行通信等也类似，需要根据具体的硬件

python-peripheryA 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