tmk_core/protocol/lufa/LUFA-git/Projects/LEDNotifier/LEDNotifier.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 USB LED Notifier Project
   8  *
   9  *  \section Sec_Compat Demo Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  \li AT90USB646
  14  *
  15  *  \section Sec_Info USB Information:
  16  *
  17  *  The following table gives a rundown of the USB utilization of this demo.
  18  *
  19  *  <table>
  20  *   <tr>
  21  *    <td><b>USB Mode:</b></td>
  22  *    <td>Device</td>
  23  *   </tr>
  24  *   <tr>
  25  *    <td><b>USB Class:</b></td>
  26  *    <td>Communications Device Class (CDC)</td>
  27  *   </tr>
  28  *   <tr>
  29  *    <td><b>USB Subclass:</b></td>
  30  *    <td>Abstract Control Model (ACM)</td>
  31  *   </tr>
  32  *   <tr>
  33  *    <td><b>Relevant Standards:</b></td>
  34  *    <td>USBIF CDC Class Standard</td>
  35  *   </tr>
  36  *   <tr>
  37  *    <td><b>Supported USB Speeds:</b></td>
  38  *    <td>Full Speed Mode</td>
  39  *   </tr>
  40  *  </table>
  41  *
  42  *  \section Sec_Description Project Description:
  43  *
  44  *  USB LED Notifier Project. This project is designed for the Busware BUI board, however it can run easily on any
  45  *  USB AVR. It is a generic RGB LED controller (via a three channel software PWM) which listens for commands from the
  46  *  host on a CDC virtual serial port. When new commands are received, it updates the board LEDs.
  47  *
  48  *  This can be controlled with any host application that can write to the virtual serial port, allowing it to become
  49  *  a visual notification system for any number of custom host applications, such as a new unread email notifier.
  50  *
  51  *  \section Sec_Options Project Options
  52  *
  53  *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
  54  *
  55  *  <table>
  56  *   <tr>
  57  *    <td>
  58  *     None
  59  *    </td>
  60  *   </tr>
  61  *  </table>
  62  */
  63