tsensor.h

00001 /**
00002   ******************************************************************************
00003   * @file    tsensor.h
00004   * @author  MCD Application Team
00005   * @brief   This header file contains the functions prototypes for the
00006   *          Temperature Sensor driver. 
00007   ******************************************************************************
00008   * @attention
00009   *
00010   * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
00011   * All rights reserved.</center></h2>
00012   *
00013   * This software component is licensed by ST under BSD 3-Clause license,
00014   * the "License"; You may not use this file except in compliance with the
00015   * License. You may obtain a copy of the License at:
00016   *                        opensource.org/licenses/BSD-3-Clause
00017   *
00018   ******************************************************************************
00019   */
00020 
00021 /* Define to prevent recursive inclusion -------------------------------------*/
00022 #ifndef __TSENSOR_H
00023 #define __TSENSOR_H
00024 
00025 #ifdef __cplusplus
00026  extern "C" {
00027 #endif
00028 
00029 /* Includes ------------------------------------------------------------------*/
00030 #include <stdint.h>
00031 
00032 /** @addtogroup BSP
00033   * @{
00034   */
00035 
00036 /** @addtogroup Components
00037   * @{
00038   */
00039     
00040 /** @addtogroup TSENSOR
00041   * @{
00042   */
00043 
00044 /** @defgroup TSENSOR_Exported_Types
00045   * @{
00046   */ 
00047 
00048 /** @defgroup TSENSOR_Config_structure  Temperature Sensor Configuration structure
00049   * @{
00050   */
00051 typedef struct
00052 {
00053   uint8_t AlertMode;            /* Alert Mode Temperature out of range*/
00054   uint8_t ConversionMode;       /* Continuous/One Shot Mode */
00055   uint8_t ConversionResolution; /* Temperature Resolution */
00056   uint8_t ConversionRate;       /* Number of measure per second */
00057   int8_t TemperatureLimitHigh; /* High Temperature Limit Range */
00058   int8_t TemperatureLimitLow;  /* Low Temperature Limit Range */
00059 }TSENSOR_InitTypeDef;
00060 /**
00061   * @}
00062   */
00063 
00064 /** @defgroup TSENSOR_Driver_structure  Temperature Sensor Driver structure
00065   * @{
00066   */
00067 typedef struct
00068 {  
00069   void       (*Init)(uint16_t, TSENSOR_InitTypeDef *);
00070   uint8_t    (*IsReady)(uint16_t, uint32_t);
00071   uint8_t    (*ReadStatus)(uint16_t);
00072   float      (*ReadTemp)(uint16_t); 
00073 }TSENSOR_DrvTypeDef;
00074 /**
00075   * @}
00076   */
00077 
00078 /**
00079   * @}
00080   */
00081 
00082 /**
00083   * @}
00084   */
00085 
00086 /**
00087   * @}
00088   */
00089 
00090 /**
00091   * @}
00092   */
00093 
00094 #ifdef __cplusplus
00095 }
00096 #endif
00097 
00098 #endif /* __TSENSOR_H */
00099 
00100 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/