ST / LIS2MDL

3-axis MEMS ultra low power magnetometer

Dependencies:   X_NUCLEO_COMMON ST_INTERFACES

Dependents:   X_NUCLEO_IKS01A3 X_NUCLEO_IKS01A3

Embed: (wiki syntax)

« Back to documentation index

LIS2MDL_interrupts
Functions

LIS2MDL_interrupts
[LIS2MDL]

This section group all the functions that manage interrupts. More...

Functions

int32_t lis2mdl_offset_int_conf_set (lis2mdl_ctx_t *ctx, lis2mdl_int_on_dataoff_t val)
 The interrupt block recognition checks data after/before the hard-iron correction to discover the interrupt.
int32_t lis2mdl_offset_int_conf_get (lis2mdl_ctx_t *ctx, lis2mdl_int_on_dataoff_t *val)
 The interrupt block recognition checks data after/before the hard-iron correction to discover the interrupt.
int32_t lis2mdl_drdy_on_pin_set (lis2mdl_ctx_t *ctx, uint8_t val)
 Data-ready signal on INT_DRDY pin.
int32_t lis2mdl_drdy_on_pin_get (lis2mdl_ctx_t *ctx, uint8_t *val)
 Data-ready signal on INT_DRDY pin.
int32_t lis2mdl_int_on_pin_set (lis2mdl_ctx_t *ctx, uint8_t val)
 Interrupt signal on INT_DRDY pin.
int32_t lis2mdl_int_on_pin_get (lis2mdl_ctx_t *ctx, uint8_t *val)
 Interrupt signal on INT_DRDY pin.
int32_t lis2mdl_int_gen_conf_set (lis2mdl_ctx_t *ctx, lis2mdl_int_crtl_reg_t *val)
 Interrupt generator configuration register.
int32_t lis2mdl_int_gen_conf_get (lis2mdl_ctx_t *ctx, lis2mdl_int_crtl_reg_t *val)
 Interrupt generator configuration register.
int32_t lis2mdl_int_gen_source_get (lis2mdl_ctx_t *ctx, lis2mdl_int_source_reg_t *val)
 Interrupt generator source register.
int32_t lis2mdl_int_gen_treshold_set (lis2mdl_ctx_t *ctx, uint8_t *buff)
 User-defined threshold value for xl interrupt event on generator.
int32_t lis2mdl_int_gen_treshold_get (lis2mdl_ctx_t *ctx, uint8_t *buff)
 User-defined threshold value for xl interrupt event on generator.

Detailed Description

This section group all the functions that manage interrupts.

Function Documentation

int32_t lis2mdl_drdy_on_pin_get ( lis2mdl_ctx_t *  ctx,
uint8_t *  val 
)

Data-ready signal on INT_DRDY pin.

[get]

Parameters:
ctxread / write interface definitions.(ptr)
valchange the values of drdy_on_pin in reg CFG_REG_C.(ptr)
Return values:
interfacestatus.(MANDATORY: return 0 -> no Error)

Definition at line 952 of file lis2mdl_reg.c.

int32_t lis2mdl_drdy_on_pin_set ( lis2mdl_ctx_t *  ctx,
uint8_t  val 
)

Data-ready signal on INT_DRDY pin.

[set]

Parameters:
ctxread / write interface definitions.(ptr)
valchange the values of drdy_on_pin in reg CFG_REG_C
Return values:
interfacestatus.(MANDATORY: return 0 -> no Error)

Definition at line 929 of file lis2mdl_reg.c.

int32_t lis2mdl_int_gen_conf_get ( lis2mdl_ctx_t *  ctx,
lis2mdl_int_crtl_reg_t *  val 
)

Interrupt generator configuration register.

[get]

Parameters:
ctxread / write interface definitions.(ptr)
valregisters INT_CRTL_REG.(ptr)
Return values:
interfacestatus.(MANDATORY: return 0 -> no Error)

Definition at line 1029 of file lis2mdl_reg.c.

