summaryrefslogtreecommitdiff
path: root/digital/avr/modules/usb/lufa/Demos/KeyboardHostWithParser/KeyboardHostWithParser.txt
diff options
context:
space:
mode:
Diffstat (limited to 'digital/avr/modules/usb/lufa/Demos/KeyboardHostWithParser/KeyboardHostWithParser.txt')
-rw-r--r--digital/avr/modules/usb/lufa/Demos/KeyboardHostWithParser/KeyboardHostWithParser.txt44
1 files changed, 44 insertions, 0 deletions
diff --git a/digital/avr/modules/usb/lufa/Demos/KeyboardHostWithParser/KeyboardHostWithParser.txt b/digital/avr/modules/usb/lufa/Demos/KeyboardHostWithParser/KeyboardHostWithParser.txt
new file mode 100644
index 00000000..09a83ca5
--- /dev/null
+++ b/digital/avr/modules/usb/lufa/Demos/KeyboardHostWithParser/KeyboardHostWithParser.txt
@@ -0,0 +1,44 @@
+/** \file
+ *
+ * This file contains special DoxyGen information for the generation of the main page and other special
+ * documentation pages. It is not a project source file.
+ */
+
+/** \mainpage Keyboard Host With HID Descriptor Parser Demo
+ *
+ * Keyboard host demonstration application. This gives a simple reference
+ * application for implementing a USB Keyboard host, for USB keyboards using
+ * the standard Keyboard HID profile. It uses a HID parser for the HID reports,
+ * allowing for correct operation across all USB keyboards. This demo supports
+ * keyboards with a single HID report.
+ *
+ * Pressed alpha-numeric, enter or space key is transmitted through the serial
+ * USART at serial settings 9600, 8, N, 1. On connection to a USB keyboard, the
+ * report items will be processed and printed as a formatted list through the
+ * USART before the keyboard is fully enumerated.
+ *
+ * Currently only single interface keyboards are supported.
+ *
+ * <table>
+ * <tr>
+ * <td><b>USB Mode:</b></td>
+ * <td>Host</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Class:</b></td>
+ * <td>Human Interface Device (HID)</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Subclass:</b></td>
+ * <td>N/A</td>
+ * </tr>
+ * <tr>
+ * <td><b>Relevant Standards:</b></td>
+ * <td>USBIF HID Specification, USBIF HID Usage Tables</td>
+ * </tr>
+ * <tr>
+ * <td><b>Usable Speeds:</b></td>
+ * <td>Low Speed Mode, Full Speed Mode</td>
+ * </tr>
+ * </table>
+ */ \ No newline at end of file