Control any common DC motor using Nucleo 64 with STM32G474RE MCU and STM32G474RE
What drives you these days?
Published Nov 08, 2024
Click board™
DC Motor 12 Click
Dev Board
Nucleo 64 with STM32G474RE MCU
Compiler
NECTO Studio
MCU
STM32G474RE
The ultimate DC motor driving solution
A
A
Hardware Overview
How does it work?
DC Motor 12 Click is based on the TB9054FTG, a dual-channel, H-bridge, brushed DC motor driver from Toshiba Semiconductor. The TB9054FTG allows a dual configuration with two motors with 5A current ratings per channel or one 10A channel drive in a Parallel mode of operation. It is also rated for an operating voltage range from 4.5V to 28V, with the motor controlled directly through an SPI serial interface or PWM signal from an unpopulated header. The PWM control with low on-resistance enables highly efficient motor drive output, ensuring reliable operation for highly competitive automotive applications. Besides the SPI communication, several GPIO pins connected to the mikroBUS™ socket pins are also used to control the TB9054FTG associated with the PCA9538A I2C-configurable port expander, such as Sleep Mode pin and DC motor channels current monitor routed to the RST and AN pins (SLP and CM) of the mikroBUS™ socket. The PCA9538A also allows choosing the least significant bit (LSB) of its I2C slave address by positioning SMD jumpers labeled as ADDR SEL
to an appropriate position marked as 0 and 1, alongside its interrupt feature routed to the INT pin of the mikroBUS™ socket. As mentioned, this Click board™ supports double or single DC motor configuration. The corresponding switches on the board marked with SW1-SW4 are used to select the motor control and operational modes. The first two represent the switches for motor control selection - more precisely, the choice of control directly by the PWM signal or through the SPI interface - while the second two represent the selection of the motor operational mode. There are four possible modes, i.e., Small mode (two independent channels), Large Mode (two channels are connected and support one DC motor), Half Mode, and Prohibited Mode, where the channels are completely disabled. The control and PWM signals can also be brought externally via the onboard header J1. In that case, the PWM1 and PWM2 pins specify forward, reverse, or brake modes for motor 1, and the PWM3 and PWM4 pins specify these modes for motor 2. The enable EN pins select the drive or stop mode for the motor.
A broad range of configuration options for control and mode selections can be found in the attached datasheet. This Click board™ also has additional LEDs for anomaly indication. Suppose a state such as an overtemperature or overcurrent/under voltage is detected. In that case, a such anomaly is indicated by red LEDs marked as DIAG1 and DIAG2 associated with the interrupt pin. The DC Motor 12 supports an external power supply for the TB9054FTG, which can be connected to the input terminal labeled as VM and should be within the range of 4.5V to 28V, while the DC motor coils can be connected to the terminals labeled from OUT1 up to OUT4. This Click board™ can operate with either 3.3V or 5V logic voltage levels selected via the VCC SEL jumper. This way, both 3.3V and 5V capable MCUs can use the communication lines properly. However, the Click board™ comes equipped with a library containing easy-to-use functions and an example code that can be used, as a reference, for further development.
Features overview
Development board
Nucleo-64 with STM32G474R MCU offers a cost-effective and adaptable platform for developers to explore new ideas and prototype their designs. This board harnesses the versatility of the STM32 microcontroller, enabling users to select the optimal balance of performance and power consumption for their projects. It accommodates the STM32 microcontroller in the LQFP64 package and includes essential components such as a user LED, which doubles as an ARDUINO® signal, alongside user and reset push-buttons, and a 32.768kHz crystal oscillator for precise timing operations. Designed with expansion and flexibility in mind, the Nucleo-64 board features an ARDUINO® Uno V3 expansion connector and ST morpho extension pin
headers, granting complete access to the STM32's I/Os for comprehensive project integration. Power supply options are adaptable, supporting ST-LINK USB VBUS or external power sources, ensuring adaptability in various development environments. The board also has an on-board ST-LINK debugger/programmer with USB re-enumeration capability, simplifying the programming and debugging process. Moreover, the board is designed to simplify advanced development with its external SMPS for efficient Vcore logic supply, support for USB Device full speed or USB SNK/UFP full speed, and built-in cryptographic features, enhancing both the power efficiency and security of projects. Additional connectivity is
provided through dedicated connectors for external SMPS experimentation, a USB connector for the ST-LINK, and a MIPI® debug connector, expanding the possibilities for hardware interfacing and experimentation. Developers will find extensive support through comprehensive free software libraries and examples, courtesy of the STM32Cube MCU Package. This, combined with compatibility with a wide array of Integrated Development Environments (IDEs), including IAR Embedded Workbench®, MDK-ARM, and STM32CubeIDE, ensures a smooth and efficient development experience, allowing users to fully leverage the capabilities of the Nucleo-64 board in their projects.
Microcontroller Overview
MCU Card / MCU
Architecture
ARM Cortex-M4
MCU Memory (KB)
512
Silicon Vendor
STMicroelectronics
Pin count
64
RAM (Bytes)
128k
You complete me!
Accessories
Click Shield for Nucleo-64 comes equipped with two proprietary mikroBUS™ sockets, allowing all the Click board™ devices to be interfaced with the STM32 Nucleo-64 board with no effort. This way, Mikroe allows its users to add any functionality from our ever-growing range of Click boards™, such as WiFi, GSM, GPS, Bluetooth, ZigBee, environmental sensors, LEDs, speech recognition, motor control, movement sensors, and many more. More than 1537 Click boards™, which can be stacked and integrated, are at your disposal. The STM32 Nucleo-64 boards are based on the microcontrollers in 64-pin packages, a 32-bit MCU with an ARM Cortex M4 processor operating at 84MHz, 512Kb Flash, and 96KB SRAM, divided into two regions where the top section represents the ST-Link/V2 debugger and programmer while the bottom section of the board is an actual development board. These boards are controlled and powered conveniently through a USB connection to program and efficiently debug the Nucleo-64 board out of the box, with an additional USB cable connected to the USB mini port on the board. Most of the STM32 microcontroller pins are brought to the IO pins on the left and right edge of the board, which are then connected to two existing mikroBUS™ sockets. This Click Shield also has several switches that perform functions such as selecting the logic levels of analog signals on mikroBUS™ sockets and selecting logic voltage levels of the mikroBUS™ sockets themselves. Besides, the user is offered the possibility of using any Click board™ with the help of existing bidirectional level-shifting voltage translators, regardless of whether the Click board™ operates at a 3.3V or 5V logic voltage level. Once you connect the STM32 Nucleo-64 board with our Click Shield for Nucleo-64, you can access hundreds of Click boards™, working with 3.3V or 5V logic voltage levels.
DC Gear Motor - 430RPM (3-6V) represents an all-in-one combination of a motor and gearbox, where the addition of gear leads to a reduction of motor speed while increasing the torque output. This gear motor has a spur gearbox, making it a highly reliable solution for applications with lower torque and speed requirements. The most critical parameters for gear motors are speed, torque, and efficiency, which are, in this case, 520RPM with no load and 430RPM at maximum efficiency, alongside a current of 60mA and a torque of 50g.cm. Rated for a 3-6V operational voltage range and clockwise/counterclockwise rotation direction, this motor represents an excellent solution for many functions initially performed by brushed DC motors in robotics, medical equipment, electric door locks, and much more.
Used MCU Pins
mikroBUS™ mapper
Take a closer look
Schematic
Step by step
Project assembly
Start by selecting your development board and Click board™. Begin with the Nucleo 64 with STM32G474RE MCU as your development board.
Track your results in real time
Application Output via Debug Mode
1. Once the code example is loaded, pressing the "DEBUG" button initiates the build process, programs it on the created setup, and enters Debug mode.
2. After the programming is completed, a header with buttons for various actions within the IDE becomes visible. Clicking the green "PLAY" button starts reading the results achieved with the Click board™. The achieved results are displayed in the Application Output tab.
Software Support
Library Description
This library contains API for DC Motor 12 Click driver.
Key functions:
dcmotor12_get_motor_currentDC Motor 12 get motor current function.dcmotor12_set_ch1_operation_modeDC Motor 12 set ch1 operation mode function.dcmotor12_set_cm_sel_pinDC Motor 12 set cm sel pin function.
Open Source
Code example
This example can be found in NECTO Studio. Feel free to download the code, or you can copy the code below.
/*!
* @file main.c
* @brief DC Motor 12 Click example
*
* # Description
* This example demonstrates the use of DC Motor 12 click board by controlling the speed
* of DC motor over PWM duty cycle as well as displaying the motor current consumption.
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initializes the driver and performs the click default configuration.
*
* ## Application Task
* Changes the operation mode and motor speed by setting the PWM duty cycle and then calculates
* the motor current consumption for that speed. All data is being logged on the USB UART
* where you can track changes.
*
* @note
* The click board swiches should be set as follows: SW 1-2-3-4 : H-H-L-L
* This sets the click board as a SPI controlled single-channel device so
* the motor should be connected to OUT1/2 and OUT3/4.
*
* @author Stefan Filipovic
*
*/
#include "board.h"
#include "log.h"
#include "dcmotor12.h"
static dcmotor12_t dcmotor12;
static log_t logger;
void application_init ( void )
{
log_cfg_t log_cfg; /**< Logger config object. */
dcmotor12_cfg_t dcmotor12_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.
dcmotor12_cfg_setup( &dcmotor12_cfg );
DCMOTOR12_MAP_MIKROBUS( dcmotor12_cfg, MIKROBUS_1 );
if ( DCMOTOR12_OK != dcmotor12_init( &dcmotor12, &dcmotor12_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( DCMOTOR12_OK != dcmotor12_default_cfg ( &dcmotor12 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}
void application_task ( void )
{
if ( DCMOTOR12_OK == dcmotor12_set_ch1_operation_mode ( &dcmotor12, DCMOTOR12_MODE_OUTPUT_OFF ) )
{
log_printf ( &logger, " MODE: OFF\r\n" );
Delay_ms ( 3000 );
}
if ( DCMOTOR12_OK == dcmotor12_set_ch1_operation_mode ( &dcmotor12, DCMOTOR12_MODE_FORWARD ) )
{
dcmotor12_set_cm_sel_pin ( &dcmotor12, DCMOTOR12_PIN_LOW_LEVEL );
for ( uint16_t duty = 0; duty <= DCMOTOR12_CONFIG56_DUTY_PERIOD_MAX; duty += 100 )
{
float current;
log_printf ( &logger, " MODE: FORWARD\r\n" );
if ( DCMOTOR12_OK == dcmotor12_set_ch1_duty_period ( &dcmotor12, duty ) )
{
log_printf ( &logger, " Duty: %u\r\n", duty );
}
if ( DCMOTOR12_OK == dcmotor12_get_motor_current ( &dcmotor12, ¤t ) )
{
log_printf ( &logger, " Current: %.3f A\r\n\n", current );
}
Delay_ms ( 500 );
}
}
if ( DCMOTOR12_OK == dcmotor12_set_ch1_operation_mode ( &dcmotor12, DCMOTOR12_MODE_BRAKE ) )
{
log_printf ( &logger, " MODE: BRAKE\r\n" );
Delay_ms ( 3000 );
}
if ( DCMOTOR12_OK == dcmotor12_set_ch1_operation_mode ( &dcmotor12, DCMOTOR12_MODE_REVERSE ) )
{
dcmotor12_set_cm_sel_pin ( &dcmotor12, DCMOTOR12_PIN_HIGH_LEVEL );
for ( uint16_t duty = 0; duty <= DCMOTOR12_CONFIG56_DUTY_PERIOD_MAX; duty += 100 )
{
float current;
log_printf ( &logger, " MODE: REVERSE\r\n" );
if ( DCMOTOR12_OK == dcmotor12_set_ch1_duty_period ( &dcmotor12, duty ) )
{
log_printf ( &logger, " Duty: %u\r\n", duty );
}
if ( DCMOTOR12_OK == dcmotor12_get_motor_current ( &dcmotor12, ¤t ) )
{
log_printf ( &logger, " Current: %.3f A\r\n\n", current );
}
Delay_ms ( 500 );
}
}
}
void main ( void )
{
application_init( );
for ( ; ; )
{
application_task( );
}
}
// ------------------------------------------------------------------------ END
