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:
Manu_L
Date:
Thu Apr 28 14:03:11 2016 +0000
Revision:
0:13bc901c90aa
X-NUCLEO-IHM12A1 (STSPIN240) Library creation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Manu_L 0:13bc901c90aa 1 /**************************************************************************//**
Manu_L 0:13bc901c90aa 2 * @file stspin240_250_target_config.h
Manu_L 0:13bc901c90aa 3 * @author IPC Rennes
Manu_L 0:13bc901c90aa 4 * @version V1.0.0
Manu_L 0:13bc901c90aa 5 * @date February 10, 2016
Manu_L 0:13bc901c90aa 6 * @brief Predefines values for the Stspin240 or Stspin250 parameters
Manu_L 0:13bc901c90aa 7 * and for the devices parameters
Manu_L 0:13bc901c90aa 8 * @note (C) COPYRIGHT 2016 STMicroelectronics
Manu_L 0:13bc901c90aa 9 ******************************************************************************
Manu_L 0:13bc901c90aa 10 * @attention
Manu_L 0:13bc901c90aa 11 *
Manu_L 0:13bc901c90aa 12 * <h2><center>&copy; 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 /* Define to prevent recursive inclusion -------------------------------------*/
Manu_L 0:13bc901c90aa 40 #ifndef __STSPIN240_250_TARGET_CONFIG_H
Manu_L 0:13bc901c90aa 41 #define __STSPIN240_250_TARGET_CONFIG_H
Manu_L 0:13bc901c90aa 42
Manu_L 0:13bc901c90aa 43 #ifdef __cplusplus
Manu_L 0:13bc901c90aa 44 extern "C" {
Manu_L 0:13bc901c90aa 45 #endif
Manu_L 0:13bc901c90aa 46
Manu_L 0:13bc901c90aa 47 /** @addtogroup STSPIN240_250
Manu_L 0:13bc901c90aa 48 * @{
Manu_L 0:13bc901c90aa 49 */
Manu_L 0:13bc901c90aa 50
Manu_L 0:13bc901c90aa 51 /** @addtogroup STSPIN240_250_Exported_Defines STSPIN240_250 Exported Defines
Manu_L 0:13bc901c90aa 52 * @{
Manu_L 0:13bc901c90aa 53 */
Manu_L 0:13bc901c90aa 54
Manu_L 0:13bc901c90aa 55 /** @defgroup Predefined_STSPIN240_250_Parameters_Values Predefined STSPIN240_250 Parameters Values
Manu_L 0:13bc901c90aa 56 * @{
Manu_L 0:13bc901c90aa 57 */
Manu_L 0:13bc901c90aa 58
Manu_L 0:13bc901c90aa 59 /// The maximum number of Stspin240 or Stspin250 devices
Manu_L 0:13bc901c90aa 60 #define MAX_NUMBER_OF_DEVICES (1)
Manu_L 0:13bc901c90aa 61
Manu_L 0:13bc901c90aa 62 /// The maximum number of Brush DC motors connected to the Stspin240 or Stspin250
Manu_L 0:13bc901c90aa 63 #define MAX_NUMBER_OF_BRUSH_DC_MOTORS (2)
Manu_L 0:13bc901c90aa 64
Manu_L 0:13bc901c90aa 65 /// Frequency of PWM of Input Bridge A in Hz up to 100000Hz
Manu_L 0:13bc901c90aa 66 #define STSPIN240_250_CONF_PARAM_FREQ_PWM_A (20000)
Manu_L 0:13bc901c90aa 67
Manu_L 0:13bc901c90aa 68 /// Frequency of PWM of Input Bridge B in Hz up to 100000Hz
Manu_L 0:13bc901c90aa 69 /// On the X-NUCLEO-IHM01A12 expansion board the PWM_A and PWM_B
Manu_L 0:13bc901c90aa 70 /// share the same timer, so the frequency must be the same
Manu_L 0:13bc901c90aa 71 #define STSPIN240_250_CONF_PARAM_FREQ_PWM_B (20000)
Manu_L 0:13bc901c90aa 72
Manu_L 0:13bc901c90aa 73 /// Frequency of PWM used for Ref pinin Hz up to 100000Hz
Manu_L 0:13bc901c90aa 74 #define STSPIN240_250_CONF_PARAM_FREQ_PWM_REF (20000)
Manu_L 0:13bc901c90aa 75
Manu_L 0:13bc901c90aa 76 /// Duty cycle of PWM used for Ref pin (from 0 to 100)
Manu_L 0:13bc901c90aa 77 #define STSPIN240_250_CONF_PARAM_DC_PWM_REF (50)
Manu_L 0:13bc901c90aa 78
Manu_L 0:13bc901c90aa 79 /// Dual Bridge configuration (0 for mono, 1 for dual brush dc (STSPIN240 only)
Manu_L 0:13bc901c90aa 80 #define STSPIN240_250_CONF_PARAM_DUAL_BRIDGE_ENABLING (0)
Manu_L 0:13bc901c90aa 81
Manu_L 0:13bc901c90aa 82 /**
Manu_L 0:13bc901c90aa 83 * @}
Manu_L 0:13bc901c90aa 84 */
Manu_L 0:13bc901c90aa 85
Manu_L 0:13bc901c90aa 86 /**
Manu_L 0:13bc901c90aa 87 * @}
Manu_L 0:13bc901c90aa 88 */
Manu_L 0:13bc901c90aa 89
Manu_L 0:13bc901c90aa 90 /**
Manu_L 0:13bc901c90aa 91 * @}
Manu_L 0:13bc901c90aa 92 */
Manu_L 0:13bc901c90aa 93
Manu_L 0:13bc901c90aa 94 #ifdef __cplusplus
Manu_L 0:13bc901c90aa 95 }
Manu_L 0:13bc901c90aa 96 #endif
Manu_L 0:13bc901c90aa 97
Manu_L 0:13bc901c90aa 98 #endif /* __STSPIN240_250_TARGET_CONFIG_H */
Manu_L 0:13bc901c90aa 99
Manu_L 0:13bc901c90aa 100 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/