Webserver.txt 4.56 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/** \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 SSec_Compat Project Compatibility:
 *
 *  The following list indicates what microcontrollers are compatible with this project.
 *
 *  - Series 7 USB AVRs
 *
 *  \section SSec_Info USB Information:
 *
 *  The following table gives a rundown of the USB utilization of this project.
 *
 *  <table>
 *   <tr>
 *    <td><b>USB Mode:</b></td>
22
 *    <td>Dual Mode Host/Device</td>
23
24
25
 *   </tr>
 *   <tr>
 *    <td><b>USB Class:</b></td>
26
27
 *    <td>Communications Device Class (CDC) \n
 *        Mass Storage Device</td>
28
29
30
 *   </tr>
 *   <tr> 
 *    <td><b>USB Subclass:</b></td>
31
32
 *    <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard) \n
 *        Bulk-Only Transport</td>
33
34
35
 *   </tr>
 *   <tr>
 *    <td><b>Relevant Standards:</b></td>
36
37
38
39
40
 *    <td>Microsoft RNDIS Specification \n
 *        USBIF Mass Storage Standard \n
 *        USB Bulk-Only Transport Standard \n
 *        SCSI Primary Commands Specification \n
 *        SCSI Block Commands Specification</td>
41
42
43
44
45
46
47
48
49
 *   </tr>
 *   <tr>
 *    <td><b>Usable Speeds:</b></td>
 *    <td>Full Speed Mode</td>
 *   </tr>
 *  </table>
 *
 *  \section SSec_Description Project Description: 
 *
50
51
52
53
 *  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 webpages 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.
54
 *
55
56
 *  To use this project, plug the USB AVR into a computer, so that it enumerates as a standard Mass Storage device. Load
 *  HTML files onto the disk, so that they can be served out to clients -- the default file to serve should be called
57
 *  <i>index.htm</i>. Filenames must be in 8.3 format for them to be retrieved correctly by the webserver, and the total
58
 *  requested file path must be equal to or less than the maximum URI length (\see \ref SSec_Options).
59
60
 *
 *  When attached to a RNDIS class device, such as a USB (desktop) modem, the system will enumerate the device, set the
61
62
63
64
 *  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 SSec_Options) - otherwise, the device
 *  will query the network's DHCP server for these parameters automatically.
65
 *
66
67
68
 *  When properly configured, the webserver can be accessed from any HTTP webrowser 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.
69
70
71
72
73
74
75
76
77
78
79
80
 *
 *  \section SSec_Options Project Options
 *
 *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
 *
 *  <table>
 *   <tr>
 *    <td><b>Define Name:</b></td>
 *    <td><b>Location:</b></td>
 *    <td><b>Description:</b></td>
 *   </tr>
 *   <tr>
81
 *    <td>ENABLE_DHCP_CLIENT</td>
82
 *    <td>Makefile CDEFS</td>
83
 *    <td>When defined, this enables the DHCP client for dynamic IP allocation of the network settings from a DHCP server.</td>
84
85
 *   </tr>
 *   <tr>
86
 *    <td>DEVICE_IP_ADDRESS</td>
87
 *    <td>Lib/uIPManagement.h</td>
88
 *    <td>IP address that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT is not defined).</td>
89
90
91
 *   </tr>
 *   <tr>
 *    <td>DEVICE_NETMASK</td>
92
 *    <td>Lib/uIPManagement.h</td>
93
 *    <td>Netmask that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT is not defined).</td>
94
95
96
 *   </tr>
 *   <tr>
 *    <td>DEVICE_GATEWAY</td>
97
 *    <td>Lib/uIPManagement.h</td>
98
 *    <td>Default routing gateway that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT
99
 *        is not defined).</td>
100
 *   </tr>
101
102
103
104
105
 *   <tr>
 *    <td>MAX_URI_LENGTH</td>
 *    <td>Makefile CDEFS</td>
 *    <td>Maximum length of a URI for the Webserver. This is the maximum file path, including subdirectories and seperators.</td>
 *   </tr>
106
107
 *  </table>
 */