touchkey 2.0.0.0
Public function

Functions

void touchkey_cfg_setup (touchkey_cfg_t *cfg)
 Config Object Initialization function.
 
TOUCHKEY_RETVAL touchkey_init (touchkey_t *ctx, touchkey_cfg_t *cfg)
 Initialization function.
 
uint8_t touchkey_a (touchkey_t *ctx)
 Taster A pressed function.
 
uint8_t touchkey_b (touchkey_t *ctx)
 Taster B pressed function.
 
uint8_t touchkey_c (touchkey_t *ctx)
 Taster C pressed function.
 
uint8_t touchkey_d (touchkey_t *ctx)
 Taster D pressed function.
 

Detailed Description

Function Documentation

◆ touchkey_a()

uint8_t touchkey_a ( touchkey_t * ctx)

Taster A pressed function.

Parameters
ctxClick object.
Returns
1 : Key A pressed. 0 : Key A not pressed.

Function gets state of "a" (RST) pin on TouchKey Click board.

◆ touchkey_b()

uint8_t touchkey_b ( touchkey_t * ctx)

Taster B pressed function.

Parameters
ctxClick object.
Returns
1 : Key B pressed. 0 : Key B not pressed.

@description Function gets state of "b" (AN) pin on TouchKey Click board.

◆ touchkey_c()

uint8_t touchkey_c ( touchkey_t * ctx)

Taster C pressed function.

Parameters
ctxClick object.
Returns
1 : Key C pressed. 0 : Key C not pressed.

@description Function gets state of "c" (PWM) pin on TouchKey Click board.

◆ touchkey_cfg_setup()

void touchkey_cfg_setup ( touchkey_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.

◆ touchkey_d()

uint8_t touchkey_d ( touchkey_t * ctx)

Taster D pressed function.

Parameters
ctxClick object.
Returns
1 : Key D pressed. 0 : Key D not pressed.

@description Function gets state of "d" (INT) pin on TouchKey Click board.

◆ touchkey_init()

TOUCHKEY_RETVAL touchkey_init ( touchkey_t * ctx,
touchkey_cfg_t * cfg )

Initialization function.

Parameters
touchkeyClick object.
cfgClick configuration structure.

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