ST / X_NUCLEO_IKA01A1

mbed library for STMicroelectronics' X-NUCLEO-IKA01A1 expansion board.

Dependents:   HelloWorld_IKA01A1

Fork of X_NUCLEO_IKA01A1 by ST Expansion SW Team

Library for STMicroelectronics' X-NUCLEO-IKA01A1 multifunctional expansion board based on operational amplifiers.

Components/Common/photosensor.h@21:8d0624950dd1, 2016-04-13 (annotated)

Committer:
hemddabral
Date:
Wed Apr 13 06:21:46 2016 +0000
Revision:
21:8d0624950dd1
Parent:
16:2f9443aedbe8 
updated TSZ124 class, and simplified method names in WindComp and PhotoSensor configurations.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
hemddabral 16:2f9443aedbe8 1 /**
hemddabral 16:2f9443aedbe8 2 ******************************************************************************
hemddabral 16:2f9443aedbe8 3 * @file photodiode.h
hemddabral 16:2f9443aedbe8 4 * @author Central Labs
hemddabral 16:2f9443aedbe8 5 * @version 1.0.0
hemddabral 16:2f9443aedbe8 6 * @date 11-February-2016
hemddabral 16:2f9443aedbe8 7 * @brief Portable architecture for TSU104
hemddabral 16:2f9443aedbe8 8 ******************************************************************************
hemddabral 16:2f9443aedbe8 9 * @attention
hemddabral 16:2f9443aedbe8 10 *
hemddabral 16:2f9443aedbe8 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
hemddabral 16:2f9443aedbe8 12 *
hemddabral 16:2f9443aedbe8 13 * Redistribution and use in source and binary forms, with or without modification,
hemddabral 16:2f9443aedbe8 14 * are permitted provided that the following conditions are met:
hemddabral 16:2f9443aedbe8 15 * 1. Redistributions of source code must retain the above copyright notice,
hemddabral 16:2f9443aedbe8 16 * this list of conditions and the following disclaimer.
hemddabral 16:2f9443aedbe8 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
hemddabral 16:2f9443aedbe8 18 * this list of conditions and the following disclaimer in the documentation
hemddabral 16:2f9443aedbe8 19 * and/or other materials provided with the distribution.
hemddabral 16:2f9443aedbe8 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
hemddabral 16:2f9443aedbe8 21 * may be used to endorse or promote products derived from this software
hemddabral 16:2f9443aedbe8 22 * without specific prior written permission.
hemddabral 16:2f9443aedbe8 23 *
hemddabral 16:2f9443aedbe8 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
hemddabral 16:2f9443aedbe8 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
hemddabral 16:2f9443aedbe8 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
hemddabral 16:2f9443aedbe8 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
hemddabral 16:2f9443aedbe8 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
hemddabral 16:2f9443aedbe8 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
hemddabral 16:2f9443aedbe8 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
hemddabral 16:2f9443aedbe8 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
hemddabral 16:2f9443aedbe8 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
hemddabral 16:2f9443aedbe8 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
hemddabral 16:2f9443aedbe8 34 *
hemddabral 16:2f9443aedbe8 35 ******************************************************************************
hemddabral 16:2f9443aedbe8 36 */
hemddabral 16:2f9443aedbe8 37
hemddabral 16:2f9443aedbe8 38
hemddabral 16:2f9443aedbe8 39 /* Define to prevent recursive inclusion -------------------------------------*/
hemddabral 16:2f9443aedbe8 40
hemddabral 16:2f9443aedbe8 41 #ifndef __PHOTODIODE_H
hemddabral 16:2f9443aedbe8 42 #define __PHOTODIODE_H
hemddabral 16:2f9443aedbe8 43
hemddabral 16:2f9443aedbe8 44 #ifdef __cplusplus
hemddabral 16:2f9443aedbe8 45 extern "C" {
hemddabral 16:2f9443aedbe8 46 #endif
hemddabral 16:2f9443aedbe8 47
hemddabral 16:2f9443aedbe8 48
hemddabral 16:2f9443aedbe8 49 /* Includes ------------------------------------------------------------------*/
hemddabral 16:2f9443aedbe8 50
hemddabral 16:2f9443aedbe8 51 #include <stdint.h>
hemddabral 16:2f9443aedbe8 52 #include "component.h"
hemddabral 16:2f9443aedbe8 53
hemddabral 16:2f9443aedbe8 54
hemddabral 16:2f9443aedbe8 55 /* Types ---------------------------------------------------------------------*/
hemddabral 16:2f9443aedbe8 56
hemddabral 16:2f9443aedbe8 57 /** @addtogroup BSP
hemddabral 16:2f9443aedbe8 58 * @{
hemddabral 16:2f9443aedbe8 59 */
hemddabral 16:2f9443aedbe8 60
hemddabral 16:2f9443aedbe8 61 /** @addtogroup Components
hemddabral 16:2f9443aedbe8 62 * @{
hemddabral 16:2f9443aedbe8 63 */
hemddabral 16:2f9443aedbe8 64
hemddabral 16:2f9443aedbe8 65 /** @addtogroup PHOTODIODE
hemddabral 16:2f9443aedbe8 66 * @{
hemddabral 16:2f9443aedbe8 67 */
hemddabral 16:2f9443aedbe8 68
hemddabral 16:2f9443aedbe8 69 /** @defgroup PHOTODIODE_Exported_Types
hemddabral 16:2f9443aedbe8 70 * @{
hemddabral 16:2f9443aedbe8 71 */
hemddabral 16:2f9443aedbe8 72
hemddabral 16:2f9443aedbe8 73 /**
hemddabral 16:2f9443aedbe8 74 * @brief PHOTODIODE component identifier enumerator definition.
hemddabral 16:2f9443aedbe8 75 */
hemddabral 16:2f9443aedbe8 76 typedef enum
hemddabral 16:2f9443aedbe8 77 {
hemddabral 16:2f9443aedbe8 78 PHOTODIODE_NONE_COMPONENT = 0,
hemddabral 16:2f9443aedbe8 79 PHOTODIODE_TSU104_COMPONENT = 1
hemddabral 16:2f9443aedbe8 80 } PHOTODIODEE_Component_t;
hemddabral 16:2f9443aedbe8 81
hemddabral 16:2f9443aedbe8 82 /**
hemddabral 16:2f9443aedbe8 83 * @brief PHOTODIODE driver virtual table structure definition.
hemddabral 16:2f9443aedbe8 84 */
hemddabral 16:2f9443aedbe8 85 typedef struct
hemddabral 16:2f9443aedbe8 86 {
hemddabral 16:2f9443aedbe8 87 /* ACTION ----------------------------------------------------------------*
hemddabral 16:2f9443aedbe8 88 * Declare here the component's generic functions. *
hemddabral 16:2f9443aedbe8 89 * Tag this group of functions with the " Generic " C-style comment. *
hemddabral 16:2f9443aedbe8 90 * A component's interface has to define at least the two generic *
hemddabral 16:2f9443aedbe8 91 * functions provided here below within the "Example" section, as the *
hemddabral 16:2f9443aedbe8 92 * first and second functions of its Virtual Table. They have to be *
hemddabral 16:2f9443aedbe8 93 * specified exactly in the given way. *
hemddabral 16:2f9443aedbe8 94 * *
hemddabral 16:2f9443aedbe8 95 * Example: *
hemddabral 16:2f9443aedbe8 96 * Status_t (*Init) (void *handle, void *init); *
hemddabral 16:2f9443aedbe8 97 * Status_t (*ReadID) (void *handle, uint8_t *id); *
hemddabral 16:2f9443aedbe8 98 *------------------------------------------------------------------------*/
hemddabral 16:2f9443aedbe8 99 /* Generic */
hemddabral 16:2f9443aedbe8 100 Status_t (*Init) (void *handle, void *init);
hemddabral 16:2f9443aedbe8 101 Status_t (*ReadID) (void *handle, uint8_t *id);
hemddabral 16:2f9443aedbe8 102
hemddabral 16:2f9443aedbe8 103 /* ACTION ----------------------------------------------------------------*
hemddabral 16:2f9443aedbe8 104 * Declare here the component's specific functions. *
hemddabral 16:2f9443aedbe8 105 * Tag this group of functions with the " Specific " C-style comment. *
hemddabral 16:2f9443aedbe8 106 * Do not specify any function if not required. *
hemddabral 16:2f9443aedbe8 107 * *
hemddabral 16:2f9443aedbe8 108 * Example: *
hemddabral 16:2f9443aedbe8 109 * Status_t (*GetValue) (void *handle, float *f); *
hemddabral 16:2f9443aedbe8 110 *------------------------------------------------------------------------*/
hemddabral 16:2f9443aedbe8 111 /* Specific */
hemddabral 21:8d0624950dd1 112 unsigned int (*GetGetVoltage) (void *handle);
hemddabral 16:2f9443aedbe8 113 } WINDCOMP_VTable_t;
hemddabral 16:2f9443aedbe8 114
hemddabral 16:2f9443aedbe8 115 #ifdef __cplusplus
hemddabral 16:2f9443aedbe8 116 }
hemddabral 16:2f9443aedbe8 117 #endif
hemddabral 16:2f9443aedbe8 118
hemddabral 16:2f9443aedbe8 119 #endif /* __PHOTODIODE_H */
hemddabral 16:2f9443aedbe8 120
hemddabral 16:2f9443aedbe8 121 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/