Library to handle the X-NUCLEO-IHM06A1 Motor Control Expansion Board based on the STSPIN220 component.

Dependencies:   ST_INTERFACES

Dependents:   HelloWorld_IHM06A1

Fork of X-NUCLEO-IHM06A1 by ST Expansion SW Team

Motor Control Library

Library to handle the X-NUCLEO-IHM06A1 Motor Control Expansion Board based on the STSPIN220 component.

It features the:

  • Read and write of the device parameters; GPIO, PWM and IRQ configuration; microstepping, direction position, speed, acceleration, deceleration and torque controls
  • Automatic full-step switch management; high impedance or hold stop mode selection; enable and standby management
  • Fault interrupts handling (over current, short-circuit and over temperature)
  • Command locking until the device completes movement

The API allows to easily:

  • perform various positioning, moves and stops
  • get/set or monitor the motor positions
  • set the home position and mark another position
  • get/set the minimum and maximum speed
  • get the current speed
  • get/set the acceleration and deceleration
  • get/set the stop mode (hold, hiz or standby)
  • get/set the torque
  • get/set the torque boost
  • get/set the step mode (up to 1/256)

Platform compatibility

Compatible platforms have been tested with the configurations provided by the HelloWorld_IHM06A1 example.

Committer:
davide.aliprandi@st.com
Date:
Fri Mar 24 10:59:19 2017 +0100
Revision:
3:a132aa6d66e4
Aligning to ARM mbed coding style.

Who changed what in which revision?

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