Show & Speak Digits Via Knob Solution

/*
 * Solution Name: Show & Speak Digits Via Knob
 *
 * Description:
 * This interactive embedded solution combines LED matrix output, audio
 * playback, and analog input sensing for dynamic digit representation.
 * It utilizes the 16x12 G Click to display a digit (1?6), while the Speaker 2
 * Click plays the corresponding pre-recorded voice prompt. The digit
 * displayed and sound played are determined by the position of the
 * potentiometer on the POT 4 Click.
 * 
 * Users rotate the potentiometer, and the system reads the analog voltage,
 * converts it to a percentage (0?100%), and maps it to one of six digit/voice
 * pairs. A button press on the POT 4 Click triggers an additional fast beep
 * sound.
 *
 * The system utilizes the following Click boards:
 *   - **16x12 G Click**: 16x12 LED matrix that displays digits with ABM
 *     animation.
 *   - **Speaker 2 Click**: Plays SPI-triggered audio files such as spoken
 *     numbers and beeps.
 *   - **POT 4 Click**: Reads analog voltage from a potentiometer and converts
 *     it to percentage.
 *
 * The `application_init` function initializes all three Click boards, sets up 
 * the LED matrix (with global brightness and animation timing), prepares the 
 * Speaker 2 Click for playback, and initializes the analog voltage input logic
 * for the potentiometer.
 *
 * The `application_task` function continuously reads the potentiometer value 
 * as a percentage and maps that to a digit (1?6). It clears the display, shows 
 * the digit on the LED matrix, and plays the corresponding voice. If the onboard 
 * button is pressed, a FAST BEEP sound is triggered. All actions are logged via
 * UART.
 *
 * Hardware Setup:
 *   - **MIKROBUS_1**: 16x12 G Click (LED matrix digit output)
 *   - **MIKROBUS_2**: Speaker 2 Click (SPI audio output)
 *   - **MIKROBUS_3**: POT 4 Click (Analog potentiometer input with digital
 *     switch)
 *
 * Key Features:
 *   - Real-time digit-to-voice mapping based on analog input.
 *   - Interactive rotary control using potentiometer.
 *   - Button-triggered sound feedback with fast beep tone.
 *   - Dynamic digit rendering with smooth LED animation.
 *   - Full UART logging for audio events and potentiometer readings.
 *
 * 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 "c16x12.h"
#include "speaker2.h"

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

// --- 16x12 G Click Configuration ---
static c16x12_abm_t abm_1;              // ABM animation configuration
static uint8_t scroll_speed = 50;       // Scroll speed for animated text

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

// --- Display Digits & Label ---
const char digits[6] = { '1', '2', '3', '4', '5', '6' }; // Digits to display
char name[] = "Show & Speak Digits Via Knob";            // Welcome text

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

    // 16x12 Click initialization.
    c16x12_cfg_setup( &c16x12_cfg );
    C16X12_MAP_MIKROBUS( c16x12_cfg, MIKROBUS_1 );
    c16x12_init( &c16x12, &c16x12_cfg );

    c16x12g_device_reset( &c16x12 );
    Delay_ms ( 1000 );

    c16x12_default_cfg( &c16x12 );
    c16x12g_set_global_current_control( &c16x12, 255 );
    c16x12g_set_leds_mode( &c16x12, C16X12G_LED_MODE_ABM1 );

    abm_1.time_1     = C16X12G_ABM_T1_210MS;
    abm_1.time_2     = C16X12G_ABM_T2_0MS;
    abm_1.time_3     = C16X12G_ABM_T3_210MS;
    abm_1.time_4     = C16X12G_ABM_T4_0MS;
    abm_1.loop_begin = C16X12G_ABM_LOOP_BEGIN_T1;
    abm_1.loop_end   = C16X12G_ABM_LOOP_END_T3;
    abm_1.loop_times = C16X12G_ABM_LOOP_FOREVER;

    c16x12g_config_abm( &c16x12, C16X12G_ABM_NUM_1, &abm_1 );
    c16x12g_start_abm( &c16x12 );
    c16x12g_display_text( &c16x12, &name[ 0 ], sizeof(name) - 1, scroll_speed );

    c16x12g_config_abm( &c16x12, C16X12G_ABM_NUM_1, &abm_1 );
    c16x12g_start_abm( &c16x12 );

    // Speaker 2 Click initialization.
    speaker2_cfg_setup( &speaker2_cfg );
    SPEAKER2_MAP_MIKROBUS( speaker2_cfg, MIKROBUS_2 );
    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_3 );
    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

        // Switch I2C communication to 16x12 G Click
        i2c_master_set_slave_address(&c16x12.i2c, c16x12.slave_address);

        // Display digit on LED matrix
        c16x12g_clear_display( &c16x12 );
        c16x12g_display_byte( &c16x12, digits[ index ] );

        // 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