Functions
DrvStatusTypeDef	BSP_MAGNETO_Init (MAGNETO_ID_t id, void **handle)
	Initialize a magnetometer sensor. More...

DrvStatusTypeDef	BSP_MAGNETO_DeInit (void **handle)
	Deinitialize a magnetometer sensor. More...

DrvStatusTypeDef	BSP_MAGNETO_Sensor_Enable (void *handle)
	Enable magnetometer sensor. More...

DrvStatusTypeDef	BSP_MAGNETO_Sensor_Disable (void *handle)
	Disable magnetometer sensor. More...

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

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

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

DrvStatusTypeDef	BSP_MAGNETO_Get_Instance (void handle, uint8_t instance)
	Get the magnetometer sensor instance. More...

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

DrvStatusTypeDef	BSP_MAGNETO_Check_WhoAmI (void *handle)
	Check the WHO_AM_I ID of the magnetometer sensor. More...

DrvStatusTypeDef	BSP_MAGNETO_Get_Axes (void handle, SensorAxes_t magnetic_field)
	Get the magnetometer sensor axes. More...

DrvStatusTypeDef	BSP_MAGNETO_Get_AxesRaw (void handle, SensorAxesRaw_t value)
	Get the magnetometer sensor raw axes. More...

DrvStatusTypeDef	BSP_MAGNETO_Get_Sensitivity (void handle, float sensitivity)
	Get the magnetometer sensor sensitivity. More...

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

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

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

DrvStatusTypeDef	BSP_MAGNETO_Get_FS (void handle, float fullScale)
	Get the magnetometer sensor full scale. More...

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

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

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

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

DrvStatusTypeDef	BSP_MAGNETO_Get_DRDY_Status (void handle, uint8_t status)
	Get magnetometer data ready status. More...

Detailed Description

Function Documentation

◆ BSP_MAGNETO_Check_WhoAmI()

DrvStatusTypeDef BSP_MAGNETO_Check_WhoAmI ( void * handle )

Check the WHO_AM_I ID of the magnetometer sensor.

Parameters

handle the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 459 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_DeInit()

DrvStatusTypeDef BSP_MAGNETO_DeInit ( void ** handle )

Deinitialize a magnetometer sensor.

Parameters

handle the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 209 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_Get_Axes()

DrvStatusTypeDef BSP_MAGNETO_Get_Axes	(	void *	handle,
		SensorAxes_t *	magnetic_field
	)

Get the magnetometer sensor axes.

Parameters

handle	the device handle
magnetic_field	pointer where the values of the axes are written [mgauss]

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 493 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_Get_AxesRaw()

DrvStatusTypeDef BSP_MAGNETO_Get_AxesRaw	(	void *	handle,
		SensorAxesRaw_t *	value
	)

Get the magnetometer 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 531 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_Get_DRDY_Status()

DrvStatusTypeDef BSP_MAGNETO_Get_DRDY_Status	(	void *	handle,
		uint8_t *	status
	)

Get magnetometer 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 898 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_Get_FS()

DrvStatusTypeDef BSP_MAGNETO_Get_FS	(	void *	handle,
		float *	fullScale
	)

Get the magnetometer 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 716 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_Get_Instance()

DrvStatusTypeDef BSP_MAGNETO_Get_Instance	(	void *	handle,
		uint8_t *	instance
	)

Get the magnetometer 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 394 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_Get_ODR()

DrvStatusTypeDef BSP_MAGNETO_Get_ODR	(	void *	handle,
		float *	odr
	)

Get the magnetometer 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 610 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_Get_Sensitivity()

DrvStatusTypeDef BSP_MAGNETO_Get_Sensitivity	(	void *	handle,
		float *	sensitivity
	)

Get the magnetometer sensor sensitivity.

Parameters

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

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 572 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_Get_WhoAmI()

DrvStatusTypeDef BSP_MAGNETO_Get_WhoAmI	(	void *	handle,
		uint8_t *	who_am_i
	)

Get the WHO_AM_I ID of the magnetometer 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 422 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_Init()

DrvStatusTypeDef BSP_MAGNETO_Init	(	MAGNETO_ID_t	id,
		void **	handle
	)

Initialize a magnetometer sensor.

Parameters

id	the magnetometer sensor identifier
handle	the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 101 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_IsCombo()

DrvStatusTypeDef BSP_MAGNETO_IsCombo	(	void *	handle,
		uint8_t *	status
	)

Check if the magnetometer 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 367 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_IsEnabled()

DrvStatusTypeDef BSP_MAGNETO_IsEnabled	(	void *	handle,
		uint8_t *	status
	)

Check if the magnetometer 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 340 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_IsInitialized()

DrvStatusTypeDef BSP_MAGNETO_IsInitialized	(	void *	handle,
		uint8_t *	status
	)

Check if the magnetometer 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 313 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_Read_Reg()

DrvStatusTypeDef BSP_MAGNETO_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 822 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_Sensor_Disable()

DrvStatusTypeDef BSP_MAGNETO_Sensor_Disable ( void * handle )

Disable magnetometer sensor.

Parameters

handle the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 279 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_Sensor_Enable()

DrvStatusTypeDef BSP_MAGNETO_Sensor_Enable ( void * handle )

Enable magnetometer sensor.

Parameters

handle the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 245 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_Set_FS()

DrvStatusTypeDef BSP_MAGNETO_Set_FS	(	void *	handle,
		SensorFs_t	fullScale
	)

Set the magnetometer 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 754 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_Set_FS_Value()

DrvStatusTypeDef BSP_MAGNETO_Set_FS_Value	(	void *	handle,
		float	fullScale
	)

Set the magnetometer 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 788 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_Set_ODR()

DrvStatusTypeDef BSP_MAGNETO_Set_ODR	(	void *	handle,
		SensorOdr_t	odr
	)

Set the magnetometer 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 648 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_Set_ODR_Value()

DrvStatusTypeDef BSP_MAGNETO_Set_ODR_Value	(	void *	handle,
		float	odr
	)

Set the magnetometer 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 682 of file SensorTile_magneto.c.

◆ BSP_MAGNETO_Write_Reg()

DrvStatusTypeDef BSP_MAGNETO_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 863 of file SensorTile_magneto.c.

STSW-STLKT01: SENSORTILE_MAGNETO Private functions

STSW-STLKT01

Functions

Detailed Description

Function Documentation

◆ BSP_MAGNETO_Check_WhoAmI()

◆ BSP_MAGNETO_DeInit()

◆ BSP_MAGNETO_Get_Axes()

◆ BSP_MAGNETO_Get_AxesRaw()

◆ BSP_MAGNETO_Get_DRDY_Status()

◆ BSP_MAGNETO_Get_FS()

◆ BSP_MAGNETO_Get_Instance()

◆ BSP_MAGNETO_Get_ODR()

◆ BSP_MAGNETO_Get_Sensitivity()

◆ BSP_MAGNETO_Get_WhoAmI()

◆ BSP_MAGNETO_Init()

◆ BSP_MAGNETO_IsCombo()

◆ BSP_MAGNETO_IsEnabled()

◆ BSP_MAGNETO_IsInitialized()

◆ BSP_MAGNETO_Read_Reg()

◆ BSP_MAGNETO_Sensor_Disable()

◆ BSP_MAGNETO_Sensor_Enable()

◆ BSP_MAGNETO_Set_FS()

◆ BSP_MAGNETO_Set_FS_Value()

◆ BSP_MAGNETO_Set_ODR()

◆ BSP_MAGNETO_Set_ODR_Value()

◆ BSP_MAGNETO_Write_Reg()

Get in touch