X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/84e1241f8063dab6b82a580584fa11893a162b55..1d8bb8f9bc90a492073b93ef3b422ac947c873e7:/Projects/Webserver/Webserver.txt diff --git a/Projects/Webserver/Webserver.txt b/Projects/Webserver/Webserver.txt index 59b530248..05d0b1ffd 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 * 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 50 characters. + * requested file path must be equal to or less than the maximum URI length (\see \ref SSec_Options). * * 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,26 +78,30 @@ * Description: * * - * ENABLE_DHCP=x + * ENABLE_DHCP_CLIENT * Makefile CDEFS - * 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). + * When defined, this enables the DHCP client for dynamic IP allocation of the network settings from a DHCP server. * * * DEVICE_IP_ADDRESS * Lib/uIPManagement.h - * IP address that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP is not defined). + * IP address that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT is not defined). * * * DEVICE_NETMASK * Lib/uIPManagement.h - * Netmask that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP is not defined). + * Netmask that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT is not defined). * * * DEVICE_GATEWAY * Lib/uIPManagement.h - * Default routing gateway that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP + * Default routing gateway that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT * is not defined). * + * + * MAX_URI_LENGTH + * Makefile CDEFS + * Maximum length of a URI for the Webserver. This is the maximum file path, including subdirectories and seperators. + * * */ \ No newline at end of file