ST / LSM6DSOX

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   X_NUCLEO_COMMON ST_INTERFACES

Embed: (wiki syntax)

« Back to documentation index

LSM6DSOX_tap_generator
Functions

LSM6DSOX_tap_generator

This section groups all the functions that manage the tap and double tap event generation. More...

Functions

int32_t lsm6dsox_tap_detection_on_z_set (lsm6dsox_ctx_t *ctx, uint8_t val)
 Enable Z direction in tap recognition.
int32_t lsm6dsox_tap_detection_on_z_get (lsm6dsox_ctx_t *ctx, uint8_t *val)
 Enable Z direction in tap recognition.
int32_t lsm6dsox_tap_detection_on_y_set (lsm6dsox_ctx_t *ctx, uint8_t val)
 Enable Y direction in tap recognition.
int32_t lsm6dsox_tap_detection_on_y_get (lsm6dsox_ctx_t *ctx, uint8_t *val)
 Enable Y direction in tap recognition.
int32_t lsm6dsox_tap_detection_on_x_set (lsm6dsox_ctx_t *ctx, uint8_t val)
 Enable X direction in tap recognition.
int32_t lsm6dsox_tap_detection_on_x_get (lsm6dsox_ctx_t *ctx, uint8_t *val)
 Enable X direction in tap recognition.
int32_t lsm6dsox_tap_threshold_x_set (lsm6dsox_ctx_t *ctx, uint8_t val)
 X-axis tap recognition threshold.
int32_t lsm6dsox_tap_threshold_x_get (lsm6dsox_ctx_t *ctx, uint8_t *val)
 X-axis tap recognition threshold.
int32_t lsm6dsox_tap_axis_priority_set (lsm6dsox_ctx_t *ctx, lsm6dsox_tap_priority_t val)
 Selection of axis priority for TAP detection.
int32_t lsm6dsox_tap_axis_priority_get (lsm6dsox_ctx_t *ctx, lsm6dsox_tap_priority_t *val)
 Selection of axis priority for TAP detection.
int32_t lsm6dsox_tap_threshold_y_set (lsm6dsox_ctx_t *ctx, uint8_t val)
 Y-axis tap recognition threshold.
int32_t lsm6dsox_tap_threshold_y_get (lsm6dsox_ctx_t *ctx, uint8_t *val)
 Y-axis tap recognition threshold.
int32_t lsm6dsox_tap_threshold_z_set (lsm6dsox_ctx_t *ctx, uint8_t val)
 Z-axis recognition threshold.
int32_t lsm6dsox_tap_threshold_z_get (lsm6dsox_ctx_t *ctx, uint8_t *val)
 Z-axis recognition threshold.
int32_t lsm6dsox_tap_shock_set (lsm6dsox_ctx_t *ctx, uint8_t val)
 Maximum duration is the maximum time of an over threshold signal detection to be recognized as a tap event.
int32_t lsm6dsox_tap_shock_get (lsm6dsox_ctx_t *ctx, uint8_t *val)
 Maximum duration is the maximum time of an over threshold signal detection to be recognized as a tap event.
int32_t lsm6dsox_tap_quiet_set (lsm6dsox_ctx_t *ctx, uint8_t val)
 Quiet time is the time after the first detected tap in which there must not be any over threshold event.
int32_t lsm6dsox_tap_quiet_get (lsm6dsox_ctx_t *ctx, uint8_t *val)
 Quiet time is the time after the first detected tap in which there must not be any over threshold event.
int32_t lsm6dsox_tap_dur_set (lsm6dsox_ctx_t *ctx, uint8_t val)
 When double tap recognition is enabled, this register expresses the maximum time between two consecutive detected taps to determine a double tap event.
int32_t lsm6dsox_tap_dur_get (lsm6dsox_ctx_t *ctx, uint8_t *val)
 When double tap recognition is enabled, this register expresses the maximum time between two consecutive detected taps to determine a double tap event.
int32_t lsm6dsox_tap_mode_set (lsm6dsox_ctx_t *ctx, lsm6dsox_single_double_tap_t val)
 Single/double-tap event enable.
