Heartbeat & Oxygen Monitor Solution

/*!
 * Solution Name: Heartbeat & Oxygen Monitor
 *
 * # Description
 * This example demonstrates the use of Heart Rate 13 Click and
 * Oximeter 5 Click boards for measuring heart rate and SpO2 values,
 * which can be visualized on the Plot application.
 *
 * The demo application is composed of three sections:
 *
 * ## Application Init
 * Initializes the drivers for both the Heart Rate 13 Click and
 * Oximeter 5 Click, performs the default configurations for heart rate
 * and SpO2 measurements, and prepares the necessary buffers for data
 * acquisition.
 *
 * ## Application Task
 * The task waits for data from both Click boards, then reads the
 * heart rate and SpO2 measurements, and displays them on the Plot
 * tool. The user can visualize heart rate on one chart and SpO2 on another
 * chart after creating separate charts within Plot. The heart rate
 * data is visualized upon placing a finger on the Heart Rate 13 Click's
 * sensor, and the SpO2 data is visualized by placing 
 * a finger on the Oximeter 5 Click's sensor. 
 * 
 * ## Plot Functionality
 * To visualize the data:
 * 1. Run the debug feature by pressing F9 on the keyboard.
 * 2. Navigate to the Plot feature by pressing `CTRL` + `F9`.
 * 3. Press F6 to start the application.
 * 4. First, place a finger on the Heart Rate 13 Click`s sensor to visualize
 *    the heart rate on the plot.
 * 5. Next, place a finger on the Oximeter 5 Click`s sensor to visualize
 *    the SpO2 value on the plot. 
 *    Create a new chart by selecting the 'Create separate charts' option
 *    in Plot to see both heart rate and SpO2 values on distinct charts.
 *
 * @note
 * It is important to create separate charts for the heart rate and SpO2
 * measurements in the Plot tool to clearly distinguish between
 * the two readings.
 *
 * Author: Branko Jaksic
 * Date: April, 2025
 *
 */

// ------------------------------------------------------------------- INCLUDES
#include "log.h"
#include "board.h"
#include "oximeter5.h"
#include "heartrate13.h"

// ------------------------------------------------------------------ VARIABLES
static log_t logger;
static oximeter5_t oximeter5;
static heartrate13_t heartrate13;

// Oximeter 5 Click variables
static uint32_t aun_ir_buffer[ 100 ];
static uint32_t aun_red_buffer[ 100 ];
static uint32_t un_min, un_max, un_prev_data, un_brightness;
static float f_temp;
static uint8_t n_spo2;

