Enable users to tailor vibration patterns to their preferences using G0832022D and PIC18F57Q43
Shake up your world with control
Published Feb 13, 2024
Click board™
Vibro Motor 3 Click
Dev Board
Curiosity Nano with PIC18F57Q43
Compiler
NECTO Studio
MCU
PIC18F57Q43
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
PIC18F57Q43 Curiosity Nano evaluation kit is a cutting-edge hardware platform designed to evaluate microcontrollers within the PIC18-Q43 family. Central to its design is the inclusion of the powerful PIC18F57Q43 microcontroller (MCU), offering advanced functionalities and robust performance. Key features of this evaluation kit include a yellow user LED and a responsive
mechanical user switch, providing seamless interaction and testing. The provision for a 32.768kHz crystal footprint ensures precision timing capabilities. With an onboard debugger boasting a green power and status LED, programming and debugging become intuitive and efficient. Further enhancing its utility is the Virtual serial port (CDC) and a debug GPIO channel (DGI
GPIO), offering extensive connectivity options. Powered via USB, this kit boasts an adjustable target voltage feature facilitated by the MIC5353 LDO regulator, ensuring stable operation with an output voltage ranging from 1.8V to 5.1V, with a maximum output current of 500mA, subject to ambient temperature and voltage constraints.
Microcontroller Overview
MCU Card / MCU
Architecture
PIC
MCU Memory (KB)
128
Silicon Vendor
Microchip
Pin count
48
RAM (Bytes)
8196
You complete me!
Accessories
Curiosity Nano Base for Click boards is a versatile hardware extension platform created to streamline the integration between Curiosity Nano kits and extension boards, tailored explicitly for the mikroBUS™-standardized Click boards and Xplained Pro extension boards. This innovative base board (shield) offers seamless connectivity and expansion possibilities, simplifying experimentation and development. Key features include USB power compatibility from the Curiosity Nano kit, alongside an alternative external power input option for enhanced flexibility. The onboard Li-Ion/LiPo charger and management circuit ensure smooth operation for battery-powered applications, simplifying usage and management. Moreover, the base incorporates a fixed 3.3V PSU dedicated to target and mikroBUS™ power rails, alongside a fixed 5.0V boost converter catering to 5V power rails of mikroBUS™ sockets, providing stable power delivery for various connected devices.
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 Curiosity Nano with PIC18F57Q43 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
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 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
