dualee  2.0.0.0
Functions
Public function

Functions

void dualee_cfg_setup (dualee_cfg_t *cfg)
 Config Object Initialization function. More...
 
DUALEE_RETVAL dualee_init (dualee_t *ctx, dualee_cfg_t *cfg)
 Initialization function. More...
 
void dualee_generic_write (dualee_t *ctx, uint8_t *reg, uint8_t *data_buf, uint8_t len)
 Generic write function. More...
 
void dualee_generic_read (dualee_t *ctx, uint8_t *reg, uint8_t *data_buf, uint8_t len)
 Generic read function. More...
 
uint8_t dualee_write (dualee_t *ctx, uint32_t reg_address, uint8_t *data_buff, uint8_t n_bytes)
 Generic write data function. More...
 
uint8_t dualee_read (dualee_t *ctx, uint32_t reg_address, uint8_t *data_buff, uint8_t n_bytes)
 Generic write data function. More...
 

Detailed Description

Function Documentation

◆ dualee_cfg_setup()

void dualee_cfg_setup ( dualee_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.

◆ dualee_generic_read()

void dualee_generic_read ( dualee_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.

◆ dualee_generic_write()

void dualee_generic_write ( dualee_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.

◆ dualee_init()

DUALEE_RETVAL dualee_init ( dualee_t ctx,
dualee_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ dualee_read()

uint8_t dualee_read ( dualee_t ctx,
uint32_t  reg_address,
uint8_t *  data_buff,
uint8_t  n_bytes 
)

Generic write data function.

Parameters
ctxClick object.
reg_addressAddress from where data will be read
data_buffOUTPUT buffer data
n_bytesNumber of bytes data

@description either _DUALEE_SUCCESSFUL_RW or _DUALEE_ERROR_RW.

◆ dualee_write()

uint8_t dualee_write ( dualee_t ctx,
uint32_t  reg_address,
uint8_t *  data_buff,
uint8_t  n_bytes 
)

Generic write data function.

Parameters
ctxClick object.
reg_addressAddress from where data will be written
data_buffINPUT buffer data
n_bytesNumber of bytes data

@description either _DUALEE_SUCCESSFUL_RW or _DUALEE_ERROR_RW.