Use BDCMotor_class.h instead of motor_class.h
Dependents: HelloWorld_IHM04A1
Fork of X_NUCLEO_IHM04A1 by
Diff: Components/Interfaces/Motor_class.h
- Revision:
- 0:2cb6ce8e07bd
- Child:
- 1:2597a6165252
diff -r 000000000000 -r 2cb6ce8e07bd Components/Interfaces/Motor_class.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Components/Interfaces/Motor_class.h Tue May 03 11:16:57 2016 +0000 @@ -0,0 +1,102 @@ +/** + ****************************************************************************** + * @file Motor_class.h + * @author AST + * @version V1.0.0 + * @date April 13th, 2015 + * @brief This file contains the abstract class describing the interface of a + * motor component. + ****************************************************************************** + * @attention + * + * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> + * + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * 3. Neither the name of STMicroelectronics nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + ****************************************************************************** + */ + + +/* Generated with STM32CubeTOO -----------------------------------------------*/ + + +/* Revision ------------------------------------------------------------------*/ +/* + Repository: http://svn.x-nucleodev.codex.cro.st.com/svnroot/X-NucleoDev + Branch/Trunk/Tag: trunk + Based on: X-CUBE-SPN4/trunk/Drivers/BSP/Components/Common/motor.h + Revision: 0 +*/ + + +/* Define to prevent recursive inclusion -------------------------------------*/ + +#ifndef __MOTOR_CLASS_H +#define __MOTOR_CLASS_H + + +/* Includes ------------------------------------------------------------------*/ + +#include "Component_class.h" + + +/* Classes ------------------------------------------------------------------*/ + +/** An abstract class for Motor components. + */ +class Motor : public Component +{ +public: + /* ACTION 1 --------------------------------------------------------------* + * Declare here the interface's methods. * + * They should be: * + * + Methods with the same name of the C component's virtual table * + * (and extended virtual table, if any)'s functions, provided that * + * the component's driver implements them (i.e.: the corresponding * + * pointer to function is not "0"). * + * * + * Example: * + * virtual int GetValue(float *f) = 0; * + *------------------------------------------------------------------------*/ + virtual uint16_t GetCurrentSpeed(uint8_t motorId) = 0; + virtual motorState_t GetDeviceState(uint8_t motorId) = 0; + virtual uint8_t GetFwVersion(void) = 0; + virtual uint16_t GetMaxSpeed(uint8_t motorId) = 0; + virtual void HardStop(uint8_t motorId) = 0; + virtual void Run(uint8_t stepCount, motorDir_t direction) = 0; + virtual bool SetMaxSpeed(uint8_t motorId, uint16_t newMaxSpeed) = 0; + virtual void CmdDisable(uint8_t bridgeId) = 0; + virtual void CmdEnable(uint8_t bridgeId) = 0; + virtual uint16_t CmdGetStatus(uint8_t bridgeId) = 0; + virtual void CmdHardHiZ(uint8_t motorId) = 0; + virtual void ErrorHandler(uint16_t error) = 0; + virtual void SetDualFullBridgeConfig(uint8_t newConfig) = 0; + virtual uint32_t GetBridgeInputPwmFreq(uint8_t bridgeId) = 0; + virtual void SetBridgeInputPwmFreq(uint8_t bridgeId, uint32_t newFreq) = 0; + virtual bool SetNbDevices(uint8_t nbDevices) = 0; +}; + +#endif /* __MOTOR_CLASS_H */ + +/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ +