]> git.gir.st - tmk_keyboard.git/blob - protocol/lufa/LUFA-git/Projects/SerialToLCD/SerialToLCD.txt
Squashed 'tmk_core/' changes from caca2c0..dc0e46e
[tmk_keyboard.git] / protocol / lufa / LUFA-git / Projects / SerialToLCD / SerialToLCD.txt
1 /** \file
2 *
3 * This file contains special DoxyGen information for the generation of the main page and other special
4 * documentation pages. It is not a project source file.
5 */
6
7 /** \mainpage Simon Foster's USB Serial to HD44780 LCD Project
8 *
9 * \section Sec_Compat Project Compatibility:
10 *
11 * The following list indicates what microcontrollers are compatible with this project.
12 *
13 * \li AT90USB162
14 *
15 * \section Sec_Info USB Information:
16 *
17 * The following table gives a rundown of the USB utilization of this project.
18 *
19 * <table>
20 * <tr>
21 * <td><b>USB Mode:</b></td>
22 * <td>Device</td>
23 * </tr>
24 * <tr>
25 * <td><b>USB Class:</b></td>
26 * <td>Communications Device Class (CDC)</td>
27 * </tr>
28 * <tr>
29 * <td><b>USB Subclass:</b></td>
30 * <td>Abstract Control Model (ACM)</td>
31 * </tr>
32 * <tr>
33 * <td><b>Relevant Standards:</b></td>
34 * <td>USBIF CDC Class Standard</td>
35 * </tr>
36 * <tr>
37 * <td><b>Supported USB Speeds:</b></td>
38 * <td>Full Speed Mode</td>
39 * </tr>
40 * </table>
41 *
42 * \section Sec_Description Project Description:
43 *
44 * Firmware for a USB Virtual Serial to HD44780 LCD controller project, by Simon Foster. This
45 * project connects a standard HD7780 compatible LCD controller to a PC via a virtual serial
46 * link, so that data supplied by the host can be written to the display. This project is
47 * designed to use the Minimum USB AVR board, however it can be modified to suit other hardware
48 * if desired.
49 *
50 * LCD Datasheet: http://www.sparkfun.com/datasheets/LCD/HD44780.pdf \n
51 * More Information: http://en.wikipedia.org/wiki/HD44780_Character_LCD \n
52 *
53 * Below are the connections between the AVR Minimus board and LCD.
54 *
55 * <table>
56 * <tr>
57 * <td><b>AVR Pin:</b></td>
58 * <td><b>HD44780 LCD Pin:</b></td>
59 * </tr>
60 * <tr>
61 * <td>VCC</td>
62 * <td>VCC</td>
63 * </tr>
64 * <tr>
65 * <td>GND</td>
66 * <td>GND</td>
67 * </tr>
68 * <tr>
69 * <td>PD0</td>
70 * <td>DB4</td>
71 * </tr>
72 * <tr>
73 * <td>PD1</td>
74 * <td>DB5</td>
75 * </tr>
76 * <tr>
77 * <td>PD2</td>
78 * <td>DB6</td>
79 * </tr>
80 * <tr>
81 * <td>PD3</td>
82 * <td>DB7</td>
83 * </tr>
84 * <tr>
85 * <td>PD4</td>
86 * <td>/RS</td>
87 * </tr>
88 * <tr>
89 * <td>GND</td>
90 * <td>/RW</td>
91 * </tr>
92 * <tr>
93 * <td>PD7</td>
94 * <td>/E</td>
95 * </tr>
96 * </table>
97 *
98 * \section Sec_Options Project Options
99 *
100 * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
101 *
102 * <table>
103 * <tr>
104 * <td>
105 * None
106 * </td>
107 * </tr>
108 * </table>
109 */
Imprint / Impressum