Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of Environmental_sheild_F4 by
BSP/X-NUCLEO-IKE01x1/x_nucleo_ike01x1_uv.h@2:e88266f73a67, 2014-08-14 (annotated)
- Committer:
- Deepti
- Date:
- Thu Aug 14 05:25:37 2014 +0000
- Revision:
- 2:e88266f73a67
- Parent:
- 0:c3c9b1c8e3cb
Environmental_Shield_F4_API
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
manoj123 | 0:c3c9b1c8e3cb | 1 | /** |
manoj123 | 0:c3c9b1c8e3cb | 2 | ****************************************************************************** |
manoj123 | 0:c3c9b1c8e3cb | 3 | * @file x_nucleo_ike01x1_uv.h |
manoj123 | 0:c3c9b1c8e3cb | 4 | * @author AST Robotics Team |
manoj123 | 0:c3c9b1c8e3cb | 5 | * @version V0.0.1 |
manoj123 | 0:c3c9b1c8e3cb | 6 | * @date 10-March-2014 |
manoj123 | 0:c3c9b1c8e3cb | 7 | * @brief This file contains definitions for x_nucleo_ike01x1_uv.c |
manoj123 | 0:c3c9b1c8e3cb | 8 | * firmware driver. |
manoj123 | 0:c3c9b1c8e3cb | 9 | ****************************************************************************** |
manoj123 | 0:c3c9b1c8e3cb | 10 | * @attention |
manoj123 | 0:c3c9b1c8e3cb | 11 | * |
manoj123 | 0:c3c9b1c8e3cb | 12 | * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2> |
manoj123 | 0:c3c9b1c8e3cb | 13 | * |
manoj123 | 0:c3c9b1c8e3cb | 14 | * Redistribution and use in source and binary forms, with or without modification, |
manoj123 | 0:c3c9b1c8e3cb | 15 | * are permitted provided that the following conditions are met: |
manoj123 | 0:c3c9b1c8e3cb | 16 | * 1. Redistributions of source code must retain the above copyright notice, |
manoj123 | 0:c3c9b1c8e3cb | 17 | * this list of conditions and the following disclaimer. |
manoj123 | 0:c3c9b1c8e3cb | 18 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
manoj123 | 0:c3c9b1c8e3cb | 19 | * this list of conditions and the following disclaimer in the documentation |
manoj123 | 0:c3c9b1c8e3cb | 20 | * and/or other materials provided with the distribution. |
manoj123 | 0:c3c9b1c8e3cb | 21 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
manoj123 | 0:c3c9b1c8e3cb | 22 | * may be used to endorse or promote products derived from this software |
manoj123 | 0:c3c9b1c8e3cb | 23 | * without specific prior written permission. |
manoj123 | 0:c3c9b1c8e3cb | 24 | * |
manoj123 | 0:c3c9b1c8e3cb | 25 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
manoj123 | 0:c3c9b1c8e3cb | 26 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
manoj123 | 0:c3c9b1c8e3cb | 27 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
manoj123 | 0:c3c9b1c8e3cb | 28 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
manoj123 | 0:c3c9b1c8e3cb | 29 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
manoj123 | 0:c3c9b1c8e3cb | 30 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
manoj123 | 0:c3c9b1c8e3cb | 31 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
manoj123 | 0:c3c9b1c8e3cb | 32 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
manoj123 | 0:c3c9b1c8e3cb | 33 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
manoj123 | 0:c3c9b1c8e3cb | 34 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
manoj123 | 0:c3c9b1c8e3cb | 35 | * |
manoj123 | 0:c3c9b1c8e3cb | 36 | ****************************************************************************** |
manoj123 | 0:c3c9b1c8e3cb | 37 | */ |
manoj123 | 0:c3c9b1c8e3cb | 38 | |
manoj123 | 0:c3c9b1c8e3cb | 39 | |
manoj123 | 0:c3c9b1c8e3cb | 40 | /* Define to prevent recursive inclusion -------------------------------------*/ |
manoj123 | 0:c3c9b1c8e3cb | 41 | #ifndef __X_NUCLEO_IKE01X1_UV_H |
manoj123 | 0:c3c9b1c8e3cb | 42 | #define __X_NUCLEO_IKE01X1_UV_H |
manoj123 | 0:c3c9b1c8e3cb | 43 | |
manoj123 | 0:c3c9b1c8e3cb | 44 | #ifdef __cplusplus |
manoj123 | 0:c3c9b1c8e3cb | 45 | extern "C" { |
manoj123 | 0:c3c9b1c8e3cb | 46 | #endif |
manoj123 | 0:c3c9b1c8e3cb | 47 | |
manoj123 | 0:c3c9b1c8e3cb | 48 | /* Includes ------------------------------------------------------------------*/ |
manoj123 | 0:c3c9b1c8e3cb | 49 | //#include "x_nucleo_ike01x1.h" |
manoj123 | 0:c3c9b1c8e3cb | 50 | /* Include UV sensor component driver */ |
manoj123 | 0:c3c9b1c8e3cb | 51 | #include "../Components/uvis3/uvis3.h" |
manoj123 | 0:c3c9b1c8e3cb | 52 | |
manoj123 | 0:c3c9b1c8e3cb | 53 | /** @addtogroup BSP |
manoj123 | 0:c3c9b1c8e3cb | 54 | * @{ |
manoj123 | 0:c3c9b1c8e3cb | 55 | */ |
manoj123 | 0:c3c9b1c8e3cb | 56 | |
manoj123 | 0:c3c9b1c8e3cb | 57 | /** @addtogroup X_NUCLEO_IKE01X1 |
manoj123 | 0:c3c9b1c8e3cb | 58 | * @{ |
manoj123 | 0:c3c9b1c8e3cb | 59 | */ |
manoj123 | 0:c3c9b1c8e3cb | 60 | |
manoj123 | 0:c3c9b1c8e3cb | 61 | /** @addtogroup X_NUCLEO_IKE01X1_UV |
manoj123 | 0:c3c9b1c8e3cb | 62 | * @{ |
manoj123 | 0:c3c9b1c8e3cb | 63 | */ |
manoj123 | 0:c3c9b1c8e3cb | 64 | |
manoj123 | 0:c3c9b1c8e3cb | 65 | /** @defgroup X_NUCLEO_IKE01X1_UV_Exported_Types X_NUCLEO_IKE01X1_UV_Exported_Types |
manoj123 | 0:c3c9b1c8e3cb | 66 | * @{ |
manoj123 | 0:c3c9b1c8e3cb | 67 | */ |
manoj123 | 0:c3c9b1c8e3cb | 68 | typedef enum |
manoj123 | 0:c3c9b1c8e3cb | 69 | { |
manoj123 | 0:c3c9b1c8e3cb | 70 | UV_OK = 0, |
manoj123 | 0:c3c9b1c8e3cb | 71 | UV_ERROR = 1, |
manoj123 | 0:c3c9b1c8e3cb | 72 | UV_TIMEOUT = 2 |
manoj123 | 0:c3c9b1c8e3cb | 73 | } |
manoj123 | 0:c3c9b1c8e3cb | 74 | UV_StatusTypeDef; |
manoj123 | 0:c3c9b1c8e3cb | 75 | |
manoj123 | 0:c3c9b1c8e3cb | 76 | /** |
manoj123 | 0:c3c9b1c8e3cb | 77 | * @} |
manoj123 | 0:c3c9b1c8e3cb | 78 | */ |
manoj123 | 0:c3c9b1c8e3cb | 79 | |
manoj123 | 0:c3c9b1c8e3cb | 80 | /** @defgroup X_NUCLEO_IKE01X1_UV_Exported_Constants X_NUCLEO_IKE01X1_UV_Exported_Constants |
manoj123 | 0:c3c9b1c8e3cb | 81 | * @{ |
manoj123 | 0:c3c9b1c8e3cb | 82 | */ |
manoj123 | 0:c3c9b1c8e3cb | 83 | |
manoj123 | 0:c3c9b1c8e3cb | 84 | /** |
manoj123 | 0:c3c9b1c8e3cb | 85 | * @} |
manoj123 | 0:c3c9b1c8e3cb | 86 | */ |
manoj123 | 0:c3c9b1c8e3cb | 87 | |
manoj123 | 0:c3c9b1c8e3cb | 88 | /** @defgroup X_NUCLEO_IKE01X1_UV_Exported_Macros X_NUCLEO_IKE01X1_UV_Exported_Macros |
manoj123 | 0:c3c9b1c8e3cb | 89 | * @{ |
manoj123 | 0:c3c9b1c8e3cb | 90 | */ |
manoj123 | 0:c3c9b1c8e3cb | 91 | |
manoj123 | 0:c3c9b1c8e3cb | 92 | /** |
manoj123 | 0:c3c9b1c8e3cb | 93 | * @} |
manoj123 | 0:c3c9b1c8e3cb | 94 | */ |
manoj123 | 0:c3c9b1c8e3cb | 95 | |
manoj123 | 0:c3c9b1c8e3cb | 96 | /** @defgroup X_NUCLEO_IKE01X1_UV_Exported_Functions X_NUCLEO_IKE01X1_UV_Exported_Functions |
manoj123 | 0:c3c9b1c8e3cb | 97 | * @{ |
manoj123 | 0:c3c9b1c8e3cb | 98 | */ |
manoj123 | 0:c3c9b1c8e3cb | 99 | /* Sensor Configuration Functions */ |
manoj123 | 0:c3c9b1c8e3cb | 100 | uint8_t BSP_UV_Init(void); |
manoj123 | 0:c3c9b1c8e3cb | 101 | uint8_t BSP_UV_isInitialized(void); |
manoj123 | 0:c3c9b1c8e3cb | 102 | void BSP_UV_Reset(void); |
manoj123 | 0:c3c9b1c8e3cb | 103 | uint8_t BSP_UV_ReadID(void); |
manoj123 | 0:c3c9b1c8e3cb | 104 | void BSP_UV_ITConfig(void/*UV_InterruptConfigTypeDef *pIntConfigStruct*/); |
manoj123 | 0:c3c9b1c8e3cb | 105 | void BSP_UV_EnableIT(uint8_t IntPin); |
manoj123 | 0:c3c9b1c8e3cb | 106 | void BSP_UV_DisableIT(uint8_t IntPin); |
manoj123 | 0:c3c9b1c8e3cb | 107 | void BSP_UV_GetIndex(float* pfData); |
manoj123 | 0:c3c9b1c8e3cb | 108 | |
manoj123 | 0:c3c9b1c8e3cb | 109 | /** |
manoj123 | 0:c3c9b1c8e3cb | 110 | * @} |
manoj123 | 0:c3c9b1c8e3cb | 111 | */ |
manoj123 | 0:c3c9b1c8e3cb | 112 | |
manoj123 | 0:c3c9b1c8e3cb | 113 | /** |
manoj123 | 0:c3c9b1c8e3cb | 114 | * @} |
manoj123 | 0:c3c9b1c8e3cb | 115 | */ |
manoj123 | 0:c3c9b1c8e3cb | 116 | |
manoj123 | 0:c3c9b1c8e3cb | 117 | /** |
manoj123 | 0:c3c9b1c8e3cb | 118 | * @} |
manoj123 | 0:c3c9b1c8e3cb | 119 | */ |
manoj123 | 0:c3c9b1c8e3cb | 120 | |
manoj123 | 0:c3c9b1c8e3cb | 121 | /** |
manoj123 | 0:c3c9b1c8e3cb | 122 | * @} |
manoj123 | 0:c3c9b1c8e3cb | 123 | */ |
manoj123 | 0:c3c9b1c8e3cb | 124 | |
manoj123 | 0:c3c9b1c8e3cb | 125 | #ifdef __cplusplus |
manoj123 | 0:c3c9b1c8e3cb | 126 | } |
manoj123 | 0:c3c9b1c8e3cb | 127 | #endif |
manoj123 | 0:c3c9b1c8e3cb | 128 | |
manoj123 | 0:c3c9b1c8e3cb | 129 | #endif /* __X_NUCLEO_IKE01X1_UV_H */ |
manoj123 | 0:c3c9b1c8e3cb | 130 | |
manoj123 | 0:c3c9b1c8e3cb | 131 | |
manoj123 | 0:c3c9b1c8e3cb | 132 | |
manoj123 | 0:c3c9b1c8e3cb | 133 | /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |
manoj123 | 0:c3c9b1c8e3cb | 134 |