STSW-STLKT01: Drivers/BSP/SensorTile/SensorTile_humidity.h Source File

STSW-STLKT01

previous page next page
STSW-STLKT01
SensorTile_humidity.h
Go to the documentation of this file.
1 
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __SENSORTILE_HUMIDITY_H
40 #define __SENSORTILE_HUMIDITY_H
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 
47 
48 /* Includes ------------------------------------------------------------------*/
49 #include "HTS221_Driver_HL.h"
50 #include "SensorTile.h"
51 
52 
69 typedef enum
70 {
71  HUMIDITY_SENSORS_AUTO = -1, /* Always first element and equal to -1 */
72  HTS221_H_0 /* Default on board. */
73 } HUMIDITY_ID_t;
74 
83 #define HUMIDITY_SENSORS_MAX_NUM 1
84 
93 /* Sensor Configuration Functions */
94 DrvStatusTypeDef BSP_HUMIDITY_Init( HUMIDITY_ID_t id, void **handle );
95 DrvStatusTypeDef BSP_HUMIDITY_DeInit( void **handle );
96 DrvStatusTypeDef BSP_HUMIDITY_Sensor_Enable( void *handle );
97 DrvStatusTypeDef BSP_HUMIDITY_Sensor_Disable( void *handle );
98 DrvStatusTypeDef BSP_HUMIDITY_IsInitialized( void *handle, uint8_t *status );
99 DrvStatusTypeDef BSP_HUMIDITY_IsEnabled( void *handle, uint8_t *status );
100 DrvStatusTypeDef BSP_HUMIDITY_IsCombo( void *handle, uint8_t *status );
101 DrvStatusTypeDef BSP_HUMIDITY_Get_Instance( void *handle, uint8_t *instance );
102 DrvStatusTypeDef BSP_HUMIDITY_Get_WhoAmI( void *handle, uint8_t *who_am_i );
103 DrvStatusTypeDef BSP_HUMIDITY_Check_WhoAmI( void *handle );
104 DrvStatusTypeDef BSP_HUMIDITY_Get_Hum( void *handle, float *humidity );
105 DrvStatusTypeDef BSP_HUMIDITY_Get_ODR( void *handle, float *odr );
106 DrvStatusTypeDef BSP_HUMIDITY_Set_ODR( void *handle, SensorOdr_t odr );
107 DrvStatusTypeDef BSP_HUMIDITY_Set_ODR_Value( void *handle, float odr );
108 DrvStatusTypeDef BSP_HUMIDITY_Read_Reg( void *handle, uint8_t reg, uint8_t *data );
109 DrvStatusTypeDef BSP_HUMIDITY_Write_Reg( void *handle, uint8_t reg, uint8_t data );
110 DrvStatusTypeDef BSP_HUMIDITY_Get_DRDY_Status( void *handle, uint8_t *status );
111 
128 #ifdef __cplusplus
129 }
130 #endif
131 
132 #endif /* __SENSORTILE_HUMIDITY_H */
133 
134 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
BSP_HUMIDITY_Init
DrvStatusTypeDef BSP_HUMIDITY_Init(HUMIDITY_ID_t id, void **handle)
Initialize a humidity sensor.
Definition: SensorTile_humidity.c:88
BSP_HUMIDITY_Read_Reg
DrvStatusTypeDef BSP_HUMIDITY_Read_Reg(void *handle, uint8_t reg, uint8_t *data)
Read the data from register.
Definition: SensorTile_humidity.c:542
BSP_HUMIDITY_Set_ODR
DrvStatusTypeDef BSP_HUMIDITY_Set_ODR(void *handle, SensorOdr_t odr)
Set the humidity sensor output data rate.
Definition: SensorTile_humidity.c:650
BSP_HUMIDITY_IsInitialized
DrvStatusTypeDef BSP_HUMIDITY_IsInitialized(void *handle, uint8_t *status)
Check if the humidity sensor is initialized.
Definition: SensorTile_humidity.c:284
BSP_HUMIDITY_Get_ODR
DrvStatusTypeDef BSP_HUMIDITY_Get_ODR(void *handle, float *odr)
Get the humidity sensor output data rate.
Definition: SensorTile_humidity.c:502
BSP_HUMIDITY_IsEnabled
DrvStatusTypeDef BSP_HUMIDITY_IsEnabled(void *handle, uint8_t *status)
Check if the humidity sensor is enabled.
Definition: SensorTile_humidity.c:311
SensorTile.h
This file contains definitions for SensorTile.c file.
BSP_HUMIDITY_Check_WhoAmI
DrvStatusTypeDef BSP_HUMIDITY_Check_WhoAmI(void *handle)
Check the WHO_AM_I ID of the humidity sensor.
Definition: SensorTile_humidity.c:430
BSP_HUMIDITY_Sensor_Enable
DrvStatusTypeDef BSP_HUMIDITY_Sensor_Enable(void *handle)
Enable humidity sensor.
Definition: SensorTile_humidity.c:216
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.
Definition: SensorTile_humidity.c:393
BSP_HUMIDITY_Set_ODR_Value
DrvStatusTypeDef BSP_HUMIDITY_Set_ODR_Value(void *handle, float odr)
Set the humidity sensor output data rate.
Definition: SensorTile_humidity.c:684
BSP_HUMIDITY_Write_Reg
DrvStatusTypeDef BSP_HUMIDITY_Write_Reg(void *handle, uint8_t reg, uint8_t data)
Write the data to register.
Definition: SensorTile_humidity.c:583
BSP_HUMIDITY_Get_DRDY_Status
DrvStatusTypeDef BSP_HUMIDITY_Get_DRDY_Status(void *handle, uint8_t *status)
Get humidity data ready status.
Definition: SensorTile_humidity.c:618
BSP_HUMIDITY_Get_Hum
DrvStatusTypeDef BSP_HUMIDITY_Get_Hum(void *handle, float *humidity)
Get the humidity value.
Definition: SensorTile_humidity.c:464
BSP_HUMIDITY_Get_Instance
DrvStatusTypeDef BSP_HUMIDITY_Get_Instance(void *handle, uint8_t *instance)
Get the humidity sensor instance.
Definition: SensorTile_humidity.c:365
BSP_HUMIDITY_DeInit
DrvStatusTypeDef BSP_HUMIDITY_DeInit(void **handle)
Deinitialize a humidity sensor.
Definition: SensorTile_humidity.c:178
BSP_HUMIDITY_IsCombo
DrvStatusTypeDef BSP_HUMIDITY_IsCombo(void *handle, uint8_t *status)
Check if the humidity sensor is combo.
Definition: SensorTile_humidity.c:338
BSP_HUMIDITY_Sensor_Disable
DrvStatusTypeDef BSP_HUMIDITY_Sensor_Disable(void *handle)
Disable humidity sensor.
Definition: SensorTile_humidity.c:250
Generated by   doxygen 1.8.13
previous page start next page