aboutsummaryrefslogtreecommitdiffstats
path: root/Projects/Webserver/Webserver.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Projects/Webserver/Webserver.txt')
-rw-r--r--Projects/Webserver/Webserver.txt24
1 files changed, 13 insertions, 11 deletions
diff --git a/Projects/Webserver/Webserver.txt b/Projects/Webserver/Webserver.txt
index 59b530248..9cee32e8a 100644
--- a/Projects/Webserver/Webserver.txt
+++ b/Projects/Webserver/Webserver.txt
@@ -55,15 +55,17 @@
* 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
* <i>index.htm</i>. 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 50 characters.
+ * requested file path must be equal to or less than 50 characters (set in uipopt.h).
*
* 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. 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).
+ * 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.
*
- * When properly configured, the webserver can be accessed from any HTTP webrowser by typing in the device's static or
- * dynamically allocated IP address.
+ * 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.
*
* \section SSec_Options Project Options
*
@@ -76,7 +78,7 @@
* <td><b>Description:</b></td>
* </tr>
* <tr>
- * <td>ENABLE_DHCP=<i>x</i></td>
+ * <td>ENABLE_DHCP_CLIENT=<i>x</i></td>
* <td>Makefile CDEFS</td>
* <td>When set to 1, this enables the DHCP client for dynamic IP allocation of the network settings from a DHCP server.
* To disable DHCP and use the fixed address settings set elsewhere, set this to zero (do not undefine it).</td>
@@ -84,18 +86,18 @@
* <tr>
* <td>DEVICE_IP_ADDRESS</td>
* <td>Lib/uIPManagement.h</td>
- * <td>IP address that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP is not defined).</td>
+ * <td>IP address that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT is zero).</td>
* </tr>
* <tr>
* <td>DEVICE_NETMASK</td>
* <td>Lib/uIPManagement.h</td>
- * <td>Netmask that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP is not defined).</td>
+ * <td>Netmask that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT is zero).</td>
* </tr>
* <tr>
* <td>DEVICE_GATEWAY</td>
* <td>Lib/uIPManagement.h</td>
- * <td>Default routing gateway that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP
- * is not defined).</td>
+ * <td>Default routing gateway that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT
+ * is zero).</td>
* </tr>
* </table>
*/ \ No newline at end of file