Skip to content

Latest commit

 

History

History
156 lines (121 loc) · 5.46 KB

README.md

File metadata and controls

156 lines (121 loc) · 5.46 KB

Silent Step 4 Click

Silent Step 4 Click demo application is developed using the NECTO Studio, ensuring compatibility with mikroSDK's open-source libraries and tools. Designed for plug-and-play implementation and testing, the demo is fully compatible with all development, starter, and mikromedia boards featuring a mikroBUS™ socket.

Click Library

  • Author : Stefan Filipovic
  • Date : Oct 2023.
  • Type : I2C/SPI type

Software Support

Example Description

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

Example Libraries

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.SilentStep4

Example Key Functions

  • silentstep4_cfg_setup Config Object Initialization function.
void silentstep4_cfg_setup ( silentstep4_cfg_t *cfg );
  • silentstep4_init Initialization function.
err_t silentstep4_init ( silentstep4_t *ctx, silentstep4_cfg_t *cfg );
  • silentstep4_default_cfg Click Default Configuration function.
err_t silentstep4_default_cfg ( silentstep4_t *ctx );
  • silentstep4_set_direction This function sets the motor direction by setting the DIR pin logic state.
void silentstep4_set_direction ( silentstep4_t *ctx, uint8_t dir );
  • silentstep4_set_step_res This function sets the microstep resolution bits in CHOPCONF register.
err_t silentstep4_set_step_res ( silentstep4_t *ctx, uint8_t mres );
  • silentstep4_drive_motor This function drives the motor for the specific number of steps at the selected speed.
void silentstep4_drive_motor ( silentstep4_t *ctx, uint32_t steps, uint8_t speed );

Application Init

Initializes the driver and performs the Click default configuration.

void application_init ( void )
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    silentstep4_cfg_t silentstep4_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.
    silentstep4_cfg_setup( &silentstep4_cfg );
    SILENTSTEP4_MAP_MIKROBUS( silentstep4_cfg, MIKROBUS_1 );
    err_t init_flag = silentstep4_init( &silentstep4, &silentstep4_cfg );
    if ( ( I2C_MASTER_ERROR == init_flag ) || ( SPI_MASTER_ERROR == init_flag ) )
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    
    if ( SILENTSTEP4_ERROR == silentstep4_default_cfg ( &silentstep4 ) )
    {
        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" );
    silentstep4_set_direction ( &silentstep4, SILENTSTEP4_DIR_CW );
    silentstep4_set_step_res ( &silentstep4, SILENTSTEP4_MRES_FULLSTEP );
    silentstep4_drive_motor ( &silentstep4, 200, SILENTSTEP4_SPEED_SLOW );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );

    log_printf ( &logger, " Move 200 half steps counter-clockwise, speed: medium\r\n\n" );
    silentstep4_set_direction ( &silentstep4, SILENTSTEP4_DIR_CCW );
    silentstep4_set_step_res ( &silentstep4, SILENTSTEP4_MRES_2 );
    silentstep4_drive_motor ( &silentstep4, 200, SILENTSTEP4_SPEED_MEDIUM );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );

    log_printf ( &logger, " Move 400 quarter steps counter-clockwise, speed: fast\r\n\n" );
    silentstep4_set_direction ( &silentstep4, SILENTSTEP4_DIR_CCW );
    silentstep4_set_step_res ( &silentstep4, SILENTSTEP4_MRES_4 );
    silentstep4_drive_motor ( &silentstep4, 400, SILENTSTEP4_SPEED_FAST );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
}

Application Output

This Click board can be interfaced and monitored in two ways:

  • Application Output - Use the "Application Output" window in Debug mode for real-time data monitoring. Set it up properly by following this tutorial.
  • UART Terminal - Monitor data via the UART Terminal using a USB to UART converter. For detailed instructions, check out this tutorial.

Additional Notes and Information

The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.