oximeter5.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef OXIMETER5_H
#define OXIMETER5_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
    
 
#define OXIMETER5_REG_INTR_STATUS_1               0x00
#define OXIMETER5_REG_INTR_STATUS_2               0x01
#define OXIMETER5_REG_INTR_ENABLE_1               0x02
#define OXIMETER5_REG_INTR_ENABLE_2               0x03
#define OXIMETER5_REG_FIFO_WR_PTR                 0x04
#define OXIMETER5_REG_OVF_COUNTER                 0x05
#define OXIMETER5_REG_FIFO_RD_PTR                 0x06
#define OXIMETER5_REG_FIFO_DATA                   0x07
#define OXIMETER5_REG_FIFO_CONFIG                 0x08
#define OXIMETER5_REG_MODE_CONFIG                 0x09
#define OXIMETER5_REG_SPO2_CONFIG                 0x0A
#define OXIMETER5_REG_LED1_PA                     0x0C
#define OXIMETER5_REG_LED2_PA                     0x0D
#define OXIMETER5_REG_MULTI_LED_CTRL1             0x11
#define OXIMETER5_REG_MULTI_LED_CTRL2             0x12
#define OXIMETER5_REG_TEMP_INTR                   0x1F
#define OXIMETER5_REG_TEMP_FRAC                   0x20
#define OXIMETER5_REG_TEMP_CONFIG                 0x21
#define OXIMETER5_REG_PROX_INT_THRESH             0x30
#define OXIMETER5_REG_REV_ID                      0xFE
#define OXIMETER5_REG_PART_ID                     0xFF
 
 // oximeter5_reg
 
// OXIMETER5_REG_INTR_ENABLE_1 
#define OXIMETER5_SET_INTR_EN_1_FULL_EN           0x80
#define OXIMETER5_SET_INTR_EN_1_PPG_RDY_EN        0x40
#define OXIMETER5_SET_INTR_EN_1_ALC_OVF_EN        0x20
    
// OXIMETER5_REG_INTR_ENABLE_2 
#define OXIMETER5_SET_INTR_EN_2_TEMP_EN           0x80
#define OXIMETER5_SET_INTR_EN_2_TEMP_DIS          0x00
    
// OXIMETER5_REG_FIFO_CONFIG 
#define OXIMETER5_SET_FIFO_PTR_RESET              0x00
#define OXIMETER5_SET_FIFO_COUNTER_RESET          0x00
    
// OXIMETER5_REG_FIFO_CONFIG 
#define OXIMETER5_SET_FIFO_CFG_SMP_AVE_BIT_MASK   0xC0
#define OXIMETER5_SET_FIFO_CFG_SMP_AVE_1          0x00
#define OXIMETER5_SET_FIFO_CFG_SMP_AVE_2          0x20
#define OXIMETER5_SET_FIFO_CFG_SMP_AVE_3          0x40
#define OXIMETER5_SET_FIFO_CFG_SMP_AVE_8          0x60
#define OXIMETER5_SET_FIFO_CFG_SMP_AVE_16         0x80
#define OXIMETER5_SET_FIFO_CFG_SMP_AVE_32         0xC0
 
#define OXIMETER5_SET_FIFO_CFG_FIFO_RL_BIT_MASK   0x10    
#define OXIMETER5_SET_FIFO_CFG_FIFO_RL_EN         0x10
    
#define OXIMETER5_SET_FIFO_CFG_DATA_SAMP_BIT_MASK 0x0F
#define OXIMETER5_SET_FIFO_CFG_DATA_SAMP_0        0x00
#define OXIMETER5_SET_FIFO_CFG_DATA_SAMP_1        0x01
#define OXIMETER5_SET_FIFO_CFG_DATA_SAMP_2        0x02
#define OXIMETER5_SET_FIFO_CFG_DATA_SAMP_3        0x03
#define OXIMETER5_SET_FIFO_CFG_DATA_SAMP_4        0x04
#define OXIMETER5_SET_FIFO_CFG_DATA_SAMP_5        0x05
#define OXIMETER5_SET_FIFO_CFG_DATA_SAMP_6        0x06
#define OXIMETER5_SET_FIFO_CFG_DATA_SAMP_7        0x07
#define OXIMETER5_SET_FIFO_CFG_DATA_SAMP_8        0x08
#define OXIMETER5_SET_FIFO_CFG_DATA_SAMP_9        0x09
#define OXIMETER5_SET_FIFO_CFG_DATA_SAMP_10       0x0A
#define OXIMETER5_SET_FIFO_CFG_DATA_SAMP_11       0x0B
#define OXIMETER5_SET_FIFO_CFG_DATA_SAMP_12       0x0C
#define OXIMETER5_SET_FIFO_CFG_DATA_SAMP_13       0x0D
#define OXIMETER5_SET_FIFO_CFG_DATA_SAMP_14       0x0E
#define OXIMETER5_SET_FIFO_CFG_DATA_SAMP_15       0x0F
    
#define OXIMETER5_SET_CFG_MODE_BIT_MASK           0x07
#define OXIMETER5_SW_RESET                        0x40
#define OXIMETER5_SET_CFG_MODE_HEART_RATE         0x02
#define OXIMETER5_SET_CFG_MODE_SpO2               0x03
#define OXIMETER5_SET_CFG_MODE_MULTI_LED          0x07
    