int32_t lis2mdl_int_gen_conf_set ( lis2mdl_ctx_t *  ctx,
lis2mdl_int_crtl_reg_t *  val 
)

Interrupt generator configuration register.

[set]

Parameters:
ctxread / write interface definitions.(ptr)
valregisters INT_CRTL_REG.(ptr)
Return values:
interfacestatus.(MANDATORY: return 0 -> no Error)

Definition at line 1013 of file lis2mdl_reg.c.

int32_t lis2mdl_int_gen_source_get ( lis2mdl_ctx_t *  ctx,
lis2mdl_int_source_reg_t *  val 
)

Interrupt generator source register.

[get]

Parameters:
ctxread / write interface definitions.(ptr)
valregisters INT_SOURCE_REG.(ptr)
Return values:
interfacestatus.(MANDATORY: return 0 -> no Error)

Definition at line 1045 of file lis2mdl_reg.c.

int32_t lis2mdl_int_gen_treshold_get ( lis2mdl_ctx_t *  ctx,
uint8_t *  buff 
)

User-defined threshold value for xl interrupt event on generator.

Data format is the same of output data raw: two’s complement with 1LSb = 1.5mG.[get]

Parameters:
ctxread / write interface definitions.(ptr)
buffthat stores data read
Return values:
interfacestatus.(MANDATORY: return 0 -> no Error)

Definition at line 1080 of file lis2mdl_reg.c.

int32_t lis2mdl_int_gen_treshold_set ( lis2mdl_ctx_t *  ctx,
uint8_t *  buff 
)

User-defined threshold value for xl interrupt event on generator.

Data format is the same of output data raw: two’s complement with 1LSb = 1.5mG.[set]

Parameters:
ctxread / write interface definitions.(ptr)
buffthat contains data to write
Return values:
interfacestatus.(MANDATORY: return 0 -> no Error)

Definition at line 1063 of file lis2mdl_reg.c.

int32_t lis2mdl_int_on_pin_get ( lis2mdl_ctx_t *  ctx,
uint8_t *  val 
)

Interrupt signal on INT_DRDY pin.

[get]

Parameters:
ctxread / write interface definitions.(ptr)
valchange the values of int_on_pin in reg CFG_REG_C.(ptr)
Return values:
interfacestatus.(MANDATORY: return 0 -> no Error)

Definition at line 994 of file lis2mdl_reg.c.

int32_t lis2mdl_int_on_pin_set ( lis2mdl_ctx_t *  ctx,
uint8_t  val 
)

Interrupt signal on INT_DRDY pin.

[set]

Parameters:
ctxread / write interface definitions.(ptr)
valchange the values of int_on_pin in reg CFG_REG_C
Return values:
interfacestatus.(MANDATORY: return 0 -> no Error)

Definition at line 971 of file lis2mdl_reg.c.

int32_t lis2mdl_offset_int_conf_get ( lis2mdl_ctx_t *  ctx,
lis2mdl_int_on_dataoff_t *  val 
)

The interrupt block recognition checks data after/before the hard-iron correction to discover the interrupt.

[get]

Parameters:
ctxread / write interface definitions.(ptr)
valGet the values of int_on_dataoff in reg CFG_REG_B.(ptr)
Return values:
interfacestatus.(MANDATORY: return 0 -> no Error)

Definition at line 900 of file lis2mdl_reg.c.

int32_t lis2mdl_offset_int_conf_set ( lis2mdl_ctx_t *  ctx,
lis2mdl_int_on_dataoff_t  val 
)

The interrupt block recognition checks data after/before the hard-iron correction to discover the interrupt.

[set]

Parameters:
ctxread / write interface definitions.(ptr)
valchange the values of int_on_dataoff in reg CFG_REG_B
Return values:
interfacestatus.(MANDATORY: return 0 -> no Error)

Definition at line 875 of file lis2mdl_reg.c.

Generated on Tue Jul 12 2022 20:53:15 by  doxygen 1.7.2