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/TSZ124/TSZ124.h@23:807f66b435d6, 2017-07-13 (annotated)

Committer:
Davidroid
Date:
Thu Jul 13 15:46:02 2017 +0000
Revision:
23:807f66b435d6
Parent:
22:ff8d071bf79e 
Adapting to ARM mbed coding style.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
hemddabral 2:19d1dcef0c0e 1 /**
hemddabral 2:19d1dcef0c0e 2 ******************************************************************************
Davidroid 22:ff8d071bf79e 3 * @file TSZ124.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 TSZ124
hemddabral 2:19d1dcef0c0e 8 ******************************************************************************
hemddabral 2:19d1dcef0c0e 9 * @attention
hemddabral 2:19d1dcef0c0e 10 *
hemddabral 2:19d1dcef0c0e 11 * <h2><center>&copy; 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/tsz124/tsz124.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 __TSZ124_CLASS_H
hemddabral 2:19d1dcef0c0e 54 #define __TSZ124_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 *----------------------------------------------------------------------------*/
Davidroid 22:ff8d071bf79e 66 #include "TSZ124_def.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: *
Davidroid 22:ff8d071bf79e 71 * #include "HumiditySensor.h" *
Davidroid 22:ff8d071bf79e 72 * #include "TemperatureSensor.h" *
hemddabral 2:19d1dcef0c0e 73 *----------------------------------------------------------------------------*/
Davidroid 22:ff8d071bf79e 74 #include "../Interfaces/InstrumentationAmp.h"
hemddabral 20:169bdc228a7b 75 #include "x_nucleo_ika01a1_config.h"
hemddabral 2:19d1dcef0c0e 76
hemddabral 2:19d1dcef0c0e 77
hemddabral 2:19d1dcef0c0e 78 /* Classes -------------------------------------------------------------------*/
hemddabral 2:19d1dcef0c0e 79
hemddabral 2:19d1dcef0c0e 80 /**
hemddabral 13:9cecc8d66cc1 81 * @brief Class representing a TSZ124 operational amplifier component.
hemddabral 2:19d1dcef0c0e 82 */
Davidroid 22:ff8d071bf79e 83 class TSZ124 : public InstrumentationAmp
hemddabral 2:19d1dcef0c0e 84 {
hemddabral 2:19d1dcef0c0e 85 public:
hemddabral 2:19d1dcef0c0e 86
hemddabral 2:19d1dcef0c0e 87 /*** Constructor and Destructor Methods ***/
hemddabral 2:19d1dcef0c0e 88
hemddabral 2:19d1dcef0c0e 89 /**
hemddabral 2:19d1dcef0c0e 90 * @brief Constructor.
hemddabral 2:19d1dcef0c0e 91 */
Davidroid 22:ff8d071bf79e 92 TSZ124(PinName instrumentAmpPin, PinName currentSensorPin) : InstrumentationAmp()
hemddabral 2:19d1dcef0c0e 93 {
hemddabral 21:8d0624950dd1 94 instrAmpPin = instrumentAmpPin;
hemddabral 21:8d0624950dd1 95 currentSensPin = currentSensorPin;
hemddabral 2:19d1dcef0c0e 96 }
hemddabral 2:19d1dcef0c0e 97
hemddabral 2:19d1dcef0c0e 98 /**
hemddabral 2:19d1dcef0c0e 99 * @brief Destructor.
hemddabral 2:19d1dcef0c0e 100 */
hemddabral 2:19d1dcef0c0e 101 virtual ~TSZ124(void) {}
Davidroid 22:ff8d071bf79e 102
Davidroid 22:ff8d071bf79e 103
Davidroid 22:ff8d071bf79e 104 /*** Public Component Related Methods ***/
hemddabral 2:19d1dcef0c0e 105
Davidroid 22:ff8d071bf79e 106 /* ACTION 5 --------------------------------------------------------------*
Davidroid 22:ff8d071bf79e 107 * Implement here the component's public methods, as wrappers of the C *
Davidroid 22:ff8d071bf79e 108 * component's functions. *
Davidroid 22:ff8d071bf79e 109 * They should be: *
Davidroid 22:ff8d071bf79e 110 * + Methods with the same name of the C component's virtual table's *
Davidroid 22:ff8d071bf79e 111 * functions (1); *
Davidroid 22:ff8d071bf79e 112 * + Methods with the same name of the C component's extended virtual *
Davidroid 22:ff8d071bf79e 113 * table's functions, if any (2). *
Davidroid 22:ff8d071bf79e 114 * *
Davidroid 22:ff8d071bf79e 115 * Example: *
Davidroid 22:ff8d071bf79e 116 * virtual int get_value(float *p_data) //(1) *
Davidroid 22:ff8d071bf79e 117 * { *
Davidroid 22:ff8d071bf79e 118 * return COMPONENT_get_value(float *pf_data); *
Davidroid 22:ff8d071bf79e 119 * } *
Davidroid 22:ff8d071bf79e 120 * *
Davidroid 22:ff8d071bf79e 121 * virtual int enable_feature(void) //(2) *
Davidroid 22:ff8d071bf79e 122 * { *
Davidroid 22:ff8d071bf79e 123 * return COMPONENT_enable_feature(); *
Davidroid 22:ff8d071bf79e 124 * } *
Davidroid 22:ff8d071bf79e 125 *------------------------------------------------------------------------*/
hemddabral 2:19d1dcef0c0e 126
Davidroid 22:ff8d071bf79e 127 /**
Davidroid 22:ff8d071bf79e 128 * @brief Public functions inherited from the Component Class
Davidroid 22:ff8d071bf79e 129 */
hemddabral 13:9cecc8d66cc1 130
hemddabral 13:9cecc8d66cc1 131 /**
hemddabral 13:9cecc8d66cc1 132 * @brief initialize class for TSZ124 operational amplifier component
hemddabral 13:9cecc8d66cc1 133 * @retval COMPONENT_OK if initialization is successfull
hemddabral 13:9cecc8d66cc1 134 * @retval suitable error code otherwise
hemddabral 13:9cecc8d66cc1 135 */
Davidroid 22:ff8d071bf79e 136 virtual int init(void *init = NULL)
hemddabral 2:19d1dcef0c0e 137 {
hemddabral 2:19d1dcef0c0e 138 return (int) TSZ124_Init((void *) init);
hemddabral 2:19d1dcef0c0e 139 }
hemddabral 2:19d1dcef0c0e 140
hemddabral 13:9cecc8d66cc1 141 /**
hemddabral 13:9cecc8d66cc1 142 * @brief obtain component ID for TSZ124 perational amplifier
hemddabral 13:9cecc8d66cc1 143 * @retval component ID for TSZ124 operational amplifier
hemddabral 13:9cecc8d66cc1 144 */
Davidroid 22:ff8d071bf79e 145 virtual int read_id(uint8_t *id = NULL)
hemddabral 2:19d1dcef0c0e 146 {
hemddabral 2:19d1dcef0c0e 147 return (int) TSZ124_ReadID((uint8_t *) id);
hemddabral 2:19d1dcef0c0e 148 }
hemddabral 2:19d1dcef0c0e 149
Davidroid 22:ff8d071bf79e 150 /**
Davidroid 22:ff8d071bf79e 151 * @brief Public functions inherited from the InstrumentationAmp Class
Davidroid 22:ff8d071bf79e 152 */
Davidroid 22:ff8d071bf79e 153
hemddabral 13:9cecc8d66cc1 154 /**
hemddabral 13:9cecc8d66cc1 155 * @brief obtain the amplified differential voltage in instrumentation Amplifier configuration
hemddabral 13:9cecc8d66cc1 156 * @retval amplified differential voltage in instrumentation Amplifier configuration
hemddabral 13:9cecc8d66cc1 157 */
Davidroid 22:ff8d071bf79e 158 virtual unsigned int get_voltage(void)
hemddabral 2:19d1dcef0c0e 159 {
hemddabral 2:19d1dcef0c0e 160 const unsigned int ADC_RANGE_12_BIT = 0xFFF;
Davidroid 22:ff8d071bf79e 161 AnalogIn ain(instrAmpPin);
hemddabral 11:91d59b5ac026 162 return ((double)ain.read())*805.0*ADC_RANGE_12_BIT/1000.0;
hemddabral 2:19d1dcef0c0e 163 }
hemddabral 2:19d1dcef0c0e 164
hemddabral 13:9cecc8d66cc1 165 /**
hemddabral 13:9cecc8d66cc1 166 * @brief obtain the current consumed by the application in Current sensing configuration
hemddabral 13:9cecc8d66cc1 167 * @retval current consumed by the application in Current sensing configuration
hemddabral 13:9cecc8d66cc1 168 */
Davidroid 22:ff8d071bf79e 169 virtual unsigned int get_current(void)
hemddabral 2:19d1dcef0c0e 170 {
hemddabral 2:19d1dcef0c0e 171 const unsigned int ADC_RANGE_12_BIT = 0xFFF;
Davidroid 22:ff8d071bf79e 172 AnalogIn ain(currentSensPin);
hemddabral 11:91d59b5ac026 173 return ((double)ain.read())*1000.0*805.0*ADC_RANGE_12_BIT/1000.0/1586.0;
hemddabral 2:19d1dcef0c0e 174 }
hemddabral 2:19d1dcef0c0e 175
hemddabral 2:19d1dcef0c0e 176
hemddabral 2:19d1dcef0c0e 177 /*** Public Interrupt Related Methods ***/
hemddabral 2:19d1dcef0c0e 178
hemddabral 2:19d1dcef0c0e 179 /* ACTION 6 --------------------------------------------------------------*
hemddabral 2:19d1dcef0c0e 180 * Implement here interrupt related methods, if any. *
hemddabral 2:19d1dcef0c0e 181 * Note that interrupt handling is platform dependent, e.g.: *
hemddabral 2:19d1dcef0c0e 182 * + mbed: *
hemddabral 2:19d1dcef0c0e 183 * InterruptIn feature_irq(pin); //Interrupt object. *
hemddabral 2:19d1dcef0c0e 184 * feature_irq.fall(callback); //Attach a callback. *
hemddabral 2:19d1dcef0c0e 185 * feature_irq.mode(PullNone); //Set interrupt mode. *
hemddabral 2:19d1dcef0c0e 186 * feature_irq.enable_irq(); //Enable interrupt. *
hemddabral 2:19d1dcef0c0e 187 * feature_irq.disable_irq(); //Disable interrupt. *
hemddabral 2:19d1dcef0c0e 188 * + Arduino: *
hemddabral 2:19d1dcef0c0e 189 * attachInterrupt(pin, callback, RISING); //Attach a callback. *
hemddabral 2:19d1dcef0c0e 190 * detachInterrupt(pin); //Detach a callback. *
hemddabral 2:19d1dcef0c0e 191 * *
hemddabral 2:19d1dcef0c0e 192 * Example (mbed): *
Davidroid 22:ff8d071bf79e 193 * void attach_feature_irq(void (*fptr) (void)) *
Davidroid 22:ff8d071bf79e 194 * { *
Davidroid 22:ff8d071bf79e 195 * feature_irq.rise(fptr); *
Davidroid 22:ff8d071bf79e 196 * } *
Davidroid 22:ff8d071bf79e 197 * *
Davidroid 22:ff8d071bf79e 198 * void enable_feature_irq(void) *
Davidroid 22:ff8d071bf79e 199 * { *
Davidroid 22:ff8d071bf79e 200 * feature_irq.enable_irq(); *
Davidroid 22:ff8d071bf79e 201 * } *
Davidroid 22:ff8d071bf79e 202 * *
Davidroid 22:ff8d071bf79e 203 * void disable_feature_irq(void) *
Davidroid 22:ff8d071bf79e 204 * { *
Davidroid 22:ff8d071bf79e 205 * feature_irq.disable_irq(); *
Davidroid 22:ff8d071bf79e 206 * } *
hemddabral 2:19d1dcef0c0e 207 *------------------------------------------------------------------------*/
hemddabral 2:19d1dcef0c0e 208
hemddabral 2:19d1dcef0c0e 209
hemddabral 2:19d1dcef0c0e 210 protected:
hemddabral 2:19d1dcef0c0e 211
hemddabral 2:19d1dcef0c0e 212 /*** Protected Component Related Methods ***/
hemddabral 2:19d1dcef0c0e 213
hemddabral 2:19d1dcef0c0e 214 /* ACTION 7 --------------------------------------------------------------*
hemddabral 2:19d1dcef0c0e 215 * Declare here the component's specific methods. *
hemddabral 2:19d1dcef0c0e 216 * They should be: *
hemddabral 2:19d1dcef0c0e 217 * + Methods with the same name of the C component's virtual table's *
hemddabral 2:19d1dcef0c0e 218 * functions (1); *
hemddabral 2:19d1dcef0c0e 219 * + Methods with the same name of the C component's extended virtual *
hemddabral 2:19d1dcef0c0e 220 * table's functions, if any (2); *
hemddabral 2:19d1dcef0c0e 221 * + Helper methods, if any, like functions declared in the component's *
hemddabral 2:19d1dcef0c0e 222 * source files but not pointed by the component's virtual table (3). *
hemddabral 2:19d1dcef0c0e 223 * *
hemddabral 2:19d1dcef0c0e 224 * Example: *
Davidroid 22:ff8d071bf79e 225 * status_t COMPONENT_get_value(float *f); //(1) *
Davidroid 22:ff8d071bf79e 226 * status_t COMPONENT_enable_feature(void); //(2) *
Davidroid 22:ff8d071bf79e 227 * status_t COMPONENT_compute_average(void); //(3) *
hemddabral 2:19d1dcef0c0e 228 *------------------------------------------------------------------------*/
hemddabral 2:19d1dcef0c0e 229 /* TSZ124's generic functions. */
Davidroid 22:ff8d071bf79e 230 status_t TSZ124_Init(void *init);
hemddabral 13:9cecc8d66cc1 231 unsigned int TSZ124_ReadID(void *id);
hemddabral 21:8d0624950dd1 232 PinName instrAmpPin;
hemddabral 21:8d0624950dd1 233 PinName currentSensPin;
hemddabral 2:19d1dcef0c0e 234
hemddabral 2:19d1dcef0c0e 235
hemddabral 2:19d1dcef0c0e 236 /*** Component's Instance Variables ***/
hemddabral 2:19d1dcef0c0e 237
hemddabral 2:19d1dcef0c0e 238 /* ACTION 9 --------------------------------------------------------------*
hemddabral 2:19d1dcef0c0e 239 * Declare here interrupt related variables, if needed. *
hemddabral 2:19d1dcef0c0e 240 * Note that interrupt handling is platform dependent, see *
hemddabral 2:19d1dcef0c0e 241 * "Interrupt Related Methods" above. *
hemddabral 2:19d1dcef0c0e 242 * *
hemddabral 2:19d1dcef0c0e 243 * Example: *
hemddabral 2:19d1dcef0c0e 244 * + mbed: *
hemddabral 2:19d1dcef0c0e 245 * InterruptIn feature_irq; *
hemddabral 2:19d1dcef0c0e 246 *------------------------------------------------------------------------*/
hemddabral 2:19d1dcef0c0e 247
hemddabral 2:19d1dcef0c0e 248 /* ACTION 10 -------------------------------------------------------------*
hemddabral 2:19d1dcef0c0e 249 * Declare here other pin related variables, if needed. *
hemddabral 2:19d1dcef0c0e 250 * *
hemddabral 2:19d1dcef0c0e 251 * Example: *
hemddabral 2:19d1dcef0c0e 252 * + mbed: *
hemddabral 2:19d1dcef0c0e 253 * DigitalOut standby_reset; *
hemddabral 2:19d1dcef0c0e 254 *------------------------------------------------------------------------*/
hemddabral 2:19d1dcef0c0e 255
hemddabral 2:19d1dcef0c0e 256 /* ACTION 11 -------------------------------------------------------------*
hemddabral 2:19d1dcef0c0e 257 * Declare here communication related variables, if needed. *
hemddabral 2:19d1dcef0c0e 258 * *
hemddabral 2:19d1dcef0c0e 259 * Example: *
hemddabral 2:19d1dcef0c0e 260 * + mbed: *
hemddabral 2:19d1dcef0c0e 261 * DigitalOut address; *
hemddabral 2:19d1dcef0c0e 262 * DevI2C &dev_i2c; *
hemddabral 2:19d1dcef0c0e 263 *------------------------------------------------------------------------*/
hemddabral 2:19d1dcef0c0e 264
hemddabral 2:19d1dcef0c0e 265 /* ACTION 12 -------------------------------------------------------------*
hemddabral 2:19d1dcef0c0e 266 * Declare here identity related variables, if needed. *
hemddabral 2:19d1dcef0c0e 267 * Note that there should be only a unique identifier for each component, *
hemddabral 2:19d1dcef0c0e 268 * which should be the "who_am_i" parameter. *
hemddabral 2:19d1dcef0c0e 269 *------------------------------------------------------------------------*/
hemddabral 2:19d1dcef0c0e 270 /* Identity */
hemddabral 2:19d1dcef0c0e 271 uint8_t who_am_i;
hemddabral 2:19d1dcef0c0e 272
hemddabral 2:19d1dcef0c0e 273 /* ACTION 13 -------------------------------------------------------------*
hemddabral 2:19d1dcef0c0e 274 * Declare here the component's static and non-static data, one variable *
hemddabral 2:19d1dcef0c0e 275 * per line. *
hemddabral 2:19d1dcef0c0e 276 * *
hemddabral 2:19d1dcef0c0e 277 * Example: *
hemddabral 2:19d1dcef0c0e 278 * float measure; *
hemddabral 2:19d1dcef0c0e 279 * int instance_id; *
hemddabral 2:19d1dcef0c0e 280 * static int number_of_instances; *
hemddabral 2:19d1dcef0c0e 281 *------------------------------------------------------------------------*/
hemddabral 2:19d1dcef0c0e 282 };
hemddabral 2:19d1dcef0c0e 283
hemddabral 2:19d1dcef0c0e 284 #endif /* __TSZ124_CLASS_H */
hemddabral 2:19d1dcef0c0e 285
hemddabral 2:19d1dcef0c0e 286 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/