ags02ma_async_driver

A MicroPython library to control AGS02MA TVOC/gas sensor via I2C

1.0.0 yangcong-bit Updated At: 2026-11-10
Install Package
Local Install
mpremote mip install https://upypi.net/pkgs/ags02ma_async_driver/1.0.0
Remote Install
mip.install("https://upypi.net/pkgs/ags02ma_async_driver/1.0.0")
Version Selection
README

A MicroPython library to control AGS02MA TVOC/gas sensor via I2C — MicroPython 异步驱动

实验性异步版本:尚未完成实物验收。

同步来源:同步版本。维护者说明同步版本已验证;本次未逐包复测同步来源,适用硬件和固件范围以原有记录为准。

异步版本:本包 Python 源码及示例已通过 MicroPython 1.23 / 1.29 编译检查;软件回归只覆盖选定路径,不代表本包全部 API、实际器件及并发行为已验证。

仓库验证说明 · 两轮软件检查 · 受限清单 · 安装与初始化迁移

目录

简介

ags02ma_async_driver 是当前仓库中独立发布的 MicroPython 异步包。设备/功能名称和 API 均来自包内运行时文件;它不是对同步 API 的无依据重命名。源包:sensors/ags02ma_driver。

主要功能

  • 可解析的公开类:AGS02MA, AGS02MAAsync, SyncAdapterMixin。
  • 可解析的公开调用入口:23 个(详见 API 矩阵)。
  • 异步等级:not_async_safe;异步包装不能消除同步 I2C 阻塞;在取得可复现阻塞上界前不得作为可用异步驱动交付。

硬件要求

