Hantek6022API 项目使用教程

1. 项目目录结构及介绍

Hantek6022API 项目是一个开源项目，主要用于提供 Hantek 6022BE/BL 示波器的 Python API，支持在 Linux 系统下使用。项目的目录结构如下：

• .github/: 存放 GitHub Actions 工作流文件。
• Firmware/: 包含 Hantek 6022BE/BL 的定制固件。
• PyHT6022/: 核心代码目录，包含 Python 库和模块。
• PyHT6022Tests/: 包含对 PyHT6022 模块的单元测试。
• docs/: 存放项目文档。
• examples/: 包含示例程序和脚本。
• fx2upload/: 用于固件上传的工具。
• hardware/: 包含硬件相关的文档和图片。
• sdcc_debian_old/: 旧版本 SDCC 编译器的相关文件。
• udev/: 包含 udev 规则文件，用于设置设备权限。
• .gitignore: 指定 Git 忽略的文件和目录。
• .gitmodules: 指定 Git 子模块。
• CHANGELOG: 记录项目更新和修改的历史。
• HANTEK6022_AC_Modification.pdf: 示波器 AC 修改相关的文档。
• LICENSE: 项目许可证文件。
• MANIFEST.in: 打包项目时包含的文件列表。
• MK_FW_VERSION.sh: 用于生成固件版本号的脚本。
• Makefile: 用于构建项目的 Makefile 文件。
• README.md: 项目说明文件。
• appveyor_inactive.yml: 与 Appveyor 持续集成服务相关的配置文件。
• description-pak: 项目描述文件。
• setup.cfg: Python 包设置文件。
• setup.py: Python 包安装脚本。
• stdeb.cfg: 用于生成 Debian 包的配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 examples 目录下的各种示例脚本，例如 get_serial_number.py。以下是一个简单的启动文件示例：

# 导入 PyHT6022 库中的 Oscilloscope 类
from PyHT6022.LibUsbScope import Oscilloscope

# 创建一个示波器对象
scope = Oscilloscope()

# 设置示波器
scope.setup()

# 打开设备句柄
scope.open_handle()

# 检查设备固件是否已上传
if not scope.is_device_firmware_present:
    scope.flash_firmware()

# 设置校准频率输出为 400 Hz
scope.set_calibration_frequency(400)

3. 项目的配置文件介绍

项目的配置文件主要包括 .github/workflows 目录下的 GitHub Actions 工作流文件，以及 setup.py 文件。

• GitHub Actions 工作流文件：用于自动化项目的构建、测试和打包过程。例如，build.yml 文件定义了构建和测试的步骤。
• setup.py 文件：用于定义 Python 包的安装过程，包括包的名称、版本、依赖项等信息。

例如，setup.py 文件的内容如下：

from setuptools import setup, find_packages

setup(
    name='Hantek6022API',
    version='0.1.0',
    packages=find_packages(),
    install_requires=[
        'python3-libusb1'
    ],
    entry_points={
        'console_scripts': [
            'get_serial_number = examples.get_serial_number:main'
        ]
    }
)

以上内容是 Hantek6022API 项目的使用教程，包括项目的目录结构介绍、启动文件介绍和配置文件介绍。希望对您有所帮助。