Intermediate
30 min

Provide clear feedback with VG1040003D and STM32F437ZG

Empower your device's buzz

Vibro Motor 4 Click with Fusion for ARM v8

Published Sep 10, 2023

Click board™

Vibro Motor 4 Click

Development board

Fusion for ARM v8

Compiler

NECTO Studio

MCU

STM32F437ZG

Elevate interaction with devices and applications by incorporating precise vibration control, offering a more engaging and immersive experience

A

A

Hardware Overview

How does it work?

Vibro Motor 4 Click is based on the VG1040003D, coin-sized linear resonant actuator that generates vibration/haptic feedback in the Z plane perpendicular to the motor's surface from Vybronics. The VG1040003D draws a typical 145mA while producing a G force of 2 GRMS and makes an excellent choice for applications requiring crisp haptic feedback and low power consumption. For haptic feedback applications, fast rise and fall times are critical for achieving the optimal user experience. That's why the rise time (50% power) of the G1040003D, which is 10ms, and its fall time (10% power) of 50ms makes it one of the best choices for haptic feedback applications. Driven by the DRV2605, a flexible Haptic/Vibra driver from

Texas Instruments, this Click board™ is designed to provide highly flexible haptic control over a standard I2C 2-Wire interface with a maximum clock frequency of 400kHz. It possesses an enabling function, routed on the CS pin of the mikroBUS™ socket labeled as the EN, and comes up with an extensive integrated library of over 100 licensed effects that eliminates the need to design haptics waveforms. It also contains a smart-loop architecture and provides automatic overdrive and braking, creating a simplified input waveform paradigm, reliable motor control, and consistent motor performance. The DRV2605 can also operate in the PWM Mode and accept the PWM signal from the PWM pin of the mikroBUS™

socket. In this mode, the DRV2605 device drives the actuator continuously until the user sets the DRV2605 to a Standby Mode or enters another interface mode. More information about the operating modes of the DRV2605 can be found in the attached datasheet. 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. Also, this 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.

Vibro Motor 4 Click top side image
Vibro Motor 4 Click bottom side image

Features overview

Development board

Fusion for ARM v8 is a development board specially designed for the needs of rapid development of embedded applications. It supports a wide range of microcontrollers, such as different ARM® Cortex®-M based MCUs regardless of their number of pins, and a broad set of unique functions, such as the first-ever embedded debugger/programmer over WiFi. The development board is well organized and designed so that the end-user has all the necessary elements, such as switches, buttons, indicators, connectors, and others, in one place. Thanks to innovative manufacturing technology, Fusion for ARM v8 provides a fluid and immersive working experience, allowing access anywhere and under any

circumstances at any time. Each part of the Fusion for ARM v8 development board contains the components necessary for the most efficient operation of the same board. An advanced integrated CODEGRIP programmer/debugger module offers many valuable programming/debugging options, including support for JTAG, SWD, and SWO Trace (Single Wire Output)), and seamless integration with the Mikroe software environment. Besides, it also includes a clean and regulated power supply module for the development board. It can use a wide range of external power sources, including a battery, an external 12V power supply, and a power source via the USB Type-C (USB-C) connector.

Communication options such as USB-UART, USB HOST/DEVICE, CAN (on the MCU card, if supported), and Ethernet is also included. In addition, it also has the well-established mikroBUS™ standard, a standardized socket for the MCU card (SiBRAIN standard), and two display options for the TFT board line of products and character-based LCD. Fusion for ARM v8 is an integral part of the Mikroe ecosystem for rapid development. Natively supported by Mikroe software tools, it covers many aspects of prototyping and development thanks to a considerable number of different Click boards™ (over a thousand boards), the number of which is growing every day.

Fusion for ARM v8 horizontal image

Microcontroller Overview

MCU Card / MCU

default

Type

8th Generation

Architecture

ARM Cortex-M4

MCU Memory (KB)

1024

Silicon Vendor

STMicroelectronics

Pin count

144

RAM (Bytes)

262144

Used MCU Pins

mikroBUS™ mapper

NC
NC
AN
NC
NC
RST
Enable
PA4
CS
NC
NC
SCK
NC
NC
MISO
NC
NC
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
PWM Signal
PD12
PWM
NC
NC
INT
NC
NC
TX
NC
NC
RX
I2C Clock
PB8
SCL
I2C Data
PB9
SDA
Power Supply
5V
5V
Ground
GND
GND
1

Take a closer look

Schematic

Vibro Motor 4 Click Schematic schematic

Step by step

Project assembly

Fusion for PIC v8 front image hardware assembly

Start by selecting your development board and Click board™. Begin with the Fusion for ARM v8 as your development board.

