vibromotor3  2.0.0.0
Main Page

Vibro Motor 3 click

Vibro Motor 3 Click is a compact add-on board that makes an ideal solution for adding simple haptic feedback in any design. This board features the G0832022D, a coin-sized linear resonant actuator (LRA) that generates vibration/haptic feedback in the Z plane, perpendicular to the motor's surface from Jinlong Machinery & Electronics, Inc.

click Product page


Click library

  • Author : Stefan Ilic
  • Date : Jul 2021.
  • Type : I2C type

Software Support

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

Standard key functions :

Example key functions :

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.

void application_init ( void ) {
log_cfg_t log_cfg;
vibromotor3_cfg_t vibromotor3_cfg;
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 ( ; ; );
}
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 );
}

Application Task

Changing duty cycle applied in order to get different vibrations.

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;
}

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

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.


vibromotor3_write_byte
void vibromotor3_write_byte(vibromotor3_t *ctx, uint8_t reg, uint8_t wr_data)
Generic write the byte of data function.
vibromotor3_soft_rst
void vibromotor3_soft_rst(vibromotor3_t *ctx)
Reset function.
vibromotor3_cfg_t
Vibro Motor 3 Click configuration object.
Definition: vibromotor3.h:322
vibromotor3_init
err_t vibromotor3_init(vibromotor3_t *ctx, vibromotor3_cfg_t *cfg)
Vibro Motor 3 initialization function.
vibromotor3_enable
void vibromotor3_enable(vibromotor3_t *ctx, uint8_t state)
Enable the device function.
vibromotor3_pwm_start
err_t vibromotor3_pwm_start(vibromotor3_t *ctx)
Vibro Motor 3 start PWM module.
application_task
void application_task(void)
Definition: main.c:75
VIBROMOTOR3_PROPERTY_ENABLE
#define VIBROMOTOR3_PROPERTY_ENABLE
Definition: vibromotor3.h:258
vibromotor3_set_duty_cycle
err_t vibromotor3_set_duty_cycle(vibromotor3_t *ctx, float duty_cycle)
Vibro Motor 3 sets PWM duty cycle.
vibromotor3_t
Vibro Motor 3 Click context object.
Definition: vibromotor3.h:302
vibromotor3_cfg_setup
void vibromotor3_cfg_setup(vibromotor3_cfg_t *cfg)
Vibro Motor 3 configuration object setup function.
VIBROMOTOR3_MAP_MIKROBUS
#define VIBROMOTOR3_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: vibromotor3.h:289
application_init
void application_init(void)
Definition: main.c:31
vibromotor3_default_cfg
err_t vibromotor3_default_cfg(vibromotor3_t *ctx)
Vibro Motor 3 default configuration function.