iNEMO inertial module: 3D accelerometer and 3D gyroscope.

Dependencies:   X_NUCLEO_COMMON ST_INTERFACES

Dependents:   X_NUCLEO_IKS01A3 X_NUCLEO_IKS01A3

Embed: (wiki syntax)

« Back to documentation index

LSM6DSO_common

LSM6DSO_common
[LSM6DSO]

This section groups common usefull functions. More...

Functions

int32_t lsm6dso_odr_cal_reg_set (lsm6dso_ctx_t *ctx, uint8_t val)
 Difference in percentage of the effective ODR(and timestamp rate) with respect to the typical.
int32_t lsm6dso_odr_cal_reg_get (lsm6dso_ctx_t *ctx, uint8_t *val)
 Difference in percentage of the effective ODR(and timestamp rate) with respect to the typical.
int32_t lsm6dso_mem_bank_set (lsm6dso_ctx_t *ctx, lsm6dso_reg_access_t val)
 Enable access to the embedded functions/sensor hub configuration registers.
int32_t lsm6dso_mem_bank_get (lsm6dso_ctx_t *ctx, lsm6dso_reg_access_t *val)
 Enable access to the embedded functions/sensor hub configuration registers.
int32_t lsm6dso_ln_pg_write_byte (lsm6dso_ctx_t *ctx, uint16_t address, uint8_t *val)
 Write a line(byte) in a page.
int32_t lsm6dso_ln_pg_write (lsm6dso_ctx_t *ctx, uint16_t address, uint8_t *buf, uint8_t len)
 Write buffer in a page.
int32_t lsm6dso_ln_pg_read_byte (lsm6dso_ctx_t *ctx, uint16_t address, uint8_t *val)
 Read a line(byte) in a page.
int32_t lsm6dso_data_ready_mode_set (lsm6dso_ctx_t *ctx, lsm6dso_dataready_pulsed_t val)
 Data-ready pulsed / letched mode.
int32_t lsm6dso_data_ready_mode_get (lsm6dso_ctx_t *ctx, lsm6dso_dataready_pulsed_t *val)
 Data-ready pulsed / letched mode.
int32_t lsm6dso_device_id_get (lsm6dso_ctx_t *ctx, uint8_t *buff)
 Device "Who am I".
int32_t lsm6dso_reset_set (lsm6dso_ctx_t *ctx, uint8_t val)
 Software reset.
int32_t lsm6dso_reset_get (lsm6dso_ctx_t *ctx, uint8_t *val)
 Software reset.
int32_t lsm6dso_auto_increment_set (lsm6dso_ctx_t *ctx, uint8_t val)
 Register address automatically incremented during a multiple byte access with a serial interface.
int32_t lsm6dso_auto_increment_get (lsm6dso_ctx_t *ctx, uint8_t *val)
 Register address automatically incremented during a multiple byte access with a serial interface.
int32_t lsm6dso_boot_set (lsm6dso_ctx_t *ctx, uint8_t val)
 Reboot memory content.
int32_t lsm6dso_boot_get (lsm6dso_ctx_t *ctx, uint8_t *val)
 Reboot memory content.
int32_t lsm6dso_xl_self_test_set (lsm6dso_ctx_t *ctx, lsm6dso_st_xl_t val)
 Linear acceleration sensor self-test enable.
int32_t lsm6dso_xl_self_test_get (lsm6dso_ctx_t *ctx, lsm6dso_st_xl_t *val)
 Linear acceleration sensor self-test enable.
int32_t lsm6dso_gy_self_test_set (lsm6dso_ctx_t *ctx, lsm6dso_st_g_t val)
 Angular rate sensor self-test enable.
int32_t lsm6dso_gy_self_test_get (lsm6dso_ctx_t *ctx, lsm6dso_st_g_t *val)
 Angular rate sensor self-test enable.

Detailed Description

This section groups common usefull functions.


Function Documentation

int32_t lsm6dso_auto_increment_get ( lsm6dso_ctx_t *  ctx,
uint8_t *  val 
)

Register address automatically incremented during a multiple byte access with a serial interface.

[get]

Parameters:
ctxread / write interface definitions
valchange the values of if_inc in reg CTRL3_C

Definition at line 1709 of file lsm6dso_reg.c.

int32_t lsm6dso_auto_increment_set ( lsm6dso_ctx_t *  ctx,
uint8_t  val 
)

Register address automatically incremented during a multiple byte access with a serial interface.

[set]

Parameters:
ctxread / write interface definitions
valchange the values of if_inc in reg CTRL3_C

Definition at line 1688 of file lsm6dso_reg.c.

int32_t lsm6dso_boot_get ( lsm6dso_ctx_t *  ctx,
uint8_t *  val 
)

Reboot memory content.

Reload the calibration parameters.[get]

Parameters:
ctxread / write interface definitions
valchange the values of boot in reg CTRL3_C

Definition at line 1747 of file lsm6dso_reg.c.

int32_t lsm6dso_boot_set ( lsm6dso_ctx_t *  ctx,
uint8_t  val 
)

Reboot memory content.

Reload the calibration parameters.[set]

Parameters:
ctxread / write interface definitions
valchange the values of boot in reg CTRL3_C

Definition at line 1727 of file lsm6dso_reg.c.

int32_t lsm6dso_data_ready_mode_get ( lsm6dso_ctx_t *  ctx,
lsm6dso_dataready_pulsed_t *  val 
)

Data-ready pulsed / letched mode.

[get]

Parameters:
ctxread / write interface definitions
valGet the values of dataready_pulsed in reg COUNTER_BDR_REG1

