mmc5983_async_driver

A MicroPython library to control mmc5983_driver

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

A MicroPython library to control mmc5983_driver — MicroPython 异步驱动

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

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

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

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

目录

简介

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

主要功能

  • 可解析的公开类:CBits, CBitsAsync, MMC5983, RegisterStruct, RegisterStructAsync, SyncAdapterMixin。
  • 可解析的公开调用入口:13 个(详见 API 矩阵)。
  • 异步等级:cooperative_nonblocking;依据:等待阶段使用协程让出;底层总线调用仍同步。

硬件要求

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

软件环境

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

文件结构

├── code/__pycache__/main.cpython-313.pyc
├── code/_gs_mmc5983_i2c_helpers_async.py
├── code/main.py
├── code/_gs_mmc5983_micropython_mmc5983/__init__.py
├── code/_gs_mmc5983_micropython_mmc5983/__pycache__/__init__.cpython-313.pyc
├── code/_gs_mmc5983_micropython_mmc5983/__pycache__/i2c_helpers.cpython-313.pyc
├── code/_gs_mmc5983_micropython_mmc5983/__pycache__/mmc5983.cpython-313.pyc
├── code/_gs_mmc5983_micropython_mmc5983/i2c_helpers.py
├── code/_gs_mmc5983_micropython_mmc5983/mmc5983.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    : 2025/1/15 下午3:00
    # @Author  : hogeiha
    # @File    : main.py
    # @Description : MMC5983磁力计连续模式读取并遍历操作模式

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

    # 导入时间模块用于延时

    # 导入MicroPython的引脚和软I2C类
    from machine import Pin, SoftI2C

    # 导入MMC5983磁力计驱动库
    from _gs_mmc5983_micropython_mmc5983 import mmc5983

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

    # 自动识别传感器地址,定义全局目标地址列表(支持多地址,单个也用[])
    TARGET_SENSOR_ADDRS = [0x30]

    # I2C引脚和频率定义
    I2C_SDA_PIN = 4
    I2C_SCL_PIN = 5
    I2C_FREQ = 400000

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

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

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

    # 等待3秒让系统稳定
    await asyncio.sleep(3)
    # 打印启动提示信息
    print("FreakStudio: MMC5983 sensor continuous mode test")

    # I2C初始化(兼容I2C/SoftI2C)
    i2c_bus = SoftI2C(sda=Pin(I2C_SDA_PIN), scl=Pin(I2C_SCL_PIN), freq=I2C_FREQ)

    # 开始扫描I2C总线上的设备
    devices_list: list[int] = i2c_bus.scan()
    print("START I2C SCANNER")

    # 检查I2C设备扫描结果
    if len(devices_list) == 0:
        print("No i2c device !")
        raise SystemExit("I2C scan found no devices, program exited")
    else:
        print("i2c devices found:", len(devices_list))

    # 遍历地址列表初始化目标传感器
    # 初始化传感器对象占位符
    sensor = None
    for device in devices_list:
        if device in TARGET_SENSOR_ADDRS:
            print("I2c hexadecimal address:", hex(device))
            try:
                # 自动识别并初始化对应传感器
                sensor = mmc5983.MMC5983(i2c=i2c_bus)
                print("Sensor initialization successful")
                break
            except Exception as e:
                print(f"Sensor Initialization failed: {e}")
                continue
    else:
        # 未找到目标设备,抛出异常
        raise Exception("No target sensor device found in I2C bus")

    # 设置传感器为连续测量模式
    sensor.operation_mode = mmc5983.CONTINUOUS

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

    # 主循环:遍历所有操作模式并读取磁场数据
    while True:
        # 遍历所有可用的操作模式
        for operation_mode in mmc5983.operation_mode_values:
            # 打印当前操作模式设置
            print("Current Operation mode setting: ", sensor.operation_mode)
            # 在当前模式下连续读取10次磁场数据
            for _ in range(10):
                # 读取X、Y、Z三轴磁场强度(微特斯拉)
                magx, magy, magz = sensor.magnetic
                # 打印磁场数值,保留两位小数
                print(f"X: {magx:.2f}uT, Y: {magy:.2f}uT, Z: {magz:.2f}uT")
                # 打印空行分隔
                print()
                # 延时0.5秒
                await asyncio.sleep(0.5)
            # 切换到下一个操作模式
            sensor.operation_mode = operation_mode

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
MMC5983.bandwidth cooperative_nonblocking 等待阶段使用协程让出;底层总线调用仍同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
MMC5983.continuous_mode_frequency cooperative_nonblocking 等待阶段使用协程让出;底层总线调用仍同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
MMC5983.magnetic cooperative_nonblocking 等待阶段使用协程让出;底层总线调用仍同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
MMC5983.operation_mode cooperative_nonblocking 等待阶段使用协程让出;底层总线调用仍同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
MMC5983.temperature cooperative_nonblocking 等待阶段使用协程让出;底层总线调用仍同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
SyncAdapterMixin.aclose cooperative_nonblocking 等待阶段使用协程让出;底层总线调用仍同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
aclose cooperative_nonblocking 等待阶段使用协程让出;底层总线调用仍同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
bandwidth cooperative_nonblocking 等待阶段使用协程让出;底层总线调用仍同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
continuous_mode_frequency cooperative_nonblocking 等待阶段使用协程让出;底层总线调用仍同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
magnetic cooperative_nonblocking 等待阶段使用协程让出;底层总线调用仍同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
main cooperative_nonblocking 等待阶段使用协程让出;底层总线调用仍同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
operation_mode cooperative_nonblocking 等待阶段使用协程让出;底层总线调用仍同步 底层总线/同步临界区可能阻塞事件循环 请使用实现中已有 timeout 参数;取消后执行清理。
temperature 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 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.
File List
Name Size Type
LICENSE 1.0KB File
README.md 13.9KB Doc
code/_gs_mmc5983_i2c_helpers_async.py 713B Python
code/_gs_mmc5983_micropython_mmc5983/__init__.py 241B Main
code/_gs_mmc5983_micropython_mmc5983/i2c_helpers.py 10.4KB Python
code/_gs_mmc5983_micropython_mmc5983/mmc5983.py 14.8KB Python
code/main.py 1.9KB Main
code/mmc5983_async.py 1.5KB Python
examples/main_sync.py 3.2KB Python
package.json 945B Conf