Create simple sounds including beeps and buzzers with PAM8906 and STM32F413ZH

Piezoelectric sounder

Piezo Driver Click with Nucleo 144 with STM32F413ZH MCU

Published Feb 14, 2024

Click board™

Piezo Driver Click

Dev. board

Nucleo 144 with STM32F413ZH MCU

Compiler

NECTO Studio

MCU

STM32F413ZH

Convert electrical energy into mechanical vibrations and produce audible sound waves

Hardware Overview

How does it work?

Piezo Driver Click is based on the PAM8906, a piezo sounder driver with self-excitation mode from Diodes Incorporated. It features automatic shutdown and wake-up control, low operating current, very short turn ON/OFF, over-voltage protection, over-current protection, and more. This driver operates with an external PWM input. It can drive a two-terminal or three-terminal piezo sounder, and selection can be made over the

TERMINAL SEL jumper. The piezo sounder can be connected over the 3-pin screw terminal, labeled differently for both available options. In addition, you can use VOUT to power up the piezo sounder. Piezo Driver Click uses a PWM input pin to communicate with the host MCU. The PWM input will be amplified and driven to the output terminal if used as an external PWM control. It can also be used for automatic wake-up and shutdown

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

Piezo Driver Click hardware overview image

Features overview

Development board

Nucleo-144 with STM32F413ZH MCU board offers an accessible and adaptable avenue for users to explore new ideas and construct prototypes. It allows users to tailor their experience by selecting from a range of performance and power consumption features offered by the STM32 microcontroller. With compatible boards, the

internal or external SMPS dramatically decreases power usage in Run mode. Including the ST Zio connector, expanding ARDUINO Uno V3 connectivity, and ST morpho headers facilitate easy expansion of the Nucleo open development platform. The integrated ST-LINK debugger/programmer enhances convenience by

eliminating the need for a separate probe. Moreover, the board is accompanied by comprehensive free software libraries and examples within the STM32Cube MCU Package, further enhancing its utility and value.

Nucleo 144 with STM32F413ZH MCU double side image

Microcontroller Overview

MCU Card / MCU

Architecture

ARM Cortex-M4

MCU Memory (KB)

1536

Silicon Vendor

STMicroelectronics

Pin count

144

RAM (Bytes)

327680

You complete me!

Accessories

Click Shield for Nucleo-144 comes equipped with four mikroBUS™ sockets, with one in the form of a Shuttle connector, allowing all the Click board™ devices to be interfaced with the STM32 Nucleo-144 board with no effort. This way, MIKROE allows its users to add any functionality from our ever-growing range of Click boards™, such as WiFi, GSM, GPS, Bluetooth, ZigBee, environmental sensors, LEDs, speech recognition, motor control, movement sensors, and many more. Featuring an ARM Cortex-M microcontroller, 144 pins, and Arduino™ compatibility, the STM32 Nucleo-144 board offers limitless possibilities for prototyping and creating diverse applications. These boards are controlled and powered conveniently through a USB connection to program and efficiently debug the Nucleo-144 board out of the box, with an additional USB cable connected to the USB mini port on the board. Simplify your project development with the integrated ST-Link debugger and unleash creativity using the extensive I/O options and expansion capabilities. 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 STM32 Nucleo-144 board with our Click Shield for Nucleo-144, you can access hundreds of Click boards™, working with 3.3V or 5V logic voltage levels.

Used MCU Pins

mikroBUS™ mapper

RST

ID COMM

PA4

SCK

MISO

MOSI

Power Supply

3.3V

Ground

GND

PWM Control

PC6

PWM

INT

SCL

SDA

Power Supply

Ground

GND

Take a closer look

Click board™ Schematic

Step by step

Project assembly

Click Shield for Nucleo-144 accessories 1 image hardware assembly

Start by selecting your development board and Click board™. Begin with the Nucleo 144 with STM32F413ZH MCU as your development board.

Nucleo 144 with STM32F446ZE MCU front image hardware assembly

Charger 27 Click front image hardware assembly

Charger 27 Click complete accessories setup image hardware assembly

