_BSP_User_Manual: stm3210e_eval_tsensor.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm3210e_eval_tsensor.h
00004   * @author  MCD Application Team
00005   * @version $VERSION$
00006   * @date    $DATE$
00007   * @brief   This file contains all the functions prototypes for the 
00008   *          stm3210e_tsensor.c firmware 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 /* Define to prevent recursive inclusion -------------------------------------*/
00040 #ifndef __STM3210E_EVAL_TSENSOR_H
00041 #define __STM3210E_EVAL_TSENSOR_H
00042 
00043 #ifdef __cplusplus
00044  extern "C" {
00045 #endif
00046 
00047 /* Includes ------------------------------------------------------------------*/
00048 #include "stm3210e_eval.h"
00049 #include "../Components/stlm75/stlm75.h"   
00050 
00051 /** @addtogroup BSP
00052   * @{
00053   */
00054   
00055 /** @addtogroup STM3210E_EVAL
00056   * @{
00057   */ 
00058   
00059 /** @addtogroup STM3210E_EVAL_TSENSOR
00060   * @{
00061   */  
00062 
00063 /** @defgroup STM3210E_EVAL_TSENSOR_Exported_Types Exported_Types
00064   * @{
00065   */
00066    
00067 /** 
00068   * @brief  TSENSOR Status  
00069   */ 
00070 typedef enum
00071 {
00072   TSENSOR_OK = 0,
00073   TSENSOR_ERROR
00074 }TSENSOR_Status_TypDef;
00075 
00076 /**
00077   * @}
00078   */
00079   
00080 /** @defgroup STM3210E_EVAL_TSENSOR_Exported_Constants Exported_Constants
00081   * @{
00082   */ 
00083 /* Temperature Sensor hardware I2C address */ 
00084 #define TSENSOR_I2C_ADDRESS_A01 0x90
00085 #define TSENSOR_I2C_ADDRESS_A02 0x92
00086 
00087 /* Maximum number of trials use for STLM75_IsReady function */
00088 #define TSENSOR_MAX_TRIALS      50
00089 /**
00090   * @}
00091   */
00092 
00093 
00094 /** @addtogroup STM3210E_EVAL_EVAL_I2C_TSENSOR_Exported_Functions
00095   * @{
00096   */ 
00097 uint32_t BSP_TSENSOR_Init(void);
00098 uint8_t  BSP_TSENSOR_ReadStatus(void);
00099 uint16_t BSP_TSENSOR_ReadTemp(void);
00100  
00101 #ifdef __cplusplus
00102 }
00103 #endif
00104 
00105 #endif /* __STM3210E_EVAL_TSENSOR_H */
00106 /**
00107   * @}
00108   */
00109 
00110 /**
00111   * @}
00112   */
00113 
00114 /**
00115   * @}
00116   */
00117 
00118 /**
00119   * @}
00120   */ 
00121 
00122 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/