Functions
DrvStatusTypeDef	BSP_GYRO_Init (GYRO_ID_t id, void **handle)
	Initialize a gyroscope sensor. More...

DrvStatusTypeDef	BSP_GYRO_DeInit (void **handle)
	Deinitialize a gyroscope sensor. More...

DrvStatusTypeDef	BSP_GYRO_Sensor_Enable (void *handle)
	Enable gyroscope sensor. More...

DrvStatusTypeDef	BSP_GYRO_Sensor_Disable (void *handle)
	Disable gyroscope sensor. More...

DrvStatusTypeDef	BSP_GYRO_IsInitialized (void handle, uint8_t status)
	Check if the gyroscope sensor is initialized. More...

DrvStatusTypeDef	BSP_GYRO_IsEnabled (void handle, uint8_t status)
	Check if the gyroscope sensor is enabled. More...

DrvStatusTypeDef	BSP_GYRO_IsCombo (void handle, uint8_t status)
	Check if the gyroscope sensor is combo. More...

DrvStatusTypeDef	BSP_GYRO_Get_Instance (void handle, uint8_t instance)
	Get the gyroscope sensor instance. More...

DrvStatusTypeDef	BSP_GYRO_Get_WhoAmI (void handle, uint8_t who_am_i)
	Get the WHO_AM_I ID of the gyroscope sensor. More...

DrvStatusTypeDef	BSP_GYRO_Check_WhoAmI (void *handle)
	Check the WHO_AM_I ID of the gyroscope sensor. More...

DrvStatusTypeDef	BSP_GYRO_Get_Axes (void handle, SensorAxes_t angular_velocity)
	Get the gyroscope sensor axes. More...

DrvStatusTypeDef	BSP_GYRO_Get_AxesRaw (void handle, SensorAxesRaw_t value)
	Get the gyroscope sensor raw axes. More...

DrvStatusTypeDef	BSP_GYRO_Get_Sensitivity (void handle, float sensitivity)
	Get the gyroscope sensor sensitivity. More...

DrvStatusTypeDef	BSP_GYRO_Get_ODR (void handle, float odr)
	Get the gyroscope sensor output data rate. More...

DrvStatusTypeDef	BSP_GYRO_Set_ODR (void *handle, SensorOdr_t odr)
	Set the gyroscope sensor output data rate. More...

DrvStatusTypeDef	BSP_GYRO_Set_ODR_Value (void *handle, float odr)
	Set the gyroscope sensor output data rate. More...

DrvStatusTypeDef	BSP_GYRO_Get_FS (void handle, float fullScale)
	Get the gyroscope sensor full scale. More...

DrvStatusTypeDef	BSP_GYRO_Set_FS (void *handle, SensorFs_t fullScale)
	Set the gyroscope sensor full scale. More...

DrvStatusTypeDef	BSP_GYRO_Set_FS_Value (void *handle, float fullScale)
	Set the gyroscope sensor full scale. More...

DrvStatusTypeDef	BSP_GYRO_Get_Axes_Status (void handle, uint8_t xyz_enabled)
	Get the gyroscope sensor axes status. More...

DrvStatusTypeDef	BSP_GYRO_Read_Reg (void handle, uint8_t reg, uint8_t data)
	Read the data from register. More...

DrvStatusTypeDef	BSP_GYRO_Write_Reg (void *handle, uint8_t reg, uint8_t data)
	Write the data to register. More...

DrvStatusTypeDef	BSP_GYRO_Get_DRDY_Status (void handle, uint8_t status)
	Get gyroscope data ready status. More...

DrvStatusTypeDef	BSP_GYRO_Set_Axes_Status (void handle, uint8_t enable_xyz)
	Set the enabled/disabled status of the gyroscope sensor axes. More...

Detailed Description

Function Documentation

◆ BSP_GYRO_Check_WhoAmI()

DrvStatusTypeDef BSP_GYRO_Check_WhoAmI ( void * handle )

Check the WHO_AM_I ID of the gyroscope sensor.

Parameters

handle the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 450 of file SensorTile_gyro.c.

◆ BSP_GYRO_DeInit()

DrvStatusTypeDef BSP_GYRO_DeInit ( void ** handle )

Deinitialize a gyroscope sensor.

Parameters

handle the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 198 of file SensorTile_gyro.c.

◆ BSP_GYRO_Get_Axes()

