STM32CubeF4/Projects/STM32F411RE-Nucleo/Examples_LL/ADC/ADC_SingleConversion_TriggerSW/readme.txt

90 lines
3.4 KiB
Plaintext

/**
@page ADC_SingleConversion_TriggerSW ADC example
@verbatim
******************** (C) COPYRIGHT 2017 STMicroelectronics *******************
* @file Examples_LL/ADC/ADC_SingleConversion_TriggerSW/readme.txt
* @author MCD Application Team
* @brief Description of the ADC_SingleConversion_TriggerSW example.
******************************************************************************
* @attention
*
* Copyright (c) 2017 STMicroelectronics.
* All rights reserved.
*
* This software is licensed under terms that can be found in the LICENSE file
* in the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
******************************************************************************
@endverbatim
@par Example Description
This example describes how to use a ADC peripheral to perform
a single ADC conversion of a channel, at each software start;
Example using programming model: polling
(for programming models interrupt or DMA transfer, refer to
other examples);
This example is based on the STM32F4xx ADC LL API;
peripheral initialization done using LL unitary services functions
for optimization purpose (performance and size).
Example configuration:
ADC is configured to convert a single channel, in single conversion mode,
from SW trigger.
Example execution:
At each press on User Button, the ADC performs 1 conversion of the selected channel.
Software polls for conversion completion.
When conversion is completed, main program reads conversion data
from ADC data register and stores it into a variable, LED2 is turned on.
For debug: variables to monitor with debugger watch window:
- "uhADCxConvertedData": ADC group regular conversion data
- "uhADCxConvertedData_Voltage_mVolt": ADC conversion data computation to physical values
Connection needed:
None.
Note: Optionally, a voltage can be supplied to the analog input pin (cf pin below),
between 0V and Vdda=3.3V, to perform a ADC conversion on a determined
voltage level.
Otherwise, this pin can be let floating (in this case ADC conversion data
will be undetermined).
Other peripherals used:
1 GPIO for User Button
1 GPIO for LED2
1 GPIO for analog input: PA.04 (Arduino connector CN8 pin A2, Morpho connector CN7 pin 32)
@par Keywords
Analog, ADC, Analog to Digital, single conversion , Software trigger, Polling
@par Directory contents
- ADC/ADC_SingleConversion_TriggerSW/Inc/stm32f4xx_it.h Interrupt handlers header file
- ADC/ADC_SingleConversion_TriggerSW/Inc/main.h Header for main.c module
- ADC/ADC_SingleConversion_TriggerSW/Inc/stm32_assert.h Template file to include assert_failed function
- ADC/ADC_SingleConversion_TriggerSW/Src/stm32f4xx_it.c Interrupt handlers
- ADC/ADC_SingleConversion_TriggerSW/Src/main.c Main program
- ADC/ADC_SingleConversion_TriggerSW/Src/system_stm32f4xx.c STM32F4xx system source file
@par Hardware and Software environment
- This example runs on STM32F411xx devices.
- This example has been tested with NUCLEO-F411RE board and can be
easily tailored to any other supported device and development board.
@par How to use it ?
In order to make the program work, you must do the following :
- Open your preferred toolchain
- Rebuild all files and load your image into target memory
- Run the example
*/