Definition at line 1605 of file lsm6dso_reg.c.

int32_t lsm6dso_data_ready_mode_set ( lsm6dso_ctx_t *  ctx,
lsm6dso_dataready_pulsed_t  val 
)

Data-ready pulsed / letched mode.

[set]

Parameters:
ctxread / write interface definitions
valchange the values of dataready_pulsed in reg COUNTER_BDR_REG1

Definition at line 1582 of file lsm6dso_reg.c.

int32_t lsm6dso_device_id_get ( lsm6dso_ctx_t *  ctx,
uint8_t *  buff 
)

Device "Who am I".

[get]

Parameters:
ctxread / write interface definitions
buffbuffer that stores data read

Definition at line 1633 of file lsm6dso_reg.c.

int32_t lsm6dso_gy_self_test_get ( lsm6dso_ctx_t *  ctx,
lsm6dso_st_g_t *  val 
)

Angular rate sensor self-test enable.

[get]

Parameters:
ctxread / write interface definitions
valGet the values of st_g in reg CTRL5_C

Definition at line 1835 of file lsm6dso_reg.c.

int32_t lsm6dso_gy_self_test_set ( lsm6dso_ctx_t *  ctx,
lsm6dso_st_g_t  val 
)

Angular rate sensor self-test enable.

[set]

Parameters:
ctxread / write interface definitions
valchange the values of st_g in reg CTRL5_C

Definition at line 1815 of file lsm6dso_reg.c.

int32_t lsm6dso_ln_pg_read_byte ( lsm6dso_ctx_t *  ctx,
uint16_t  address,
uint8_t *  val 
)

Read a line(byte) in a page.

[get]

Parameters:
ctxread / write interface definitions
uint8_taddress: page line address
valread value

Definition at line 1524 of file lsm6dso_reg.c.

int32_t lsm6dso_ln_pg_write ( lsm6dso_ctx_t *  ctx,
uint16_t  address,
uint8_t *  buf,
uint8_t  len 
)

Write buffer in a page.

[set]

Parameters:
ctxread / write interface definitions
uint8_taddress: page line address
uint8_t*buf: buffer to write
uint8_tlen: buffer len

Definition at line 1449 of file lsm6dso_reg.c.

int32_t lsm6dso_ln_pg_write_byte ( lsm6dso_ctx_t *  ctx,
uint16_t  address,
uint8_t *  val 
)

Write a line(byte) in a page.

[set]

Parameters:
ctxread / write interface definitions
uint8_taddress: page line address
valvalue to write

Definition at line 1392 of file lsm6dso_reg.c.

int32_t lsm6dso_mem_bank_get ( lsm6dso_ctx_t *  ctx,
lsm6dso_reg_access_t *  val 
)

Enable access to the embedded functions/sensor hub configuration registers.

[get]

Parameters:
ctxread / write interface definitions
valGet the values of reg_access in reg FUNC_CFG_ACCESS

Definition at line 1361 of file lsm6dso_reg.c.

int32_t lsm6dso_mem_bank_set ( lsm6dso_ctx_t *  ctx,
lsm6dso_reg_access_t  val 
)

Enable access to the embedded functions/sensor hub configuration registers.

[set]

Parameters:
ctxread / write interface definitions
valchange the values of reg_access in reg FUNC_CFG_ACCESS

Definition at line 1339 of file lsm6dso_reg.c.

int32_t lsm6dso_odr_cal_reg_get ( lsm6dso_ctx_t *  ctx,
uint8_t *  val 
)

Difference in percentage of the effective ODR(and timestamp rate) with respect to the typical.

Step: 0.15%. 8-bit format, 2's complement.[get]

Parameters:
ctxread / write interface definitions
valchange the values of freq_fine in reg INTERNAL_FREQ_FINE

Definition at line 1318 of file lsm6dso_reg.c.

int32_t lsm6dso_odr_cal_reg_set ( lsm6dso_ctx_t *  ctx,
uint8_t  val 
)

Difference in percentage of the effective ODR(and timestamp rate) with respect to the typical.

Step: 0.15%. 8-bit format, 2's complement.[set]

Parameters:
ctxread / write interface definitions
valchange the values of freq_fine in reg INTERNAL_FREQ_FINE

Definition at line 1295 of file lsm6dso_reg.c.

int32_t lsm6dso_reset_get ( lsm6dso_ctx_t *  ctx,
uint8_t *  val 
)

Software reset.

Restore the default values in user registers.[get]

Parameters:
ctxread / write interface definitions
valchange the values of sw_reset in reg CTRL3_C

Definition at line 1669 of file lsm6dso_reg.c.

int32_t lsm6dso_reset_set ( lsm6dso_ctx_t *  ctx,
uint8_t  val 
)

Software reset.

Restore the default values in user registers[set]

Parameters:
ctxread / write interface definitions
valchange the values of sw_reset in reg CTRL3_C

Definition at line 1648 of file lsm6dso_reg.c.

int32_t lsm6dso_xl_self_test_get ( lsm6dso_ctx_t *  ctx,
lsm6dso_st_xl_t *  val 
)

Linear acceleration sensor self-test enable.

[get]

Parameters:
ctxread / write interface definitions
valGet the values of st_xl in reg CTRL5_C

Definition at line 1785 of file lsm6dso_reg.c.

int32_t lsm6dso_xl_self_test_set ( lsm6dso_ctx_t *  ctx,
lsm6dso_st_xl_t  val 
)

Linear acceleration sensor self-test enable.

[set]

Parameters:
ctxread / write interface definitions
valchange the values of st_xl in reg CTRL5_C

Definition at line 1765 of file lsm6dso_reg.c.