Hmc5883l Class Reference

Driver for HMC5883L magnetometer. More...

#include <hmc5883l.hpp>

Inheritance diagram for Hmc5883l:

Collaboration diagram for Hmc5883l:

List of all members.

Public Member Functions
	Hmc5883l (I2c &i2c)
	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 > &	mag (void) const
	Get X, Y and Z components of magnetic field.
const float &	mag_X (void) const
	Get X component of magnetic field.
const float &	mag_Y (void) const
	Get Y component of magnetic field.
const float &	mag_Z (void) const
	Get Z component of magnetic field.
const float &	temperature (void) const
	Get sensor temperature.

---

Detailed Description

Driver for HMC5883L magnetometer.

This driver does not support temperature

---

Constructor & Destructor Documentation

Hmc5883l::Hmc5883l

(

I2c &

i2c

)

Constructor.

Parameters:

i2c	Reference to I2C device

---

Member Function Documentation

bool Hmc5883l::init

(

void

)

[virtual]

Initialise the sensor.

Returns:

Success

Implements Magnetometer.

Here is the call graph for this function:

Here is the caller graph for this function:

const float & Hmc5883l::last_update_us

(

void

)

const [virtual]

Get last update time in microseconds.

Returns:

Update time

Implements Magnetometer.

const std::array< float, 3 > & Hmc5883l::mag

(

void

)

const [virtual]

Get X, Y and Z components of magnetic field.

This is raw data, so X, Y and Z components are biased, not scaled, and given in the sensor frame (not in the UAV frame). Use an Imu object to handle bias removal, scaling and axis rotations

Returns:

Value

Implements Magnetometer.

const float & Hmc5883l::mag_X

(

void

)

const [virtual]

Get X component of magnetic field.

This is raw data, so X, Y and Z components are biased, not scaled, and given in the sensor frame (not in the UAV frame). Use an Imu object to handle bias removal, scaling and axis rotations

Returns:

Value

Implements Magnetometer.

const float & Hmc5883l::mag_Y

(

void

)

const [virtual]

Get Y component of magnetic field.

This is raw data, so X, Y and Z components are biased, not scaled, and given in the sensor frame (not in the UAV frame). Use an Imu object to handle bias removal, scaling and axis rotations

Returns:

Value

Implements Magnetometer.

const float & Hmc5883l::mag_Z

(

void

)

const [virtual]

Get Z component of magnetic field.

This is raw data, so X, Y and Z components are biased, not scaled, and given in the sensor frame (not in the UAV frame). Use an Imu object to handle bias removal, scaling and axis rotations

Returns:

Value

Implements Magnetometer.

const float & Hmc5883l::temperature

(

void

)

const [virtual]

Get sensor temperature.

Returns:

Value

Implements Magnetometer.

bool Hmc5883l::update

(

void

)

[virtual]

Main update function Reads new values from sensor.

Returns:

Success

Implements Magnetometer.

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• /home/travis/build/lis-epfl/MAVRIC_Library/drivers/hmc5883l.hpp
• /home/travis/build/lis-epfl/MAVRIC_Library/drivers/hmc5883l.cpp