Intermediate
30 min

Build a various waveform signal generator with AD9837 and ATmega328P

Waves of Fun

Waveform 3 Click with Arduino UNO Rev3

Published Feb 14, 2024

Click board™

Waveform 3 Click

Dev. board

Arduino UNO Rev3

Compiler

NECTO Studio

MCU

ATmega328P

Design and develop a waveform generator that produces specific waveforms to simulate sensor inputs for testing and validation purposes

A

A

Hardware Overview

How does it work?

Waveform 3 Click is based on the AD9837, a fully integrated direct digital synthesis (DDS) device capable of producing high-performance sine and triangular wave outputs from Analog Devices. It also has an internal comparator that allows the creation of a square wave for clock generation. With 28-bit wide frequency registers, the output frequency and phase are software-programmable, allowing easy tuning. The AD9837 is capable of a broad range of complex and straightforward modulation schemes fully implemented in the digital domain, allowing the accurate and precise realization of complex modulation algorithms using DSP techniques. The internal circuitry of the AD9837 consists of a numerically controlled oscillator (NCO), frequency and phase modulators, SIN

ROM, a DAC, a comparator, and a regulator. Also, it has a high-performance, onboard 16MHz trimmed general oscillator that can serve as the master clock for the AD9837 achieving a resolution of 0.06Hz. The AD9837 offers a variety of outputs available from an onboard output SMA connector. The various output options (sine, triangular, and square wave) from the AD9837 make this Click board™ suitable for various applications, including modulation applications. It is also ideal for signal generator applications, and with its low current consumption, it is also suitable for applications in which it can serve as a local oscillator. The Waveform 3 Click communicates with MCU using the 3-Wire SPI serial interface compatible with standard SPI, QSPI™, MICROWIRE™, and DSP interface

standards and operates at clock rates up to 40MHz. Besides, it possesses additional functionality, such as a programmable Sleep function that allows external control of the Power-Down mode and Reset function, which resets the appropriate internal registers to 0 to provide an analog output of mid-scale. Remembering that the reset function does not reset the phase, frequency, or control registers is essential. This Click board™ can only be operated with a 3.3V logic voltage level. The board must perform appropriate logic voltage level conversion before using MCUs with different logic levels. However, the Click board™ comes equipped with a library containing functions and an example code that can be used as a reference for further development.

Waveform 3 Click top side image
Waveform 3 Click lateral side image
Waveform 3 Click bottom side image

Features overview

Development board

Arduino UNO is a versatile microcontroller board built around the ATmega328P chip. It offers extensive connectivity options for various projects, featuring 14 digital input/output pins, six of which are PWM-capable, along with six analog inputs. Its core components include a 16MHz ceramic resonator, a USB connection, a power jack, an

ICSP header, and a reset button, providing everything necessary to power and program the board. The Uno is ready to go, whether connected to a computer via USB or powered by an AC-to-DC adapter or battery. As the first USB Arduino board, it serves as the benchmark for the Arduino platform, with "Uno" symbolizing its status as the

first in a series. This name choice, meaning "one" in Italian, commemorates the launch of Arduino Software (IDE) 1.0. Initially introduced alongside version 1.0 of the Arduino Software (IDE), the Uno has since become the foundational model for subsequent Arduino releases, embodying the platform's evolution.

Arduino UNO Rev3 double side image

Microcontroller Overview

MCU Card / MCU

default

Architecture

AVR

MCU Memory (KB)

32

Silicon Vendor

Microchip

Pin count

28

RAM (Bytes)

2048

You complete me!

Accessories

Click Shield for Arduino UNO has two proprietary mikroBUS™ sockets, allowing all the Click board™ devices to be interfaced with the Arduino UNO board without effort. The Arduino Uno, a microcontroller board based on the ATmega328P, provides an affordable and flexible way for users to try out new concepts and build prototypes with the ATmega328P microcontroller from various combinations of performance, power consumption, and features. The Arduino Uno has 14 digital input/output pins (of which six can be used as PWM outputs), six analog inputs, a 16 MHz ceramic resonator (CSTCE16M0V53-R0), a USB connection, a power jack, an ICSP header, and reset button. Most of the ATmega328P microcontroller pins are brought to the IO pins on the left and right edge of the board, which are then connected to two existing mikroBUS™ sockets. 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 Arduino UNO board with our Click Shield for Arduino UNO, you can access hundreds of Click boards™, working with 3.3V or 5V logic voltage levels.

