captouch  2.0.0.0
Functions
Public function

Functions

void captouch_cfg_setup (captouch_cfg_t *cfg)
 Config Object Initialization function. More...
 
CAPTOUCH_RETVAL captouch_init (captouch_t *ctx, captouch_cfg_t *cfg)
 Initialization function. More...
 
void captouch_default_cfg (captouch_t *ctx)
 Click Default Configuration function. More...
 
void captouch_set_mode (captouch_t *ctx, uint8_t mode)
 Select mode. More...
 
uint8_t captouch_get_touch (captouch_t *ctx)
 Get touch state. More...
 

Detailed Description

Function Documentation

◆ captouch_cfg_setup()

void captouch_cfg_setup ( captouch_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ captouch_default_cfg()

void captouch_default_cfg ( captouch_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

This function executes default configuration for CapTouch click.

◆ captouch_get_touch()

uint8_t captouch_get_touch ( captouch_t ctx)

Get touch state.

Parameters
ctxClick object.
Returns
Touch state

◆ captouch_init()

CAPTOUCH_RETVAL captouch_init ( captouch_t ctx,
captouch_cfg_t cfg 
)

Initialization function.

Parameters
captouchClick object.
cfgClick configuration structure.

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

◆ captouch_set_mode()

void captouch_set_mode ( captouch_t ctx,
uint8_t  mode 
)

Select mode.

Parameters
ctxClick object.
modeSensor mode (Low power mode or Fast mode(default)).