Accel Unit

这是 Accel Unit 的驱动库，用于获取加速度传感器的数据，并支持运动检测。

支持以下产品：

UiFlow2 应用示例

获取加速度计数值

在 UiFlow2 中打开 stickcplus2_unit_accel_example.m5f2 项目。

该示例获取 Accel Unit 的加速度值，并将其显示在屏幕上。

UiFlow2 代码块：

示例输出：

None

MicroPython 应用示例

获取加速度计数值

该示例获取 Accel Unit 的加速度值，并将其显示在屏幕上。

MicroPython 代码块：

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

import os, sys, io
import M5
from M5 import *
from hardware import *
from unit import AccelUnit


label0 = None
label1 = None
label2 = None
title0 = None
label3 = None
label4 = None
label5 = None
i2c0 = None
accel_0 = None


acc = None


def setup():
    global label0, label1, label2, title0, label3, label4, label5, i2c0, accel_0, acc

    M5.begin()
    label0 = Widgets.Label("x:", 4, 48, 1.0, 0xFFFFFF, 0x222222, Widgets.FONTS.DejaVu18)
    label1 = Widgets.Label("y:", 4, 88, 1.0, 0xFFFFFF, 0x222222, Widgets.FONTS.DejaVu18)
    label2 = Widgets.Label("z:", 4, 128, 1.0, 0xFFFFFF, 0x222222, Widgets.FONTS.DejaVu18)
    title0 = Widgets.Title("ACCEL UNIT", 3, 0xFFFFFF, 0x0000FF, Widgets.FONTS.DejaVu18)
    label3 = Widgets.Label("label3", 24, 48, 1.0, 0xFFFFFF, 0x222222, Widgets.FONTS.DejaVu18)
    label4 = Widgets.Label("label4", 24, 88, 1.0, 0xFFFFFF, 0x222222, Widgets.FONTS.DejaVu18)
    label5 = Widgets.Label("label5", 24, 128, 1.0, 0xFFFFFF, 0x222222, Widgets.FONTS.DejaVu18)

    i2c0 = I2C(0, scl=Pin(33), sda=Pin(32), freq=100000)
    accel_0 = AccelUnit(i2c0, 0x53)


def loop():
    global label0, label1, label2, title0, label3, label4, label5, i2c0, accel_0, acc
    M5.update()
    acc = accel_0.get_accel()
    label3.setText(str(acc[0]))
    label4.setText(str(acc[1]))
    label5.setText(str(acc[2]))


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")

示例输出：

None

API参考

AccelUnit

class unit.accel.AccelUnit(i2c, address=83)

基类：ADXL345

创建一个 AccelUnit 对象。

参数:

i2c (I2C) – Accel Unit 所连接的 I2C 总线。
address (int) – 设备的 I2C 地址。默认值为 0x53。

UiFlow2 代码块：

MicroPython 代码块：

from hardware import I2C
from unit import AccelUnit

acceli2c0 = I2C(0, scl=Pin(1), sda=Pin(2), freq=100000)
accel_0 = AccelUnit(i2c0)

get_accel()

返回 x、y、z 加速度值，以 \(m / s ^ 2\) 为单位的 3 元组。

返回:: x、y、z 加速度值，单位为 \(m / s ^ 2\)。
返回类型:: tuple[float, float, float]

UiFlow2 代码块：

MicroPython 代码块：

accel_0.get_accel()

enable_motion_detection(*, threshold=18)

活动检测参数。

参数:: threshold (int) – 加速度在任意轴上必须超过该值，才会被注册为活跃。比例因子为 62.5 mg/LSB。
返回类型:: None

如果您希望自行设置它们而不是使用默认值，则必须使用关键字参数:

accelerometer.enable_motion_detection(threshold=20)

UiFlow2 代码块：

MicroPython 代码块：

accel_0.enable_motion_detection(threshold=18)

disable_motion_detection()

禁用运动检测。

UiFlow2 代码块：

MicroPython 代码块：

accel_0.disable_motion_detection()

返回类型:: None

get_data_rate()

获取传感器的数据速率。

返回:: 传感器的数据速率。
返回类型:: int

速率选项为：

