HTS221_Driver.h

Go to the documentation of this file.

 
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __HTS221_DRIVER__H
#define __HTS221_DRIVER__H
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Uncomment the line below to expanse the "assert_param" macro in the drivers code */
#define USE_FULL_ASSERT_HTS221
 
/* Exported macro ------------------------------------------------------------*/
#ifdef  USE_FULL_ASSERT_HTS221
 
#define HTS221_assert_param(expr) ((expr) ? (void)0 : HTS221_assert_failed((uint8_t *)__FILE__, __LINE__))
/* Exported functions ------------------------------------------------------- */
void HTS221_assert_failed(uint8_t* file, uint32_t line);
#else
#define HTS221_assert_param(expr) ((void)0)
#endif /* USE_FULL_ASSERT_HTS221 */
 
/* Exported Types -------------------------------------------------------------*/
typedef enum {HTS221_OK = (uint8_t)0, HTS221_ERROR = !HTS221_OK} HTS221_Error_et;
 
typedef enum {HTS221_DISABLE = (uint8_t)0, HTS221_ENABLE = !HTS221_DISABLE} HTS221_State_et;
#define IS_HTS221_State(MODE) ((MODE == HTS221_ENABLE) || (MODE == HTS221_DISABLE))
 
typedef enum {HTS221_RESET = (uint8_t)0, HTS221_SET = !HTS221_RESET} HTS221_BitStatus_et;
#define IS_HTS221_BitStatus(MODE) ((MODE == HTS221_RESET) || (MODE == HTS221_SET))
 
typedef enum
{
  HTS221_AVGH_4         = (uint8_t)0x00,         
  HTS221_AVGH_8         = (uint8_t)0x01,         
  HTS221_AVGH_16        = (uint8_t)0x02,         
  HTS221_AVGH_32        = (uint8_t)0x03,         
  HTS221_AVGH_64        = (uint8_t)0x04,         
  HTS221_AVGH_128       = (uint8_t)0x05,         
  HTS221_AVGH_256       = (uint8_t)0x06,         
  HTS221_AVGH_512       = (uint8_t)0x07          
} HTS221_Avgh_et;
#define IS_HTS221_AVGH(AVGH) ((AVGH == HTS221_AVGH_4) || (AVGH == HTS221_AVGH_8) || \
                              (AVGH == HTS221_AVGH_16) || (AVGH == HTS221_AVGH_32) || \
                              (AVGH == HTS221_AVGH_64) || (AVGH == HTS221_AVGH_128) || \
                              (AVGH == HTS221_AVGH_256) || (AVGH == HTS221_AVGH_512))
 
typedef enum
{
  HTS221_AVGT_2         = (uint8_t)0x00,        
  HTS221_AVGT_4         = (uint8_t)0x08,        
  HTS221_AVGT_8         = (uint8_t)0x10,        
  HTS221_AVGT_16        = (uint8_t)0x18,        
  HTS221_AVGT_32        = (uint8_t)0x20,        
  HTS221_AVGT_64        = (uint8_t)0x28,        
  HTS221_AVGT_128       = (uint8_t)0x30,        
  HTS221_AVGT_256       = (uint8_t)0x38         
} HTS221_Avgt_et;
#define IS_HTS221_AVGT(AVGT) ((AVGT == HTS221_AVGT_2) || (AVGT == HTS221_AVGT_4) || \
                              (AVGT == HTS221_AVGT_8) || (AVGT == HTS221_AVGT_16) || \
                              (AVGT == HTS221_AVGT_32) || (AVGT == HTS221_AVGT_64) || \
                              (AVGT == HTS221_AVGT_128) || (AVGT == HTS221_AVGT_256))
 
typedef enum
{
  HTS221_ODR_ONE_SHOT  = (uint8_t)0x00,         
  HTS221_ODR_1HZ       = (uint8_t)0x01,         
  HTS221_ODR_7HZ       = (uint8_t)0x02,         
  HTS221_ODR_12_5HZ    = (uint8_t)0x03,         
} HTS221_Odr_et;
#define IS_HTS221_ODR(ODR) ((ODR == HTS221_ODR_ONE_SHOT) || (ODR == HTS221_ODR_1HZ) || \
                            (ODR == HTS221_ODR_7HZ) || (ODR == HTS221_ODR_12_5HZ))
 
 
typedef enum
{
  HTS221_PUSHPULL   = (uint8_t)0x00,   
  HTS221_OPENDRAIN  = (uint8_t)0x40    
} HTS221_OutputType_et;
#define IS_HTS221_OutputType(MODE) ((MODE == HTS221_PUSHPULL) || (MODE == HTS221_OPENDRAIN))
 
