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.
x_nucleo_ika01a1_class.h@2:19d1dcef0c0e, 2016-03-02 (annotated)
- Committer:
- hemddabral
- Date:
- Wed Mar 02 12:58:02 2016 +0000
- Revision:
- 2:19d1dcef0c0e
- Child:
- 13:9cecc8d66cc1
First draft version using STM32COO utility
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 x_nucleo_ika01a1_class.h |
hemddabral | 2:19d1dcef0c0e | 4 | * @author AST / Software Platforms and Cloud |
hemddabral | 2:19d1dcef0c0e | 5 | * @version V1.0 |
hemddabral | 2:19d1dcef0c0e | 6 | * @date October 1st, 2015 |
hemddabral | 2:19d1dcef0c0e | 7 | * @brief Class header file for the X_NUCLEO_IKA01A1 expansion board. |
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 | /* Define to prevent recursive inclusion -------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 43 | |
hemddabral | 2:19d1dcef0c0e | 44 | #ifndef __X_NUCLEO_IKA01A1_CLASS_H |
hemddabral | 2:19d1dcef0c0e | 45 | #define __X_NUCLEO_IKA01A1_CLASS_H |
hemddabral | 2:19d1dcef0c0e | 46 | |
hemddabral | 2:19d1dcef0c0e | 47 | |
hemddabral | 2:19d1dcef0c0e | 48 | /* Includes ------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 49 | |
hemddabral | 2:19d1dcef0c0e | 50 | /* ACTION 1 ------------------------------------------------------------------* |
hemddabral | 2:19d1dcef0c0e | 51 | * Include here platform specific header files. * |
hemddabral | 2:19d1dcef0c0e | 52 | *----------------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 53 | #include "mbed.h" |
hemddabral | 2:19d1dcef0c0e | 54 | /* ACTION 2 ------------------------------------------------------------------* |
hemddabral | 2:19d1dcef0c0e | 55 | * Include here expansion board configuration's header files. * |
hemddabral | 2:19d1dcef0c0e | 56 | *----------------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 57 | #include "x_nucleo_ika01a1_config.h" |
hemddabral | 2:19d1dcef0c0e | 58 | /* ACTION 3 ------------------------------------------------------------------* |
hemddabral | 2:19d1dcef0c0e | 59 | * Include here expansion board's components' header files. * |
hemddabral | 2:19d1dcef0c0e | 60 | * * |
hemddabral | 2:19d1dcef0c0e | 61 | * Example: * |
hemddabral | 2:19d1dcef0c0e | 62 | * #include "component_1_class.h" * |
hemddabral | 2:19d1dcef0c0e | 63 | * #include "component_2_class.h" * |
hemddabral | 2:19d1dcef0c0e | 64 | *----------------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 65 | #include "tsz124_class.h" |
hemddabral | 2:19d1dcef0c0e | 66 | #include "tsu104_class.h" |
hemddabral | 2:19d1dcef0c0e | 67 | #include "tsv734_class.h" |
hemddabral | 2:19d1dcef0c0e | 68 | |
hemddabral | 2:19d1dcef0c0e | 69 | |
hemddabral | 2:19d1dcef0c0e | 70 | /* Classes -------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 71 | |
hemddabral | 2:19d1dcef0c0e | 72 | /** Class representing a X_NUCLEO_IKA01A1 board. |
hemddabral | 2:19d1dcef0c0e | 73 | */ |
hemddabral | 2:19d1dcef0c0e | 74 | class X_NUCLEO_IKA01A1 |
hemddabral | 2:19d1dcef0c0e | 75 | { |
hemddabral | 2:19d1dcef0c0e | 76 | public: |
hemddabral | 2:19d1dcef0c0e | 77 | |
hemddabral | 2:19d1dcef0c0e | 78 | /*** Instance, Initialization and Destructor Methods ***/ |
hemddabral | 2:19d1dcef0c0e | 79 | |
hemddabral | 2:19d1dcef0c0e | 80 | /** |
hemddabral | 2:19d1dcef0c0e | 81 | * @brief Getting a singleton instance of X_NUCLEO_IKA01A1 class. |
hemddabral | 2:19d1dcef0c0e | 82 | * @retval a singleton instance of X_NUCLEO_IKA01A1 class. |
hemddabral | 2:19d1dcef0c0e | 83 | */ |
hemddabral | 2:19d1dcef0c0e | 84 | static X_NUCLEO_IKA01A1 *Instance(void); |
hemddabral | 2:19d1dcef0c0e | 85 | |
hemddabral | 2:19d1dcef0c0e | 86 | /** |
hemddabral | 2:19d1dcef0c0e | 87 | * @brief Initializing the X_NUCLEO_IKA01A1 board. |
hemddabral | 2:19d1dcef0c0e | 88 | * @retval true if initialization is successful, false otherwise. |
hemddabral | 2:19d1dcef0c0e | 89 | */ |
hemddabral | 2:19d1dcef0c0e | 90 | bool Init(void); |
hemddabral | 2:19d1dcef0c0e | 91 | |
hemddabral | 2:19d1dcef0c0e | 92 | /** |
hemddabral | 2:19d1dcef0c0e | 93 | * @brief Destructor. |
hemddabral | 2:19d1dcef0c0e | 94 | */ |
hemddabral | 2:19d1dcef0c0e | 95 | ~X_NUCLEO_IKA01A1(void) {} |
hemddabral | 2:19d1dcef0c0e | 96 | |
hemddabral | 2:19d1dcef0c0e | 97 | |
hemddabral | 2:19d1dcef0c0e | 98 | /*** Public Expansion Board Related Attributes ***/ |
hemddabral | 2:19d1dcef0c0e | 99 | |
hemddabral | 2:19d1dcef0c0e | 100 | /* ACTION 4 --------------------------------------------------------------* |
hemddabral | 2:19d1dcef0c0e | 101 | * Declare here a public attribute for each expansion board's component. * |
hemddabral | 2:19d1dcef0c0e | 102 | * You will have to call these attributes' public methods within your * |
hemddabral | 2:19d1dcef0c0e | 103 | * main program. * |
hemddabral | 2:19d1dcef0c0e | 104 | * * |
hemddabral | 2:19d1dcef0c0e | 105 | * Example: * |
hemddabral | 2:19d1dcef0c0e | 106 | * COMPONENT_1 *component_1; * |
hemddabral | 2:19d1dcef0c0e | 107 | * COMPONENT_2 *component_2; * |
hemddabral | 2:19d1dcef0c0e | 108 | *------------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 109 | TSZ124 *tsz124; |
hemddabral | 2:19d1dcef0c0e | 110 | TSU104 *tsu104; |
hemddabral | 2:19d1dcef0c0e | 111 | TSV734 *tsv734; |
hemddabral | 2:19d1dcef0c0e | 112 | |
hemddabral | 2:19d1dcef0c0e | 113 | |
hemddabral | 2:19d1dcef0c0e | 114 | protected: |
hemddabral | 2:19d1dcef0c0e | 115 | |
hemddabral | 2:19d1dcef0c0e | 116 | /*** Protected Constructor Method ***/ |
hemddabral | 2:19d1dcef0c0e | 117 | |
hemddabral | 2:19d1dcef0c0e | 118 | /** |
hemddabral | 2:19d1dcef0c0e | 119 | * @brief Constructor. |
hemddabral | 2:19d1dcef0c0e | 120 | */ |
hemddabral | 2:19d1dcef0c0e | 121 | X_NUCLEO_IKA01A1(void); |
hemddabral | 2:19d1dcef0c0e | 122 | |
hemddabral | 2:19d1dcef0c0e | 123 | |
hemddabral | 2:19d1dcef0c0e | 124 | /*** Protected Expansion Board Related Initialization Methods ***/ |
hemddabral | 2:19d1dcef0c0e | 125 | |
hemddabral | 2:19d1dcef0c0e | 126 | /* ACTION 5 --------------------------------------------------------------* |
hemddabral | 2:19d1dcef0c0e | 127 | * Declare here a protected initialization method for each expansion * |
hemddabral | 2:19d1dcef0c0e | 128 | * board's component. * |
hemddabral | 2:19d1dcef0c0e | 129 | * * |
hemddabral | 2:19d1dcef0c0e | 130 | * Example: * |
hemddabral | 2:19d1dcef0c0e | 131 | * bool Init_COMPONENT_1(void); * |
hemddabral | 2:19d1dcef0c0e | 132 | * bool Init_COMPONENT_2(void); * |
hemddabral | 2:19d1dcef0c0e | 133 | *------------------------------------------------------------------------*/ |
hemddabral | 2:19d1dcef0c0e | 134 | bool Init_TSZ124(void); |
hemddabral | 2:19d1dcef0c0e | 135 | bool Init_TSU104(void); |
hemddabral | 2:19d1dcef0c0e | 136 | bool Init_TSV734(void); |
hemddabral | 2:19d1dcef0c0e | 137 | |
hemddabral | 2:19d1dcef0c0e | 138 | |
hemddabral | 2:19d1dcef0c0e | 139 | /*** Component's Instance Variables ***/ |
hemddabral | 2:19d1dcef0c0e | 140 | |
hemddabral | 2:19d1dcef0c0e | 141 | /* Singleton instance of X_NUCLEO_IKA01A1 class. */ |
hemddabral | 2:19d1dcef0c0e | 142 | static X_NUCLEO_IKA01A1 *_instance; |
hemddabral | 2:19d1dcef0c0e | 143 | }; |
hemddabral | 2:19d1dcef0c0e | 144 | |
hemddabral | 2:19d1dcef0c0e | 145 | #endif /* __X_NUCLEO_IKA01A1_CLASS_H */ |
hemddabral | 2:19d1dcef0c0e | 146 | |
hemddabral | 2:19d1dcef0c0e | 147 | /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |