Functions

Functions
void	wiced_hal_adc_init (void)
	Initialize the ADC hardware to its default state. More...
void	wiced_hal_adc_set_input_range (ADC_INPUT_RANGE_SEL rangeIdx)
	This function will set the input range selection and calibrates ADC hardware. More...
int16_t	wiced_hal_adc_read_raw_sample (ADC_INPUT_CHANNEL_SEL channel, uint8_t avgCnt)
	Read the raw ADC register value for the given channel. More...
int32_t	wiced_hal_adc_get_ground_offset (void)
	Get the ADC ground offset. More...
int32_t	wiced_hal_adc_get_reference_reading (void)
	Get the ADC Reference voltage conversion value obtained from calibration. More...
uint32_t	wiced_hal_adc_get_reference_micro_volts (void)
	Get the ADC Reference voltage conversion value obtained from calibration. More...
uint32_t	wiced_hal_adc_read_voltage (ADC_INPUT_CHANNEL_SEL channel)
	Read the ADC voltage value for the given channel. More...

Detailed Description

Function Documentation

int32_t wiced_hal_adc_get_ground_offset

(

void

)

Get the ADC ground offset.

Parameters

None

Returns

: ADC ground offset.

uint32_t wiced_hal_adc_get_reference_micro_volts

(

void

)

Get the ADC Reference voltage conversion value obtained from calibration.

Parameters

None

Returns

: Reference micro voltage.

int32_t wiced_hal_adc_get_reference_reading

(

void

)

Get the ADC Reference voltage conversion value obtained from calibration.

Parameters

None

Returns

: Reference voltage conversion value.

void wiced_hal_adc_init

(

void

)

Initialize the ADC hardware to its default state.

Parameters

None

Returns

None

int16_t wiced_hal_adc_read_raw_sample	(	ADC_INPUT_CHANNEL_SEL	channel,
		uint8_t	avgCnt
	)

Read the raw ADC register value for the given channel.

The value returned here is direct from the register.

Parameters

[in]	channel	: The input channel that corresponds to a GPIO pin.
[in]	avgCnt	: Reads adc raw sample for avgCnt+4 times, and choose the middle set of avgCnt times for calculation

Returns

: Raw digital value read from the hardware register.

uint32_t wiced_hal_adc_read_voltage

(

ADC_INPUT_CHANNEL_SEL

channel

)

Read the ADC voltage value for the given channel.

The value returned here is converted to a voltage value from the register.

Parameters

[in]

channel

: The input channel that corresponds to a GPIO pin.

Returns

: Converted digital voltage value in mV.

void wiced_hal_adc_set_input_range

(

ADC_INPUT_RANGE_SEL

rangeIdx

)

This function will set the input range selection and calibrates ADC hardware.

Parameters

[in]

range_idx

: desired range selection from ADC_INPUT_RANGE_SEL

Returns

: None