heartrate.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 HEARTRATE_H
#define HEARTRATE_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define HEARTRATE_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define HEARTRATE_RETVAL  uint8_t
 
#define HEARTRATE_OK           0x00
#define HEARTRATE_INIT_ERROR   0xFF
#define SLAVE_ADDRESS          0x57
#define HEARTRATE_INT_STATUS              0x00
#define HEARTRATE_INT_ENABLE              0x01
#define HEARTRATE_FIFO_WRITE_PTR          0x02
#define HEARTRATE_OVER_FLOW_CNT           0x03
#define HEARTRATE_FIFO_READ_PTR           0x04
#define HEARTRATE_FIFO_DATA_REG           0x05
#define HEARTRATE_MODE_CONFIG             0x06
#define HEARTRATE_SPO2_CONFIG             0x07
#define HEARTRATE_LED_CONFIG              0x09
#define HEARTRATE_TEMP_INTEGER            0x16
#define HEARTRATE_TEMP_FRACTION           0x17
#define HEARTRATE_REVISION_ID             0xFE
#define HEARTRATE_PART_ID                 0xFF
#define HEARTRATE_TEMP_EN                 0x08
#define HEARTRATE_HR_ONLY                 0x02
#define HEARTRATE_SPO2_EN                 0x03
#define HEARTRATE_SPO2_HI_RES_EN          0x40
 #define HEARTRATE_ENA_A_FULL             0x80
 #define HEARTRATE_ENA_TEP_RDY            0x40
 #define HEARTRATE_ENA_HR_RDY             0x20
 #define HEARTRATE_ENA_SO2_RDY            0x10
#define HEARTRATE_PWR_RDY                 0x01
#define HEARTRATE_SAMPLES_50              0x00
#define HEARTRATE_SAMPLES_100             0x04
#define HEARTRATE_SAMPLES_167             0x08
#define HEARTRATE_SAMPLES_200             0x0C
#define HEARTRATE_SAMPLES_400             0x10
#define HEARTRATE_SAMPLES_600             0x14
#define HEARTRATE_SAMPLES_800             0x18
#define HEARTRATE_SAMPLES_1000            0x1C
#define HEARTRATE_PULSE_WIDTH_200         0x00  // 13-bit ADC resolution
#define HEARTRATE_PULSE_WIDTH_400         0x01  // 14-bit ADC resolution
#define HEARTRATE_PULSE_WIDTH_800         0x02  // 15-bit ADC resolution
#define HEARTRATE_PULSE_WIDTH_1600        0x03  // 16-bit ADC resolution
#define HEARTRATE_IR_CURRENT_0            0x00  // 0.0 mA
#define HEARTRATE_IR_CURRENT_44           0x01  // 4.4 mA
#define HEARTRATE_IR_CURRENT_76           0x02  // 7.6 mA
#define HEARTRATE_IR_CURRENT_110          0x03  // 11.0 mA
#define HEARTRATE_IR_CURRENT_142          0x04  // 14.2 mA
#define HEARTRATE_IR_CURRENT_174          0x05  // 17.4 mA
#define HEARTRATE_IR_CURRENT_208          0x06  // 20.8 mA
#define HEARTRATE_IR_CURRENT_240          0x07  // 24.0 mA
#define HEARTRATE_IR_CURRENT_271          0x08  // 27.1 mA
#define HEARTRATE_IR_CURRENT_306          0x09  // 30.6 mA
#define HEARTRATE_IR_CURRENT_338          0x0A  // 33.8 mA
#define HEARTRATE_IR_CURRENT_370          0x0B  // 37.0 mA
#define HEARTRATE_IR_CURRENT_402          0x0C  // 40.2 mA
#define HEARTRATE_IR_CURRENT_436          0x0D  // 43.6 mA
#define HEARTRATE_IR_CURRENT_468          0x0E  // 46.8 mA
#define HEARTRATE_IR_CURRENT_500          0x0F  // 50.0 mA
 
