silentstep3

\mainpage Main Page

---

Silent Step 3 Click

Silent Step 3 Click is the complete integrated bipolar step motor driver solution, rich with many features that allow extremely smooth and silent operation of the connected motor while being able to provide up to 4A peak motor current and withstand up to 30V supply voltage. The specialized TMC2660 IC driver from Trinamic company far exceeds the capabilities of similar step motor drivers that are commonly used.

Click Product page

---

Click library

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

Software Support

We provide a library for the Silent Step 3 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 Silent Step 3 Click driver.

Standard key functions :

• silentstep3_cfg_setup Config Object Initialization function.

void silentstep3_cfg_setup ( silentstep3_cfg_t *cfg );

• silentstep3_init Initialization function.

err_t silentstep3_init ( silentstep3_t *ctx, silentstep3_cfg_t *cfg );

• silentstep3_default_cfg Click Default Configuration function.

err_t silentstep3_default_cfg ( silentstep3_t *ctx );

Example key functions :

• silentstep3_set_step_mode This function sets the microstep resolution bits in DRVCTRL register.

err_t silentstep3_set_step_mode ( silentstep3_t *ctx, uint8_t mode );

• silentstep3_set_direction This function sets the motor direction by setting the DIR pin logic state.

void silentstep3_set_direction ( silentstep3_t *ctx, uint8_t dir );

• silentstep3_drive_motor This function drives the motor for the specific number of steps at the selected speed.

void silentstep3_drive_motor ( silentstep3_t *ctx, uint32_t steps, uint8_t speed );

Example Description

This example demonstrates the use of the Silent Step 3 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;  /**< Logger config object. */
    silentstep3_cfg_t silentstep3_cfg;  /**< Click config object. */

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, " Application Init " );

    // Click initialization.
    silentstep3_cfg_setup( &silentstep3_cfg );
    SILENTSTEP3_MAP_MIKROBUS( silentstep3_cfg, MIKROBUS_1 );
    if ( SPI_MASTER_ERROR == silentstep3_init( &silentstep3, &silentstep3_cfg ) )
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    
    if ( SILENTSTEP3_ERROR == silentstep3_default_cfg ( &silentstep3 ) )
    {
        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" );
    silentstep3_set_direction ( &silentstep3, SILENTSTEP3_DIR_CW );
    silentstep3_set_step_mode ( &silentstep3, SILENTSTEP3_MODE_FULL_STEP );
    silentstep3_drive_motor ( &silentstep3, 200, SILENTSTEP3_SPEED_SLOW );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );

    log_printf ( &logger, " Move 200 half steps counter-clockwise, speed: medium\r\n\n" );
    silentstep3_set_direction ( &silentstep3, SILENTSTEP3_DIR_CCW );
    silentstep3_set_step_mode ( &silentstep3, SILENTSTEP3_MODE_HALF_STEP );
    silentstep3_drive_motor ( &silentstep3, 200, SILENTSTEP3_SPEED_MEDIUM );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );

    log_printf ( &logger, " Move 400 quarter steps counter-clockwise, speed: fast\r\n\n" );
    silentstep3_set_direction ( &silentstep3, SILENTSTEP3_DIR_CCW );
    silentstep3_set_step_mode ( &silentstep3, SILENTSTEP3_MODE_QUARTER_STEP );
    silentstep3_drive_motor ( &silentstep3, 400, SILENTSTEP3_SPEED_FAST );
    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.SilentStep3

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.

---