Library used to control ST Nucleo Evaluation board IHM04A1, based on L6206 motor control driver.

Dependencies:   ST_INTERFACES

Dependents:   HelloWorld_IHM04A1 RoboCane_Motore arm_dcmotor_can arm_linear_can_2 ... more

Fork of X_NUCLEO_IHM04A1 by ST Expansion SW Team

Motor Control Library

Library to handle the X-NUCLEO-IHM04A1 Motor Control Expansion Board based on the L6206 component.

It allows a complete management of the L6206 by providing a complete APIs.

The key features of the library are :

  • Configuration of the L6206 (bridges inputs and enabling signals, bridges paralleling)
  • FLAG interrupts handling (overcurrent and thermal alarms reporting)
  • Handling of up to two bidirectional Brush DC motors or up to 4 unidirectional Brush DC motors depending of the bridges paralleling configuration
  • Nucleo and expansion board configuration (GPIOs, PWMs, IRQs…)

To use the L6206 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 “l6206_target_config.h”, in order to program the PWMs frequency of the bridges inputs, the bridges paralleling configuration, the number and the type (bidirectional or unidirectional) of brush DC motors.

Once the initialization is done, the user can modify the driver parameters by calling specific functions to change the bridges paralleling configuration, types and 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-IHM04A1 expansion board with the NUCLEO-F429ZI requires adopting the following patch:

  • to connect with a wire the PB_4 Nucleo pin to the IN1A expansion board pin;
  • to connect with a wire the PC_7 Nucleo pin to the IN2A expansion board pin;
  • to connect with a wire the PA_15 Nucleo pin to the IN1B expansion board pin;
  • to connect with a wire the PB_3 Nucleo pin to the IN2B expansion board pin.


Board configuration for HelloWorld_IHM04A1 example

/media/uploads/brdirais/drive4brushdcmotor_ihm04a1.png

Committer:
Davidroid
Date:
Fri Mar 24 13:08:23 2017 +0000
Revision:
5:51ad3c4b904c
Parent:
Components/l6206/L6206_config.h@4:24158c44f02e
Typos corrected.

Who changed what in which revision?

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