time_of_flight.hpp File Reference

#include <driver/driver.hpp>
#include <inplace_function/inplace_function.hpp>
#include <type_safe/optional.hpp>

Include dependency graph for time_of_flight.hpp:

This graph shows which files directly or indirectly include this file:

Classes
class	embvm::tof::sensor
	This class defines common time-of-flight (ToF) sensor interfaces. More...

Namespaces
	embvm
	Embedded framework core interfaces, classes, and definitions.
	embvm::tof
	Definitions, functions, and classes related to Time-of-Flight sensors.

Typedefs
using	embvm::tof::distance_t = uint16_t
	Representation for the ToF range result in mm. More...
using	embvm::tof::cb_t = stdext::inplace_function< void(distance_t)>
	Alias for the read() callback function. More...

Enumerations
enum	embvm::tof::mode { embvm::tof::mode::defaultRange = 0, embvm::tof::mode::shortRange, embvm::tof::mode::medRange, embvm::tof::mode::longRange }
	ToF ranging mode options. More...
enum	embvm::tof::status {   embvm::tof::status::ok = 0, embvm::tof::status::noChange, embvm::tof::status::notReady, embvm::tof::status::rangeValidMinRangeClipped,   embvm::tof::status::rangeValidMergedPulse, embvm::tof::status::rangeInvalid, embvm::tof::status::sigmaError, embvm::tof::status::signalError,   embvm::tof::status::outOfBoundsError, embvm::tof::status::hardwareError, embvm::tof::status::processingError, embvm::tof::status::crosstalkSignalError,   embvm::tof::status::invalidRoi, embvm::tof::status::unknown }

Variables
static const distance_t	embvm::tof::INVALID_RANGE = UINT16_MAX
	Representation for an invalid range result. More...