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:
Thu Aug 03 16:32:32 2017 +0000
Revision:
6:d16ad1d58ea1
Parent:
4:24158c44f02e
Aligning to ARM mbed coding style.

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 ******************************************************************************
davide.aliprandi@st.com 4:24158c44f02e 3 * @file component_def.h
davide.aliprandi@st.com 4:24158c44f02e 4 * @author AST
davide.aliprandi@st.com 4:24158c44f02e 5 * @version V1.0.0
davide.aliprandi@st.com 4:24158c44f02e 6 * @date 1 April 2015
davide.aliprandi@st.com 4:24158c44f02e 7 * @brief Generic header file containing a generic component's definitions
davide.aliprandi@st.com 4:24158c44f02e 8 * and I/O functions.
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
davide.aliprandi@st.com 4:24158c44f02e 40 /* Define to prevent recursive inclusion -------------------------------------*/
davide.aliprandi@st.com 4:24158c44f02e 41
davide.aliprandi@st.com 4:24158c44f02e 42 #ifndef __COMPONENT_H
davide.aliprandi@st.com 4:24158c44f02e 43 #define __COMPONENT_H
davide.aliprandi@st.com 4:24158c44f02e 44
davide.aliprandi@st.com 4:24158c44f02e 45
davide.aliprandi@st.com 4:24158c44f02e 46 /* Types ---------------------------------------------------------------------*/
davide.aliprandi@st.com 4:24158c44f02e 47
davide.aliprandi@st.com 4:24158c44f02e 48 /**
davide.aliprandi@st.com 4:24158c44f02e 49 * @brief Component's Context structure definition.
davide.aliprandi@st.com 4:24158c44f02e 50 */
davide.aliprandi@st.com 4:24158c44f02e 51 typedef struct
davide.aliprandi@st.com 4:24158c44f02e 52 {
davide.aliprandi@st.com 4:24158c44f02e 53 /* Identity. */
davide.aliprandi@st.com 4:24158c44f02e 54 uint8_t who_am_i;
davide.aliprandi@st.com 4:24158c44f02e 55
davide.aliprandi@st.com 4:24158c44f02e 56 /* ACTION ----------------------------------------------------------------*/
davide.aliprandi@st.com 4:24158c44f02e 57 /* There should be only a unique identifier for each component, which */
davide.aliprandi@st.com 4:24158c44f02e 58 /* should be the "who_am_i" parameter, hence this parameter is optional. */
davide.aliprandi@st.com 4:24158c44f02e 59 /* -----------------------------------------------------------------------*/
davide.aliprandi@st.com 4:24158c44f02e 60 /* Type. */
davide.aliprandi@st.com 4:24158c44f02e 61 uint8_t type;
davide.aliprandi@st.com 4:24158c44f02e 62
davide.aliprandi@st.com 4:24158c44f02e 63 /* Configuration. */
davide.aliprandi@st.com 4:24158c44f02e 64 uint8_t address;
davide.aliprandi@st.com 4:24158c44f02e 65
davide.aliprandi@st.com 4:24158c44f02e 66 /* Pointer to the Data. */
davide.aliprandi@st.com 4:24158c44f02e 67 void *p_data;
davide.aliprandi@st.com 4:24158c44f02e 68
davide.aliprandi@st.com 4:24158c44f02e 69 /* Pointer to the Virtual Table. */
davide.aliprandi@st.com 4:24158c44f02e 70 void *p_vt;
davide.aliprandi@st.com 4:24158c44f02e 71
davide.aliprandi@st.com 4:24158c44f02e 72 /* ACTION ----------------------------------------------------------------*/
davide.aliprandi@st.com 4:24158c44f02e 73 /* There should be only a unique virtual table for each component, which */
davide.aliprandi@st.com 4:24158c44f02e 74 /* should be the "p_vt" parameter, hence this parameter is optional. */
davide.aliprandi@st.com 4:24158c44f02e 75 /* -----------------------------------------------------------------------*/
davide.aliprandi@st.com 4:24158c44f02e 76 /* Pointer to the Extended Virtual Table. */
davide.aliprandi@st.com 4:24158c44f02e 77 void *p_ext_vt;
davide.aliprandi@st.com 4:24158c44f02e 78 } handle_t;
davide.aliprandi@st.com 4:24158c44f02e 79
davide.aliprandi@st.com 4:24158c44f02e 80 /**
davide.aliprandi@st.com 4:24158c44f02e 81 * @brief Component's Status enumerator definition.
davide.aliprandi@st.com 4:24158c44f02e 82 */
davide.aliprandi@st.com 4:24158c44f02e 83 typedef enum
davide.aliprandi@st.com 4:24158c44f02e 84 {
davide.aliprandi@st.com 4:24158c44f02e 85 COMPONENT_OK = 0,
davide.aliprandi@st.com 4:24158c44f02e 86 COMPONENT_ERROR,
davide.aliprandi@st.com 4:24158c44f02e 87 COMPONENT_TIMEOUT,
davide.aliprandi@st.com 4:24158c44f02e 88 COMPONENT_NOT_IMPLEMENTED
davide.aliprandi@st.com 4:24158c44f02e 89 } status_t;
davide.aliprandi@st.com 4:24158c44f02e 90
davide.aliprandi@st.com 4:24158c44f02e 91 #endif /* __COMPONENT_H */
davide.aliprandi@st.com 4:24158c44f02e 92
davide.aliprandi@st.com 4:24158c44f02e 93 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/