mbed library for STMicroelectronics' X-NUCLEO-IKA01A1 expansion board.
Dependents: HelloWorld_IKA01A1
Fork of X_NUCLEO_IKA01A1 by
Library for STMicroelectronics' X-NUCLEO-IKA01A1 multifunctional expansion board based on operational amplifiers.
Components/tsu104/tsu104_class.h@13:9cecc8d66cc1, 2016-04-07 (annotated)
- Committer:
- hemddabral
- Date:
- Thu Apr 07 07:51:13 2016 +0000
- Revision:
- 13:9cecc8d66cc1
- Parent:
- 12:ac16b9a1cad6
- Child:
- 14:8277ca0ab13a
updated doxygen style comments
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
hemddabral | 2:19d1dcef0c0e | 1 | /** |
hemddabral | 2:19d1dcef0c0e | 2 | ****************************************************************************** |
hemddabral | 2:19d1dcef0c0e | 3 | * @file tsu104_class.h |
hemddabral | 2:19d1dcef0c0e | 4 | * @author Central Labs |
hemddabral | 2:19d1dcef0c0e | 5 | * @version 1.0.0 |
hemddabral | 2:19d1dcef0c0e | 6 | * @date 11-February-2016 |
hemddabral | 2:19d1dcef0c0e | 7 | * @brief Portable architecture for TSU104 |
hemddabral | 2:19d1dcef0c0e | 8 | ****************************************************************************** |
hemddabral | 2:19d1dcef0c0e | 9 | * @attention |
hemddabral | 2:19d1dcef0c0e | 10 | * |
hemddabral | 2:19d1dcef0c0e | 11 | * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> |
hemddabral | 2:19d1dcef0c0e | 12 | * |
hemddabral | 2:19d1dcef0c0e | 13 | * Redistribution and use in source and binary forms, with or without modification, |
hemddabral | 2:19d1dcef0c0e | 14 | * are permitted provided that the following conditions are met: |
hemddabral | 2:19d1dcef0c0e | 15 | * 1. Redistributions of source code must retain the above copyright notice, |
hemddabral | 2:19d1dcef0c0e | 16 | * this list of conditions and the following disclaimer. |
hemddabral | 2:19d1dcef0c0e | 17 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
hemddabral | 2:19d1dcef0c0e | 18 | * this list of conditions and the following disclaimer in the documentation |
hemddabral | 2:19d1dcef0c0e | 19 | * and/or other materials provided with the distribution. |
hemddabral | 2:19d1dcef0c0e | 20 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
hemddabral | 2:19d1dcef0c0e | 21 | * may be used to endorse or promote products derived from this software |
hemddabral | 2:19d1dcef0c0e | 22 | * without specific prior written permission. |
hemddabral | 2:19d1dcef0c0e | 23 | * |
hemddabral | 2:19d1dcef0c0e | 24 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
hemddabral | 2:19d1dcef0c0e | 25 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
hemddabral | 2:19d1dcef0c0e | 26 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
hemddabral | 2:19d1dcef0c0e | 27 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
hemddabral | 2:19d1dcef0c0e | 28 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
hemddabral | 2:19d1dcef0c0e | 29 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
hemddabral | 2:19d1dcef0c0e | 30 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
hemddabral | 2:19d1dcef0c0e | 31 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
hemddabral | 2:19d1dcef0c0e | 32 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
hemddabral | 2:19d1dcef0c0e | 33 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
hemddabral | 2:19d1dcef0c0e | 34 | * |
hemddabral | 2:19d1dcef0c0e | 35 | ****************************************************************************** |
hemddabral | 2:19d1dcef0c0e | 36 | */ |
hemddabral | 2:19d1dcef0c0e | 37 | |
hemddabral | 2:19d1dcef0c0e | 38 | |
hemddabral | 2:19d1dcef0c0e | 39 | /* Generated with STM32CubeTOO -----------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 40 | |
hemddabral | 2:19d1dcef0c0e | 41 | |
hemddabral | 2:19d1dcef0c0e | 42 | /* Revision ------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 43 | /* |
hemddabral | 2:19d1dcef0c0e | 44 | Repository: http://svn.x-nucleodev.codex.cro.st.com/svnroot/X-NucleoDev |
hemddabral | 2:19d1dcef0c0e | 45 | Branch/Trunk/Tag: trunk |
hemddabral | 2:19d1dcef0c0e | 46 | Based on: X-CUBE-IKA01A1/trunk/Drivers/BSP/Components/tsu104/tsu104.h |
hemddabral | 2:19d1dcef0c0e | 47 | Revision: 402 |
hemddabral | 2:19d1dcef0c0e | 48 | */ |
hemddabral | 2:19d1dcef0c0e | 49 | |
hemddabral | 2:19d1dcef0c0e | 50 | |
hemddabral | 2:19d1dcef0c0e | 51 | /* Define to prevent recursive inclusion -------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 52 | |
hemddabral | 2:19d1dcef0c0e | 53 | #ifndef __TSU104_CLASS_H |
hemddabral | 2:19d1dcef0c0e | 54 | #define __TSU104_CLASS_H |
hemddabral | 2:19d1dcef0c0e | 55 | |
hemddabral | 2:19d1dcef0c0e | 56 | |
hemddabral | 2:19d1dcef0c0e | 57 | /* Includes ------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 58 | |
hemddabral | 2:19d1dcef0c0e | 59 | /* ACTION 1 ------------------------------------------------------------------* |
hemddabral | 2:19d1dcef0c0e | 60 | * Include here platform specific header files. * |
hemddabral | 2:19d1dcef0c0e | 61 | *----------------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 62 | #include "mbed.h" |
hemddabral | 2:19d1dcef0c0e | 63 | /* ACTION 2 ------------------------------------------------------------------* |
hemddabral | 2:19d1dcef0c0e | 64 | * Include here component specific header files. * |
hemddabral | 2:19d1dcef0c0e | 65 | *----------------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 66 | #include "tsu104.h" |
hemddabral | 2:19d1dcef0c0e | 67 | /* ACTION 3 ------------------------------------------------------------------* |
hemddabral | 2:19d1dcef0c0e | 68 | * Include here interface specific header files. * |
hemddabral | 2:19d1dcef0c0e | 69 | * * |
hemddabral | 2:19d1dcef0c0e | 70 | * Example: * |
hemddabral | 2:19d1dcef0c0e | 71 | * #include "../Interfaces/Humidity_class.h" * |
hemddabral | 2:19d1dcef0c0e | 72 | * #include "../Interfaces/Temperature_class.h" * |
hemddabral | 2:19d1dcef0c0e | 73 | *----------------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 74 | #include "../Interfaces/Windcomp_class.h" |
hemddabral | 2:19d1dcef0c0e | 75 | |
hemddabral | 2:19d1dcef0c0e | 76 | |
hemddabral | 2:19d1dcef0c0e | 77 | /* Classes -------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 78 | |
hemddabral | 2:19d1dcef0c0e | 79 | /** |
hemddabral | 13:9cecc8d66cc1 | 80 | * @brief Class representing a TSU104 operational amplifier component. The window comparator |
hemddabral | 13:9cecc8d66cc1 | 81 | * configuration allows the user to compare a signal to two threshold voltages. When the signal |
hemddabral | 13:9cecc8d66cc1 | 82 | * is out of the required voltage range, the output of the operational amplifier toggles |
hemddabral | 2:19d1dcef0c0e | 83 | */ |
hemddabral | 2:19d1dcef0c0e | 84 | class TSU104 : public Windcomp |
hemddabral | 2:19d1dcef0c0e | 85 | { |
hemddabral | 2:19d1dcef0c0e | 86 | public: |
hemddabral | 2:19d1dcef0c0e | 87 | |
hemddabral | 2:19d1dcef0c0e | 88 | /*** Constructor and Destructor Methods ***/ |
hemddabral | 2:19d1dcef0c0e | 89 | |
hemddabral | 2:19d1dcef0c0e | 90 | /** |
hemddabral | 2:19d1dcef0c0e | 91 | * @brief Constructor. |
hemddabral | 2:19d1dcef0c0e | 92 | */ |
hemddabral | 2:19d1dcef0c0e | 93 | TSU104(void) : Windcomp() |
hemddabral | 2:19d1dcef0c0e | 94 | { |
hemddabral | 2:19d1dcef0c0e | 95 | /* ACTION 4 ----------------------------------------------------------* |
hemddabral | 2:19d1dcef0c0e | 96 | * Initialize here the component's member variables, one variable per * |
hemddabral | 2:19d1dcef0c0e | 97 | * line. * |
hemddabral | 2:19d1dcef0c0e | 98 | * * |
hemddabral | 2:19d1dcef0c0e | 99 | * Example: * |
hemddabral | 2:19d1dcef0c0e | 100 | * measure = 0; * |
hemddabral | 2:19d1dcef0c0e | 101 | * instance_id = number_of_instances++; * |
hemddabral | 2:19d1dcef0c0e | 102 | *--------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 103 | } |
hemddabral | 2:19d1dcef0c0e | 104 | |
hemddabral | 2:19d1dcef0c0e | 105 | /** |
hemddabral | 2:19d1dcef0c0e | 106 | * @brief Destructor. |
hemddabral | 2:19d1dcef0c0e | 107 | */ |
hemddabral | 2:19d1dcef0c0e | 108 | virtual ~TSU104(void) {} |
hemddabral | 2:19d1dcef0c0e | 109 | |
hemddabral | 2:19d1dcef0c0e | 110 | |
hemddabral | 2:19d1dcef0c0e | 111 | /*** Public Component Related Methods ***/ |
hemddabral | 2:19d1dcef0c0e | 112 | |
hemddabral | 13:9cecc8d66cc1 | 113 | /** |
hemddabral | 13:9cecc8d66cc1 | 114 | * @brief initialize the class for TSU104 operational amplifier component |
hemddabral | 13:9cecc8d66cc1 | 115 | * @retval COMPONENT_OK if initialization is successfull |
hemddabral | 13:9cecc8d66cc1 | 116 | * @retval suitable error code otherwise |
hemddabral | 13:9cecc8d66cc1 | 117 | */ |
hemddabral | 2:19d1dcef0c0e | 118 | virtual int Init(void *init = NULL) |
hemddabral | 2:19d1dcef0c0e | 119 | { |
hemddabral | 2:19d1dcef0c0e | 120 | return (int) TSU104_Init((void *) init); |
hemddabral | 2:19d1dcef0c0e | 121 | } |
hemddabral | 13:9cecc8d66cc1 | 122 | |
hemddabral | 13:9cecc8d66cc1 | 123 | /** |
hemddabral | 13:9cecc8d66cc1 | 124 | * @brief obtain component ID for TSU104 perational amplifier |
hemddabral | 13:9cecc8d66cc1 | 125 | * @retval component ID for TSU104 operational amplifier |
hemddabral | 13:9cecc8d66cc1 | 126 | */ |
hemddabral | 2:19d1dcef0c0e | 127 | virtual int ReadID(uint8_t *id = NULL) |
hemddabral | 2:19d1dcef0c0e | 128 | { |
hemddabral | 2:19d1dcef0c0e | 129 | return (int) TSU104_ReadID((uint8_t *) id); |
hemddabral | 2:19d1dcef0c0e | 130 | } |
hemddabral | 13:9cecc8d66cc1 | 131 | /** |
hemddabral | 13:9cecc8d66cc1 | 132 | * @brief obtain digital value at arduino pin D2 |
hemddabral | 13:9cecc8d66cc1 | 133 | * @retval digital value at arduino pin D2 |
hemddabral | 13:9cecc8d66cc1 | 134 | */ |
hemddabral | 2:19d1dcef0c0e | 135 | virtual unsigned int TSU104_WindComp_Get_D2(void) |
hemddabral | 2:19d1dcef0c0e | 136 | { |
hemddabral | 2:19d1dcef0c0e | 137 | DigitalIn windowsCompD2(D2); |
hemddabral | 2:19d1dcef0c0e | 138 | return windowsCompD2.read(); |
hemddabral | 2:19d1dcef0c0e | 139 | } |
hemddabral | 2:19d1dcef0c0e | 140 | |
hemddabral | 13:9cecc8d66cc1 | 141 | /** |
hemddabral | 13:9cecc8d66cc1 | 142 | * @brief obtain digital value at arduino pin D4 |
hemddabral | 13:9cecc8d66cc1 | 143 | * @retval digital value at arduino pin D4 |
hemddabral | 13:9cecc8d66cc1 | 144 | */ |
hemddabral | 2:19d1dcef0c0e | 145 | virtual unsigned int TSU104_WindComp_Get_D4(void) |
hemddabral | 2:19d1dcef0c0e | 146 | { |
hemddabral | 2:19d1dcef0c0e | 147 | DigitalIn windowsCompD4(D4); |
hemddabral | 2:19d1dcef0c0e | 148 | return windowsCompD4.read(); |
hemddabral | 2:19d1dcef0c0e | 149 | } |
hemddabral | 13:9cecc8d66cc1 | 150 | |
hemddabral | 13:9cecc8d66cc1 | 151 | |
hemddabral | 13:9cecc8d66cc1 | 152 | /** |
hemddabral | 13:9cecc8d66cc1 | 153 | * @brief obtain the output voltage detected by photo sensor |
hemddabral | 13:9cecc8d66cc1 | 154 | * @param pin AnalogIn pin to use for detecting the voltage |
hemddabral | 13:9cecc8d66cc1 | 155 | * @retval voltage detected by photo sensor |
hemddabral | 13:9cecc8d66cc1 | 156 | */ |
hemddabral | 6:5dd31859cea3 | 157 | virtual unsigned int TSU104_PhotoSensor_GetVoltage(PinName pin) |
hemddabral | 2:19d1dcef0c0e | 158 | { |
hemddabral | 6:5dd31859cea3 | 159 | AnalogIn photoSensor(pin); |
hemddabral | 12:ac16b9a1cad6 | 160 | double voltage = photoSensor.read(); |
hemddabral | 2:19d1dcef0c0e | 161 | voltage = voltage*3.3*1000.0; // voltage in mV |
hemddabral | 2:19d1dcef0c0e | 162 | return voltage; |
hemddabral | 2:19d1dcef0c0e | 163 | } |
hemddabral | 2:19d1dcef0c0e | 164 | |
hemddabral | 2:19d1dcef0c0e | 165 | |
hemddabral | 2:19d1dcef0c0e | 166 | /*** Public Interrupt Related Methods ***/ |
hemddabral | 2:19d1dcef0c0e | 167 | |
hemddabral | 2:19d1dcef0c0e | 168 | /* ACTION 6 --------------------------------------------------------------* |
hemddabral | 2:19d1dcef0c0e | 169 | * Implement here interrupt related methods, if any. * |
hemddabral | 2:19d1dcef0c0e | 170 | * Note that interrupt handling is platform dependent, e.g.: * |
hemddabral | 2:19d1dcef0c0e | 171 | * + mbed: * |
hemddabral | 2:19d1dcef0c0e | 172 | * InterruptIn feature_irq(pin); //Interrupt object. * |
hemddabral | 2:19d1dcef0c0e | 173 | * feature_irq.fall(callback); //Attach a callback. * |
hemddabral | 2:19d1dcef0c0e | 174 | * feature_irq.mode(PullNone); //Set interrupt mode. * |
hemddabral | 2:19d1dcef0c0e | 175 | * feature_irq.enable_irq(); //Enable interrupt. * |
hemddabral | 2:19d1dcef0c0e | 176 | * feature_irq.disable_irq(); //Disable interrupt. * |
hemddabral | 2:19d1dcef0c0e | 177 | * + Arduino: * |
hemddabral | 2:19d1dcef0c0e | 178 | * attachInterrupt(pin, callback, RISING); //Attach a callback. * |
hemddabral | 2:19d1dcef0c0e | 179 | * detachInterrupt(pin); //Detach a callback. * |
hemddabral | 2:19d1dcef0c0e | 180 | * * |
hemddabral | 2:19d1dcef0c0e | 181 | * Example (mbed): * |
hemddabral | 2:19d1dcef0c0e | 182 | * void AttachFeatureIRQ(void (*fptr) (void)) * |
hemddabral | 2:19d1dcef0c0e | 183 | * { * |
hemddabral | 2:19d1dcef0c0e | 184 | * feature_irq.fall(fptr); * |
hemddabral | 2:19d1dcef0c0e | 185 | * } * |
hemddabral | 2:19d1dcef0c0e | 186 | * * |
hemddabral | 2:19d1dcef0c0e | 187 | * void EnableFeatureIRQ(void) * |
hemddabral | 2:19d1dcef0c0e | 188 | * { * |
hemddabral | 2:19d1dcef0c0e | 189 | * feature_irq.enable_irq(); * |
hemddabral | 2:19d1dcef0c0e | 190 | * } * |
hemddabral | 2:19d1dcef0c0e | 191 | * * |
hemddabral | 2:19d1dcef0c0e | 192 | * void DisableFeatureIRQ(void) * |
hemddabral | 2:19d1dcef0c0e | 193 | * { * |
hemddabral | 2:19d1dcef0c0e | 194 | * feature_irq.disable_irq(); * |
hemddabral | 2:19d1dcef0c0e | 195 | * } * |
hemddabral | 2:19d1dcef0c0e | 196 | *------------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 197 | |
hemddabral | 2:19d1dcef0c0e | 198 | |
hemddabral | 2:19d1dcef0c0e | 199 | protected: |
hemddabral | 2:19d1dcef0c0e | 200 | |
hemddabral | 2:19d1dcef0c0e | 201 | /*** Protected Component Related Methods ***/ |
hemddabral | 2:19d1dcef0c0e | 202 | |
hemddabral | 2:19d1dcef0c0e | 203 | /* ACTION 7 --------------------------------------------------------------* |
hemddabral | 2:19d1dcef0c0e | 204 | * Declare here the component's specific methods. * |
hemddabral | 2:19d1dcef0c0e | 205 | * They should be: * |
hemddabral | 2:19d1dcef0c0e | 206 | * + Methods with the same name of the C component's virtual table's * |
hemddabral | 2:19d1dcef0c0e | 207 | * functions (1); * |
hemddabral | 2:19d1dcef0c0e | 208 | * + Methods with the same name of the C component's extended virtual * |
hemddabral | 2:19d1dcef0c0e | 209 | * table's functions, if any (2); * |
hemddabral | 2:19d1dcef0c0e | 210 | * + Helper methods, if any, like functions declared in the component's * |
hemddabral | 2:19d1dcef0c0e | 211 | * source files but not pointed by the component's virtual table (3). * |
hemddabral | 2:19d1dcef0c0e | 212 | * * |
hemddabral | 2:19d1dcef0c0e | 213 | * Example: * |
hemddabral | 2:19d1dcef0c0e | 214 | * Status_t COMPONENT_GetValue(float *f); //(1) * |
hemddabral | 2:19d1dcef0c0e | 215 | * Status_t COMPONENT_EnableFeature(void); //(2) * |
hemddabral | 2:19d1dcef0c0e | 216 | * Status_t COMPONENT_ComputeAverage(void); //(3) * |
hemddabral | 2:19d1dcef0c0e | 217 | *------------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 218 | /* TSU104's generic functions. */ |
hemddabral | 2:19d1dcef0c0e | 219 | Status_t TSU104_Init(void *init); |
hemddabral | 2:19d1dcef0c0e | 220 | Status_t TSU104_ReadID(void *id); |
hemddabral | 2:19d1dcef0c0e | 221 | |
hemddabral | 2:19d1dcef0c0e | 222 | /* TSU104's interrupts related functions. */ |
hemddabral | 2:19d1dcef0c0e | 223 | Status_t TSU104_ConfigIT(void* a); |
hemddabral | 2:19d1dcef0c0e | 224 | |
hemddabral | 2:19d1dcef0c0e | 225 | |
hemddabral | 2:19d1dcef0c0e | 226 | /*** Component's I/O Methods ***/ |
hemddabral | 2:19d1dcef0c0e | 227 | |
hemddabral | 2:19d1dcef0c0e | 228 | /* ACTION 8 --------------------------------------------------------------* |
hemddabral | 2:19d1dcef0c0e | 229 | * Implement here other I/O methods beyond those already implemented * |
hemddabral | 2:19d1dcef0c0e | 230 | * above, which are declared extern within the component's header file. * |
hemddabral | 2:19d1dcef0c0e | 231 | *------------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 232 | unsigned int TSU104_Read_Pin_D2() |
hemddabral | 2:19d1dcef0c0e | 233 | { |
hemddabral | 2:19d1dcef0c0e | 234 | /* TO BE IMPLEMENTED BY USING TARGET PLATFORM'S APIs. */ |
hemddabral | 2:19d1dcef0c0e | 235 | return (unsigned int) 0; |
hemddabral | 2:19d1dcef0c0e | 236 | } |
hemddabral | 2:19d1dcef0c0e | 237 | |
hemddabral | 2:19d1dcef0c0e | 238 | unsigned int TSU104_Read_Pin_D4() |
hemddabral | 2:19d1dcef0c0e | 239 | { |
hemddabral | 2:19d1dcef0c0e | 240 | /* TO BE IMPLEMENTED BY USING TARGET PLATFORM'S APIs. */ |
hemddabral | 2:19d1dcef0c0e | 241 | return (unsigned int) 0; |
hemddabral | 2:19d1dcef0c0e | 242 | } |
hemddabral | 2:19d1dcef0c0e | 243 | |
hemddabral | 2:19d1dcef0c0e | 244 | unsigned int TSU104_Read_Pin_A4() |
hemddabral | 2:19d1dcef0c0e | 245 | { |
hemddabral | 2:19d1dcef0c0e | 246 | /* TO BE IMPLEMENTED BY USING TARGET PLATFORM'S APIs. */ |
hemddabral | 2:19d1dcef0c0e | 247 | return (unsigned int) 0; |
hemddabral | 2:19d1dcef0c0e | 248 | } |
hemddabral | 2:19d1dcef0c0e | 249 | |
hemddabral | 2:19d1dcef0c0e | 250 | |
hemddabral | 2:19d1dcef0c0e | 251 | /*** Component's Instance Variables ***/ |
hemddabral | 2:19d1dcef0c0e | 252 | |
hemddabral | 2:19d1dcef0c0e | 253 | /* ACTION 9 --------------------------------------------------------------* |
hemddabral | 2:19d1dcef0c0e | 254 | * Declare here interrupt related variables, if needed. * |
hemddabral | 2:19d1dcef0c0e | 255 | * Note that interrupt handling is platform dependent, see * |
hemddabral | 2:19d1dcef0c0e | 256 | * "Interrupt Related Methods" above. * |
hemddabral | 2:19d1dcef0c0e | 257 | * * |
hemddabral | 2:19d1dcef0c0e | 258 | * Example: * |
hemddabral | 2:19d1dcef0c0e | 259 | * + mbed: * |
hemddabral | 2:19d1dcef0c0e | 260 | * InterruptIn feature_irq; * |
hemddabral | 2:19d1dcef0c0e | 261 | *------------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 262 | |
hemddabral | 2:19d1dcef0c0e | 263 | /* ACTION 10 -------------------------------------------------------------* |
hemddabral | 2:19d1dcef0c0e | 264 | * Declare here other pin related variables, if needed. * |
hemddabral | 2:19d1dcef0c0e | 265 | * * |
hemddabral | 2:19d1dcef0c0e | 266 | * Example: * |
hemddabral | 2:19d1dcef0c0e | 267 | * + mbed: * |
hemddabral | 2:19d1dcef0c0e | 268 | * DigitalOut standby_reset; * |
hemddabral | 2:19d1dcef0c0e | 269 | *------------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 270 | |
hemddabral | 2:19d1dcef0c0e | 271 | /* ACTION 11 -------------------------------------------------------------* |
hemddabral | 2:19d1dcef0c0e | 272 | * Declare here communication related variables, if needed. * |
hemddabral | 2:19d1dcef0c0e | 273 | * * |
hemddabral | 2:19d1dcef0c0e | 274 | * Example: * |
hemddabral | 2:19d1dcef0c0e | 275 | * + mbed: * |
hemddabral | 2:19d1dcef0c0e | 276 | * DigitalOut address; * |
hemddabral | 2:19d1dcef0c0e | 277 | * DevI2C &dev_i2c; * |
hemddabral | 2:19d1dcef0c0e | 278 | *------------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 279 | |
hemddabral | 2:19d1dcef0c0e | 280 | /* ACTION 12 -------------------------------------------------------------* |
hemddabral | 2:19d1dcef0c0e | 281 | * Declare here identity related variables, if needed. * |
hemddabral | 2:19d1dcef0c0e | 282 | * Note that there should be only a unique identifier for each component, * |
hemddabral | 2:19d1dcef0c0e | 283 | * which should be the "who_am_i" parameter. * |
hemddabral | 2:19d1dcef0c0e | 284 | *------------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 285 | /* Identity */ |
hemddabral | 2:19d1dcef0c0e | 286 | uint8_t who_am_i; |
hemddabral | 2:19d1dcef0c0e | 287 | |
hemddabral | 2:19d1dcef0c0e | 288 | /* ACTION 13 -------------------------------------------------------------* |
hemddabral | 2:19d1dcef0c0e | 289 | * Declare here the component's static and non-static data, one variable * |
hemddabral | 2:19d1dcef0c0e | 290 | * per line. * |
hemddabral | 2:19d1dcef0c0e | 291 | * * |
hemddabral | 2:19d1dcef0c0e | 292 | * Example: * |
hemddabral | 2:19d1dcef0c0e | 293 | * float measure; * |
hemddabral | 2:19d1dcef0c0e | 294 | * int instance_id; * |
hemddabral | 2:19d1dcef0c0e | 295 | * static int number_of_instances; * |
hemddabral | 2:19d1dcef0c0e | 296 | *------------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 297 | }; |
hemddabral | 2:19d1dcef0c0e | 298 | |
hemddabral | 2:19d1dcef0c0e | 299 | #endif /* __TSU104_CLASS_H */ |
hemddabral | 2:19d1dcef0c0e | 300 | |
hemddabral | 2:19d1dcef0c0e | 301 | /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |