Defines a conversion to be used with ADCBuf_convert(). More...

#include <ADCBuf.h>

Data Fields
uint16_t	samplesRequestedCount

void *	sampleBuffer

void *	sampleBufferTwo

void *	arg

uint32_t	adcChannel

Detailed Description

Defines a conversion to be used with ADCBuf_convert().

See also: ADCBuf_convert(); ADCBuf_Recurrence_Mode; ADCBuf_Return_Mode

Field Documentation

§ samplesRequestedCount

uint16_t ADCBuf_Conversion::samplesRequestedCount

Defines the number of samples to be performed on the ADCBuf_Conversion.channel. The application buffers provided by ADCBuf_Conversion.sampleBuffer and ADCBuf_Conversion.sampleBufferTwo must be large enough to hold samplesRequestedCount samples.

§ sampleBuffer

void* ADCBuf_Conversion::sampleBuffer

Buffer to store ADCBuf conversion results. This buffer must be at least (ADCBuf_Conversion.samplesRequestedCount * 2) bytes. When using ADCBuf_RECURRENCE_MODE_ONE_SHOT, only this buffer is used.

§ sampleBufferTwo

void* ADCBuf_Conversion::sampleBufferTwo

Buffer to store ADCBuf conversion results. This buffer must be at least (ADCBuf_Conversion.samplesRequestedCount * 2) bytes. When using ADCBuf_RECURRENCE_MODE_ONE_SHOT, this buffer is not used. When using ADCBuf_RECURRENCE_MODE_CONTINUOUS, this must point to a valid buffer.

See also: ADCBuf_RECURRENCE_MODE_CONTINUOUS

§ arg

void* ADCBuf_Conversion::arg

Pointer to a custom argument to be passed to the ADCBuf_Callback function via the ADCBuf_Conversion structure.

Note: The ADCBuf_Callback function is only called when operating in ADCBuf_RETURN_MODE_CALLBACK.

See also: ADCBuf_RETURN_MODE_CALLBACK; ADCBuf_Callback

§ adcChannel

uint32_t ADCBuf_Conversion::adcChannel

ADCBuf channel to perform conversions on. Mapping of channel to pin or internal signal is device specific. Refer to the device specific implementation.

The documentation for this struct was generated from the following file:

ADCBuf.h