int32_t lsm6dsox_tap_mode_get (lsm6dsox_ctx_t *ctx, lsm6dsox_single_double_tap_t *val)
 Single/double-tap event enable.

Detailed Description

This section groups all the functions that manage the tap and double tap event generation.

Function Documentation

int32_t lsm6dsox_tap_axis_priority_get ( lsm6dsox_ctx_t *  ctx,
lsm6dsox_tap_priority_t *  val 
)

Selection of axis priority for TAP detection.

[get]

Parameters:
ctxread / write interface definitions
valGet the values of tap_priority in reg TAP_CFG1

Definition at line 4703 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_axis_priority_set ( lsm6dsox_ctx_t *  ctx,
lsm6dsox_tap_priority_t  val 
)

Selection of axis priority for TAP detection.

[set]

Parameters:
ctxread / write interface definitions
valchange the values of tap_priority in reg TAP_CFG1

Definition at line 4681 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_detection_on_x_get ( lsm6dsox_ctx_t *  ctx,
uint8_t *  val 
)

Enable X direction in tap recognition.

[get]

Parameters:
ctxread / write interface definitions
valchange the values of tap_x_en in reg TAP_CFG0

Definition at line 4624 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_detection_on_x_set ( lsm6dsox_ctx_t *  ctx,
uint8_t  val 
)

Enable X direction in tap recognition.

[set]

Parameters:
ctxread / write interface definitions
valchange the values of tap_x_en in reg TAP_CFG0

Definition at line 4604 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_detection_on_y_get ( lsm6dsox_ctx_t *  ctx,
uint8_t *  val 
)

Enable Y direction in tap recognition.

[get]

Parameters:
ctxread / write interface definitions
valchange the values of tap_y_en in reg TAP_CFG0

Definition at line 4586 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_detection_on_y_set ( lsm6dsox_ctx_t *  ctx,
uint8_t  val 
)

Enable Y direction in tap recognition.

[set]

Parameters:
ctxread / write interface definitions
valchange the values of tap_y_en in reg TAP_CFG0

Definition at line 4566 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_detection_on_z_get ( lsm6dsox_ctx_t *  ctx,
uint8_t *  val 
)

Enable Z direction in tap recognition.

[get]

Parameters:
ctxread / write interface definitions
valchange the values of tap_z_en in reg TAP_CFG0

Definition at line 4548 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_detection_on_z_set ( lsm6dsox_ctx_t *  ctx,
uint8_t  val 
)

Enable Z direction in tap recognition.

[set]

Parameters:
ctxread / write interface definitions
valchange the values of tap_z_en in reg TAP_CFG0

Definition at line 4528 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_dur_get ( lsm6dsox_ctx_t *  ctx,
uint8_t *  val 
)

When double tap recognition is enabled, this register expresses the maximum time between two consecutive detected taps to determine a double tap event.

The default value of these bits is 0000b which corresponds to 16*ODR_XL time. If the DUR[3:0] bits are set to a different value, 1LSB corresponds to 32*ODR_XL time.[get]

Parameters:
ctxread / write interface definitions
valchange the values of dur in reg INT_DUR2

Definition at line 4951 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_dur_set ( lsm6dsox_ctx_t *  ctx,
uint8_t  val 
)

When double tap recognition is enabled, this register expresses the maximum time between two consecutive detected taps to determine a double tap event.

The default value of these bits is 0000b which corresponds to 16*ODR_XL time. If the DUR[3:0] bits are set to a different value, 1LSB corresponds to 32*ODR_XL time.[set]

Parameters:
ctxread / write interface definitions
valchange the values of dur in reg INT_DUR2

Definition at line 4924 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_mode_get ( lsm6dsox_ctx_t *  ctx,
lsm6dsox_single_double_tap_t *  val 
)

Single/double-tap event enable.

[get]

Parameters:
ctxread / write interface definitions
valGet the values of single_double_tap in reg WAKE_UP_THS

