qmc5883l example driver function

qmc5883l example driver modules More...

Collaboration diagram for qmc5883l example driver function:

Macros
#define	QMC5883L_BASIC_DEFAULT_PERIOD   0x01
	qmc5883l basic example default definition
#define	QMC5883L_BASIC_DEFAULT_POINTER_ROLL_OVER   QMC5883L_BOOL_TRUE
#define	QMC5883L_BASIC_DEFAULT_INTERRUPT   QMC5883L_BOOL_FALSE
#define	QMC5883L_BASIC_DEFAULT_OVER_SAMPLE   QMC5883L_OVER_SAMPLE_512
#define	QMC5883L_BASIC_DEFAULT_FULL_SCALE   QMC5883L_FULL_SCALE_2GAUSS
#define	QMC5883L_BASIC_DEFAULT_OUTPUT_RATE   QMC5883L_OUTPUT_RATE_10HZ

Functions
uint8_t	qmc5883l_basic_init (void)
	basic example init
uint8_t	qmc5883l_basic_deinit (void)
	basic example deinit
uint8_t	qmc5883l_basic_read (float m_gauss[3])
	basic example read

Detailed Description

qmc5883l example driver modules

Macro Definition Documentation

QMC5883L_BASIC_DEFAULT_FULL_SCALE

#define QMC5883L_BASIC_DEFAULT_FULL_SCALE   QMC5883L_FULL_SCALE_2GAUSS

2gauss

Definition at line 60 of file driver_qmc5883l_basic.h.

QMC5883L_BASIC_DEFAULT_INTERRUPT

#define QMC5883L_BASIC_DEFAULT_INTERRUPT   QMC5883L_BOOL_FALSE

disable interrupt

Definition at line 58 of file driver_qmc5883l_basic.h.

QMC5883L_BASIC_DEFAULT_OUTPUT_RATE

#define QMC5883L_BASIC_DEFAULT_OUTPUT_RATE   QMC5883L_OUTPUT_RATE_10HZ

10Hz

Definition at line 61 of file driver_qmc5883l_basic.h.

QMC5883L_BASIC_DEFAULT_OVER_SAMPLE

#define QMC5883L_BASIC_DEFAULT_OVER_SAMPLE   QMC5883L_OVER_SAMPLE_512

512

Definition at line 59 of file driver_qmc5883l_basic.h.

QMC5883L_BASIC_DEFAULT_PERIOD

#define QMC5883L_BASIC_DEFAULT_PERIOD   0x01

qmc5883l basic example default definition

0x01

Definition at line 56 of file driver_qmc5883l_basic.h.

QMC5883L_BASIC_DEFAULT_POINTER_ROLL_OVER

#define QMC5883L_BASIC_DEFAULT_POINTER_ROLL_OVER   QMC5883L_BOOL_TRUE

enable pointer roll over

Definition at line 57 of file driver_qmc5883l_basic.h.

Function Documentation

qmc5883l_basic_deinit()

uint8_t qmc5883l_basic_deinit

(

void

)

basic example deinit

Returns

status code

• 0 success
• 1 deinit failed

Note

none

Definition at line 171 of file driver_qmc5883l_basic.c.

Here is the call graph for this function:

qmc5883l_basic_init()

uint8_t qmc5883l_basic_init

(

void

)

basic example init

Returns

status code

• 0 success
• 1 init failed

Note

none

Definition at line 48 of file driver_qmc5883l_basic.c.

Here is the call graph for this function:

qmc5883l_basic_read()

uint8_t qmc5883l_basic_read

(

float

m_gauss[3]

)

basic example read

Parameters

[out]

*m_gauss

pointer to a converted data buffer

Returns

status code

• 0 success
• 1 read failed

Note

none

Definition at line 151 of file driver_qmc5883l_basic.c.

Here is the call graph for this function: