Alcohol Click Driver

API for configuring and manipulating Alcohol Click driver. More...

Topics
	Alcohol MikroBUS Map
	MikroBUS pin mapping of Alcohol Click driver.

Functions
void	alcohol_cfg_setup (alcohol_cfg_t *cfg)
	Alcohol configuration object setup function.
err_t	alcohol_init (alcohol_t *ctx, alcohol_cfg_t *cfg)
	Alcohol initialization function.
err_t	alcohol_read_an_pin_value (alcohol_t *ctx, uint16_t *data_out)
	Alcohol read AN pin value function.
err_t	alcohol_read_an_pin_voltage (alcohol_t *ctx, float *data_out)
	Alcohol read AN pin voltage level function.

Detailed Description

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

alcohol_cfg_setup()

void alcohol_cfg_setup

(

alcohol_cfg_t *

cfg

)

Alcohol configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

alcohol_init()

err_t alcohol_init	(	alcohol_t *	ctx,
		alcohol_cfg_t *	cfg )

Alcohol initialization function.

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

Parameters

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

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

alcohol_read_an_pin_value()

err_t alcohol_read_an_pin_value	(	alcohol_t *	ctx,
		uint16_t *	data_out )

Alcohol read AN pin value function.

This function reads results of AD conversion of the AN pin.

Parameters

[in]	ctx	: Click context object. See alcohol_t object definition for detailed explanation.
[out]	data_out	: Output ADC result.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

alcohol_read_an_pin_voltage()

err_t alcohol_read_an_pin_voltage	(	alcohol_t *	ctx,
		float *	data_out )

Alcohol read AN pin voltage level function.

This function reads results of AD conversion of the AN pin and converts them to proportional voltage level.

Parameters

[in]	ctx	: Click context object. See alcohol_t object definition for detailed explanation.
[out]	data_out	: Output voltage level of the analog pin [V].

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

The conversion to voltage depends on the entered configuration of the ADC (resolution, reference voltage).