STM32L073Z_EVAL BSP User Manual: stm32l073z_eval_tsensor.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm32l073z_eval_tsensor.h
00004   * @author  MCD Application Team
00005   * @brief   This file contains all the functions prototypes for the 
00006   *          stm32l073z_eval_tsensor.c firmware driver.
00007   ******************************************************************************
00008   * @attention
00009   *
00010   * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
00011   *
00012   * Redistribution and use in source and binary forms, with or without modification,
00013   * are permitted provided that the following conditions are met:
00014   *   1. Redistributions of source code must retain the above copyright notice,
00015   *      this list of conditions and the following disclaimer.
00016   *   2. Redistributions in binary form must reproduce the above copyright notice,
00017   *      this list of conditions and the following disclaimer in the documentation
00018   *      and/or other materials provided with the distribution.
00019   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00020   *      may be used to endorse or promote products derived from this software
00021   *      without specific prior written permission.
00022   *
00023   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00026   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00027   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00028   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00029   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00030   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00031   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00032   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033   *
00034   ******************************************************************************
00035   */
00036 
00037 /* Define to prevent recursive inclusion -------------------------------------*/
00038 #ifndef __STM32L073Z_EVAL_TSENSOR_H
00039 #define __STM32L073Z_EVAL_TSENSOR_H
00040 
00041 #ifdef __cplusplus
00042  extern "C" {
00043 #endif
00044 
00045 /* Includes ------------------------------------------------------------------*/
00046 #include "stm32l073z_eval.h"
00047 #include "../Components/stlm75/stlm75.h"   
00048 
00049 /** @addtogroup Utilities
00050   * @{
00051   */
00052   
00053 /** @addtogroup STM32L073Z_EVAL
00054   * @{
00055   */ 
00056 
00057 /** @addtogroup Common
00058   * @{
00059   */
00060   
00061 /** @addtogroup STM32L073Z_EVAL_TSENSOR
00062   * @{
00063   */  
00064 
00065 /** @defgroup STM32L073Z_EVAL_TSENSOR_Exported_Types
00066   * @{
00067   */
00068    
00069 /** 
00070   * @brief  TSENSOR Status  
00071   */ 
00072 typedef enum
00073 {
00074   TSENSOR_OK = 0,
00075   TSENSOR_ERROR
00076 }TSENSOR_Status_TypDef;
00077 
00078 /**
00079   * @}
00080   */
00081   
00082 /** @defgroup STM32L073Z_EVAL_TSENSOR_Exported_Constants
00083   * @{
00084   */ 
00085 /* Temperature Sensor hardware I2C address */ 
00086 #define TSENSOR_I2C_ADDRESS_A01 0x90
00087 #define TSENSOR_I2C_ADDRESS_A02 0x92
00088 
00089 /* Maximum number of trials use for STTS751_IsReady function */
00090 #define TSENSOR_MAX_TRIALS      50
00091 /**
00092   * @}
00093   */
00094 
00095 /** @defgroup STM32L073Z_EVAL_I2C_TSENSOR_Exported_Macros
00096   * @{
00097   */ 
00098 /**
00099   * @}
00100   */ 
00101 
00102 /** @defgroup STM32L073Z_EVAL_I2C_TSENSOR_Exported_Functions
00103   * @{
00104   */ 
00105 uint32_t BSP_TSENSOR_Init(void);
00106 uint8_t  BSP_TSENSOR_ReadStatus(void);
00107 uint16_t BSP_TSENSOR_ReadTemp(void);
00108  
00109 #ifdef __cplusplus
00110 }
00111 #endif
00112 
00113 #endif /* __STM32L073Z_EVAL_TSENSOR_H */
00114 /**
00115   * @}
00116   */
00117 
00118 /**
00119   * @}
00120   */
00121 
00122 /**
00123   * @}
00124   */
00125 
00126 /**
00127   * @}
00128   */ 
00129 
00130 /**
00131   * @}
00132   */
00133 
00134 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/