PPK2 API Python 项目教程
1. 项目的目录结构及介绍
ppk2-api-python/
├── LICENSE
├── README.md
├── ppk2_api/
│ ├── __init__.py
│ ├── ppk2_api.py
│ └── ...
├── examples/
│ ├── basic_example.py
│ └── ...
├── tests/
│ └── ...
└── setup.py
- LICENSE: 项目许可证文件。
- README.md: 项目说明文档。
- ppk2_api/: 包含项目的主要代码文件。
- init.py: 模块初始化文件。
- ppk2_api.py: 主要API实现文件。
- examples/: 包含使用示例代码。
- basic_example.py: 基本使用示例。
- tests/: 包含测试代码。
- setup.py: 项目安装配置文件。
2. 项目的启动文件介绍
项目的启动文件通常是 examples/basic_example.py
,这是一个基本的使用示例,展示了如何使用PPK2 API进行数据读取和DUT电源切换。
from ppk2_api.ppk2_api import PPK2_API
# 初始化API实例
ppk2_test = PPK2_API("/dev/ttyACM3") # 串口路径可能不同
# 获取修改器
ppk2_test.get_modifiers()
# 设置源表模式
ppk2_test.use_source_meter()
# 设置源电压(mV)
ppk2_test.set_source_voltage(3300)
# 开始测量
ppk2_test.start_measuring()
# 读取测量值
for i in range(0, 10):
read_data = ppk2_test.get_data()
if read_data != b'':
samples = ppk2_test.get_samples(read_data)
print(f"Average of {len(samples)} samples is: {sum(samples)/len(samples)}uA")
time.sleep(1)
# 停止测量
ppk2_test.stop_measuring()
3. 项目的配置文件介绍
项目的配置文件主要是 setup.py
,它用于配置项目的安装信息。
from setuptools import setup, find_packages
setup(
name='ppk2_api',
version='0.9.2',
packages=find_packages(),
install_requires=[],
description='API for Nordic Semiconductor\'s Power Profiler Kit II (PPK 2)',
long_description=open('README.md').read(),
long_description_content_type='text/markdown',
author='IRNAS',
author_email='info@irnas.eu',
url='https://github.com/IRNAS/ppk2-api-python',
classifiers=[
'License :: OSI Approved :: GNU General Public License v2 (GPLv2)',
'Operating System :: OS Independent',
'Programming Language :: Python :: 3',
],
)
- name: 项目名称。
- version: 项目版本。
- packages: 包含的包。
- install_requires: 安装依赖。
- description: 项目描述。
- long_description: 详细描述。
- long_description_content_type: 详细描述内容类型。
- author: 作者。
- author_email: 作者邮箱。
- url: 项目主页。
- classifiers: 项目分类。