stepper5  2.1.0.0
Main Page

Stepper 5 Click

Stepper 5 Click is the complete integrated bipolar step motor driver solution, rich with many features that allow silent operation and optimal working conditions for the connected motor. The specialized TMC2208 IC driver from Trinamic company far exceeds the capabilities of similar step motor drivers that are commonly used. In order to achieve such outstanding performances with a wide range of various step motors, this device features several technologies: stealth Chop2™ - for silent motor operation; spreadCycle™ - highly dynamic, motor current control; microPlayer™ interpolation with 256 microsteps.

Click Product page


Click library

  • Author : Stefan Filipovic
  • Date : Feb 2024.
  • Type : UART type

Software Support

We provide a library for the Stepper 5 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for Stepper 5 Click driver.

Standard key functions :

Example key functions :

  • stepper5_set_direction This function sets the motor direction by setting the DIR pin logic state.
    void stepper5_set_direction ( stepper5_t *ctx, uint8_t dir );
  • stepper5_set_step_res This function sets the microstep resolution bits in CHOPCONF register.
    err_t stepper5_set_step_res ( stepper5_t *ctx, uint8_t mres );
  • stepper5_drive_motor This function drives the motor for the specific number of steps at the selected speed.
    void stepper5_drive_motor ( stepper5_t *ctx, uint32_t steps, uint8_t speed );

Example Description

This example demonstrates the use of the Stepper 5 Click board by driving the motor in both directions for a desired number of steps.

The demo application is composed of two sections :

Application Init

Initializes the driver and performs the Click default configuration.

void application_init ( void )
{
log_cfg_t log_cfg;
stepper5_cfg_t stepper5_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
stepper5_cfg_setup( &stepper5_cfg );
STEPPER5_MAP_MIKROBUS( stepper5_cfg, MIKROBUS_1 );
if ( UART_ERROR == stepper5_init( &stepper5, &stepper5_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( STEPPER5_ERROR == stepper5_default_cfg ( &stepper5 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}

Application Task

Drives the motor clockwise for 200 full steps and then counter-clockiwse for 200 half

steps and 400 quarter steps with 2 seconds delay on driving mode change. All data is being logged on the USB UART where you can track the program flow.

void application_task ( void )
{
log_printf ( &logger, " Move 200 full steps clockwise, speed: slow\r\n\n" );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
log_printf ( &logger, " Move 200 half steps counter-clockwise, speed: medium\r\n\n" );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
log_printf ( &logger, " Move 400 quarter steps counter-clockwise, speed: fast\r\n\n" );
Delay_ms ( 1000 );
Delay_ms ( 1000 );
}

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Stepper5

Additional notes and informations

Depending on the development board you are using, you may need USB UART Click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. UART terminal is available in all MikroElektronika compilers.


stepper5_set_step_res
err_t stepper5_set_step_res(stepper5_t *ctx, uint8_t mres)
Stepper 5 set step res function.
STEPPER5_SPEED_SLOW
#define STEPPER5_SPEED_SLOW
Definition: stepper5.h:133
STEPPER5_MRES_2
#define STEPPER5_MRES_2
Definition: stepper5.h:186
stepper5_cfg_setup
void stepper5_cfg_setup(stepper5_cfg_t *cfg)
Stepper 5 configuration object setup function.
STEPPER5_MAP_MIKROBUS
#define STEPPER5_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: stepper5.h:231
STEPPER5_ERROR
@ STEPPER5_ERROR
Definition: stepper5.h:300
stepper5_cfg_t
Stepper 5 Click configuration object.
Definition: stepper5.h:272
stepper5_set_direction
void stepper5_set_direction(stepper5_t *ctx, uint8_t dir)
Stepper 5 set direction function.
STEPPER5_MRES_4
#define STEPPER5_MRES_4
Definition: stepper5.h:185
application_task
void application_task(void)
Definition: main.c:66
STEPPER5_DIR_CCW
#define STEPPER5_DIR_CCW
Definition: stepper5.h:119
STEPPER5_MRES_FULLSTEP
#define STEPPER5_MRES_FULLSTEP
Definition: stepper5.h:187
stepper5_t
Stepper 5 Click context object.
Definition: stepper5.h:248
stepper5_init
err_t stepper5_init(stepper5_t *ctx, stepper5_cfg_t *cfg)
Stepper 5 initialization function.
stepper5_drive_motor
void stepper5_drive_motor(stepper5_t *ctx, uint32_t steps, uint8_t speed)
Stepper 5 driver motor function.
stepper5_default_cfg
err_t stepper5_default_cfg(stepper5_t *ctx)
Stepper 5 default configuration function.
STEPPER5_SPEED_FAST
#define STEPPER5_SPEED_FAST
Definition: stepper5.h:135
STEPPER5_SPEED_MEDIUM
#define STEPPER5_SPEED_MEDIUM
Definition: stepper5.h:134
STEPPER5_DIR_CW
#define STEPPER5_DIR_CW
Stepper 5 direction setting.
Definition: stepper5.h:118
application_init
void application_init(void)
Definition: main.c:30