DrvStatusTypeDef BSP_GYRO_Get_Axes	(	void *	handle,
		SensorAxes_t *	angular_velocity
	)

Get the gyroscope sensor axes.

Parameters

handle	the device handle
angular_velocity	pointer where the values of the axes are written [mdps]

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 484 of file SensorTile_gyro.c.

◆ BSP_GYRO_Get_Axes_Status()

DrvStatusTypeDef BSP_GYRO_Get_Axes_Status	(	void *	handle,
		uint8_t *	xyz_enabled
	)

Get the gyroscope sensor axes status.

Parameters

handle	the device handle
xyz_enabled	the pointer to the axes enabled/disabled status

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 811 of file SensorTile_gyro.c.

◆ BSP_GYRO_Get_AxesRaw()

DrvStatusTypeDef BSP_GYRO_Get_AxesRaw	(	void *	handle,
		SensorAxesRaw_t *	value
	)

Get the gyroscope sensor raw axes.

Parameters

handle	the device handle
value	pointer where the raw values of the axes are written

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 522 of file SensorTile_gyro.c.

◆ BSP_GYRO_Get_DRDY_Status()

DrvStatusTypeDef BSP_GYRO_Get_DRDY_Status	(	void *	handle,
		uint8_t *	status
	)

Get gyroscope data ready status.

Parameters

handle	the device handle
status	the data ready status

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 923 of file SensorTile_gyro.c.

◆ BSP_GYRO_Get_FS()

DrvStatusTypeDef BSP_GYRO_Get_FS	(	void *	handle,
		float *	fullScale
	)

Get the gyroscope sensor full scale.

Parameters

handle	the device handle
fullScale	pointer where the full scale is written

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 705 of file SensorTile_gyro.c.

◆ BSP_GYRO_Get_Instance()

DrvStatusTypeDef BSP_GYRO_Get_Instance	(	void *	handle,
		uint8_t *	instance
	)

Get the gyroscope sensor instance.

Parameters

handle	the device handle
instance	the pointer to the device instance

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 385 of file SensorTile_gyro.c.

◆ BSP_GYRO_Get_ODR()

DrvStatusTypeDef BSP_GYRO_Get_ODR	(	void *	handle,
		float *	odr
	)

Get the gyroscope sensor output data rate.

Parameters

handle	the device handle
odr	pointer where the output data rate is written

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 599 of file SensorTile_gyro.c.

◆ BSP_GYRO_Get_Sensitivity()

DrvStatusTypeDef BSP_GYRO_Get_Sensitivity	(	void *	handle,
		float *	sensitivity
	)

Get the gyroscope sensor sensitivity.

Parameters

handle	the device handle
sensitivity	pointer where the sensitivity value is written [mdps/LSB]

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 561 of file SensorTile_gyro.c.

◆ BSP_GYRO_Get_WhoAmI()

DrvStatusTypeDef BSP_GYRO_Get_WhoAmI	(	void *	handle,
		uint8_t *	who_am_i
	)

Get the WHO_AM_I ID of the gyroscope sensor.

Parameters

handle	the device handle
who_am_i	pointer to the value of WHO_AM_I register

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 413 of file SensorTile_gyro.c.

◆ BSP_GYRO_Init()

DrvStatusTypeDef BSP_GYRO_Init	(	GYRO_ID_t	id,
		void **	handle
	)

Initialize a gyroscope sensor.

Parameters

id	the gyroscope sensor identifier
handle	the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 88 of file SensorTile_gyro.c.

◆ BSP_GYRO_IsCombo()

DrvStatusTypeDef BSP_GYRO_IsCombo	(	void *	handle,
		uint8_t *	status
	)

Check if the gyroscope sensor is combo.

Parameters

handle	the device handle
status	the pointer to the combo status

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 358 of file SensorTile_gyro.c.

◆ BSP_GYRO_IsEnabled()

DrvStatusTypeDef BSP_GYRO_IsEnabled	(	void *	handle,
		uint8_t *	status
	)

Check if the gyroscope sensor is enabled.

Parameters

handle	the device handle
status	the pointer to the enable status

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 331 of file SensorTile_gyro.c.

◆ BSP_GYRO_IsInitialized()

DrvStatusTypeDef BSP_GYRO_IsInitialized	(	void *	handle,
		uint8_t *	status
	)

Check if the gyroscope sensor is initialized.

Parameters

