B-L475E-IOT01 BSP User Manual: stm32l475e_iot01_tsensor.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm32l475e_iot01_tsensor.h
00004   * @author  MCD Application Team
00005   * @version V1.0.0
00006   * @date    17-March-2017
00007   * @brief   This file provides a set of functions needed to manage the temperature sensor
00008   ******************************************************************************
00009   * @attention
00010   *
00011   * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics International N.V.
00012   * All rights reserved.</center></h2>
00013   *
00014   * Redistribution and use in source and binary forms, with or without
00015   * modification, are permitted, provided that the following conditions are met:
00016   *
00017   * 1. Redistribution of source code must retain the above copyright notice,
00018   *    this list of conditions and the following disclaimer.
00019   * 2. Redistributions in binary form must reproduce the above copyright notice,
00020   *    this list of conditions and the following disclaimer in the documentation
00021   *    and/or other materials provided with the distribution.
00022   * 3. Neither the name of STMicroelectronics nor the names of other
00023   *    contributors to this software may be used to endorse or promote products
00024   *    derived from this software without specific written permission.
00025   * 4. This software, including modifications and/or derivative works of this
00026   *    software, must execute solely and exclusively on microcontroller or
00027   *    microprocessor devices manufactured by or for STMicroelectronics.
00028   * 5. Redistribution and use of this software other than as permitted under
00029   *    this license is void and will automatically terminate your rights under
00030   *    this license.
00031   *
00032   * THIS SOFTWARE IS PROVIDED BY STMICROELECTRONICS AND CONTRIBUTORS "AS IS"
00033   * AND ANY EXPRESS, IMPLIED OR STATUTORY WARRANTIES, INCLUDING, BUT NOT
00034   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
00035   * PARTICULAR PURPOSE AND NON-INFRINGEMENT OF THIRD PARTY INTELLECTUAL PROPERTY
00036   * RIGHTS ARE DISCLAIMED TO THE FULLEST EXTENT PERMITTED BY LAW. IN NO EVENT
00037   * SHALL STMICROELECTRONICS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00038   * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00039   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
00040   * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00041   * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00042   * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
00043   * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00044   *
00045   ******************************************************************************
00046   */
00047 
00048 /* Define to prevent recursive inclusion -------------------------------------*/
00049 #ifndef __STM32L475E_IOT01_TSENSOR_H
00050 #define __STM32L475E_IOT01_TSENSOR_H
00051 
00052 #ifdef __cplusplus
00053  extern "C" {
00054 #endif
00055 
00056 /* Includes ------------------------------------------------------------------*/
00057 #include "stm32l475e_iot01.h"
00058 #ifdef USE_LPS22HB_TEMP
00059 #include "../Components/lps22hb/lps22hb.h"
00060 #else /* USE_HTS221_TEMP */
00061 #include "../Components/hts221/hts221.h"
00062 #endif
00063 
00064 /** @addtogroup BSP
00065   * @{
00066   */ 
00067 
00068 /** @addtogroup STM32L475E_IOT01
00069   * @{
00070   */
00071 
00072 /** @addtogroup STM32L475E_IOT01_TEMPERATURE 
00073   * @{
00074   */
00075    
00076 /** @defgroup STM32L475E_IOT01_TEMPERATURE_Exported_Types TEMPERATURE Exported Types
00077   * @{
00078   */
00079    
00080 /** 
00081   * @brief  TSENSOR Status  
00082   */ 
00083 typedef enum
00084 {
00085   TSENSOR_OK = 0,
00086   TSENSOR_ERROR
00087 }TSENSOR_Status_TypDef;
00088 
00089 /**
00090   * @}
00091   */
00092 
00093 
00094 /** @defgroup STM32L475E_IOT01_TEMPERATURE_Exported_Functions TEMPERATURE Exported Constants
00095   * @{
00096   */
00097 /* Exported macros -----------------------------------------------------------*/
00098 /* Private macros ------------------------------------------------------------*/
00099 /* Exported functions --------------------------------------------------------*/
00100 /* Sensor Configuration Functions */
00101 uint32_t BSP_TSENSOR_Init(void);
00102 float BSP_TSENSOR_ReadTemp(void);
00103 /**
00104   * @}
00105   */ 
00106 
00107 #ifdef __cplusplus
00108 }
00109 #endif
00110 
00111 /**
00112   * @}
00113   */ 
00114 
00115 /**
00116   * @}
00117   */ 
00118 
00119 /**
00120   * @}
00121   */
00122 
00123 #endif /* __STM32L475E_IOT01_TSENSOR_H */
00124 
00125 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/