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