Expansion SW library to control high power stepper motor(s) using IHM03A1 expansion board(s) with Powerstep01 driver.

Dependencies:   X_NUCLEO_COMMON ST_INTERFACES

Dependents:   IHM03A1_ExampleFor1Motor HelloWorld_IHM03A1 IHM03A1_ExampleFor3Motors KYPHOS_Stepper_Motor_Control

Fork of X_NUCLEO_IHM03A1 by ST Expansion SW Team

Motor Control Library

Library to handle the X-NUCLEO-IHM03A1 Motor Control Expansion Board based on the Powerstep01 component.

It features the:

  • read and write of Powerstep01 registers
  • Nucleo and expansion board configuration (GPIOs, PWMs, IRQs, etc.)
  • Powerstep01 application commands handling
  • FLAG and BUSY interrupt handling (alarm reporting)
  • Daisy chain handling

The API allows to easily:

  • perform various positioning, moves and stops
  • get/set or monitor the motor positions
  • set home position and mark another position
  • get/set minimum and maximum speed
  • get current speed
  • get/set acceleration and deceleration
  • get/set the step mode (up to 1/128)
  • get/set the control method
  • get/set parameters for voltage mode driving
  • get/set parameters for current mode driving
  • get/set parameters for gate driving
  • configure various protections such as overcurrent detection
  • enable/disable alarms
  • handle step-clock
  • get system status

Daisy-Chain Configuration

The IHM03A1 board can be stacked up to three times so that the Powerstep01 components will be connected in daisy-chain configuration. For this purpose, some resistors must be correctly connected on the boards as depicted here below:

/media/uploads/nucleosam/driving1steppermotor.png /media/uploads/nucleosam/driving2steppermotors.png /media/uploads/nucleosam/driving3steppermotors.png

Platform compatibility

Compatible platforms have been tested with the default configuration provided by the HelloWorld_IHM03A1 example.

