MIC 3 Click Driver

API for configuring and manipulating MIC 3 Click driver. More...

Topics
	MIC 3 Registers Settings
	Settings for registers of MIC 3 Click driver.
	MIC 3 MikroBUS Map
	MikroBUS pin mapping of MIC 3 Click driver.

Functions
void	mic3_cfg_setup (mic3_cfg_t *cfg)
	MIC 3 configuration object setup function.
err_t	mic3_init (mic3_t *ctx, mic3_cfg_t *cfg)
	MIC 3 initialization function.
err_t	mic3_default_cfg (mic3_t *ctx)
	MIC 3 default configuration function.
void	mic3_shd_pin_set (mic3_t *ctx, uint8_t state)
	MIC 3 SHD pin setting function.

Detailed Description

API for configuring and manipulating MIC 3 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

mic3_cfg_setup()

void mic3_cfg_setup

(

mic3_cfg_t *

cfg

)

MIC 3 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

mic3_default_cfg()

err_t mic3_default_cfg

(

mic3_t *

ctx

)

MIC 3 default configuration function.

This function executes a default configuration of MIC 3 click board.

Parameters

[in]

ctx

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

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

This function can consist any necessary configuration or setting to put device into operating mode.

mic3_init()

err_t mic3_init	(	mic3_t *	ctx,
		mic3_cfg_t *	cfg )

MIC 3 initialization function.

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

Parameters

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

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

mic3_shd_pin_set()

void mic3_shd_pin_set	(	mic3_t *	ctx,
		uint8_t	state )

MIC 3 SHD pin setting function.

This function sets the target pin on the high level of MIC 3 click board.

Parameters

[in]	ctx	: Click context object. See mic3_t object definition for detailed explanation.
[in]	state	: State of the SHD pin.

Returns

Nothing.