touchkey2 2.0.0.0
Functions

Functions

void touchkey2_cfg_setup (touchkey2_cfg_t *cfg)
 Config Object Initialization function. More...
 
TOUCHKEY2_RETVAL touchkey2_init (touchkey2_t *ctx, touchkey2_cfg_t *cfg)
 Initialization function. More...
 
void touchkey2_generic_multi_write (touchkey2_t *ctx, char *data_buf, uint8_t len)
 Generic multi write function. More...
 
void touchkey2_generic_multi_read (touchkey2_t *ctx, char *data_buf, uint8_t len)
 Generic multi read function. More...
 
char touchkey2_generic_single_read (touchkey2_t *ctx)
 Generic single read function. More...
 
void touchkey2_generic_single_write (touchkey2_t *ctx, char tx_data)
 Generic single write function. More...
 
void touchkey2_set_reset_pin (touchkey2_t *ctx)
 Set reset pin function. More...
 
void touchkey2_clear_reset_pin (touchkey2_t *ctx)
 Clear reset pin function. More...
 
void touchkey2_target_reset (touchkey2_t *ctx)
 Reset function. More...
 

Detailed Description

Function Documentation

◆ touchkey2_cfg_setup()

void touchkey2_cfg_setup ( touchkey2_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.

◆ touchkey2_clear_reset_pin()

void touchkey2_clear_reset_pin ( touchkey2_t ctx)

Clear reset pin function.

Parameters
ctxClick object.

@description This function is used to clear the reset pin.

◆ touchkey2_generic_multi_read()

void touchkey2_generic_multi_read ( touchkey2_t ctx,
char *  data_buf,
uint8_t  len 
)

Generic multi read function.

Parameters
ctxClick object.
data_bufOutput data buffer.
lenNumber of the bytes in data buffer.

@description This function reads data.

◆ touchkey2_generic_multi_write()

void touchkey2_generic_multi_write ( touchkey2_t ctx,
char *  data_buf,
uint8_t  len 
)

Generic multi write function.

Parameters
ctxClick object.
data_bufInput data buffer
lenNumber of the bytes in the data buffer

@description This function writes data.

◆ touchkey2_generic_single_read()

char touchkey2_generic_single_read ( touchkey2_t ctx)

Generic single read function.

Parameters
ctxClick object.
Returns
one byte data

@description This function read one byte data.

◆ touchkey2_generic_single_write()

void touchkey2_generic_single_write ( touchkey2_t ctx,
char  tx_data 
)

Generic single write function.

Parameters
ctxClick object.
tx_dataInput data

@description This function write one byte data.

◆ touchkey2_init()

TOUCHKEY2_RETVAL touchkey2_init ( touchkey2_t ctx,
touchkey2_cfg_t cfg 
)

Initialization function.

Parameters
touchkey2Click object.
cfgClick configuration structure.

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

◆ touchkey2_set_reset_pin()

void touchkey2_set_reset_pin ( touchkey2_t ctx)

Set reset pin function.

Parameters
ctxClick object.

@description This function is used to set the reset pin.

◆ touchkey2_target_reset()

void touchkey2_target_reset ( touchkey2_t ctx)

Reset function.

Parameters
ctxClick object.

@description This function is used to reset the device.