ToF4M Unit

这是 ToF4M Unit 的驱动库，用于从 VL53L1CXV0FY 传感器获取距离数据。

支持以下产品：

UiFlow2 应用示例

获取距离值

在 UiFlow2 中打开 tof4m_core_example.m5f2 项目。

该示例获取 ToF4M Unit 的距离值，并将其显示在屏幕上。

UiFlow2 代码块：

示例输出：

None

MicroPython 应用示例

获取距离值

该示例获取 ToF4M Unit 的距离值，并将其显示在屏幕上。

MicroPython 代码块：

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

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


title0 = None
label1 = None
i2c1 = None
tof4m_0 = None


distance = None


def setup():
    global title0, label1, i2c1, tof4m_0, distance

    M5.begin()
    Widgets.fillScreen(0x222222)
    title0 = Widgets.Title("ToF4MUnit CoreS3 Test", 3, 0xFFFFFF, 0x0000FF, Widgets.FONTS.DejaVu18)
    label1 = Widgets.Label("label1", 1, 121, 1.0, 0xFFFFFF, 0x222222, Widgets.FONTS.DejaVu18)

    i2c1 = I2C(1, scl=Pin(22), sda=Pin(21), freq=100000)
    tof4m_0 = TOF4MUnit(i2c1, 0x29)
    tof4m_0.set_distance_mode(2)
    tof4m_0.set_measurement_timing_budget(500)
    tof4m_0.set_continuous_start_measurement()


def loop():
    global title0, label1, i2c1, tof4m_0, distance
    M5.update()
    if tof4m_0.get_data_ready:
        label1.setText(str((str("Distance:") + str((str(distance) + str("mm"))))))


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参考

TOF4MUnit

unit.tof4m.TOF4MUnit: VL53L1X 的别名

VL53L1CXV0FY

class driver.vl53l1x.VL53L1X(i2c, address=41)

基类：object

创建一个 VL53L1X 对象。

参数:

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

UiFlow2 代码块：

MicroPython 代码块：

from hardware import I2C
from unit import TOFUnit

i2c0 = I2C(0, scl=Pin(1), sda=Pin(2), freq=100000)
tof_0 = TOFUnit(i2c0)

property get_distance

以毫米为单位的距离。

返回:: 以毫米为单位的距离；如果测量无效则为 None。
返回类型:: int or None

UiFlow2 代码块：

MicroPython 代码块：

distance = tof_0.get_distance

set_continuous_start_measurement()

启动连续测量操作。

UiFlow2 代码块：

MicroPython 代码块：

tof_0.set_continuous_start_measurement()

set_continuous_stop_measurement()

停止测量操作。

UiFlow2 代码块：

MicroPython 代码块：

tof_0.set_continuous_stop_measurement()

property get_data_ready

Returns true if new data is ready, otherwise false.

返回:: 如果新数据已就绪，则为 True。
返回类型:: bool

UiFlow2 代码块：

MicroPython 代码块：

if tof_0.get_data_ready:
    distance = tof_0.get_distance

property get_measurement_timing_budget

获取以毫秒为单位的测量持续时间。

返回:: 以毫秒为单位的定时预算。
返回类型:: int

UiFlow2 代码块：

MicroPython 代码块：

budget = tof_0.get_measurement_timing_budget

set_measurement_timing_budget(val)

以毫秒为单位设置测量定时预算。

参数:: val (int) – 以毫秒为单位的时间预算。

UiFlow2 代码块：

MicroPython 代码块：

tof_0.set_measurement_timing_budget(100)

property get_distance_mode

获取距离模式。

返回:: 距离模式（1=短距离，2=长距离）。
返回类型:: int

UiFlow2 代码块：

MicroPython 代码块：

mode = tof_0.get_distance_mode

set_distance_mode(mode)

设置距离模式。

参数:: mode (int) – 1=短，2=长

UiFlow2 代码块：

MicroPython 代码块：

tof_0.set_distance_mode(2)  # Long distance mode

set_i2c_address(new_address)

为已实例化的对象设置新的 I2C 地址。

参数:: new_address (int) – 新的 I2C 地址。

UiFlow2 代码块：

MicroPython 代码块：

tof_0.set_i2c_address(42)