MAV'RIC
Public Member Functions
Sonar_i2cxl Class Reference
Inheritance diagram for Sonar_i2cxl:
Inheritance graph
[legend]
Collaboration diagram for Sonar_i2cxl:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 Sonar_i2cxl (I2c &i2c, sonar_i2cxl_conf_t config=sonar_i2cxl_default_config())
 Constructor.
bool init (void)
 Initialise the sensor.
bool update (void)
 Main update function Reads new values from sensor.
const float & last_update_us (void) const
 Get last update time in microseconds.
const std::array< float, 3 > & orientation_bf (void) const
 Get sensor orientation relative to the platform (in body frame)
const float & distance (void) const
 Get latest distance measure.
const float & velocity (void) const
 Get velocity estimate from consecutive measurements.
const bool & healthy (void) const
 Indicates whether the measurements can be trusted.

Constructor & Destructor Documentation

Sonar_i2cxl::Sonar_i2cxl ( I2c i2c,
sonar_i2cxl_conf_t  config = sonar_i2cxl_default_config() 
)

Constructor.

Parameters:
i2cReference to I2C device
configConfiguration

Member Function Documentation

const float & Sonar_i2cxl::distance ( void  ) const [virtual]

Get latest distance measure.

Returns:
Value

Implements Sonar.

const bool & Sonar_i2cxl::healthy ( void  ) const [virtual]

Indicates whether the measurements can be trusted.

Returns:
Value

Implements Sonar.

bool Sonar_i2cxl::init ( void  ) [virtual]

Initialise the sensor.

Returns:
Success

Implements Sonar.

Here is the call graph for this function:

Here is the caller graph for this function:

const float & Sonar_i2cxl::last_update_us ( void  ) const [virtual]

Get last update time in microseconds.

Returns:
Update time

Implements Sonar.

const std::array< float, 3 > & Sonar_i2cxl::orientation_bf ( void  ) const [virtual]

Get sensor orientation relative to the platform (in body frame)

Returns:
quaternion

Implements Sonar.

bool Sonar_i2cxl::update ( void  ) [virtual]

Main update function Reads new values from sensor.

Returns:
Success

Implements Sonar.

const float & Sonar_i2cxl::velocity ( void  ) const [virtual]

Get velocity estimate from consecutive measurements.

Returns:
Value

Implements Sonar.


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines