Functions
DrvStatusTypeDef	BSP_HUMIDITY_Init (HUMIDITY_ID_t id, void **handle)
	Initialize a humidity sensor. More...

DrvStatusTypeDef	BSP_HUMIDITY_DeInit (void **handle)
	Deinitialize a humidity sensor. More...

DrvStatusTypeDef	BSP_HUMIDITY_Sensor_Enable (void *handle)
	Enable humidity sensor. More...

DrvStatusTypeDef	BSP_HUMIDITY_Sensor_Disable (void *handle)
	Disable humidity sensor. More...

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

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

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

DrvStatusTypeDef	BSP_HUMIDITY_Get_Instance (void handle, uint8_t instance)
	Get the humidity sensor instance. More...

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

DrvStatusTypeDef	BSP_HUMIDITY_Check_WhoAmI (void *handle)
	Check the WHO_AM_I ID of the humidity sensor. More...

DrvStatusTypeDef	BSP_HUMIDITY_Get_Hum (void handle, float humidity)
	Get the humidity value. More...

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

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

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

DrvStatusTypeDef	BSP_HUMIDITY_Get_DRDY_Status (void handle, uint8_t status)
	Get humidity data ready status. More...

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

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

Detailed Description

Function Documentation

◆ BSP_HUMIDITY_Check_WhoAmI()

DrvStatusTypeDef BSP_HUMIDITY_Check_WhoAmI ( void * handle )

Check the WHO_AM_I ID of the humidity sensor.

Parameters

handle the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 430 of file SensorTile_humidity.c.

◆ BSP_HUMIDITY_DeInit()

DrvStatusTypeDef BSP_HUMIDITY_DeInit ( void ** handle )

Deinitialize a humidity sensor.

Parameters

handle the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 178 of file SensorTile_humidity.c.

◆ BSP_HUMIDITY_Get_DRDY_Status()

DrvStatusTypeDef BSP_HUMIDITY_Get_DRDY_Status	(	void *	handle,
		uint8_t *	status
	)

Get humidity 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 618 of file SensorTile_humidity.c.

◆ BSP_HUMIDITY_Get_Hum()

DrvStatusTypeDef BSP_HUMIDITY_Get_Hum	(	void *	handle,
		float *	humidity
	)

Get the humidity value.

Parameters

handle	the device handle
humidity	pointer where the value is written [%]

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 464 of file SensorTile_humidity.c.

◆ BSP_HUMIDITY_Get_Instance()

DrvStatusTypeDef BSP_HUMIDITY_Get_Instance	(	void *	handle,
		uint8_t *	instance
	)

Get the humidity 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 365 of file SensorTile_humidity.c.

◆ BSP_HUMIDITY_Get_ODR()

DrvStatusTypeDef BSP_HUMIDITY_Get_ODR	(	void *	handle,
		float *	odr
	)

Get the humidity 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 502 of file SensorTile_humidity.c.

◆ BSP_HUMIDITY_Get_WhoAmI()

DrvStatusTypeDef BSP_HUMIDITY_Get_WhoAmI	(	void *	handle,
		uint8_t *	who_am_i
	)

Get the WHO_AM_I ID of the humidity 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 393 of file SensorTile_humidity.c.

◆ BSP_HUMIDITY_Init()

DrvStatusTypeDef BSP_HUMIDITY_Init	(	HUMIDITY_ID_t	id,
		void **	handle
	)

Initialize a humidity sensor.

Parameters

id	the humidity 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_humidity.c.

◆ BSP_HUMIDITY_IsCombo()

DrvStatusTypeDef BSP_HUMIDITY_IsCombo	(	void *	handle,
		uint8_t *	status
	)

Check if the humidity 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 338 of file SensorTile_humidity.c.

◆ BSP_HUMIDITY_IsEnabled()

DrvStatusTypeDef BSP_HUMIDITY_IsEnabled	(	void *	handle,
		uint8_t *	status
	)

Check if the humidity 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 311 of file SensorTile_humidity.c.

◆ BSP_HUMIDITY_IsInitialized()

DrvStatusTypeDef BSP_HUMIDITY_IsInitialized	(	void *	handle,
		uint8_t *	status
	)

Check if the humidity 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 284 of file SensorTile_humidity.c.

◆ BSP_HUMIDITY_Read_Reg()

DrvStatusTypeDef BSP_HUMIDITY_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 542 of file SensorTile_humidity.c.

◆ BSP_HUMIDITY_Sensor_Disable()

DrvStatusTypeDef BSP_HUMIDITY_Sensor_Disable ( void * handle )

Disable humidity sensor.

Parameters

handle the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 250 of file SensorTile_humidity.c.

◆ BSP_HUMIDITY_Sensor_Enable()

DrvStatusTypeDef BSP_HUMIDITY_Sensor_Enable ( void * handle )

Enable humidity sensor.

Parameters

handle the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 216 of file SensorTile_humidity.c.

◆ BSP_HUMIDITY_Set_ODR()

DrvStatusTypeDef BSP_HUMIDITY_Set_ODR	(	void *	handle,
		SensorOdr_t	odr
	)

Set the humidity 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 650 of file SensorTile_humidity.c.

◆ BSP_HUMIDITY_Set_ODR_Value()

DrvStatusTypeDef BSP_HUMIDITY_Set_ODR_Value	(	void *	handle,
		float	odr
	)

Set the humidity 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 684 of file SensorTile_humidity.c.

◆ BSP_HUMIDITY_Write_Reg()

DrvStatusTypeDef BSP_HUMIDITY_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 583 of file SensorTile_humidity.c.

STSW-STLKT01: SENSORTILE_HUMIDITY Exported functions

STSW-STLKT01

Functions

Detailed Description

Function Documentation

◆ BSP_HUMIDITY_Check_WhoAmI()

◆ BSP_HUMIDITY_DeInit()

◆ BSP_HUMIDITY_Get_DRDY_Status()

◆ BSP_HUMIDITY_Get_Hum()

◆ BSP_HUMIDITY_Get_Instance()

◆ BSP_HUMIDITY_Get_ODR()

◆ BSP_HUMIDITY_Get_WhoAmI()

◆ BSP_HUMIDITY_Init()

◆ BSP_HUMIDITY_IsCombo()

◆ BSP_HUMIDITY_IsEnabled()

◆ BSP_HUMIDITY_IsInitialized()

◆ BSP_HUMIDITY_Read_Reg()

◆ BSP_HUMIDITY_Sensor_Disable()

◆ BSP_HUMIDITY_Sensor_Enable()

◆ BSP_HUMIDITY_Set_ODR()

◆ BSP_HUMIDITY_Set_ODR_Value()

◆ BSP_HUMIDITY_Write_Reg()

Get in touch