dcmotor3

\mainpage Main Page

---

DC Motor 3 Click

DC MOTOR 3 Click is a mikroBUS™ add-on board with a Toshiba TB6549FG full-bridge driver for direct current motors. The IC is capable of outputting currents of up to 3.5 A with 30V, making it suitable for high-power motors

Click Product page

---

Click library

• Author : Nikola Peric
• Date : Feb 2022.
• Type : PWM type

Software Support

We provide a library for the DcMotor3 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 form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for DcMotor3 Click driver.

Standard key functions :

• Config Object Initialization function.

void dcmotor3_cfg_setup ( dcmotor3_cfg_t *cfg );

• Initialization function.

DCMOTOR3_RETVAL dcmotor3_init ( dcmotor3_t *ctx, dcmotor3_cfg_t *cfg );

• Click Default Configuration function.

void dcmotor3_default_cfg ( dcmotor3_t *ctx );

Example key functions :

• This function set the direction of rotation in the clockwise direction by sets AN pin and clear RST pin.

void dcmotor3_clockwise ( dcmotor3_t *ctx );

• This function set the direction of rotation in the counter clockwise direction by clear AN pin and sets RST pin.

void dcmotor3_counter_clockwise ( dcmotor3_t *ctx );

• This function brake the engine by sets AN and RST pins on DC Motor 3 Click board.

void dcmotor3_short_brake ( dcmotor3_t *ctx );

Examples Description

This Click has four operating modes: clockwise, counter-clockwise, short brake and stop. The operating mode is configured through IN1 and IN2 pins.

The demo application is composed of two sections :

Application Init

Initialization driver enable's - GPIO, PWM initialization, set PWM duty cycle and PWM frequency, start PWM, enable the engine, and start write log.

void application_init ( void )
{
    log_cfg_t log_cfg;
    dcmotor3_cfg_t cfg;

    /** 
     * 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.

    dcmotor3_cfg_setup( &cfg );
    DCMOTOR3_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    dcmotor3_init( &dcmotor3, &cfg );

    dcmotor3_set_duty_cycle ( &dcmotor3, 0.0 );
    dcmotor3_pwm_start( &dcmotor3 );
    Delay_ms ( 1000 );
    dcmotor3_enable( &dcmotor3 );
    Delay_ms ( 1000 );
    log_info( &logger, "---- Application Task ----" );
}
  

Application Task

This is a example which demonstrates the use of DC Motor 3 Click board. DC Motor 3 Click communicates with register via PWM interface. It shows moving in the left direction from slow to fast speed and from fast to slow speed. Results are being sent to the Usart Terminal where you can track their changes.

void application_task ( void )
{    
    static int8_t duty_cnt = 1;
    static int8_t duty_inc = 1;
    float duty = duty_cnt / 10.0;

    if ( dcmotor3_direction == 1 )
    {
        dcmotor3_clockwise( &dcmotor3 );
        log_printf( &logger, ">>>> CLOCKWISE " );
        dcmotor3_enable ( &dcmotor3 );
    }
    else
    {
        dcmotor3_counter_clockwise( &dcmotor3 );
        log_printf( &logger, "<<<< COUNTER CLOCKWISE " );
        dcmotor3_enable ( &dcmotor3 );
    }

    dcmotor3_set_duty_cycle ( &dcmotor3, duty );
    log_printf( &logger, "Duty: %d%%\r\n", ( uint16_t )( duty_cnt * 10 ) );
    Delay_ms ( 500 );

    if ( 10 == duty_cnt ) 
    {
        duty_inc = -1;
    }
    else if ( 0 == duty_cnt ) 
    {
        duty_inc = 1;
                
        if ( dcmotor3_direction == 1 )
        {
            dcmotor3_direction = 0;
        }
        else if ( dcmotor3_direction == 0 )
        {
            dcmotor3_direction = 1;
        }
    }
    duty_cnt += duty_inc;
} 

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

• MikroSDK.Board
• MikroSDK.Log
• Click.DcMotor3

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. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.

---