A MicroPython NMEA parser wrapper suitable for MIA-M10Q GNSS UART output — MicroPython 异步驱动
实验性异步版本:尚未完成实物验收。
同步来源:同步版本。维护者说明同步版本已验证;本次未逐包复测同步来源,适用硬件和固件范围以原有记录为准。
异步版本:本包 Python 源码及示例已通过 MicroPython 1.23 / 1.29 编译检查;软件回归只覆盖选定路径,不代表本包全部 API、实际器件及并发行为已验证。
目录
- 简介
- 主要功能
- 硬件要求
- 软件环境
- 文件结构
- 文件说明
- 快速开始
- 异步设计与使用
- API Async Matrix
- Source Demo to Async Demo Mapping
- 超时、取消、并发与残余阻塞
- Hardware Acceptance
- 注意事项
- 版本记录
- 联系方式
- 许可协议
简介
mia_m10q_async_driver 是当前仓库中独立发布的 MicroPython 异步包。设备/功能名称和 API 均来自包内运行时文件;它不是对同步 API 的无依据重命名。源包:sensors/mia_m10q_driver。
主要功能
- 可解析的公开类:
MicropyGPS,MicropyGPSAsync,SyncAdapterMixin。 - 可解析的公开调用入口:100 个(详见 API 矩阵)。
- 异步等级:
cooperative_nonblocking;依据:等待阶段使用协程让出;底层总线调用仍同步。
硬件要求
| 项目 | 从代码取得的事实 |
|---|---|
| 通信/IO | UART, Pin( |
| 示例 GPIO | 示例未声明固定 GPIO 编号 |
| 供电、地址与电平 | 仅按模块实物标签、数据手册及代码常量配置;。 |
软件环境
| 项目 | 值 |
|---|---|
| 运行时 | MicroPython + uasyncio |
| 包版本 | 1.0.0 |
| 作者 | inmcm, FreakStudio |
| 依赖 | 无声明的第三方依赖 |
文件结构
├── code/__pycache__/main.cpython-313.pyc
├── code/__pycache__/mia_m10q.cpython-313.pyc
├── code/main.py
├── code/mia_m10q.py
├── code/mia_m10q_async.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/07/19 00:00
# @Author : FreakStudio
# @File : main.py
# @Description : 测试 MIA-M10Q NMEA GPS 驱动类的代码
# @License : MIT
# ======================================== 导入相关模块 =========================================
from machine import Pin, UART
from mia_m10q import MicropyGPS
# ======================================== 全局变量 ============================================
# UART 接收超时时间(毫秒)
# UART receive timeout in milliseconds
_UART_TIMEOUT_MS = 5000
# 循环读取间隔(毫秒)
# Loop read interval in milliseconds
_LOOP_INTERVAL_MS = 1000
# ======================================== 功能函数 ============================================
# ======================================== 自定义类 ============================================
# ======================================== 初始化配置 ==========================================
# UART 硬件引脚定义
UART_ID = 1
TX_PIN = 17
RX_PIN = 16
BAUDRATE = 9600
# 上电稳定延时
await asyncio.sleep(3)
print("FreakStudio: MIA-M10Q NMEA GPS driver test starting...")
# 初始化 UART 总线
uart = UART(UART_ID, baudrate=BAUDRATE, tx=Pin(TX_PIN), rx=Pin(RX_PIN))
# 创建 GPS 解析器实例
device = None
# ======================================== 主程序 ===========================================
try:
# 创建 NMEA 解析器实例(北京时区 UTC+8)
# Create NMEA parser instance (UTC+8 Beijing time)
device = MicropyGPS(local_offset=8)
print("Waiting for NMEA data from MIA-M10Q...")
# 启动时刻(用于超时判断)
gps_start_time = time.ticks_ms()
while True:
# 检查 UART 缓冲区是否有可用数据
# Check if UART buffer has available data
if uart.any():
data = uart.read()
if data:
for byte in data:
# 逐字符输入 GPS 解析器
# Feed characters to GPS parser one at a time
result = device.update(chr(byte))
if result is not None:
print("Parsed sentence: %s" % result)
# 数据接收后重置超时计时
# Reset timeout timer on data receipt
gps_start_time = time.ticks_ms()
# 输出当前 GPS 信息
# Output current GPS information
print(
"Lat: %s Lon: %s Speed: %s Satellites: %d"
% (device.latitude_string(), device.longitude_string(), device.speed_string("kph"), device.satellites_in_use)
)
# UART 超时检查
# UART timeout check
if time.ticks_diff(time.ticks_ms(), gps_start_time) > _UART_TIMEOUT_MS:
if not device.valid:
print("Warning: No valid NMEA data received within %d ms" % _UART_TIMEOUT_MS)
await asyncio.sleep_ms(_LOOP_INTERVAL_MS)
except KeyboardInterrupt:
print("Test stopped by user")
except Exception as e:
print("MIA-M10Q test error:", e)
finally:
if device is not None:
device.deinit()
print("GPS parser deinitialized")
device = None
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 |
|---|---|---|---|---|
MicropyGPS.compass_direction |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.date_string |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.deinit |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.gpgga |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.gpgll |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.gpgsa |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.gpgsv |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.gprmc |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.gpvtg |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.latitude |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.latitude_string |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.longitude |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.longitude_string |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.new_fix_time |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.new_sentence |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.satellite_data_updated |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.satellites_visible |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.speed_string |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.start_logging |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.stop_logging |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.time_since_fix |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.unset_satellite_data_updated |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.update |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPS.write_log |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.compass_direction_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.date_string_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.deinit_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.gpgga_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.gpgll_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.gpgsa_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.gpgsv_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.gprmc_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.gpvtg_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.latitude_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.latitude_string_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.longitude_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.longitude_string_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.new_fix_time_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.new_sentence_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.satellite_data_updated_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.satellites_visible_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.speed_string_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.start_logging_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.stop_logging_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.time_since_fix_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.unset_satellite_data_updated_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.update_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
MicropyGPSAsync.write_log_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
SyncAdapterMixin.aclose |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
aclose |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
compass_direction |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
compass_direction_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
const |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
date_string |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
date_string_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
deinit |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
deinit_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
gpgga |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
gpgga_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
gpgll |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
gpgll_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
gpgsa |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
gpgsa_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
gpgsv |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
gpgsv_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
gprmc |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
gprmc_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
gpvtg |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
gpvtg_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
latitude |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
latitude_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
latitude_string |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
latitude_string_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
longitude |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
longitude_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
longitude_string |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
longitude_string_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
main |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
new_fix_time |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
new_fix_time_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
new_sentence |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
new_sentence_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
satellite_data_updated |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
satellite_data_updated_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
satellites_visible |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
satellites_visible_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
speed_string |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
speed_string_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
start_logging |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
start_logging_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
stop_logging |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
stop_logging_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
time_since_fix |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
time_since_fix_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
unset_satellite_data_updated |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
unset_satellite_data_updated_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
update |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
update_async |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
write_log |
cooperative_nonblocking |
等待阶段使用协程让出;底层总线调用仍同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
write_log_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、静默间隔及错误含义只以当前实现和源示例可证明的内容为准。
UART Concurrency Contract
Model: caller-owned Reader owner: 调用方协程;不得让多个协程同时读取同一 UART。 Frame and unsolicited-data policy: 仅按当前运行时已有帧解析规则处理;未定义的非请求数据不得静默丢弃。
Hardware Acceptance
| Level | Evidence | Not covered |
|---|---|---|
| Link | 未实测:仅完成静态代码与文档取证。 | 总线/网络连接、设备身份响应。 |
| Basic function | 未实测。 | 一次真实业务 API 成功及结果正确性。 |
| Complete business flow | 未实测。 | 端到端设备、对端、供电、时序和异常恢复。 |
注意事项
| 类别 | 说明 |
|---|---|
| 并发 | 同一硬件实例应由调用方串行化;UART 额外遵守其并发契约。 |
| 阻塞 | 不把短同步总线访问或严格时序脉冲描述为真正可中断。 |
| 验收 | 文档生成不等于硬件验证;接入真实设备后分别记录三层验收证据。 |
版本记录
| 版本号 | 日期 | 作者 | 修改说明 |
|---|---|---|---|
1.0.0 |
2026-09-17 | inmcm, FreakStudio | 基于当前异步代码、来源包和许可证重新取证 README。 |
联系方式
请通过本仓库的 issue 或维护者渠道联系;包内元数据作者为:inmcm, FreakStudio。
许可协议
许可证声明:MIT。以下为本包 LICENSE 的逐字内容:
MIT License
Copyright (c) 2017 Calvin McCoy
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.