Update docs

Author: shennongmin

ESP8266.h

@@ -122,7 +122,7 @@ class ESP8266 {
  * @param pwd - PASSWORD of SoftAP. 
  * @param chl - the channel (1 - 13, default: 7). 
  * @param ecn - the way of encrypstion (0 - OPEN, 1 - WEP, 
- * 2 - WPA_PSK, 3 - WPA2_PSK, 4 - WPA_WPA2_PSK, default: 0). 
+ * 2 - WPA_PSK, 3 - WPA2_PSK, 4 - WPA_WPA2_PSK, default: 4). 
  * @note This method should not be called when station mode. 
  */
  bool setSoftAPParam(String ssid, String pwd, uint8_t chl = 7, uint8_t ecn = 4);

README.md

@@ -4,6 +4,71 @@
 
 An ESP8266 library for Arduino providing an easy-to-use way to manipulate ESP8266.
 
+## API List
+
+ bool	kick (void) : Verify ESP8266 whether live or not.
+  
+ bool	restart (void) : Restart ESP8266 by "AT+RST".
+  
+ String	getVersion (void) : Get the version of AT Command Set.
+  
+ bool	setOprToStation (void) : Set operation mode to staion.
+  
+ bool	setOprToSoftAP (void) : Set operation mode to softap.
+  
+ bool	setOprToStationSoftAP (void) : Set operation mode to station + softap.
+  
+ String	getAPList (void) : Search available AP list and return it.
+  
+ bool	joinAP (String ssid, String pwd) : Join in AP. 
+  
+ bool	leaveAP (void) : Leave AP joined before. 
+  
+ bool	setSoftAPParam (String ssid, String pwd, uint8_t chl=7, uint8_t ecn=4) : Set SoftAP parameters. 
+  
+ String	getJoinedDeviceIP (void) : Get the IP list of devices connected to SoftAP. 
+  
+ String	getIPStatus (void) : Get the current status of connection(UDP and TCP). 
+  
+ String	getLocalIP (void) : Get the IP address of ESP8266. 
+  
+ bool	enableMUX (void) : Enable IP MUX(multiple connection mode). 
+  
+ bool	disableMUX (void) : Disable IP MUX(single connection mode). 
+  
+ bool	createTCP (String addr, uint32_t port) : Create TCP connection in single mode. 
+  
+ bool	releaseTCP (void) : Release TCP connection in single mode. 
+  
+ bool	registerUDP (String addr, uint32_t port) : Register UDP port number in single mode. 
+  
+ bool	unregisterUDP (void) : Unregister UDP port number in single mode. 
+  
+ bool	createTCP (uint8_t mux_id, String addr, uint32_t port) : Create TCP connection in multiple mode. 
+  
+ bool	releaseTCP (uint8_t mux_id) : Release TCP connection in multiple mode. 
+  
+ bool	registerUDP (uint8_t mux_id, String addr, uint32_t port) : Register UDP port number in multiple mode. 
+  
+ bool	unregisterUDP (uint8_t mux_id) : Unregister UDP port number in multiple mode. 
+  
+ bool	setTCPServerTimeout (uint32_t timeout=180) : Set the timeout of TCP Server. 
+  
+ bool	startTCPServer (uint32_t port=333) : Start TCP Server(Only in multiple mode). 
+  
+ bool	stopTCPServer (void) : Stop TCP Server(Only in multiple mode). 
+  
+ bool	send (const uint8_t *buffer, uint32_t len) : Send data based on TCP or UDP builded already in single mode. 
+  
+ bool	send (uint8_t mux_id, const uint8_t *buffer, uint32_t len) : Send data based on one of TCP or UDP builded already in multiple mode. 
+  
+ uint32_t	recv (uint8_t *buffer, uint32_t buffer_size, uint32_t timeout=1000) : Receive data from TCP or UDP builded already in single mode. 
+  
+ uint32_t	recv (uint8_t mux_id, uint8_t *buffer, uint32_t buffer_size, uint32_t timeout=1000) : Receive data from one of TCP or UDP builded already in multiple mode. 
+  
+ uint32_t	recv (uint8_t *coming_mux_id, uint8_t *buffer, uint32_t buffer_size, uint32_t timeout=1000) : Receive data from all of TCP or UDP builded already in multiple mode. 
+
+
 # Source 
 
 Source can be download at <https://github.com/itead/ITEADLIB_Arduino_WeeESP8266>.