force3  2.0.0.0
Functions
Public function

Functions

void force3_cfg_setup (force3_cfg_t *cfg)
 Config Object Initialization function. More...
 
FORCE3_RETVAL force3_init (force3_t *ctx, force3_cfg_t *cfg)
 Initialization function. More...
 
void force3_generic_write (force3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function. More...
 
void force3_generic_read (force3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function. More...
 
uint16_t force3_read_raw_data (force3_t *ctx)
 Read 12bit raw data. More...
 

Detailed Description

Function Documentation

◆ force3_cfg_setup()

void force3_cfg_setup ( force3_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.

◆ force3_generic_read()

void force3_generic_read ( force3_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.

◆ force3_generic_write()

void force3_generic_write ( force3_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.

◆ force3_init()

FORCE3_RETVAL force3_init ( force3_t ctx,
force3_cfg_t cfg 
)

Initialization function.

Parameters
force3Click object.
cfgClick configuration structure.

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

◆ force3_read_raw_data()

uint16_t force3_read_raw_data ( force3_t ctx)

Read 12bit raw data.

Parameters
ctxClick object.
Returns
12bit data