dcmotor24  2.1.0.0
Main Page

DC Motor 24 click

DC Motor 24 Click is a compact add-on board with a brushed DC motor driver. This board features the L9958, an SPI-controlled H-bridge from STMicroelectronics. The L9958 is rated for an operating voltage range from 4V to 28V, with direct PWM motor control and current regulation threshold set by the SPI interface from 2.5A to 8.6A. It also has complete diagnostic and protection capabilities supporting the robust and reliable operation.

click Product page


Click library

  • Author : Stefan Filipovic
  • Date : Jan 2023.
  • Type : SPI/PWM type

Software Support

We provide a library for the DC Motor 24 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 DC Motor 24 Click driver.

Standard key functions :

Example key functions :

Example Description

This example demonstrates the use of the DC Motor 24 Click board by driving the motor in both directions at different speeds.

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;
dcmotor24_cfg_t dcmotor24_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
dcmotor24_cfg_setup( &dcmotor24_cfg );
DCMOTOR24_MAP_MIKROBUS( dcmotor24_cfg, MIKROBUS_1 );
if ( SPI_MASTER_ERROR == dcmotor24_init( &dcmotor24, &dcmotor24_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( DCMOTOR24_ERROR == dcmotor24_default_cfg ( &dcmotor24 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}

Application Task

Controls the motor speed by changing the PWM duty cycle every 500ms.

The duty cycle ranges from 0% to 100%. At the minimal speed, the motor switches direction. It also reads and parses the diagnostics word register. Each step will be logged on the USB UART where you can track the program flow.

void application_task ( void )
{
static int8_t duty_pct = 10;
static int8_t duty_step = 10;
uint16_t diag;
if ( DCMOTOR24_OK == dcmotor24_set_duty_cycle ( &dcmotor24, ( float ) duty_pct / 100 ) )
{
log_printf( &logger, "\r\n Duty: %u%%\r\n", ( uint16_t ) duty_pct );
}
if ( DCMOTOR24_OK == dcmotor24_read_diag ( &dcmotor24, &diag ) )
{
dcmotor24_display_diag ( diag );
}
Delay_ms( 500 );
if ( ( 100 == duty_pct ) || ( 0 == duty_pct ) )
{
duty_step = -duty_step;
if ( 0 == duty_pct )
{
log_printf( &logger, "\r\n Switch direction\r\n" );
Delay_ms ( 500 );
}
}
duty_pct += duty_step;
}

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.DCMotor24

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.


dcmotor24_read_diag
err_t dcmotor24_read_diag(dcmotor24_t *ctx, uint16_t *diag)
DC Motor 24 read diag function.
dcmotor24_cfg_setup
void dcmotor24_cfg_setup(dcmotor24_cfg_t *cfg)
DC Motor 24 configuration object setup function.
dcmotor24_init
err_t dcmotor24_init(dcmotor24_t *ctx, dcmotor24_cfg_t *cfg)
DC Motor 24 initialization function.
DCMOTOR24_MAP_MIKROBUS
#define DCMOTOR24_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: dcmotor24.h:141
application_task
void application_task(void)
Definition: main.c:76
dcmotor24_set_duty_cycle
err_t dcmotor24_set_duty_cycle(dcmotor24_t *ctx, float duty_cycle)
DC Motor 24 sets PWM duty cycle.
dcmotor24_switch_direction
void dcmotor24_switch_direction(dcmotor24_t *ctx)
DC Motor 24 switch direction function.
dcmotor24_t
DC Motor 24 Click context object.
Definition: dcmotor24.h:158
application_init
void application_init(void)
Definition: main.c:40
DCMOTOR24_OK
@ DCMOTOR24_OK
Definition: dcmotor24.h:205
DCMOTOR24_ERROR
@ DCMOTOR24_ERROR
Definition: dcmotor24.h:206
dcmotor24_cfg_t
DC Motor 24 Click configuration object.
Definition: dcmotor24.h:179
dcmotor24_default_cfg
err_t dcmotor24_default_cfg(dcmotor24_t *ctx)
DC Motor 24 default configuration function.