mag3110 example driver function

mag3110 example driver modules More...

Collaboration diagram for mag3110 example driver function:

Macros
#define	MAG3110_BASIC_DEFAULT_OFFSET   0.0f
	mag3110 basic example default definition
#define	MAG3110_BASIC_DEFAULT_DISABLE_OFFSET_CORRECTION   MAG3110_BOOL_TRUE
#define	MAG3110_BASIC_DEFAULT_RATE_OVER_SAMPLE   MAG3110_RATE_10HZ_OVER_SAMPLE_128
#define	MAG3110_BASIC_DEFAULT_FAST_READ   MAG3110_BOOL_FALSE
#define	MAG3110_BASIC_DEFAULT_TRIGGER_MODE   MAG3110_BOOL_FALSE
#define	MAG3110_BASIC_DEFAULT_AUTO_RESET   MAG3110_BOOL_FALSE

Functions
uint8_t	mag3110_basic_init (void)
	basic example init
uint8_t	mag3110_basic_deinit (void)
	basic example deinit
uint8_t	mag3110_basic_read (float ut[3])
	basic example read

Detailed Description

mag3110 example driver modules

Macro Definition Documentation

MAG3110_BASIC_DEFAULT_AUTO_RESET

#define MAG3110_BASIC_DEFAULT_AUTO_RESET   MAG3110_BOOL_FALSE

disable

Definition at line 61 of file driver_mag3110_basic.h.

MAG3110_BASIC_DEFAULT_DISABLE_OFFSET_CORRECTION

#define MAG3110_BASIC_DEFAULT_DISABLE_OFFSET_CORRECTION   MAG3110_BOOL_TRUE

disable offset correction

Definition at line 57 of file driver_mag3110_basic.h.

MAG3110_BASIC_DEFAULT_FAST_READ

#define MAG3110_BASIC_DEFAULT_FAST_READ   MAG3110_BOOL_FALSE

disable

Definition at line 59 of file driver_mag3110_basic.h.

MAG3110_BASIC_DEFAULT_OFFSET

#define MAG3110_BASIC_DEFAULT_OFFSET   0.0f

mag3110 basic example default definition

0

Definition at line 56 of file driver_mag3110_basic.h.

MAG3110_BASIC_DEFAULT_RATE_OVER_SAMPLE

#define MAG3110_BASIC_DEFAULT_RATE_OVER_SAMPLE   MAG3110_RATE_10HZ_OVER_SAMPLE_128

10hz, 128 over sample

Definition at line 58 of file driver_mag3110_basic.h.

MAG3110_BASIC_DEFAULT_TRIGGER_MODE

#define MAG3110_BASIC_DEFAULT_TRIGGER_MODE   MAG3110_BOOL_FALSE

disable

Definition at line 60 of file driver_mag3110_basic.h.

Function Documentation

mag3110_basic_deinit()

uint8_t mag3110_basic_deinit

(

void

)

basic example deinit

Returns

status code

• 0 success
• 1 deinit failed

Note

none

Definition at line 202 of file driver_mag3110_basic.c.

Here is the call graph for this function:

mag3110_basic_init()

uint8_t mag3110_basic_init

(

void

)

basic example init

Returns

status code

• 0 success
• 1 init failed

Note

none

Definition at line 48 of file driver_mag3110_basic.c.

Here is the call graph for this function:

mag3110_basic_read()

uint8_t mag3110_basic_read

(

float

ut[3]

)

basic example read

Parameters

[out]

*ut

pointer to a converted data buffer

Returns

status code

• 0 success
• 1 read failed

Note

none

Definition at line 182 of file driver_mag3110_basic.c.

Here is the call graph for this function: