Intermediate
30 min
0

Create notification systems for various events or alarms with PIC18F85K22 and PAM8904

Alerts that demand attention: Next-gen buzzers that redefine signaling

BUZZ 3 Click with Fusion for PIC v8

Published Oct 22, 2023

Click board™

BUZZ 3 Click

Development board

Fusion for PIC v8

Compiler

NECTO Studio

MCU

PIC18F85K22

Step into the future of audio signaling with next-gen buzzers and witness their transformative impact across a wide spectrum of industries and settings

A

A

Hardware Overview

How does it work?

Buzz 3 Click is based on the PAM8904, a piezo-sounder driver with an integrated Multi-Mode charge pump boost converter from Diodes Incorporated. The PAM8904 is a switching driver with a multi-mode charge pump for piezo-sounder. Operating at a fixed frequency of 1MHz, the PAM8904 can drive a sounder load of up to 15nF, providing a 9V output with a minimal component footprint. For adjusting the piezoelectric sounder sound volume, the charge pump can operate in 1x, 2x, or 3x mode. It features thermal shutdown, over-current and voltage protection, and under-voltage lock-out and provides a small inrush current, low EMI, and high efficiency. The sounder driver helps to keep current consumption low and battery life long by employing built-in automatic shutdown and wake-up functions. For example, active current consumption is just 300µA in 1x mode, with an

input voltage of 3V, input frequency of 4kHz, and driving a 15nF piezo. In shutdown mode, the quiescent current is less than 1µA. The Charge Pump Mode pins, EN1 and EN2, are used to set the charge pump into mode 1xVDD, 2xVDD, 3xVDD, or they can be used to put the PAM8904 into a forced low-current Shutdown Mode. The device enters the Normal Operation Mode when one or both EN pins are pulled high. Once the PAM8904 senses a valid signal on the DIN pin, the charge pump will start and provide the desired voltage on the VOUT pin, and the output drive lines labeled as VO1 and VO2 will become active after a period of between 270μs and 350μs depending on the selected Mode. If a valid signal on the DIN line disappears, the PAM8904 will detect that disappearance and then wait 42ms to ensure its disappearance. If, even after this period, there is no valid signal on the DIN line, the PAM8904 switches

to low-current Standby Mode. Buzz 3 Click establishes communication with MCU using several GPIO pins routed on the RST, AN, and PWM pins of the mikroBUS™ socket labeled EN1, EN2, and DIN. There is also a jumper setting labeled as INT BUZZ used to choose between single-ended and differential load configurations and between driving either the onboard piezo-sounder or an externally connected piezo-sounder. 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.

BUZZ 3 Click hardware overview image

Features overview

Development board

Fusion for PIC v8 is a development board specially designed for the needs of rapid development of embedded applications. It supports a wide range of microcontrollers, such as different PIC, dsPIC, PIC24, and PIC32 MCUs regardless of their number of pins, and a broad set of unique functions, such as the first-ever embedded debugger/programmer over WiFi. The development board is well organized and designed so that the end-user has all the necessary elements, such as switches, buttons, indicators, connectors, and others, in one place. Thanks to innovative manufacturing technology, Fusion for PIC v8 provides a fluid and immersive working experience, allowing access anywhere and under any

circumstances at any time. Each part of the Fusion for PIC v8 development board contains the components necessary for the most efficient operation of the same board. In addition to the advanced integrated CODEGRIP programmer/debugger module, which offers many valuable programming/debugging options and seamless integration with the Mikroe software environment, the board also includes a clean and regulated power supply module for the development board. It can use a wide range of external power sources, including a battery, an external 12V power supply, and a power source via the USB Type-C (USB-C) connector. Communication options such as USB-UART, USB

HOST/DEVICE, CAN (on the MCU card, if supported), and Ethernet are also included, including the well-established mikroBUS™ standard, a standardized socket for the MCU card (SiBRAIN standard), and two display options (graphical and character-based LCD). Fusion for PIC v8 is an integral part of the Mikroe ecosystem for rapid development. Natively supported by Mikroe software tools, it covers many aspects of prototyping and development thanks to a considerable number of different Click boards™ (over a thousand boards), the number of which is growing every day.

Fusion for PIC v8 horizontal image

Microcontroller Overview

MCU Card / MCU

default

Type

8th Generation

Architecture

PIC

MCU Memory (KB)

32

Silicon Vendor

Microchip

Pin count

80

