A MicroPython library to control ADS1115 sensors — MicroPython 异步驱动
实验性异步版本:尚未完成实物验收。
同步来源:同步版本。维护者说明同步版本已验证;本次未逐包复测同步来源,适用硬件和固件范围以原有记录为准。
异步版本:本包 Python 源码及示例已通过 MicroPython 1.23 / 1.29 编译检查;软件回归只覆盖选定路径,不代表本包全部 API、实际器件及并发行为已验证。
目录
- 简介
- 主要功能
- 硬件要求
- 软件环境
- 文件结构
- 文件说明
- 快速开始
- 异步设计与使用
- API Async Matrix
- Source Demo to Async Demo Mapping
- 超时、取消、并发与残余阻塞
- Hardware Acceptance
- 注意事项
- 版本记录
- 联系方式
- 许可协议
简介
ads1115_async_driver 是当前仓库中独立发布的 MicroPython 异步包。设备/功能名称和 API 均来自包内运行时文件;它不是对同步 API 的无依据重命名。源包:signal_acquisition/ads1115_driver。
主要功能
- 可解析的公开类:
ADS1115,ADS1115Async,SyncAdapterMixin。 - 可解析的公开调用入口:34 个(详见 API 矩阵)。
- 异步等级:
event_bridge;依据:IRQ/事件通知由协程消费;总线访问仍可能同步。
硬件要求
| 项目 | 从代码取得的事实 |
|---|---|
| 通信/IO | I2C, UART, Pin( |
| 示例 GPIO | 4、5 |
| 供电、地址与电平 | 仅按模块实物标签、数据手册及代码常量配置;。 |
软件环境
| 项目 | 值 |
|---|---|
| 运行时 | MicroPython + uasyncio |
| 包版本 | 1.0.0 |
| 作者 | leeqingshui |
| 依赖 | 无声明的第三方依赖 |
文件结构
├── code/_gs_ads1115_ads1115.py
├── code/ads1115_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 : 2024/10/7 下午2:21
# @Author : 李清水
# @File : main.py
# @Description : ADC类实验,使用ADS1115外置ADC芯片采集数据,定时器触发采集
# ======================================== 导入相关模块 ========================================
# 导入硬件相关模块
from machine import Pin, I2C, Timer, UART
# 导入时间相关模块
# 导入外部ADC相关模块
from _gs_ads1115_ads1115 import ADS1115
# 导入二进制数据和原生数据类型打包解包模块
import struct
# ======================================== 全局变量 ============================================
# 外置ADC地址
ADC_ADDRESS = 0
# 旋转电位器连接的通道:AIN0
POT_CHANNEL = 0
# 滑动均值滤波器相关变量
FILTER_SIZE = 20
filter_buffer = []
filter_sum = 0
# ======================================== 功能函数 ============================================
# 定义定时器回调函数
def timer_callback(timer):
"""
定时器回调函数,用于定时采样
Args:
timer (machine.Timer): 定时器对象。
Returns:
None
==========================================
Timer callback function for periodic sampling.
Args:
timer (machine.Timer): Timer object.
Returns:
None
"""
# 声明全局变量
global adc, POT_CHANNEL, FILTER_SIZE
# 采集数据
try:
# 设置当前转换速率和通道
adc.set_conv(rate=7, channel1=POT_CHANNEL)
# 读取采样数据并启动下一次转换
raw_adc = adc.read_rev()
# 将原始值转换为电压
voltage = adc.raw_to_v(raw_adc)
# 打印采样数据
print(f"Channel AIN{POT_CHANNEL}: {voltage:.4f} V (Raw: {raw_adc})")
# 将原始ADC值存储为int16
adc_value = int(raw_adc)
# 使用独立的滑动均值滤波器函数
average = moving_average_filter(adc_value, FILTER_SIZE)
# 构建并发送数据帧,传递原始值和滤波值
send_data_frames(raw_adc, average)
except Exception as e:
print("Error in timer_callback:", e)
# 串口数据帧打包函数
def send_data_frames(raw_adc, average):
"""
串口发送数据函数,发送原始ADC值和滤波后的平均值
Args:
raw_adc (int): 原始ADC采集的值。
average (int): 滤波后的平均值。
Returns:
None
==========================================
UART data transmission function, sends raw ADC value and filtered average value.
Args:
raw_adc (int): Raw ADC collected value.
average (int): Filtered average value.
Returns:
None
"""
global uart
try:
# 构建数据帧
# 帧头为0xAA 0xBB,后面是两个16位数据,使用小端模式
frame_header = struct.pack("<2B", 0xAA, 0xBB)
frame_data = struct.pack("<2H", raw_adc & 0xFFFF, average & 0xFFFF)
frame_full = frame_header + frame_data
# 发送数据帧
uart.write(frame_full)
except Exception as e:
print("Error in send_data_frames:", e)
# 滑动均值滤波函数
def moving_average_filter(new_value, filter_size):
"""
Args:
new_value (int): 新采样值。
filter_size (int): 滤波器窗口大小。
Returns:
int: 当前滑动均值。
==========================================
Moving average filter.
Args:
new_value (int): New sampling value.
filter_size (int): Filter window size.
Returns:
int: Current moving average.
"""
# 声明全局变量
global filter_buffer, filter_sum
# 将新值加入缓冲区
filter_buffer.append(new_value)
filter_sum += new_value
# 如果缓冲区超过滤波器大小,移除最旧的值
if len(filter_buffer) > filter_size:
removed = filter_buffer.pop(0)
filter_sum -= removed
# 计算并返回滑动平均值
return filter_sum // len(filter_buffer)
# ======================================== 自定义类 ============================================
# ======================================== 初始化配置 ==========================================
# 上电延时3s
await asyncio.sleep(3)
# 打印调试消息
print("FreakStudio: Using ADS1115 acquire signal")
# 创建串口对象,设置波特率为256000
uart = UART(0, 256000)
# 初始化uart对象,波特率为256000,数据位为8,无校验位,停止位为1
# 设置接收引脚为GPIO1,发送引脚为GPIO0
# 设置串口超时时间为100ms
uart.init(baudrate=256000, bits=8, parity=None, stop=1, tx=0, rx=1, timeout=100)
# 创建硬件I2C的实例,使用I2C0外设,时钟频率为400KHz,SDA引脚为4,SCL引脚为5
i2c = I2C(id=0, sda=Pin(4), scl=Pin(5), freq=400000)
# 开始扫描I2C总线上的设备,返回从机地址的列表
devices_list = i2c.scan()
print("START I2C SCANNER")
# 若devices_list为空,则没有设备连接到I2C总线上
if len(devices_list) == 0:
print("No i2c device !")
# 若非空,则打印从机设备地址
else:
print("i2c devices found:", len(devices_list))
# 便利从机设备地址列表
for device in devices_list:
print("ADC I2C hexadecimal address: ", hex(device))
ADC_ADDRESS = device
# 创建ADC相关实例,增益系数设置为1
adc = ADS1115(i2c, ADC_ADDRESS, 1)
# 初始化软件定时器,设置周期为10毫秒(100Hz)
timer = Timer(-1)
timer.init(period=10, mode=Timer.PERIODIC, callback=timer_callback)
# ======================================== 主程序 ============================================
# 无限循环:无具体操作
while True:
# 延时1s
await asyncio.sleep(1)
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 |
|---|---|---|---|---|
ADS1115.alert_read |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
ADS1115.alert_start |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
ADS1115.conversion_start |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
ADS1115.raw_to_v |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
ADS1115.read |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
ADS1115.read_rev |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
ADS1115.set_conv |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
ADS1115Async.alert_read_async |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
ADS1115Async.alert_start_async |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
ADS1115Async.conversion_start_async |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
ADS1115Async.raw_to_v_async |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
ADS1115Async.read_async |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
ADS1115Async.read_rev_async |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
ADS1115Async.set_conv_async |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
SyncAdapterMixin.aclose |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
aclose |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
alert_read |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
alert_read_async |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
alert_start |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
alert_start_async |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
conversion_start |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
conversion_start_async |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
main |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
moving_average_filter |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
raw_to_v |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
raw_to_v_async |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
read |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
read_async |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
read_rev |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
read_rev_async |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
send_data_frames |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
set_conv |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
set_conv_async |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 timeout 参数;取消后执行清理。 |
timer_callback |
event_bridge |
IRQ/事件通知由协程消费;总线访问仍可能同步 | 底层总线/同步临界区可能阻塞事件循环 | 请使用实现中已有 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 | leeqingshui | 基于当前异步代码、来源包和许可证重新取证 README。 |
联系方式
请通过本仓库的 issue 或维护者渠道联系;包内元数据作者为:leeqingshui。
许可协议
许可证声明: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.