summaryrefslogtreecommitdiff
path: root/digital/avr/modules/usb/lufa/Demos/KeyboardFullInt/KeyboardFullInt.txt
diff options
context:
space:
mode:
Diffstat (limited to 'digital/avr/modules/usb/lufa/Demos/KeyboardFullInt/KeyboardFullInt.txt')
-rw-r--r--digital/avr/modules/usb/lufa/Demos/KeyboardFullInt/KeyboardFullInt.txt44
1 files changed, 44 insertions, 0 deletions
diff --git a/digital/avr/modules/usb/lufa/Demos/KeyboardFullInt/KeyboardFullInt.txt b/digital/avr/modules/usb/lufa/Demos/KeyboardFullInt/KeyboardFullInt.txt
new file mode 100644
index 00000000..89071188
--- /dev/null
+++ b/digital/avr/modules/usb/lufa/Demos/KeyboardFullInt/KeyboardFullInt.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 Fully Interrupt Driven Keyboard Device Demo
+ *
+ * Keyboard demonstration application, using endpoint interrupts for the
+ * exchange of data to the USB host, and control requests on the control
+ * endpoint. This gives a simple reference application for implementing a
+ * USB Keyboard using the basic USB HID drivers in all modern OSes (i.e.
+ * no special drivers required). It is boot protocol compatible, and thus
+ * works under compatible BIOS as if it was a native keyboard (e.g. PS/2).
+ *
+ * On startup the system will automatically enumerate and function
+ * as a keyboard when the USB connection to a host is present. To use
+ * the keyboard example, manipulate the joystick to send the letters
+ * a, b, c, d and e. See the USB HID documentation for more information
+ * on sending keyboard event and keypresses.
+ *
+ * <table>
+ * <tr>
+ * <td><b>USB Mode:</b></td>
+ * <td>Device</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