diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2010-12-26 14:25:34 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2010-12-26 14:25:34 +0000 |
commit | 2073b96d82433607bd287e3b6529fd0d3cc428cd (patch) | |
tree | 680767a0fba855e26799e392a59d4b0b6d8be4df /LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h | |
parent | 39ac72f2d12a9c62b2e876de4eee6c34a864ff74 (diff) | |
download | lufa-2073b96d82433607bd287e3b6529fd0d3cc428cd.tar.gz lufa-2073b96d82433607bd287e3b6529fd0d3cc428cd.tar.bz2 lufa-2073b96d82433607bd287e3b6529fd0d3cc428cd.zip |
Added basic driver example use code to the library documentation.
Made the USARTStream global public and documented in the SerialStream module, allowing for the serial USART stream to be accessed via its handle rather than via the implicit stdout and stdin streams.
Diffstat (limited to 'LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h')
-rw-r--r-- | LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h index 4790668cd..3e736864c 100644 --- a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h +++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h @@ -47,6 +47,24 @@ * \note This file should not be included directly. It is automatically included as needed by the ADC driver * dispatch header located in LUFA/Drivers/Peripheral/ADC.h. * + * <b>Example Usage:</b> + * \code + * // Initialise the ADC driver before first use + * ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_32); + * + * // Must setup the ADC channel to read beforehand + * ADC_SetupChannel(1); + * + * // Perform a single conversion of the ADC channel 1 + * ADC_GetChannelReading(ADC_REFERENCE_AVCC | ADC_RIGHT_ADJUSTED | ADC_CHANNEL1); + * printf("Conversion Result: %d\r\n", ADC_GetResult()); + * + * // Start reading ADC channel 1 in free running (continuous conversion) mode + * ADC_StartReading(ADC_REFERENCE_AVCC | ADC_RIGHT_ADJUSTED | ADC_CHANNEL1); + * while (!(ADC_IsReadingComplete())) {}; + * printf("Conversion Result: %d\r\n", ADC_GetResult()); + * \endcode + * * @{ */ |