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.

Diff: Components/Interfaces/Instrumentation_amp_class.h

Revision:
18:25dbc718084c
Parent:
2:19d1dcef0c0e
--- a/Components/Interfaces/Instrumentation_amp_class.h	Fri Apr 08 08:59:17 2016 +0000
+++ b/Components/Interfaces/Instrumentation_amp_class.h	Fri Apr 08 09:22:36 2016 +0000
@@ -34,9 +34,9 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
  ******************************************************************************
- */
-
-
+ */
+
+
 /* Generated with STM32CubeTOO -----------------------------------------------*/
 
 
@@ -77,8 +77,18 @@
 	 *                                                                        *
 	 * Example:                                                               *
 	 *    virtual int GetValue(float *f) = 0;                                 *
-	 *------------------------------------------------------------------------*/
-	virtual unsigned int GetVoltage(void) = 0;
+	 *------------------------------------------------------------------------*/
+	 
+	/**
+	 * @brief  abstract method to obtain the amplified differential voltage in instrumentation Amplifier configuration
+	 * @retval amplified differential voltage in instrumentation Amplifier configuration
+	 */		 
+	virtual unsigned int GetVoltage(void) = 0;
+	
+	/**
+	 * @brief  abstract method to obtain the current consumed by the application in Current sensing configuration
+	 * @retval current consumed by the application in Current sensing configuration
+	 */		
 	virtual unsigned int GetCurrent(void) = 0;
 };