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.
Diff: x_nucleo_ika01a1_class.h
- Revision:
- 13:9cecc8d66cc1
- Parent:
- 2:19d1dcef0c0e
- Child:
- 14:8277ca0ab13a
--- a/x_nucleo_ika01a1_class.h Thu Apr 07 04:15:34 2016 +0000 +++ b/x_nucleo_ika01a1_class.h Thu Apr 07 07:51:13 2016 +0000 @@ -69,7 +69,20 @@ /* Classes -------------------------------------------------------------------*/ -/** Class representing a X_NUCLEO_IKA01A1 board. +/** Class X_NUCLEO_IKA01A1 represents multifunctional expansion board based on operational amplifiers. + * It provides an easy-to-use and affordable solution for different multifunctional use cases with your + * STM32 Nucleo board. For current sensing configuration and the instrumentation amplifier configuration, + * a highly accurate operational amplifier (TSZ124) is used. The expansion board also contains Nanopower (TSU104) + * and Micropower (TSV734) operational amplifiers for mobile applications. + * It is intentionally implemented as a singleton because only one + * X_NUCLEO_IKA01A1 at a time might be deployed in a HW component stack.\n + * In order to get the singleton instance you have to call class method `Instance()`, + * e.g.: + * @code + * // Inertial & Environmental expansion board singleton instance + * static X_NUCLEO_IKA01A1 *<TODO>_expansion_board = X_NUCLEO_IKA01A1::Instance(); + * @endcode + * */ class X_NUCLEO_IKA01A1 { @@ -84,8 +97,9 @@ static X_NUCLEO_IKA01A1 *Instance(void); /** - * @brief Initializing the X_NUCLEO_IKA01A1 board. - * @retval true if initialization is successful, false otherwise. + * @brief Initialize the singleton's operational amplifiers to default settings + * @retval true if initialization is successful + * @retval false otherwise. */ bool Init(void);