Definition at line 4990 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_mode_set ( lsm6dsox_ctx_t *  ctx,
lsm6dsox_single_double_tap_t  val 
)

Single/double-tap event enable.

[set]

Parameters:
ctxread / write interface definitions
valchange the values of single_double_tap in reg WAKE_UP_THS

Definition at line 4969 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_quiet_get ( lsm6dsox_ctx_t *  ctx,
uint8_t *  val 
)

Quiet time is the time after the first detected tap in which there must not be any over threshold event.

The default value of these bits is 00b which corresponds to 2*ODR_XL time. If the QUIET[1:0] bits are set to a different value, 1LSB corresponds to 4*ODR_XL time.[get]

Parameters:
ctxread / write interface definitions
valchange the values of quiet in reg INT_DUR2

Definition at line 4899 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_quiet_set ( lsm6dsox_ctx_t *  ctx,
uint8_t  val 
)

Quiet time is the time after the first detected tap in which there must not be any over threshold event.

The default value of these bits is 00b which corresponds to 2*ODR_XL time. If the QUIET[1:0] bits are set to a different value, 1LSB corresponds to 4*ODR_XL time.[set]

Parameters:
ctxread / write interface definitions
valchange the values of quiet in reg INT_DUR2

Definition at line 4873 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_shock_get ( lsm6dsox_ctx_t *  ctx,
uint8_t *  val 
)

Maximum duration is the maximum time of an over threshold signal detection to be recognized as a tap event.

The default value of these bits is 00b which corresponds to 4*ODR_XL time. If the SHOCK[1:0] bits are set to a different value, 1LSB corresponds to 8*ODR_XL time.[get]

Parameters:
ctxread / write interface definitions
valchange the values of shock in reg INT_DUR2

Definition at line 4849 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_shock_set ( lsm6dsox_ctx_t *  ctx,
uint8_t  val 
)

Maximum duration is the maximum time of an over threshold signal detection to be recognized as a tap event.

The default value of these bits is 00b which corresponds to 4*ODR_XL time. If the SHOCK[1:0] bits are set to a different value, 1LSB corresponds to 8*ODR_XL time.[set]

Parameters:
ctxread / write interface definitions
valchange the values of shock in reg INT_DUR2

Definition at line 4824 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_threshold_x_get ( lsm6dsox_ctx_t *  ctx,
uint8_t *  val 
)

X-axis tap recognition threshold.

[get]

Parameters:
ctxread / write interface definitions
valchange the values of tap_ths_x in reg TAP_CFG1

Definition at line 4662 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_threshold_x_set ( lsm6dsox_ctx_t *  ctx,
uint8_t  val 
)

X-axis tap recognition threshold.

[set]

Parameters:
ctxread / write interface definitions
valchange the values of tap_ths_x in reg TAP_CFG1

Definition at line 4642 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_threshold_y_get ( lsm6dsox_ctx_t *  ctx,
uint8_t *  val 
)

Y-axis tap recognition threshold.

[get]

Parameters:
ctxread / write interface definitions
valchange the values of tap_ths_y in reg TAP_CFG2

Definition at line 4763 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_threshold_y_set ( lsm6dsox_ctx_t *  ctx,
uint8_t  val 
)

Y-axis tap recognition threshold.

[set]

Parameters:
ctxread / write interface definitions
valchange the values of tap_ths_y in reg TAP_CFG2

Definition at line 4743 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_threshold_z_get ( lsm6dsox_ctx_t *  ctx,
uint8_t *  val 
)

Z-axis recognition threshold.

[get]

Parameters:
ctxread / write interface definitions
valchange the values of tap_ths_z in reg TAP_THS_6D

Definition at line 4801 of file lsm6dsox_reg.c.

int32_t lsm6dsox_tap_threshold_z_set ( lsm6dsox_ctx_t *  ctx,
uint8_t  val 
)

Z-axis recognition threshold.

[set]

Parameters:
ctxread / write interface definitions
valchange the values of tap_ths_z in reg TAP_THS_6D

Definition at line 4781 of file lsm6dsox_reg.c.

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