Analog MUX 4 Click Driver

API for configuring and manipulating Analog MUX 4 Click driver. More...

Topics
	Analog MUX 4 Registers Settings
	Settings for registers of Analog MUX 4 Click driver.
	Analog MUX 4 MikroBUS Map
	MikroBUS pin mapping of Analog MUX 4 Click driver.

Functions
void	analogmux4_cfg_setup (analogmux4_cfg_t *cfg)
	Analog MUX 4 configuration object setup function.
err_t	analogmux4_init (analogmux4_t *ctx, analogmux4_cfg_t *cfg)
	Analog MUX 4 initialization function.
err_t	analogmux4_read_an_pin_value (analogmux4_t *ctx, uint16_t *data_out)
	Analog MUX 4 read AN pin value function.
err_t	analogmux4_read_an_pin_voltage (analogmux4_t *ctx, float *data_out)
	Analog MUX 4 read AN pin voltage level function.
void	analogmux4_enable_input (analogmux4_t *ctx)
	Analog MUX 4 enable input function.
void	analogmux4_disable_input (analogmux4_t *ctx)
	Analog MUX 4 disable input function.
void	analogmux4_set_input_channel (analogmux4_t *ctx, uint8_t channel)
	Analog MUX 4 set input channel function.

Detailed Description

API for configuring and manipulating Analog MUX 4 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

analogmux4_cfg_setup()

void analogmux4_cfg_setup

(

analogmux4_cfg_t *

cfg

)

Analog MUX 4 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

analogmux4_disable_input()

void analogmux4_disable_input

(

analogmux4_t *

ctx

)

Analog MUX 4 disable input function.

This function disables analog inputs.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

analogmux4_enable_input()

void analogmux4_enable_input

(

analogmux4_t *

ctx

)

Analog MUX 4 enable input function.

This function enables analog inputs.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

analogmux4_init()

err_t analogmux4_init	(	analogmux4_t *	ctx,
		analogmux4_cfg_t *	cfg )

Analog MUX 4 initialization function.

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

Parameters

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

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

analogmux4_read_an_pin_value()

err_t analogmux4_read_an_pin_value	(	analogmux4_t *	ctx,
		uint16_t *	data_out )

Analog MUX 4 read AN pin value function.

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

Parameters

[in]	ctx	: Click context object. See analogmux4_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.

analogmux4_read_an_pin_voltage()

err_t analogmux4_read_an_pin_voltage	(	analogmux4_t *	ctx,
		float *	data_out )

Analog MUX 4 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 analogmux4_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).

analogmux4_set_input_channel()

void analogmux4_set_input_channel	(	analogmux4_t *	ctx,
		uint8_t	channel )

Analog MUX 4 set input channel function.

This function sets the analog input channel.

Parameters

[in]	ctx	: Click context object. See analogmux4_t object definition for detailed explanation.
[in]	channel	: Channel selection [0-7].

Returns

None.

Note

None.