Switch-Triggered Voice Playback Solution

/*
 * Solution Name: Switch-Triggered Voice Playback Solution
 *
 * Description:
 * This embedded application maps rotary switch positions to pre-defined 
 * voice prompts using the Rotary Switch Click and Speaker 2 Click boards. 
 * As the user rotates the switch, the system dynamically triggers playback 
 * of corresponding voice files via the onboard speaker.
 *
 * The system utilizes the following Click boards:
 *   - Rotary Switch Click: A 256-position rotary encoder used to determine 
 *     the current user-selected value or range.
 *   - Speaker 2 Click: Plays pre-recorded voice prompts based on the selected 
 *     rotary switch position.
 *
 * The `application_init` function initializes both Click boards and sets up 
 * the UART logger for status tracking and debugging.
 *
 * The `application_task` function continuously reads the rotary switch 
 * position and maps it to one of seven logical zones using configurable 
 * macro definitions. Each zone is assigned to a specific voice file, played 
 * back via Speaker 2 Click. The mapping ensures flexibility and clean logic 
 * through macros like `ROTARY_SWITCH_MAX_RANGE`, `SPEAKER_2_NUM_SOUNDS`, 
 * and `SPEAKER_2_ZONE_WIDTH`.
 *
 * Hardware Setup:
 *   - MIKROBUS_1: Rotary Switch Click (Rotary input)
 *   - MIKROBUS_2: Speaker 2 Click (Voice playback)
 *
 * Key Features:
 *   - Rotary position-to-voice mapping via modular macros
 *   - Configurable number of voice zones and resolution
 *   - Dynamic playback of pre-recorded voice prompts
 *   - UART-based logging for rotary position and playback status
 *
 * Development Environment:
 *   - [NECTO Studio](https://www.mikroe.com/necto)
 *   - [mikroSDK v2.0](https://www.mikroe.com/mikrosdk) framework
 *   - MIKROE [Click boards](https://www.mikroe.com/click-boards) Add-ons
 *
 * Author: Branko Jaksic
 * Date: April, 2025
 */

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

// ------------------------------------------------------------- PRIVATE MACROS
#define ROTARY_SWITCH_MAX_RANGE 256
#define SPEAKER_2_NUM_SOUNDS    7
#define SPEAKER_2_ZONE_WIDTH ( ROTARY_SWITCH_MAX_RANGE / SPEAKER_2_NUM_SOUNDS )

// ------------------------------------------------------------------ VARIABLES
static log_t logger;
static speaker2_t speaker2;
static rotaryswitch_t rotaryswitch;

// ----------------------------------------------------- USER-DEFINED CONSTANTS
static const uint16_t speaker2_voice_map[SPEAKER_2_NUM_SOUNDS] = {
    SPEAKER2_VP9_ONE,
    SPEAKER2_VP10_TWO,
    SPEAKER2_VP11_THREE,
    SPEAKER2_VP12_FOUR,
    SPEAKER2_VP13_FIVE,
    SPEAKER2_VP14_SIX,
    SPEAKER2_VP15_FAST_BEEP
};

// ------------------------------------------------------ APPLICATION FUNCTIONS
void application_init ( void )
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    speaker2_cfg_t speaker2_cfg;  /**< Click config object. */
    rotaryswitch_cfg_t rotaryswitch_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.
    rotaryswitch_cfg_setup( &rotaryswitch_cfg );
    ROTARYSWITCH_MAP_MIKROBUS( rotaryswitch_cfg, MIKROBUS_1 );
    if ( I2C_MASTER_ERROR == rotaryswitch_init( &rotaryswitch,
                                                &rotaryswitch_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }

    if ( ROTARYSWITCH_ERROR == rotaryswitch_default_cfg ( &rotaryswitch ) )
    {
        log_error( &logger, " Default configuration." );
        for ( ; ; );
    }

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

    log_info( &logger, " Application Task " );
}

void application_task ( void )
{
    static uint8_t prev_rotary_position = 0xFF; // Initially invalid
    uint8_t rotary_position = 0;

    if ( ROTARYSWITCH_OK == rotaryswitch_get_position( &rotaryswitch,
                                                       &rotary_position ) )
    {
        uint8_t current_zone = rotary_position / SPEAKER_2_ZONE_WIDTH;
        if ( current_zone >= SPEAKER_2_NUM_SOUNDS )
        {
            current_zone = SPEAKER_2_NUM_SOUNDS - 1;
        }

        // Calculate current zone boundaries
        uint8_t zone_min = current_zone * SPEAKER_2_ZONE_WIDTH;
        uint8_t zone_max = ( ( current_zone + 1 ) * SPEAKER_2_ZONE_WIDTH ) - 1;
        if ( current_zone == SPEAKER_2_NUM_SOUNDS - 1 )
        {
            zone_max = ROTARY_SWITCH_MAX_RANGE - 1;
        }

        // Check if rotary moved into a NEW range (new zone boundaries)
        if ( ( rotary_position >= zone_min && rotary_position <= zone_max ) &&
             !( prev_rotary_position >= zone_min &&
                prev_rotary_position <= zone_max ) )
        {
            prev_rotary_position = rotary_position;

            log_printf( &logger, " Rotary position: %u -> Zone %u (%u - %u)\r\n", 
                        rotary_position, current_zone, zone_min, zone_max );

            if ( SPEAKER2_OK == speaker2_play_voice( &speaker2,
                                                     speaker2_voice_map[ current_zone ] ) )
            {
                log_printf( &logger, " Voice played: %u\r\n\n", current_zone );
            }
            else
            {
                log_error( &logger,
                           " Failed to play voice for zone %u\r\n\n",
                           current_zone );
            }
        }
    }

    Delay_ms( 20 );
}

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