Projects/HotmailNotifier/HotmailNotifier.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 Communications Device Class (Virtual Serial Port) Demo
   8  *
   9  *  \section SSec_Compat Demo Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  - AT90USB646
  14  *
  15  *  \section SSec_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>Usable Speeds:</b></td>
  38  *    <td>Full Speed Mode</td>
  39  *   </tr>
  40  *  </table>
  41  *
  42  *  \section SSec_Description Project Description:
  43  *
  44  *  Hotmail Email Notifier Project. This project is designed for the Busware BUI board, however it can run easily on any
  45  *  USB AVR. It consists of a host application (written in C#) and a device firmware which work together to provide a
  46  *  visual mail notification system via the board's RGB LED. While the sample host application uses the Windows Live
  47  *  Messenger API for its email notifications, the hardware simply adjusts the LED color based on bytes sent to it - thus
  48  *  with a little coding, this project can be adapted for any sort of visual notification.
  49  *
  50  *  To compile the host application, you will need Microsoft Visual Studio 2008 (the free Express edition should be
  51  *  sufficient) as well as a recent version of Windows Live Messenger installed. When run, you will need to set the COM port
  52  *  number used by the hardware on the host PC, whereupon the host will send new email notifications to the device.
  53  *
  54  *  \section SSec_Options Project Options
  55  *
  56  *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
  57  *
  58  *  <table>
  59  *   <tr>
  60  *    <td>
  61  *     None
  62  *    </td>
  63  *   </tr>
  64  *  </table>
  65  */