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 and FatFS
  45  *  library to create a RNDIS host capable of serving out HTTP webpages to multiple hosts simultaneously. This project
  46  *  demonstrates how the libraries can be combined into a robust network enabled application, with the addition of a RNDIS
  47  *  network device.
  48  *
  49  *  To use this project, plug the USB AVR into a computer, so that it enumerates as a standard Mass Storage device. Load
  50  *  HTML files onto the disk, so that they can be served out to clients -- the default file to serve should be called
  51  *  <i>index.htm<i>. Filenames must be in 8.3 format for them to be retrieved correctly by the webserver.
  52
  53  *  When attached to a RNDIS class device, such as a USB (desktop) modem. If compatible, the system will enumerate the
  54  *  device, set the appropriate parameters needed for connectivity and begin listening for new HTTP connections on port 80.
  55  *  The device IP, netmask and default gateway IP must be set to values appropriate for the RNDIS device being used for this
  56  *  project to work, if the DHCP client is disabled (see \ref SSec_Options).
  57  *
  58  *  When properly configured, the webserver can be accessed from any HTTP webrowser by typing in the device's static or
  59  *  dynamically allocated IP address.
  60  *
  61  *  \section SSec_Options Project Options
  62  *
  63  *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
  64  *
  65  *  <table>
  66  *   <tr>
  67  *    <td><b>Define Name:</b></td>
  68  *    <td><b>Location:</b></td>
  69  *    <td><b>Description:</b></td>
  70  *   </tr>
  71  *   <tr>
  72  *    <td>ENABLE_DHCP</td>
  73  *    <td>Makefile CDEFS</td>
  74  *    <td>When defined, enables the DHCP client for dynamic IP allocation of the network settings from a DHCP server.</td>
  75  *   </tr>
  76  *   <tr>
  77  *    <td>DEVICE_IP_ADDRESS</td>
  78  *    <td>Lib/uIPManagement.h</td>
  79  *    <td>IP address that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP is not defined).</td>
  80  *   </tr>
  81  *   <tr>
  82  *    <td>DEVICE_NETMASK</td>
  83  *    <td>Lib/uIPManagement.h</td>
  84  *    <td>Netmask that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP is not defined).</td>
  85  *   </tr>
  86  *   <tr>
  87  *    <td>DEVICE_GATEWAY</td>
  88  *    <td>Lib/uIPManagement.h</td>
  89  *    <td>Default routing gateway that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP
  90  *        is not defined).</td>
  91  *   </tr>
  92  *  </table>
  93  */