ADC Driver

ADC Driver API Reference. More...

Functions list
void	analog_in_configure_default (analog_in_config_t *config)
	Configure ADC configuration structure. More...
err_t	analog_in_open (analog_in_t *obj, analog_in_config_t *config)
	Open the ADC driver object on selected pin. More...
err_t	analog_in_set_resolution (analog_in_t *obj, analog_in_resolution_t resolution)
	Set ADC driver sample resolution. More...
err_t	analog_in_set_vref_input (analog_in_t *obj, analog_in_vref_t vref)
	Set ADC driver voltage reference source. More...
err_t	analog_in_set_vref_value (analog_in_t *obj, float vref_value)
	Set ADC driver voltage reference value. More...
err_t	analog_in_read (analog_in_t *obj, uint16_t *readDatabuf)
	Read analog value from pin. More...
err_t	analog_in_read_voltage (analog_in_t *obj, float *readDatabuf)
	Read analog voltage value from pin. More...
err_t	analog_in_close (analog_in_t *obj)
	Close ADC driver context object. More...

Detailed Description

The ADC driver provides standard ADC functionality including setting the analog pin and reading the ADC value from it. It also allows configuration of ADC resolution, voltage reference source and value.

Function Documentation

analog_in_configure_default()

void analog_in_configure_default

(

analog_in_config_t *

config

)

Configures ADC configuration structure to default initialization values. Take into consideration that this is just structure variable initial values setting. Values need to be redefined by user.

Parameters

[in,out]

config

ADC driver configuration settings. See analog_in_config_t structure definition for detailed explanation.

Default values:

Function	Default value
Input pin	0xFFFFFFFF (invalid pin)
Resolution	12 bit
Vref input	External reference voltage
Vref value	-1 (invalid reference voltage value)

Returns

Nothing.

Example

// Analog input driver configuration structure.
analog_in_config_t analog_in_cfg;
 
// Fill structure with default values.
analog_in_configure_default( &analog_in_cfg );

analog_in_open()

err_t analog_in_open	(	analog_in_t *	obj,
		analog_in_config_t *	config
	)

Opens the ADC driver object on selected pins. Allocates memory and pin for specified object.

Parameters

[in,out]	obj	ADC driver object. See analog_in_t structure definition for detailed explanation.
[in]	config	ADC driver configuration settings. See analog_in_config_t structure definition for detailed explanation.

Returns

The function can return one of the values defined by analog_in_err_t, which is size dependant on the architecture.

Precondition

Make sure that config structure has been adequately populated beforehand. See analog_in_configure_default definition for detailed explanation.

Note

It is recommended to check return value for error.

Example

// Analog input driver context structure.
analog_in_t analog_in;
 
// Analog input driver configuration structure.
analog_in_config_t analog_in_cfg;
 
// Fill structure with default values.
analog_in_configure_default( &analog_in_cfg );
 
// Fill analog input pin.
analog_in_cfg.pin = MIKROBUS_1_AN;
 
// Open the driver on the selected pin.
if ( ADC_SUCCESS == analog_in_open( &analog_in, &analog_in_cfg ) ) {
 // No error
} else {
 // Handle the error
}

analog_in_set_resolution()

err_t analog_in_set_resolution	(	analog_in_t *	obj,
		analog_in_resolution_t	resolution
	)

Sets ADC driver resolution to passed value if possible. If not possible, returns error. Make sure to check for return value. Take into consideration that the driver will be re-initialized on the hardware level.

Parameters

[in]	obj	ADC driver context object.
[in]	resolution	ADC driver sample resolution value. See analog_in_resolution_t for valid values.

Returns

The function can return one of the values defined by analog_in_err_t, which is size dependant on the architecture.

Precondition

Before calling this function, the user is expected to call analog_in_open

Postcondition

This function sets ADC resolution.

Note

Driver will be re-initialized on the hardware level

Example

// Analog input driver context structure.
analog_in_t analog_in;
 
// Analog input driver configuration structure.
analog_in_config_t analog_in_cfg;
 
// Fill sample resolution.
analog_in_cfg.resolution = ANALOG_IN_RESOLUTION_10_BIT;
 
// Set sample resolution.
if ( ADC_SUCCESS == analog_in_set_resolution( &analog_in, analog_in_cfg.resolution ) ) {
 // No error
} else {
 // Handle the error
}

analog_in_set_vref_input()

err_t analog_in_set_vref_input	(	analog_in_t *	obj,
		analog_in_vref_t	vref
	)

