m5::unit::UnitRCWL9620 Class Reference

An ultrasonic distance measuring sensor unit. More...

#include <unit_RCWL9620.hpp>

Inheritance diagram for m5::unit::UnitRCWL9620:

Classes
struct	config_t
	Settings for begin. More...
class	Interface
	@cond0 More...

Public Member Functions
	UnitRCWL9620 (const uint8_t addr=DEFAULT_ADDRESS)
virtual bool	begin () override
virtual void	update (const bool force=false) override
Settings for begin
config_t	config ()
	Gets the configration.
void	config (const config_t &cfg)
	Set the configration.
Measurement data by periodic
float	distance () const
	Oldest distance (mm)
Periodic measurement
bool	startPeriodicMeasurement (const uint32_t interval)
	Start periodic measurement.
bool	stopPeriodicMeasurement ()
	Stop periodic measurement.
Single shot measurement
bool	measureSingleshot (rcwl9620::Data &d)
	Measurement single shot.

Protected Member Functions
bool	request_measurement ()
bool	read_measurement (rcwl9620::Data &d, bool &timeouted)
bool	start_periodic_measurement (const uint32_t interval)
bool	stop_periodic_measurement ()
Interface *	interface ()
	M5_UNIT_COMPONENT_PERIODIC_MEASUREMENT_ADAPTER_HPP_BUILDER (UnitRCWL9620, rcwl9620::Data)
virtual uint32_t	minimum_interval () const

Protected Attributes
std::unique_ptr< m5::container::CircularBuffer< rcwl9620::Data > >	_data {}

Detailed Description

An ultrasonic distance measuring sensor unit.

Member Function Documentation

measureSingleshot()

bool m5::unit::UnitRCWL9620::measureSingleshot

(

rcwl9620::Data &

d

)

Measurement single shot.

Parameters

[out]

data

Measuerd data

Warning

During periodic detection runs, an error is returned

Blocked until measurement is complete

startPeriodicMeasurement()

bool m5::unit::UnitRCWL9620::startPeriodicMeasurement ( const uint32_t interval )

inline

Start periodic measurement.

Parameters

interval

Measurement interval (ms)

Returns

True if successful

stopPeriodicMeasurement()

bool m5::unit::UnitRCWL9620::stopPeriodicMeasurement ( )

inline

Stop periodic measurement.

Returns

True if successful