Projects/MissileLauncher/MissileLauncher.txt

   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
   7 /** \mainpage David Fletcher's Missile Launcher
   8  *
   9  *  \section Sec_Compat Project Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this project.
  12  *
  13  *  - Series 7 USB AVRs (AT90USBxxx7)
  14  *
  15  *  \section Sec_Info USB Information:
  16  *
  17  *  The following table gives a rundown of the USB utilization of this project.
  18  *
  19  *  <table>
  20  *   <tr>
  21  *    <td><b>USB Mode:</b></td>
  22  *    <td>Host</td>
  23  *   </tr>
  24  *   <tr>
  25  *    <td><b>USB Class:</b></td>
  26  *    <td>Human Interface Device (HID)</td>
  27  *   </tr>
  28  *   <tr>
  29  *    <td><b>USB Subclass:</b></td>
  30  *    <td>N/A</td>
  31  *   </tr>
  32  *   <tr>
  33  *    <td><b>Relevant Standards:</b></td>
  34  *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>
  35  *   </tr>
  36  *   <tr>
  37  *    <td><b>Usable Speeds:</b></td>
  38  *    <td>Low Speed Mode, Full Speed Mode</td>
  39  *   </tr>
  40  *  </table>
  41  *
  42  *  \section Sec_Description Project Description:
  43  *
  44  *  Missile Launcher host. This is a host driver for the popular USB-controller table top toy missile launchers,
  45  *  which can typically aim and fire small foam "missiles" from a spring-loaded turret. This project controls the
  46  *  launcher via a joystick and button to aim and fire missiles at targets without a PC.
  47  *
  48  *  \section Sec_Options Project Options
  49  *
  50  *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
  51  *
  52  *  <table>
  53  *   <tr>
  54  *    <td>
  55  *     None
  56  *    </td>
  57  *   </tr>
  58  *  </table>
  59  */
  60