Projects/Webserver/Webserver.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 uIP Powered Webserver Project
   8  *
   9  *  \section SSec_Compat Project Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this project.
  12  *
  13  *  - Series 7 USB AVRs
  14  *
  15  *  \section SSec_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>Communications Device Class (CDC)</td>
  27  *   </tr>
  28  *   <tr>
  29  *    <td><b>USB Subclass:</b></td>
  30  *    <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard)</td>
  31  *   </tr>
  32  *   <tr>
  33  *    <td><b>Relevant Standards:</b></td>
  34  *    <td>Microsoft RNDIS Specification</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  *  Simple HTTP webserver project. This project combines the LUFA library with the uIP TCP/IP full network stack, to create a
  45  *  RNDIS host capable of serving out HTTP webpages to up to 10 hosts simultaneously. This project demonstrates how the two
  46  *  libraries can be combined into a robust network enabled application, with the addition of a RNDIS network device.
  47  *
  48  *  To use this project, plug the USB AVR into a RNDIS class device, such as a USB (desktop) modem. If compatible, the project
  49  *  will enumerate the device, set the appropriate parameters needed for connectivity and begin listening for new HTTP connections
  50  *  on port 80. The device IP, netmask and default gateway IP must be set to values appropriate for the RNDIS device being used
  51  *  for this project to work.
  52  *
  53  *  When properly configured, the webserver can be accessed from any HTTP webrowser by typing in the device's IP address.
  54  *
  55  *  \section SSec_Options Project Options
  56  *
  57  *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
  58  *
  59  *  <table>
  60  *   <tr>
  61  *    <td><b>Define Name:</b></td>
  62  *    <td><b>Location:</b></td>
  63  *    <td><b>Description:</b></td>
  64  *   </tr>
  65  *   <tr>
  66  *    <td>ENABLE_DHCP</td>
  67  *    <td>Makefile CDEFS</td>
  68  *    <td>When defined, enables the DHCP client for dynamic IP allocation of the network settings from a DHCP server.</td>
  69  *   </tr>
  70  *   <tr>
  71  *    <td>DEVICE_IP_ADDRESS</td>
  72  *    <td>Webserver.h</td>
  73  *    <td>IP address that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP is not defined).</td>
  74  *   </tr>
  75  *   <tr>
  76  *    <td>DEVICE_NETMASK</td>
  77  *    <td>Webserver.h</td>
  78  *    <td>Netmask that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP is not defined).</td>
  79  *   </tr>
  80  *   <tr>
  81  *    <td>DEVICE_GATEWAY</td>
  82  *    <td>Webserver.h</td>
  83  *    <td>Default routing gateway that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP
  84  *        is not defined).</td>
  85  *   </tr>
  86  *  </table>
  87  */