ToF Unit

Support the following products:

Micropython Example:

# 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 ToFUnit


label0 = None
i2c0 = None
tof_0 = None


def setup():
    global label0, i2c0, tof_0

    M5.begin()
    Widgets.fillScreen(0x222222)
    label0 = Widgets.Label("label0", 132, 109, 1.0, 0xFFFFFF, 0x222222, Widgets.FONTS.DejaVu18)

    i2c0 = I2C(0, scl=Pin(22), sda=Pin(21), freq=100000)
    tof_0 = ToFUnit(i2c0)


def loop():
    global label0, i2c0, tof_0
    M5.update()
    label0.setText(str((str((tof_0.get_range())) + 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")

UIFLOW2 Example:

tof_core_example.m5f2

class ToFUnit

Constructors

class ToFUnit(i2c: I2C, address: int = 0x29, io_timeout_ms: int = 0)

Create a DLight object.

参数:

i2c – the I2C object.
address – the I2C address of the device. Default is 0x23.
io_timeout_ms – the timeout of I2C communication. Default is 0ms.

UIFLOW2:

Methods

ToFUnit.get_distance() → float

Get distance in centimeters.

返回:: distance in millimeters.

UIFLOW2:

ToFUnit.get_data_ready() → bool

Get data ready status.

返回:: data ready status.

UIFLOW2:

ToFUnit.get_range() → int

Get distance in millimeters.

返回:: distance in millimeters.

UIFLOW2:

ToFUnit.is_continuous_mode() → bool

Get continuous mode status.

返回:: continuous mode status.

UIFLOW2:

ToFUnit.get_measurement_timing_budget() → int

Get measurement timing budget. The budget is in microseconds.

返回:: measurement timing budget. The budget is in microseconds.

UIFLOW2:

ToFUnit.set_measurement_timing_budget(budget_us: int) → None

Set measurement timing budget. The budget_us is in microseconds.

参数:: budget_us – measurement timing budget in microseconds.

UIFLOW2:

ToFUnit.get_signal_rate_limit() → float

Get signal rate limit.

返回:: signal rate limit.

UIFLOW2:

ToFUnit.set_signal_rate_limit(val: float) → None

Set signal rate limit.

参数:: val – signal rate limit.

UIFLOW2:

ToFUnit.start_continuous() → None

Start continuous mode.

UIFLOW2:

ToFUnit.stop_continuous() → None

Stop continuous mode.

UIFLOW2:

ToFUnit.set_address(new_address: int) → None

Set I2C address.

参数:: new_address – new I2C address.

UIFLOW2: