bma423_async_driver

A MicroPython I2C driver for the BMA423 accelerometer and feature engine

1.0.0 yangcong-bit 更新时间: 2026-11-10
安装包
本地安装
mpremote mip install https://upypi.net/pkgs/bma423_async_driver/1.0.0
远程安装
mip.install("https://upypi.net/pkgs/bma423_async_driver/1.0.0")
版本选择
README

A MicroPython I2C driver for the BMA423 accelerometer and feature engine — MicroPython 异步驱动

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

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

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

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

Async startup: constructing the async class stores configuration only. Call await device.initialize_async() (or await sensor.initialize_async()) before other operations. The constructor of the original synchronous class is unchanged.

目录

简介

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

主要功能

  • 可解析的公开类:BMA423, BMA423Async, SyncAdapterMixin。
  • 可解析的公开调用入口:63 个(详见 API 矩阵)。
  • 异步等级:event_bridge;依据:IRQ/事件通知由协程消费;总线访问仍可能同步。

硬件要求

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

软件环境

项目 值
运行时 MicroPython + uasyncio
包版本 1.0.0
作者 Salvatore Sanfilippo, FreakStudio
依赖 无声明的第三方依赖

文件结构

├── code/__pycache__/bma423.cpython-313.pyc
├── code/__pycache__/main.cpython-313.pyc
├── code/_gs_bma423_bma423.py
├── code/bma423_async.py
├── code/bma423conf.bin
├── 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


# Python env   : MicroPython v1.23.0
# -*- coding: utf-8 -*-
# @Time    : 2026/07/19 00:00
# @Author  : FreakStudio
# @File    : main.py
# @Description : 测试 BMA423 加速度传感器驱动类的代码
# @License : MIT

from machine import I2C, Pin
from bma423_async import BMA423Async as BMA423

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

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

# I2C 引脚配置(ESP32 默认引脚)
I2C_SCL_PIN = 22
I2C_SDA_PIN = 21
I2C_FREQ = 400000

# 示例:将 I2C 总线 ID 0 作为默认值
I2C_BUS_ID = 0

# 驱动实例(初始化配置区赋值)
device = None

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


def report_event(data) -> None:
    """
    中断回调函数示例
    Args:
        data: 由 BMA423 中断传递的数据
    """
    print("Interrupt triggered: %s" % str(data))


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

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


async def main():
    i2c = None
    device = None
    try:
        await asyncio.sleep_ms(3000)
        print("FreakStudio: Using BMA423 accelerometer driver ...")
        i2c = I2C(I2C_BUS_ID, scl=Pin(I2C_SCL_PIN), sda=Pin(I2C_SDA_PIN), freq=I2C_FREQ)
        devices = i2c.scan()
        if not devices:
            raise RuntimeError("No I2C device found on bus")
        print("I2C devices found: %s" % [hex(d) for d in devices])
        device = BMA423(i2c, acc_range=4, debug=False)
        await device.initialize_async()
        try:
            await device.load_features_config_async()
            await device.enable_features_detection_async("step-count")
            print("Feature engine: step counting enabled")
        except (OSError, RuntimeError) as error:
            print("Feature engine load failed: %s" % error)
        while True:
            device.process_irq()
            accel = await device.get_xyz_async()
            temp = await device.get_temperature_async()
            steps = await device.get_steps_async()
            print("accel(x,y,z)=(%.3f, %.3f, %.3f)g temp=%.1fC steps=%d" % (accel[0], accel[1], accel[2], temp if temp is not None else -999.0, steps))
            await asyncio.sleep_ms(500)
    finally:
        if device is not None:
            await device.aclose()
        if i2c is not None:
            deinit = getattr(i2c, "deinit", None)
            if deinit is not None:
                deinit()
# ======================================== 主程序 ==============================================
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
BMA423.deinit event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423.enable_accelerometer event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423.enable_features_detection event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423.enable_interrupt event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423.get_steps event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423.get_temperature event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423.get_xyz event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423.load_features_config event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423.reset event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423.set_accelerometer_avg event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423.set_accelerometer_freq event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423.set_accelerometer_perf event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423.set_advanced_power_save event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423.set_range event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423Async.deinit_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423Async.enable_accelerometer_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423Async.enable_features_detection_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423Async.enable_interrupt_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423Async.get_steps_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423Async.get_temperature_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423Async.get_xyz_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423Async.load_features_config_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423Async.reset_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423Async.set_accelerometer_avg_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423Async.set_accelerometer_freq_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423Async.set_accelerometer_perf_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423Async.set_advanced_power_save_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
BMA423Async.set_range_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
SyncAdapterMixin.aclose event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
aclose event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
alloc_emergency_exception_buf event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
const event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
deinit event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
deinit_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
enable_accelerometer event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
enable_accelerometer_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
enable_features_detection event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
enable_features_detection_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
enable_interrupt event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
enable_interrupt_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
get_steps event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
get_steps_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
get_temperature event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
get_temperature_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
get_xyz event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
get_xyz_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
load_features_config event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
load_features_config_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
main event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
my_callback event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
reset event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
reset_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
schedule event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
set_accelerometer_avg event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
set_accelerometer_avg_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
set_accelerometer_freq event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
set_accelerometer_freq_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
set_accelerometer_perf event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
set_accelerometer_perf_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
set_advanced_power_save event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
set_advanced_power_save_async event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
set_range event_bridge IRQ/事件通知由协程消费;总线访问仍可能同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
set_range_async 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、静默间隔及错误含义只以当前实现和源示例可证明的内容为准。

Hardware Acceptance

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

注意事项

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

版本记录

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

联系方式

请通过本仓库的 issue 或维护者渠道联系;包内元数据作者为:Salvatore Sanfilippo, FreakStudio。

许可协议

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

Copyright (c) 2024 Salvatore Sanfilippo.

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.
文件列表
Name Size Type
LICENSE 1.0KB File
README.md 24.3KB Doc
code/_gs_bma423_bma423.py 38.8KB Python
code/bma423_async.py 6.6KB Python
code/bma423conf.bin 6.0KB File
code/main.py 2.8KB Main
examples/main_sync.py 3.0KB Python
package.json 591B Conf