vibromotor2

\mainpage Main Page

---

Vibro Motor 2 Click

Vibro Motor 2 Click features a compact size Eccentric Rotating Mass (ERM) motor, labeled as Z4FC1B1301781 as well as DMG3420U MOSFET to drive the ERM motor, since the MCU itself cannot provide enough power for the motor driving. This type of motor is often used for haptic feedback on many small handheld devices, such as the cellphones, pagers, RFID scanners and similar devices. This motor contains a small eccentric weight on its rotor, so while rotating it also produces vibration effect

Click Product page

---

Click library

• Author : Stefan Ilic
• Date : Jun 2021.
• Type : PWM type

Software Support

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

Standard key functions :

• vibromotor2_cfg_setup Config Object Initialization function.

void vibromotor2_cfg_setup ( vibromotor2_cfg_t *cfg );

• vibromotor2_init Initialization function.

err_t vibromotor2_init ( vibromotor2_t *ctx, vibromotor2_cfg_t *cfg );

Example key functions :

• vibromotor2_set_duty_cycle This function sets the PWM duty cycle in percentages ( Range[ 0..1 ] ).

err_t vibromotor2_set_duty_cycle ( vibromotor2_t *ctx, float duty_cycle );

• vibromotor2_pwm_stop This function stops the PWM moudle output.

err_t vibromotor2_pwm_stop ( vibromotor2_t *ctx );

• vibromotor2_pwm_start This function starts the PWM moudle output.

err_t vibromotor2_pwm_start ( vibromotor2_t *ctx );

Example Description

This application contorl the speed of vibro motor.

The demo application is composed of two sections :

Application Init

Initializes GPIO driver and PWM. Configures PWM to 5kHz frequency, calculates maximum duty ratio and starts PWM with duty ratio value 0.

void application_init ( void ) {
    log_cfg_t log_cfg;  /**< Logger config object. */
    vibromotor2_cfg_t vibromotor2_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.

    vibromotor2_cfg_setup( &vibromotor2_cfg );
    VIBROMOTOR2_MAP_MIKROBUS( vibromotor2_cfg, MIKROBUS_1 );
    err_t init_flag  = vibromotor2_init( &vibromotor2, &vibromotor2_cfg );
    if ( PWM_ERROR == init_flag ) {
        log_error( &logger, " Application Init Error. " );
        log_info( &logger, " Please, run program again... " );

        for ( ; ; );
    }

    vibromotor2_set_duty_cycle ( &vibromotor2, 0.0 );
    vibromotor2_pwm_start( &vibromotor2 );

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

Application Task

Allows user to enter desired command to control Vibro Motor Click board.

void application_task ( void ) {
    static int8_t duty_cnt = 1;
    static int8_t duty_inc = 1;
    float duty = duty_cnt / 10.0;
    
    vibromotor2_set_duty_cycle ( &vibromotor2, 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.VibroMotor2

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.

---