typedef enum
{
  HTS221_HIGH_LVL   = (uint8_t)0x00,   
  HTS221_LOW_LVL    = (uint8_t)0x80    
} HTS221_DrdyLevel_et;
#define IS_HTS221_DrdyLevelType(MODE) ((MODE == HTS221_HIGH_LVL) || (MODE == HTS221_LOW_LVL))
 
typedef struct
{
  uint8_t   Major;
  uint8_t   Minor;
  uint8_t   Point;
} HTS221_DriverVersion_st;
 
 
typedef struct
{
  HTS221_Avgh_et        avg_h;            
  HTS221_Avgt_et        avg_t;            
  HTS221_Odr_et         odr;              
  HTS221_State_et       bdu_status;       
  HTS221_State_et       heater_status;    
  HTS221_DrdyLevel_et   irq_level;        
  HTS221_OutputType_et  irq_output_type;  
  HTS221_State_et       irq_enable;       
} HTS221_Init_st;
 
/* Exported Constants ---------------------------------------------------------*/
#define HTS221_BIT(x) ((uint8_t)x)
 
#define HTS221_I2C_ADDRESS  (uint8_t)0xBE
 
#define HTS221_DRIVER_VERSION_MAJOR (uint8_t)1
#define HTS221_DRIVER_VERSION_MINOR (uint8_t)1
#define HTS221_DRIVER_VERSION_POINT (uint8_t)0
 
#define HTS221_WHO_AM_I_REG          (uint8_t)0x0F
 
#define HTS221_WHO_AM_I_VAL         (uint8_t)0xBC
 
 
#define HTS221_AV_CONF_REG        (uint8_t)0x10
 
#define HTS221_AVGT_BIT           HTS221_BIT(3)
#define HTS221_AVGH_BIT           HTS221_BIT(0)
 
#define HTS221_AVGH_MASK          (uint8_t)0x07
#define HTS221_AVGT_MASK          (uint8_t)0x38
 
#define HTS221_CTRL_REG1      (uint8_t)0x20
 
#define HTS221_PD_BIT          HTS221_BIT(7)
#define HTS221_BDU_BIT         HTS221_BIT(2)
#define HTS221_ODR_BIT         HTS221_BIT(0)
 
#define HTS221_PD_MASK        (uint8_t)0x80
#define HTS221_BDU_MASK       (uint8_t)0x04
#define HTS221_ODR_MASK       (uint8_t)0x03
 
#define HTS221_CTRL_REG2      (uint8_t)0x21
 
#define HTS221_BOOT_BIT        HTS221_BIT(7)
#define HTS221_HEATER_BIT      HTS221_BIT(1)
#define HTS221_ONESHOT_BIT     HTS221_BIT(0)
 
#define HTS221_BOOT_MASK      (uint8_t)0x80
#define HTS221_HEATER_MASK    (uint8_t)0x02
#define HTS221_ONE_SHOT_MASK  (uint8_t)0x01
 
#define HTS221_CTRL_REG3      (uint8_t)0x22
 
#define HTS221_DRDY_H_L_BIT    HTS221_BIT(7)
#define HTS221_PP_OD_BIT       HTS221_BIT(6)
#define HTS221_DRDY_BIT        HTS221_BIT(2)
 
#define HTS221_DRDY_H_L_MASK  (uint8_t)0x80
#define HTS221_PP_OD_MASK     (uint8_t)0x40
#define HTS221_DRDY_MASK      (uint8_t)0x04
 
#define HTS221_STATUS_REG    (uint8_t)0x27
 
#define HTS221_H_DA_BIT       HTS221_BIT(1)
#define HTS221_T_DA_BIT       HTS221_BIT(0)
 
#define HTS221_HDA_MASK      (uint8_t)0x02
#define HTS221_TDA_MASK      (uint8_t)0x01
 
#define HTS221_HR_OUT_L_REG        (uint8_t)0x28
 
#define HTS221_HR_OUT_H_REG        (uint8_t)0x29
 
 
#define HTS221_TEMP_OUT_L_REG         (uint8_t)0x2A
 
#define HTS221_TEMP_OUT_H_REG         (uint8_t)0x2B
 
