LibDriver HMC5883L
Loading...
Searching...
No Matches
hmc5883l example driver function
hmc5883l driver function

hmc5883l example driver modules More...

Collaboration diagram for hmc5883l example driver function:

Macros

#define HMC5883L_BASIC_DEFAULT_AVERAGE_SAMPLE   HMC5883L_AVERAGE_SAMPLE_8
 hmc5883l basic example default definition
#define HMC5883L_BASIC_DEFAULT_DATA_OUTPUT_RATE   HMC5883L_DATA_OUTPUT_RATE_15
#define HMC5883L_BASIC_DEFAULT_MODE   HMC5883L_MODE_NORMAL
#define HMC5883L_BASIC_DEFAULT_GAIN   HMC5883L_GAIN_820
#define HMC5883L_SHOT_DEFAULT_AVERAGE_SAMPLE   HMC5883L_AVERAGE_SAMPLE_8
 hmc5883l shot example default definition
#define HMC5883L_SHOT_DEFAULT_DATA_OUTPUT_RATE   HMC5883L_DATA_OUTPUT_RATE_15
#define HMC5883L_SHOT_DEFAULT_MODE   HMC5883L_MODE_NORMAL
#define HMC5883L_SHOT_DEFAULT_GAIN   HMC5883L_GAIN_820

Functions

uint8_t hmc5883l_basic_init (void)
 basic example init
uint8_t hmc5883l_basic_deinit (void)
 basic example deinit
uint8_t hmc5883l_basic_read (float m_gauss[3])
 basic example read
uint8_t hmc5883l_shot_init (void)
 shot example init
uint8_t hmc5883l_shot_deinit (void)
 shot example deinit
uint8_t hmc5883l_shot_read (float m_gauss[3])
 shot example read

Detailed Description

hmc5883l example driver modules

Macro Definition Documentation

◆ HMC5883L_BASIC_DEFAULT_AVERAGE_SAMPLE

#define HMC5883L_BASIC_DEFAULT_AVERAGE_SAMPLE   HMC5883L_AVERAGE_SAMPLE_8

hmc5883l basic example default definition

average 8 sample

Definition at line 57 of file driver_hmc5883l_basic.h.

◆ HMC5883L_BASIC_DEFAULT_DATA_OUTPUT_RATE

#define HMC5883L_BASIC_DEFAULT_DATA_OUTPUT_RATE   HMC5883L_DATA_OUTPUT_RATE_15

15Hz output rate

Definition at line 58 of file driver_hmc5883l_basic.h.

◆ HMC5883L_BASIC_DEFAULT_GAIN

#define HMC5883L_BASIC_DEFAULT_GAIN   HMC5883L_GAIN_820

gain 820

Definition at line 60 of file driver_hmc5883l_basic.h.

◆ HMC5883L_BASIC_DEFAULT_MODE

#define HMC5883L_BASIC_DEFAULT_MODE   HMC5883L_MODE_NORMAL

normal mode

Definition at line 59 of file driver_hmc5883l_basic.h.

◆ HMC5883L_SHOT_DEFAULT_AVERAGE_SAMPLE

#define HMC5883L_SHOT_DEFAULT_AVERAGE_SAMPLE   HMC5883L_AVERAGE_SAMPLE_8

hmc5883l shot example default definition

average 8 sample

Definition at line 55 of file driver_hmc5883l_shot.h.

◆ HMC5883L_SHOT_DEFAULT_DATA_OUTPUT_RATE

#define HMC5883L_SHOT_DEFAULT_DATA_OUTPUT_RATE   HMC5883L_DATA_OUTPUT_RATE_15

15Hz output rate

Definition at line 56 of file driver_hmc5883l_shot.h.

◆ HMC5883L_SHOT_DEFAULT_GAIN

#define HMC5883L_SHOT_DEFAULT_GAIN   HMC5883L_GAIN_820

gain 820

Definition at line 58 of file driver_hmc5883l_shot.h.

◆ HMC5883L_SHOT_DEFAULT_MODE

#define HMC5883L_SHOT_DEFAULT_MODE   HMC5883L_MODE_NORMAL

normal mode

Definition at line 57 of file driver_hmc5883l_shot.h.

Function Documentation

◆ hmc5883l_basic_deinit()

uint8_t hmc5883l_basic_deinit ( void )

basic example deinit

Returns
status code
  • 0 success
  • 1 deinit failed
Note
none

Definition at line 164 of file driver_hmc5883l_basic.c.

Here is the call graph for this function:

◆ hmc5883l_basic_init()

uint8_t hmc5883l_basic_init ( void )

basic example init

Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 49 of file driver_hmc5883l_basic.c.

Here is the call graph for this function:

◆ hmc5883l_basic_read()

uint8_t hmc5883l_basic_read ( float m_gauss[3])

basic example read

Parameters
[out]*m_gausspointer to a converted data buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 142 of file driver_hmc5883l_basic.c.

Here is the call graph for this function:

◆ hmc5883l_shot_deinit()

uint8_t hmc5883l_shot_deinit ( void )

shot example deinit

Returns
status code
  • 0 success
  • 1 deinit failed
Note
none

Definition at line 154 of file driver_hmc5883l_shot.c.

Here is the call graph for this function:

◆ hmc5883l_shot_init()

uint8_t hmc5883l_shot_init ( void )

shot example init

Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 49 of file driver_hmc5883l_shot.c.

Here is the call graph for this function:

◆ hmc5883l_shot_read()

uint8_t hmc5883l_shot_read ( float m_gauss[3])

shot example read

Parameters
[out]*m_gausspointer to a converted data buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 132 of file driver_hmc5883l_shot.c.

Here is the call graph for this function: