Skip to content

Latest commit

 

History

History
164 lines (120 loc) · 5.36 KB

README.md

File metadata and controls

164 lines (120 loc) · 5.36 KB
Raw

\mainpage Main Page

Stepper 17 Click

Stepper 17 Click is a compact add-on board that contains a bipolar stepper motor driver. This board features the TB67S539FTG, a two-phase bipolar stepping motor driver using a PWM chopper from Toshiba Semiconductor.

Click Product page

Click library

  • Author : Stefan Filipovic
  • Date : Jun 2023.
  • Type : I2C type

Software Support

We provide a library for the Stepper 17 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 17 Click driver.

Standard key functions :

  • stepper17_cfg_setup Config Object Initialization function.
void stepper17_cfg_setup ( stepper17_cfg_t *cfg );
  • stepper17_init Initialization function.
err_t stepper17_init ( stepper17_t *ctx, stepper17_cfg_t *cfg );
  • stepper17_default_cfg Click Default Configuration function.
err_t stepper17_default_cfg ( stepper17_t *ctx );

Example key functions :

  • stepper17_set_direction This function sets the motor direction by setting the DIR pin logic state.
void stepper17_set_direction ( stepper17_t *ctx, uint8_t dir );
  • stepper17_drive_motor This function drives the motor for the specific number of steps at the selected speed.
void stepper17_drive_motor ( stepper17_t *ctx, uint32_t steps, uint8_t speed );
  • stepper17_set_step_mode This function sets the step mode resolution settings.
err_t stepper17_set_step_mode ( stepper17_t *ctx, uint8_t mode );

Example Description

This example demonstrates the use of the Stepper 17 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. */
    stepper17_cfg_t stepper17_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.
    stepper17_cfg_setup( &stepper17_cfg );
    STEPPER17_MAP_MIKROBUS( stepper17_cfg, MIKROBUS_1 );
    if ( I2C_MASTER_ERROR == stepper17_init( &stepper17, &stepper17_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    
    if ( STEPPER17_ERROR == stepper17_default_cfg ( &stepper17 ) )
    {
        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 400 quarter steps with 2 seconds delay before changing the direction. 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 \r\n\n" );
    stepper17_set_step_mode ( &stepper17, STEPPER17_MODE_FULL_STEP );
    stepper17_set_direction ( &stepper17, STEPPER17_DIR_CW );
    stepper17_drive_motor ( &stepper17, 200, STEPPER17_SPEED_FAST );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    
    log_printf ( &logger, " Move 400 quarter steps counter-clockwise \r\n\n" );
    stepper17_set_step_mode ( &stepper17, STEPPER17_MODE_QUARTER_STEP );
    stepper17_set_direction ( &stepper17, STEPPER17_DIR_CCW );
    stepper17_drive_motor ( &stepper17, 400, STEPPER17_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.Stepper17

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.