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
Auxiliary_interface
This section groups all the functions concerning auxiliary interface. More...
Functions | |
| int32_t | lsm6dsox_ois_mode_set (lsm6dsox_ctx_t *ctx, lsm6dsox_spi2_read_en_t val) |
| OIS data reading from Auxiliary / Main SPI. | |
| int32_t | lsm6dsox_ois_mode_get (lsm6dsox_ctx_t *ctx, lsm6dsox_spi2_read_en_t *val) |
| aux_ois_data: [get] OIS data reading from Auxiliary / Main SPI | |
| int32_t | lsm6dsox_aux_sdo_ocs_mode_set (lsm6dsox_ctx_t *ctx, lsm6dsox_ois_pu_dis_t val) |
| aOn auxiliary interface connect/disconnect SDO and OCS internal pull-up. | |
| int32_t | lsm6dsox_aux_sdo_ocs_mode_get (lsm6dsox_ctx_t *ctx, lsm6dsox_ois_pu_dis_t *val) |
| On auxiliary interface connect/disconnect SDO and OCS internal pull-up. | |
| int32_t | lsm6dsox_aux_pw_on_ctrl_set (lsm6dsox_ctx_t *ctx, lsm6dsox_ois_on_t val) |
| OIS chain on aux interface power on mode. | |
| int32_t | lsm6dsox_aux_pw_on_ctrl_get (lsm6dsox_ctx_t *ctx, lsm6dsox_ois_on_t *val) |
| aux_pw_on_ctrl: [get] OIS chain on aux interface power on mode | |
| int32_t | lsm6dsox_aux_xl_fs_mode_set (lsm6dsox_ctx_t *ctx, lsm6dsox_xl_fs_mode_t val) |
| Accelerometer full-scale management between UI chain and OIS chain. | |
| int32_t | lsm6dsox_aux_xl_fs_mode_get (lsm6dsox_ctx_t *ctx, lsm6dsox_xl_fs_mode_t *val) |
| Accelerometer full-scale management between UI chain and OIS chain. | |
| int32_t | lsm6dsox_aux_status_reg_get (lsm6dsox_ctx_t *ctx, lsm6dsox_spi2_status_reg_ois_t *val) |
| The STATUS_SPIAux register is read by the auxiliary SPI. | |
| int32_t | lsm6dsox_aux_xl_flag_data_ready_get (lsm6dsox_ctx_t *ctx, uint8_t *val) |
| aux_xl_flag_data_ready: [get] AUX accelerometer data available | |
| int32_t | lsm6dsox_aux_gy_flag_data_ready_get (lsm6dsox_ctx_t *ctx, uint8_t *val) |
| aux_gy_flag_data_ready: [get] AUX gyroscope data available. | |
| int32_t | lsm6dsox_aux_gy_flag_settling_get (lsm6dsox_ctx_t *ctx, uint8_t *val) |
| High when the gyroscope output is in the settling phase. | |
| int32_t | lsm6dsox_aux_den_polarity_set (lsm6dsox_ctx_t *ctx, lsm6dsox_den_lh_ois_t val) |
| Indicates polarity of DEN signal on OIS chain. | |
| int32_t | lsm6dsox_aux_den_polarity_get (lsm6dsox_ctx_t *ctx, lsm6dsox_den_lh_ois_t *val) |
| Indicates polarity of DEN signal on OIS chain. | |
| int32_t | lsm6dsox_aux_den_mode_set (lsm6dsox_ctx_t *ctx, lsm6dsox_lvl2_ois_t val) |
| Configure DEN mode on the OIS chain. | |
| int32_t | lsm6dsox_aux_den_mode_get (lsm6dsox_ctx_t *ctx, lsm6dsox_lvl2_ois_t *val) |
| Configure DEN mode on the OIS chain. | |
| int32_t | lsm6dsox_aux_drdy_on_int2_set (lsm6dsox_ctx_t *ctx, uint8_t val) |
| Enables/Disable OIS chain DRDY on INT2 pin. | |
| int32_t | lsm6dsox_aux_drdy_on_int2_get (lsm6dsox_ctx_t *ctx, uint8_t *val) |
| Enables/Disable OIS chain DRDY on INT2 pin. | |
| int32_t | lsm6dsox_aux_mode_set (lsm6dsox_ctx_t *ctx, lsm6dsox_ois_en_spi2_t val) |
| Enables OIS chain data processing for gyro in Mode 3 and Mode 4 (mode4_en = 1) and accelerometer data in and Mode 4 (mode4_en = 1). | |
| int32_t | lsm6dsox_aux_mode_get (lsm6dsox_ctx_t *ctx, lsm6dsox_ois_en_spi2_t *val) |
| Enables OIS chain data processing for gyro in Mode 3 and Mode 4 (mode4_en = 1) and accelerometer data in and Mode 4 (mode4_en = 1). | |
| int32_t | lsm6dsox_aux_gy_full_scale_set (lsm6dsox_ctx_t *ctx, lsm6dsox_fs_g_ois_t val) |
| Selects gyroscope OIS chain full-scale. | |
| int32_t | lsm6dsox_aux_gy_full_scale_get (lsm6dsox_ctx_t *ctx, lsm6dsox_fs_g_ois_t *val) |
| Selects gyroscope OIS chain full-scale. | |
| int32_t | lsm6dsox_aux_spi_mode_set (lsm6dsox_ctx_t *ctx, lsm6dsox_sim_ois_t val) |
| SPI2 3- or 4-wire interface. | |
| int32_t | lsm6dsox_aux_spi_mode_get (lsm6dsox_ctx_t *ctx, lsm6dsox_sim_ois_t *val) |
| SPI2 3- or 4-wire interface. | |
| int32_t | lsm6dsox_aux_gy_lp1_bandwidth_set (lsm6dsox_ctx_t *ctx, lsm6dsox_ftype_ois_t val) |
| Selects gyroscope digital LPF1 filter bandwidth. | |
| int32_t | lsm6dsox_aux_gy_lp1_bandwidth_get (lsm6dsox_ctx_t *ctx, lsm6dsox_ftype_ois_t *val) |
| Selects gyroscope digital LPF1 filter bandwidth. | |
| int32_t | lsm6dsox_aux_gy_hp_bandwidth_set (lsm6dsox_ctx_t *ctx, lsm6dsox_hpm_ois_t val) |
| Selects gyroscope OIS chain digital high-pass filter cutoff. | |
| int32_t | lsm6dsox_aux_gy_hp_bandwidth_get (lsm6dsox_ctx_t *ctx, lsm6dsox_hpm_ois_t *val) |
| Selects gyroscope OIS chain digital high-pass filter cutoff. | |
| int32_t | lsm6dsox_aux_gy_clamp_set (lsm6dsox_ctx_t *ctx, lsm6dsox_st_ois_clampdis_t val) |
| Enable / Disables OIS chain clamp. | |
| int32_t | lsm6dsox_aux_gy_clamp_get (lsm6dsox_ctx_t *ctx, lsm6dsox_st_ois_clampdis_t *val) |
| Enable / Disables OIS chain clamp. | |
| int32_t | lsm6dsox_aux_xl_bandwidth_set (lsm6dsox_ctx_t *ctx, lsm6dsox_filter_xl_conf_ois_t val) |
| Selects accelerometer OIS channel bandwidth. | |
| int32_t | lsm6dsox_aux_xl_bandwidth_get (lsm6dsox_ctx_t *ctx, lsm6dsox_filter_xl_conf_ois_t *val) |
| Selects accelerometer OIS channel bandwidth. | |
| int32_t | lsm6dsox_aux_xl_full_scale_set (lsm6dsox_ctx_t *ctx, lsm6dsox_fs_xl_ois_t val) |
| Selects accelerometer OIS channel full-scale. | |
| int32_t | lsm6dsox_aux_xl_full_scale_get (lsm6dsox_ctx_t *ctx, lsm6dsox_fs_xl_ois_t *val) |
| Selects accelerometer OIS channel full-scale. | |
| int32_t | lsm6dsox_sdo_sa0_mode_set (lsm6dsox_ctx_t *ctx, lsm6dsox_sdo_pu_en_t val) |
| Connect/Disconnect SDO/SA0 internal pull-up. | |
| int32_t | lsm6dsox_sdo_sa0_mode_get (lsm6dsox_ctx_t *ctx, lsm6dsox_sdo_pu_en_t *val) |
| Connect/Disconnect SDO/SA0 internal pull-up. | |
| int32_t | lsm6dsox_spi_mode_set (lsm6dsox_ctx_t *ctx, lsm6dsox_sim_t val) |
| SPI Serial Interface Mode selection. | |
| int32_t | lsm6dsox_spi_mode_get (lsm6dsox_ctx_t *ctx, lsm6dsox_sim_t *val) |
| SPI Serial Interface Mode selection. | |
| int32_t | lsm6dsox_i2c_interface_set (lsm6dsox_ctx_t *ctx, lsm6dsox_i2c_disable_t val) |
| Disable / Enable I2C interface. | |
| int32_t | lsm6dsox_i2c_interface_get (lsm6dsox_ctx_t *ctx, lsm6dsox_i2c_disable_t *val) |
| Disable / Enable I2C interface. | |
| int32_t | lsm6dsox_i3c_disable_set (lsm6dsox_ctx_t *ctx, lsm6dsox_i3c_disable_t val) |
| I3C Enable/Disable communication protocol[.set]. | |
| int32_t | lsm6dsox_i3c_disable_get (lsm6dsox_ctx_t *ctx, lsm6dsox_i3c_disable_t *val) |
| I3C Enable/Disable communication protocol. | |
| int32_t | lsm6dsox_gy_sleep_mode_set (lsm6dsox_ctx_t *ctx, uint8_t val) |
| Enables gyroscope Sleep mode. | |
| int32_t | lsm6dsox_gy_sleep_mode_get (lsm6dsox_ctx_t *ctx, uint8_t *val) |
| Enables gyroscope Sleep mode. | |
| int32_t | lsm6dsox_act_pin_notification_set (lsm6dsox_ctx_t *ctx, lsm6dsox_sleep_status_on_int_t val) |
| Drives the sleep status instead of sleep change on INT pins (only if INT1_SLEEP_CHANGE or INT2_SLEEP_CHANGE bits are enabled). | |
| int32_t | lsm6dsox_act_pin_notification_get (lsm6dsox_ctx_t *ctx, lsm6dsox_sleep_status_on_int_t *val) |
| Drives the sleep status instead of sleep change on INT pins (only if INT1_SLEEP_CHANGE or INT2_SLEEP_CHANGE bits are enabled). | |
| int32_t | lsm6dsox_act_mode_set (lsm6dsox_ctx_t *ctx, lsm6dsox_inact_en_t val) |
| Enable inactivity function. | |
| int32_t | lsm6dsox_act_mode_get (lsm6dsox_ctx_t *ctx, lsm6dsox_inact_en_t *val) |
| Enable inactivity function. | |
| int32_t | lsm6dsox_act_sleep_dur_set (lsm6dsox_ctx_t *ctx, uint8_t val) |
| Duration to go in sleep mode. | |
| int32_t | lsm6dsox_act_sleep_dur_get (lsm6dsox_ctx_t *ctx, uint8_t *val) |
| Duration to go in sleep mode. | |
| int32_t | lsm6dsox_6d_threshold_set (lsm6dsox_ctx_t *ctx, lsm6dsox_sixd_ths_t val) |
| Threshold for 4D/6D function. | |
| int32_t | lsm6dsox_6d_threshold_get (lsm6dsox_ctx_t *ctx, lsm6dsox_sixd_ths_t *val) |
| Threshold for 4D/6D function. | |
| int32_t | lsm6dsox_4d_mode_set (lsm6dsox_ctx_t *ctx, uint8_t val) |
| 4D orientation detection enable. | |
| int32_t | lsm6dsox_4d_mode_get (lsm6dsox_ctx_t *ctx, uint8_t *val) |
| 4D orientation detection enable. | |
| int32_t | lsm6dsox_sh_mag_sensitivity_set (lsm6dsox_ctx_t *ctx, uint8_t *buff) |
| External magnetometer sensitivity value register for Sensor hub. | |
| int32_t | lsm6dsox_sh_mag_sensitivity_get (lsm6dsox_ctx_t *ctx, uint8_t *buff) |
| External magnetometer sensitivity value register for Sensor hub. | |
| int32_t | lsm6dsox_mlc_mag_sensitivity_set (lsm6dsox_ctx_t *ctx, uint8_t *buff) |
| External magnetometer sensitivity value register for Machine Learning Core. | |
| int32_t | lsm6dsox_mlc_mag_sensitivity_get (lsm6dsox_ctx_t *ctx, uint8_t *buff) |
| External magnetometer sensitivity value register for Machine Learning Core. | |
| int32_t | lsm6dsox_mag_offset_set (lsm6dsox_ctx_t *ctx, uint8_t *buff) |
| Offset for hard-iron compensation register (r/w). | |
| int32_t | lsm6dsox_mag_offset_get (lsm6dsox_ctx_t *ctx, uint8_t *buff) |
| Offset for hard-iron compensation register (r/w). | |
| int32_t | lsm6dsox_mag_soft_iron_set (lsm6dsox_ctx_t *ctx, uint8_t *buff) |
| Soft-iron (3x3 symmetric) matrix correction register (r/w). | |
| int32_t | lsm6dsox_mag_soft_iron_get (lsm6dsox_ctx_t *ctx, uint8_t *buff) |
| Soft-iron (3x3 symmetric) matrix correction register (r/w). | |
| int32_t | lsm6dsox_mag_z_orient_set (lsm6dsox_ctx_t *ctx, lsm6dsox_mag_z_axis_t val) |
| Magnetometer Z-axis coordinates rotation (to be aligned to accelerometer/gyroscope axes orientation). | |
| int32_t | lsm6dsox_mag_z_orient_get (lsm6dsox_ctx_t *ctx, lsm6dsox_mag_z_axis_t *val) |
| Magnetometer Z-axis coordinates rotation (to be aligned to accelerometer/gyroscope axes orientation). | |
| int32_t | lsm6dsox_mag_y_orient_set (lsm6dsox_ctx_t *ctx, lsm6dsox_mag_y_axis_t val) |
| Magnetometer Y-axis coordinates rotation (to be aligned to accelerometer/gyroscope axes orientation). | |
| int32_t | lsm6dsox_mag_y_orient_get (lsm6dsox_ctx_t *ctx, lsm6dsox_mag_y_axis_t *val) |
| Magnetometer Y-axis coordinates rotation (to be aligned to accelerometer/gyroscope axes orientation). | |
| int32_t | lsm6dsox_mag_x_orient_set (lsm6dsox_ctx_t *ctx, lsm6dsox_mag_x_axis_t val) |
| Magnetometer X-axis coordinates rotation (to be aligned to accelerometer/gyroscope axes orientation). | |
| int32_t | lsm6dsox_mag_x_orient_get (lsm6dsox_ctx_t *ctx, lsm6dsox_mag_x_axis_t *val) |
| Magnetometer X-axis coordinates rotation (to be aligned to accelerometer/gyroscope axes orientation). | |
Detailed Description
This section groups all the functions concerning auxiliary interface.
This section groups all the functions that manage additional magnetometer sensor.
This section groups all the functions concerning six position detection (6D).
This section groups all the functions concerning activity/inactivity detection.
This section groups all the functions concerning main serial interface management (not auxiliary)
Function Documentation
| int32_t lsm6dsox_4d_mode_get | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t * | val | ||
| ) |
4D orientation detection enable.
[get]
- Parameters:
-
ctx read / write interface definitions val change the values of d4d_en in reg TAP_THS_6D
Definition at line 5106 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_4d_mode_set | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t | val | ||
| ) |
4D orientation detection enable.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of d4d_en in reg TAP_THS_6D
Definition at line 5086 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_6d_threshold_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_sixd_ths_t * | val | ||
| ) |
Threshold for 4D/6D function.
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of sixd_ths in reg TAP_THS_6D
Definition at line 5053 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_6d_threshold_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_sixd_ths_t | val | ||
| ) |
Threshold for 4D/6D function.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of sixd_ths in reg TAP_THS_6D
Definition at line 5033 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_act_mode_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_inact_en_t * | val | ||
| ) |
Enable inactivity function.
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of inact_en in reg TAP_CFG2
Definition at line 4442 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_act_mode_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_inact_en_t | val | ||
| ) |
Enable inactivity function.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of inact_en in reg TAP_CFG2
Definition at line 4422 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_act_pin_notification_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_sleep_status_on_int_t * | val | ||
| ) |
Drives the sleep status instead of sleep change on INT pins (only if INT1_SLEEP_CHANGE or INT2_SLEEP_CHANGE bits are enabled).
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of sleep_status_on_int in reg TAP_CFG0
Definition at line 4394 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_act_pin_notification_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_sleep_status_on_int_t | val | ||
| ) |
Drives the sleep status instead of sleep change on INT pins (only if INT1_SLEEP_CHANGE or INT2_SLEEP_CHANGE bits are enabled).
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of sleep_status_on_int in reg TAP_CFG0
Definition at line 4370 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_act_sleep_dur_get | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t * | val | ||
| ) |
Duration to go in sleep mode.
[get] 1 LSb = 512 / ODR
- Parameters:
-
ctx read / write interface definitions val change the values of sleep_dur in reg WAKE_UP_DUR
Definition at line 4497 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_act_sleep_dur_set | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t | val | ||
| ) |
Duration to go in sleep mode.
[set] 1 LSb = 512 / ODR
- Parameters:
-
ctx read / write interface definitions val change the values of sleep_dur in reg WAKE_UP_DUR
Definition at line 4476 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_den_mode_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_lvl2_ois_t * | val | ||
| ) |
Configure DEN mode on the OIS chain.
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of lvl2_ois in reg INT_OIS
Definition at line 3089 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_den_mode_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_lvl2_ois_t | val | ||
| ) |
Configure DEN mode on the OIS chain.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of lvl2_ois in reg INT_OIS
Definition at line 3061 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_den_polarity_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_den_lh_ois_t * | val | ||
| ) |
Indicates polarity of DEN signal on OIS chain.
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of den_lh_ois in reg INT_OIS
Definition at line 3033 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_den_polarity_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_den_lh_ois_t | val | ||
| ) |
Indicates polarity of DEN signal on OIS chain.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of den_lh_ois in reg INT_OIS
Definition at line 3012 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_drdy_on_int2_get | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t * | val | ||
| ) |
Enables/Disable OIS chain DRDY on INT2 pin.
This setting has priority over all other INT2 settings.[get]
- Parameters:
-
ctx read / write interface definitions val change the values of int2_drdy_ois in reg INT_OIS
Definition at line 3145 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_drdy_on_int2_set | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t | val | ||
| ) |
Enables/Disable OIS chain DRDY on INT2 pin.
This setting has priority over all other INT2 settings.[set]
- Parameters:
-
ctx read / write interface definitions val change the values of int2_drdy_ois in reg INT_OIS
Definition at line 3124 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_gy_clamp_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_st_ois_clampdis_t * | val | ||
| ) |
Enable / Disables OIS chain clamp.
Enable: All OIS chain outputs = 8000h during self-test; Disable: OIS chain self-test outputs dependent from the aux gyro full scale selected.[set]
- Parameters:
-
ctx read / write interface definitions val Get the values of st_ois_clampdis in reg CTRL3_OIS
Definition at line 3477 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_gy_clamp_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_st_ois_clampdis_t | val | ||
| ) |
Enable / Disables OIS chain clamp.
Enable: All OIS chain outputs = 8000h during self-test; Disable: OIS chain self-test outputs dependent from the aux gyro full scale selected.[set]
- Parameters:
-
ctx read / write interface definitions val change the values of st_ois_clampdis in reg CTRL3_OIS
Definition at line 3451 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_gy_flag_data_ready_get | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t * | val | ||
| ) |
aux_gy_flag_data_ready: [get] AUX gyroscope data available.
- Parameters:
-
ctx read / write interface definitions val change the values of gda in reg STATUS_SPIAUX
Definition at line 2975 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_gy_flag_settling_get | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t * | val | ||
| ) |
High when the gyroscope output is in the settling phase.
[get]
- Parameters:
-
ctx read / write interface definitions val change the values of gyro_settling in reg STATUS_SPIAUX
Definition at line 2993 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_gy_full_scale_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_fs_g_ois_t * | val | ||
| ) |
Selects gyroscope OIS chain full-scale.
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of fs_g_ois in reg CTRL1_OIS
Definition at line 3247 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_gy_full_scale_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_fs_g_ois_t | val | ||
| ) |
Selects gyroscope OIS chain full-scale.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of fs_g_ois in reg CTRL1_OIS
Definition at line 3226 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_gy_hp_bandwidth_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_hpm_ois_t * | val | ||
| ) |
Selects gyroscope OIS chain digital high-pass filter cutoff.
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of hpm_ois in reg CTRL2_OIS
Definition at line 3409 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_gy_hp_bandwidth_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_hpm_ois_t | val | ||
| ) |
Selects gyroscope OIS chain digital high-pass filter cutoff.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of hpm_ois in reg CTRL2_OIS
Definition at line 3387 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_gy_lp1_bandwidth_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_ftype_ois_t * | val | ||
| ) |
Selects gyroscope digital LPF1 filter bandwidth.
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of ftype_ois in reg CTRL2_OIS
Definition at line 3353 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_gy_lp1_bandwidth_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_ftype_ois_t | val | ||
| ) |
Selects gyroscope digital LPF1 filter bandwidth.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of ftype_ois in reg CTRL2_OIS
Definition at line 3332 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_mode_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_ois_en_spi2_t * | val | ||
| ) |
Enables OIS chain data processing for gyro in Mode 3 and Mode 4 (mode4_en = 1) and accelerometer data in and Mode 4 (mode4_en = 1).
When the OIS chain is enabled, the OIS outputs are available through the SPI2 in registers OUTX_L_G (22h) through OUTZ_H_G (27h) and STATUS_REG (1Eh) / STATUS_SPIAux, and LPF1 is dedicated to this chain.[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of ois_en_spi2 in reg CTRL1_OIS
Definition at line 3196 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_mode_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_ois_en_spi2_t | val | ||
| ) |
Enables OIS chain data processing for gyro in Mode 3 and Mode 4 (mode4_en = 1) and accelerometer data in and Mode 4 (mode4_en = 1).
When the OIS chain is enabled, the OIS outputs are available through the SPI2 in registers OUTX_L_G (22h) through OUTZ_H_G (27h) and STATUS_REG (1Eh) / STATUS_SPIAux, and LPF1 is dedicated to this chain.[set]
- Parameters:
-
ctx read / write interface definitions val change the values of ois_en_spi2 in reg CTRL1_OIS
Definition at line 3169 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_pw_on_ctrl_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_ois_on_t * | val | ||
| ) |
aux_pw_on_ctrl: [get] OIS chain on aux interface power on mode
- Parameters:
-
ctx read / write interface definitions val Get the values of ois_on in reg CTRL7_G
Definition at line 2853 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_pw_on_ctrl_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_ois_on_t | val | ||
| ) |
OIS chain on aux interface power on mode.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of ois_on in reg CTRL7_G
Definition at line 2832 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_sdo_ocs_mode_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_ois_pu_dis_t * | val | ||
| ) |
On auxiliary interface connect/disconnect SDO and OCS internal pull-up.
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of ois_pu_dis in reg PIN_CTRL
Definition at line 2804 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_sdo_ocs_mode_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_ois_pu_dis_t | val | ||
| ) |
aOn auxiliary interface connect/disconnect SDO and OCS internal pull-up.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of ois_pu_dis in reg PIN_CTRL
Definition at line 2782 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_spi_mode_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_sim_ois_t * | val | ||
| ) |
SPI2 3- or 4-wire interface.
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of sim_ois in reg CTRL1_OIS
Definition at line 3304 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_spi_mode_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_sim_ois_t | val | ||
| ) |
SPI2 3- or 4-wire interface.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of sim_ois in reg CTRL1_OIS
Definition at line 3284 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_status_reg_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_spi2_status_reg_ois_t * | val | ||
| ) |
The STATUS_SPIAux register is read by the auxiliary SPI.
[get]
- Parameters:
-
ctx read / write interface definitions val Get registers STATUS_SPIAUX
Definition at line 2942 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_xl_bandwidth_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_filter_xl_conf_ois_t * | val | ||
| ) |
Selects accelerometer OIS channel bandwidth.
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of filter_xl_conf_ois in reg CTRL3_OIS
Definition at line 3528 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_xl_bandwidth_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_filter_xl_conf_ois_t | val | ||
| ) |
Selects accelerometer OIS channel bandwidth.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of filter_xl_conf_ois in reg CTRL3_OIS
Definition at line 3506 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_xl_flag_data_ready_get | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t * | val | ||
| ) |
aux_xl_flag_data_ready: [get] AUX accelerometer data available
- Parameters:
-
ctx read / write interface definitions val change the values of xlda in reg STATUS_SPIAUX
Definition at line 2957 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_xl_fs_mode_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_xl_fs_mode_t * | val | ||
| ) |
Accelerometer full-scale management between UI chain and OIS chain.
When XL UI is on, the full scale is the same between UI/OIS and is chosen by the UI CTRL registers; when XL UI is in PD, the OIS can choose the FS. Full scales are independent between the UI/OIS chain but both bound to 8 g.[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of xl_fs_mode in reg CTRL8_XL
Definition at line 2913 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_xl_fs_mode_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_xl_fs_mode_t | val | ||
| ) |
Accelerometer full-scale management between UI chain and OIS chain.
When XL UI is on, the full scale is the same between UI/OIS and is chosen by the UI CTRL registers; when XL UI is in PD, the OIS can choose the FS. Full scales are independent between the UI/OIS chain but both bound to 8 g.[set]
- Parameters:
-
ctx read / write interface definitions val change the values of xl_fs_mode in reg CTRL8_XL
Definition at line 2887 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_xl_full_scale_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_fs_xl_ois_t * | val | ||
| ) |
Selects accelerometer OIS channel full-scale.
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of fs_xl_ois in reg CTRL3_OIS
Definition at line 3597 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_aux_xl_full_scale_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_fs_xl_ois_t | val | ||
| ) |
Selects accelerometer OIS channel full-scale.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of fs_xl_ois in reg CTRL3_OIS
Definition at line 3576 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_gy_sleep_mode_get | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t * | val | ||
| ) |
Enables gyroscope Sleep mode.
[get]
- Parameters:
-
ctx read / write interface definitions val change the values of sleep_g in reg CTRL4_C
Definition at line 4349 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_gy_sleep_mode_set | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t | val | ||
| ) |
Enables gyroscope Sleep mode.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of sleep_g in reg CTRL4_C
Definition at line 4329 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_i2c_interface_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_i2c_disable_t * | val | ||
| ) |
Disable / Enable I2C interface.
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of i2c_disable in reg CTRL4_C
Definition at line 3762 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_i2c_interface_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_i2c_disable_t | val | ||
| ) |
Disable / Enable I2C interface.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of i2c_disable in reg CTRL4_C
Definition at line 3740 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_i3c_disable_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_i3c_disable_t * | val | ||
| ) |
I3C Enable/Disable communication protocol.
[get]
- Parameters:
-
ctx read / write interface definitions val change the values of i3c_disable in reg CTRL9_XL
Definition at line 3824 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_i3c_disable_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_i3c_disable_t | val | ||
| ) |
I3C Enable/Disable communication protocol[.set].
- Parameters:
-
ctx read / write interface definitions val change the values of i3c_disable in reg CTRL9_XL
Definition at line 3791 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_mag_offset_get | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t * | buff | ||
| ) |
Offset for hard-iron compensation register (r/w).
[get]
- Parameters:
-
ctx read / write interface definitions buff buffer that stores data read
Definition at line 7210 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_mag_offset_set | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t * | buff | ||
| ) |
Offset for hard-iron compensation register (r/w).
[set]
- Parameters:
-
ctx read / write interface definitions buff buffer that contains data to write
Definition at line 7171 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_mag_soft_iron_get | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t * | buff | ||
| ) |
Soft-iron (3x3 symmetric) matrix correction register (r/w).
The value is expressed as half-precision floating-point format: SEEEEEFFFFFFFFFF S: 1 sign bit; E: 5 exponent bits; F: 10 fraction bits.[get]
- Parameters:
-
ctx read / write interface definitions buff buffer that stores data read
Definition at line 7329 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_mag_soft_iron_set | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t * | buff | ||
| ) |
Soft-iron (3x3 symmetric) matrix correction register (r/w).
The value is expressed as half-precision floating-point format: SEEEEEFFFFFFFFFF S: 1 sign bit; E: 5 exponent bits; F: 10 fraction bits).[set]
- Parameters:
-
ctx read / write interface definitions buff buffer that contains data to write
Definition at line 7255 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_mag_x_orient_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_mag_x_axis_t * | val | ||
| ) |
Magnetometer X-axis coordinates rotation (to be aligned to accelerometer/gyroscope axes orientation).
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of mag_x_axis in reg MAG_CFG_B
Definition at line 7556 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_mag_x_orient_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_mag_x_axis_t | val | ||
| ) |
Magnetometer X-axis coordinates rotation (to be aligned to accelerometer/gyroscope axes orientation).
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of mag_x_axis in reg MAG_CFG_B
Definition at line 7532 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_mag_y_orient_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_mag_y_axis_t * | val | ||
| ) |
Magnetometer Y-axis coordinates rotation (to be aligned to accelerometer/gyroscope axes orientation).
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of mag_y_axis in reg MAG_CFG_A
Definition at line 7489 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_mag_y_orient_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_mag_y_axis_t | val | ||
| ) |
Magnetometer Y-axis coordinates rotation (to be aligned to accelerometer/gyroscope axes orientation).
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of mag_y_axis in reg MAG_CFG_A
Definition at line 7465 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_mag_z_orient_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_mag_z_axis_t * | val | ||
| ) |
Magnetometer Z-axis coordinates rotation (to be aligned to accelerometer/gyroscope axes orientation).
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of mag_z_axis in reg MAG_CFG_A
Definition at line 7423 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_mag_z_orient_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_mag_z_axis_t | val | ||
| ) |
Magnetometer Z-axis coordinates rotation (to be aligned to accelerometer/gyroscope axes orientation).
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of mag_z_axis in reg MAG_CFG_A
Definition at line 7399 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_mlc_mag_sensitivity_get | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t * | buff | ||
| ) |
External magnetometer sensitivity value register for Machine Learning Core.
[get]
- Parameters:
-
ctx read / write interface definitions buff buffer that stores data read
Definition at line 7147 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_mlc_mag_sensitivity_set | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t * | buff | ||
| ) |
External magnetometer sensitivity value register for Machine Learning Core.
[set]
- Parameters:
-
ctx read / write interface definitions buff buffer that contains data to write
Definition at line 7123 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_ois_mode_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_spi2_read_en_t * | val | ||
| ) |
aux_ois_data: [get] OIS data reading from Auxiliary / Main SPI
- Parameters:
-
ctx read / write interface definitions val Get the values of spi2_read_en in reg UI_INT_OIS
Definition at line 2741 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_ois_mode_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_spi2_read_en_t | val | ||
| ) |
OIS data reading from Auxiliary / Main SPI.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of spi2_read_en in reg UI_INT_OIS
Definition at line 2709 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_sdo_sa0_mode_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_sdo_pu_en_t * | val | ||
| ) |
Connect/Disconnect SDO/SA0 internal pull-up.
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of sdo_pu_en in reg PIN_CTRL
Definition at line 3665 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_sdo_sa0_mode_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_sdo_pu_en_t | val | ||
| ) |
Connect/Disconnect SDO/SA0 internal pull-up.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of sdo_pu_en in reg PIN_CTRL
Definition at line 3645 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_sh_mag_sensitivity_get | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t * | buff | ||
| ) |
External magnetometer sensitivity value register for Sensor hub.
[get]
- Parameters:
-
ctx read / write interface definitions buff buffer that stores data read
Definition at line 7098 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_sh_mag_sensitivity_set | ( | lsm6dsox_ctx_t * | ctx, |
| uint8_t * | buff | ||
| ) |
External magnetometer sensitivity value register for Sensor hub.
[set]
- Parameters:
-
ctx read / write interface definitions buff buffer that contains data to write
Definition at line 7073 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_spi_mode_get | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_sim_t * | val | ||
| ) |
SPI Serial Interface Mode selection.
[get]
- Parameters:
-
ctx read / write interface definitions val Get the values of sim in reg CTRL3_C
Definition at line 3712 of file lsm6dsox_reg.c.
| int32_t lsm6dsox_spi_mode_set | ( | lsm6dsox_ctx_t * | ctx, |
| lsm6dsox_sim_t | val | ||
| ) |
SPI Serial Interface Mode selection.
[set]
- Parameters:
-
ctx read / write interface definitions val change the values of sim in reg CTRL3_C
Definition at line 3692 of file lsm6dsox_reg.c.
Generated on Tue Jul 12 2022 20:15:23 by
1.7.2