heartrate3  2.0.0.0
Functions

Functions

void heartrate3_cfg_setup (heartrate3_cfg_t *cfg)
 Config Object Initialization function. More...
 
HEARTRATE3_RETVAL heartrate3_init (heartrate3_t *ctx, heartrate3_cfg_t *cfg)
 Initialization function. More...
 
void heartrate3_default_cfg (heartrate3_t *ctx)
 Click Default Configuration function. More...
 
void heartrate3_generic_write (heartrate3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function. More...
 
void heartrate3_generic_read (heartrate3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function. More...
 
void heartrate3_write_data (heartrate3_t *ctx, uint8_t reg_adr, uint32_t wr_data)
 Write data function. More...
 
uint32_t heartrate3_read_u32 (heartrate3_t *ctx, uint8_t reg_adr)
 Read 32-bit data function. More...
 
uint16_t heartrate3_read_u16 (heartrate3_t *ctx, uint8_t reg_adr)
 Read 16-bit data function. More...
 
void heartrate3_rst_state (heartrate3_t *ctx, uint8_t state)
 Set Reset pin state. More...
 
void heartrate3_clk_state (heartrate3_t *ctx, uint8_t state)
 Set Clock pin state. More...
 
uint8_t heartrate3_check_data_ready (heartrate3_t *ctx)
 Check data ready function. More...
 

Detailed Description

Function Documentation

◆ heartrate3_cfg_setup()

void heartrate3_cfg_setup ( heartrate3_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ heartrate3_check_data_ready()

uint8_t heartrate3_check_data_ready ( heartrate3_t ctx)

Check data ready function.

Parameters
ctxClick object.
Returns
1 : data ready / 0 : data not ready

@description Function is used to check data ready flag.

◆ heartrate3_clk_state()

void heartrate3_clk_state ( heartrate3_t ctx,
uint8_t  state 
)

Set Clock pin state.

Parameters
ctxClick object.
state0 - clk pin cleared / 1 - clk pin set

@description Function is used to set or clear clk pin.

◆ heartrate3_default_cfg()

void heartrate3_default_cfg ( heartrate3_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for HeartRate3 click.

  HEARTRATE3_CONTROL0
-------------------------------------------
  HEARTRATE3_CONTROL0_CMD

HEARTRATE3_LED2STC

  HEARTRATE3_LED2STC_CMD
  HEARTRATE3_LED2ENDC
-------------------------------------------
  HEARTRATE3_LED2ENDC_CMD

HEARTRATE3_LED1LEDSTC

  HEARTRATE3_LED1LEDSTC_CMD
  HEARTRATE3_LED1LEDENDC
-------------------------------------------
  HEARTRATE3_LED1LEDENDC_CMD

HEARTRATE3_ALED2STC

  HEARTRATE3_ALED2STC_CMD
  HEARTRATE3_ALED2ENDC
-------------------------------------------
  HEARTRATE3_ALED2ENDC_CMD

HEARTRATE3_LED1STC

  HEARTRATE3_LED1STC_CMD
  HEARTRATE3_LED1ENDC
-------------------------------------------
  HEARTRATE3_LED1ENDC_CMD

HEARTRATE3_LED2LEDSTC

  HEARTRATE3_LED2LEDSTC_CMD
  HEARTRATE3_LED2LEDENDC
-------------------------------------------
  HEARTRATE3_LED2LEDENDC_CMD
  HEARTRATE3_ALED1STC
-------------------------------------------
  HEARTRATE3_ALED1STC_CMD
  HEARTRATE3_ALED1ENDC
-------------------------------------------
  HEARTRATE3_ALED1ENDC_CMD
  HEARTRATE3_LED2CONVST
-------------------------------------------
  HEARTRATE3_LED2CONVST_CMD
  HEARTRATE3_LED2CONVEND
-------------------------------------------
  HEARTRATE3_LED2CONVEND_CMD
  HEARTRATE3_ALED2CONVST
-------------------------------------------
  HEARTRATE3_ALED2CONVST_CMD
  HEARTRATE3_ALED2CONVEND
-------------------------------------------
  HEARTRATE3_ALED2CONVEND_CMD
  HEARTRATE3_LED1CONVST
-------------------------------------------
  HEARTRATE3_LED1CONVST_CMD
  HEARTRATE3_LED1CONVEND
-------------------------------------------
  HEARTRATE3_LED1CONVEND_CMD
  HEARTRATE3_ALED1CONVST
-------------------------------------------
  HEARTRATE3_ALED1CONVST_CMD
  HEARTRATE3_ALED1CONVEND
-------------------------------------------
  HEARTRATE3_ALED1CONVEND_CMD
  HEARTRATE3_ADCRSTSTCT0
-------------------------------------------
  HEARTRATE3_ADCRSTSTCT0_CMD
  HEARTRATE3_ADCRSTENDCT0
-------------------------------------------
  HEARTRATE3_ADCRSTENDCT0_CMD
  HEARTRATE3_ADCRSTSTCT1
-------------------------------------------
  HEARTRATE3_ADCRSTSTCT1_CMD
  HEARTRATE3_ADCRSTENDCT1
-------------------------------------------
  HEARTRATE3_ADCRSTENDCT1_CMD
  HEARTRATE3_ADCRSTSTCT2
-------------------------------------------
  HEARTRATE3_ADCRSTSTCT2_CMD
  HEARTRATE3_ADCRSTENDCT2
-------------------------------------------
  HEARTRATE3_ADCRSTENDCT2_CMD
  HEARTRATE3_ADCRSTSTCT3
-------------------------------------------
  HEARTRATE3_ADCRSTSTCT3_CMD
  HEARTRATE3_ADCRSTENDCT3
-------------------------------------------
  HEARTRATE3_ADCRSTENDCT3_CMD
  HEARTRATE3_PRPCOUNT
-------------------------------------------
  HEARTRATE3_PRPCOUNT_CMD
  HEARTRATE3_CONTROL1
-------------------------------------------
  HEARTRATE3_CONTROL1_CMD
  HEARTRATE3_TIA_GAIN_SEP
-------------------------------------------
  HEARTRATE3_TIA_GAIN_SEP_CMD
  HEARTRATE3_TIA_GAIN
-------------------------------------------
  HEARTRATE3_TIA_GAIN_CMD
  HEARTRATE3_LEDCNTRL
-------------------------------------------
  HEARTRATE3_LEDCNTRL_CMD
  HEARTRATE3_CONTROL2
-------------------------------------------
  HEARTRATE3_CONTROL2_CMD
  HEARTRATE3_ALARM
-------------------------------------------
  HEARTRATE3_ALARM_CMD
  HEARTRATE3_CONTROL3
-------------------------------------------
  HEARTRATE3_CONTROL3_CMD
  HEARTRATE3_PDNCYCLESTC
-------------------------------------------
  HEARTRATE3_PDNCYCLESTC_CMD
  HEARTRATE3_PDNCYCLEENDC
-------------------------------------------
  HEARTRATE3_PDNCYCLEENDC_CMD
  HEARTRATE3_PROG_TG_STC_CMD
-------------------------------------------
  HEARTRATE3_PROG_TG_STC
  HEARTRATE3_PROG_TG_ENDC
-------------------------------------------
  HEARTRATE3_PROG_TG_ENDC_CMD
  HEARTRATE3_LED3LEDSTC
-------------------------------------------
  HEARTRATE3_LED3LEDSTC_CMD
  HEARTRATE3_LED3LEDENDC
-------------------------------------------
  HEARTRATE3_LED3LEDENDC_CMD
  HEARTRATE3_CLKDIV_PRF
-------------------------------------------
  HEARTRATE3_CLKDIV_PRF_CMD
  HEARTRATE3_OFFDAC
-------------------------------------------
  HEARTRATE3_OFFDAC_CMD

◆ heartrate3_generic_read()

void heartrate3_generic_read ( heartrate3_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic read function.

Parameters
ctxClick object.
regRegister address.
data_bufOutput data buf
lenNumber of the bytes to be read

@description This function reads data from the desired register.

◆ heartrate3_generic_write()

void heartrate3_generic_write ( heartrate3_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic write function.

Parameters
ctxClick object.
regRegister address.
data_bufData buf to be written.
lenNumber of the bytes in data buf.

@description This function writes data to the desired register.

◆ heartrate3_init()

HEARTRATE3_RETVAL heartrate3_init ( heartrate3_t ctx,
heartrate3_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

◆ heartrate3_read_u16()

uint16_t heartrate3_read_u16 ( heartrate3_t ctx,
uint8_t  reg_adr 
)

Read 16-bit data function.

Parameters
ctxClick object.
reg_adr8-bit data that defines register's address
Returns
result 16-bit value read from chosen register

@description Function is used to read 16-bit value from register.

◆ heartrate3_read_u32()

uint32_t heartrate3_read_u32 ( heartrate3_t ctx,
uint8_t  reg_adr 
)

Read 32-bit data function.

Parameters
ctxClick object.
reg_adr8-bit data that defines register's address
Returns
result 32-bit value read from chosen register

@description Function is used to read 32-bit value from register.

◆ heartrate3_rst_state()

void heartrate3_rst_state ( heartrate3_t ctx,
uint8_t  state 
)

Set Reset pin state.

Parameters
ctxClick object.
state0 - rst pin cleared / 1 - rst pin set

@description Function is used to set or clear rst pin.

◆ heartrate3_write_data()

void heartrate3_write_data ( heartrate3_t ctx,
uint8_t  reg_adr,
uint32_t  wr_data 
)

Write data function.

Parameters
ctxClick object.
reg_adr8-bit data that defines register's address
wr_data32-bit used defined data to be written into register

@description Function is used to write 32-bit data into register.