Changeset 809

Timestamp:

08/11/08 15:45:51 (3 months ago)

Author:

liamstask

Message:

- update doc for webserver OSC interface
- small doc fix for IO

Location:

firmware/trunk

Files:

• core/makingthings/io.c (modified) (1 diff)
• core/makingthings/network.c (modified) (3 diffs)
• libraries/webserver/webserver.c (modified) (1 diff)

firmware/trunk/core/makingthings/io.c

@@ -254 +254 @@
   Read whether an IO pin is in use.
   @param index An int specifying which IO line.  Use the appropriate entry from the \ref IoIndices
-  @param output Specify 1 for an output, or 0 for an input.
   @return non-zero if active, 0 if inactive
   

firmware/trunk/core/makingthings/network.c

@@ -1289 +1289 @@
    
     \section properties Properties
-    The Network system has seven properties 
+    The Network system has the following properties
     - address
     - mask
@@ -1297 +1297 @@
     - osc_udp_port
     - dhcp
-    - webserver
 
     \par Address
@@ -1368 +1367 @@
     \code /network/dhcp \endcode
     with no argument value.
-    
-    \par Web Server
-    The \b webserver property sets whether the demo web server on the Make Controller is running or not.
-    The web server can provide current stats about the board through a web browser interface.  Because the web server
-    consumes a significant chunk of the board's resources, it's best to turn it off when you're not using it.
-    \par
-    To turn the web server on, send the message
-    \code /network/webserver 1 \endcode
-    then enter the board's IP address into the address bar of your favorite web browser.  Send the message
-    \code /network/webserver 0 \endcode
-    to turn the webserver off.
    
     \par MAC

firmware/trunk/libraries/webserver/webserver.c

@@ -827 +827 @@
 #ifdef OSC // Webserver OSC interface
 
+/** \defgroup webserverosc Web Server - OSC
+  Configure the Web Server  via OSC.
+  \ingroup OSC
+
+  \section devices Devices
+    There is only one Web Server system, so a device index is not used.
+   
+  \section properties Properties
+  The Web Server system has the following properties
+  - active
+  - listenport
+
+  \section details Property Details
+
+  \b Active
+
+  The \b active property sets whether the web server on the Make Controller is running or not.
+  The default web server does not really do anything too interesting, but provides a count of the
+  number of requests it has served.  You can access the web server by typing the board's IP address
+  into your favorite browser.  You can check the board's IP address in mchelper.
+
+  To turn the web server on, send the message
+  \code /webserver/active 1 \endcode
+  then enter the board's IP address into the address bar of your favorite web browser.  Send the message
+  \code /network/webserver 0 \endcode
+  to turn the webserver off.
+
+  <b> Listen Port </b>
+
+  The \b listenport property sets which port the web server should listen on for incoming requests.  By default
+  this is set to 80, the standard port for HTTP.
+
+  To listen on port 8080, send the message
+  \code /webserver/listenport 8080 \endcode
+
+  Note that the server will most likely already be listening on the previous port, and it won't update its port
+  until it serves that last request it's waiting for.
+*/
+
 #include "osc.h"
 static char* WebServerOsc_Name = "webserver";