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 ******************************************************************************
Manu_L 0:13bc901c90aa 3 * @file Component_class.h
Manu_L 0:13bc901c90aa 4 * @author AST
Manu_L 0:13bc901c90aa 5 * @version V1.0.0
Manu_L 0:13bc901c90aa 6 * @date April 13th, 2015
Manu_L 0:13bc901c90aa 7 * @brief This file contains the abstract class describing the interface of a
Manu_L 0:13bc901c90aa 8 * generic component.
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) 2015 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 recursive inclusion -------------------------------------*/
Manu_L 0:13bc901c90aa 41
Manu_L 0:13bc901c90aa 42 #ifndef __COMPONENT_CLASS_H
Manu_L 0:13bc901c90aa 43 #define __COMPONENT_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 <stdint.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 Generic components.
Manu_L 0:13bc901c90aa 54 */
Manu_L 0:13bc901c90aa 55 class Component
Manu_L 0:13bc901c90aa 56 {
Manu_L 0:13bc901c90aa 57 public:
Manu_L 0:13bc901c90aa 58 /**
Manu_L 0:13bc901c90aa 59 * @brief Initializing the component.
Manu_L 0:13bc901c90aa 60 * @param[in] init pointer to device specific initalization structure.
Manu_L 0:13bc901c90aa 61 * @retval "0" in case of success, an error code otherwise.
Manu_L 0:13bc901c90aa 62 */
Manu_L 0:13bc901c90aa 63 virtual int Init(void *init) = 0;
Manu_L 0:13bc901c90aa 64
Manu_L 0:13bc901c90aa 65 /**
Manu_L 0:13bc901c90aa 66 * @brief Getting the ID of the component.
Manu_L 0:13bc901c90aa 67 * @param[out] id pointer to an allocated variable to store the ID into.
Manu_L 0:13bc901c90aa 68 * @retval "0" in case of success, an error code otherwise.
Manu_L 0:13bc901c90aa 69 */
Manu_L 0:13bc901c90aa 70 virtual int ReadID(uint8_t *id) = 0;
Manu_L 0:13bc901c90aa 71 };
Manu_L 0:13bc901c90aa 72
Manu_L 0:13bc901c90aa 73 #endif /* __COMPONENT_CLASS_H */
Manu_L 0:13bc901c90aa 74
Manu_L 0:13bc901c90aa 75 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/