hum_temp.h

00001 /**
00002   ******************************************************************************
00003   * @file    hum_temp.h
00004   * @author  MEMS Application Team
00005   * @version V1.0.0
00006   * @date    30-July-2014
00007   * @brief   This header file contains the functions prototypes for the 
00008   *          humidity and temperature driver.
00009   ******************************************************************************
00010   * @attention
00011   *
00012   * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
00013   *
00014   * Redistribution and use in source and binary forms, with or without modification,
00015   * are permitted provided that the following conditions are met:
00016   *   1. Redistributions of source code must retain the above copyright notice,
00017   *      this list of conditions and the following disclaimer.
00018   *   2. Redistributions in binary form must reproduce the above copyright notice,
00019   *      this list of conditions and the following disclaimer in the documentation
00020   *      and/or other materials provided with the distribution.
00021   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00022   *      may be used to endorse or promote products derived from this software
00023   *      without specific prior written permission.
00024   *
00025   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00026   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00028   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00029   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00030   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00031   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00032   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00033   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00034   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035   *
00036   ******************************************************************************
00037   */
00038   
00039 
00040 /* Define to prevent recursive inclusion -------------------------------------*/
00041 #ifndef __HUM_TEMP_H
00042 #define __HUM_TEMP_H
00043 
00044 #ifdef __cplusplus
00045  extern "C" {
00046 #endif
00047 
00048 /* Includes ------------------------------------------------------------------*/
00049 #include <stdint.h> 
00050 
00051 /** 
00052   * @brief  Humidity and temperature init structure definition  
00053   */ 
00054 typedef struct
00055 {
00056   uint8_t Power_Mode;                         /* Power-down/Sleep/Normal Mode */
00057   uint8_t Data_Update_Mode;                   /* continuous update/output registers not updated until MSB and LSB reading*/
00058   uint8_t Reboot_Mode;                        /* Normal Mode/Reboot memory content */
00059   uint8_t Humidity_Resolutin;                 /* Humidity Resolution */
00060   uint8_t Temperature_Resolution;             /* Temperature Resolution */
00061   uint8_t OutputDataRate;                     /* One-shot / 1Hz / 7 Hz / 12.5 Hz */
00062 }HUM_TEMP_InitTypeDef;
00063 
00064 /** 
00065   * @brief  Humidity and temperature status enumerator definition  
00066   */ 
00067 typedef enum {
00068     HUM_TEMP_OK = 0,
00069     HUM_TEMP_ERROR = 1,
00070     HUM_TEMP_TIMEOUT = 2
00071 } HUM_TEMP_StatusTypeDef;
00072 
00073 /** 
00074   * @brief  Humidity and temperature driver structure definition  
00075   */ 
00076 typedef struct
00077 {  
00078   void       (*Init)(HUM_TEMP_InitTypeDef *);
00079   void       (*PowerOFF)(void);
00080   uint8_t    (*ReadID)(void);
00081   void       (*Reset)(void);
00082   void       (*ConfigIT)(uint16_t);
00083   void       (*EnableIT)(uint8_t);
00084   void       (*DisableIT)(uint8_t);
00085   uint8_t    (*ITStatus)(uint16_t, uint16_t);
00086   void       (*ClearIT)(uint16_t, uint16_t);
00087   void       (*GetHumidity)(float *);
00088   void       (*GetTemperature)(float *);
00089 }HUM_TEMP_DrvTypeDef;
00090 
00091 
00092 /**
00093   * @}
00094   */ 
00095 
00096 #ifdef __cplusplus
00097 }
00098 #endif
00099 
00100 #endif /* __HUM_TEMP_H */
00101 /**
00102   * @}
00103   */
00104 
00105 /**
00106   * @}
00107   */
00108 
00109 /**
00110   * @}
00111   */ 
00112 
00113 
00114 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 
00115