#define HEARTRATE_RED_CURRENT_0           0x00  // 0.0 mA
#define HEARTRATE_RED_CURRENT_44          0x10  // 4.4 mA
#define HEARTRATE_RED_CURRENT_76          0x20  // 7.6 mA
#define HEARTRATE_RED_CURRENT_110         0x30  // 11.0 mA
#define HEARTRATE_RED_CURRENT_142         0x40  // 14.2 mA
#define HEARTRATE_RED_CURRENT_174         0x50  // 17.4 mA
#define HEARTRATE_RED_CURRENT_208         0x60  // 20.8 mA
#define HEARTRATE_RED_CURRENT_240         0x70  // 24.0 mA
#define HEARTRATE_RED_CURRENT_271         0x80  // 27.1 mA
#define HEARTRATE_RED_CURRENT_306         0x90  // 30.6 mA
#define HEARTRATE_RED_CURRENT_338         0xA0  // 33.8 mA
#define HEARTRATE_RED_CURRENT_370         0xB0  // 37.0 mA
#define HEARTRATE_RED_CURRENT_402         0xC0  // 40.2 mA
#define HEARTRATE_RED_CURRENT_436         0xD0  // 43.6 mA
#define HEARTRATE_RED_CURRENT_468         0xE0  // 46.8 mA
#define HEARTRATE_RED_CURRENT_500         0xF0  // 50.0 mA
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} heartrate_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} heartrate_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void heartrate_cfg_setup ( heartrate_cfg_t *cfg );
 
HEARTRATE_RETVAL heartrate_init ( heartrate_t *ctx, heartrate_cfg_t *cfg );
 
void heartrate_default_cfg ( heartrate_t *ctx );
 
uint8_t heartrate_get_revision_id ( heartrate_t *ctx );
 
uint8_t heartrate_get_part_id ( heartrate_t *ctx );
 
uint8_t heartrate_get_config ( heartrate_t *ctx );
 
uint8_t heartrate_get_status ( heartrate_t *ctx );
 
void heartrate_set_config ( heartrate_t *ctx, uint8_t cfg );
 
void heartrate_set_interrupt ( heartrate_t *ctx, uint8_t intrpts );
 
uint8_t heartrate_read_ir_red ( heartrate_t *ctx, uint16_t *ir_buff, uint16_t *red_buff );
 
void heartrate_read_temp ( heartrate_t *ctx, uint16_t *temp_value );
 
uint8_t heartrate_data_ready ( heartrate_t *ctx );
 
void heartrate_generic_write ( heartrate_t *ctx, uint8_t reg, uint16_t len, uint8_t *data_buf );
 
void heartrate_generic_read ( heartrate_t *ctx, uint8_t reg, uint16_t len, uint8_t *data_buf );
 
void hr_shut_down ( heartrate_t *ctx, bool enable );
 
void hr_reset ( heartrate_t *ctx );
 
void hr_temp_enable ( heartrate_t *ctx, bool enable );
 
int8_t hr_set_mode ( heartrate_t *ctx, uint8_t mode );
 
void hr_spo2_high_res_enable ( heartrate_t *ctx, bool enable );
 
uint8_t hr_spo2_set_sample_rate ( heartrate_t *ctx, uint8_t sample_rate );
 
uint8_t hr_set_led_pulse_width ( heartrate_t *ctx, uint8_t _value );
 
uint8_t hr_set_red_current_level ( heartrate_t *ctx, uint8_t level );
 
uint8_t hr_set_ir_current_level ( heartrate_t *ctx, uint8_t level );
 
void hr_fifo_almost_full_int_enable ( heartrate_t *ctx, bool enable );
 
void hr_temp_ready_int_enable ( heartrate_t *ctx, bool enable );
 
void hr_heartrate_data_ready_int_enable ( heartrate_t *ctx, bool enable );
 
void hr_heartrate_spo2_data_ready_int_enable ( heartrate_t *ctx, bool enable );
 
uint8_t hr_read_diodes ( heartrate_t *ctx, uint16_t* ir_buff, uint16_t* red_buff );
 
uint8_t hr_get_status ( heartrate_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _HEARTRATE_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END