Added new SerialToLCD user project contributed by Simon Foster.
[pub/lufa.git] / Projects / SerialToLCD / SerialToLCD.txt
diff --git a/Projects/SerialToLCD/SerialToLCD.txt b/Projects/SerialToLCD/SerialToLCD.txt
new file mode 100644 (file)
index 0000000..8bf2102
--- /dev/null
@@ -0,0 +1,51 @@
+/** \file\r
+ *\r
+ *  This file contains special DoxyGen information for the generation of the main page and other special\r
+ *  documentation pages. It is not a project source file.\r
+ */\r
+\r
+/** \mainpage Simon Foster's USB Serial to HD44780 LCD Project\r
+ *\r
+ *  \section Sec_Compat Project Compatibility:\r
+ *\r
+ *  The following list indicates what microcontrollers are compatible with this project.\r
+ *\r
+ *  - AT90USB162\r
+ *\r
+ *  \section Sec_Info USB Information:\r
+ *\r
+ *  The following table gives a rundown of the USB utilization of this project.\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td><b>USB Mode:</b></td>\r
+ *    <td>Device</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>USB Class:</b></td>\r
+ *    <td>Communications Device Class (CDC)</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>USB Subclass:</b></td>\r
+ *    <td>Abstract Control Model (ACM)</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Relevant Standards:</b></td>\r
+ *    <td>USBIF CDC Class Standard</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Usable Speeds:</b></td>\r
+ *    <td>Full Speed Mode</td>\r
+ *   </tr>\r
+ *  </table>\r
+ *\r
+ *  \section Sec_Description Project Description:\r
+ *\r
+ *  Firmware for a USB Virtual Serial to HD44780 LCD controller project, by Simon Foster. This\r
+ *  project connects a standard HD7780 compatible LCD controller to a PC via a virtual serial\r
+ *  link, so that data supplied by the host can be written to the display. This project is\r
+ *  designed to use the Minimum USB AVR board, however it can be modified to suit other hardware\r
+ *  if desired.\r
+ *\r
+ *  See comments in the SerialToLCD.c source file for hardware pinouts of the Minimus board.\r
+ */\r