/** \file * * This file contains special DoxyGen information for the generation of the main page and other special * documentation pages. It is not a project source file. */ /** \mainpage uIP Powered Webserver Project * * \section Sec_Compat Project Compatibility: * * The following list indicates what microcontrollers are compatible with this project. * * \li Series 7 USB AVRs (AT90USBxxx7) * * \section Sec_Info USB Information: * * The following table gives a rundown of the USB utilization of this project. * * * * * * * * * * * * * * * * * * * * * * *
USB Mode:Dual Mode Host/Device
USB Class:Communications Device Class (CDC) \n * Mass Storage Device
USB Subclass:Remote NDIS (Microsoft Proprietary CDC Class Networking Standard) \n * Bulk-Only Transport
Relevant Standards:Microsoft RNDIS Specification \n * USBIF Mass Storage Standard \n * USB Bulk-Only Transport Standard \n * SCSI Primary Commands Specification \n * SCSI Block Commands Specification
Supported USB Speeds:Full Speed Mode
* * \section Sec_Description Project Description: * * Simple HTTP webserver project. This project combines the LUFA library with the uIP TCP/IP full network stack and FatFS * library to create a RNDIS host capable of serving out HTTP web pages to multiple hosts simultaneously. This project * demonstrates how the libraries can be combined into a robust network enabled application, with the addition of a RNDIS * network device. * * To use this project, plug the USB AVR into a computer, so that it enumerates as a standard Mass Storage and RNDIS composite * device. Load HTML files onto the disk, so that they can be served out to clients -- the default file to serve should be called * index.htm. Filenames must be in 8.3 format for them to be retrieved correctly by the webserver, and the total * requested file path must be equal to or less than the maximum URI length (\see \ref Sec_Options). Supply the included INF * file when requested on Windows machines to enable the RNDIS interface, and allow the files to be viewed on a standard web-browser * using the IP address 10.0.0.2. * * When attached to a RNDIS class device, such as a USB (desktop) modem, the system will enumerate the device, set the * appropriate parameters needed for connectivity and begin listening for new HTTP connections on port 80 and TELNET * connections on port 23. The device IP, netmask and default gateway IP must be set to values appropriate for the RNDIS * device being used for this project to work if the DHCP client is disabled (see \ref Sec_Options) - otherwise, the device * will query the network's DHCP server for these parameters automatically. * * When properly configured, the webserver can be accessed from any HTTP web browser by typing in the device's statically or * dynamically allocated IP address. The TELNET client can be accessed via any network socket app by connecting to the device * on port 23 on the device's statically or dynamically allocated IP address. * * \section Sec_Options Project Options * * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Define Name:Location:Description:
ENABLE_TELNET_SERVERAppConfig.hWhen defined, this enables the TELNET server in addition to the HTTP webserver, which listens for incoming connections * and processes user commands.
ENABLE_DHCP_CLIENTAppConfig.hWhen defined, this enables the DHCP client for dynamic IP allocation of the network settings from a DHCP server.
ENABLE_DHCP_SERVERAppConfig.hWhen defined, this enables the DHCP server for dynamic IP allocation of the network settings to a DHCP client.
DEVICE_IP_ADDRESSAppConfig.hIP address that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT is not defined).
DEVICE_NETMASKAppConfig.hNetmask that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT is not defined).
DEVICE_GATEWAYAppConfig.hDefault routing gateway that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT * is not defined).
MAX_URI_LENGTHAppConfig.hMaximum length of a URI for the Webserver. This is the maximum file path, including subdirectories and separators.
SERVER_MAC_ADDRESSAppConfig.hMAC address of the server used when sending Ethernet packets onto the bus.
*/ 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230