RAM (Bytes)

2048

Used MCU Pins

mikroBUS™ mapper

Charge Pump Mode Pin 1
PA0
AN
Charge Pump Mode Pin 2
PJ4
RST
NC
NC
CS
NC
NC
SCK
NC
NC
MISO
NC
NC
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
PWM Signal
PE0
PWM
NC
NC
INT
NC
NC
TX
NC
NC
RX
NC
NC
SCL
NC
NC
SDA
Power Supply
5V
5V
Ground
GND
GND
1

Take a closer look

Schematic

BUZZ 3 Click Schematic schematic

Step by step

Project assembly

Fusion for PIC v8 front image hardware assembly

Start by selecting your development board and Click board™. Begin with the Fusion for PIC v8 as your development board.

Fusion for PIC v8 front image hardware assembly
GNSS2 Click front image hardware assembly
SiBRAIN for PIC32MZ1024EFK144 front image hardware assembly
GNSS2 Click complete accessories setup image hardware assembly
v8 SiBRAIN Access MB 1 - upright/background hardware assembly
Necto image step 2 hardware assembly
Necto image step 3 hardware assembly
Necto image step 4 hardware assembly
NECTO Compiler Selection Step Image hardware assembly
NECTO Output Selection Step Image hardware assembly
Necto image step 6 hardware assembly
Necto image step 7 hardware assembly
Necto image step 8 hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Necto PreFlash Image hardware assembly

Track your results in real time

Application Output

After pressing the "FLASH" button on the left-side panel, it is necessary to open the UART terminal to display the achieved results. By clicking on the Tools icon in the right-hand panel, multiple different functions are displayed, among which is the UART Terminal. Click on the offered "UART Terminal" icon.

UART Application Output Step 1

Once the UART terminal is opened, the window takes on a new form. At the top of the tab are two buttons, one for adjusting the parameters of the UART terminal and the other for connecting the UART terminal. The tab's lower part is reserved for displaying the achieved results. Before connecting, the terminal has a Disconnected status, indicating that the terminal is not yet active. Before connecting, it is necessary to check the set parameters of the UART terminal. Click on the "OPTIONS" button.

UART Application Output Step 2

In the newly opened UART Terminal Options field, we check if the terminal settings are correct, such as the set port and the Baud rate of UART communication. If the data is not displayed properly, it is possible that the Baud rate value is not set correctly and needs to be adjusted to 115200. If all the parameters are set correctly, click on "CONFIGURE".

UART Application Output Step 3

The next step is to click on the "CONNECT" button, after which the terminal status changes from Disconnected to Connected in green, and the data is displayed in the Received data field.

UART Application Output Step 4

Software Support

Library Description

This library contains API for BUZZ 3 Click driver.

Key functions:

  • buzz3_pwm_start - This function starts the PWM module output

  • buzz3_set_gain_operating_mode - The function set gain operating mode of the PAM8904 piezo sounder driver with integrated charge pump boost converter on Buzz 3 Click

  • buzz3_play_sound - This function plays sound on buzzer

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 Buzz3 Click example
 *
 * # Description
 * This example demonstrates the use of Buzz 3 click boards with PAM8904 for play the Imperial March. 
 * PAM8904 is piezo-sounder driver with an integrated Multi-Mode charge pump boost converter from Diodes Incorporated. 
 *
 * The demo application is composed of two sections :
 *
 * ## Application Init
 * Initializes GPIO, set AN and RST pin as outputs, begins to write a log. 
 * Initialization driver enables - GPIO and configures the appropriate MCU pin for 
 * sound generation, also write log.
 *
 * ## Application Task
 * Plays the Imperial March melody. Also logs an appropriate message on the USB UART.
 *
 * Additional Functions :
 * - void buzz3_melody( void ) - This function plays the Imperial March melody.
 * 
 * @note
 * The minimal PWM Clock frequency required for this example is the frequency of tone C6 - 1047 Hz. 
 * So, 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 the certain architectures
 * in order to get the required PWM clock frequency.
 *
 * @author Jelena Milosavljevic
 *
 */

#include "board.h"
#include "log.h"
#include "buzz3.h"

#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
                      

static buzz3_t buzz3;
static log_t logger;

