oximeter  2.0.0.0
Main Page

Oximeter click

Oximeter click is a versatile photometric Click board�, perfectly suited for measuring the blood oxygen saturation.

click Product page


Click library

  • Author : MikroE Team
  • Date : Dec 2019.
  • Type : I2C type

Software Support

We provide a library for the Oximeter 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 form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for Oximeter Click driver.

Standard key functions :

  • Config Object Initialization function.

    void oximeter_cfg_setup ( oximeter_cfg_t *cfg );

  • Initialization function.

    OXIMETER_RETVAL oximeter_init ( oximeter_t *ctx, oximeter_cfg_t *cfg );

  • Click Default Configuration function.

    void oximeter_default_cfg ( oximeter_t *ctx );

Example key functions :

  • Function writes 16-bit data to the register.

    uint8_t oxim_write_reg ( oximeter_t* ctx, uint8_t register_address,uint16_t transfer_data );

  • Function performs the configuration and enables the interrupt on this slot.

    uint8_t oxim_set_time_slotA ( oximeter_t* ctx, uint8_t enable_slotA,

    uint8_t enable_photodiode, uint8_t enable_LED, uint8_t set_mode );
  • Function determines which channel/channels be enabled.

    uint8_t oxim_enable_channels ( oximeter_t* ctx, uint8_t select_channel );

Examples Description

This application collects data from the sensor, calculates it and then logs the result.

The demo application is composed of two sections :

Application Init

Initializes driver and performs the device configuration which puts Time Slot A in enabled mode and LEDX2 (IR diode) to active state. Before the device configuration, the SW reset will be performed and in this way we will put the registers in initial state.

void application_init ( void )
{
log_cfg_t log_cfg;
// Logger initialization.
LOG_MAP_USB_UART( log_cfg );
log_cfg.level = LOG_LEVEL_DEBUG;
log_cfg.baud = 9600;
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
OXIMETER_MAP_MIKROBUS( cfg, MIKROBUS_1 );
oximeter_init( &oximeter, &cfg );
oximeter_default_cfg( &oximeter );
}

Application Task

Logs PD1-PD4 data on USB UART

void application_task ( void )
{
}

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Oximeter

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. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.


oximeter_default_cfg
void oximeter_default_cfg(oximeter_t *ctx)
Click Default Configuration function.
OXIMETER_MAP_MIKROBUS
#define OXIMETER_MAP_MIKROBUS(cfg, mikrobus)
Definition: oximeter.h:53
application_task
void application_task(void)
Definition: main.c:295
oximeter_cfg_setup
void oximeter_cfg_setup(oximeter_cfg_t *cfg)
Config Object Initialization function.
oxim_logs_results
void oxim_logs_results(void)
Definition: main.c:198
oximeter_init
OXIMETER_RETVAL oximeter_init(oximeter_t *ctx, oximeter_cfg_t *cfg)
Initialization function.
application_init
void application_init(void)
Definition: main.c:274
oximeter_cfg_t
Click configuration structure definition.
Definition: oximeter.h:252