Mercurial > ~darius > hgwebdir.cgi > stm32temp

comparison libs/STM32F10x_StdPeriph_Lib_V3.5.0/Project/STM32F10x_StdPeriph_Examples/USART/IrDA/Transmit/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 USART_IrDA_Transmit USART IrDA Transmit example
3
4 @verbatim
5 ******************** (C) COPYRIGHT 2011 STMicroelectronics *******************
6 * @file USART/IrDA/Transmit/readme.txt
7 * @author MCD Application Team
8 * @version V3.5.0
9 * @date 08-April-2011
10 * @brief Description of the USART IrDA Transmit 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 provides a basic communication USARTy IrDA transmit mode. Five pins,
24 configured in input floating mode, are used to select the byte to be send at
25 each pin state change. USARTy can be USART3 or USART2 depending on the
26 STMicroelectronics EVAL board you are using.
27
28 These bytes are:
29 - 0x00 if no key (JOY_NONE) pressed
30 - 0x01 if JOY_SEL pin state change
31 - 0x02 if JOY_DOWN pin state change
32 - 0x03 if JOY_LEFT pin state change
33 - 0x04 if JOY_RIGHT pin state change
34 - 0x05 if JOY_UP pin state change
35
36 USARTy configured as follow:
37 - BaudRate = 115200 baud
38 - Word Length = 8 Bits
39 - One Stop Bit
40 - No parity
41 - Hardware flow control disabled (RTS and CTS signals)
42 - Receive and transmit enabled
43
44 The USART IrDA example provides two IrDA program: transmitter&receiver and requires two boards
45 to be able to run the full demonstration:
46 - one board will act as IrDA transmitter
47 - one board will act as IrDA receiver
48
49
50 @par Directory contents
51
52 - USART/IrDA/Transmit/platform_config.h Evaluation board specific configuration file
53 - USART/IrDA/Transmit/stm32f10x_conf.h Library Configuration file
54 - USART/IrDA/Transmit/stm32f10x_it.h Interrupt handlers header file
55 - USART/IrDA/Transmit/stm32f10x_it.c Interrupt handlers
56 - USART/IrDA/Transmit/main.c Main program
57 - USART/IrDA/Transmit/system_stm32f10x.c STM32F10x system source file
58
59 @par Hardware and Software environment
60
61 - This example runs on STM32F10x Connectivity line, High-Density, High-Density
62 Value line, Medium-Density, XL-Density, Medium-Density Value line, Low-Density
63 and Low-Density Value line Devices.
64
65 - This example has been tested with STMicroelectronics STM32100E-EVAL (High-Density
66 Value line), STM32100B-EVAL (Medium-Density Value line), STM3210C-EVAL (Connectivity line),
67 STM3210E-EVAL (High-Density and XL-Density) and STM3210B-EVAL (Medium-Density)
68 evaluation boards and can be easily tailored to any other supported device
69 and development board.
70 To select the STMicroelectronics evaluation board used to run the example,
71 uncomment the corresponding line in USART/IrDA/Transmit/platform_config.h or the stm32_eval.h file
72
73 - STM32100E-EVAL Set-up
74 - Use DOWN push-button connected to pin PD.03
75 - Use UP push-button connected to pin PG.15
76 - Use SEL push-button connected to pin PG.07
77 - Use RIGHT push-button connected to pin PG.13
78 - Use RIGHT push-button connected to pin PG.14
79 - Use an IrDA transceiver connected to the USART3 Tx and Rx pins (U16
80 connector, JP15 jumper must be fitted).
81
82 - STM32100B-EVAL Set-up
83 - Use DOWN push-button connected to pin PD.14
84 - Use UP push-button connected to pin PD.08
85 - Use SEL push-button connected to pin PD.12
86 - Use RIGHT push-button connected to pin PE.01
87 - Use RIGHT push-button connected to pin PE.00
88 - Use an IrDA transceiver connected to the USART3 Tx and Rx pins (U14
89 connector, JP11 jumper must be fitted).
90
91 - STM3210C-EVAL Set-up
92 - The JoyStick push buttons are connected to the IO Expander on I2C.
93 - Use an IrDA transceiver connected to the USART2 Tx and Rx pins (U12
94 connector, JP16 should be in position 1<-->2).
95
96 - STM3210E-EVAL Set-up
97 - Use DOWN push-button connected to pin PD.03
98 - Use UP push-button connected to pin PG.15
99 - Use SEL push-button connected to pin PG.07
100 - Use RIGHT push-button connected to pin PG.13
101 - Use RIGHT push-button connected to pin PG.14
102 - Use an IrDA transceiver connected to the USART3 Tx and Rx pins (U13
103 connector, JP21 and JP22 jumper must be fitted).
104
105 - STM3210B-EVAL Set-up
106 - Use DOWN push-button connected to pin PD.14
107 - Use UP push-button connected to pin PD.08
108 - Use SEL push-button connected to pin PD.12
109 - Use RIGHT push-button connected to pin PE.00
110 - Use RIGHT push-button connected to pin PE.01
111 - Use an IrDA transceiver connected to the USART3 Tx and Rx pins (U11
112 connector, JP5 jumper must be fitted).
113
114 @par How to use it ?
115
116 In order to make the program work, you must do the following :
117 - Copy all source files from this example folder to the template folder under
118 Project\STM32F10x_StdPeriph_Template
119 - Open your preferred toolchain
120 - Rebuild all files and load your image into target memory
121 - Run the example
122
123 @note
124 - Low-density Value line devices are STM32F100xx microcontrollers where the
125 Flash memory density ranges between 16 and 32 Kbytes.
126 - Low-density devices are STM32F101xx, STM32F102xx and STM32F103xx
127 microcontrollers where the Flash memory density ranges between 16 and 32 Kbytes.
128 - Medium-density Value line devices are STM32F100xx microcontrollers where
129 the Flash memory density ranges between 64 and 128 Kbytes.
130 - Medium-density devices are STM32F101xx, STM32F102xx and STM32F103xx
131 microcontrollers where the Flash memory density ranges between 64 and 128 Kbytes.
132 - High-density Value line devices are STM32F100xx microcontrollers where
133 the Flash memory density ranges between 256 and 512 Kbytes.
134 - High-density devices are STM32F101xx and STM32F103xx microcontrollers where
135 the Flash memory density ranges between 256 and 512 Kbytes.
136 - XL-density devices are STM32F101xx and STM32F103xx microcontrollers where
137 the Flash memory density ranges between 512 and 1024 Kbytes.
138 - Connectivity line devices are STM32F105xx and STM32F107xx microcontrollers.
139
140 * <h3><center>&copy; COPYRIGHT 2011 STMicroelectronics</center></h3>
141 */