heartrate5  2.0.0.0
Main Page

Heart Rate 5 click

Heart Rate 5 click is the optical biosensor Click boardâ„¢ which can be used for the heart-rate monitoring (HRM), as well as the peripheral capillary oxygen saturation monitoring (SpO2). This Click boardâ„¢ employs a very sensitive analog front-end IC with high dynamic range, which ensures accurate and reliable readings.

click Product page


Click library

  • Author : Stefan Ilic
  • Date : Dec 2021.
  • Type : I2C type

Software Support

We provide a library for the Heart Rate 5 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for Heart Rate 5 Click driver.

Standard key functions :

Example key functions :

Example Description

This example showcases ability for device to read Heart Rate 5 Click Board

The demo application is composed of two sections :

Application Init

Configures the micro controller for communication and initializes the click board.

void application_init ( void )
{
log_cfg_t log_cfg;
heartrate5_cfg_t heartrate5_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
heartrate5_cfg_setup( &heartrate5_cfg );
HEARTRATE5_MAP_MIKROBUS( heartrate5_cfg, MIKROBUS_1 );
if ( I2C_MASTER_ERROR == heartrate5_init( &heartrate5, &heartrate5_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( HEARTRATE5_ERROR == heartrate5_default_cfg ( &heartrate5 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}

Application Task

This section shows how the data is processed and sent to the MikroPlot application.

void application_task ( void )
{
if( heartrate5_get_led2_aled2_val( &heartrate5 ) < 10 )
{
sensor_value = heartrate5_get_aled1_val( &heartrate5 );
log_printf( &logger, "%lu,%lu \r\n", sensor_value, time );
time += 10;
Delay_ms ( 10 );
}
}

Note

For testing this example application SerialPlot was used. There you can see heart rate graphicly shown.

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.HeartRate5

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. UART terminal is available in all MikroElektronika compilers.


heartrate5_cfg_setup
void heartrate5_cfg_setup(heartrate5_cfg_t *cfg)
Heart Rate 5 configuration object setup function.
heartrate5_t
Heart Rate 5 Click context object.
Definition: heartrate5.h:202
heartrate5_read_reg
uint32_t heartrate5_read_reg(heartrate5_t *ctx, uint8_t reg_addr)
Heart Rate 5 register reading function.
application_task
void application_task(void)
Definition: main.c:68
HEARTRATE5_ERROR
@ HEARTRATE5_ERROR
Definition: heartrate5.h:241
heartrate5_get_aled1_val
uint32_t heartrate5_get_aled1_val(heartrate5_t *ctx)
Heart Rate 5 get ALED1 data function.
heartrate5_write_reg
void heartrate5_write_reg(heartrate5_t *ctx, uint8_t reg_addr, uint32_t write_data)
Heart Rate 5 register write function.
heartrate5_default_cfg
err_t heartrate5_default_cfg(heartrate5_t *ctx)
Heart Rate 5 default configuration function.
heartrate5_cfg_t
Heart Rate 5 Click configuration object.
Definition: heartrate5.h:222
heartrate5_sw_reset
void heartrate5_sw_reset(heartrate5_t *ctx)
Heart Rate 5 software reset function.
HEARTRATE5_MAP_MIKROBUS
#define HEARTRATE5_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: heartrate5.h:188
heartrate5_init
err_t heartrate5_init(heartrate5_t *ctx, heartrate5_cfg_t *cfg)
Heart Rate 5 initialization function.
heartrate5_get_led2_aled2_val
uint32_t heartrate5_get_led2_aled2_val(heartrate5_t *ctx)
Heart Rate 5 get LED2_ALED2 data function.
application_init
void application_init(void)
Definition: main.c:32