]> git.gir.st - tmk_keyboard.git/blob - protocol/lufa/LUFA-git/Projects/Webserver/Webserver.txt
Squashed 'tmk_core/' changes from caca2c0..dc0e46e
[tmk_keyboard.git] / protocol / lufa / LUFA-git / 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 Sec_Compat Project Compatibility:
10 *
11 * The following list indicates what microcontrollers are compatible with this project.
12 *
13 * \li Series 7 USB AVRs (AT90USBxxx7)
14 *
15 * \section Sec_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>Dual Mode Host/Device</td>
23 * </tr>
24 * <tr>
25 * <td><b>USB Class:</b></td>
26 * <td>Communications Device Class (CDC) \n
27 * Mass Storage Device</td>
28 * </tr>
29 * <tr>
30 * <td><b>USB Subclass:</b></td>
31 * <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard) \n
32 * Bulk-Only Transport</td>
33 * </tr>
34 * <tr>
35 * <td><b>Relevant Standards:</b></td>
36 * <td>Microsoft RNDIS Specification \n
37 * USBIF Mass Storage Standard \n
38 * USB Bulk-Only Transport Standard \n
39 * SCSI Primary Commands Specification \n
40 * SCSI Block Commands Specification</td>
41 * </tr>
42 * <tr>
43 * <td><b>Supported USB Speeds:</b></td>
44 * <td>Full Speed Mode</td>
45 * </tr>
46 * </table>
47 *
48 * \section Sec_Description Project Description:
49 *
50 * Simple HTTP webserver project. This project combines the LUFA library with the uIP TCP/IP full network stack and FatFS
51 * library to create a RNDIS host capable of serving out HTTP web pages to multiple hosts simultaneously. This project
52 * demonstrates how the libraries can be combined into a robust network enabled application, with the addition of a RNDIS
53 * network device.
54 *
55 * To use this project, plug the USB AVR into a computer, so that it enumerates as a standard Mass Storage and RNDIS composite
56 * 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 Sec_Options). Supply the included INF
59 * file when requested on Windows machines to enable the RNDIS interface, and allow the files to be viewed on a standard web-browser
60 * using the IP address 10.0.0.2.
61 *
62 * When attached to a RNDIS class device, such as a USB (desktop) modem, the system will enumerate the device, set the
63 * appropriate parameters needed for connectivity and begin listening for new HTTP connections on port 80 and TELNET
64 * connections on port 23. The device IP, netmask and default gateway IP must be set to values appropriate for the RNDIS
65 * device being used for this project to work if the DHCP client is disabled (see \ref Sec_Options) - otherwise, the device
66 * will query the network's DHCP server for these parameters automatically.
67 *
68 * When properly configured, the webserver can be accessed from any HTTP web browser by typing in the device's statically or
69 * dynamically allocated IP address. The TELNET client can be accessed via any network socket app by connecting to the device
70 * on port 23 on the device's statically or dynamically allocated IP address.
71 *
72 * \section Sec_Options Project Options
73 *
74 * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
75 *
76 * <table>
77 * <tr>
78 * <th><b>Define Name:</b></th>
79 * <th><b>Location:</b></th>
80 * <th><b>Description:</b></th>
81 * </tr>
82 * <tr>
83 * <td>ENABLE_TELNET_SERVER</td>
84 * <td>AppConfig.h</td>
85 * <td>When defined, this enables the TELNET server in addition to the HTTP webserver, which listens for incoming connections
86 * and processes user commands.</td>
87 * </tr>
88 * <tr>
89 * <td>ENABLE_DHCP_CLIENT</td>
90 * <td>AppConfig.h</td>
91 * <td>When defined, this enables the DHCP client for dynamic IP allocation of the network settings from a DHCP server.</td>
92 * </tr>
93 * <tr>
94 * <td>ENABLE_DHCP_SERVER</td>
95 * <td>AppConfig.h</td>
96 * <td>When defined, this enables the DHCP server for dynamic IP allocation of the network settings to a DHCP client.</td>
97 * </tr>
98 * <tr>
99 * <td>DEVICE_IP_ADDRESS</td>
100 * <td>AppConfig.h</td>
101 * <td>IP address that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT is not defined).</td>
102 * </tr>
103 * <tr>
104 * <td>DEVICE_NETMASK</td>
105 * <td>AppConfig.h</td>
106 * <td>Netmask that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT is not defined).</td>
107 * </tr>
108 * <tr>
109 * <td>DEVICE_GATEWAY</td>
110 * <td>AppConfig.h</td>
111 * <td>Default routing gateway that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT
112 * is not defined).</td>
113 * </tr>
114 * <tr>
115 * <td>MAX_URI_LENGTH</td>
116 * <td>AppConfig.h</td>
117 * <td>Maximum length of a URI for the Webserver. This is the maximum file path, including subdirectories and separators.</td>
118 * </tr>
119 * <tr>
120 * <td>SERVER_MAC_ADDRESS</td>
121 * <td>AppConfig.h</td>
122 * <td>MAC address of the server used when sending Ethernet packets onto the bus.</td>
123 * </tr>
124 * </table>
125 */
126
Imprint / Impressum