STM32CubeF4/Projects/STM32F413ZH-Nucleo/Examples/ADC/ADC_RegularConversion_Inter.../readme.txt

85 lines
3.6 KiB
Plaintext

/**
@page ADC_RegularConversion_Interrupt conversion using interrupt
@verbatim
******************** (C) COPYRIGHT 2017 STMicroelectronics *******************
* @file ADC/ADC_RegularConversion_Interrupt/readme.txt
* @author MCD Application Team
* @brief Description of the ADC RegularConversion interrupt 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
How to use the ADC in interrupt mode to convert data through the HAL API.
The ADC1 is configured to continuously convert ADC_CHANNEL_10.
Each time an end of conversion occurs an interrupt is generated and the converted
data of ADC1 DR register is affected to the uhADCxConvertedValue variable in the
ADC conversion complete call back function.
In this example, the system clock is 100MHz, APB2 = 100MHz and ADC clock = APB2/4.
Since ADC1 clock is 25 MHz and sampling time is set to 3 cycles, the conversion
time to 12bit data is 12 cycles so the total conversion time is (12+3)/25= 0.6us(1.7Msps).
User can vary the ADC_CHANNEL_10 voltage by applying an input voltage on pin PC.00 (pin3 connector 9)
(e.g. using function generator).
The converted value can be monitored through the debugger using the uhADCxConvertedValue variable.
STM32 board LED can be used to monitor the conversion:
- LED3 is ON if an error occurs.
@note Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds)
based on variable incremented in SysTick ISR. This implies that if HAL_Delay() is called from
a peripheral ISR process, then the SysTick interrupt must have higher priority (numerically lower)
than the peripheral interrupt. Otherwise the caller ISR process will be blocked.
To change the SysTick interrupt priority you have to use HAL_NVIC_SetPriority() function.
@note The application needs to ensure that the SysTick time base is always set to 1 millisecond
to have correct HAL operation.
@par Keywords
Analog, ADC, Analog to Digital Converter, Regular Conversion, Interrupt, Continuous Conversion
@par Directory contents
- ADC/ADC_RegularConversion_Interrupt/Inc/stm32f4xx_hal_conf.h HAL configuration file
- ADC/ADC_RegularConversion_Interrupt/Inc/stm32f4xx_it.h DMA interrupt handlers header file
- ADC/ADC_RegularConversion_Interrupt/Inc/main.h Header for main.c module
- ADC/ADC_RegularConversion_Interrupt/Src/stm32f4xx_it.c DMA interrupt handlers
- ADC/ADC_RegularConversion_Interrupt/Src/main.c Main program
- ADC/ADC_RegularConversion_Interrupt/Src/stm32f4xx_hal_msp.c HAL MSP file
- ADC/ADC_RegularConversion_Interrupt/Src/system_stm32f4xx.c STM32F4xx system source file
@par Hardware and Software environment
- This example runs on STM32F413xx/STM32F423xx devices.
- This example has been tested with STM32F413ZH-Nucleo 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
*/