0：0.1 Hz

1：0.20 Hz

2：0.39 Hz

3：0.78 Hz

4：1.56 Hz

5：3.13 Hz

6：6.25 Hz

7：12.5 Hz

8：25 Hz

9：50 Hz

10：100 Hz

11：200 Hz

400 Hz

13：800 Hz

14：1600 Hz

15：3200 Hz

UiFlow2 代码块：

MicroPython 代码块：

accel_0.get_data_rate()

set_data_rate(rate)

设置传感器的数据速率。

参数:: rate (int) – 传感器的数据速率。
返回类型:: None

速率选项为：

0：0.1 Hz

1：0.20 Hz

2：0.39 Hz

3：0.78 Hz

4：1.56 Hz

5：3.13 Hz

6：6.25 Hz

7：12.5 Hz

8：25 Hz

9：50 Hz

10：100 Hz

11：200 Hz

400 Hz

13：800 Hz

14：1600 Hz

15：3200 Hz

UiFlow2 代码块：

MicroPython 代码块：

accel_0.set_data_rate(accel_0.RATE_3200_HZ)

get_range()

获取传感器的测量范围。

返回:: 传感器的测量范围。
返回类型:: int

范围选项包括：

0：2G

4G

2：8G

16G

UiFlow2 代码块：

MicroPython 代码块：

accel_0.get_range()

set_range(range)

传感器的测量范围。

参数:: range (int) – 传感器的测量范围。
返回类型:: None

范围选项包括：

0：2G

4G

2：8G

16G

UiFlow2 代码块：

MicroPython 代码块：

accel_0.set_range(accel_0.RANGE_2_G)

is_tap()

Returns True if a tap has been detected.

返回:: 如果检测到点击，则为 True。
返回类型:: bool

UiFlow2 代码块：

MicroPython 代码块：

accel_0.is_tap()

is_motion()

检测到运动时返回 True。

返回:: 如果检测到运动，则为 True。
返回类型:: bool

UiFlow2 代码块：

MicroPython 代码块：

accel_0.is_motion()

is_freefall()

Returns True if freefall has been detected.

返回:: 如果检测到自由落体，则为 True。
返回类型:: bool

UiFlow2 代码块：

MicroPython 代码块：

accel_0.is_freefall()

enable_freefall_detection(*, threshold=10, time=25)

自由落体检测参数：

参数:

threshold (int) – 所有轴的加速度必须低于该值时，才会被判定为跌落。比例系数为 62.5 mg/LSB。
time (int) – 在所有轴上加速度必须小于 threshold 并持续的时间，才能被判定为跌落。比例因子为 5 ms/LSB。推荐值为 100 ms 到 350 ms（20 到 70）。

返回类型:

None

如果您希望自行设置它们，而不是使用默认值，则必须使用关键字参数：

accelerometer.enable_freefall_detection(time=30)

UiFlow2 代码块：

MicroPython 代码块：

accel_0.enable_freefall_detection()

disable_freefall_detection()

禁用自由落体检测。

UiFlow2 代码块：

MicroPython 代码块：

accel_0.disable_freefall_detection()

返回类型:: None

enable_tap_detection(tap_count=1, threshold=20, duration=50, latency=20, window=255)

轻触检测参数。

参数:

tap_count (int) – 1 用于仅检测单击，2 用于仅检测双击。
threshold (int) – 轻触检测的阈值。比例因子为 62.5 mg/LSB。数值越大，检测灵敏度越低。
duration (int) – 这将限制高于 threshold 的脉冲持续时间。任何超过 duration 的脉冲都不会被识别为一次轻触。缩放因子为 625 µs/LSB。
latency (int) – （仅双击）在初始脉冲低于 threshold 后，到开始用于检测第二个脉冲的时间窗口之前的时长。比例因子为 1.25 ms/LSB。
window (int) – （仅双击）用于检测第二次点击的时间窗口长度。比例因子为 1.25 ms/LSB。

返回类型:

None

如果您希望自行设置它们，而不是使用默认值，则必须使用关键字参数：

accelerometer.enable_tap_detection(duration=30, threshold=25)

UiFlow2 代码块：

