Mercurial > ~darius > hgwebdir.cgi > stm32temp

comparison libs/STM32F10x_StdPeriph_Lib_V3.5.0/Project/STM32F10x_StdPeriph_Examples/TIM/InputCapture/readme.txt @ 0:c59513fd84fb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial commit of STM32 test code.
author Daniel O'Connor <darius@dons.net.au>
date Mon, 03 Oct 2011 21:19:15 +1030
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:c59513fd84fb
1 /**
2 @page TIM_Input_Capture TIM Input Capture example
3
4 @verbatim
5 ******************** (C) COPYRIGHT 2011 STMicroelectronics *******************
6 * @file TIM/InputCapture/readme.txt
7 * @author MCD Application Team
8 * @version V3.5.0
9 * @date 08-April-2011
10 * @brief Description of the TIM Input Capture example.
11 ******************************************************************************
12 * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
13 * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
14 * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
15 * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
16 * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
17 * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
18 ******************************************************************************
19 @endverbatim
20
21 @par Example Description
22
23 This example shows how to use the TIM peripheral to measure the frequency of an
24 external signal.
25
26 The TIMxCLK frequency is set to SystemCoreClock (Hz), the Prescaler is 0 so the
27 TIM3 counter clock is SystemCoreClock (Hz).
28 SystemCoreClock is set to 72 MHz for Low-density, Medium-density, High-density
29 and Connectivity line devices. For Low-Density Value line and Medium-Density
30 Value line devices, SystemCoreClock is set to 24 MHz.
31
32 TIM3 is configured in Input Capture Mode: the external signal is connected to
33 TIM3 Channel2 used as input pin.
34 To measure the frequency we use the TIM3 CC2 interrupt request,
35 so In the TIM3_IRQHandler routine, the frequency of the external signal is computed.
36 The "TIM3Freq" variable contains the external signal frequency:
37 TIM3Freq = TIM3 counter clock / Capture in Hz,
38 where the Capture is the difference between two consecutive TIM3 captures.
39
40 For Low-density, Medium-density, High-density and Connectivity line devices,
41 the minimum frequency value to measure is 1100 Hz.
42 For Low-Density Value line, Medium-Density and High-Density Value line devices,
43 the minimum frequency value to measure is 366 Hz.
44
45 @par Directory contents
46
47 - TIM/InputCapture/stm32f10x_conf.h Library Configuration file
48 - TIM/InputCapture/stm32f10x_it.c Interrupt handlers
49 - TIM/InputCapture/stm32f10x_it.h Interrupt handlers header file
50 - TIM/InputCapture/main.c Main program
51 - TIM/InputCapture/system_stm32f10x.c STM32F10x system source file
52
53 @par Hardware and Software environment
54
55 - This example runs on STM32F10x Connectivity line, High-Density, High-Density
56 Value line, Medium-Density, XL-Density, Medium-Density Value line, Low-Density
57 and Low-Density Value line Devices.
58
59 - This example has been tested with STMicroelectronics STM32100E-EVAL (High-Density
60 Value line), STM32100B-EVAL (Medium-Density Value line), STM3210C-EVAL (Connectivity line),
61 STM3210E-EVAL (High-Density and XL-Density) and STM3210B-EVAL (Medium-Density)
62 evaluation boards and can be easily tailored to any other supported device
63 and development board.
64
65 - STM32100E-EVAL, STM32100B-EVAL, STM3210C-EVAL, STM3210E-EVAL and STM3210B-EVAL Set-up
66 - Connect the external signal to measure to the TIM3 CH2 pin (PA.07).
67
68 @par How to use it ?
69
70 In order to make the program work, you must do the following :
71 - Copy all source files from this example folder to the template folder under
72 Project\STM32F10x_StdPeriph_Template
73 - Open your preferred toolchain
74 - Rebuild all files and load your image into target memory
75 - Run the example
76
77 @note
78 - Low-density Value line devices are STM32F100xx microcontrollers where the
79 Flash memory density ranges between 16 and 32 Kbytes.
80 - Low-density devices are STM32F101xx, STM32F102xx and STM32F103xx
81 microcontrollers where the Flash memory density ranges between 16 and 32 Kbytes.
82 - Medium-density Value line devices are STM32F100xx microcontrollers where
83 the Flash memory density ranges between 64 and 128 Kbytes.
84 - Medium-density devices are STM32F101xx, STM32F102xx and STM32F103xx
85 microcontrollers where the Flash memory density ranges between 64 and 128 Kbytes.
86 - High-density Value line devices are STM32F100xx microcontrollers where
87 the Flash memory density ranges between 256 and 512 Kbytes.
88 - High-density devices are STM32F101xx and STM32F103xx microcontrollers where
89 the Flash memory density ranges between 256 and 512 Kbytes.
90 - XL-density devices are STM32F101xx and STM32F103xx microcontrollers where
91 the Flash memory density ranges between 512 and 1024 Kbytes.
92 - Connectivity line devices are STM32F105xx and STM32F107xx microcontrollers.
93
94 * <h3><center>&copy; COPYRIGHT 2011 STMicroelectronics</center></h3>
95 */