Keyboard firmwares for Atmel AVR and Cortex-M
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

KeyboardMouseMultiReport.txt 2.5KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  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. /** \mainpage Multiple Report HID Keyboard and Mouse Device Demo
  7. *
  8. * \section Sec_Compat Demo Compatibility:
  9. *
  10. * The following list indicates what microcontrollers are compatible with this demo.
  11. *
  12. * \li Series 7 USB AVRs (AT90USBxxx7)
  13. * \li Series 6 USB AVRs (AT90USBxxx6)
  14. * \li Series 4 USB AVRs (ATMEGAxxU4)
  15. * \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
  16. * \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
  17. * \li Series B XMEGA AVRs (ATXMEGAxxxBxU)
  18. * \li Series C XMEGA AVRs (ATXMEGAxxxCxU)
  19. *
  20. * \section Sec_Info USB Information:
  21. *
  22. * The following table gives a rundown of the USB utilization of this demo.
  23. *
  24. * <table>
  25. * <tr>
  26. * <td><b>USB Mode:</b></td>
  27. * <td>Device</td>
  28. * </tr>
  29. * <tr>
  30. * <td><b>USB Class:</b></td>
  31. * <td>Human Interface Device (HID)</td>
  32. * </tr>
  33. * <tr>
  34. * <td><b>USB Subclass:</b></td>
  35. * <td>N/A</td>
  36. * </tr>
  37. * <tr>
  38. * <td><b>Relevant Standards:</b></td>
  39. * <td>USBIF HID Specification \n
  40. * USBIF HID Usage Tables</td>
  41. * </tr>
  42. * <tr>
  43. * <td><b>Supported USB Speeds:</b></td>
  44. * <td>Low Speed Mode \n
  45. * Full Speed Mode</td>
  46. * </tr>
  47. * </table>
  48. *
  49. * \section Sec_Description Project Description:
  50. *
  51. * Keyboard/Mouse demonstration application, using a single HID interface. This gives
  52. * a simple reference application for implementing a multiple HID report device
  53. * containing both USB Keyboard and USB Mouse functionality using the basic USB HID
  54. * drivers in all modern OSes (i.e. no special drivers required). This example uses a
  55. * single HID interface that is shared between the two functions.
  56. *
  57. * On start-up the system will automatically enumerate and function as a keyboard when
  58. * the USB connection to a host is present and the HWB is not pressed. When enabled,
  59. * manipulate the joystick to send the letters a, b, c, d and e. See the USB HID
  60. * documentation for more information on sending keyboard event and key presses.
  61. *
  62. * When the HWB is pressed, the mouse mode is enabled. When enabled, move the joystick
  63. * to move the pointer, and push the joystick inwards to simulate a left-button click.
  64. *
  65. * \section Sec_Options Project Options
  66. *
  67. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  68. *
  69. * <table>
  70. * <tr>
  71. * <td>
  72. * None
  73. * </td>
  74. * </tr>
  75. * </table>
  76. */