MicroPython 代码块：

accel_0.enable_tap_detection(tap_count=1, threshold=20, duration=50, latency=20, window=255)

disable_tap_detection()

禁用点击检测。

UiFlow2 代码块：

MicroPython 代码块：

accel_0.disable_tap_detection()

返回类型:: None

ADXL345

class unit.accel.ADXL345(i2c, address=micropython.const)

基类：object

ADXL345 三轴加速度计驱动程序。

参数:

i2c (I2C) – ADXL345 连接到的 I2C 总线。
address (int) – 传感器的 I2C 设备地址。默认值为 0x53。

快速入门：导入并使用设备

下面是使用 ADXL345 类的示例。首先，你需要导入用于使用该传感器的库：
import machine
import adxl34x
完成后，你可以定义你的 I2C 对象，并定义你的传感器对象：
i2c = machine.I2C(0)  # uses board default SDA and SCL pins
accelerometer = adxl34x.ADXL343(i2c)
现在你可以访问 acceleration 属性：
acceleration = accelerometer.acceleration

property acceleration: tuple[int, int, int]: 返回 x、y、z 加速度值，以 \(m / s ^ 2\) 为单位的 3 元组。

property raw_x: int: 原始 x 值。

property raw_y: int: 原始 y 值。

property raw_z: int: 原始 z 值。

property events: dict[str, bool]

events 将返回一个字典，其中包含每个已启用事件类型对应的键。

可能的键为：

Key	Description
tap	如果最近检测到一次轻触，则为 True。是检测单击还是双击，由 enable_tap_detection 的 tap 参数决定。
motion	如果传感器检测到加速度超过通过 enable_motion_detection 设置的阈值，则为 True。
freefall	如果传感器处于自由落体状态，则为 True。参数在使用 enable_freefall_detection 启用时设置。

enable_motion_detection(*, threshold=18)

活动检测参数。

参数:: threshold (int) – 加速度在任意轴上必须超过该值，才会被注册为活跃。比例因子为 62.5 mg/LSB。

如果您希望自行设置它们，而不是使用默认值，则必须使用关键字参数：

accelerometer.enable_motion_detection(threshold=20)

disable_motion_detection()

禁用运动检测。

返回类型:: None

enable_freefall_detection(*, threshold=10, time=25)

自由落体检测参数：

参数:

threshold (int) – 所有轴的加速度必须低于该值时，才会被判定为跌落。比例系数为 62.5 mg/LSB。
time (int) – 在所有轴上加速度必须小于 threshold 并持续的时间，才能被判定为跌落。比例因子为 5 ms/LSB。推荐值为 100 ms 到 350 ms（20 到 70）。

返回类型:

None

如果您希望自行设置它们，而不是使用默认值，则必须使用关键字参数：

accelerometer.enable_freefall_detection(time=30)

disable_freefall_detection()

禁用自由落体检测。

返回类型:: None

enable_tap_detection(*, tap_count=1, threshold=20, duration=50, latency=20, window=255)

轻触检测参数。

参数:

tap_count (int) – 1 用于仅检测单击，2 用于仅检测双击。
threshold (int) – 轻触检测的阈值。比例因子为 62.5 mg/LSB。数值越大，检测灵敏度越低。
duration (int) – 这将限制高于 threshold 的脉冲持续时间。任何超过 duration 的脉冲都不会被识别为一次轻触。缩放因子为 625 µs/LSB。
latency (int) – （仅双击）在初始脉冲低于 threshold 后，到开始用于检测第二个脉冲的时间窗口之前的时长。比例因子为 1.25 ms/LSB。
window (int) – （仅双击）用于检测第二次点击的时间窗口长度。比例因子为 1.25 ms/LSB。

如果您希望自行设置它们，而不是使用默认值，则必须使用关键字参数：

accelerometer.enable_tap_detection(duration=30, threshold=25)

disable_tap_detection()

禁用点击检测。

返回类型:: None

property data_rate: int: 传感器的数据速率。

property range: int: 传感器的测量范围。

property offset: tuple[int, int, int]

x、y、z 偏移量，作为原始计数值的元组。

有关用法请参阅 offset_calibration 示例。