heartrate11.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 HEARTRATE11_H
#define HEARTRATE11_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_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
#define HEARTRATE11_REG_STATUS_0                    0x00
#define HEARTRATE11_REG_STATUS_1                    0x01
#define HEARTRATE11_REG_PS_DATA_0                   0x02
#define HEARTRATE11_REG_PS_DATA_1                   0x03
#define HEARTRATE11_REG_LS_CLEAR_DATA_0             0x04
#define HEARTRATE11_REG_LS_CLEAR_DATA_1             0x05
#define HEARTRATE11_REG_LS_CLEAR_DATA_2             0x06
#define HEARTRATE11_REG_LS_GREEN_DATA_0             0x07
#define HEARTRATE11_REG_LS_GREEN_DATA_1             0x08
#define HEARTRATE11_REG_LS_GREEN_DATA_2             0x09
#define HEARTRATE11_REG_LS_BLUE_DATA_0              0x0A
#define HEARTRATE11_REG_LS_BLUE_DATA_1              0x0B
#define HEARTRATE11_REG_LS_BLUE_DATA_2              0x0C
#define HEARTRATE11_REG_LS_RED_DATA_0               0x0D
#define HEARTRATE11_REG_LS_RED_DATA_1               0x0E
#define HEARTRATE11_REG_LS_RED_DATA_2               0x0F
#define HEARTRATE11_REG_COMP_DATA_0                 0x10
#define HEARTRATE11_REG_COMP_DATA_1                 0x11
#define HEARTRATE11_REG_COMP_DATA_2                 0x12
#define HEARTRATE11_REG_MAIN_CTRL_0                 0x15
#define HEARTRATE11_REG_MAIN_CTRL_1                 0x16
#define HEARTRATE11_REG_PS_LED_CURR_0               0x17
#define HEARTRATE11_REG_PS_LED_CURR_1               0x18
#define HEARTRATE11_REG_PS_CAN_PULSES               0x19
#define HEARTRATE11_REG_PS_PWIDTH_PERIOD            0x1A
#define HEARTRATE11_REG_PS_CAN_DIG_0                0x1B
#define HEARTRATE11_REG_PS_CAN_DIG_1                0x1C
#define HEARTRATE11_REG_PS_MOV_AVG_HYS              0x1D
#define HEARTRATE11_REG_PS_THRES_UP_0               0x1E
#define HEARTRATE11_REG_PS_THRES_UP_1               0x1F
#define HEARTRATE11_REG_PS_THRES_LOW_0              0x20
#define HEARTRATE11_REG_PS_THRES_LOW_1              0x21
#define HEARTRATE11_REG_LS_RES_PERIOD               0x22
#define HEARTRATE11_REG_LS_GAIN                     0x23
#define HEARTRATE11_REG_LS_THRES_UP_0               0x24
#define HEARTRATE11_REG_LS_THRES_UP_1               0x25
#define HEARTRATE11_REG_LS_THRES_UP_2               0x26
#define HEARTRATE11_REG_LS_THRES_LOW_0              0x27
#define HEARTRATE11_REG_LS_THRES_LOW_1              0x28
#define HEARTRATE11_REG_LS_THRES_LOW_2              0x29
#define HEARTRATE11_REG_LS_THRES_VAR                0x2A
#define HEARTRATE11_REG_INT_CFG_0                   0x2B
#define HEARTRATE11_REG_INT_CFG_1                   0x2C
#define HEARTRATE11_REG_INT_PST                     0x2D
#define HEARTRATE11_REG_PPG_PS_GAIN                 0x2E
#define HEARTRATE11_REG_PPG_PS_CFG                  0x2F
#define HEARTRATE11_REG_PPG_IRLED_CURR_0            0x30
#define HEARTRATE11_REG_PPG_IRLED_CURR_1            0x31
#define HEARTRATE11_REG_PPG_RLED_CURR_0             0x32
#define HEARTRATE11_REG_PPG_RLED_CURR_1             0x33
#define HEARTRATE11_REG_PPG_CAN_ANA                 0x34
#define HEARTRATE11_REG_PPG_AVG                     0x35
#define HEARTRATE11_REG_PPG_PWIDTH_PERIOD           0x36
#define HEARTRATE11_REG_FIFO_CFG                    0x37
#define HEARTRATE11_REG_FIFO_WR_PTR                 0x38
#define HEARTRATE11_REG_FIFO_RD_PTR                 0x39
#define HEARTRATE11_REG_FIFO_OVF_CNT                0x3A
#define HEARTRATE11_REG_FIFO_DATA                   0x3B
#define HEARTRATE11_REG_PART_ID                     0x3D
 
 // heartrate11_reg
 
#define HEARTRATE11_POR_STATUS                      0x80
#define HEARTRATE11_LS_INT_STATUS                   0x02
#define HEARTRATE11_LS_NEW_DATA                     0x01
 
