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.

Joystick.txt 2.1KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  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 Joystick 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. * Joystick demonstration application. This gives a simple reference
  52. * application for implementing a USB Keyboard device, for USB Joysticks
  53. * using the standard Keyboard HID profile.
  54. *
  55. * This device will show up as a generic joystick device, with two buttons.
  56. * Pressing the joystick inwards is the first button, and the HWB button
  57. * is the second.
  58. *
  59. * Moving the joystick on the selected board moves the joystick location on
  60. * the host computer.
  61. *
  62. * Currently only single interface joysticks are supported.
  63. *
  64. * \section Sec_Options Project Options
  65. *
  66. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  67. *
  68. * <table>
  69. * <tr>
  70. * <td>
  71. * None
  72. * </td>
  73. * </tr>
  74. * </table>
  75. */