Achieve precise resistance adjustments with AD5235 and PIC32MZ1024EFH064

Ditch the traditional, embrace the digital

Published Aug 23, 2023

Click board™

DIGI POT 9 Click

Dev. board

PIC32MZ clicker

Compiler

NECTO Studio

MCU

PIC32MZ1024EFH064

By providing programmable resistance settings, our digital potentiometers find application in scenarios requiring remote adjustments, eliminating the need for manual intervention

Hardware Overview

How does it work?

DIGI POT 9 Click is based on the AD5235, a digital potentiometer that operates as a proper variable resistor from Analog Devices. The resistor wiper position is determined by the RDAC register contents, that act as a scratchpad register, allowing unlimited changes of resistance settings. The scratchpad register can be programmed with any position setting using the standard SPI serial interface by loading the 24-bit data word. The nominal resistance of the RDAC between terminal A and terminal B (RAB) is 250kΩ with 1024 positions (10-bit resolution). This Click board™ communicates with MCU through a standard SPI interface and operates at clock rates up to 10MHz, supporting the two most common SPI modes, SPI Mode 0 and 3. In the data word format, the first four bits are commands, the following four bits are addresses, and the last 16 bits are data. When a

specified value is set, this value can be stored in a corresponding EEMEM register for user-defined information such as memory data for other components, look-up table, or system identification information. During subsequent power-ups, the wiper setting is automatically loaded to that value. The device performs the same electronic adjustment function as a mechanical potentiometer with enhanced resolution, solid-state reliability, and superior low-temperature coefficient performance. An additional feature of this board represents optional write-protect and hardware override preset signals, routed to the PWM and RST pins of the mikroBUS™ socket, and labeled as WP and PR. The hardware overrides preset feature refreshes the scratchpad register with the current contents of the EEMEM register. Factory default

loads midscale until EEMEM is loaded with a new user-set value. On the other hand, the write-protect signal turns off any changes to the scratchpad register contents, except for the EEMEM setting. Therefore, write-protect can be used to provide a hardware EEMEM protection feature. Also, it uses a ready RDY pin, routed to the INT pin of the mikroBUS™ socket, used for EEMEM instruction completion indication. 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.

Features overview

Development board

PIC32MZ Clicker is a compact starter development board that brings the flexibility of add-on Click boards™ to your favorite microcontroller, making it a perfect starter kit for implementing your ideas. It comes with an onboard 32-bit PIC32MZ microcontroller with FPU from Microchip, a USB connector, LED indicators, buttons, a mikroProg connector, and a header for interfacing with external electronics. Thanks to its compact design with clear and easy-recognizable silkscreen markings, it provides a fluid and immersive working experience, allowing access anywhere and under

any circumstances. Each part of the PIC32MZ Clicker development kit contains the components necessary for the most efficient operation of the same board. In addition to the possibility of choosing the PIC32MZ Clicker programming method, using USB HID mikroBootloader, or through an external mikroProg connector for PIC, dsPIC, or PIC32 programmer, the Clicker board also includes a clean and regulated power supply module for the development kit. The USB Micro-B connection can provide up to 500mA of current, which is more than enough to operate all onboard

and additional modules. All communication methods that mikroBUS™ itself supports are on this board, including the well-established mikroBUS™ socket, reset button, and several buttons and LED indicators. PIC32MZ Clicker is an integral part of the Mikroe ecosystem, allowing you to create a new application in minutes. Natively supported by Mikroe software tools, it covers many aspects of prototyping thanks to a considerable number of different Click boards™ (over a thousand boards), the number of which is growing every day.

Microcontroller Overview

MCU Card / MCU

Architecture

PIC32

MCU Memory (KB)

1024

Silicon Vendor

Microchip

Pin count

RAM (Bytes)

524288

Used MCU Pins

mikroBUS™ mapper

Hardware Override Preset

RE5

RST

SPI Chip Select

RG9

SPI Clock

RG6

SCK

SPI Data OUT

RG7

MISO

SPI Data IN

RG8

MOSI

Power Supply

3.3V

Ground

GND

Write Protect

RB3

PWM

Data Ready

RB5

INT

SCL

SDA

Power Supply

Ground

GND

Take a closer look

Click board™ Schematic

Step by step

Project assembly

PIC32MZ clicker front image hardware assembly

Start by selecting your development board and Click board™. Begin with the PIC32MZ clicker as your development board.

GNSS2 Click front image hardware assembly

GNSS2 Click complete accessories setup image hardware assembly

Micro B Connector Clicker Access - upright/background hardware assembly

Flip&Click PIC32MZ 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 DIGI POT 9 Click driver.

Key functions:

digipot9_generic_write - This function writes two data bytes to the selected command and address by using SPI serial interface
digipot9_generic_read - This function reads two data bytes from the selected command and address by using SPI serial interface
digipot9_set_wiper_1 - This function sets wiper 1 to desired value

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 DIGIPOT9 Click example
 *
 * # Description
 * This example demonstrates the use of DIGI POT 9 Click board.
 *
 * The demo application is composed of two sections :
 *
 * ## Application Init
 * Initializes the driver and makes an initial log.
 *
 * ## Application Task
 * Iterates through the entire wiper range and sets both wipers to 
 * the iterator value once per second. 
 * The current wiper position will be displayed on the USB UART.
 *
 * @author Stefan Filipovic
 *
 */

#include "board.h"
#include "log.h"
#include "digipot9.h"

static digipot9_t digipot9;
static log_t logger;

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

    digipot9_cfg_setup( &digipot9_cfg );
    DIGIPOT9_MAP_MIKROBUS( digipot9_cfg, MIKROBUS_1 );
    err_t init_flag  = digipot9_init( &digipot9, &digipot9_cfg );
    if ( SPI_MASTER_ERROR == init_flag ) 
    {
        log_error( &logger, " Application Init Error. " );
        log_info( &logger, " Please, run program again... " );

        for ( ; ; );
    }

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

void application_task ( void ) 
{
    for ( uint16_t cnt = DIGIPOT9_WIPER_ZERO_SCALE; cnt <= DIGIPOT9_WIPER_FULL_SCALE; cnt += 50 )
    {
        digipot9_set_wiper_1 ( &digipot9, cnt );
        digipot9_set_wiper_2 ( &digipot9, cnt );
        log_printf( &logger, " * Wipers position set to %u *\r\n", cnt );
        
        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;
}

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