DoF9 Unit

此库是 Unit DoF9 的驱动程序。

支持以下产品：

UiFlow2 应用示例

读取航向角

在 UiFlow2 中打开 cores3_unit_dof9_example.m5f2 项目。

此示例演示如何读取并显示航向角。

UiFlow2 代码块：

示例输出：

无

MicroPython 应用示例

读取航向角

此示例演示如何读取并显示航向角。

MicroPython 代码块：

# SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT

import os, sys, io
import M5
from M5 import *
from hardware import Pin
from hardware import I2C
from unit import DoF9Unit
import time


title = None
live = None
heading_caption = None
label_heading = None
degree_unit = None
compensation_caption = None
sensor_caption = None
i2c0 = None
dof9_0 = None


last_time = None
UPDATE_DURATION_MS = None


def setup():
    global \
        title, \
        live, \
        heading_caption, \
        label_heading, \
        degree_unit, \
        compensation_caption, \
        sensor_caption, \
        i2c0, \
        dof9_0, \
        last_time, \
        UPDATE_DURATION_MS

    M5.begin()
    Widgets.setRotation(0)
    Widgets.fillScreen(0x10171D)
    title = Widgets.Label(
        "DoF9 / Compass", 12, 8, 1.0, 0x4CD7D0, 0x10171D, Widgets.FONTS.Montserrat18
    )
    live = Widgets.Label("Live", 272, 11, 1.0, 0x63D08C, 0x10171D, Widgets.FONTS.Montserrat14)
    heading_caption = Widgets.Label(
        "Magnetic Heading", 12, 48, 1.0, 0x8FA1AD, 0x10171D, Widgets.FONTS.Montserrat14
    )
    label_heading = Widgets.Label(
        "---.-", 12, 70, 1.0, 0xF2F6F8, 0x10171D, Widgets.FONTS.Montserrat40
    )
    degree_unit = Widgets.Label(
        "DEG", 174, 91, 1.0, 0xFFB454, 0x10171D, Widgets.FONTS.Montserrat18
    )
    compensation_caption = Widgets.Label(
        "TILT COMPENSATED", 12, 153, 1.0, 0x8FA1AD, 0x10171D, Widgets.FONTS.Montserrat14
    )
    sensor_caption = Widgets.Label(
        "BMI270 + BMM350", 12, 207, 1.0, 0x63A8FF, 0x10171D, Widgets.FONTS.Montserrat14
    )

    i2c0 = I2C(0, scl=Pin(1), sda=Pin(2), freq=400000)
    dof9_0 = DoF9Unit(i2c0, addr=0x68)
    UPDATE_DURATION_MS = 100
    last_time = time.ticks_ms()


def loop():
    global \
        title, \
        live, \
        heading_caption, \
        label_heading, \
        degree_unit, \
        compensation_caption, \
        sensor_caption, \
        i2c0, \
        dof9_0, \
        last_time, \
        UPDATE_DURATION_MS
    M5.update()
    if (time.ticks_diff((time.ticks_ms()), last_time)) >= UPDATE_DURATION_MS:
        last_time = time.ticks_ms()
        label_heading.setText(str(round(dof9_0.get_heading(), 1)))


if __name__ == "__main__":
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            from utility import print_error_msg

            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

示例输出：

无

API

DoF9Unit

构造函数

class DoF9Unit(i2c, addr=0x68)

在主机 I2C 总线上创建 DoF9Unit。BMI270 地址可选 0x68 或 0x69，默认为 0x68。BMM350 地址仍为 0x14。

参数:

i2c (I2C or PAHUBUnit) – 已初始化的 I2C 或 PAHUBUnit 接口。
addr (int) – BMI270 I2C 地址，可选 0x68 或 0x69，默认为 0x68。

抛出:

TypeError – addr 必须为整数。
ValueError – addr 必须为 0x68 或 0x69。
UnitError – 所选地址未检测到 BMI270。
OSError – 传感器初始化或 I2C 通信失败。

UiFlow2 代码块：

MicroPython 代码块：

dof = DoF9Unit(i2c)  # Default BMI270 address: 0x68
# Use this instead when the BMI270 is configured at 0x69:
# dof = DoF9Unit(i2c, addr=0x69)

方法

下面列出 DoF9 的完整接口。

get_accel()

返回映射后的加速度 (x, y, z)，单位为 m/s2。

返回:: 加速度元组。
返回类型:: tuple[float, float, float]

UiFlow2 代码块：

get_accel_raw()

