Speak Numbers with Potentiometer Solution

/*
 * Solution Name: Speak Numbers With Potentiometer
 *
 * Description:
 * This embedded solution provides an interactive audio experience by linking
 * analog input from a potentiometer to voice prompts played through a speaker.
 * The position of the potentiometer on the **POT 4 Click** is read and mapped
 * to one of six pre-recorded digits (1 to 6), which are then played through
 * the **Speaker 2 Click**.
 *
 * A press of the onboard button on the POT 4 Click triggers a distinct **FAST BEEP**
 * as an auditory feedback event. The system continuously monitors analog voltage
 * levels, converts them to percentages, and logs all activity through the UART
 * terminal for transparency and debugging.
 *
 * The system utilizes the following Click boards:
 *   - **Speaker 2 Click**: Plays pre-recorded audio via SPI interface.
 *   - **POT 4 Click**: Measures analog voltage from a potentiometer and provides
 *     digital input via a button pin.
 *
 * The `application_init` function initializes both Click boards and configures
 * the SPI and ADC communication channels. It prepares the audio system for
 * voice playback and the potentiometer for analog-to-percentage conversion.
 *
 * The `application_task` function continuously reads the potentiometer voltage,
 * converts it to a percentage, and maps it to a digit index. When the value
 * changes, the matching voice prompt is played. Additionally, if the button is
 * pressed, a FAST BEEP tone is played. All actions are logged via UART.
 *
 * Hardware Setup:
 *   - **MIKROBUS_1**: Speaker 2 Click (SPI audio playback)
 *   - **MIKROBUS_2**: POT 4 Click (Analog voltage input + button pin)
 *
 * Key Features:
 *   - Audio-based digit representation via potentiometer position.
 *   - Voice output changes only when the knob is rotated into a new range.
 *   - Button-triggered beep functionality.
 *   - UART terminal logging for diagnostics and playback tracking.
 *
 * Development Environment:
 *   - **NECTO Studio** ([link](https://www.mikroe.com/necto))
 *   - **mikroSDK v2.0** ([link](https://www.mikroe.com/mikrosdk))
 *   - MIKROE **Click boards** ([link](https://www.mikroe.com/click-boards))
 *
 * Author: Branko Jaksic
 * Date: April, 2025
 */

// ------------------------------------------------------------------- INCLUDES
#include "log.h"
#include "pot4.h"
#include "board.h"
#include "speaker2.h"

// ------------------------------------------------------------------ VARIABLES
// --- Driver Instances ---
static pot4_t pot4;                     // POT 4 Click driver object
static log_t logger;                    // Logger instance
static speaker2_t speaker2;             // Speaker 2 Click driver instance

// --- Speaker 2 Click Voice Map ---
const uint8_t voices[6] = {             // Voice prompt mappings (1-6)
    SPEAKER2_VP9_ONE,
    SPEAKER2_VP10_TWO,
    SPEAKER2_VP11_THREE,
    SPEAKER2_VP12_FOUR,
    SPEAKER2_VP13_FIVE,
    SPEAKER2_VP14_SIX
};

// ------------------------------------------------------ APPLICATION FUNCTIONS
void application_init ( void )
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    pot4_cfg_t pot4_cfg;  /**< Click config object. */
    speaker2_cfg_t speaker2_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 " );

    // Speaker 2 Click initialization.
    speaker2_cfg_setup( &speaker2_cfg );
    SPEAKER2_MAP_MIKROBUS( speaker2_cfg, MIKROBUS_1 );
    if ( SPI_MASTER_ERROR == speaker2_init( &speaker2, &speaker2_cfg ) )
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }

    if ( SPEAKER2_ERROR == speaker2_default_cfg ( &speaker2 ) )
    {
        log_error( &logger, " Default configuration." );
        for ( ; ; );
    }

    // POT 4 Click initialization.
    pot4_cfg_setup( &pot4_cfg );
    POT4_MAP_MIKROBUS( pot4_cfg, MIKROBUS_2 );
    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 " );
}

void application_task ( void )
{
    float voltage = 0;
    uint8_t pot_percent = 0;

    // Switch I2C communication to POT 4 Click
    i2c_master_set_slave_address(&pot4.i2c, pot4.slave_address);

    // Play a beep if POT had been pressed
    if ( !pot4_get_switch_pin ( &pot4 ) )
    {
        err_t beep_status = speaker2_play_voice( &speaker2,
                                                SPEAKER2_VP15_FAST_BEEP );
        log_printf( &logger, " Playing FAST BEEP: %s\r\n\n",
                    ( beep_status == SPEAKER2_OK ) ? "DONE" : "ERROR" );
    }

    // Read analog voltage from POT 4
    if ( POT4_OK == pot4_read_voltage( &pot4, &voltage ) )
    {
        pot_percent = ( uint8_t ) pot4_convert_voltage_to_percents( &pot4, voltage );
        log_printf( &logger, " Potentiometer : %u %%\r\n", pot_percent );

        // Map percentage [0-100] into 6 levels (0-5)
        uint8_t index = ( pot_percent * 6 ) / 101;  // Ensure max 5

        // Play voice for the digit
        err_t status = speaker2_play_voice( &speaker2, voices[ index ] );
        log_printf( &logger, " Playing voice %d: %s\r\n\n",
                    index + 1, ( status == SPEAKER2_OK ) ? "DONE" : "ERROR" );
    }
}

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