Board mapper by product8 hardware assembly

STM32F413ZH Nucleo MCU Step hardware assembly

Necto No Display image step 8 hardware assembly

Debug Image Necto Step hardware assembly

Track your results in real time

Application Output

1. Application Output - In Debug mode, the 'Application Output' window enables real-time data monitoring, offering direct insight into execution results. Ensure proper data display by configuring the environment correctly using the provided tutorial.

2. UART Terminal - Use the UART Terminal to monitor data transmission via a USB to UART converter, allowing direct communication between the Click board™ and your development system. Configure the baud rate and other serial settings according to your project's requirements to ensure proper functionality. For step-by-step setup instructions, refer to the provided tutorial.

3. Plot Output - The Plot feature offers a powerful way to visualize real-time sensor data, enabling trend analysis, debugging, and comparison of multiple data points. To set it up correctly, follow the provided tutorial, which includes a step-by-step example of using the Plot feature to display Click board™ readings. To use the Plot feature in your code, use the function: plot(*insert_graph_name*, variable_name);. This is a general format, and it is up to the user to replace 'insert_graph_name' with the actual graph name and 'variable_name' with the parameter to be displayed.

Software Support

Library Description

This library contains API for Piezo Driver Click driver.

Key functions:

piezodriver_pwm_stop - Piezo Driver stop PWM module.
piezodriver_pwm_start - Piezo Driver start PWM module.
piezodriver_play_sound - Piezo Driver play sound 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 Piezo Driver Click example
 *
 * # Description
 * This example demonstrates the use of Piezo Driver Click board.
 *
 * The demo application is composed of two sections :
 *
 * ## Application Init
 * Initializes the driver and logger.
 *
 * ## Application Task
 * Plays the Imperial March melody. Also logs an appropriate message on the USB UART.
 *
 * @note
 * The minimal PWM Clock frequency required for this example is the frequency of tone C6 - 1047 Hz. 
 * In order to run this example and play all tones correctly, the user will need to decrease 
 * the MCU's main clock frequency in MCU Settings for certain architectures
 * in order to get the required PWM clock frequency.
 *
 * @author Stefan Ilic
 *
 */

#include "board.h"
#include "log.h"
#include "piezodriver.h"

static piezodriver_t piezodriver;
static log_t logger;

#define W           4*Q       // Whole 4/4 - 4 Beats
#define H           2*Q       // Half 2/4 - 2 Beats 
#define Q           250       // Quarter 1/4 - 1 Beat
#define E           Q/2       // Eighth 1/8 - 1/2 Beat
#define S           Q/4       // Sixteenth 1/16 - 1/4 Beat

#define VOLUME      100 

/**
 * @brief Piezo Driver play Imperial march function.
 * @details This function is used to play Imperial march on the buzzer.
 * @return Nothing.
 * @note None.
 */
static void imperial_march( );

void application_init ( void ) 
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    piezodriver_cfg_t piezodriver_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.
    piezodriver_cfg_setup( &piezodriver_cfg );
    PIEZODRIVER_MAP_MIKROBUS( piezodriver_cfg, MIKROBUS_1 );
    if ( PWM_ERROR == piezodriver_init( &piezodriver, &piezodriver_cfg ) )
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    
    if ( PIEZODRIVER_ERROR == piezodriver_default_cfg ( &piezodriver ) )
    {
        log_error( &logger, " Default configuration." );
        for ( ; ; );
    }
    
    log_info( &logger, " Application Task " );
}

void application_task ( void ) 
{
    log_printf( &logger, "Playing the Imperial March melody ...\r\n" );
    imperial_march( ); 
    // 10 seconds delay
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
}

int main ( void ) 
{
    /* Do not remove this line or clock might not be set correctly. */
    #ifdef PREINIT_SUPPORTED
    preinit();
    #endif
    
    application_init( );
    
    for ( ; ; ) 
    {
        application_task( );
    }

    return 0;
}

