STSW-STLKT01: SENSORTILE_TEMPERATURE Exported functions

STSW-STLKT01

STSW-STLKT01
SENSORTILE_TEMPERATURE Exported functions

Functions

DrvStatusTypeDef BSP_TEMPERATURE_Init (TEMPERATURE_ID_t id, void **handle)
 Initialize a temperature sensor. More...
 
DrvStatusTypeDef BSP_TEMPERATURE_DeInit (void **handle)
 Deinitialize a temperature sensor. More...
 
DrvStatusTypeDef BSP_TEMPERATURE_Sensor_Enable (void *handle)
 Enable temperature sensor. More...
 
DrvStatusTypeDef BSP_TEMPERATURE_Sensor_Disable (void *handle)
 Disable temperature sensor. More...
 
DrvStatusTypeDef BSP_TEMPERATURE_IsInitialized (void *handle, uint8_t *status)
 Check if the temperature sensor is initialized. More...
 
DrvStatusTypeDef BSP_TEMPERATURE_IsEnabled (void *handle, uint8_t *status)
 Check if the temperature sensor is enabled. More...
 
DrvStatusTypeDef BSP_TEMPERATURE_IsCombo (void *handle, uint8_t *status)
 Check if the temperature sensor is combo. More...
 
DrvStatusTypeDef BSP_TEMPERATURE_Get_Instance (void *handle, uint8_t *instance)
 Get the temperature sensor instance. More...
 
DrvStatusTypeDef BSP_TEMPERATURE_Get_WhoAmI (void *handle, uint8_t *who_am_i)
 Get the WHO_AM_I ID of the temperature sensor. More...
 
DrvStatusTypeDef BSP_TEMPERATURE_Check_WhoAmI (void *handle)
 Check the WHO_AM_I ID of the temperature sensor. More...
 
DrvStatusTypeDef BSP_TEMPERATURE_Get_Temp (void *handle, float *temperature)
 Get the temperature value. More...
 
DrvStatusTypeDef BSP_TEMPERATURE_Get_ODR (void *handle, float *odr)
 Get the temperature sensor output data rate. More...
 
DrvStatusTypeDef BSP_TEMPERATURE_Set_ODR (void *handle, SensorOdr_t odr)
 Set the temperature sensor output data rate. More...
 
DrvStatusTypeDef BSP_TEMPERATURE_Set_ODR_Value (void *handle, float odr)
 Set the temperature sensor output data rate. More...
 
DrvStatusTypeDef BSP_TEMPERATURE_Read_Reg (void *handle, uint8_t reg, uint8_t *data)
 Read the data from register. More...
 
DrvStatusTypeDef BSP_TEMPERATURE_Write_Reg (void *handle, uint8_t reg, uint8_t data)
 Write the data to register. More...
 
DrvStatusTypeDef BSP_TEMPERATURE_Get_DRDY_Status (void *handle, uint8_t *status)
 Get temperature data ready status. More...
 

Detailed Description

Function Documentation

◆ BSP_TEMPERATURE_Check_WhoAmI()

DrvStatusTypeDef BSP_TEMPERATURE_Check_WhoAmI ( void *  handle)

Check the WHO_AM_I ID of the temperature sensor.

Parameters
handlethe device handle
Return values
COMPONENT_OKin case of success
COMPONENT_ERRORin case of failure

Definition at line 526 of file SensorTile_temperature.c.

◆ BSP_TEMPERATURE_DeInit()

DrvStatusTypeDef BSP_TEMPERATURE_DeInit ( void **  handle)

Deinitialize a temperature sensor.

Parameters
handlethe device handle
Return values
COMPONENT_OKin case of success
COMPONENT_ERRORin case of failure

Definition at line 276 of file SensorTile_temperature.c.

◆ BSP_TEMPERATURE_Get_DRDY_Status()

DrvStatusTypeDef BSP_TEMPERATURE_Get_DRDY_Status ( void *  handle,
uint8_t *  status 
)

Get temperature data ready status.

Parameters
handlethe device handle
statusthe data ready status
Return values
COMPONENT_OKin case of success
COMPONENT_ERRORin case of failure

Definition at line 779 of file SensorTile_temperature.c.

◆ BSP_TEMPERATURE_Get_Instance()

DrvStatusTypeDef BSP_TEMPERATURE_Get_Instance ( void *  handle,
uint8_t *  instance 
)

Get the temperature sensor instance.

Parameters
handlethe device handle
instancethe pointer to the device instance
Return values
COMPONENT_OKin case of success
COMPONENT_ERRORin case of failure

Definition at line 461 of file SensorTile_temperature.c.

◆ BSP_TEMPERATURE_Get_ODR()

DrvStatusTypeDef BSP_TEMPERATURE_Get_ODR ( void *  handle,
float *  odr 
)

Get the temperature sensor output data rate.

Parameters
handlethe device handle
odrpointer where the output data rate is written
Return values
COMPONENT_OKin case of success
COMPONENT_ERRORin case of failure

