Cap Touch 6 Click Driver

API for configuring and manipulating Cap Touch 6 Click driver. More...

Topics
	Cap Touch 6 MikroBUS Map
	MikroBUS pin mapping of Cap Touch 6 Click driver.

Functions
void	captouch6_cfg_setup (captouch6_cfg_t *cfg)
	Cap Touch 6 configuration object setup function.
err_t	captouch6_init (captouch6_t *ctx, captouch6_cfg_t *cfg)
	Cap Touch 6 initialization function.
uint8_t	captouch6_get_tout_pin (captouch6_t *ctx)
	Cap Touch 6 get tout pin function.
uint8_t	captouch6_get_pout_pin (captouch6_t *ctx)
	Cap Touch 6 get pout pin function.

Detailed Description

API for configuring and manipulating Cap Touch 6 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

captouch6_cfg_setup()

void captouch6_cfg_setup

(

captouch6_cfg_t *

cfg

)

Cap Touch 6 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See captouch6_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

captouch6_get_pout_pin()

uint8_t captouch6_get_pout_pin

(

captouch6_t *

ctx

)

Cap Touch 6 get pout pin function.

This function returns the POUT pin logic state.

Parameters

[in]

ctx

: Click context object. See captouch6_t object definition for detailed explanation.

Returns

• 0 - Low pin state,
• 1 - High pin state.

Note

None.

captouch6_get_tout_pin()

uint8_t captouch6_get_tout_pin

(

captouch6_t *

ctx

)

Cap Touch 6 get tout pin function.

This function returns the TOUT pin logic state.

Parameters

[in]

ctx

: Click context object. See captouch6_t object definition for detailed explanation.

Returns

• 0 - Low pin state,
• 1 - High pin state.

Note

None.

captouch6_init()

err_t captouch6_init	(	captouch6_t *	ctx,
		captouch6_cfg_t *	cfg )

Cap Touch 6 initialization function.

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

Parameters

[out]	ctx	: Click context object. See captouch6_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See captouch6_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.