返回范围为 -32768 到 32767 的有符号 16 位 BMI270 计数值。

返回:: 原始加速度计数值。
返回类型:: tuple[int, int, int]

UiFlow2 代码块：

get_gyro()

返回经过映射和偏移校正的角速度 (x, y, z)，单位为 rad/s。

返回:: 角速度元组。
返回类型:: tuple[float, float, float]

UiFlow2 代码块：

get_gyro_raw()

返回范围为 -32768 到 32767 的有符号 16 位 BMI270 陀螺仪计数值。

返回:: 原始陀螺仪计数值。
返回类型:: tuple[int, int, int]

UiFlow2 代码块：

get_mag()

返回经过映射和校准的磁场 (x, y, z)，单位为 uT。

返回:: 磁场元组。
返回类型:: tuple[float, float, float]

UiFlow2 代码块：

get_mag_raw()

返回范围为 -8388608 到 8388607 的有符号 24 位 BMM350 计数值。

返回:: 原始磁场计数值。
返回类型:: tuple[int, int, int]

UiFlow2 代码块：

get_temperature(sensor='imu')

返回 BMI270 或 BMM350 温度，单位为摄氏度。sensor 可为 "imu" 或 "magnetometer"。

参数:: sensor (str) – 温度来源。
返回:: 温度，单位为摄氏度。
返回类型:: float

UiFlow2 代码块：

get_heading()

采样传感器并返回经过倾斜补偿的航向角，范围为 0 到小于 360 度。

返回:: 航向角，单位为度。
返回类型:: float

UiFlow2 代码块：

get_attitude()

采样传感器并返回 (yaw, pitch, roll)，单位为度。

返回:: 姿态角，单位为度。
返回类型:: tuple[float, float, float]

UiFlow2 代码块：

set_accel_range(accel_scale)

设置为 ACCEL_RANGE_2G、ACCEL_RANGE_4G、ACCEL_RANGE_8G 或 ACCEL_RANGE_16G 之一。

参数:: accel_scale (int) – 满量程范围，单位为 g。

UiFlow2 代码块：

set_gyro_range(gyro_scale)

设置为 GYRO_RANGE_125DPS、GYRO_RANGE_250DPS、GYRO_RANGE_500DPS、GYRO_RANGE_1000DPS 或 GYRO_RANGE_2000DPS 之一。

参数:: gyro_scale (int) – 满量程范围，单位为 deg/s。

UiFlow2 代码块：

set_accel_gyro_odr(accel_odr, gyro_odr)

使用 ACCEL_ODR_VALUES 和 GYRO_ODR_VALUES 设置 BMI270 输出数据率。

参数:

accel_odr (float) – 加速度计输出数据率，单位为 Hz。
gyro_odr (int) – 陀螺仪输出数据率，单位为 Hz。

UiFlow2 代码块：

set_gyro_offsets(x, y, z)

设置映射后的陀螺仪偏移量，单位为 rad/s。

参数:

x (float) – X 轴偏移量，单位为 rad/s。
y (float) – Y 轴偏移量，单位为 rad/s。
z (float) – Z 轴偏移量，单位为 rad/s。

UiFlow2 代码块：

calibrate_gyro(samples=32)

设备静止时估算偏移量，成功时返回 True。

参数:: samples (int) – 采样次数。
返回:: 校准是否成功。
返回类型:: bool

UiFlow2 代码块：

set_magnetometer_calibration(offsets, scales)

设置硬铁偏移量（单位为 uT）和无量纲软铁比例因子。

参数:

offsets (tuple[float, float, float]) – 三个硬铁偏移量，单位为 uT。
scales (tuple[float, float, float]) – 三个正比例因子。

UiFlow2 代码块：

set_axis_mapping(sensor, x_axis, y_axis, z_axis)

映射 accelerometer、gyroscope 或 magnetometer 轴。1/-1、2/-2 和 3/-3 分别选择带符号的源 X/Y/Z 轴；源轴不能重复。

参数:

sensor (str) – 传感器名称。
x_axis (int) – 输出 X 轴对应的源轴。
y_axis (int) – 输出 Y 轴对应的源轴。
z_axis (int) – 输出 Z 轴对应的源轴。

UiFlow2 代码块：

set_fusion_time_constant(seconds)

设置非负的互补滤波器时间常数，单位为秒。

参数:: seconds (float) – 非负滤波器时间常数。

UiFlow2 代码块：

reset_fusion()

重置姿态滤波器；下一次姿态采样时会重新初始化。

UiFlow2 代码块：