Mini ToF-90° Unit

This is the driver library of Mini ToF-90° Unit, which is used to obtain data from the distance sensor.

Support the following products:

UiFlow2 Example

get distance value

Open the tof90_core2_example.m5f2 project in UiFlow2.

This example gets the distance value of the Mini ToF-90° Unit and displays it on the screen.

UiFlow2 Code Block:

Example output:

None

MicroPython Example

get distance value

This example gets the distance value of the Mini ToF-90° Unit and displays it on the screen.

MicroPython Code Block:

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


title0 = None
label0 = None
label1 = None
i2c0 = None
minitof90_0 = None


def setup():
    global title0, label0, label1, i2c0, minitof90_0

    M5.begin()
    Widgets.fillScreen(0x222222)
    title0 = Widgets.Title(
        "Core2 Mini ToF-90  Example", 3, 0xFFFFFF, 0x0000FF, Widgets.FONTS.DejaVu18
    )
    label0 = Widgets.Label("label0", 2, 110, 1.0, 0xFFFFFF, 0x222222, Widgets.FONTS.DejaVu18)
    label1 = Widgets.Label("label1", -85, 149, 1.0, 0xFFFFFF, 0x222222, Widgets.FONTS.DejaVu18)

    i2c0 = I2C(0, scl=Pin(33), sda=Pin(32), freq=100000)
    minitof90_0 = ToF90Unit(i2c0, 0x29)
    minitof90_0.start_continuous()


def loop():
    global title0, label0, label1, i2c0, minitof90_0
    M5.update()
    if minitof90_0.get_data_ready():
        label0.setText(str((str("Distance:") + str((str((minitof90_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")

Example output:

None

API

ToF90Unit

class unit.tof.ToF90Unit(i2c, address=41)

Bases: VL53L0X

Create an VL53L0X object.

Parameters:

i2c (I2C) – The I2C bus the VL53L0X is connected to.
address (int) – The I2C address of VL53L0X. Default is 0x29.

UiFlow2 Code Block:

MicroPython Code Block:

from unit import ToF90Unit

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

VL53L0X

class driver.vl53l0x.VL53L0X(i2c, address=41, io_timeout_ms=0)

Bases: object

Create an VL53L0X object.

Parameters:

i2c (I2C) – The I2C bus the VL53L0X is connected to.
address (int) – The I2C address of VL53L0X. Default is 0x29.
io_timeout_ms (int) – The timeout for the I/O operations. Default is 0.

MicroPython Code Block:

from driver import VL53L0X

i2c0 = I2C(0, scl=Pin(1), sda=Pin(2), freq=100000)
vl53l0x_0 = VL53L0X(i2c0)

get_measurement_timing_budget()

Get the measurement timing budget in microseconds.

Returns:: The measurement timing budget in microseconds.
Return type:: int

UiFlow2 Code Block:

MicroPython Code Block:

budget_ms = vl53l0x_0.get_measurement_timing_budget()

set_measurement_timing_budget(budget_us)

Set the measurement timing budget in microseconds.

Parameters:: budget_us (int) – The measurement timing budget in microseconds(range 20000 - 200000).
Return type:: None

UiFlow2 Code Block:

MicroPython Code Block:

budget_ms = vl53l0x_0.get_measurement_timing_budget()

get_distance()

Perform a single reading of the range for an object in front of the sensor and return the distance in centimeters.

Returns:: The distance in centimeters.
Return type:: float

MicroPython Code Block:

distance = vl53l0x_0.get_distance()

get_range()

Perform a single reading of the range for an object in front of the sensor and return the distance in millimeters.

Returns:: The distance in millimeters.
Return type:: float

UiFlow2 Code Block:

MicroPython Code Block:

distance = vl53l0x_0.get_range()

get_data_ready()

Get the data ready status of the sensor.

Returns:: The data ready status of the sensor.
Return type:: bool

UiFlow2 Code Block:

MicroPython Code Block:

data_ready = vl53l0x_0.get_data_ready()

is_continuous_mode()

Get the continuous mode status of the sensor.

Returns:: The continuous mode status of the sensor.
Return type:: bool

UiFlow2 Code Block:

MicroPython Code Block:

continuous_mode = vl53l0x_0.is_continuous_mode()

start_continuous()

Set the sensor to continuous mode.

UiFlow2 Code Block:

MicroPython Code Block:

vl53l0x_0.start_continuous()

Return type:: None

stop_continuous()

Set the sensor to single ranging mode.

UiFlow2 Code Block:

MicroPython Code Block:

vl53l0x_0.stop_continuous()

Return type:: None

set_address(new_address=41)

Set a new I2C address to the sensor.

Parameters:: new_address (int) – The 7-bit int that is to be assigned to the VL53L0X sensor.
Return type:: None

UiFlow2 Code Block:

MicroPython Code Block:

vl53l0x_0.set_address(0x2A)