Fusion for PIC v8 front image hardware assembly
Buck 22 Click front image hardware assembly
SiBRAIN for PIC32MZ1024EFK144 front image hardware assembly
v8 SiBRAIN MB 1 - upright/background hardware assembly
Necto image step 2 hardware assembly
Necto image step 3 hardware assembly
Necto image step 4 hardware assembly
NECTO Compiler Selection Step Image hardware assembly
NECTO Output Selection Step Image hardware assembly
Necto image step 6 hardware assembly
Necto image step 7 hardware assembly
Necto image step 8 hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Necto PreFlash Image hardware assembly

Track your results in real time

Application Output

After pressing the "FLASH" button on the left-side panel, it is necessary to open the UART terminal to display the achieved results. By clicking on the Tools icon in the right-hand panel, multiple different functions are displayed, among which is the UART Terminal. Click on the offered "UART Terminal" icon.

UART Application Output Step 1

Once the UART terminal is opened, the window takes on a new form. At the top of the tab are two buttons, one for adjusting the parameters of the UART terminal and the other for connecting the UART terminal. The tab's lower part is reserved for displaying the achieved results. Before connecting, the terminal has a Disconnected status, indicating that the terminal is not yet active. Before connecting, it is necessary to check the set parameters of the UART terminal. Click on the "OPTIONS" button.

UART Application Output Step 2

In the newly opened UART Terminal Options field, we check if the terminal settings are correct, such as the set port and the Baud rate of UART communication. If the data is not displayed properly, it is possible that the Baud rate value is not set correctly and needs to be adjusted to 115200. If all the parameters are set correctly, click on "CONFIGURE".

UART Application Output Step 3

The next step is to click on the "CONNECT" button, after which the terminal status changes from Disconnected to Connected in green, and the data is displayed in the Received data field.

UART Application Output Step 4

Software Support

Library Description

This library contains API for Vibro Motor 4 Click driver.

Key functions:

  • vibromotor4_set_mode - Vibro Motor 4 sets the desired mode function

  • vibromotor4_set_duty_cycle - Vibro Motor 4 sets PWM duty cycle

  • vibromotor4_pwm_start - Vibro Motor 4 start PWM module.

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 VibroMotor4 Click example
 *
 * # Description
 * This library contains API for Vibro Motor 4 Click driver.
 * The library initializes and defines the I2C bus drivers
 * to write and read data from registers and PWM module.
 *
 * The demo application is composed of two sections :
 *
 * ## Application Init
 * The initialization of I2C and PWM module, log UART, and additional pins.
 * After successful driver init, executes a default configuration
 * and configures Vibro Motor 4 Click board™.
 *
 * ## Application Task
 * This is an example that shows the use of a Vibro Motor 4 Click board™.
 * Changing duty cycle results in different vibrations.
 * Results are being sent to the Usart Terminal where you can track their changes.
 *
 * @author Nenad Filipovic
 *
 */

#include "board.h"
#include "log.h"
#include "vibromotor4.h"

static vibromotor4_t vibromotor4;
static log_t logger;

void application_init ( void )
{
    log_cfg_t log_cfg;                  /**< Logger config object. */
    vibromotor4_cfg_t vibromotor4_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.
    vibromotor4_cfg_setup( &vibromotor4_cfg );
    VIBROMOTOR4_MAP_MIKROBUS( vibromotor4_cfg, MIKROBUS_1 );
    err_t init_flag = vibromotor4_init( &vibromotor4, &vibromotor4_cfg );
    if ( I2C_MASTER_ERROR == init_flag )
    {
        log_error( &logger, " Application Init Error. " );
        log_info( &logger, " Please, run program again... " );

        for ( ; ; );
    }

    vibromotor4_enable( &vibromotor4, VIBROMOTOR4_PROPERTY_ENABLE );
    Delay_ms( 100 );

    vibromotor4_soft_rst( &vibromotor4 );
    Delay_ms( 100 );

    vibromotor4_default_cfg ( &vibromotor4 );
    Delay_ms( 100 );

    vibromotor4_set_duty_cycle( &vibromotor4, 0.0 );
    Delay_ms( 100 );

    vibromotor4_pwm_start( &vibromotor4 );
    Delay_ms( 100 );

    log_info( &logger, " Application Task " );
    Delay_ms( 100 );
}

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

    vibromotor4_set_duty_cycle ( &vibromotor4, duty );
    log_printf( &logger, "> Duty: %d%%\r\n", ( uint16_t )( duty_cnt * 10 ) );

    Delay_ms( 1000 );

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

void main ( void )
{
    application_init( );

    for ( ; ; )
    {
        application_task( );
    }
}

// ------------------------------------------------------------------------ END

Additional Support

Resources