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:
nucleosam
Date:
Thu May 26 15:44:53 2016 +0000
Revision:
0:0ccd34c56c66
Initial version.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nucleosam 0:0ccd34c56c66 1 /**
nucleosam 0:0ccd34c56c66 2 ******************************************************************************
nucleosam 0:0ccd34c56c66 3 * @file Component_class.h
nucleosam 0:0ccd34c56c66 4 * @author AST
nucleosam 0:0ccd34c56c66 5 * @version V1.0.0
nucleosam 0:0ccd34c56c66 6 * @date April 13th, 2015
nucleosam 0:0ccd34c56c66 7 * @brief This file contains the abstract class describing the interface of a
nucleosam 0:0ccd34c56c66 8 * generic component.
nucleosam 0:0ccd34c56c66 9 ******************************************************************************
nucleosam 0:0ccd34c56c66 10 * @attention
nucleosam 0:0ccd34c56c66 11 *
nucleosam 0:0ccd34c56c66 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
nucleosam 0:0ccd34c56c66 13 *
nucleosam 0:0ccd34c56c66 14 * Redistribution and use in source and binary forms, with or without modification,
nucleosam 0:0ccd34c56c66 15 * are permitted provided that the following conditions are met:
nucleosam 0:0ccd34c56c66 16 * 1. Redistributions of source code must retain the above copyright notice,
nucleosam 0:0ccd34c56c66 17 * this list of conditions and the following disclaimer.
nucleosam 0:0ccd34c56c66 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
nucleosam 0:0ccd34c56c66 19 * this list of conditions and the following disclaimer in the documentation
nucleosam 0:0ccd34c56c66 20 * and/or other materials provided with the distribution.
nucleosam 0:0ccd34c56c66 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
nucleosam 0:0ccd34c56c66 22 * may be used to endorse or promote products derived from this software
nucleosam 0:0ccd34c56c66 23 * without specific prior written permission.
nucleosam 0:0ccd34c56c66 24 *
nucleosam 0:0ccd34c56c66 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
nucleosam 0:0ccd34c56c66 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
nucleosam 0:0ccd34c56c66 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
nucleosam 0:0ccd34c56c66 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
nucleosam 0:0ccd34c56c66 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
nucleosam 0:0ccd34c56c66 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
nucleosam 0:0ccd34c56c66 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
nucleosam 0:0ccd34c56c66 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
nucleosam 0:0ccd34c56c66 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
nucleosam 0:0ccd34c56c66 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
nucleosam 0:0ccd34c56c66 35 *
nucleosam 0:0ccd34c56c66 36 ******************************************************************************
nucleosam 0:0ccd34c56c66 37 */
nucleosam 0:0ccd34c56c66 38
nucleosam 0:0ccd34c56c66 39
nucleosam 0:0ccd34c56c66 40 /* Define to prevent recursive inclusion -------------------------------------*/
nucleosam 0:0ccd34c56c66 41
nucleosam 0:0ccd34c56c66 42 #ifndef __COMPONENT_CLASS_H
nucleosam 0:0ccd34c56c66 43 #define __COMPONENT_CLASS_H
nucleosam 0:0ccd34c56c66 44
nucleosam 0:0ccd34c56c66 45
nucleosam 0:0ccd34c56c66 46 /* Includes ------------------------------------------------------------------*/
nucleosam 0:0ccd34c56c66 47
nucleosam 0:0ccd34c56c66 48 #include <stdint.h>
nucleosam 0:0ccd34c56c66 49
nucleosam 0:0ccd34c56c66 50
nucleosam 0:0ccd34c56c66 51 /* Classes ------------------------------------------------------------------*/
nucleosam 0:0ccd34c56c66 52
nucleosam 0:0ccd34c56c66 53 /** An abstract class for Generic components.
nucleosam 0:0ccd34c56c66 54 */
nucleosam 0:0ccd34c56c66 55 class Component
nucleosam 0:0ccd34c56c66 56 {
nucleosam 0:0ccd34c56c66 57 public:
nucleosam 0:0ccd34c56c66 58 /**
nucleosam 0:0ccd34c56c66 59 * @brief Initializing the component.
nucleosam 0:0ccd34c56c66 60 * @param[in] init pointer to device specific initalization structure.
nucleosam 0:0ccd34c56c66 61 * @retval "0" in case of success, an error code otherwise.
nucleosam 0:0ccd34c56c66 62 */
nucleosam 0:0ccd34c56c66 63 virtual int Init(void *init) = 0;
nucleosam 0:0ccd34c56c66 64
nucleosam 0:0ccd34c56c66 65 /**
nucleosam 0:0ccd34c56c66 66 * @brief Getting the ID of the component.
nucleosam 0:0ccd34c56c66 67 * @param[out] id pointer to an allocated variable to store the ID into.
nucleosam 0:0ccd34c56c66 68 * @retval "0" in case of success, an error code otherwise.
nucleosam 0:0ccd34c56c66 69 */
nucleosam 0:0ccd34c56c66 70 virtual int ReadID(uint8_t *id) = 0;
nucleosam 0:0ccd34c56c66 71
nucleosam 0:0ccd34c56c66 72 /**
nucleosam 0:0ccd34c56c66 73 * @brief Getting the version of the firmware.
nucleosam 0:0ccd34c56c66 74 * @param None.
nucleosam 0:0ccd34c56c66 75 * @retval The version of the firmware.
nucleosam 0:0ccd34c56c66 76 */
nucleosam 0:0ccd34c56c66 77 virtual unsigned int GetFwVersion(void) = 0;
nucleosam 0:0ccd34c56c66 78
nucleosam 0:0ccd34c56c66 79 };
nucleosam 0:0ccd34c56c66 80
nucleosam 0:0ccd34c56c66 81 #endif /* __COMPONENT_CLASS_H */
nucleosam 0:0ccd34c56c66 82
nucleosam 0:0ccd34c56c66 83 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/