Diff: wifi/Wifi.h

Revision:

108:554585370b4a

Parent:

106:358972176b89

Child:

120:3051dd49fa3a

--- a/wifi/Wifi.h	Tue Dec 31 16:34:22 2013 +0000
+++ b/wifi/Wifi.h	Tue Dec 31 17:30:45 2013 +0000
@@ -8,6 +8,23 @@
 
 using namespace mts;
 
+/** This is a class for communicating with a Roving Networks RN-171 Wifi module. This
+* module comes in a variety of form factors including the Multi-Tech SocketShield.
+* This class supports two main types of WiFi module interactions including:
+* configuration and status command processing and TCP/UDP Socket
+* data connections. It should be noted that while a data connection is open the module
+* must be put in command mode before commands can be sent. This is handled within the class
+* automatically for all native commands. This class also inherits from IPStack
+* providing a common set of commands for communication devices that have an onboard
+* IP Stack. It is also integrated with the standard mbed Sockets package and can therefore
+* be used seamlessly with clients and services built on top of this interface already within
+* the mbed library.
+*
+* All of the following examples use the Pin Names for the Freedom KL46Z board coupled with
+* the SocketModem Shield Arduino compatible board. Please chage Pin Names accordingly to
+* match your hardware configuration. The default baud rate for the WiFi module is 9600 bps.
+*
+*/
 class Wifi : public IPStack
 {
 public: