ecg_gsr  2.0.0.0
Functions
Public function

Functions

void ecg_gsr_cfg_setup (ecg_gsr_cfg_t *cfg)
 ECG GSR configuration object setup function. More...
 
ecg_gsr_err_t ecg_gsr_init (ecg_gsr_t *ctx, ecg_gsr_cfg_t *cfg)
 Initialization function. More...
 
void ecg_gsr_default_cfg (ecg_gsr_t *ctx, ecg_gsr_cfg_t *cfg)
 Click Default Configuration function. More...
 
ecg_gsr_err_t ecg_gsr_write_reg (ecg_gsr_t *ctx, uint8_t register_address, uint8_t transfer_data)
 Generic Write function. More...
 
ecg_gsr_err_t ecg_gsr_read_reg (ecg_gsr_t *ctx, uint8_t register_address, uint16_t *data_out, uint8_t num_of_regs)
 Generic Read function. More...
 
void ecg_gsr_read_dev_id (ecg_gsr_t *ctx, uint8_t register_address, uint8_t *dev_id_out, uint8_t num_of_regs)
 ECG GSR Read ID function. More...
 
void ecg_gsr_reset (ecg_gsr_t *ctx)
 ECG GSR Reset function. More...
 

Detailed Description

Function Documentation

◆ ecg_gsr_cfg_setup()

void ecg_gsr_cfg_setup ( ecg_gsr_cfg_t cfg)

ECG GSR configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[in]*cfgClick configuration structure.
Note
All used pins will be set to unconnected state.

◆ ecg_gsr_default_cfg()

void ecg_gsr_default_cfg ( ecg_gsr_t ctx,
ecg_gsr_cfg_t cfg 
)

Click Default Configuration function.

This function executes default configuration for ECG GSR Click.

Parameters
[in]*ctxClick object.
[in]*cfgClick configuration structure.

◆ ecg_gsr_init()

ecg_gsr_err_t ecg_gsr_init ( ecg_gsr_t ctx,
ecg_gsr_cfg_t cfg 
)

Initialization function.

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

Parameters
[in]*ctxClick object.
[in]*cfgClick configuration structure.
Returns
0 - OK, 1 - I2C Master Open functionality has failed.

◆ ecg_gsr_read_dev_id()

void ecg_gsr_read_dev_id ( ecg_gsr_t ctx,
uint8_t  register_address,
uint8_t *  dev_id_out,
uint8_t  num_of_regs 
)

ECG GSR Read ID function.

Function performs reading of an ID of the device.

Parameters
[in]*ctxClick object.
[in]*register_addressRegister which will be read.
[out]*dev_id_outBuffer for storing identification number that has been read.
[in]num_of_regsNumber of registers to be read.

◆ ecg_gsr_read_reg()

ecg_gsr_err_t ecg_gsr_read_reg ( ecg_gsr_t ctx,
uint8_t  register_address,
uint16_t *  data_out,
uint8_t  num_of_regs 
)

Generic Read function.

Function reads 8-bit data from the register/registers.

Parameters
[in]*cfgClick configuration.
[in]*register_addressRegister which will be read.
[out]*data_outBuffer for storing data that has been read.
[in]num_of_regsNumber of registers to be read.
Returns
0 - OK, 1 - Wrong address parameter.

◆ ecg_gsr_reset()

void ecg_gsr_reset ( ecg_gsr_t ctx)

ECG GSR Reset function.

Function performs the SW reset of the device and waits until the device returns back to normal state.

Parameters
[in]*ctxClick object.

◆ ecg_gsr_write_reg()

ecg_gsr_err_t ecg_gsr_write_reg ( ecg_gsr_t ctx,
uint8_t  register_address,
uint8_t  transfer_data 
)

Generic Write function.

Function writes 8-bit data to the register.

Parameters
[in]*ctxClick object.
[in]register_addressRegister which will be written to.
[in]transfer_dataData to be written.
Returns
0 - OK, 1 - Wrong address parameter.