Enable users to tailor vibration patterns to their preferences using G0832022D and ATmega2560
Shake up your world with control
Published Feb 14, 2024
Click board™
Vibro Motor 3 Click
Dev Board
Arduino Mega 2560 Rev3
Compiler
NECTO Studio
MCU
ATmega2560
Fine-tune your device notifications with precision, ensuring that users receive alerts in a more discreet and personalized manner
A
A
Hardware Overview
How does it work?
Vibro Motor 3 Click is based on the G0832022D, a coin-sized linear resonant actuator that generates vibration/haptic feedback in the Z plane, perpendicular to the motor's surface from Jinlong Machinery & Electronics, Inc. The G0832022D draws only 19mA at 0.6V while producing a G force of 0.55 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. 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, which allows effortless auto resonant drive for LRA motor drive. This feedback provides automatic overdrive and braking, which creates 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. In PWM Mode, the vibration strength is controlled by the duty cycle, and
for the LRA motor, the DRV2605 automatically tracks the resonance frequency unless the LRA_OPEN_LOOP bit in register 0x1D is set. If the LRA_OPEN_LOOP bit is set, then the LRA motor is driven according to the frequency of the PWM input signal. 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.
Features overview
Development board
Arduino Mega 2560 is a robust microcontroller platform built around the ATmega 2560 chip. It has extensive capabilities and boasts 54 digital input/output pins, including 15 PWM outputs, 16 analog inputs, and 4 UARTs. With a 16MHz crystal
oscillator ensuring precise timing, it offers seamless connectivity via USB, a convenient power jack, an ICSP header, and a reset button. This all-inclusive board simplifies microcontroller projects; connect it to your computer via USB or power it up
using an AC-to-DC adapter or battery. Notably, the Mega 2560 maintains compatibility with a wide range of shields crafted for the Uno, Duemilanove, or Diecimila boards, ensuring versatility and ease of integration.
Microcontroller Overview
MCU Card / MCU
Architecture
AVR
MCU Memory (KB)
256
Silicon Vendor
Microchip
Pin count
100
RAM (Bytes)
8192
You complete me!
Accessories
Click Shield for Arduino Mega comes equipped with four mikroBUS™ sockets, with two in the form of a Shuttle connector, allowing all the Click board™ devices to be interfaced with the Arduino Mega board with no effort. Featuring an AVR 8-bit microcontroller with advanced RISC architecture, 54 digital I/O pins, and Arduino™ compatibility, the Arduino Mega board offers limitless possibilities for prototyping and creating diverse applications. This board is controlled and powered conveniently through a USB connection to program and debug the Arduino Mega board efficiently out of the box, with an additional USB cable connected to the USB B port on the board. Simplify your project development with the integrated ATmega16U2 programmer and unleash creativity using the extensive I/O options and expansion capabilities. There are eight switches, which you can use as inputs, and eight LEDs, which can be used as outputs of the MEGA2560. In addition, the shield features the MCP1501, a high-precision buffered voltage reference from Microchip. This reference is selected by default over the EXT REF jumper at the bottom of the board. You can choose an external one, as you would usually do with an Arduino Mega board. There is also a GND hook for testing purposes. Four additional LEDs are PWR, LED (standard pin D13), RX, and TX LEDs connected to UART1 (mikroBUS™ 1 socket). 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 Arduino Mega board with Click Shield for Arduino Mega, you can access hundreds of Click boards™, working with 3.3V or 5V logic voltage levels.
Used MCU Pins
mikroBUS™ mapper
Take a closer look
Click board™ Schematic
Step by step
Project assembly
Start by selecting your development board and Click board™. Begin with the Arduino Mega 2560 Rev3 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 Vibro Motor 3 Click driver.
Key functions:
vibromotor3_set_duty_cycle- Vibro Motor 3 sets PWM duty cyclevibromotor3_enable- Enable the device functionvibromotor3_write_byte- Generic write the byte of data function
Open Source
Code example
The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.
/*!
* @file main.c
* @brief VibroMotor3 Click example
*
* # Description
* This example shows the capabilities of the Vibro Motor 3 click board
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initalizes I2C driver, PWM driver and configures Vibro Motor 3 click board.
*
* ## Application Task
* Changing duty cycle applied in order to get different vibrations.
*
* @author Stefan Ilic
*
*/
#include "board.h"
#include "log.h"
#include "vibromotor3.h"
static vibromotor3_t vibromotor3;
static log_t logger;
static float pwm_max_duty = 1;
static float pwm_duty_cycle = 0;
void application_init ( void ) {
log_cfg_t log_cfg; /**< Logger config object. */
vibromotor3_cfg_t vibromotor3_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.
vibromotor3_cfg_setup( &vibromotor3_cfg );
VIBROMOTOR3_MAP_MIKROBUS( vibromotor3_cfg, MIKROBUS_1 );
err_t init_flag = vibromotor3_init( &vibromotor3, &vibromotor3_cfg );
if ( I2C_MASTER_ERROR == init_flag || PWM_ERROR == init_flag ) {
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
vibromotor3_enable( &vibromotor3, VIBROMOTOR3_PROPERTY_ENABLE );
Delay_ms( 100 );
vibromotor3_soft_rst( &vibromotor3 );
Delay_ms( 100 );
vibromotor3_default_cfg( &vibromotor3 );
Delay_ms( 100 );
vibromotor3_set_duty_cycle( &vibromotor3, 0.0 );
vibromotor3_pwm_start( &vibromotor3 );
Delay_ms( 100 );
log_info( &logger, " Application Task " );
Delay_ms( 100 );
}
void application_task ( void ) {
static int8_t duty_cnt = 1;
static int8_t duty_inc = 1;
float duty = duty_cnt / 10.0;
vibromotor3_set_duty_cycle ( &vibromotor3, 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;
}
duty_cnt += duty_inc;
}
void main ( void ) {
application_init( );
for ( ; ; ) {
application_task( );
}
}
// ------------------------------------------------------------------------ END
