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 ST Expansion SW Team

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_3 Nucleo pin to the PWMB expansion board pin.


Board configuration for HelloWorld_IHM12A1 example

/media/uploads/Manu_L/x_nucleo_ihm12a1.jpg

Committer:
Davidroid
Date:
Thu Aug 09 15:00:43 2018 +0000
Revision:
7:6efcc9b4d810
Parent:
4:07acd6934359
Update comment of STSpin240_250's class constructor

Who changed what in which revision?

UserRevisionLine numberNew contents of line
davide.aliprandi@st.com 3:b0128df93d26 1 /**************************************************************************//**
davide.aliprandi@st.com 3:b0128df93d26 2 * @file STSpin240_250_config.h
davide.aliprandi@st.com 3:b0128df93d26 3 * @author IPC Rennes
davide.aliprandi@st.com 3:b0128df93d26 4 * @version V1.0.0
davide.aliprandi@st.com 3:b0128df93d26 5 * @date February 10, 2016
davide.aliprandi@st.com 3:b0128df93d26 6 * @brief Predefines values for the Stspin240 or Stspin250 parameters
davide.aliprandi@st.com 3:b0128df93d26 7 * and for the devices parameters
davide.aliprandi@st.com 3:b0128df93d26 8 * @note (C) COPYRIGHT 2016 STMicroelectronics
davide.aliprandi@st.com 3:b0128df93d26 9 ******************************************************************************
davide.aliprandi@st.com 3:b0128df93d26 10 * @attention
davide.aliprandi@st.com 3:b0128df93d26 11 *
davide.aliprandi@st.com 3:b0128df93d26 12 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
davide.aliprandi@st.com 3:b0128df93d26 13 *
davide.aliprandi@st.com 3:b0128df93d26 14 * Redistribution and use in source and binary forms, with or without modification,
davide.aliprandi@st.com 3:b0128df93d26 15 * are permitted provided that the following conditions are met:
davide.aliprandi@st.com 3:b0128df93d26 16 * 1. Redistributions of source code must retain the above copyright notice,
davide.aliprandi@st.com 3:b0128df93d26 17 * this list of conditions and the following disclaimer.
davide.aliprandi@st.com 3:b0128df93d26 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
davide.aliprandi@st.com 3:b0128df93d26 19 * this list of conditions and the following disclaimer in the documentation
davide.aliprandi@st.com 3:b0128df93d26 20 * and/or other materials provided with the distribution.
davide.aliprandi@st.com 3:b0128df93d26 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
davide.aliprandi@st.com 3:b0128df93d26 22 * may be used to endorse or promote products derived from this software
davide.aliprandi@st.com 3:b0128df93d26 23 * without specific prior written permission.
davide.aliprandi@st.com 3:b0128df93d26 24 *
davide.aliprandi@st.com 3:b0128df93d26 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
davide.aliprandi@st.com 3:b0128df93d26 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
davide.aliprandi@st.com 3:b0128df93d26 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
davide.aliprandi@st.com 3:b0128df93d26 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
davide.aliprandi@st.com 3:b0128df93d26 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
davide.aliprandi@st.com 3:b0128df93d26 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
davide.aliprandi@st.com 3:b0128df93d26 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
davide.aliprandi@st.com 3:b0128df93d26 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
davide.aliprandi@st.com 3:b0128df93d26 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
davide.aliprandi@st.com 3:b0128df93d26 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
davide.aliprandi@st.com 3:b0128df93d26 35 *
davide.aliprandi@st.com 3:b0128df93d26 36 ******************************************************************************
davide.aliprandi@st.com 3:b0128df93d26 37 */
davide.aliprandi@st.com 3:b0128df93d26 38
davide.aliprandi@st.com 3:b0128df93d26 39 /* Define to prevent recursive inclusion -------------------------------------*/
davide.aliprandi@st.com 3:b0128df93d26 40 #ifndef __STSPIN240_250_CONFIG_H
davide.aliprandi@st.com 3:b0128df93d26 41 #define __STSPIN240_250_CONFIG_H
davide.aliprandi@st.com 3:b0128df93d26 42
davide.aliprandi@st.com 3:b0128df93d26 43 #ifdef __cplusplus
davide.aliprandi@st.com 3:b0128df93d26 44 extern "C" {
davide.aliprandi@st.com 3:b0128df93d26 45 #endif
davide.aliprandi@st.com 3:b0128df93d26 46
davide.aliprandi@st.com 3:b0128df93d26 47 /** @addtogroup STSPIN240_250
davide.aliprandi@st.com 3:b0128df93d26 48 * @{
davide.aliprandi@st.com 3:b0128df93d26 49 */
davide.aliprandi@st.com 3:b0128df93d26 50
davide.aliprandi@st.com 3:b0128df93d26 51 /** @addtogroup STSPIN240_250_Exported_Defines STSPIN240_250 Exported Defines
davide.aliprandi@st.com 3:b0128df93d26 52 * @{
davide.aliprandi@st.com 3:b0128df93d26 53 */
davide.aliprandi@st.com 3:b0128df93d26 54
davide.aliprandi@st.com 3:b0128df93d26 55 /** @defgroup Predefined_STSPIN240_250_Parameters_Values Predefined STSPIN240_250 Parameters Values
davide.aliprandi@st.com 3:b0128df93d26 56 * @{
davide.aliprandi@st.com 3:b0128df93d26 57 */
davide.aliprandi@st.com 3:b0128df93d26 58
davide.aliprandi@st.com 3:b0128df93d26 59 /// The maximum number of Stspin240 or Stspin250 devices
davide.aliprandi@st.com 3:b0128df93d26 60 #define MAX_NUMBER_OF_DEVICES (1)
davide.aliprandi@st.com 3:b0128df93d26 61
davide.aliprandi@st.com 3:b0128df93d26 62 /// The maximum number of Brush DC motors connected to the Stspin240 or Stspin250
davide.aliprandi@st.com 3:b0128df93d26 63 #define MAX_NUMBER_OF_BRUSH_DC_MOTORS (2)
davide.aliprandi@st.com 3:b0128df93d26 64
davide.aliprandi@st.com 3:b0128df93d26 65 /// Frequency of PWM of Input Bridge A in Hz up to 100000Hz
davide.aliprandi@st.com 3:b0128df93d26 66 #define STSPIN240_250_CONF_PARAM_FREQ_PWM_A (20000)
davide.aliprandi@st.com 3:b0128df93d26 67
davide.aliprandi@st.com 3:b0128df93d26 68 /// Frequency of PWM of Input Bridge B in Hz up to 100000Hz
davide.aliprandi@st.com 3:b0128df93d26 69 /// On the X-NUCLEO-IHM01A12 expansion board the PWM_A and PWM_B
davide.aliprandi@st.com 3:b0128df93d26 70 /// share the same timer, so the frequency must be the same
davide.aliprandi@st.com 3:b0128df93d26 71 #define STSPIN240_250_CONF_PARAM_FREQ_PWM_B (20000)
davide.aliprandi@st.com 3:b0128df93d26 72
davide.aliprandi@st.com 3:b0128df93d26 73 /// Frequency of PWM used for Ref pinin Hz up to 100000Hz
davide.aliprandi@st.com 3:b0128df93d26 74 #define STSPIN240_250_CONF_PARAM_FREQ_PWM_REF (20000)
davide.aliprandi@st.com 3:b0128df93d26 75
davide.aliprandi@st.com 3:b0128df93d26 76 /// Duty cycle of PWM used for Ref pin (from 0 to 100)
davide.aliprandi@st.com 3:b0128df93d26 77 #define STSPIN240_250_CONF_PARAM_DC_PWM_REF (50)
davide.aliprandi@st.com 3:b0128df93d26 78
davide.aliprandi@st.com 3:b0128df93d26 79 /// Dual Bridge configuration (0 for mono, 1 for dual brush dc (STSPIN240 only)
davide.aliprandi@st.com 3:b0128df93d26 80 #define STSPIN240_250_CONF_PARAM_DUAL_BRIDGE_ENABLING (0)
davide.aliprandi@st.com 3:b0128df93d26 81
davide.aliprandi@st.com 3:b0128df93d26 82 /**
davide.aliprandi@st.com 3:b0128df93d26 83 * @}
davide.aliprandi@st.com 3:b0128df93d26 84 */
davide.aliprandi@st.com 3:b0128df93d26 85
davide.aliprandi@st.com 3:b0128df93d26 86 /**
davide.aliprandi@st.com 3:b0128df93d26 87 * @}
davide.aliprandi@st.com 3:b0128df93d26 88 */
davide.aliprandi@st.com 3:b0128df93d26 89
davide.aliprandi@st.com 3:b0128df93d26 90 /**
davide.aliprandi@st.com 3:b0128df93d26 91 * @}
davide.aliprandi@st.com 3:b0128df93d26 92 */
davide.aliprandi@st.com 3:b0128df93d26 93
davide.aliprandi@st.com 3:b0128df93d26 94 #ifdef __cplusplus
davide.aliprandi@st.com 3:b0128df93d26 95 }
davide.aliprandi@st.com 3:b0128df93d26 96 #endif
davide.aliprandi@st.com 3:b0128df93d26 97
davide.aliprandi@st.com 3:b0128df93d26 98 #endif /* __STSPIN240_250_CONFIG_H */
davide.aliprandi@st.com 3:b0128df93d26 99
davide.aliprandi@st.com 3:b0128df93d26 100 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/