Welcome to mirror list, hosted at ThFree Co, Russian Federation.

readme.txt « ADC_AnalogWatchdog « ADC « Examples « P-NUCLEO-WB55.Nucleo « Projects - github.com/Flipper-Zero/STM32CubeWB.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 1c1f91df92b788b9dc044643cab95a616a43d9be (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/**
  @page ADC_AnalogWatchdog ADC example

  @verbatim
  ******************************************************************************
  * @file    Examples/ADC/ADC_AnalogWatchdog/readme.txt 
  * @author  MCD Application Team
  * @brief   Description of the ADC_AnalogWatchdog 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 

How to use the ADC peripheral to perform conversions with an analog watchdog 
and out-of-window interrupts enabled.

Example configuration:
The ADC launch conversions in continuous mode on the selected channel. DMA is configured
to transfer conversion data in an array, in circular mode.
Analog watchdog 1 is enabled, minimum and maximum thresholds are respectively set to 1/8
and 5/8 of full range scale (between about 0.41V and 2.06V with full range of 3.3V).

Example execution:
From the start, the ADC converts the selected channel continuously. DMA transfers conversion data to the array. Results array is updated indefinitely (DMA in circular mode).
If the conversion results is out of the analog window thresholds, ADC analog window IRQ handler (HAL_ADC_LevelOutOfWindowCallback) is called "ubAnalogWatchdogStatus" is SET and
LED2 is turned on.

For debug: variables to monitor with debugger watch window:
 - "aADCxConvertedData": ADC group regular conversion data (array of data)
 - "ubAnalogWatchdogStatus": ADC analog window status (SET = voltage out of window / RESET otherwise)

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: PA1 (Arduino connector CN8 pin A2, Morpho connector CN7 pin 32)
  DMA

Board settings:
 - ADC is configured to convert ADC_CHANNEL_6 (Arduino connector CN8 pin A2, Morpho connector CN7 pin 32).
 - The voltage input on ADC channel must be provided by an external source connected to Arduino connector CN8 pin A2, Morpho connector CN7 pin 32.


To observe voltage level applied on ADC channel through GPIO, connect a voltmeter on
pin PA1 (Arduino connector CN8 pin A2, Morpho connector CN7 pin 32).

P-NUCLEO-WB55 board LED is be used to monitor the program execution status:
 - Normal operation: LED2 is turned-on/off in function of ADC conversion
   result.
    - Turned-off if voltage into of AWD window
    - Turned-on if voltage is out of AWD window
 - Error: In case of error, LED2 is toggling at a frequency of 1Hz.

@par Keywords

ADC, analog digital converter, analog, conversion, voltage, channel, analog input, trigger, analog watchdog, threshold, window

@par Directory contents 

  - ADC/ADC_AnalogWatchdog/Inc/stm32wbxx_hal_conf.h    HAL configuration file
  - ADC/ADC_AnalogWatchdog/Inc/stm32wbxx_it.h          Interrupt handlers header file
  - ADC/ADC_AnalogWatchdog/Inc/main.h                        Header for main.c module  
  - ADC/ADC_AnalogWatchdog/Src/stm32wbxx_it.c          Interrupt handlers
  - ADC/ADC_AnalogWatchdog/Src/stm32wbxx_hal_msp.c     HAL MSP module
  - ADC/ADC_AnalogWatchdog/Src/main.c                        Main program
  - ADC/ADC_AnalogWatchdog/Src/system_stm32wbxx.c      STM32WBxx system source file


@par Hardware and Software environment

  - This example runs on STM32WB55xx devices.
    
  - This example has been tested with P-NUCLEO-WB55 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>&copy; COPYRIGHT STMicroelectronics</center></h3>
 */