// ------------------------------------------------------ APPLICATION FUNCTIONS
void application_init ( void ) 
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    heartrate13_cfg_t heartrate13_cfg;  /**< Click config object. */
    oximeter5_cfg_t oximeter5_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 " );

    // Heart Rate 13 Click initialization.
    heartrate13_cfg_setup( &heartrate13_cfg );
    HEARTRATE13_MAP_MIKROBUS( heartrate13_cfg, MIKROBUS_1 );
    if ( I2C_MASTER_ERROR == heartrate13_init( &heartrate13,
                                               &heartrate13_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }

    if ( HEARTRATE13_ERROR == heartrate13_default_cfg ( &heartrate13 ) )
    {
        log_error( &logger, " Default configuration." );
        for ( ; ; );
    }

    // Oximeter 5 Click initialization.
    oximeter5_cfg_setup( &oximeter5_cfg );
    OXIMETER5_MAP_MIKROBUS( oximeter5_cfg, MIKROBUS_2 );
    if ( I2C_MASTER_ERROR == oximeter5_init( &oximeter5, &oximeter5_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    Delay_ms ( 100 );

    if ( OXIMETER5_ERROR == oximeter5_default_cfg ( &oximeter5 ) )
    {
        log_error( &logger, " Default configuration." );
        for ( ; ; );
    }
    Delay_ms ( 100 ); 

    un_brightness = 0;
    un_min = 0x3FFFF;
    un_max = 0;

    for ( uint8_t n_cnt = 0; n_cnt < 100; n_cnt++ )
    {
        while ( oximeter5_check_interrupt( &oximeter5 ) == OXIMETER5_INTERRUPT_ACTIVE );

        oximeter5_read_sensor_data( &oximeter5,
                                    &aun_red_buffer[ n_cnt ],
                                    &aun_ir_buffer[ n_cnt ] );

        if ( un_min > aun_red_buffer[ n_cnt ] )
        {
            un_min = aun_red_buffer[ n_cnt ];
        }

        if ( un_max < aun_red_buffer[ n_cnt ] )
        {
            un_max = aun_red_buffer[ n_cnt ];
        }
    }

    oximeter5_get_oxygen_saturation( &aun_ir_buffer[ 0 ], 100,
                                     &aun_red_buffer[ 0 ], &n_spo2 );
    log_info( &logger, " Application Task " );
    Delay_ms ( 100 ); 
}

void application_task ( void ) 
{
    heartrate13_pd_data_t pd_data;

    // Switch I2C communication to Heart rate 13 Click.
    i2c_master_set_slave_address(&heartrate13.i2c, heartrate13.slave_address);

    if ( HEARTRATE13_OK == heartrate13_get_pd_data ( &heartrate13, &pd_data ) )
    {
        log_printf ( &logger, "%u\r\n", pd_data.pd3 );
        plot("HEART RATE: ", pd_data.pd3);
    }

    // Switch I2C communication to Oximeter 5 Click.
    i2c_master_set_slave_address(&oximeter5.i2c, oximeter5.slave_address);

    for ( uint8_t n_cnt = 25; n_cnt < 100; n_cnt++ )
    {
        aun_red_buffer[ n_cnt - 25 ] = aun_red_buffer[ n_cnt ];
        aun_ir_buffer[ n_cnt - 25 ] = aun_ir_buffer[ n_cnt ];

        if ( un_min > aun_red_buffer[ n_cnt ] )
        {
            un_min = aun_red_buffer[ n_cnt ];
        }
      
        if ( un_max < aun_red_buffer[ n_cnt ] )
        {
            un_max=aun_red_buffer[n_cnt];
        }
    }

    for ( uint8_t n_cnt = 75; n_cnt < 100; n_cnt++ )
    {
        un_prev_data = aun_red_buffer[ n_cnt - 1 ];
        while ( oximeter5_check_interrupt( &oximeter5 ) == OXIMETER5_INTERRUPT_ACTIVE ); 

        oximeter5_read_sensor_data( &oximeter5,
                                    &aun_red_buffer[ n_cnt ],
                                    &aun_ir_buffer[ n_cnt ] );

        if ( aun_red_buffer[ n_cnt ] > un_prev_data )
        {
            f_temp = aun_red_buffer[ n_cnt ]-un_prev_data;
            f_temp /= ( un_max - un_min );
            f_temp *= MAX_BRIGHTNESS;
            f_temp = un_brightness - f_temp;
        
            if ( f_temp < 0 )
            {
                un_brightness = 0;
            }
            else
            {
                un_brightness = ( uint32_t ) f_temp;
            }
        }
        else
        {
            f_temp = un_prev_data - aun_red_buffer[ n_cnt ];
            f_temp /= ( un_max - un_min );
            f_temp *= MAX_BRIGHTNESS;
            un_brightness += ( uint32_t ) f_temp;

            if ( un_brightness > MAX_BRIGHTNESS )
            {
                un_brightness = MAX_BRIGHTNESS;
            }
        }

        if ( ( OXIMETER5_OK == oximeter5_get_oxygen_saturation( &aun_ir_buffer[ 0 ],
                                                                100,
                                                                &aun_red_buffer[ 0 ],
                                                                &n_spo2 ) ) )
        {
            if ( aun_ir_buffer[n_cnt] > 10000  ) 
            {
                log_printf( &logger, "\tIR    : %lu \r\n", aun_ir_buffer[ n_cnt ] );
                log_printf( &logger, "\tRED   : %lu \r\n", aun_red_buffer[ n_cnt ] ); 
                log_printf( &logger, "- - - - - - - - - - - - - - -\r\n" );
                log_printf( &logger, "\tSPO2  : %d %%\r\n", ( uint16_t ) n_spo2 );
                log_printf( &logger, "-----------------------------\r\n" );
                plot("SpO2 (0% - 100%): ", ( uint16_t ) n_spo2 );
                Delay_ms ( 100 );       
            }
            else
            {
                Delay_ms ( 10 );      
            }
        }
    }
}

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