digipot9  2.0.0.0
Main Page

DIGI POT 9 click

<PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU>

[click Product page](<CLICK_PRODUCT_PAGE_LINK>)


Click library

  • Author : Stefan Filipovic
  • Date : Jun 2021.
  • Type : SPI type

Software Support

We provide a library for the DIGIPOT9 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for DIGIPOT9 Click driver.

Standard key functions :

Example key functions :

  • digipot9_generic_write This function writes two data bytes to the selected command and address by using SPI serial interface.
    err_t digipot9_generic_write ( digipot9_t *ctx, uint8_t command, uint8_t address, uint16_t data_in );
  • digipot9_generic_read This function reads two data bytes from the selected command and address by using SPI serial interface.
    err_t digipot9_generic_read ( digipot9_t *ctx, uint8_t command, uint8_t address, uint16_t *data_out );
  • digipot9_set_wiper_1 This function sets wiper 1 to desired value.
    err_t digipot9_set_wiper_1 ( digipot9_t *ctx, uint16_t data_in );

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.

void application_init ( void )
{
log_cfg_t log_cfg;
digipot9_cfg_t digipot9_cfg;
// Logger initialization.
LOG_MAP_USB_UART( log_cfg );
log_cfg.level = LOG_LEVEL_DEBUG;
log_cfg.baud = 115200;
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 " );
}

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.

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 );
}
}

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.DIGIPOT9

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. The terminal available in all MikroElektronika compilers, or any other terminal application of your choice, can be used to read the message.


digipot9_default_cfg
void digipot9_default_cfg(digipot9_t *ctx)
DIGI POT 9 default configuration function.
DIGIPOT9_WIPER_FULL_SCALE
#define DIGIPOT9_WIPER_FULL_SCALE
DIGI POT 9 Wiper setting.
Definition: digipot9.h:113
digipot9_generic_write
err_t digipot9_generic_write(digipot9_t *ctx, uint8_t command, uint8_t address, uint16_t data_in)
DIGI POT 9 data writing function.
digipot9_set_wiper_1
err_t digipot9_set_wiper_1(digipot9_t *ctx, uint16_t data_in)
DIGI POT 9 Set wiper 1 function.
digipot9_init
err_t digipot9_init(digipot9_t *ctx, digipot9_cfg_t *cfg)
DIGI POT 9 initialization function.
digipot9_generic_read
err_t digipot9_generic_read(digipot9_t *ctx, uint8_t command, uint8_t address, uint16_t *data_out)
DIGI POT 9 data reading function.
digipot9_set_wiper_2
err_t digipot9_set_wiper_2(digipot9_t *ctx, uint16_t data_in)
DIGI POT 9 Set wiper 2 function.
application_task
void application_task(void)
Definition: main.c:58
digipot9_t
DIGI POT 9 Click context object.
Definition: digipot9.h:150
digipot9_cfg_t
DIGI POT 9 Click configuration object.
Definition: digipot9.h:170
DIGIPOT9_MAP_MIKROBUS
#define DIGIPOT9_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: digipot9.h:133
application_init
void application_init(void)
Definition: main.c:29
digipot9_cfg_setup
void digipot9_cfg_setup(digipot9_cfg_t *cfg)
DIGI POT 9 configuration object setup function.
DIGIPOT9_WIPER_ZERO_SCALE
#define DIGIPOT9_WIPER_ZERO_SCALE
Definition: digipot9.h:115