Sets ADC driver voltage reference source to passed value if possible. If not possible, returns error. Make sure to check for return value. Take into consideration that the driver will be re-initialized on the hardware level.

Parameters

[in]	obj	ADC driver context object.
[in]	vref	ADC driver voltage reference source value. See analog_in_vref_t for valid values.

Returns

The function can return one of the values defined by analog_in_err_t, which is size dependant on the architecture.

Precondition

Before calling this function, the user is expected to call analog_in_open

Postcondition

This function sets ADC voltage reference source.

Note

Driver will be re-initialized on the hardware level

Example

// Analog input driver context structure.
analog_in_t analog_in;
 
// Analog input driver configuration structure.
analog_in_config_t analog_in_cfg;
 
// Fill voltage reference source.
analog_in_cfg.vref_input = ANALOG_IN_VREF_EXTERNAL;
 
// Set voltage reference source.
if ( ADC_SUCCESS == analog_in_set_vref_input( &analog_in, analog_in_cfg.vref ) ) {
 // No error
} else {
 // Handle the error
}

analog_in_set_vref_value()

err_t analog_in_set_vref_value	(	analog_in_t *	obj,
		float	vref_value
	)

Sets ADC driver voltage reference value to passed value if possible. If not possible, returns error. Make sure to check for return value. Take into consideration that the driver will be re-initialized on the hardware level.

Parameters

[in]	obj	ADC driver context object.
[in]	vref_value	ADC driver voltage reference value.

Returns

The function can return one of the values defined by analog_in_err_t, which is size dependant on the architecture.

Precondition

Before calling this function, the user is expected to call analog_in_open

Postcondition

This function sets ADC voltage reference value neccessary for voltage calculation.

Note

Setting wrong voltage reference value will result with bad voltage calculation.

Example

// Analog input driver context structure.
analog_in_t analog_in;
 
// Analog input driver configuration structure.
analog_in_config_t analog_in_cfg;
 
// Fill voltage reference value.
analog_in_cfg.vref_value = 2.048;
 
// Set voltage reference value.
if ( ADC_SUCCESS == analog_in_set_vref_value( &analog_in, analog_in_cfg.vref_value ) ) {
 // No error
} else {
 // Handle the error
}

analog_in_read()

err_t analog_in_read	(	analog_in_t *	obj,
		uint16_t *	readDatabuf
	)

Function perform a read on the configured analog pin.

Parameters

[in]	obj	Analog input driver object. See analog_in_t structure definition for detailed explanation.
[out]	readDatabuf	Data buffer to place read data in.

Returns

The function can return one of the values defined by analog_in_err_t, which is size dependant on the architecture.

Note

The ADC driver needs to be initialized so that the read can be done.

Example

// Analog input driver context structure.
analog_in_t analog_in;
 
// ADC data buffer.
float *readDatabuf;
 
// Read analog value and store it to buffer.
if ( ADC_SUCCESS == analog_in_read( &analog_in, &readDatabuf ) ) {
 // No error
} else {
 // Handle the error
}

analog_in_read_voltage()

err_t analog_in_read_voltage	(	analog_in_t *	obj,
		float *	readDatabuf
	)

Function perform a read on the configured analog pin and converts it into voltage.

Parameters

[in]	obj	Analog input driver object. See analog_in_t structure definition for detailed explanation.
[out]	readDatabuf	Data buffer to place read data in.

Returns

The function can return one of the values defined by analog_in_err_t, which is size dependant on the architecture.

Note

The ADC driver needs to be initialized so that the read can be done. User should set right reference voltage value in order to get correct voltage value from this function.

Example

// Analog input driver context structure.
analog_in_t analog_in;
 
// ADC data buffer.
float *readDatabuf;
 
// Read analog voltage value and store to buffer.
if ( ADC_SUCCESS == analog_in_read_voltage( &analog_in, &readDatabuf ) ) {
 // No error
} else {
 // Handle the error
}

analog_in_close()

err_t analog_in_close

(

analog_in_t *

obj

)

De-allocates hardware resources for specific driver object.

Parameters

[in]

obj

ADC driver object.

Returns

The function can return one of the values defined by analog_in_err_t, which is size dependant on the architecture.

Example

// Analog input driver context structure.
analog_in_t analog_in;
 
// Close ADC driver context object.
if ( ADC_SUCCESS == analog_in_close( &analog_in ) )
{
 // No error
} else {
 // Handle the error
}