From 60b30c036397cb5627fa374bb930794b225daa29 Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Fri, 7 Jul 2017 11:55:23 -0400 Subject: Squashed 'lib/lufa/' content from commit 385d40300 git-subtree-dir: lib/lufa git-subtree-split: 385d4030035dbaf41591309dbde47653bd03841b --- .../MouseHostDevice/MouseHostDevice.txt | 80 ++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 Demos/DualRole/ClassDriver/MouseHostDevice/MouseHostDevice.txt (limited to 'Demos/DualRole/ClassDriver/MouseHostDevice/MouseHostDevice.txt') diff --git a/Demos/DualRole/ClassDriver/MouseHostDevice/MouseHostDevice.txt b/Demos/DualRole/ClassDriver/MouseHostDevice/MouseHostDevice.txt new file mode 100644 index 0000000000..d3fb9a5618 --- /dev/null +++ b/Demos/DualRole/ClassDriver/MouseHostDevice/MouseHostDevice.txt @@ -0,0 +1,80 @@ +/** \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 Mouse Host/Device Dual Role Demo + * + * \section Sec_Compat Demo Compatibility: + * + * The following list indicates what microcontrollers are compatible with this demo. + * + * \li Series 7 USB AVRs (AT90USBxxx7) + * + * \section Sec_Info USB Information: + * + * The following table gives a rundown of the USB utilization of this demo. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
USB Mode:Dual Mode Host/Device
USB Class:Human Interface Device (HID)
USB Subclass:N/A
Relevant Standards:USBIF HID Specification, USBIF HID Usage Tables
Supported USB Speeds:Low Speed Mode, Full Speed Mode
+ * + * \section Sec_Description Project Description: + * + * Mouse host/device dual role demonstration application. This gives a simple + * reference application for implementing a dual role USB Mouse, for USB mice + * using the standard mouse boot protocol HID profile. + * + * When in host mode: + * Mouse movement and button presses are displayed on the board LEDs, + * as well as printed out the serial terminal as formatted dY, dY and + * button status information. + * + * This uses a naive method where the mouse is set to Boot Protocol mode, so + * that the report structure is fixed and known. A better implementation + * uses the HID report parser for correct report data processing across + * all compatible mice with advanced characteristics, as shown in the + * MouseHostWithParser Host demo application. + * + * Currently only single interface mice are supported. + * + * When in device mode: + * Upon enumeration the system will automatically enumerate and function + * as a mouse when the USB connection to a host is present. To use + * the mouse, move the joystick to move the pointer, and push the + * joystick inwards to simulate a left-button click. The HWB serves as + * the right mouse button. + * + * \section Sec_Options Project Options + * + * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. + * + * + * + * + * + *
+ * None + *
+ */ + -- cgit v1.2.3