Intermediate
30 min

Enhance user experiences with advanced ERM motor control based on C1026B002F and PIC32MZ2048EFM100

Sync and thrive!

Vibro Motor Click with Curiosity PIC32 MZ EF

Published Sep 09, 2023

Click board™

Vibro Motor Click

Dev Board

Curiosity PIC32 MZ EF

Compiler

NECTO Studio

MCU

PIC32MZ2048EFM100

In today's dynamic landscape of vibrational applications, our solution aims to simplify motor control and enhance vibrational experiences, offering a user-friendly way to manage ERM motors

A

A

Hardware Overview

How does it work?

Vibro Motor Click is based on the C1026B002F, a compact-size Eccentric Rotating Mass (ERM) motor. This type of motor is often used for haptic feedback on many small handheld devices, such as cellphones, pagers, RFID scanners, and similar devices. This motor contains a small eccentric weight on its rotor, so it also produces a vibration effect while rotating. This kind of motor is sometimes called a coin motor due to its shape. Besides the vibration motor, the click is also equipped with the DMG3420U, a small MOSFET used to drive the motor. The Vibro Motor click is ideal for adding simple, one-pin-driven haptic feedback on any design. The circuit also contains

a protection diode, which protects the transistor from the reverse voltage since the motor represents an inductive load, and turning off its current can produce a kickback voltage that can damage the transistor. The gate of the MOSFET is driven by the PWM signal, routed through the PWM pin of the mikroBUS™. The PWM signal toggles the gate of the MOSFET with pulses of a certain width. As a result, the current through the motor is varied depending on the pulse width of the PWM signal, which directly affects the speed of the motor, effectively controlling the vibration force that way. The small, eccentric weight attached to the rotor of the coin motor generates

the centrifugal force while it rotates, which in turn results in the wobbling effect of the motor itself. The faster the rotation is, the bigger the force gets. Controlling the motor speed allows for the vibration intensity to be controlled. This Click board™ can be operated only with a 3.3V logic voltage level. The board must perform appropriate logic voltage level conversion before using MCUs with different logic levels. Also, it comes equipped with a library containing functions and an example code that can be used as a reference for further development.

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

Features overview

Development board

Curiosity PIC32 MZ EF development board is a fully integrated 32-bit development platform featuring the high-performance PIC32MZ EF Series (PIC32MZ2048EFM) that has a 2MB Flash, 512KB RAM, integrated FPU, Crypto accelerator, and excellent connectivity options. It includes an integrated programmer and debugger, requiring no additional hardware. Users can expand

functionality through MIKROE mikroBUS™ Click™ adapter boards, add Ethernet connectivity with the Microchip PHY daughter board, add WiFi connectivity capability using the Microchip expansions boards, and add audio input and output capability with Microchip audio daughter boards. These boards are fully integrated into PIC32’s powerful software framework, MPLAB Harmony,

which provides a flexible and modular interface to application development a rich set of inter-operable software stacks (TCP-IP, USB), and easy-to-use features. The Curiosity PIC32 MZ EF development board offers expansion capabilities making it an excellent choice for a rapid prototyping board in Connectivity, IOT, and general-purpose applications.

Curiosity PIC32MZ EF double side image

Microcontroller Overview

MCU Card / MCU

default

Architecture

PIC32

MCU Memory (KB)

2048

Silicon Vendor

Microchip

Pin count

100

RAM (Bytes)

524288

Used MCU Pins

mikroBUS™ mapper

NC
NC
AN
NC
NC
RST
NC
NC
CS
NC
NC
SCK
NC
NC
MISO
NC
NC
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
Motor Speed Control
RPE8
PWM
NC
NC
INT
NC
NC
TX
NC
NC
RX
NC
NC
SCL
NC
NC
SDA
NC
NC
5V
Ground
GND
GND
1

Take a closer look

Click board™ Schematic

Vibro Motor Click Schematic schematic

Step by step

Project assembly

Curiosity PIC32MZ EF front image hardware assembly

Start by selecting your development board and Click board™. Begin with the Curiosity PIC32 MZ EF as your development board.

Curiosity PIC32MZ EF front image hardware assembly
GNSS2 Click front image hardware assembly
Prog-cut hardware assembly
Curiosity PIC32 MZ EF MB 1 Access - upright/background hardware assembly
Necto image step 2 hardware assembly
Necto image step 3 hardware assembly
Necto image step 4 hardware assembly
Necto image step 5 hardware assembly
Necto image step 6 hardware assembly
Curiosity PIC32 MZ EF MCU Step hardware assembly
Necto No Display image step 8 hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Debug Image Necto Step hardware assembly

Track your results in real time

Application Output

This Click board can be interfaced and monitored in two ways:

  • Application Output - Use the "Application Output" window in Debug mode for real-time data monitoring. Set it up properly by following this tutorial.

Software Support

Library Description

This library contains API for Vibro Motor Click driver.

Key functions:

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

  • vibromotor_pwm_stop - This function stops the PWM moudle output

  • vibromotor_pwm_start - This function starts the PWM moudle output.

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 VibroMotor Click 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.
 * 
 * ## Application Task  
 * Allows user to enter desired command to control
 * Vibro Motor Click board.
 *
 * @author Stefan Ilic
 *
 */

#include "board.h"
#include "log.h"
#include "vibromotor.h"


static vibromotor_t vibromotor;
static log_t logger;

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

    vibromotor_cfg_setup( &vibromotor_cfg );
    VIBROMOTOR_MAP_MIKROBUS( vibromotor_cfg, MIKROBUS_1 );
    err_t init_flag  = vibromotor_init( &vibromotor, &vibromotor_cfg );
    if ( PWM_ERROR == init_flag ) {
        log_error( &logger, " Application Init Error. " );
        log_info( &logger, " Please, run program again... " );

        for ( ; ; );
    }

    vibromotor_set_duty_cycle ( &vibromotor, 0.0 );
    vibromotor_pwm_start( &vibromotor );

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

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

Additional Support

Resources

Love this project?

'Buy This Kit' button takes you directly to the shopping cart where you can easily add or remove products.