modm API documentation
|
#include <modm/driver/position/vl53l0.hpp>
Classes | |
struct | Data |
struct | TimeOverhead |
Public Typedefs | |
typedef modm::Configuration< RangeStatus_t, RangeErrorCode, 0x0F, 3 > | RangeErrorCode_t |
using | Control_t = modm::FlagsGroup< Start_t, MeasurementSequenceStep_t, InterruptConfig_t, InterruptClear_t, GpioConfig_t, InterruptStatus_t, RangeStatus_t, MSRCConfig_t > |
Public Types | |
enum | Register : uint8_t |
The addresses of the Configuration and Data Registers. | |
enum | Start : uint8_t |
SYSRANGE__START. | |
enum | MeasurementSequenceStep : uint8_t |
SYSTEM__SEQUENCE_CONFIG. | |
enum | InterruptConfig : uint8_t |
SYSTEM__INTERRUPT_CONFIG_GPIO. | |
enum | InterruptClear : uint8_t |
SYSTEM__INTERRUPT_CLEAR. | |
enum | GpioConfig : uint8_t |
enum | InterruptStatus : uint8_t |
RESULT__INTERRUPT_STATUS_GPIO. | |
enum | RangeStatus : uint8_t |
RESULT__RANGE_STATUS. | |
enum | RangeErrorCode : uint8_t |
enum | MSRCConfig : uint8_t |
Public Member Functions | |
MODM_FLAGS8 (Start) | |
MODM_FLAGS8 (MeasurementSequenceStep) | |
MODM_FLAGS8 (InterruptConfig) | |
MODM_FLAGS8 (InterruptClear) | |
MODM_FLAGS8 (GpioConfig) | |
MODM_FLAGS8 (InterruptStatus) | |
MODM_FLAGS8 (RangeStatus) | |
MODM_FLAGS8 (MSRCConfig) | |
Vl53l0 (Data &data, uint8_t address=0x29) | |
Constructor, requires an vl53l0::Data object, sets address to default of 0x29. | |
modm::ResumableResult< bool > | ping () |
modm::ResumableResult< bool > | reset () |
Soft reset of device. | |
modm::ResumableResult< bool > | initialize () |
modm::ResumableResult< bool > | setDeviceAddress (uint8_t address) |
modm::ResumableResult< bool > | readDistance () |
Reads the distance and buffers the result. | |
RangeErrorCode | getRangeError () |
template<typename T > | |
modm::ResumableResult< bool > | updateRegister (Register reg, T setMask, T clearMask=T (0xff)) |
Data & | getData () |
the data object for this sensor. | |
modm::ResumableResult< bool > | setMaxMeasurementTime (uint32_t timeUs) |
uint32_t | getMaxMeasurementTime () |
Get the configured maximum measurement time. | |
void | attachConfigurationHandler (I2c::ConfigurationHandler handler) |
modm::ResumableResult< bool > | read (uint8_t *buffer, std::size_t size) |
Starts a write transaction and waits until finished. | |
void | setAddress (uint8_t address) |
modm::ResumableResult< bool > | write (const uint8_t *buffer, std::size_t size) |
Starts a write transaction and waits until finished. | |
modm::ResumableResult< bool > | writeRead (const uint8_t *writeBuffer, std::size_t writeSize, uint8_t *readBuffer, std::size_t readSize) |
Starts a write-read transaction and waits until finished. | |
Protected Member Functions | |
modm::ResumableResult< ReturnType > resumable | function (...) |
int8_t | getResumableDepth () const |
bool | isResumableRunning () const |
bool | isTransactionRunning () |
modm::ResumableResult< bool > | runTransaction () |
Starts our own transaction and waits until finished. | |
bool | startRead (uint8_t *buffer, std::size_t size) |
Configures the transaction with a read operation and starts it. | |
bool | startTransaction () |
Starts the transaction with our own transaction object. | |
bool | startTransaction (modm::I2cTransaction *transaction) |
Starts the transaction with a separate transaction object. | |
bool | startWrite (const uint8_t *buffer, std::size_t size) |
Configures the transaction with a write operation and starts it. | |
bool | startWriteRead (const uint8_t *writeBuffer, std::size_t writeSize, uint8_t *readBuffer, std::size_t readSize) |
Configures the transaction with a write/read operation and starts it. | |
void | stopResumable () |
Force all resumable functions to stop running at the current nesting level. | |
bool | wasTransactionSuccessful () |
Protected Attributes | |
I2cWriteReadTransaction | transaction |
The class is build for single-shot measurements.
|
strong |
MSRC__CONFIG_CONTROL MSRC = "minimum signal rate check"
|
inheritedinline |
Attaches a configuration handler, which is called before a transaction, whenever the configuration has to be changed.
|
inherited |
Run the resumable function.
You need to implement this method in you subclass yourself.
NestingError
if still running, <=NestingError
if it has finished.
|
inheritedinline |
|
inheritedinline |
true
if a resumable function is running at the current nesting level, else false
|
inheritedinlineprotected |
true
when transaction is busy. modm::ResumableResult<bool> modm::Vl53l0< I2cMaster >::ping | ( | ) |
|
inheritedinline |
Sets a new address of the slave device.
address | the slave address not yet shifted left (address < 128). |
modm::ResumableResult<bool> modm::Vl53l0< I2cMaster >::setDeviceAddress | ( | uint8_t | address | ) |
Set a new I2C address (< 128) for this device. The address is not permanent and must be set again after every device boot.
modm::ResumableResult<bool> modm::Vl53l0< I2cMaster >::setMaxMeasurementTime | ( | uint32_t | timeUs | ) |
Set the maximum measurement time.
Increasing this value will improve the accuracy. The default is ~30ms. ST recommends 2'000'000us = 200ms for high precision.
useful range of values: ~20'000us - 2'000'000us (20ms - 2s)
|
inheritedinlineprotected |
true
when transaction did not return an error.