#define HTS221_H0_RH_X2        (uint8_t)0x30
#define HTS221_H1_RH_X2        (uint8_t)0x31
#define HTS221_T0_DEGC_X8      (uint8_t)0x32
#define HTS221_T1_DEGC_X8      (uint8_t)0x33
#define HTS221_T0_T1_DEGC_H2   (uint8_t)0x35
#define HTS221_H0_T0_OUT_L     (uint8_t)0x36
#define HTS221_H0_T0_OUT_H     (uint8_t)0x37
#define HTS221_H1_T0_OUT_L     (uint8_t)0x3A
#define HTS221_H1_T0_OUT_H     (uint8_t)0x3B
#define HTS221_T0_OUT_L        (uint8_t)0x3C
#define HTS221_T0_OUT_H        (uint8_t)0x3D
#define HTS221_T1_OUT_L        (uint8_t)0x3E
#define HTS221_T1_OUT_H        (uint8_t)0x3F
 
 
/* Exported Functions -------------------------------------------------------------*/
HTS221_Error_et HTS221_ReadReg( void *handle, uint8_t RegAddr, uint16_t NumByteToRead, uint8_t *Data );
HTS221_Error_et HTS221_WriteReg( void *handle, uint8_t RegAddr, uint16_t NumByteToWrite, uint8_t *Data );
 
HTS221_Error_et HTS221_Get_DriverVersion(HTS221_DriverVersion_st* version);
HTS221_Error_et HTS221_Get_DeviceID(void *handle, uint8_t* deviceid);
 
HTS221_Error_et HTS221_Set_InitConfig(void *handle, HTS221_Init_st* pxInit);
HTS221_Error_et HTS221_Get_InitConfig(void *handle, HTS221_Init_st* pxInit);
HTS221_Error_et HTS221_DeInit(void *handle);
HTS221_Error_et HTS221_IsMeasurementCompleted(void *handle, HTS221_BitStatus_et* Is_Measurement_Completed);
 
HTS221_Error_et HTS221_Get_Measurement(void *handle, uint16_t* humidity, int16_t* temperature);
HTS221_Error_et HTS221_Get_RawMeasurement(void *handle, int16_t* humidity, int16_t* temperature);
HTS221_Error_et HTS221_Get_Humidity(void *handle, uint16_t* value);
HTS221_Error_et HTS221_Get_HumidityRaw(void *handle, int16_t* value);
HTS221_Error_et HTS221_Get_TemperatureRaw(void *handle, int16_t* value);
HTS221_Error_et HTS221_Get_Temperature(void *handle, int16_t* value);
HTS221_Error_et HTS221_Get_DataStatus(void *handle, HTS221_BitStatus_et* humidity, HTS221_BitStatus_et* temperature);
HTS221_Error_et HTS221_Activate(void *handle);
HTS221_Error_et HTS221_DeActivate(void *handle);
 
HTS221_Error_et HTS221_Set_AvgHT(void *handle, HTS221_Avgh_et avgh, HTS221_Avgt_et avgt);
HTS221_Error_et HTS221_Set_AvgH(void *handle, HTS221_Avgh_et avgh);
HTS221_Error_et HTS221_Set_AvgT(void *handle, HTS221_Avgt_et avgt);
HTS221_Error_et HTS221_Get_AvgHT(void *handle, HTS221_Avgh_et* avgh, HTS221_Avgt_et* avgt);
HTS221_Error_et HTS221_Set_BduMode(void *handle, HTS221_State_et status);
HTS221_Error_et HTS221_Get_BduMode(void *handle, HTS221_State_et* status);
HTS221_Error_et HTS221_Set_PowerDownMode(void *handle, HTS221_BitStatus_et status);
HTS221_Error_et HTS221_Get_PowerDownMode(void *handle, HTS221_BitStatus_et* status);
HTS221_Error_et HTS221_Set_Odr(void *handle, HTS221_Odr_et odr);
HTS221_Error_et HTS221_Get_Odr(void *handle, HTS221_Odr_et* odr);
HTS221_Error_et HTS221_MemoryBoot(void *handle);
HTS221_Error_et HTS221_Set_HeaterState(void *handle, HTS221_State_et status);
HTS221_Error_et HTS221_Get_HeaterState(void *handle, HTS221_State_et* status);
HTS221_Error_et HTS221_StartOneShotMeasurement(void *handle);
HTS221_Error_et HTS221_Set_IrqActiveLevel(void *handle, HTS221_DrdyLevel_et status);
HTS221_Error_et HTS221_Get_IrqActiveLevel(void *handle, HTS221_DrdyLevel_et* status);
HTS221_Error_et HTS221_Set_IrqOutputType(void *handle, HTS221_OutputType_et value);
HTS221_Error_et HTS221_Get_IrqOutputType(void *handle, HTS221_OutputType_et* value);
HTS221_Error_et HTS221_Set_IrqEnable(void *handle, HTS221_State_et status);
HTS221_Error_et HTS221_Get_IrqEnable(void *handle, HTS221_State_et* status);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __HTS221_DRIVER__H */
 
/******************* (C) COPYRIGHT 2013 STMicroelectronics *****END OF FILE****/