heartrate5.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 HEARTRATE5_H
#define HEARTRATE5_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 HEARTRATE5_REG0H                       0x00
#define HEARTRATE5_REG1H                       0x01
#define HEARTRATE5_REG2H                       0x02
#define HEARTRATE5_REG3H                       0x03
#define HEARTRATE5_REG4H                       0x04
#define HEARTRATE5_REG5H                       0x05
#define HEARTRATE5_REG6H                       0x06
#define HEARTRATE5_REG7H                       0x07
#define HEARTRATE5_REG8H                       0x08
#define HEARTRATE5_REG9H                       0x09
#define HEARTRATE5_REGAH                       0x0A
#define HEARTRATE5_REGBH                       0x0B
#define HEARTRATE5_REGCH                       0x0C
#define HEARTRATE5_REGDH                       0x0D
#define HEARTRATE5_REGEH                       0x0E
#define HEARTRATE5_REGFH                       0x0F
#define HEARTRATE5_REG10H                      0x10
#define HEARTRATE5_REG11H                      0x11
#define HEARTRATE5_REG12H                      0x12
#define HEARTRATE5_REG13H                      0x13
#define HEARTRATE5_REG14H                      0x14
#define HEARTRATE5_REG15H                      0x15
#define HEARTRATE5_REG16H                      0x16
#define HEARTRATE5_REG17H                      0x17
#define HEARTRATE5_REG18H                      0x18
#define HEARTRATE5_REG19H                      0x19
#define HEARTRATE5_REG1AH                      0x1A
#define HEARTRATE5_REG1BH                      0x1B
#define HEARTRATE5_REG1CH                      0x1C
 
#define HEARTRATE5_REG1DH                      0x1D
#define HEARTRATE5_REG1EH                      0x1E
#define HEARTRATE5_REG20H                      0x20
#define HEARTRATE5_REG21H                      0x21
#define HEARTRATE5_REG22H                      0x22
#define HEARTRATE5_REG23H                      0x23
#define HEARTRATE5_REG29H                      0x29
 
#define HEARTRATE5_REG2AH                      0x2A
#define HEARTRATE5_REG2BH                      0x2B
#define HEARTRATE5_REG2CH                      0x2C
#define HEARTRATE5_REG2DH                      0x2D
#define HEARTRATE5_REG2EH                      0x2E
#define HEARTRATE5_REG2FH                      0x2F
#define HEARTRATE5_REG31H                      0x31
 
#define HEARTRATE5_REG32H                      0x32
#define HEARTRATE5_REG33H                      0x33
 
#define HEARTRATE5_REG34H                      0x34
#define HEARTRATE5_REG35H                      0x35
 
#define HEARTRATE5_REG36H                      0x36
#define HEARTRATE5_REG37H                      0x37
 
#define HEARTRATE5_REG39H                      0x39
#define HEARTRATE5_REG3AH                      0x3A
#define HEARTRATE5_REG3DH                      0x3D
#define HEARTRATE5_REG3FH                      0x3F
#define HEARTRATE5_REG40H                      0x40
 
 // heartrate5_reg
 
#define HEARTRATE5_SET_DEV_ADDR  0x58
 
 // heartrate5_set
 
#define HEARTRATE5_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // heartrate5_map
 // heartrate5
 
typedef struct
{
    // Output pins
    digital_out_t  rst;             
    // Input pins
    digital_in_t  int_pin;          
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
} heartrate5_t;
 
typedef struct
{
    pin_name_t  scl;                
    pin_name_t  sda;                
    pin_name_t  rst;                
    pin_name_t  int_pin;            
    uint32_t  i2c_speed;            
    uint8_t   i2c_address;          
} heartrate5_cfg_t;
 
typedef enum
{
    HEARTRATE5_OK = 0,
    HEARTRATE5_ERROR = -1
 
} heartrate5_return_value_t;
 
void heartrate5_cfg_setup ( heartrate5_cfg_t *cfg );
 
err_t heartrate5_init ( heartrate5_t *ctx, heartrate5_cfg_t *cfg );
 
err_t heartrate5_default_cfg ( heartrate5_t *ctx );
 
err_t heartrate5_generic_write ( heartrate5_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t heartrate5_generic_read ( heartrate5_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
void heartrate5_write_reg( heartrate5_t *ctx, uint8_t reg_addr, uint32_t write_data ); 
 
uint32_t heartrate5_read_reg( heartrate5_t *ctx, uint8_t reg_addr ); 
 
void heartrate5_hw_reset( heartrate5_t *ctx ); 
 
void heartrate5_sw_reset( heartrate5_t *ctx );
 
uint32_t heartrate5_get_led2_val( heartrate5_t *ctx  );
 
uint32_t heartrate5_get_aled2_val_led3v_al( heartrate5_t *ctx );
 
uint32_t heartrate5_get_led1_val( heartrate5_t *ctx );
 
uint32_t heartrate5_get_aled1_val( heartrate5_t *ctx );
 
uint32_t heartrate5_get_led2_aled2_val( heartrate5_t *ctx ); 
 
uint32_t heartrate5_get_led1_aled1_val( heartrate5_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // HEARTRATE5_H
 
 // heartrate5
 
// ------------------------------------------------------------------------ END