static void imperial_march( ) 
{
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_A6, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_A6, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_A6, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_F6, VOLUME, E + S );
    Delay_ms ( 1 + E + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_C7, VOLUME, S );
    Delay_ms ( 1 + S );
    
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_A6, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_F6, VOLUME, E + S );
    Delay_ms ( 1 + E + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_C7, VOLUME, S );
    Delay_ms ( 1 + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_A6, VOLUME, H );
    Delay_ms ( 1 + H );
    
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_E7, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_E7, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_E7, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_F7, VOLUME, E + S );
    Delay_ms ( 1 + E + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_C7, VOLUME, S );
    Delay_ms ( 1 + S );
    
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_AB6, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_F6, VOLUME, E + S );
    Delay_ms ( 1 + E + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_C7, VOLUME, S );
    Delay_ms ( 1 + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_A6, VOLUME, H );
    Delay_ms ( 1 + H );
    
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_A7, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_A6, VOLUME, E + S );
    Delay_ms ( 1 + E + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_A6, VOLUME, S );
    Delay_ms ( 1 + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_A7, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_AB7, VOLUME, E + S );
    Delay_ms ( 1 + E + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_G7, VOLUME, S );
    Delay_ms ( 1 + S );
    
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_GB7, VOLUME, S );
    Delay_ms ( 1 + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_E7, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_F7, VOLUME, E );
    Delay_ms ( 1 + E );
    Delay_ms ( 1 + E );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_BB6, VOLUME, E );
    Delay_ms ( 1 + E );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_EB7, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_D7, VOLUME, E + S );
    Delay_ms ( 1 + E + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_DB7, VOLUME, S );
    Delay_ms ( 1 + S );
    
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_C7, VOLUME, S );
    Delay_ms ( 1 + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_B6, VOLUME, S );
    Delay_ms ( 1 + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_C7, VOLUME, E );
    Delay_ms ( 1 + E );
    Delay_ms ( 1 + E );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_F6, VOLUME, E );
    Delay_ms ( 1 + E );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_AB6, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_F6, VOLUME, E + S );
    Delay_ms ( 1 + E + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_A6, VOLUME, S );
    Delay_ms ( 1 + S );
    
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_C7, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_A6, VOLUME, E + S );
    Delay_ms ( 1 + E + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_C7, VOLUME, S );
    Delay_ms ( 1 + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_E7, VOLUME, H );
    Delay_ms ( 1 + H );
    
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_A7, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_A6, VOLUME, E + S );
    Delay_ms ( 1 + E + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_A6, VOLUME, S );
    Delay_ms ( 1 + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_A7, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_AB7, VOLUME, E + S );
    Delay_ms ( 1 + E + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_G7, VOLUME, S );
    Delay_ms ( 1 + S );
    
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_GB7, VOLUME, S );
    Delay_ms ( 1 + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_E7, VOLUME, S );
    Delay_ms ( 1 + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_F7, VOLUME, E );
    Delay_ms ( 1 + E );
    Delay_ms ( 1 + E );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_BB6, VOLUME, E );
    Delay_ms ( 1 + E );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_EB7, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_D7, VOLUME, E + S );
    Delay_ms ( 1 + E + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_DB7, VOLUME, S );
    Delay_ms ( 1 + S );
    
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_C7, VOLUME, S );
    Delay_ms ( 1 + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_B6, VOLUME, S );
    Delay_ms ( 1 + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_C7, VOLUME, E );
    Delay_ms ( 1 + E );
    Delay_ms ( 1 + E );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_F6, VOLUME, E );
    Delay_ms ( 1 + E );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_AB6, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_F6, VOLUME, E + S );
    Delay_ms ( 1 + E + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_C7, VOLUME, S );
    Delay_ms ( 1 + S );
    
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_A6, VOLUME, Q );
    Delay_ms ( 1 + Q );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_F6, VOLUME, E + S );
    Delay_ms ( 1 + E + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_C7, VOLUME, S );
    Delay_ms ( 1 + S );
    piezodriver_play_sound(&piezodriver, PIEZODRIVER_NOTE_AB6, VOLUME, H );
    Delay_ms ( 1 + H );
}

// ------------------------------------------------------------------------ END