Async conversion of gp2y0e03_driver — MicroPython 异步驱动
实验性异步版本:尚未完成实物验收。
同步来源:同步版本。维护者说明同步版本已验证;本次未逐包复测同步来源,适用硬件和固件范围以原有记录为准。
异步版本:本包 Python 源码及示例已通过 MicroPython 1.23 / 1.29 编译检查;软件回归只覆盖选定路径,不代表本包全部 API、实际器件及并发行为已验证。
目录
- 简介
- 主要功能
- 硬件要求
- 软件环境
- 文件结构
- 文件说明
- 快速开始
- 异步设计与使用
- API Async Matrix
- Source Demo to Async Demo Mapping
- 超时、取消、并发与残余阻塞
- Hardware Acceptance
- 注意事项
- 版本记录
- 联系方式
- 许可协议
简介
gp2y0e03_async_driver 是当前仓库中独立发布的 MicroPython 异步包。设备/功能名称和 API 均来自包内运行时文件;它不是对同步 API 的无依据重命名。源包:sensors/gp2y0e03_driver。
主要功能
- 可解析的公开类:
GP2Y0E03,GP2Y0E03Async。 - 可解析的公开调用入口:20 个(详见 API 矩阵)。
- 异步等级:
cooperative_nonblocking;依据:等待阶段使用协程让出;底层总线调用仍同步。
硬件要求
| 项目 | 从代码取得的事实 |
|---|---|
| 通信/IO | I2C, Pin( |
| 示例 GPIO | 示例未声明固定 GPIO 编号 |
| 供电、地址与电平 | 仅按模块实物标签、数据手册及代码常量配置;。 |
软件环境
| 项目 | 值 |
|---|---|
| 运行时 | MicroPython + uasyncio |
| 包版本 | 1.0.0 |
| 作者 | FreakStudio |
| 依赖 | 无声明的第三方依赖 |
文件结构
├── code/__pycache__/gp2y0e03.cpython-313.pyc
├── code/__pycache__/main.cpython-313.pyc
├── code/gp2y0e03.py
├── code/gp2y0e03_async.py
├── code/main.py
├── examples/main_sync.py
├── LICENSE
└── package.json
文件说明
code/:实际发布的运行时 Python 模块;以package.json.urls为安装映射依据。code/main.py(若存在):异步演示入口,不是默认发布运行时映射。examples/(若存在):同步保真基线或额外示例,不应当作安装后的运行时模块。package.json、LICENSE:发布元数据和许可证的唯一事实来源。
快速开始
- 按
package.json.urls将运行时文件复制到设备;不要把examples/当作运行时依赖。 - 按上文硬件/运行环境配置总线、GPIO、网络或凭证。
- 使用包内真实
code/main.py的 import 与构造方式运行。以下是当前文件逐字读取的异步入口;部署时请保留try/finally并调用对象实际提供的deinit()或aclose()。
try:
import uasyncio as asyncio
except ImportError:
import asyncio
async def main():
# Python env : MicroPython v1.23.0
# -*- coding: utf-8 -*-
# @Time : 2026/04/22 14:15
# @Author : FreakStudio
# @File : main.py
# @Description : 测试 GP2Y0E03 数字红外测距传感器驱动的代码
# @License : MIT
# ======================================== 导入相关模块 =========================================
# 导入 MicroPython 硬件 I2C 与引脚控制模块
from machine import I2C, Pin
# 导入 GP2Y0E03 传感器驱动类
from gp2y0e03 import GP2Y0E03
# 导入时间控制模块
# ======================================== 全局变量 ============================================
# I2C 总线编号
i2c_id = 0
# I2C 数据引脚编号
i2c_sda_pin = 4
# I2C 时钟引脚编号
i2c_scl_pin = 5
# I2C 通信频率(Hz)
i2c_freq = 100000
# GP2Y0E03 默认 I2C 地址
gp2y0e03_addr = 0x40
# 数据打印间隔时间(毫秒)
print_interval = 500
# 上次打印时间戳(毫秒)
last_print_time = 0
# ======================================== 功能函数 ============================================
# ======================================== 自定义类 ============================================
# ======================================== 初始化配置 ==========================================
# 等待系统和传感器上电稳定
await asyncio.sleep(3)
# 打印程序功能提示
print("FreakStudio: Testing GP2Y0E03 distance sensor driver")
# 初始化硬件 I2C 总线
i2c = I2C(
i2c_id,
sda=Pin(i2c_sda_pin),
scl=Pin(i2c_scl_pin),
freq=i2c_freq,
)
# 扫描 I2C 总线设备
devices = i2c.scan()
# 检查扫描结果是否为空
if not devices:
raise RuntimeError("No I2C devices found on bus")
# 打印 I2C 设备扫描结果
print("I2C devices found: %s" % [hex(addr) for addr in devices])
# 检查 GP2Y0E03 是否在 I2C 总线上
if gp2y0e03_addr not in devices:
raise RuntimeError("GP2Y0E03 not found at address 0x%02X" % gp2y0e03_addr)
# 打印 GP2Y0E03 地址确认
print("GP2Y0E03 found at address: 0x%02X" % gp2y0e03_addr)
# 创建 GP2Y0E03 传感器对象
sensor = GP2Y0E03(i2c, address=gp2y0e03_addr)
# 打印当前距离量程移位值
print("Shift: %d" % sensor._shift)
# ======================================== 主程序 ===========================================
try:
while True:
await asyncio.sleep_ms(0)
# 获取当前时间戳
current_time = time.ticks_ms()
# 检查是否到达打印间隔
if time.ticks_diff(current_time, last_print_time) >= print_interval:
# 读取原始距离值
raw = sensor.read(raw=True)
# 读取厘米距离值
distance = sensor.read()
# 打印测量结果
print("Raw: %d, Distance: %.2f cm" % (raw, distance))
# 更新上次打印时间
last_print_time = current_time
# 短暂延时避免 CPU 占用过高
await asyncio.sleep_ms(10)
except KeyboardInterrupt:
print("Program interrupted by user")
except OSError as e:
print("Hardware communication error: %s" % str(e))
except Exception as e:
print("Unknown error: %s" % str(e))
finally:
print("Cleaning up resources...")
# 释放传感器对象
del sensor
# 释放 I2C 对象
del i2c
print("Program exited")
if __name__ == '__main__':
asyncio.run(main())
异步设计与使用
源状态:sync_source。本包归属当前异步仓库;原始实现的作者和许可证以源包元数据及 LICENSE 为准。协程入口应以 asyncio.run(main()) 启动。若类提供 start()/stop()、deinit() 或 aclose(),必须按其实际签名管理后台任务和资源,且在 finally 中清理。
API Async Matrix
| API | Level | Async strategy | Residual blocking | Timeout/cancellation |
|---|---|---|---|---|
GP2Y0E03.read |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
GP2Y0E03.read_raw |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
GP2Y0E03.shift |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
GP2Y0E03Async.aclose |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
GP2Y0E03Async.call_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
GP2Y0E03Async.const_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
GP2Y0E03Async.read_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
GP2Y0E03Async.read_raw_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
GP2Y0E03Async.shift_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
aclose |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
call_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
const |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
const_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
main |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
read |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
read_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
read_raw |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
read_raw_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
shift |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
shift_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
Source Demo to Async Demo Mapping
| Source sync step | Source API/protocol action | Async implementation | Preserved output/error meaning | Residual blocking |
|---|---|---|---|---|
| 源包示例 | code/main.py |
code/main.py 或本文快速开始 |
保留实际构造与调用;异常语义以运行时代码为准 | 存在 |
超时、取消、并发与残余阻塞
任何 await 不会自动使底层 I2C/SPI/UART/Pin 操作变为非阻塞。取消时应停止后台任务并在 finally 释放资源;没有实现超时参数的 API 不应被假定具有超时。协议命令、帧界限、ACK、静默间隔及错误含义只以当前实现和源示例可证明的内容为准。
Hardware Acceptance
| Level | Evidence | Not covered |
|---|---|---|
| Link | 未实测:仅完成静态代码与文档取证。 | 总线/网络连接、设备身份响应。 |
| Basic function | 未实测。 | 一次真实业务 API 成功及结果正确性。 |
| Complete business flow | 未实测。 | 端到端设备、对端、供电、时序和异常恢复。 |
注意事项
| 类别 | 说明 |
|---|---|
| 并发 | 同一硬件实例应由调用方串行化;UART 额外遵守其并发契约。 |
| 阻塞 | 不把短同步总线访问或严格时序脉冲描述为真正可中断。 |
| 验收 | 文档生成不等于硬件验证;接入真实设备后分别记录三层验收证据。 |
版本记录
| 版本号 | 日期 | 作者 | 修改说明 |
|---|---|---|---|
1.0.0 |
2026-09-17 | FreakStudio | 基于当前异步代码、来源包和许可证重新取证 README。 |
联系方式
请通过本仓库的 issue 或维护者渠道联系;包内元数据作者为:FreakStudio。
许可协议
许可证声明:MIT。以下为本包 LICENSE 的逐字内容:
MIT License
Copyright (c) 2026 FreakStudio
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.