Skip to content

tof.md

Latest commit

 

History

History
79 lines (61 loc) · 2.49 KB

tof.md

File metadata and controls

79 lines (61 loc) · 2.49 KB

ToF API

M5Stack documentation: Chain ToF

TypeScript Exports

import M5ChainToF, {
	MeasurementMode,
	MeasurementCompletionFlag,
	MeasurementStatus,
	type ToFConfiguration,
	type ToFConfigurationSnapshot,
} from "m5chainToF";

These exports can also be used as TypeScript types.

Export Description
M5ChainToF Default class export.
MeasurementMode Measurement mode values: STOP = 0, SINGLE = 1, CONTINUOUS = 2.
MeasurementStatus Measurement status values: IDLE = 0, MEASURING = 1.
MeasurementCompletionFlag Completion flag values: INCOMPLETE = 0, COMPLETE = 1.
ToFConfiguration Type accepted by configure().
ToFConfigurationSnapshot Type returned by readConfiguration().

Capabilities

  • Common device API
  • LED API
  • Sample API

Usage

import M5ChainToF, { MeasurementMode } from "m5chainToF";

if (device.type === M5ChainToF.DEVICE_TYPE) {
	const tof = device as M5ChainToF;

	await tof.setLedColor(80, 80, 255);
	await tof.configure({
		tof: {
			measurementTime: 50,
			measurementMode: MeasurementMode.CONTINUOUS,
		},
	});

	tof.onSample = function () {
		const sample = this.sample();
		trace(`distance=${sample}mm\n`);
	};
}

Device-specific Methods

Method Description
await device.configure({ tof }) Applies ToF configuration.
await device.readConfiguration() Reads ToF configuration from the device.
await device.getDistance() Reads measured distance in millimeters.
await device.getMeasurementDistance() Alias for getDistance().
await device.getMeasurementStatus() Reads measurement status as a MeasurementStatus value.
await device.getMeasurementCompletionFlag() Reads completion flag as MeasurementCompletionFlag.INCOMPLETE (0) or MeasurementCompletionFlag.COMPLETE (1).
await device.isMeasurementComplete() Returns true when completion flag is MeasurementCompletionFlag.COMPLETE (1).
await device.triggerMeasurement() Starts a measurement by setting status to measuring.

Configuration

Option Description
tof.measurementTime Sets measurement time. Range: 20 to 200 ms.
tof.measurementMode Sets mode. Use MeasurementMode.STOP (0), MeasurementMode.SINGLE (1), or MeasurementMode.CONTINUOUS (2).

Sample Value

onSample is dispatched on every poll. sample() returns the measured distance in millimeters.