void buzz3_melody ( void ) {
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_A6, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_A6, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_A6, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_F6, E + S );
    Delay_ms( 1 + E + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_C7, S );
    Delay_ms( 1 + S );
    
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_A6, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_F6, E + S );
    Delay_ms( 1 + E + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_C7, S );
    Delay_ms( 1 + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_A6, H );
    Delay_ms( 1 + H );
    
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_E7, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_E7, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_E7, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_F7, E + S );
    Delay_ms( 1 + E + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_C7, S );
    Delay_ms( 1 + S );
    
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_Ab6, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_F6, E + S );
    Delay_ms( 1 + E + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_C7, S );
    Delay_ms( 1 + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_A6, H );
    Delay_ms( 1 + H );
    
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_A7, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_A6, E + S );
    Delay_ms( 1 + E + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_A6, S );
    Delay_ms( 1 + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_A7, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_Ab7, E + S );
    Delay_ms( 1 + E + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_G7, S );
    Delay_ms( 1 + S );
    
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_Gb7, S );
    Delay_ms( 1 + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_E7, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_F7, E );
    Delay_ms( 1 + E );
    Delay_ms( 1 + E );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_Bb6, E );
    Delay_ms( 1 + E );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_Eb7, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_D7, E + S );
    Delay_ms( 1 + E + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_Db7, S );
    Delay_ms( 1 + S );
    
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_C7, S );
    Delay_ms( 1 + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_B6, S );
    Delay_ms( 1 + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_C7, E );
    Delay_ms( 1 + E );
    Delay_ms( 1 + E );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_F6, E );
    Delay_ms( 1 + E );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_Ab6, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_F6, E + S );
    Delay_ms( 1 + E + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_A6, S );
    Delay_ms( 1 + S );
    
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_C7, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_A6, E + S );
    Delay_ms( 1 + E + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_C7, S );
    Delay_ms( 1 + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_E7, H );
    Delay_ms( 1 + H );
    
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_A7, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_A6, E + S );
    Delay_ms( 1 + E + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_A6, S );
    Delay_ms( 1 + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_A7, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_Ab7, E + S );
    Delay_ms( 1 + E + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_G7, S );
    Delay_ms( 1 + S );
    
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_Gb7, S );
    Delay_ms( 1 + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_E7, S );
    Delay_ms( 1 + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_F7, E );
    Delay_ms( 1 + E );
    Delay_ms( 1 + E );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_Bb6, E );
    Delay_ms( 1 + E );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_Eb7, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_D7, E + S );
    Delay_ms( 1 + E + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_Db7, S );
    Delay_ms( 1 + S );
    
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_C7, S );
    Delay_ms( 1 + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_B6, S );
    Delay_ms( 1 + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_C7, E );
    Delay_ms( 1 + E );
    Delay_ms( 1 + E );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_F6, E );
    Delay_ms( 1 + E );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_Ab6, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_F6, E + S );
    Delay_ms( 1 + E + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_C7, S );
    Delay_ms( 1 + S );
    
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_A6, Q );
    Delay_ms( 1 + Q );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_F6, E + S );
    Delay_ms( 1 + E + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_C7, S );
    Delay_ms( 1 + S );
    buzz3_play_sound(&buzz3, BUZZ3_NOTE_Ab6, H );
    Delay_ms( 1 + H );
}

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

    buzz3_cfg_setup( &buzz3_cfg );
    BUZZ3_MAP_MIKROBUS( buzz3_cfg, MIKROBUS_1 );
    err_t init_flag  = buzz3_init( &buzz3, &buzz3_cfg );
    if ( PWM_ERROR == init_flag ) 
    {
        log_error( &logger, " Application Init Error. " );
        log_info( &logger, " Please, run program again... " );

        for ( ; ; );
    }

    buzz3_default_cfg ( &buzz3 );
    buzz3_set_duty_cycle ( &buzz3, 0.0 );
    log_printf( &logger, "---------------------\r\n" );
    log_printf( &logger, " Set the gain to x1  \r\n" );
    log_printf( &logger, "---------------------\r\n" );
    Delay_ms( 100 );
    buzz3_pwm_start( &buzz3 );
    buzz3_set_gain_operating_mode( &buzz3, BUZZ3_OP_MODE_GAIN_x1 );

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

void application_task ( void ) 
{
    log_printf( &logger, "   Play the music    \r\n" );
    buzz3_melody( );
    log_printf( &logger, "---------------------\r\n" );
    Delay_ms( 1000 );
}

void main ( void )  
{
    application_init( );

    for ( ; ; ) 
    {
        application_task( );
    }
}

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

Additional Support

Resources