#define HEARTRATE11_TS_DATA_STATUS                  0x80
#define HEARTRATE11_FIFO_AFULL_STATUS               0x20
#define HEARTRATE11_PPG_DATA_STATUS                 0x10
#define HEARTRATE11_PS_LOGIC_STATUS                 0x04
#define HEARTRATE11_PS_INT_STATUS                   0x02
#define HEARTRATE11_PS_NEW_DATA                     0x01
 
#define HEARTRATE11_SW_RESET                        0x80
#define HEARTRATE11_LS_SAI_ON                       0x08
#define HEARTRATE11_LS_SAI_OFF                      0x00
#define HEARTRATE11_ALS_MODE                        0x00
#define HEARTRATE11_RGB_MODE                        0x02
#define HEARTRATE11_LS_OFF                          0x00
#define HEARTRATE11_LS_ON                           0x01
 
#define HEARTRATE11_PS_SAI_ON                       0x08
#define HEARTRATE11_PS_SAI_OFF                      0x00
#define HEARTRATE11_PS_MODE                         0x00
#define HEARTRATE11_HR_MODE                         0x02
#define HEARTRATE11_SPO2_MODE                       0x04
#define HEARTRATE11_PPG_PS_ON                       0x01
#define HEARTRATE11_PPG_PS_OFF                      0x00
 
#define HEARTRATE11_PS_LED                          0
#define HEARTRATE11_IR_LED                          1
#define HEARTRATE11_RED_LED                         2
#define HEARTRATE11_IR_LED_DEFAULT_CURRENT          50.0
#define HEARTRATE11_PS_IR_LED_MAX_CURRENT           250.0
#define HEARTRATE11_RED_LED_MAX_CURRENT             125.0
#define HEARTRATE11_PS_IR_LED_CURRENT_RES           0x03FF
#define HEARTRATE11_RED_LED_CURRENT_RES             0x01FF
#define HEARTRATE11_ROUND_TO_NEAREST_INT            0.5
 
#define HEARTRATE11_PS_CAN_ANA_OFF                  0x00
#define HEARTRATE11_PS_CAN_ANA_ON                   0x40
#define HEARTRATE11_PS_PULSES( x )                  ( ( x ) & ( 0x07 ) ) << 3 ) // Where x = 0..5 and num pulses = 2^x
#define HEARTRATE11_PS_CAN_PULSES_RESERVED          0x02
 
#define HEARTRATE11_PS_PWIDTH_26US                  0x00
#define HEARTRATE11_PS_PWIDTH_42US                  0x10
#define HEARTRATE11_PS_PWIDTH_71US                  0x20
#define HEARTRATE11_PS_RATE_3p125MS                 0x00
#define HEARTRATE11_PS_RATE_6p25MS                  0x01
#define HEARTRATE11_PS_RATE_12p5MS                  0x02
#define HEARTRATE11_PS_RATE_25MS                    0x03
#define HEARTRATE11_PS_RATE_50MS                    0x04
#define HEARTRATE11_PS_RATE_100MS                   0x05
#define HEARTRATE11_PS_RATE_200MS                   0x06
#define HEARTRATE11_PS_RATE_400MS                   0x07
 
#define HEARTRATE11_PS_MOV_AVG_ON                   0x80
#define HEARTRATE11_PS_MOV_AVG_OFF                  0x00
#define HEARTRATE11_PS_HYS_LEVEL( x )               ( x >> 1 )  // Where x = 0..254
 
#define HEARTRATE11_LS_RES_20BIT_400MS              0x00
#define HEARTRATE11_LS_RES_19BIT_200MS              0x10
#define HEARTRATE11_LS_RES_18BIT_100MS              0x20
#define HEARTRATE11_LS_RES_17BIT_50MS               0x30
#define HEARTRATE11_LS_RES_16BIT_25MS               0x40
#define HEARTRATE11_LS_RES_13BIT_3p125MS            0x50
#define HEARTRATE11_LS_RATE_25MS                    0x00
#define HEARTRATE11_LS_RATE_50MS                    0x01
#define HEARTRATE11_LS_RATE_100MS                   0x02
#define HEARTRATE11_LS_RATE_200MS                   0x03
#define HEARTRATE11_LS_RATE_500MS                   0x04
#define HEARTRATE11_LS_RATE_1000MS                  0x05
#define HEARTRATE11_LS_RATE_2000MS                  0x06
 
#define HEARTRATE11_LS_GAIN_1                       0x00
#define HEARTRATE11_LS_GAIN_3                       0x01
#define HEARTRATE11_LS_GAIN_6                       0x02
 
#define HEARTRATE11_LS_INT_SEL_C                    0x00
#define HEARTRATE11_LS_INT_SEL_G                    0x10
#define HEARTRATE11_LS_INT_SEL_R                    0x20
#define HEARTRATE11_LS_INT_SEL_B                    0x30
#define HEARTRATE11_LS_THRES_INT_MODE               0x00
#define HEARTRATE11_LS_VAR_INT_MODE                 0x02
#define HEARTRATE11_LS_INT_OFF                      0x00
#define HEARTRATE11_LS_INT_ON                       0x01
 