Click Shield for Arduino UNO accessories 1 image

Used MCU Pins

mikroBUS™ mapper

NC
NC
AN
NC
NC
RST
SPI Chip Select
PB2
CS
SPI Clock
PB5
SCK
NC
NC
MISO
SPI Data IN
PB3
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
NC
NC
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

Waveform 3 Click Schematic schematic

Step by step

Project assembly

Click Shield for Arduino UNO front image hardware assembly

Start by selecting your development board and Click board™. Begin with the Arduino UNO Rev3 as your development board.

Click Shield for Arduino UNO front image hardware assembly
Arduino UNO Rev3 front image hardware assembly
Charger 27 Click front image hardware assembly
Prog-cut hardware assembly
Charger 27 Click complete accessories setup image hardware assembly
Board mapper by product8 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
Arduino UNO 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

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 Waveform 3 Click driver.

Key functions:

  • waveform3_cfg_setup - Config Object Initialization function.
  • waveform3_init - Initialization function.
  • waveform3_default_cfg - Click Default Configuration 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 Waveform3 Click example
 *
 * # Description
 * This demo app shows the basic capabilities of Waveform 3
 * click board. First, the sinusoidal wave is incremented
 * to targeted frequency for visually pleasing introduction
 * after which it changes between 4 modes of output.
 *
 * The demo application is composed of two sections :
 *
 * ## Application Init
 * Application initializes the UART LOG and SPI drivers,
 * resets the device and sets frequency and phase shift to
 * default values. In the end, the mode is set with the 
 * preferred freq and phase channel.
 *
 * ## Application Task
 * Task commences with the start frequency rising up to
 * the targeted one. When it reaches desired frequency,
 * the mode changes every 5 seconds which includes: 
 * sinusoidal, triangular, DAC divided by 2 and DAC
 * outputs respectively.
 *
 * *note:*
 * Waveform 3 click might not provide a high enough peak to peak signal on higher frequencies.
 * The user can freely implement custom buffer for the output stage.
 * Special thanks to my esteemed co-worker Nenad Filipovic for support during firmware development.
 *
 * @author Stefan Nikolic
 *
 */

#include "board.h"
#include "log.h"
#include "waveform3.h"

static waveform3_t waveform3;
static log_t logger;

static uint32_t start_frequency = 100;
static uint32_t rising_factor = 10;
static uint32_t target_frequency = 10000;

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

    waveform3_cfg_setup( &waveform3_cfg );
    WAVEFORM3_MAP_MIKROBUS( waveform3_cfg, MIKROBUS_1 );
    err_t init_flag  = waveform3_init( &waveform3, &waveform3_cfg );
    if ( init_flag == SPI_MASTER_ERROR ) {
        log_error( &logger, " Application Init Error. " );
        log_info( &logger, " Please, run program again... " );

        for ( ; ; );
    }

    waveform3_default_cfg( &waveform3 );
    Delay_ms( 500 );
    log_info( &logger, " Application Task " );
    waveform3_set_mode( &waveform3, WAVEFORM3_CFG_MODE_SINUSOIDAL, WAVEFORM3_CFG_FREQ_REG0, WAVEFORM3_CFG_PHASE_REG0 );
}

void application_task ( void ) {
    uint8_t cfg_mode_switch;
    
    if ( start_frequency < target_frequency ) {
        if ( start_frequency / rising_factor < 100 ) {
            start_frequency += rising_factor;
            waveform3_set_freq( &waveform3, start_frequency, WAVEFORM3_CFG_FREQ_REG0 );
            Delay_ms( 5 );
        } else {
            rising_factor += 10;
        }
    } else {
        for ( cfg_mode_switch = 0 ; cfg_mode_switch < 4 ; cfg_mode_switch++ ) {
        waveform3_set_mode( &waveform3, cfg_mode_switch, WAVEFORM3_CFG_FREQ_REG0, WAVEFORM3_CFG_PHASE_REG0 );
        Delay_ms( 5000 );
        }
    }
}

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.