mbed library for STMicroelectronics' X-NUCLEO-IKA01A1 expansion board.
Dependents: HelloWorld_IKA01A1
Fork of X_NUCLEO_IKA01A1 by
InstrumentationAmp.h
00001 /** 00002 ****************************************************************************** 00003 * @file InstrumentationAmp.h 00004 * @author AST 00005 * @version V1.0.0 00006 * @date April 13th, 2015 00007 * @brief This file contains the abstract class describing the interface of a 00008 * instrumentation_amp component. 00009 ****************************************************************************** 00010 * @attention 00011 * 00012 * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> 00013 * 00014 * Redistribution and use in source and binary forms, with or without modification, 00015 * are permitted provided that the following conditions are met: 00016 * 1. Redistributions of source code must retain the above copyright notice, 00017 * this list of conditions and the following disclaimer. 00018 * 2. Redistributions in binary form must reproduce the above copyright notice, 00019 * this list of conditions and the following disclaimer in the documentation 00020 * and/or other materials provided with the distribution. 00021 * 3. Neither the name of STMicroelectronics nor the names of its contributors 00022 * may be used to endorse or promote products derived from this software 00023 * without specific prior written permission. 00024 * 00025 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00026 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00027 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 00028 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 00029 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 00030 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 00031 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 00032 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 00033 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 00034 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00035 * 00036 ****************************************************************************** 00037 */ 00038 00039 00040 /* Generated with STM32CubeTOO -----------------------------------------------*/ 00041 00042 00043 /* Revision ------------------------------------------------------------------*/ 00044 /* 00045 Repository: http://svn.x-nucleodev.codex.cro.st.com/svnroot/X-NucleoDev 00046 Branch/Trunk/Tag: trunk 00047 Based on: X-CUBE-IKA01A1/trunk/Drivers/BSP/Components/Common/instrumentation_amp.h 00048 Revision: 385 00049 */ 00050 00051 00052 /* Define to prevent recursive inclusion -------------------------------------*/ 00053 00054 #ifndef __INSTRUMENTATION_AMP_CLASS_H 00055 #define __INSTRUMENTATION_AMP_CLASS_H 00056 00057 00058 /* Includes ------------------------------------------------------------------*/ 00059 00060 #include <Component.h> 00061 00062 00063 /* Classes ------------------------------------------------------------------*/ 00064 00065 /** An abstract class for InstrumentationAmp components. 00066 */ 00067 class InstrumentationAmp : public Component 00068 { 00069 public: 00070 /* ACTION 1 --------------------------------------------------------------* 00071 * Declare here the interface's methods. * 00072 * They should be: * 00073 * + Methods with the same name of the C component's virtual table * 00074 * (and extended virtual table, if any)'s functions, provided that * 00075 * the component's driver implements them (i.e.: the corresponding * 00076 * pointer to function is not "0"). * 00077 * * 00078 * Example: * 00079 * virtual int get_value(float *f) = 0; * 00080 *------------------------------------------------------------------------*/ 00081 00082 /** 00083 * @brief abstract method to obtain the amplified differential voltage in instrumentation Amplifier configuration 00084 * @retval amplified differential voltage in instrumentation Amplifier configuration 00085 */ 00086 virtual unsigned int get_voltage(void) = 0; 00087 00088 /** 00089 * @brief abstract method to obtain the current consumed by the application in Current sensing configuration 00090 * @retval current consumed by the application in Current sensing configuration 00091 */ 00092 virtual unsigned int get_current(void) = 0; 00093 00094 /** 00095 * @brief Destructor. 00096 */ 00097 virtual ~InstrumentationAmp() {}; 00098 }; 00099 00100 #endif /* __INSTRUMENTATION_AMP_CLASS_H */ 00101 00102 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 00103
Generated on Tue Jul 12 2022 17:01:48 by 1.7.2