ToF Unit

Support the following products:

class ToFUnit

Constructors

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

Create a DLight object.

Parameters:

• 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.

Returns:

distance in millimeters.

UIFLOW2:

ToFUnit.get_data_ready() → bool

Get data ready status.

Returns:

data ready status.

UIFLOW2:

ToFUnit.get_range() → int

Get distance in millimeters.

Returns:

distance in millimeters.

UIFLOW2:

ToFUnit.is_continuous_mode() → bool

Get continuous mode status.

Returns:

continuous mode status.

UIFLOW2:

ToFUnit.get_measurement_timing_budget() → int

Get measurement timing budget. The budget is in microseconds.

Returns:

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.

Parameters:

budget_us – measurement timing budget in microseconds.

UIFLOW2:

ToFUnit.get_signal_rate_limit() → float

Get signal rate limit.

Returns:

signal rate limit.

UIFLOW2:

ToFUnit.set_signal_rate_limit(val: float) → None

Set signal rate limit.

Parameters:

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.

Parameters:

new_address – new I2C address.

UIFLOW2: