pot 2.0.0.0
Main Page

POT click

‍Click board with the accurate selectable reference voltage output.

click Product page


Click library

  • Author : MikroE Team
  • Date : nov 2019.
  • Type : ADC type

Software Support

We provide a library for the Pot 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 form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

‍This library contains API for Pot Click driver.

Standard key functions :

  • pot_cfg_setup Config Object Initialization function.
    void pot_cfg_setup ( pot_cfg_t *cfg );
    void pot_cfg_setup(pot_cfg_t *cfg)
    POT configuration object setup function.
    Click configuration structure definition.
    Definition pot.h:89
  • pot_init Initialization function.
    err_t pot_init ( pot_t *ctx, pot_cfg_t *cfg );
    err_t pot_init(pot_t *ctx, pot_cfg_t *cfg)
    POT initialization function.
    Click ctx object definition.
    Definition pot.h:80

Example key functions :

  • pot_read_an_pin_value This function reads results of AD conversion of the AN pin.
    err_t pot_read_an_pin_value ( pot_t *ctx, uint16_t *data_out );
    err_t pot_read_an_pin_value(pot_t *ctx, uint16_t *data_out)
    POT read AN pin value function.
  • pot_read_an_pin_voltage This function reads results of AD conversion of the AN pin and converts them to proportional voltage level.
    err_t pot_read_an_pin_voltage ( pot_t *ctx, float *data_out );
    err_t pot_read_an_pin_voltage(pot_t *ctx, float *data_out)
    POT read AN pin voltage level function.

Examples Description

‍Click board with the accurate selectable reference voltage output.

The demo application is composed of two sections :

Application Init

‍Performs logger and Click initialization.

void application_init ( void )
{
log_cfg_t log_cfg;
pot_cfg_t pot_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
pot_cfg_setup( &pot_cfg );
POT_MAP_MIKROBUS( pot_cfg, MIKROBUS_1 );
if ( ADC_ERROR == pot_init( &pot, &pot_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}
#define POT_MAP_MIKROBUS(cfg, mikrobus)
Definition pot.h:65
void application_init(void)
Definition main.c:32

Application Task

‍Reads and displays on the USB UART the voltage level measured from AN pin.

void application_task ( void )
{
float voltage = 0;
if ( POT_OK == pot_read_an_pin_voltage ( &pot, &voltage ) )
{
log_printf( &logger, " AN Voltage : %.3f[V]\r\n\n", voltage );
Delay_ms ( 1000 );
}
}
@ POT_OK
Definition pot.h:103
void application_task(void)
Definition main.c:62

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Pot

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.