Library used to control ST Nucleo Evaluation board IHM12A1, based on STSPIN240 low voltage dual brush DC motor control driver.
Dependencies: ST_INTERFACES
Dependents: motori prova_motore SchedamotoriIHM12A1 prova_motore_duck ... more
Fork of X-NUCLEO-IHM12A1 by
Brush DC Motor Control Library
Library to handle the X-NUCLEO-IHM12A1 Motor Control Expansion Board based on the STSPIN240 component.
It allows a complete management of the STSPIN240, a low voltage dual brush DC driver, by providing a complete APIs.
The key features of the library are :
- Configuration of the STSPIN240 (bridges input and enabling signals)
- Flag interrupt handling (overcurrent and thermal alarms reporting)
- Handling of up to two bidirectional Brush DC motors
- Nucleo and expansion board configuration (GPIOs, PWMs, IRQs…)
To use the STSPIN240 driver library, the user first has to call its initialization method which:
- Setups the required GPIOs to handle the bridges enable pins, the FLAG interrupt which reports overcurrent detection or thermal protection.
- Loads the driver parameters with initial values configured by the user or with their predefined values from “stspin240_250_target_config.h”, in order to program the PWMs frequency of the bridges inputs, the number of brush DC motors.
Once the initialization is done, the user can modify the driver parameters by calling specific functions to change the numbers of motors or the PWMs frequency.
The user can also write callback functions and attach them to:
- The flag interrupt handler depending on the actions he wants to perform when an overcurrent or a thermal alarm is reported.
- The Error handler which is called by the library when it reports an error.
Then, the user can drive the different brush DC motors by requesting to run in a specified direction and by changing the maximal speed. When a motor is requested to run, the corresponding bridge is automatically enabled.
A motion command can be stopped at any moment:
- Either by a hard stop which immediately stops the motor.
- Or by a hardHiz command which immediately stops the motor and disables the bridge which is used by the motor.
The library also provides functions to disable or enable the bridges independently from the run or stop commands.
Arduino Connector Compatibility Warning
Using the X-NUCLEO-IHM12A1 expansion board with the NUCLEO-F429ZI requires adopting the following patch:
- to connect with a wire the
PB_3Nucleo pin to thePWMBexpansion board pin.
Board configuration for HelloWorld_IHM12A1 example
Components/Interfaces/BDCMotor_class.h@0:13bc901c90aa, 2016-04-28 (annotated)
- Committer:
- Manu_L
- Date:
- Thu Apr 28 14:03:11 2016 +0000
- Revision:
- 0:13bc901c90aa
- Child:
- 1:a68f20f0d233
X-NUCLEO-IHM12A1 (STSPIN240) Library creation
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| Manu_L | 0:13bc901c90aa | 1 | /** |
| Manu_L | 0:13bc901c90aa | 2 | ****************************************************************************** |
| Manu_L | 0:13bc901c90aa | 3 | * @file BCDMotor_class.h |
| Manu_L | 0:13bc901c90aa | 4 | * @author IPC Rennes |
| Manu_L | 0:13bc901c90aa | 5 | * @version V1.0.0 |
| Manu_L | 0:13bc901c90aa | 6 | * @date April 6th, 2016 |
| Manu_L | 0:13bc901c90aa | 7 | * @brief This file contains the abstract class describing the interface of a |
| Manu_L | 0:13bc901c90aa | 8 | * Brush DC motor component. |
| Manu_L | 0:13bc901c90aa | 9 | ****************************************************************************** |
| Manu_L | 0:13bc901c90aa | 10 | * @attention |
| Manu_L | 0:13bc901c90aa | 11 | * |
| Manu_L | 0:13bc901c90aa | 12 | * <h2><center>© COPYRIGHT(c) 2016 STMicroelectronics</center></h2> |
| Manu_L | 0:13bc901c90aa | 13 | * |
| Manu_L | 0:13bc901c90aa | 14 | * Redistribution and use in source and binary forms, with or without modification, |
| Manu_L | 0:13bc901c90aa | 15 | * are permitted provided that the following conditions are met: |
| Manu_L | 0:13bc901c90aa | 16 | * 1. Redistributions of source code must retain the above copyright notice, |
| Manu_L | 0:13bc901c90aa | 17 | * this list of conditions and the following disclaimer. |
| Manu_L | 0:13bc901c90aa | 18 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
| Manu_L | 0:13bc901c90aa | 19 | * this list of conditions and the following disclaimer in the documentation |
| Manu_L | 0:13bc901c90aa | 20 | * and/or other materials provided with the distribution. |
| Manu_L | 0:13bc901c90aa | 21 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
| Manu_L | 0:13bc901c90aa | 22 | * may be used to endorse or promote products derived from this software |
| Manu_L | 0:13bc901c90aa | 23 | * without specific prior written permission. |
| Manu_L | 0:13bc901c90aa | 24 | * |
| Manu_L | 0:13bc901c90aa | 25 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| Manu_L | 0:13bc901c90aa | 26 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| Manu_L | 0:13bc901c90aa | 27 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| Manu_L | 0:13bc901c90aa | 28 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
| Manu_L | 0:13bc901c90aa | 29 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| Manu_L | 0:13bc901c90aa | 30 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
| Manu_L | 0:13bc901c90aa | 31 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
| Manu_L | 0:13bc901c90aa | 32 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| Manu_L | 0:13bc901c90aa | 33 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| Manu_L | 0:13bc901c90aa | 34 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| Manu_L | 0:13bc901c90aa | 35 | * |
| Manu_L | 0:13bc901c90aa | 36 | ****************************************************************************** |
| Manu_L | 0:13bc901c90aa | 37 | */ |
| Manu_L | 0:13bc901c90aa | 38 | |
| Manu_L | 0:13bc901c90aa | 39 | |
| Manu_L | 0:13bc901c90aa | 40 | /* Define to prevent from recursive inclusion --------------------------------*/ |
| Manu_L | 0:13bc901c90aa | 41 | |
| Manu_L | 0:13bc901c90aa | 42 | #ifndef __BCDMMOTOR_CLASS_H |
| Manu_L | 0:13bc901c90aa | 43 | #define __BCDMMOTOR_CLASS_H |
| Manu_L | 0:13bc901c90aa | 44 | |
| Manu_L | 0:13bc901c90aa | 45 | |
| Manu_L | 0:13bc901c90aa | 46 | /* Includes ------------------------------------------------------------------*/ |
| Manu_L | 0:13bc901c90aa | 47 | |
| Manu_L | 0:13bc901c90aa | 48 | #include <Component_class.h> |
| Manu_L | 0:13bc901c90aa | 49 | |
| Manu_L | 0:13bc901c90aa | 50 | |
| Manu_L | 0:13bc901c90aa | 51 | /* Classes ------------------------------------------------------------------*/ |
| Manu_L | 0:13bc901c90aa | 52 | |
| Manu_L | 0:13bc901c90aa | 53 | /** An abstract class for BDCMotor components. |
| Manu_L | 0:13bc901c90aa | 54 | */ |
| Manu_L | 0:13bc901c90aa | 55 | class BDCMotor : public Component |
| Manu_L | 0:13bc901c90aa | 56 | { |
| Manu_L | 0:13bc901c90aa | 57 | public: |
| Manu_L | 0:13bc901c90aa | 58 | /** |
| Manu_L | 0:13bc901c90aa | 59 | * @brief Rotation modes. |
| Manu_L | 0:13bc901c90aa | 60 | */ |
| Manu_L | 0:13bc901c90aa | 61 | typedef enum |
| Manu_L | 0:13bc901c90aa | 62 | { |
| Manu_L | 0:13bc901c90aa | 63 | BWD = 0, /* Backward. */ |
| Manu_L | 0:13bc901c90aa | 64 | FWD = 1 /* Forward. */ |
| Manu_L | 0:13bc901c90aa | 65 | } direction_t; |
| Manu_L | 0:13bc901c90aa | 66 | |
| Manu_L | 0:13bc901c90aa | 67 | /** |
| Manu_L | 0:13bc901c90aa | 68 | * @brief Disabling the specified bridge. |
| Manu_L | 0:13bc901c90aa | 69 | * @param bridgeId from 0 for bridge A to 1 for bridge B. |
| Manu_L | 0:13bc901c90aa | 70 | * @retval None. |
| Manu_L | 0:13bc901c90aa | 71 | */ |
| Manu_L | 0:13bc901c90aa | 72 | virtual void DisableBridge(unsigned int) = 0; |
| Manu_L | 0:13bc901c90aa | 73 | |
| Manu_L | 0:13bc901c90aa | 74 | /** |
| Manu_L | 0:13bc901c90aa | 75 | * @brief Enabling the specified bridge. |
| Manu_L | 0:13bc901c90aa | 76 | * @param bridgeId from 0 for bridge A to 1 for bridge B |
| Manu_L | 0:13bc901c90aa | 77 | * @retval None. |
| Manu_L | 0:13bc901c90aa | 78 | */ |
| Manu_L | 0:13bc901c90aa | 79 | virtual void EnableBridge(unsigned int) = 0; |
| Manu_L | 0:13bc901c90aa | 80 | |
| Manu_L | 0:13bc901c90aa | 81 | /** |
| Manu_L | 0:13bc901c90aa | 82 | * @brief Getting the PWM frequency of the specified bridge; |
| Manu_L | 0:13bc901c90aa | 83 | * @param bridgeId from 0 for bridge A to 1 for bridge B. |
| Manu_L | 0:13bc901c90aa | 84 | * @retval The frequency in Hz of the specified bridge input PWM. |
| Manu_L | 0:13bc901c90aa | 85 | */ |
| Manu_L | 0:13bc901c90aa | 86 | virtual unsigned int GetBridgeInputPwmFreq(unsigned int) = 0; |
| Manu_L | 0:13bc901c90aa | 87 | |
| Manu_L | 0:13bc901c90aa | 88 | /** |
| Manu_L | 0:13bc901c90aa | 89 | * @brief Getting the bridge status. |
| Manu_L | 0:13bc901c90aa | 90 | * @param bridgeId from 0 for bridge A to 1 for bridge B. |
| Manu_L | 0:13bc901c90aa | 91 | * @retval The status. |
| Manu_L | 0:13bc901c90aa | 92 | */ |
| Manu_L | 0:13bc901c90aa | 93 | virtual unsigned int GetBridgeStatus(unsigned int) = 0; |
| Manu_L | 0:13bc901c90aa | 94 | |
| Manu_L | 0:13bc901c90aa | 95 | /** |
| Manu_L | 0:13bc901c90aa | 96 | * @brief Getting the device State. |
| Manu_L | 0:13bc901c90aa | 97 | * @param motorId from 0 to (MAX_NUMBER_OF_BRUSH_DC_MOTORS - 1). |
| Manu_L | 0:13bc901c90aa | 98 | * @retval The device state |
| Manu_L | 0:13bc901c90aa | 99 | */ |
| Manu_L | 0:13bc901c90aa | 100 | virtual motorState_t GetDeviceState(unsigned int) = 0; |
| Manu_L | 0:13bc901c90aa | 101 | |
| Manu_L | 0:13bc901c90aa | 102 | /** |
| Manu_L | 0:13bc901c90aa | 103 | * @brief Getting the duty cycle of the PWM used for REF. |
| Manu_L | 0:13bc901c90aa | 104 | * @param refId Id of the reference PWM signal. |
| Manu_L | 0:13bc901c90aa | 105 | * @retval duty cycle in % (from 0 to 100) |
| Manu_L | 0:13bc901c90aa | 106 | */ |
| Manu_L | 0:13bc901c90aa | 107 | virtual unsigned int GetRefPwmDc(unsigned int) = 0; |
| Manu_L | 0:13bc901c90aa | 108 | |
| Manu_L | 0:13bc901c90aa | 109 | /** |
| Manu_L | 0:13bc901c90aa | 110 | * @brief Getting the frequency of the PWM used for REF. |
| Manu_L | 0:13bc901c90aa | 111 | * @param refId Id of the reference PWM signal. |
| Manu_L | 0:13bc901c90aa | 112 | * @retval frequency in Hz. |
| Manu_L | 0:13bc901c90aa | 113 | */ |
| Manu_L | 0:13bc901c90aa | 114 | virtual unsigned int GetRefPwmFreq(unsigned int) = 0; |
| Manu_L | 0:13bc901c90aa | 115 | |
| Manu_L | 0:13bc901c90aa | 116 | /** |
| Manu_L | 0:13bc901c90aa | 117 | * @brief Getting the current speed in % of the specified motor. |
| Manu_L | 0:13bc901c90aa | 118 | * @param motorId from 0 to (MAX_NUMBER_OF_BRUSH_DC_MOTORS - 1). |
| Manu_L | 0:13bc901c90aa | 119 | * @retval The current speed in %. |
| Manu_L | 0:13bc901c90aa | 120 | */ |
| Manu_L | 0:13bc901c90aa | 121 | virtual unsigned int GetSpeed(unsigned int) = 0; |
| Manu_L | 0:13bc901c90aa | 122 | |
| Manu_L | 0:13bc901c90aa | 123 | /** |
| Manu_L | 0:13bc901c90aa | 124 | * @brief Stopping the motor and disabling the power bridge immediately. |
| Manu_L | 0:13bc901c90aa | 125 | * @param motorId from 0 to (MAX_NUMBER_OF_BRUSH_DC_MOTORS - 1). |
| Manu_L | 0:13bc901c90aa | 126 | * @retval None. |
| Manu_L | 0:13bc901c90aa | 127 | */ |
| Manu_L | 0:13bc901c90aa | 128 | virtual void HardHiZ(unsigned int) = 0; |
| Manu_L | 0:13bc901c90aa | 129 | |
| Manu_L | 0:13bc901c90aa | 130 | /** |
| Manu_L | 0:13bc901c90aa | 131 | * @brief Stopping the motor immediately. |
| Manu_L | 0:13bc901c90aa | 132 | * @param motorId from 0 to (MAX_NUMBER_OF_BRUSH_DC_MOTORS - 1). |
| Manu_L | 0:13bc901c90aa | 133 | * @retval None. |
| Manu_L | 0:13bc901c90aa | 134 | */ |
| Manu_L | 0:13bc901c90aa | 135 | virtual void HardStop(unsigned int) = 0; |
| Manu_L | 0:13bc901c90aa | 136 | |
| Manu_L | 0:13bc901c90aa | 137 | /** |
| Manu_L | 0:13bc901c90aa | 138 | * @brief Running the motor. |
| Manu_L | 0:13bc901c90aa | 139 | * @param motorId from 0 to (MAX_NUMBER_OF_BRUSH_DC_MOTORS - 1). |
| Manu_L | 0:13bc901c90aa | 140 | * @param direction The direction of rotation. |
| Manu_L | 0:13bc901c90aa | 141 | * @retval None. |
| Manu_L | 0:13bc901c90aa | 142 | */ |
| Manu_L | 0:13bc901c90aa | 143 | virtual void Run(unsigned int, direction_t) = 0; |
| Manu_L | 0:13bc901c90aa | 144 | |
| Manu_L | 0:13bc901c90aa | 145 | /** |
| Manu_L | 0:13bc901c90aa | 146 | * @brief Setting the PWM frequency of the specified bridge. |
| Manu_L | 0:13bc901c90aa | 147 | * @param bridgeId from 0 for bridge A to 1 for bridge B. |
| Manu_L | 0:13bc901c90aa | 148 | * @param frequency of the PWM in Hz |
| Manu_L | 0:13bc901c90aa | 149 | * @retval None. |
| Manu_L | 0:13bc901c90aa | 150 | */ |
| Manu_L | 0:13bc901c90aa | 151 | virtual void SetBridgeInputPwmFreq(unsigned int, unsigned int) = 0; |
| Manu_L | 0:13bc901c90aa | 152 | |
| Manu_L | 0:13bc901c90aa | 153 | /** |
| Manu_L | 0:13bc901c90aa | 154 | * @brief Setting the dual bridge configuration mode. |
| Manu_L | 0:13bc901c90aa | 155 | * @param configuration. The bridge configuration. |
| Manu_L | 0:13bc901c90aa | 156 | * @retval None. |
| Manu_L | 0:13bc901c90aa | 157 | */ |
| Manu_L | 0:13bc901c90aa | 158 | virtual void SetDualFullBridgeconfig(unsigned int) = 0; |
| Manu_L | 0:13bc901c90aa | 159 | |
| Manu_L | 0:13bc901c90aa | 160 | |
| Manu_L | 0:13bc901c90aa | 161 | /** |
| Manu_L | 0:13bc901c90aa | 162 | * @brief Setting the duty cycle of the PWM used for REF. |
| Manu_L | 0:13bc901c90aa | 163 | * @param refId Id of the reference PWM signal. |
| Manu_L | 0:13bc901c90aa | 164 | * @param newDc new duty cycle from 0 to 100 |
| Manu_L | 0:13bc901c90aa | 165 | * @retval None. |
| Manu_L | 0:13bc901c90aa | 166 | */ |
| Manu_L | 0:13bc901c90aa | 167 | virtual void SetRefPwmDc(unsigned int, unsigned int) = 0; |
| Manu_L | 0:13bc901c90aa | 168 | |
| Manu_L | 0:13bc901c90aa | 169 | /** |
| Manu_L | 0:13bc901c90aa | 170 | * @brief Setting the frequency of the PWM used for REF. |
| Manu_L | 0:13bc901c90aa | 171 | * @param refId Id of the reference PWM signal. |
| Manu_L | 0:13bc901c90aa | 172 | * @param frequency in Hz. |
| Manu_L | 0:13bc901c90aa | 173 | * @retval None. |
| Manu_L | 0:13bc901c90aa | 174 | */ |
| Manu_L | 0:13bc901c90aa | 175 | virtual void SetRefPwmFreq(unsigned int, unsigned int) = 0; |
| Manu_L | 0:13bc901c90aa | 176 | |
| Manu_L | 0:13bc901c90aa | 177 | /** |
| Manu_L | 0:13bc901c90aa | 178 | * @brief Setting the speed in %. |
| Manu_L | 0:13bc901c90aa | 179 | * @param motorId from 0 to (MAX_NUMBER_OF_BRUSH_DC_MOTORS - 1). |
| Manu_L | 0:13bc901c90aa | 180 | * @param speed The new speed in %. |
| Manu_L | 0:13bc901c90aa | 181 | * @retval "true" in case of success, "false" otherwise. |
| Manu_L | 0:13bc901c90aa | 182 | */ |
| Manu_L | 0:13bc901c90aa | 183 | virtual bool SetSpeed(unsigned int, unsigned int) = 0; |
| Manu_L | 0:13bc901c90aa | 184 | |
| Manu_L | 0:13bc901c90aa | 185 | |
| Manu_L | 0:13bc901c90aa | 186 | }; |
| Manu_L | 0:13bc901c90aa | 187 | |
| Manu_L | 0:13bc901c90aa | 188 | #endif /* __BCDMMOTOR_CLASS_H */ |
| Manu_L | 0:13bc901c90aa | 189 | |
| Manu_L | 0:13bc901c90aa | 190 | /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |

X-NUCLEO-IHM12A1 Low Voltage Dual Brush DC Motor Driver