diff options
Diffstat (limited to 'Projects/NUCLEO-WB35CE/Examples/ADC/ADC_SingleConversion_TriggerSW_IT/readme.txt')
| -rw-r--r-- | Projects/NUCLEO-WB35CE/Examples/ADC/ADC_SingleConversion_TriggerSW_IT/readme.txt | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/Projects/NUCLEO-WB35CE/Examples/ADC/ADC_SingleConversion_TriggerSW_IT/readme.txt b/Projects/NUCLEO-WB35CE/Examples/ADC/ADC_SingleConversion_TriggerSW_IT/readme.txt new file mode 100644 index 000000000..d97416766 --- /dev/null +++ b/Projects/NUCLEO-WB35CE/Examples/ADC/ADC_SingleConversion_TriggerSW_IT/readme.txt @@ -0,0 +1,97 @@ +/** + @page ADC_SingleConversion_TriggerSW_IT ADC example + + @verbatim + ****************************************************************************** + * @file Examples/ADC/ADC_SingleConversion_TriggerSW_IT/readme.txt + * @author MCD Application Team + * @brief Description of the ADC_SingleConversion_TriggerSW_IT example. + ****************************************************************************** + * + * Copyright (c) 2019 STMicroelectronics. All rights reserved. + * + * This software component is licensed by ST under BSD 3-Clause license, + * the "License"; You may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * opensource.org/licenses/BSD-3-Clause + * + ****************************************************************************** + @endverbatim + +@par Example Description +Use ADC to convert a single channel at each SW start, +conversion performed using programming model: interrupt + +Example configuration: +ADC is configured to convert a single channel, in single conversion mode, +from SW trigger. +ADC interruption enabled: EOC (end of conversion of ADC group regular). + +Example execution: +The ADC performs 1 conversion of the selected channel. When conversion is completed, +ADC interruption occurs. IRQ handler callback function 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 LED + 1 GPIO for analog input: PA4 (Arduino connector CN8 pin A0, Morpho connector CN7 pin 28) + +Board settings: + - ADC is configured to convert ADC_CHANNEL_9 (Arduino connector CN8 pin A0, Morpho connector CN7 pin 28). + - The voltage input on ADC channel must be provided by an external source connected to Arduino connector CN8 pin A0, Morpho connector CN7 pin 28. + + +To observe voltage level applied on ADC channel through GPIO, connect a voltmeter on +pin PA4 (Arduino connector CN8 pin A0, Morpho connector CN7 pin 28). + +NUCLEO-WB35CE board LED is be used to monitor the program execution status: + - Normal operation: LED2 is turned-on/off in function of ADC conversion + result. + - "On" upon conversion completion + - "Off" during conversion + - Error: In case of error, LED2 is toggling twice at a frequency of 1Hz. + +@par Keywords + +Analog, ADC, Analog to Digital, single conversion, Software trigger, interrupt. + +@par Directory contents + + - ADC/ADC_SingleConversion_TriggerSW_IT/Inc/stm32wbxx_hal_conf.h HAL configuration file + - ADC/ADC_SingleConversion_TriggerSW_IT/Inc/stm32wbxx_it.h Interrupt handlers header file + - ADC/ADC_SingleConversion_TriggerSW_IT/Inc/main.h Header for main.c module + - ADC/ADC_SingleConversion_TriggerSW_IT/Src/stm32wbxx_it.c Interrupt handlers + - ADC/ADC_SingleConversion_TriggerSW_IT/Src/main.c Main program + - ADC/ADC_SingleConversion_TriggerSW_IT/Src/stm32wbxx_hal_msp.c HAL MSP module + - ADC/ADC_SingleConversion_TriggerSW_IT/Src/system_stm32wbxx.c STM32WBxx system source file + + +@par Hardware and Software environment + + - This example runs on STM32WB35xx devices. + + - This example has been tested with NUCLEO-WB35CE 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 + + * <h3><center>© COPYRIGHT STMicroelectronics</center></h3> + */ |