Committer:
davide.aliprandi@st.com
Date:
Fri Mar 24 10:58:48 2017 +0100
Revision:
4:f48e8d87553e
Aligning to ARM mbed coding style.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
davide.aliprandi@st.com 4:f48e8d87553e 1 /**
davide.aliprandi@st.com 4:f48e8d87553e 2 ******************************************************************************
davide.aliprandi@st.com 4:f48e8d87553e 3 * @file component_def.h
davide.aliprandi@st.com 4:f48e8d87553e 4 * @author AST
davide.aliprandi@st.com 4:f48e8d87553e 5 * @version V1.0.0
davide.aliprandi@st.com 4:f48e8d87553e 6 * @date 1 April 2015
davide.aliprandi@st.com 4:f48e8d87553e 7 * @brief Generic header file containing a generic component's definitions
davide.aliprandi@st.com 4:f48e8d87553e 8 * and I/O functions.
davide.aliprandi@st.com 4:f48e8d87553e 9 ******************************************************************************
davide.aliprandi@st.com 4:f48e8d87553e 10 * @attention
davide.aliprandi@st.com 4:f48e8d87553e 11 *
davide.aliprandi@st.com 4:f48e8d87553e 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
davide.aliprandi@st.com 4:f48e8d87553e 13 *
davide.aliprandi@st.com 4:f48e8d87553e 14 * Redistribution and use in source and binary forms, with or without modification,
davide.aliprandi@st.com 4:f48e8d87553e 15 * are permitted provided that the following conditions are met:
davide.aliprandi@st.com 4:f48e8d87553e 16 * 1. Redistributions of source code must retain the above copyright notice,
davide.aliprandi@st.com 4:f48e8d87553e 17 * this list of conditions and the following disclaimer.
davide.aliprandi@st.com 4:f48e8d87553e 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
davide.aliprandi@st.com 4:f48e8d87553e 19 * this list of conditions and the following disclaimer in the documentation
davide.aliprandi@st.com 4:f48e8d87553e 20 * and/or other materials provided with the distribution.
davide.aliprandi@st.com 4:f48e8d87553e 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
davide.aliprandi@st.com 4:f48e8d87553e 22 * may be used to endorse or promote products derived from this software
davide.aliprandi@st.com 4:f48e8d87553e 23 * without specific prior written permission.
davide.aliprandi@st.com 4:f48e8d87553e 24 *
davide.aliprandi@st.com 4:f48e8d87553e 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
davide.aliprandi@st.com 4:f48e8d87553e 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
davide.aliprandi@st.com 4:f48e8d87553e 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
davide.aliprandi@st.com 4:f48e8d87553e 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
davide.aliprandi@st.com 4:f48e8d87553e 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
davide.aliprandi@st.com 4:f48e8d87553e 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
davide.aliprandi@st.com 4:f48e8d87553e 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
davide.aliprandi@st.com 4:f48e8d87553e 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
davide.aliprandi@st.com 4:f48e8d87553e 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
davide.aliprandi@st.com 4:f48e8d87553e 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
davide.aliprandi@st.com 4:f48e8d87553e 35 *
davide.aliprandi@st.com 4:f48e8d87553e 36 ******************************************************************************
davide.aliprandi@st.com 4:f48e8d87553e 37 */
davide.aliprandi@st.com 4:f48e8d87553e 38
davide.aliprandi@st.com 4:f48e8d87553e 39
davide.aliprandi@st.com 4:f48e8d87553e 40 /* Define to prevent recursive inclusion -------------------------------------*/
davide.aliprandi@st.com 4:f48e8d87553e 41
davide.aliprandi@st.com 4:f48e8d87553e 42 #ifndef __COMPONENT_H
davide.aliprandi@st.com 4:f48e8d87553e 43 #define __COMPONENT_H
davide.aliprandi@st.com 4:f48e8d87553e 44
davide.aliprandi@st.com 4:f48e8d87553e 45
davide.aliprandi@st.com 4:f48e8d87553e 46 /* Types ---------------------------------------------------------------------*/
davide.aliprandi@st.com 4:f48e8d87553e 47
davide.aliprandi@st.com 4:f48e8d87553e 48 /**
davide.aliprandi@st.com 4:f48e8d87553e 49 * @brief Component's Context structure definition.
davide.aliprandi@st.com 4:f48e8d87553e 50 */
davide.aliprandi@st.com 4:f48e8d87553e 51 typedef struct
davide.aliprandi@st.com 4:f48e8d87553e 52 {
davide.aliprandi@st.com 4:f48e8d87553e 53 /* Identity. */
davide.aliprandi@st.com 4:f48e8d87553e 54 uint8_t who_am_i;
davide.aliprandi@st.com 4:f48e8d87553e 55
davide.aliprandi@st.com 4:f48e8d87553e 56 /* ACTION ----------------------------------------------------------------*/
davide.aliprandi@st.com 4:f48e8d87553e 57 /* There should be only a unique identifier for each component, which */
davide.aliprandi@st.com 4:f48e8d87553e 58 /* should be the "who_am_i" parameter, hence this parameter is optional. */
davide.aliprandi@st.com 4:f48e8d87553e 59 /* -----------------------------------------------------------------------*/
davide.aliprandi@st.com 4:f48e8d87553e 60 /* Type. */
davide.aliprandi@st.com 4:f48e8d87553e 61 uint8_t type;
davide.aliprandi@st.com 4:f48e8d87553e 62
davide.aliprandi@st.com 4:f48e8d87553e 63 /* Configuration. */
davide.aliprandi@st.com 4:f48e8d87553e 64 uint8_t address;
davide.aliprandi@st.com 4:f48e8d87553e 65
davide.aliprandi@st.com 4:f48e8d87553e 66 /* Pointer to the Data. */
davide.aliprandi@st.com 4:f48e8d87553e 67 void *p_data;
davide.aliprandi@st.com 4:f48e8d87553e 68
davide.aliprandi@st.com 4:f48e8d87553e 69 /* Pointer to the Virtual Table. */
davide.aliprandi@st.com 4:f48e8d87553e 70 void *p_vt;
davide.aliprandi@st.com 4:f48e8d87553e 71
davide.aliprandi@st.com 4:f48e8d87553e 72 /* ACTION ----------------------------------------------------------------*/
davide.aliprandi@st.com 4:f48e8d87553e 73 /* There should be only a unique virtual table for each component, which */
davide.aliprandi@st.com 4:f48e8d87553e 74 /* should be the "p_vt" parameter, hence this parameter is optional. */
davide.aliprandi@st.com 4:f48e8d87553e 75 /* -----------------------------------------------------------------------*/
davide.aliprandi@st.com 4:f48e8d87553e 76 /* Pointer to the Extended Virtual Table. */
davide.aliprandi@st.com 4:f48e8d87553e 77 void *p_ext_vt;
davide.aliprandi@st.com 4:f48e8d87553e 78 } handle_t;
davide.aliprandi@st.com 4:f48e8d87553e 79
davide.aliprandi@st.com 4:f48e8d87553e 80 /**
davide.aliprandi@st.com 4:f48e8d87553e 81 * @brief Component's Status enumerator definition.
davide.aliprandi@st.com 4:f48e8d87553e 82 */
davide.aliprandi@st.com 4:f48e8d87553e 83 typedef enum
davide.aliprandi@st.com 4:f48e8d87553e 84 {
davide.aliprandi@st.com 4:f48e8d87553e 85 COMPONENT_OK = 0,
davide.aliprandi@st.com 4:f48e8d87553e 86 COMPONENT_ERROR,
davide.aliprandi@st.com 4:f48e8d87553e 87 COMPONENT_TIMEOUT,
davide.aliprandi@st.com 4:f48e8d87553e 88 COMPONENT_NOT_IMPLEMENTED
davide.aliprandi@st.com 4:f48e8d87553e 89 } status_t;
davide.aliprandi@st.com 4:f48e8d87553e 90
davide.aliprandi@st.com 4:f48e8d87553e 91 #endif /* __COMPONENT_H */
davide.aliprandi@st.com 4:f48e8d87553e 92
davide.aliprandi@st.com 4:f48e8d87553e 93 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/