pot4

---

POT 4 Click

POT 4 Click demo application is developed using the NECTO Studio, ensuring compatibility with mikroSDK's open-source libraries and tools. Designed for plug-and-play implementation and testing, the demo is fully compatible with all development, starter, and mikromedia boards featuring a mikroBUS™ socket.

---

Click Library

• Author : Stefan Filipovic
• Date : Oct 2022.
• Type : ADC/I2C type

Software Support

Example Description

This example demonstrates the use of POT 4 Click board by reading and displaying the potentiometer position.

Example Libraries

• MikroSDK.Board
• MikroSDK.Log
• Click.POT4

Example Key Functions

• pot4_cfg_setup Config Object Initialization function.

void pot4_cfg_setup ( pot4_cfg_t *cfg );

• pot4_init Initialization function.

err_t pot4_init ( pot4_t *ctx, pot4_cfg_t *cfg );

• pot4_get_switch_pin This function returns the switch (SW) pin logic state.

uint8_t pot4_get_switch_pin ( pot4_t *ctx );

• pot4_read_voltage This function reads raw ADC value and converts it to proportional voltage level.

err_t pot4_read_voltage ( pot4_t *ctx, float *voltage );

• pot4_convert_voltage_to_percents This function converts analog voltage to potentiometer position in percents.

uint8_t pot4_convert_voltage_to_percents ( pot4_t *ctx, float voltage );

Application Init

Initializes the driver and logger.

void application_init ( void )
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    pot4_cfg_t pot4_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.
    pot4_cfg_setup( &pot4_cfg );
    POT4_MAP_MIKROBUS( pot4_cfg, MIKROBUS_1 );
    err_t init_flag = pot4_init( &pot4, &pot4_cfg );
    if ( ( ADC_ERROR == init_flag ) || ( I2C_MASTER_ERROR == init_flag ) )
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    
    log_info( &logger, " Application Task " );
}

Application Task

Reads and displays on the USB UART the potentiometer position in forms of voltage and percents once per second only when the potentiometer switch is active.

void application_task ( void )
{
    if ( !pot4_get_switch_pin ( &pot4 ) )
    {
        float voltage = 0;
        if ( POT4_OK == pot4_read_voltage ( &pot4, &voltage ) ) 
        {
            log_printf( &logger, " AN Voltage : %.3f V\r\n", voltage );
            log_printf( &logger, " Potentiometer : %u %%\r\n\n", 
                        ( uint16_t ) pot4_convert_voltage_to_percents ( &pot4, voltage ) );
            Delay_ms ( 1000 );
        }
    }
}

Application Output

This Click board can be interfaced and monitored in two ways:

• Application Output - Use the "Application Output" window in Debug mode for real-time data monitoring. Set it up properly by following this tutorial.
• UART Terminal - Monitor data via the UART Terminal using a USB to UART converter. For detailed instructions, check out this tutorial.

Additional Notes and Information

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.

---