ADC 14 Click Driver

API for configuring and manipulating ADC 14 Click driver. More...

Topics
	ADC 14 Registers Settings
	Settings for registers of ADC 14 Click driver.
	ADC 14 MikroBUS Map
	MikroBUS pin mapping of ADC 14 Click driver.

Functions
void	adc14_cfg_setup (adc14_cfg_t *cfg)
	ADC 14 configuration object setup function.
err_t	adc14_init (adc14_t *ctx, adc14_cfg_t *cfg)
	ADC 14 initialization function.
void	adc14_device_shutdown (adc14_t *ctx)
	ADC 14 device shutdown function.
void	adc14_device_power_up (adc14_t *ctx)
	ADC 14 device shutdown function.
err_t	adc14_read_conversion_data (adc14_t *ctx, uint16_t *adc_data)
	ADC 14 read conversion data function.
err_t	adc14_get_voltage (adc14_t *ctx, float *voltage)
	ADC 14 get voltage function.
err_t	adc14_set_vref (adc14_t *ctx, float vref)
	ADC 14 set voltage reference function.

Detailed Description

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

adc14_cfg_setup()

void adc14_cfg_setup

(

adc14_cfg_t *

cfg

)

ADC 14 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

adc14_device_power_up()

void adc14_device_power_up

(

adc14_t *

ctx

)

ADC 14 device shutdown function.

This function is used for the device power up and enabled internal voltage reference [2.048V] of the MCP1501, High-Precision Buffered Voltage Reference on the ADC 14 Click board™.

Parameters

[out]

ctx

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

Returns

Nothing.

Note

Before using the Shutdown pin, the device should first be powered up. Once the device is fully powered up, the Shutdown pin can be used.

adc14_device_shutdown()

void adc14_device_shutdown

(

adc14_t *

ctx

)

ADC 14 device shutdown function.

This function is used for the device shutdown voltage reference of the MCP1501, High-Precision Buffered Voltage Reference on the ADC 14 Click board™.

Parameters

[out]

ctx

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

Returns

Nothing.

Note

None.

adc14_get_voltage()

err_t adc14_get_voltage	(	adc14_t *	ctx,
		float *	voltage )

ADC 14 get voltage function.

This function reads results of 12-Bit ADC raw data and converts them to proportional voltage level [mV], of the MAX11108, Low-Power, Serial 12-Bit ADC on the ADC 14 Click board™.

Parameters

[in]	ctx	: Click context object. See adc14_t object definition for detailed explanation.
[out]	voltage	: Output voltage level [mV].

Returns

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

Note

None.

adc14_init()

err_t adc14_init	(	adc14_t *	ctx,
		adc14_cfg_t *	cfg )

ADC 14 initialization function.

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

Parameters

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

Returns

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

Note

None.

adc14_read_conversion_data()

err_t adc14_read_conversion_data	(	adc14_t *	ctx,
		uint16_t *	adc_data )

ADC 14 read conversion data function.

This function is used to reads 12-Bit ADC raw data value of the MAX11108, Low-Power, Serial 12-Bit ADC on the ADC 14 Click board™.

Parameters

[in]	ctx	: Click context object. See adc14_t object definition for detailed explanation.
[out]	adc_data	: 12-Bit ADC data value.

Returns

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

Note

None.

adc14_set_vref()

err_t adc14_set_vref	(	adc14_t *	ctx,
		float	vref )

ADC 14 set voltage reference function.

This function sets external voltage reference and converts them to proportional voltage level [mV], of the MAX11108, Low-Power, Serial 12-Bit ADC on the ADC 14 Click board™.

Parameters

[in]	ctx	: Click context object. See adc14_t object definition for detailed explanation.
[out]	vref	: External voltage reference [0-3.3V].

Returns

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

Note

None.