项目 从代码取得的事实
通信/IO I2C, Pin(
示例 GPIO 示例未声明固定 GPIO 编号
供电、地址与电平 仅按模块实物标签、数据手册及代码常量配置;。

软件环境

项目 值
运行时 MicroPython + uasyncio
包版本 1.0.0
作者 Tom Øyvind Hogstad
依赖 无声明的第三方依赖

文件结构

├── code/__pycache__/ags02ma.cpython-313.pyc
├── code/__pycache__/main.cpython-313.pyc
├── code/ags02ma.py
├── code/ags02ma_async.py
├── code/main.py
├── examples/main_sync.py
├── LICENSE
└── package.json

文件说明

  • code/:实际发布的运行时 Python 模块;以 package.json.urls 为安装映射依据。
  • code/main.py(若存在):异步演示入口,不是默认发布运行时映射。
  • examples/(若存在):同步保真基线或额外示例,不应当作安装后的运行时模块。
  • package.json、LICENSE:发布元数据和许可证的唯一事实来源。

快速开始

  1. 按 package.json.urls 将运行时文件复制到设备;不要把 examples/ 当作运行时依赖。
  2. 按上文硬件/运行环境配置总线、GPIO、网络或凭证。
  3. 使用包内真实 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  : hogeiha
    # @File    : main.py
    # @Description : AGS02MA气体传感器读取示例


    # ======================================== 导入相关模块 =========================================

    import machine
    from ags02ma import AGS02MA


    # ======================================== 全局变量 ============================================

    # I2C数据引脚编号
    I2C_SDA_PIN = 4

    # I2C时钟引脚编号
    I2C_SCL_PIN = 5

    # AGS02MA需要低速I2C通信
    I2C_FREQ = 20000

    # 传感器读取间隔时间(秒)
    READ_INTERVAL = 10

    # 传感器上电预热等待时间(秒)
    WARMUP_SECONDS = 120


    # ======================================== 功能函数 ============================================


    # ======================================== 自定义类 ============================================


    # ======================================== 初始化配置 ===========================================

    # 等待系统和传感器上电稳定
    await asyncio.sleep(3)

    # 打印程序功能提示
    print("FreakStudio: AGS02MA gas sensor")

    # 初始化软件I2C总线
    i2c = machine.SoftI2C(
        scl=machine.Pin(I2C_SCL_PIN),
        sda=machine.Pin(I2C_SDA_PIN),
        freq=I2C_FREQ,
    )

    # 扫描I2C总线设备
    devices = i2c.scan()

    # 打印I2C设备扫描结果
    print("Devices: {}".format(devices))

    # 创建AGS02MA传感器对象
    ags = AGS02MA(i2c)

    # 读取固件版本
    firmware_version = ags.firmware_version() & 0x0000FF

    # 打印固件版本
    print("Firmware version: {}".format(firmware_version))

    # 打印传感器预热提示
    print("Warmup for {} seconds".format(WARMUP_SECONDS))


    # ========================================  主程序  ============================================

    # 持续读取AGS02MA传感器数据
    while True:

        # 捕获单次读取异常避免示例程序退出
        try:

            # 读取TVOC浓度值
            tvoc = ags.TVOC

            # 打印TVOC浓度值
            print("TVOC: {}".format(tvoc))

        # 读取TVOC失败时打印英文错误
        except RuntimeError as exc:
            print("TVOC read failed: {}".format(exc))

            # 打印TVOC原始调试数据
            print("TVOC raw: {}".format(ags.debug_read_raw(0x00)))

        # 捕获单次读取异常避免示例程序退出
        try:

            # 读取气敏电阻值
            gas_resistance = ags.gas_resistance

            # 打印气敏电阻值
            print("Gas resistance: {}".format(gas_resistance))

        # 读取气敏电阻失败时打印英文错误
        except RuntimeError as exc:
            print("Gas resistance read failed: {}".format(exc))

            # 打印气敏电阻原始调试数据
            print("Gas resistance raw: {}".format(ags.debug_read_raw(0x20)))

        # 等待下一次读取
        await asyncio.sleep(READ_INTERVAL)

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
AGS02MA.TVOC not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
AGS02MA.debug_read_raw not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
AGS02MA.deinit not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
AGS02MA.firmware_version not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
AGS02MA.gas_resistance not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
AGS02MAAsync.TVOC_async not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
AGS02MAAsync.debug_read_raw_async not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
AGS02MAAsync.deinit_async not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
AGS02MAAsync.firmware_version_async not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
AGS02MAAsync.gas_resistance_async not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
SyncAdapterMixin.aclose not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
TVOC not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
TVOC_async not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
aclose not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
debug_read_raw not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
debug_read_raw_async not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
deinit not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
deinit_async not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
firmware_version not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
firmware_version_async not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
gas_resistance not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
gas_resistance_async not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 timeout;取消仅在同步调用返回后生效;不得用于时延敏感协程。
main not_async_safe 直接委托来源同步 I2C 事务;事务内不让出 同步 I2C 事务可无限期或不可预期地阻塞事件循环 无事务内 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、静默间隔及错误含义只以当前实现和源示例可证明的内容为准。

Sync Adapter Blocking Budget

所有标记为 not_async_safe 的 API 都直接委托给来源实现中的一个或多个同步 I2C 事务;协程包装本身不在事务内部让出执行权。阻塞来源是 I2C.readfrom_mem、I2C.writeto_mem、I2C.readfrom 或 I2C.writeto。未在目标硬件、总线频率、从机时钟拉伸和错误恢复条件下测得可证实的最大事务时长,因此最大阻塞时间为“未验证”,不能承诺 deadline 或实时性。

这些 API 没有事务内 timeout,也不能在 I2C 调用进行时响应取消;任务取消只会在同步调用返回后的下一个 await 处生效。调用者应避免在时延敏感的任务、IRQ 或 PIO 回调中调用,并在同一 I2C 总线的并发访问上自行串行化。保留风险:慢设备、时钟拉伸、总线故障或驱动恢复都可能使事件循环阻塞;尚未进行硬件验证。

Hardware Acceptance

Level Evidence Not covered
Link 未实测:仅完成静态代码与文档取证。 总线/网络连接、设备身份响应。
Basic function 未实测。 一次真实业务 API 成功及结果正确性。
Complete business flow 未实测。 端到端设备、对端、供电、时序和异常恢复。

注意事项

类别 说明
并发 同一硬件实例应由调用方串行化;UART 额外遵守其并发契约。
阻塞 不把短同步总线访问或严格时序脉冲描述为真正可中断。
验收 文档生成不等于硬件验证;接入真实设备后分别记录三层验收证据。

版本记录

版本号 日期 作者 修改说明
1.0.0 2026-09-17 Tom Øyvind Hogstad 基于当前异步代码、来源包和许可证重新取证 README。

联系方式

请通过本仓库的 issue 或维护者渠道联系;包内元数据作者为:Tom Øyvind Hogstad。

许可协议

许可证声明:MIT。以下为本包 LICENSE 的逐字内容:

MIT License

Copyright (c) 2022 ladyada for Adafruit Industries
Copyright (c) 2023 Tom Øyvind Hogstad

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.
File List
Name Size Type
LICENSE 1.1KB File
README.md 17.1KB Doc
code/ags02ma.py 12.0KB Python
code/ags02ma_async.py 7.1KB Python
code/main.py 3.6KB Main
examples/main_sync.py 2.7KB Python
package.json 756B Conf