Definition at line 598 of file SensorTile_temperature.c.

◆ BSP_TEMPERATURE_Get_Temp()

DrvStatusTypeDef BSP_TEMPERATURE_Get_Temp ( void *  handle,
float *  temperature 
)

Get the temperature value.

Parameters
handlethe device handle
temperaturepointer where the value is written [C]
Return values
COMPONENT_OKin case of success
COMPONENT_ERRORin case of failure

Definition at line 560 of file SensorTile_temperature.c.

◆ BSP_TEMPERATURE_Get_WhoAmI()

DrvStatusTypeDef BSP_TEMPERATURE_Get_WhoAmI ( void *  handle,
uint8_t *  who_am_i 
)

Get the WHO_AM_I ID of the temperature sensor.

Parameters
handlethe device handle
who_am_ipointer to the value of WHO_AM_I register
Return values
COMPONENT_OKin case of success
COMPONENT_ERRORin case of failure

Definition at line 489 of file SensorTile_temperature.c.

◆ BSP_TEMPERATURE_Init()

DrvStatusTypeDef BSP_TEMPERATURE_Init ( TEMPERATURE_ID_t  id,
void **  handle 
)

Initialize a temperature sensor.

Parameters
idthe temperature sensor identifier
handlethe device handle
Return values
COMPONENT_OKin case of success
COMPONENT_ERRORin case of failure

Definition at line 92 of file SensorTile_temperature.c.

◆ BSP_TEMPERATURE_IsCombo()

DrvStatusTypeDef BSP_TEMPERATURE_IsCombo ( void *  handle,
uint8_t *  status 
)

Check if the temperature sensor is combo.

Parameters
handlethe device handle
statusthe pointer to the combo status
Return values
COMPONENT_OKin case of success
COMPONENT_ERRORin case of failure

Definition at line 434 of file SensorTile_temperature.c.

◆ BSP_TEMPERATURE_IsEnabled()

DrvStatusTypeDef BSP_TEMPERATURE_IsEnabled ( void *  handle,
uint8_t *  status 
)

Check if the temperature sensor is enabled.

Parameters
handlethe device handle
statusthe pointer to the enable status
Return values
COMPONENT_OKin case of success
COMPONENT_ERRORin case of failure

Definition at line 407 of file SensorTile_temperature.c.

◆ BSP_TEMPERATURE_IsInitialized()

DrvStatusTypeDef BSP_TEMPERATURE_IsInitialized ( void *  handle,
uint8_t *  status 
)

Check if the temperature sensor is initialized.

Parameters
handlethe device handle
statusthe pointer to the initialization status
Return values
COMPONENT_OKin case of success
COMPONENT_ERRORin case of failure

Definition at line 380 of file SensorTile_temperature.c.

◆ BSP_TEMPERATURE_Read_Reg()

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

Read the data from register.

Parameters
handlethe device handle
regregister address
dataregister data
Return values
COMPONENT_OKin case of success
COMPONENT_ERRORin case of failure

Definition at line 705 of file SensorTile_temperature.c.

◆ BSP_TEMPERATURE_Sensor_Disable()

DrvStatusTypeDef BSP_TEMPERATURE_Sensor_Disable ( void *  handle)

Disable temperature sensor.

Parameters
handlethe device handle
Return values
COMPONENT_OKin case of success
COMPONENT_ERRORin case of failure

Definition at line 346 of file SensorTile_temperature.c.

◆ BSP_TEMPERATURE_Sensor_Enable()

DrvStatusTypeDef BSP_TEMPERATURE_Sensor_Enable ( void *  handle)

Enable temperature sensor.

Parameters
handlethe device handle
Return values
COMPONENT_OKin case of success
COMPONENT_ERRORin case of failure

Definition at line 312 of file SensorTile_temperature.c.

◆ BSP_TEMPERATURE_Set_ODR()

DrvStatusTypeDef BSP_TEMPERATURE_Set_ODR ( void *  handle,
SensorOdr_t  odr 
)

Set the temperature sensor output data rate.

Parameters
handlethe device handle
odrthe functional output data rate to be set
Return values
COMPONENT_OKin case of success
COMPONENT_ERRORin case of failure

Definition at line 636 of file SensorTile_temperature.c.

◆ BSP_TEMPERATURE_Set_ODR_Value()

DrvStatusTypeDef BSP_TEMPERATURE_Set_ODR_Value ( void *  handle,
float  odr 
)

Set the temperature sensor output data rate.

Parameters
handlethe device handle
odrthe output data rate value to be set
Return values
COMPONENT_OKin case of success
COMPONENT_ERRORin case of failure

Definition at line 670 of file SensorTile_temperature.c.

◆ BSP_TEMPERATURE_Write_Reg()

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

Write the data to register.

Parameters
handlethe device handle
regregister address
dataregister data
Return values
COMPONENT_OKin case of success
COMPONENT_ERRORin case of failure

Definition at line 745 of file SensorTile_temperature.c.

Generated by   doxygen 1.8.13