#define HEARTRATE11_AFULL_INT_OFF                   0x00
#define HEARTRATE11_AFULL_INT_ON                    0x20
#define HEARTRATE11_PPG_INT_OFF                     0x00
#define HEARTRATE11_PPG_INT_ON                      0x10
#define HEARTRATE11_PS_INT_LOGIC                    0x02
#define HEARTRATE11_PS_INT_OFF                      0x00
#define HEARTRATE11_PS_INT_ON                       0x01
 
#define HEARTRATE11_LS_PERSIST( x )                 ( ( x & 0x0F ) << 4 )
#define HEARTRATE11_PS_PERSIST( x )                 ( x & 0x0F)
 
#define HEARTRATE11_PPG_PS_GAIN_1                   0x00
#define HEARTRATE11_PPG_PS_GAIN_1p5                 0x10
#define HEARTRATE11_PPG_PS_GAIN_2                   0x20
#define HEARTRATE11_PPG_PS_GAIN_4                   0x30
#define HEARTRATE11_PPG_PS_GAIN_RESERVED            0x09
 
#define HEARTRATE11_PPG_POW_SAVE_OFF                0x00
#define HEARTRATE11_PPG_POW_SAVE_ON                 0x40
#define HEARTRATE11_LED_FLIP_OFF                    0x00
#define HEARTRATE11_LED_FLIP_ON                     0x08
 
#define HEARTRATE11_PPG_CH1_CAN_ANA_OFF             0x00
#define HEARTRATE11_PPG_CH1_CAN_ANA_ON              0x04
#define HEARTRATE11_PPG_CH2_CAN_ANA_OFF             0x00
#define HEARTRATE11_PPG_CH2_CAN_ANA_ON              0x04
 
#define HEARTRATE11_PPG_AVG_1                       0x00
#define HEARTRATE11_PPG_AVG_2                       0x10
#define HEARTRATE11_PPG_AVG_4                       0x20
#define HEARTRATE11_PPG_AVG_8                       0x30
#define HEARTRATE11_PPG_AVG_16                      0x40
#define HEARTRATE11_PPG_AVG_32                      0x50
#define HEARTRATE11_PPG_AVG_RESERVED                0x0A
 
#define HEARTRATE11_PPG_PWIDTH_130US                0x30
#define HEARTRATE11_PPG_PWIDTH_247US                0x40
#define HEARTRATE11_PPG_PWIDTH_481US                0x50
#define HEARTRATE11_PPG_PWIDTH_949US                0x60
#define HEARTRATE11_PPG_RATE_0p3125MS               0x00
#define HEARTRATE11_PPG_RATE_0p625MS                0x01
#define HEARTRATE11_PPG_RATE_1MS                    0x02
#define HEARTRATE11_PPG_RATE_1p25MS                 0x03
#define HEARTRATE11_PPG_RATE_2p5MS                  0x04
#define HEARTRATE11_PPG_RATE_5MS                    0x05
#define HEARTRATE11_PPG_RATE_10MS                   0x06
#define HEARTRATE11_PPG_RATE_20MS                   0x07
 
#define HEARTRATE11_FIFO_ROLL_OFF                   0x00
#define HEARTRATE11_FIFO_ROLL_ON                    0x10
#define HEARTRATE11_FIFO_AFULL_WARNING( x )         ( x & 0x0F )
 
#define HEARTRATE11_FIFO_INDEX( x )                 ( x & 0x1F )
 
#define HEARTRATE11_DEVICE_ADDRESS                  0x53
 
 // heartrate11_set
 
#define HEARTRATE11_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // heartrate11_map
 // heartrate11
 
typedef struct
{
    // Input pins
    digital_in_t int_pin;           
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
} heartrate11_t;
 
typedef struct
{
    pin_name_t  scl;                
    pin_name_t  sda;                
    pin_name_t  int_pin;            
    uint32_t  i2c_speed;            
    uint8_t   i2c_address;          
} heartrate11_cfg_t;
 
typedef enum
{
    HEARTRATE11_OK = 0,
    HEARTRATE11_ERROR = -1
 
} heartrate11_return_value_t;
 
void heartrate11_cfg_setup ( heartrate11_cfg_t *cfg );
 
err_t heartrate11_init ( heartrate11_t *ctx, heartrate11_cfg_t *cfg );
 
err_t heartrate11_default_cfg ( heartrate11_t *ctx );
 
err_t heartrate11_generic_write ( heartrate11_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t heartrate11_generic_read ( heartrate11_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t heartrate11_write_register ( heartrate11_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t heartrate11_read_register ( heartrate11_t *ctx, uint8_t reg, uint8_t *data_out );
 
uint8_t heartrate11_get_int_pin ( heartrate11_t *ctx );
 
err_t heartrate11_reset_device ( heartrate11_t *ctx );
 
err_t heartrate11_set_led_current ( heartrate11_t *ctx, uint8_t led, float current );
 
err_t heartrate11_read_fifo ( heartrate11_t *ctx, uint32_t *fifo_data );
 
#ifdef __cplusplus
}
#endif
#endif // HEARTRATE11_H
 
 // heartrate11
 
// ------------------------------------------------------------------------ END