#define OXIMETER5_SET_SPO2_CFG_ADC_RGE_BIT_MASK   0x60
#define OXIMETER5_SET_SPO2_CFG_ADC_RGE_2048       0x00
#define OXIMETER5_SET_SPO2_CFG_ADC_RGE_4096       0x20
#define OXIMETER5_SET_SPO2_CFG_ADC_RGE_8192       0x40
#define OXIMETER5_SET_SPO2_CFG_ADC_RGE_16384      0x60
    
#define OXIMETER5_SET_SPO2_CFG_SR_SEC_BIT_MASK    0x1C
#define OXIMETER5_SET_SPO2_CFG_SR_SEC_50          0x00
#define OXIMETER5_SET_SPO2_CFG_SR_SEC_100         0x04
#define OXIMETER5_SET_SPO2_CFG_SR_SEC_200         0x08
#define OXIMETER5_SET_SPO2_CFG_SR_SEC_400         0x0C
#define OXIMETER5_SET_SPO2_CFG_SR_SEC_800         0x10
#define OXIMETER5_SET_SPO2_CFG_SR_SEC_1000        0x12
#define OXIMETER5_SET_SPO2_CFG_SR_SEC_1600        0x14
#define OXIMETER5_SET_SPO2_CFG_SR_SEC_3200        0x1C
   
#define OXIMETER5_SET_SPO2_CFG_LED_PW_BIT_MASK    0x03
#define OXIMETER5_SET_SPO2_CFG_LED_PW_15_bit      0x00
#define OXIMETER5_SET_SPO2_CFG_LED_PW_16_bit      0x01
#define OXIMETER5_SET_SPO2_CFG_LED_PW_17_bit      0x02
#define OXIMETER5_SET_SPO2_CFG_LED_PW_18_bit      0x03
    
#define OXIMETER5_SET_LED_PULSE_AMPL_7_2_mA       0x24
 
#define OXIMETER5_SET_CFG_TEMP_DISABLE            0x00
#define OXIMETER5_SET_CFG_TEMP_ENABLE             0x01
 
#define MAX_BRIGHTNESS                            255
#define OXIMETER5_PN_SPO2_ERROR_DATA              255
#define OXIMETER5_HEART_RATE_ERROR_DATA          -999
 
#define OXIMETER5_INTERRUPT_INACTIVE             0x00
#define OXIMETER5_INTERRUPT_ACTIVE               0x01
 
#define OXIMETER5_SET_DEV_ADDR                    0x57
 
 // oximeter5_set
 
#define OXIMETER5_MAP_MIKROBUS( cfg, mikrobus )   \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // oximeter5_map
 // oximeter5
 
typedef struct
{
    // Input pins
    digital_in_t  int_pin;       
    // Modules
    i2c_master_t i2c;            
    // I2C slave address
    uint8_t slave_address;       
} oximeter5_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  int_pin;    
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} oximeter5_cfg_t;
 
typedef enum
{
    OXIMETER5_OK = 0,
    OXIMETER5_ERROR = -1
 
} oximeter5_return_value_t;
 
 
void oximeter5_cfg_setup ( oximeter5_cfg_t *cfg );
 
err_t oximeter5_init ( oximeter5_t *ctx, oximeter5_cfg_t *cfg );
 
err_t oximeter5_default_cfg ( oximeter5_t *ctx );
 
err_t oximeter5_generic_write ( oximeter5_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t oximeter5_generic_read ( oximeter5_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
uint8_t oximeter5_check_interrupt ( oximeter5_t *ctx );
 
err_t oximeter5_sw_reset ( oximeter5_t *ctx );
 
err_t oximeter5_read_temperature ( oximeter5_t *ctx, float *temperature );
 
err_t oximeter5_set_fifo_wr_pointer ( oximeter5_t *ctx, uint8_t fifo_wr_p );
 
err_t oximeter5_set_fifo_rd_pointer ( oximeter5_t *ctx, uint8_t fifo_rd_p );
 
err_t oximeter5_set_fifo_cfg ( oximeter5_t *ctx, uint8_t smp_ave, uint8_t fifo_ro_en, uint8_t fifo_a_full );
 
err_t oximeter5_set_mode_cfg ( oximeter5_t *ctx, uint8_t mode );
 
err_t oximeter5_set_spo2_cfg ( oximeter5_t *ctx, uint8_t spo2_adc_rge,  uint8_t spo2_sr, uint8_t led_pw );
 
err_t oximeter5_read_sensor_data ( oximeter5_t *ctx, uint32_t *ir, uint32_t *red );
 
err_t oximeter5_get_oxygen_saturation ( uint32_t *pun_ir_buffer, int32_t n_ir_buffer_length, uint32_t *pun_red_buffer, uint8_t *pn_spo2 );
 
err_t oximeter5_get_heart_rate ( uint32_t *pun_ir_buffer, int32_t n_ir_buffer_length, uint32_t *pun_red_buffer, int32_t *pn_heart_rate );
 
#ifdef __cplusplus
}
#endif
#endif // OXIMETER5_H
 
 // oximeter5
 
// ------------------------------------------------------------------------ END