tsensor.h

00001 /**
00002   ******************************************************************************
00003   * @file    tsensor.h
00004   * @author  MCD Application Team
00005   * @version V4.0.1
00006   * @date    21-July-2015
00007   * @brief   This header file contains the functions prototypes for the
00008   *          Temperature Sensor driver. 
00009   ******************************************************************************
00010   * @attention
00011   *
00012   * <h2><center>&copy; COPYRIGHT(c) 2015 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 /* Define to prevent recursive inclusion -------------------------------------*/
00040 #ifndef __TSENSOR_H
00041 #define __TSENSOR_H
00042 
00043 #ifdef __cplusplus
00044  extern "C" {
00045 #endif
00046 
00047 /* Includes ------------------------------------------------------------------*/
00048 #include <stdint.h>
00049 
00050 /** @addtogroup BSP
00051   * @{
00052   */
00053 
00054 /** @addtogroup Components
00055   * @{
00056   */
00057     
00058 /** @addtogroup TSENSOR
00059   * @{
00060   */
00061 
00062 /** @defgroup TSENSOR_Exported_Types
00063   * @{
00064   */ 
00065 
00066 /** @defgroup TSENSOR_Config_structure  Temperature Sensor Configuration structure
00067   * @{
00068   */
00069 typedef struct
00070 {
00071   uint8_t AlertMode;            /* Alert Mode Temperature out of range*/
00072   uint8_t ConversionMode;       /* Continuous/One Shot Mode */
00073   uint8_t ConversionResolution; /* Temperature Resolution */
00074   uint8_t ConversionRate;       /* Number of measure per second */
00075   uint8_t TemperatureLimitHigh; /* High Temperature Limit Range */
00076   uint8_t TemperatureLimitLow;  /* Low Temperature Limit Range */
00077 }TSENSOR_InitTypeDef;
00078 /**
00079   * @}
00080   */
00081 
00082 /** @defgroup TSENSOR_Driver_structure  Temperature Sensor Driver structure
00083   * @{
00084   */
00085 typedef struct
00086 {  
00087   void       (*Init)(uint16_t, TSENSOR_InitTypeDef *);
00088   uint8_t    (*IsReady)(uint16_t, uint32_t);
00089   uint8_t    (*ReadStatus)(uint16_t);
00090   uint16_t   (*ReadTemp)(uint16_t); 
00091 }TSENSOR_DrvTypeDef;
00092 /**
00093   * @}
00094   */
00095 
00096 /**
00097   * @}
00098   */
00099 
00100 /**
00101   * @}
00102   */
00103 
00104 /**
00105   * @}
00106   */
00107 
00108 /**
00109   * @}
00110   */
00111 
00112 #ifdef __cplusplus
00113 }
00114 #endif
00115 
00116 #endif /* __TSENSOR_H */
00117 
00118 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/