handle	the device handle
status	the pointer to the initialization status

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 304 of file SensorTile_gyro.c.

◆ BSP_GYRO_Read_Reg()

DrvStatusTypeDef BSP_GYRO_Read_Reg	(	void *	handle,
		uint8_t	reg,
		uint8_t *	data
	)

Read the data from register.

Parameters

handle	the device handle
reg	register address
data	register data

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 849 of file SensorTile_gyro.c.

◆ BSP_GYRO_Sensor_Disable()

DrvStatusTypeDef BSP_GYRO_Sensor_Disable ( void * handle )

Disable gyroscope sensor.

Parameters

handle the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 270 of file SensorTile_gyro.c.

◆ BSP_GYRO_Sensor_Enable()

DrvStatusTypeDef BSP_GYRO_Sensor_Enable ( void * handle )

Enable gyroscope sensor.

Parameters

handle the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 236 of file SensorTile_gyro.c.

◆ BSP_GYRO_Set_Axes_Status()

DrvStatusTypeDef BSP_GYRO_Set_Axes_Status	(	void *	handle,
		uint8_t *	enable_xyz
	)

Set the enabled/disabled status of the gyroscope sensor axes.

Parameters

handle	the device handle
enable_xyz	vector of the axes enabled/disabled status

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 957 of file SensorTile_gyro.c.

◆ BSP_GYRO_Set_FS()

DrvStatusTypeDef BSP_GYRO_Set_FS	(	void *	handle,
		SensorFs_t	fullScale
	)

Set the gyroscope sensor full scale.

Parameters

handle	the device handle
fullScale	the functional full scale to be set

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 743 of file SensorTile_gyro.c.

◆ BSP_GYRO_Set_FS_Value()

DrvStatusTypeDef BSP_GYRO_Set_FS_Value	(	void *	handle,
		float	fullScale
	)

Set the gyroscope sensor full scale.

Parameters

handle	the device handle
fullScale	the full scale value to be set

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 777 of file SensorTile_gyro.c.

◆ BSP_GYRO_Set_ODR()

DrvStatusTypeDef BSP_GYRO_Set_ODR	(	void *	handle,
		SensorOdr_t	odr
	)

Set the gyroscope sensor output data rate.

Parameters

handle	the device handle
odr	the functional output data rate to be set

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 637 of file SensorTile_gyro.c.

◆ BSP_GYRO_Set_ODR_Value()

DrvStatusTypeDef BSP_GYRO_Set_ODR_Value	(	void *	handle,
		float	odr
	)

Set the gyroscope sensor output data rate.

Parameters

handle	the device handle
odr	the output data rate value to be set

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 671 of file SensorTile_gyro.c.

◆ BSP_GYRO_Write_Reg()

DrvStatusTypeDef BSP_GYRO_Write_Reg	(	void *	handle,
		uint8_t	reg,
		uint8_t	data
	)

Write the data to register.

Parameters

handle	the device handle
reg	register address
data	register data

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 889 of file SensorTile_gyro.c.

STSW-STLKT01: SENSORTILE_GYRO Exported functions

STSW-STLKT01

Functions

Detailed Description

Function Documentation

◆ BSP_GYRO_Check_WhoAmI()

◆ BSP_GYRO_DeInit()

◆ BSP_GYRO_Get_Axes()

◆ BSP_GYRO_Get_Axes_Status()

◆ BSP_GYRO_Get_AxesRaw()

◆ BSP_GYRO_Get_DRDY_Status()

◆ BSP_GYRO_Get_FS()

◆ BSP_GYRO_Get_Instance()

◆ BSP_GYRO_Get_ODR()

◆ BSP_GYRO_Get_Sensitivity()

◆ BSP_GYRO_Get_WhoAmI()

◆ BSP_GYRO_Init()

◆ BSP_GYRO_IsCombo()

◆ BSP_GYRO_IsEnabled()

◆ BSP_GYRO_IsInitialized()

◆ BSP_GYRO_Read_Reg()

◆ BSP_GYRO_Sensor_Disable()

◆ BSP_GYRO_Sensor_Enable()

◆ BSP_GYRO_Set_Axes_Status()

◆ BSP_GYRO_Set_FS()

◆ BSP_GYRO_Set_FS_Value()

◆ BSP_GYRO_Set_ODR()

◆ BSP_GYRO_Set_ODR_Value()

◆ BSP_GYRO_Write_Reg()

Get in touch