source: rtos_arduino/trunk/arduino_lib/libraries/ESP8266/doc/API-html/class_e_s_p8266.html@ 136

Last change on this file since 136 was 136, checked in by ertl-honda, 8 years ago

ライブラリとOS及びベーシックなサンプルの追加．
File size: 70.4 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.7"/>
7<title>API: ESP8266 Class Reference</title>
8<link href="tabs.css" rel="stylesheet" type="text/css"/>
9<script type="text/javascript" src="jquery.js"></script>
10<script type="text/javascript" src="dynsections.js"></script>
11<link href="doxygen.css" rel="stylesheet" type="text/css" />
12</head>
13<body>
14<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
15<div id="titlearea">
16<table cellspacing="0" cellpadding="0">
17 <tbody>
18 <tr style="height: 56px;">
19 <td id="projectlogo"><img alt="Logo" src="ITEAD-logo.JPG"/></td>
20 <td style="padding-left: 0.5em;">
21 <div id="projectname">API
22 </div>
23 <div id="projectbrief">For Arduino developers</div>
24 </td>
25 </tr>
26 </tbody>
27</table>
28</div>
29<!-- end header part -->
30<!-- Generated by Doxygen 1.8.7 -->
31 <div id="navrow1" class="tabs">
32 <ul class="tablist">
33 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
34 <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
35 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
36 <li><a href="files.html"><span>Files</span></a></li>
37 <li><a href="examples.html"><span>Examples</span></a></li>
38 </ul>
39 </div>
40 <div id="navrow2" class="tabs2">
41 <ul class="tablist">
42 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
43 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
44 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
45 </ul>
46 </div>
47</div><!-- top -->
48<div class="header">
49 <div class="summary">
50<a href="#pub-methods">Public Member Functions</a> &#124;
51<a href="class_e_s_p8266-members.html">List of all members</a> </div>
52 <div class="headertitle">
53<div class="title">ESP8266 Class Reference</div> </div>
54</div><!--header-->
55<div class="contents">
56
57<p>Provide an easy-to-use way to manipulate <a class="el" href="class_e_s_p8266.html" title="Provide an easy-to-use way to manipulate ESP8266. ">ESP8266</a>.
58 <a href="class_e_s_p8266.html#details">More...</a></p>
59
60<p><code>#include &lt;<a class="el" href="_e_s_p8266_8h_source.html">ESP8266.h</a>&gt;</code></p>
61<table class="memberdecls">
62<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
63Public Member Functions</h2></td></tr>
64<tr class="memitem:a5ed71947606435c3b03b73efdaf810a5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a5ed71947606435c3b03b73efdaf810a5">kick</a> (void)</td></tr>
65<tr class="memdesc:a5ed71947606435c3b03b73efdaf810a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Verify <a class="el" href="class_e_s_p8266.html" title="Provide an easy-to-use way to manipulate ESP8266. ">ESP8266</a> whether live or not. <a href="#a5ed71947606435c3b03b73efdaf810a5">More...</a><br /></td></tr>
66<tr class="separator:a5ed71947606435c3b03b73efdaf810a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
67<tr class="memitem:a04b61a01af4ee5e8820c9de79b4b3c39"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a04b61a01af4ee5e8820c9de79b4b3c39">restart</a> (void)</td></tr>
68<tr class="memdesc:a04b61a01af4ee5e8820c9de79b4b3c39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restart <a class="el" href="class_e_s_p8266.html" title="Provide an easy-to-use way to manipulate ESP8266. ">ESP8266</a> by "AT+RST". <a href="#a04b61a01af4ee5e8820c9de79b4b3c39">More...</a><br /></td></tr>
69<tr class="separator:a04b61a01af4ee5e8820c9de79b4b3c39"><td class="memSeparator" colspan="2">&#160;</td></tr>
70<tr class="memitem:a4e2d8a0637b437d4b03209cebfa5b750"><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a4e2d8a0637b437d4b03209cebfa5b750">getVersion</a> (void)</td></tr>
71<tr class="memdesc:a4e2d8a0637b437d4b03209cebfa5b750"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the version of AT Command Set. <a href="#a4e2d8a0637b437d4b03209cebfa5b750">More...</a><br /></td></tr>
72<tr class="separator:a4e2d8a0637b437d4b03209cebfa5b750"><td class="memSeparator" colspan="2">&#160;</td></tr>
73<tr class="memitem:a572c6f855d70078fdbff9ac2c4b1ce99"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a572c6f855d70078fdbff9ac2c4b1ce99">setOprToStation</a> (void)</td></tr>
74<tr class="memdesc:a572c6f855d70078fdbff9ac2c4b1ce99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set operation mode to staion. <a href="#a572c6f855d70078fdbff9ac2c4b1ce99">More...</a><br /></td></tr>
75<tr class="separator:a572c6f855d70078fdbff9ac2c4b1ce99"><td class="memSeparator" colspan="2">&#160;</td></tr>
76<tr class="memitem:a247706884d60e85c8983bb65de26d346"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a247706884d60e85c8983bb65de26d346">setOprToSoftAP</a> (void)</td></tr>
77<tr class="memdesc:a247706884d60e85c8983bb65de26d346"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set operation mode to softap. <a href="#a247706884d60e85c8983bb65de26d346">More...</a><br /></td></tr>
78<tr class="separator:a247706884d60e85c8983bb65de26d346"><td class="memSeparator" colspan="2">&#160;</td></tr>
79<tr class="memitem:ac179183a46b218609a481747bcfd5a61"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#ac179183a46b218609a481747bcfd5a61">setOprToStationSoftAP</a> (void)</td></tr>
80<tr class="memdesc:ac179183a46b218609a481747bcfd5a61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set operation mode to station + softap. <a href="#ac179183a46b218609a481747bcfd5a61">More...</a><br /></td></tr>
81<tr class="separator:ac179183a46b218609a481747bcfd5a61"><td class="memSeparator" colspan="2">&#160;</td></tr>
82<tr class="memitem:af0cafe8a994349e81e75a35af9645a76"><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#af0cafe8a994349e81e75a35af9645a76">getAPList</a> (void)</td></tr>
83<tr class="memdesc:af0cafe8a994349e81e75a35af9645a76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Search available AP list and return it. <a href="#af0cafe8a994349e81e75a35af9645a76">More...</a><br /></td></tr>
84<tr class="separator:af0cafe8a994349e81e75a35af9645a76"><td class="memSeparator" colspan="2">&#160;</td></tr>
85<tr class="memitem:a300535b4b5f001b74058ebcc694a749f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a300535b4b5f001b74058ebcc694a749f">joinAP</a> (String ssid, String pwd)</td></tr>
86<tr class="memdesc:a300535b4b5f001b74058ebcc694a749f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Join in AP. <a href="#a300535b4b5f001b74058ebcc694a749f">More...</a><br /></td></tr>
87<tr class="separator:a300535b4b5f001b74058ebcc694a749f"><td class="memSeparator" colspan="2">&#160;</td></tr>
88<tr class="memitem:aeda29748e0d28efa9d82c9c7fab1859b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#aeda29748e0d28efa9d82c9c7fab1859b">leaveAP</a> (void)</td></tr>
89<tr class="memdesc:aeda29748e0d28efa9d82c9c7fab1859b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Leave AP joined before. <a href="#aeda29748e0d28efa9d82c9c7fab1859b">More...</a><br /></td></tr>
90<tr class="separator:aeda29748e0d28efa9d82c9c7fab1859b"><td class="memSeparator" colspan="2">&#160;</td></tr>
91<tr class="memitem:aacce786dc0ef289cd37a48642d2efef1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#aacce786dc0ef289cd37a48642d2efef1">setSoftAPParam</a> (String ssid, String pwd, uint8_t chl=7, uint8_t ecn=4)</td></tr>
92<tr class="memdesc:aacce786dc0ef289cd37a48642d2efef1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set SoftAP parameters. <a href="#aacce786dc0ef289cd37a48642d2efef1">More...</a><br /></td></tr>
93<tr class="separator:aacce786dc0ef289cd37a48642d2efef1"><td class="memSeparator" colspan="2">&#160;</td></tr>
94<tr class="memitem:a10c82a5196a8f349720a9c9ba7209a6e"><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a10c82a5196a8f349720a9c9ba7209a6e">getJoinedDeviceIP</a> (void)</td></tr>
95<tr class="memdesc:a10c82a5196a8f349720a9c9ba7209a6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the IP list of devices connected to SoftAP. <a href="#a10c82a5196a8f349720a9c9ba7209a6e">More...</a><br /></td></tr>
96<tr class="separator:a10c82a5196a8f349720a9c9ba7209a6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
97<tr class="memitem:ad273286fbb8627a612249a232d53ca22"><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#ad273286fbb8627a612249a232d53ca22">getIPStatus</a> (void)</td></tr>
98<tr class="memdesc:ad273286fbb8627a612249a232d53ca22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current status of connection(UDP and TCP). <a href="#ad273286fbb8627a612249a232d53ca22">More...</a><br /></td></tr>
99<tr class="separator:ad273286fbb8627a612249a232d53ca22"><td class="memSeparator" colspan="2">&#160;</td></tr>
100<tr class="memitem:a20819d4dabf19fed6e3dcb3fd04ee49d"><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a20819d4dabf19fed6e3dcb3fd04ee49d">getLocalIP</a> (void)</td></tr>
101<tr class="memdesc:a20819d4dabf19fed6e3dcb3fd04ee49d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the IP address of <a class="el" href="class_e_s_p8266.html" title="Provide an easy-to-use way to manipulate ESP8266. ">ESP8266</a>. <a href="#a20819d4dabf19fed6e3dcb3fd04ee49d">More...</a><br /></td></tr>
102<tr class="separator:a20819d4dabf19fed6e3dcb3fd04ee49d"><td class="memSeparator" colspan="2">&#160;</td></tr>
103<tr class="memitem:a16963a076b80906563d2269c0cd52007"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a16963a076b80906563d2269c0cd52007">enableMUX</a> (void)</td></tr>
104<tr class="memdesc:a16963a076b80906563d2269c0cd52007"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable IP MUX(multiple connection mode). <a href="#a16963a076b80906563d2269c0cd52007">More...</a><br /></td></tr>
105<tr class="separator:a16963a076b80906563d2269c0cd52007"><td class="memSeparator" colspan="2">&#160;</td></tr>
106<tr class="memitem:a2bc64145329ea45018e956b97ced030a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a2bc64145329ea45018e956b97ced030a">disableMUX</a> (void)</td></tr>
107<tr class="memdesc:a2bc64145329ea45018e956b97ced030a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable IP MUX(single connection mode). <a href="#a2bc64145329ea45018e956b97ced030a">More...</a><br /></td></tr>
108<tr class="separator:a2bc64145329ea45018e956b97ced030a"><td class="memSeparator" colspan="2">&#160;</td></tr>
109<tr class="memitem:aa927b7b8aaef163011015c22da1f07e2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#aa927b7b8aaef163011015c22da1f07e2">createTCP</a> (String addr, uint32_t port)</td></tr>
110<tr class="memdesc:aa927b7b8aaef163011015c22da1f07e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create TCP connection in single mode. <a href="#aa927b7b8aaef163011015c22da1f07e2">More...</a><br /></td></tr>
111<tr class="separator:aa927b7b8aaef163011015c22da1f07e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
112<tr class="memitem:ac15ce9df69dc566c37b3fa2c3c869337"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#ac15ce9df69dc566c37b3fa2c3c869337">releaseTCP</a> (void)</td></tr>
113<tr class="memdesc:ac15ce9df69dc566c37b3fa2c3c869337"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release TCP connection in single mode. <a href="#ac15ce9df69dc566c37b3fa2c3c869337">More...</a><br /></td></tr>
114<tr class="separator:ac15ce9df69dc566c37b3fa2c3c869337"><td class="memSeparator" colspan="2">&#160;</td></tr>
115<tr class="memitem:af8d3305a28d862c0cf353d0d758b96d4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#af8d3305a28d862c0cf353d0d758b96d4">registerUDP</a> (String addr, uint32_t port)</td></tr>
116<tr class="memdesc:af8d3305a28d862c0cf353d0d758b96d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register UDP port number in single mode. <a href="#af8d3305a28d862c0cf353d0d758b96d4">More...</a><br /></td></tr>
117<tr class="separator:af8d3305a28d862c0cf353d0d758b96d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
118<tr class="memitem:aa355332a78aa5f2b58cb11b0daa05cf5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#aa355332a78aa5f2b58cb11b0daa05cf5">unregisterUDP</a> (void)</td></tr>
119<tr class="memdesc:aa355332a78aa5f2b58cb11b0daa05cf5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregister UDP port number in single mode. <a href="#aa355332a78aa5f2b58cb11b0daa05cf5">More...</a><br /></td></tr>
120<tr class="separator:aa355332a78aa5f2b58cb11b0daa05cf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
121<tr class="memitem:a73d18b488d7f426a62e62b947f297b0d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a73d18b488d7f426a62e62b947f297b0d">createTCP</a> (uint8_t mux_id, String addr, uint32_t port)</td></tr>
122<tr class="memdesc:a73d18b488d7f426a62e62b947f297b0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create TCP connection in multiple mode. <a href="#a73d18b488d7f426a62e62b947f297b0d">More...</a><br /></td></tr>
123<tr class="separator:a73d18b488d7f426a62e62b947f297b0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
124<tr class="memitem:a96fd1a01f8f52dd80ae7f7a267005300"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a96fd1a01f8f52dd80ae7f7a267005300">releaseTCP</a> (uint8_t mux_id)</td></tr>
125<tr class="memdesc:a96fd1a01f8f52dd80ae7f7a267005300"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release TCP connection in multiple mode. <a href="#a96fd1a01f8f52dd80ae7f7a267005300">More...</a><br /></td></tr>
126<tr class="separator:a96fd1a01f8f52dd80ae7f7a267005300"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<tr class="memitem:af70a0a7c963c6411948622d802b31b2d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#af70a0a7c963c6411948622d802b31b2d">registerUDP</a> (uint8_t mux_id, String addr, uint32_t port)</td></tr>
128<tr class="memdesc:af70a0a7c963c6411948622d802b31b2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register UDP port number in multiple mode. <a href="#af70a0a7c963c6411948622d802b31b2d">More...</a><br /></td></tr>
129<tr class="separator:af70a0a7c963c6411948622d802b31b2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
130<tr class="memitem:a0a48619ad157fd2bd9c7f2e9c151f9b3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a0a48619ad157fd2bd9c7f2e9c151f9b3">unregisterUDP</a> (uint8_t mux_id)</td></tr>
131<tr class="memdesc:a0a48619ad157fd2bd9c7f2e9c151f9b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregister UDP port number in multiple mode. <a href="#a0a48619ad157fd2bd9c7f2e9c151f9b3">More...</a><br /></td></tr>
132<tr class="separator:a0a48619ad157fd2bd9c7f2e9c151f9b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
133<tr class="memitem:a71f76c76d23fc66c26f1c7b357f58ac2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a71f76c76d23fc66c26f1c7b357f58ac2">setTCPServerTimeout</a> (uint32_t timeout=180)</td></tr>
134<tr class="memdesc:a71f76c76d23fc66c26f1c7b357f58ac2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the timeout of TCP Server. <a href="#a71f76c76d23fc66c26f1c7b357f58ac2">More...</a><br /></td></tr>
135<tr class="separator:a71f76c76d23fc66c26f1c7b357f58ac2"><td class="memSeparator" colspan="2">&#160;</td></tr>
136<tr class="memitem:a22a7768a76709c8d8f0b9809158b7ec9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a22a7768a76709c8d8f0b9809158b7ec9">startTCPServer</a> (uint32_t port=333)</td></tr>
137<tr class="memdesc:a22a7768a76709c8d8f0b9809158b7ec9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start TCP Server(Only in multiple mode). <a href="#a22a7768a76709c8d8f0b9809158b7ec9">More...</a><br /></td></tr>
138<tr class="separator:a22a7768a76709c8d8f0b9809158b7ec9"><td class="memSeparator" colspan="2">&#160;</td></tr>
139<tr class="memitem:aa5355dce05aa59b92ce9f7ea76d86eef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#aa5355dce05aa59b92ce9f7ea76d86eef">stopTCPServer</a> (void)</td></tr>
140<tr class="memdesc:aa5355dce05aa59b92ce9f7ea76d86eef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop TCP Server(Only in multiple mode). <a href="#aa5355dce05aa59b92ce9f7ea76d86eef">More...</a><br /></td></tr>
141<tr class="separator:aa5355dce05aa59b92ce9f7ea76d86eef"><td class="memSeparator" colspan="2">&#160;</td></tr>
142<tr class="memitem:a88d9a6b130b6c278fd6cd2e6cda816d7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a88d9a6b130b6c278fd6cd2e6cda816d7">startServer</a> (uint32_t port=333)</td></tr>
143<tr class="memdesc:a88d9a6b130b6c278fd6cd2e6cda816d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start Server(Only in multiple mode). <a href="#a88d9a6b130b6c278fd6cd2e6cda816d7">More...</a><br /></td></tr>
144<tr class="separator:a88d9a6b130b6c278fd6cd2e6cda816d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
145<tr class="memitem:af272f2f57b7b99434e257f06c276acfc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#af272f2f57b7b99434e257f06c276acfc">stopServer</a> (void)</td></tr>
146<tr class="memdesc:af272f2f57b7b99434e257f06c276acfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop Server(Only in multiple mode). <a href="#af272f2f57b7b99434e257f06c276acfc">More...</a><br /></td></tr>
147<tr class="separator:af272f2f57b7b99434e257f06c276acfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
148<tr class="memitem:a6ba21b921a7afc79a36d0e41c20d59bc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a6ba21b921a7afc79a36d0e41c20d59bc">send</a> (const uint8_t *buffer, uint32_t len)</td></tr>
149<tr class="memdesc:a6ba21b921a7afc79a36d0e41c20d59bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send data based on TCP or UDP builded already in single mode. <a href="#a6ba21b921a7afc79a36d0e41c20d59bc">More...</a><br /></td></tr>
150<tr class="separator:a6ba21b921a7afc79a36d0e41c20d59bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
151<tr class="memitem:afb7d7b4e281d4c4699a33e1d086e6d54"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#afb7d7b4e281d4c4699a33e1d086e6d54">send</a> (uint8_t mux_id, const uint8_t *buffer, uint32_t len)</td></tr>
152<tr class="memdesc:afb7d7b4e281d4c4699a33e1d086e6d54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send data based on one of TCP or UDP builded already in multiple mode. <a href="#afb7d7b4e281d4c4699a33e1d086e6d54">More...</a><br /></td></tr>
153<tr class="separator:afb7d7b4e281d4c4699a33e1d086e6d54"><td class="memSeparator" colspan="2">&#160;</td></tr>
154<tr class="memitem:af8ce40bd14556bcfb5d4c521047fc821"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#af8ce40bd14556bcfb5d4c521047fc821">recv</a> (uint8_t *buffer, uint32_t buffer_size, uint32_t timeout=1000)</td></tr>
155<tr class="memdesc:af8ce40bd14556bcfb5d4c521047fc821"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive data from TCP or UDP builded already in single mode. <a href="#af8ce40bd14556bcfb5d4c521047fc821">More...</a><br /></td></tr>
156<tr class="separator:af8ce40bd14556bcfb5d4c521047fc821"><td class="memSeparator" colspan="2">&#160;</td></tr>
157<tr class="memitem:a0d6429057e090be1a6f4da91eff92d82"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a0d6429057e090be1a6f4da91eff92d82">recv</a> (uint8_t mux_id, uint8_t *buffer, uint32_t buffer_size, uint32_t timeout=1000)</td></tr>
158<tr class="memdesc:a0d6429057e090be1a6f4da91eff92d82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive data from one of TCP or UDP builded already in multiple mode. <a href="#a0d6429057e090be1a6f4da91eff92d82">More...</a><br /></td></tr>
159<tr class="separator:a0d6429057e090be1a6f4da91eff92d82"><td class="memSeparator" colspan="2">&#160;</td></tr>
160<tr class="memitem:a7d68591021e6ddc6919cb5865827856f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a7d68591021e6ddc6919cb5865827856f">recv</a> (uint8_t *coming_mux_id, uint8_t *buffer, uint32_t buffer_size, uint32_t timeout=1000)</td></tr>
161<tr class="memdesc:a7d68591021e6ddc6919cb5865827856f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive data from all of TCP or UDP builded already in multiple mode. <a href="#a7d68591021e6ddc6919cb5865827856f">More...</a><br /></td></tr>
162<tr class="separator:a7d68591021e6ddc6919cb5865827856f"><td class="memSeparator" colspan="2">&#160;</td></tr>
163</table>
164<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
165<div class="textblock"><p>Provide an easy-to-use way to manipulate <a class="el" href="class_e_s_p8266.html" title="Provide an easy-to-use way to manipulate ESP8266. ">ESP8266</a>. </p>
166<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_connect_wi_fi_8ino-example.html#_a0">ConnectWiFi.ino</a>, <a class="el" href="_h_t_t_p_g_e_t_8ino-example.html#_a0">HTTPGET.ino</a>, <a class="el" href="_t_c_p_client_multiple_8ino-example.html#_a0">TCPClientMultiple.ino</a>, <a class="el" href="_t_c_p_client_single_8ino-example.html#_a0">TCPClientSingle.ino</a>, <a class="el" href="_t_c_p_client_single_u_n_o_8ino-example.html#_a0">TCPClientSingleUNO.ino</a>, <a class="el" href="_t_c_p_server_8ino-example.html#_a0">TCPServer.ino</a>, <a class="el" href="_u_d_p_client_multiple_8ino-example.html#_a0">UDPClientMultiple.ino</a>, and <a class="el" href="_u_d_p_client_single_8ino-example.html#_a0">UDPClientSingle.ino</a>.</dd>
167</dl>
168<p>Definition at line <a class="el" href="_e_s_p8266_8h_source.html#l00038">38</a> of file <a class="el" href="_e_s_p8266_8h_source.html">ESP8266.h</a>.</p>
169</div><h2 class="groupheader">Member Function Documentation</h2>
170<a class="anchor" id="aa927b7b8aaef163011015c22da1f07e2"></a>
171<div class="memitem">
172<div class="memproto">
173 <table class="memname">
174 <tr>
175 <td class="memname">bool ESP8266::createTCP </td>
176 <td>(</td>
177 <td class="paramtype">String&#160;</td>
178 <td class="paramname"><em>addr</em>, </td>
179 </tr>
180 <tr>
181 <td class="paramkey"></td>
182 <td></td>
183 <td class="paramtype">uint32_t&#160;</td>
184 <td class="paramname"><em>port</em>&#160;</td>
185 </tr>
186 <tr>
187 <td></td>
188 <td>)</td>
189 <td></td><td></td>
190 </tr>
191 </table>
192</div><div class="memdoc">
193
194<p>Create TCP connection in single mode. </p>
195<dl class="params"><dt>Parameters</dt><dd>
196 <table class="params">
197 <tr><td class="paramname">addr</td><td>- the IP or domain name of the target host. </td></tr>
198 <tr><td class="paramname">port</td><td>- the port number of the target host. </td></tr>
199 </table>
200 </dd>
201</dl>
202<dl class="retval"><dt>Return values</dt><dd>
203 <table class="retval">
204 <tr><td class="paramname">true</td><td>- success. </td></tr>
205 <tr><td class="paramname">false</td><td>- failure. </td></tr>
206 </table>
207 </dd>
208</dl>
209<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_h_t_t_p_g_e_t_8ino-example.html#a6">HTTPGET.ino</a>, <a class="el" href="_t_c_p_client_multiple_8ino-example.html#a6">TCPClientMultiple.ino</a>, <a class="el" href="_t_c_p_client_single_8ino-example.html#a6">TCPClientSingle.ino</a>, and <a class="el" href="_t_c_p_client_single_u_n_o_8ino-example.html#a6">TCPClientSingleUNO.ino</a>.</dd>
210</dl>
211<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00191">191</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
212
213</div>
214</div>
215<a class="anchor" id="a73d18b488d7f426a62e62b947f297b0d"></a>
216<div class="memitem">
217<div class="memproto">
218 <table class="memname">
219 <tr>
220 <td class="memname">bool ESP8266::createTCP </td>
221 <td>(</td>
222 <td class="paramtype">uint8_t&#160;</td>
223 <td class="paramname"><em>mux_id</em>, </td>
224 </tr>
225 <tr>
226 <td class="paramkey"></td>
227 <td></td>
228 <td class="paramtype">String&#160;</td>
229 <td class="paramname"><em>addr</em>, </td>
230 </tr>
231 <tr>
232 <td class="paramkey"></td>
233 <td></td>
234 <td class="paramtype">uint32_t&#160;</td>
235 <td class="paramname"><em>port</em>&#160;</td>
236 </tr>
237 <tr>
238 <td></td>
239 <td>)</td>
240 <td></td><td></td>
241 </tr>
242 </table>
243</div><div class="memdoc">
244
245<p>Create TCP connection in multiple mode. </p>
246<dl class="params"><dt>Parameters</dt><dd>
247 <table class="params">
248 <tr><td class="paramname">mux_id</td><td>- the identifier of this TCP(available value: 0 - 4). </td></tr>
249 <tr><td class="paramname">addr</td><td>- the IP or domain name of the target host. </td></tr>
250 <tr><td class="paramname">port</td><td>- the port number of the target host. </td></tr>
251 </table>
252 </dd>
253</dl>
254<dl class="retval"><dt>Return values</dt><dd>
255 <table class="retval">
256 <tr><td class="paramname">true</td><td>- success. </td></tr>
257 <tr><td class="paramname">false</td><td>- failure. </td></tr>
258 </table>
259 </dd>
260</dl>
261
262<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00211">211</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
263
264</div>
265</div>
266<a class="anchor" id="a2bc64145329ea45018e956b97ced030a"></a>
267<div class="memitem">
268<div class="memproto">
269 <table class="memname">
270 <tr>
271 <td class="memname">bool ESP8266::disableMUX </td>
272 <td>(</td>
273 <td class="paramtype">void&#160;</td>
274 <td class="paramname"></td><td>)</td>
275 <td></td>
276 </tr>
277 </table>
278</div><div class="memdoc">
279
280<p>Disable IP MUX(single connection mode). </p>
281<p>In single connection mode, only one TCP or UDP communication can be builded.</p>
282<dl class="retval"><dt>Return values</dt><dd>
283 <table class="retval">
284 <tr><td class="paramname">true</td><td>- success. </td></tr>
285 <tr><td class="paramname">false</td><td>- failure. </td></tr>
286 </table>
287 </dd>
288</dl>
289<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_h_t_t_p_g_e_t_8ino-example.html#a5">HTTPGET.ino</a>, <a class="el" href="_t_c_p_client_single_8ino-example.html#a5">TCPClientSingle.ino</a>, <a class="el" href="_t_c_p_client_single_u_n_o_8ino-example.html#a5">TCPClientSingleUNO.ino</a>, and <a class="el" href="_u_d_p_client_single_8ino-example.html#a5">UDPClientSingle.ino</a>.</dd>
290</dl>
291<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00186">186</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
292
293</div>
294</div>
295<a class="anchor" id="a16963a076b80906563d2269c0cd52007"></a>
296<div class="memitem">
297<div class="memproto">
298 <table class="memname">
299 <tr>
300 <td class="memname">bool ESP8266::enableMUX </td>
301 <td>(</td>
302 <td class="paramtype">void&#160;</td>
303 <td class="paramname"></td><td>)</td>
304 <td></td>
305 </tr>
306 </table>
307</div><div class="memdoc">
308
309<p>Enable IP MUX(multiple connection mode). </p>
310<p>In multiple connection mode, a couple of TCP and UDP communication can be builded. They can be distinguished by the identifier of TCP or UDP named mux_id.</p>
311<dl class="retval"><dt>Return values</dt><dd>
312 <table class="retval">
313 <tr><td class="paramname">true</td><td>- success. </td></tr>
314 <tr><td class="paramname">false</td><td>- failure. </td></tr>
315 </table>
316 </dd>
317</dl>
318<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_t_c_p_client_multiple_8ino-example.html#a5">TCPClientMultiple.ino</a>, <a class="el" href="_t_c_p_server_8ino-example.html#a5">TCPServer.ino</a>, and <a class="el" href="_u_d_p_client_multiple_8ino-example.html#a5">UDPClientMultiple.ino</a>.</dd>
319</dl>
320<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00181">181</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
321
322</div>
323</div>
324<a class="anchor" id="af0cafe8a994349e81e75a35af9645a76"></a>
325<div class="memitem">
326<div class="memproto">
327 <table class="memname">
328 <tr>
329 <td class="memname">String ESP8266::getAPList </td>
330 <td>(</td>
331 <td class="paramtype">void&#160;</td>
332 <td class="paramname"></td><td>)</td>
333 <td></td>
334 </tr>
335 </table>
336</div><div class="memdoc">
337
338<p>Search available AP list and return it. </p>
339<dl class="section return"><dt>Returns</dt><dd>the list of available APs. </dd></dl>
340<dl class="section note"><dt>Note</dt><dd>This method will occupy a lot of memeory(hundreds of Bytes to a couple of KBytes). Do not call this method unless you must and ensure that your board has enough memery left. </dd></dl>
341
342<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00138">138</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
343
344</div>
345</div>
346<a class="anchor" id="ad273286fbb8627a612249a232d53ca22"></a>
347<div class="memitem">
348<div class="memproto">
349 <table class="memname">
350 <tr>
351 <td class="memname">String ESP8266::getIPStatus </td>
352 <td>(</td>
353 <td class="paramtype">void&#160;</td>
354 <td class="paramname"></td><td>)</td>
355 <td></td>
356 </tr>
357 </table>
358</div><div class="memdoc">
359
360<p>Get the current status of connection(UDP and TCP). </p>
361<dl class="section return"><dt>Returns</dt><dd>the status. </dd></dl>
362<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_t_c_p_server_8ino-example.html#a9">TCPServer.ino</a>.</dd>
363</dl>
364<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00167">167</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
365
366</div>
367</div>
368<a class="anchor" id="a10c82a5196a8f349720a9c9ba7209a6e"></a>
369<div class="memitem">
370<div class="memproto">
371 <table class="memname">
372 <tr>
373 <td class="memname">String ESP8266::getJoinedDeviceIP </td>
374 <td>(</td>
375 <td class="paramtype">void&#160;</td>
376 <td class="paramname"></td><td>)</td>
377 <td></td>
378 </tr>
379 </table>
380</div><div class="memdoc">
381
382<p>Get the IP list of devices connected to SoftAP. </p>
383<dl class="section return"><dt>Returns</dt><dd>the list of IP. </dd></dl>
384<dl class="section note"><dt>Note</dt><dd>This method should not be called when station mode. </dd></dl>
385
386<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00160">160</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
387
388</div>
389</div>
390<a class="anchor" id="a20819d4dabf19fed6e3dcb3fd04ee49d"></a>
391<div class="memitem">
392<div class="memproto">
393 <table class="memname">
394 <tr>
395 <td class="memname">String ESP8266::getLocalIP </td>
396 <td>(</td>
397 <td class="paramtype">void&#160;</td>
398 <td class="paramname"></td><td>)</td>
399 <td></td>
400 </tr>
401 </table>
402</div><div class="memdoc">
403
404<p>Get the IP address of <a class="el" href="class_e_s_p8266.html" title="Provide an easy-to-use way to manipulate ESP8266. ">ESP8266</a>. </p>
405<dl class="section return"><dt>Returns</dt><dd>the IP list. </dd></dl>
406<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_connect_wi_fi_8ino-example.html#a4">ConnectWiFi.ino</a>, <a class="el" href="_h_t_t_p_g_e_t_8ino-example.html#a4">HTTPGET.ino</a>, <a class="el" href="_t_c_p_client_multiple_8ino-example.html#a4">TCPClientMultiple.ino</a>, <a class="el" href="_t_c_p_client_single_8ino-example.html#a4">TCPClientSingle.ino</a>, <a class="el" href="_t_c_p_client_single_u_n_o_8ino-example.html#a4">TCPClientSingleUNO.ino</a>, <a class="el" href="_t_c_p_server_8ino-example.html#a4">TCPServer.ino</a>, <a class="el" href="_u_d_p_client_multiple_8ino-example.html#a4">UDPClientMultiple.ino</a>, and <a class="el" href="_u_d_p_client_single_8ino-example.html#a4">UDPClientSingle.ino</a>.</dd>
407</dl>
408<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00174">174</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
409
410</div>
411</div>
412<a class="anchor" id="a4e2d8a0637b437d4b03209cebfa5b750"></a>
413<div class="memitem">
414<div class="memproto">
415 <table class="memname">
416 <tr>
417 <td class="memname">String ESP8266::getVersion </td>
418 <td>(</td>
419 <td class="paramtype">void&#160;</td>
420 <td class="paramname"></td><td>)</td>
421 <td></td>
422 </tr>
423 </table>
424</div><div class="memdoc">
425
426<p>Get the version of AT Command Set. </p>
427<dl class="section return"><dt>Returns</dt><dd>the string of version. </dd></dl>
428<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_connect_wi_fi_8ino-example.html#a1">ConnectWiFi.ino</a>, <a class="el" href="_h_t_t_p_g_e_t_8ino-example.html#a1">HTTPGET.ino</a>, <a class="el" href="_t_c_p_client_multiple_8ino-example.html#a1">TCPClientMultiple.ino</a>, <a class="el" href="_t_c_p_client_single_8ino-example.html#a1">TCPClientSingle.ino</a>, <a class="el" href="_t_c_p_client_single_u_n_o_8ino-example.html#a1">TCPClientSingleUNO.ino</a>, <a class="el" href="_t_c_p_server_8ino-example.html#a1">TCPServer.ino</a>, <a class="el" href="_u_d_p_client_multiple_8ino-example.html#a1">UDPClientMultiple.ino</a>, and <a class="el" href="_u_d_p_client_single_8ino-example.html#a1">UDPClientSingle.ino</a>.</dd>
429</dl>
430<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00080">80</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
431
432</div>
433</div>
434<a class="anchor" id="a300535b4b5f001b74058ebcc694a749f"></a>
435<div class="memitem">
436<div class="memproto">
437 <table class="memname">
438 <tr>
439 <td class="memname">bool ESP8266::joinAP </td>
440 <td>(</td>
441 <td class="paramtype">String&#160;</td>
442 <td class="paramname"><em>ssid</em>, </td>
443 </tr>
444 <tr>
445 <td class="paramkey"></td>
446 <td></td>
447 <td class="paramtype">String&#160;</td>
448 <td class="paramname"><em>pwd</em>&#160;</td>
449 </tr>
450 <tr>
451 <td></td>
452 <td>)</td>
453 <td></td><td></td>
454 </tr>
455 </table>
456</div><div class="memdoc">
457
458<p>Join in AP. </p>
459<dl class="params"><dt>Parameters</dt><dd>
460 <table class="params">
461 <tr><td class="paramname">ssid</td><td>- SSID of AP to join in. </td></tr>
462 <tr><td class="paramname">pwd</td><td>- Password of AP to join in. </td></tr>
463 </table>
464 </dd>
465</dl>
466<dl class="retval"><dt>Return values</dt><dd>
467 <table class="retval">
468 <tr><td class="paramname">true</td><td>- success. </td></tr>
469 <tr><td class="paramname">false</td><td>- failure. </td></tr>
470 </table>
471 </dd>
472</dl>
473<dl class="section note"><dt>Note</dt><dd>This method will take a couple of seconds. </dd></dl>
474<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_connect_wi_fi_8ino-example.html#a3">ConnectWiFi.ino</a>, <a class="el" href="_h_t_t_p_g_e_t_8ino-example.html#a3">HTTPGET.ino</a>, <a class="el" href="_t_c_p_client_multiple_8ino-example.html#a3">TCPClientMultiple.ino</a>, <a class="el" href="_t_c_p_client_single_8ino-example.html#a3">TCPClientSingle.ino</a>, <a class="el" href="_t_c_p_client_single_u_n_o_8ino-example.html#a3">TCPClientSingleUNO.ino</a>, <a class="el" href="_t_c_p_server_8ino-example.html#a3">TCPServer.ino</a>, <a class="el" href="_u_d_p_client_multiple_8ino-example.html#a3">UDPClientMultiple.ino</a>, and <a class="el" href="_u_d_p_client_single_8ino-example.html#a3">UDPClientSingle.ino</a>.</dd>
475</dl>
476<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00145">145</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
477
478</div>
479</div>
480<a class="anchor" id="a5ed71947606435c3b03b73efdaf810a5"></a>
481<div class="memitem">
482<div class="memproto">
483 <table class="memname">
484 <tr>
485 <td class="memname">bool ESP8266::kick </td>
486 <td>(</td>
487 <td class="paramtype">void&#160;</td>
488 <td class="paramname"></td><td>)</td>
489 <td></td>
490 </tr>
491 </table>
492</div><div class="memdoc">
493
494<p>Verify <a class="el" href="class_e_s_p8266.html" title="Provide an easy-to-use way to manipulate ESP8266. ">ESP8266</a> whether live or not. </p>
495<p>Actually, this method will send command "AT" to <a class="el" href="class_e_s_p8266.html" title="Provide an easy-to-use way to manipulate ESP8266. ">ESP8266</a> and waiting for "OK".</p>
496<dl class="retval"><dt>Return values</dt><dd>
497 <table class="retval">
498 <tr><td class="paramname">true</td><td>- alive. </td></tr>
499 <tr><td class="paramname">false</td><td>- dead. </td></tr>
500 </table>
501 </dd>
502</dl>
503
504<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00058">58</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
505
506</div>
507</div>
508<a class="anchor" id="aeda29748e0d28efa9d82c9c7fab1859b"></a>
509<div class="memitem">
510<div class="memproto">
511 <table class="memname">
512 <tr>
513 <td class="memname">bool ESP8266::leaveAP </td>
514 <td>(</td>
515 <td class="paramtype">void&#160;</td>
516 <td class="paramname"></td><td>)</td>
517 <td></td>
518 </tr>
519 </table>
520</div><div class="memdoc">
521
522<p>Leave AP joined before. </p>
523<dl class="retval"><dt>Return values</dt><dd>
524 <table class="retval">
525 <tr><td class="paramname">true</td><td>- success. </td></tr>
526 <tr><td class="paramname">false</td><td>- failure. </td></tr>
527 </table>
528 </dd>
529</dl>
530
531<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00150">150</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
532
533</div>
534</div>
535<a class="anchor" id="af8ce40bd14556bcfb5d4c521047fc821"></a>
536<div class="memitem">
537<div class="memproto">
538 <table class="memname">
539 <tr>
540 <td class="memname">uint32_t ESP8266::recv </td>
541 <td>(</td>
542 <td class="paramtype">uint8_t *&#160;</td>
543 <td class="paramname"><em>buffer</em>, </td>
544 </tr>
545 <tr>
546 <td class="paramkey"></td>
547 <td></td>
548 <td class="paramtype">uint32_t&#160;</td>
549 <td class="paramname"><em>buffer_size</em>, </td>
550 </tr>
551 <tr>
552 <td class="paramkey"></td>
553 <td></td>
554 <td class="paramtype">uint32_t&#160;</td>
555 <td class="paramname"><em>timeout</em> = <code>1000</code>&#160;</td>
556 </tr>
557 <tr>
558 <td></td>
559 <td>)</td>
560 <td></td><td></td>
561 </tr>
562 </table>
563</div><div class="memdoc">
564
565<p>Receive data from TCP or UDP builded already in single mode. </p>
566<dl class="params"><dt>Parameters</dt><dd>
567 <table class="params">
568 <tr><td class="paramname">buffer</td><td>- the buffer for storing data. </td></tr>
569 <tr><td class="paramname">buffer_size</td><td>- the length of the buffer. </td></tr>
570 <tr><td class="paramname">timeout</td><td>- the time waiting data. </td></tr>
571 </table>
572 </dd>
573</dl>
574<dl class="section return"><dt>Returns</dt><dd>the length of data received actually. </dd></dl>
575<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_h_t_t_p_g_e_t_8ino-example.html#a8">HTTPGET.ino</a>, <a class="el" href="_t_c_p_client_multiple_8ino-example.html#a8">TCPClientMultiple.ino</a>, <a class="el" href="_t_c_p_client_single_8ino-example.html#a8">TCPClientSingle.ino</a>, <a class="el" href="_t_c_p_client_single_u_n_o_8ino-example.html#a8">TCPClientSingleUNO.ino</a>, <a class="el" href="_t_c_p_server_8ino-example.html#a8">TCPServer.ino</a>, <a class="el" href="_u_d_p_client_multiple_8ino-example.html#a8">UDPClientMultiple.ino</a>, and <a class="el" href="_u_d_p_client_single_8ino-example.html#a8">UDPClientSingle.ino</a>.</dd>
576</dl>
577<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00271">271</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
578
579</div>
580</div>
581<a class="anchor" id="a0d6429057e090be1a6f4da91eff92d82"></a>
582<div class="memitem">
583<div class="memproto">
584 <table class="memname">
585 <tr>
586 <td class="memname">uint32_t ESP8266::recv </td>
587 <td>(</td>
588 <td class="paramtype">uint8_t&#160;</td>
589 <td class="paramname"><em>mux_id</em>, </td>
590 </tr>
591 <tr>
592 <td class="paramkey"></td>
593 <td></td>
594 <td class="paramtype">uint8_t *&#160;</td>
595 <td class="paramname"><em>buffer</em>, </td>
596 </tr>
597 <tr>
598 <td class="paramkey"></td>
599 <td></td>
600 <td class="paramtype">uint32_t&#160;</td>
601 <td class="paramname"><em>buffer_size</em>, </td>
602 </tr>
603 <tr>
604 <td class="paramkey"></td>
605 <td></td>
606 <td class="paramtype">uint32_t&#160;</td>
607 <td class="paramname"><em>timeout</em> = <code>1000</code>&#160;</td>
608 </tr>
609 <tr>
610 <td></td>
611 <td>)</td>
612 <td></td><td></td>
613 </tr>
614 </table>
615</div><div class="memdoc">
616
617<p>Receive data from one of TCP or UDP builded already in multiple mode. </p>
618<dl class="params"><dt>Parameters</dt><dd>
619 <table class="params">
620 <tr><td class="paramname">mux_id</td><td>- the identifier of this TCP(available value: 0 - 4). </td></tr>
621 <tr><td class="paramname">buffer</td><td>- the buffer for storing data. </td></tr>
622 <tr><td class="paramname">buffer_size</td><td>- the length of the buffer. </td></tr>
623 <tr><td class="paramname">timeout</td><td>- the time waiting data. </td></tr>
624 </table>
625 </dd>
626</dl>
627<dl class="section return"><dt>Returns</dt><dd>the length of data received actually. </dd></dl>
628
629<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00276">276</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
630
631</div>
632</div>
633<a class="anchor" id="a7d68591021e6ddc6919cb5865827856f"></a>
634<div class="memitem">
635<div class="memproto">
636 <table class="memname">
637 <tr>
638 <td class="memname">uint32_t ESP8266::recv </td>
639 <td>(</td>
640 <td class="paramtype">uint8_t *&#160;</td>
641 <td class="paramname"><em>coming_mux_id</em>, </td>
642 </tr>
643 <tr>
644 <td class="paramkey"></td>
645 <td></td>
646 <td class="paramtype">uint8_t *&#160;</td>
647 <td class="paramname"><em>buffer</em>, </td>
648 </tr>
649 <tr>
650 <td class="paramkey"></td>
651 <td></td>
652 <td class="paramtype">uint32_t&#160;</td>
653 <td class="paramname"><em>buffer_size</em>, </td>
654 </tr>
655 <tr>
656 <td class="paramkey"></td>
657 <td></td>
658 <td class="paramtype">uint32_t&#160;</td>
659 <td class="paramname"><em>timeout</em> = <code>1000</code>&#160;</td>
660 </tr>
661 <tr>
662 <td></td>
663 <td>)</td>
664 <td></td><td></td>
665 </tr>
666 </table>
667</div><div class="memdoc">
668
669<p>Receive data from all of TCP or UDP builded already in multiple mode. </p>
670<p>After return, coming_mux_id store the id of TCP or UDP from which data coming. User should read the value of coming_mux_id and decide what next to do.</p>
671<dl class="params"><dt>Parameters</dt><dd>
672 <table class="params">
673 <tr><td class="paramname">coming_mux_id</td><td>- the identifier of TCP or UDP. </td></tr>
674 <tr><td class="paramname">buffer</td><td>- the buffer for storing data. </td></tr>
675 <tr><td class="paramname">buffer_size</td><td>- the length of the buffer. </td></tr>
676 <tr><td class="paramname">timeout</td><td>- the time waiting data. </td></tr>
677 </table>
678 </dd>
679</dl>
680<dl class="section return"><dt>Returns</dt><dd>the length of data received actually. </dd></dl>
681
682<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00287">287</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
683
684</div>
685</div>
686<a class="anchor" id="af8d3305a28d862c0cf353d0d758b96d4"></a>
687<div class="memitem">
688<div class="memproto">
689 <table class="memname">
690 <tr>
691 <td class="memname">bool ESP8266::registerUDP </td>
692 <td>(</td>
693 <td class="paramtype">String&#160;</td>
694 <td class="paramname"><em>addr</em>, </td>
695 </tr>
696 <tr>
697 <td class="paramkey"></td>
698 <td></td>
699 <td class="paramtype">uint32_t&#160;</td>
700 <td class="paramname"><em>port</em>&#160;</td>
701 </tr>
702 <tr>
703 <td></td>
704 <td>)</td>
705 <td></td><td></td>
706 </tr>
707 </table>
708</div><div class="memdoc">
709
710<p>Register UDP port number in single mode. </p>
711<dl class="params"><dt>Parameters</dt><dd>
712 <table class="params">
713 <tr><td class="paramname">addr</td><td>- the IP or domain name of the target host. </td></tr>
714 <tr><td class="paramname">port</td><td>- the port number of the target host. </td></tr>
715 </table>
716 </dd>
717</dl>
718<dl class="retval"><dt>Return values</dt><dd>
719 <table class="retval">
720 <tr><td class="paramname">true</td><td>- success. </td></tr>
721 <tr><td class="paramname">false</td><td>- failure. </td></tr>
722 </table>
723 </dd>
724</dl>
725<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_u_d_p_client_multiple_8ino-example.html#a6">UDPClientMultiple.ino</a>, and <a class="el" href="_u_d_p_client_single_8ino-example.html#a6">UDPClientSingle.ino</a>.</dd>
726</dl>
727<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00201">201</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
728
729</div>
730</div>
731<a class="anchor" id="af70a0a7c963c6411948622d802b31b2d"></a>
732<div class="memitem">
733<div class="memproto">
734 <table class="memname">
735 <tr>
736 <td class="memname">bool ESP8266::registerUDP </td>
737 <td>(</td>
738 <td class="paramtype">uint8_t&#160;</td>
739 <td class="paramname"><em>mux_id</em>, </td>
740 </tr>
741 <tr>
742 <td class="paramkey"></td>
743 <td></td>
744 <td class="paramtype">String&#160;</td>
745 <td class="paramname"><em>addr</em>, </td>
746 </tr>
747 <tr>
748 <td class="paramkey"></td>
749 <td></td>
750 <td class="paramtype">uint32_t&#160;</td>
751 <td class="paramname"><em>port</em>&#160;</td>
752 </tr>
753 <tr>
754 <td></td>
755 <td>)</td>
756 <td></td><td></td>
757 </tr>
758 </table>
759</div><div class="memdoc">
760
761<p>Register UDP port number in multiple mode. </p>
762<dl class="params"><dt>Parameters</dt><dd>
763 <table class="params">
764 <tr><td class="paramname">mux_id</td><td>- the identifier of this TCP(available value: 0 - 4). </td></tr>
765 <tr><td class="paramname">addr</td><td>- the IP or domain name of the target host. </td></tr>
766 <tr><td class="paramname">port</td><td>- the port number of the target host. </td></tr>
767 </table>
768 </dd>
769</dl>
770<dl class="retval"><dt>Return values</dt><dd>
771 <table class="retval">
772 <tr><td class="paramname">true</td><td>- success. </td></tr>
773 <tr><td class="paramname">false</td><td>- failure. </td></tr>
774 </table>
775 </dd>
776</dl>
777
778<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00221">221</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
779
780</div>
781</div>
782<a class="anchor" id="ac15ce9df69dc566c37b3fa2c3c869337"></a>
783<div class="memitem">
784<div class="memproto">
785 <table class="memname">
786 <tr>
787 <td class="memname">bool ESP8266::releaseTCP </td>
788 <td>(</td>
789 <td class="paramtype">void&#160;</td>
790 <td class="paramname"></td><td>)</td>
791 <td></td>
792 </tr>
793 </table>
794</div><div class="memdoc">
795
796<p>Release TCP connection in single mode. </p>
797<dl class="retval"><dt>Return values</dt><dd>
798 <table class="retval">
799 <tr><td class="paramname">true</td><td>- success. </td></tr>
800 <tr><td class="paramname">false</td><td>- failure. </td></tr>
801 </table>
802 </dd>
803</dl>
804<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_h_t_t_p_g_e_t_8ino-example.html#a9">HTTPGET.ino</a>, <a class="el" href="_t_c_p_client_multiple_8ino-example.html#a9">TCPClientMultiple.ino</a>, <a class="el" href="_t_c_p_client_single_8ino-example.html#a9">TCPClientSingle.ino</a>, <a class="el" href="_t_c_p_client_single_u_n_o_8ino-example.html#a9">TCPClientSingleUNO.ino</a>, and <a class="el" href="_t_c_p_server_8ino-example.html#a11">TCPServer.ino</a>.</dd>
805</dl>
806<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00196">196</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
807
808</div>
809</div>
810<a class="anchor" id="a96fd1a01f8f52dd80ae7f7a267005300"></a>
811<div class="memitem">
812<div class="memproto">
813 <table class="memname">
814 <tr>
815 <td class="memname">bool ESP8266::releaseTCP </td>
816 <td>(</td>
817 <td class="paramtype">uint8_t&#160;</td>
818 <td class="paramname"><em>mux_id</em></td><td>)</td>
819 <td></td>
820 </tr>
821 </table>
822</div><div class="memdoc">
823
824<p>Release TCP connection in multiple mode. </p>
825<dl class="params"><dt>Parameters</dt><dd>
826 <table class="params">
827 <tr><td class="paramname">mux_id</td><td>- the identifier of this TCP(available value: 0 - 4). </td></tr>
828 </table>
829 </dd>
830</dl>
831<dl class="retval"><dt>Return values</dt><dd>
832 <table class="retval">
833 <tr><td class="paramname">true</td><td>- success. </td></tr>
834 <tr><td class="paramname">false</td><td>- failure. </td></tr>
835 </table>
836 </dd>
837</dl>
838
839<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00216">216</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
840
841</div>
842</div>
843<a class="anchor" id="a04b61a01af4ee5e8820c9de79b4b3c39"></a>
844<div class="memitem">
845<div class="memproto">
846 <table class="memname">
847 <tr>
848 <td class="memname">bool ESP8266::restart </td>
849 <td>(</td>
850 <td class="paramtype">void&#160;</td>
851 <td class="paramname"></td><td>)</td>
852 <td></td>
853 </tr>
854 </table>
855</div><div class="memdoc">
856
857<p>Restart <a class="el" href="class_e_s_p8266.html" title="Provide an easy-to-use way to manipulate ESP8266. ">ESP8266</a> by "AT+RST". </p>
858<p>This method will take 3 seconds or more.</p>
859<dl class="retval"><dt>Return values</dt><dd>
860 <table class="retval">
861 <tr><td class="paramname">true</td><td>- success. </td></tr>
862 <tr><td class="paramname">false</td><td>- failure. </td></tr>
863 </table>
864 </dd>
865</dl>
866
867<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00063">63</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
868
869</div>
870</div>
871<a class="anchor" id="a6ba21b921a7afc79a36d0e41c20d59bc"></a>
872<div class="memitem">
873<div class="memproto">
874 <table class="memname">
875 <tr>
876 <td class="memname">bool ESP8266::send </td>
877 <td>(</td>
878 <td class="paramtype">const uint8_t *&#160;</td>
879 <td class="paramname"><em>buffer</em>, </td>
880 </tr>
881 <tr>
882 <td class="paramkey"></td>
883 <td></td>
884 <td class="paramtype">uint32_t&#160;</td>
885 <td class="paramname"><em>len</em>&#160;</td>
886 </tr>
887 <tr>
888 <td></td>
889 <td>)</td>
890 <td></td><td></td>
891 </tr>
892 </table>
893</div><div class="memdoc">
894
895<p>Send data based on TCP or UDP builded already in single mode. </p>
896<dl class="params"><dt>Parameters</dt><dd>
897 <table class="params">
898 <tr><td class="paramname">buffer</td><td>- the buffer of data to send. </td></tr>
899 <tr><td class="paramname">len</td><td>- the length of data to send. </td></tr>
900 </table>
901 </dd>
902</dl>
903<dl class="retval"><dt>Return values</dt><dd>
904 <table class="retval">
905 <tr><td class="paramname">true</td><td>- success. </td></tr>
906 <tr><td class="paramname">false</td><td>- failure. </td></tr>
907 </table>
908 </dd>
909</dl>
910<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_h_t_t_p_g_e_t_8ino-example.html#a7">HTTPGET.ino</a>, <a class="el" href="_t_c_p_client_multiple_8ino-example.html#a7">TCPClientMultiple.ino</a>, <a class="el" href="_t_c_p_client_single_8ino-example.html#a7">TCPClientSingle.ino</a>, <a class="el" href="_t_c_p_client_single_u_n_o_8ino-example.html#a7">TCPClientSingleUNO.ino</a>, <a class="el" href="_t_c_p_server_8ino-example.html#a10">TCPServer.ino</a>, <a class="el" href="_u_d_p_client_multiple_8ino-example.html#a7">UDPClientMultiple.ino</a>, and <a class="el" href="_u_d_p_client_single_8ino-example.html#a7">UDPClientSingle.ino</a>.</dd>
911</dl>
912<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00261">261</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
913
914</div>
915</div>
916<a class="anchor" id="afb7d7b4e281d4c4699a33e1d086e6d54"></a>
917<div class="memitem">
918<div class="memproto">
919 <table class="memname">
920 <tr>
921 <td class="memname">bool ESP8266::send </td>
922 <td>(</td>
923 <td class="paramtype">uint8_t&#160;</td>
924 <td class="paramname"><em>mux_id</em>, </td>
925 </tr>
926 <tr>
927 <td class="paramkey"></td>
928 <td></td>
929 <td class="paramtype">const uint8_t *&#160;</td>
930 <td class="paramname"><em>buffer</em>, </td>
931 </tr>
932 <tr>
933 <td class="paramkey"></td>
934 <td></td>
935 <td class="paramtype">uint32_t&#160;</td>
936 <td class="paramname"><em>len</em>&#160;</td>
937 </tr>
938 <tr>
939 <td></td>
940 <td>)</td>
941 <td></td><td></td>
942 </tr>
943 </table>
944</div><div class="memdoc">
945
946<p>Send data based on one of TCP or UDP builded already in multiple mode. </p>
947<dl class="params"><dt>Parameters</dt><dd>
948 <table class="params">
949 <tr><td class="paramname">mux_id</td><td>- the identifier of this TCP(available value: 0 - 4). </td></tr>
950 <tr><td class="paramname">buffer</td><td>- the buffer of data to send. </td></tr>
951 <tr><td class="paramname">len</td><td>- the length of data to send. </td></tr>
952 </table>
953 </dd>
954</dl>
955<dl class="retval"><dt>Return values</dt><dd>
956 <table class="retval">
957 <tr><td class="paramname">true</td><td>- success. </td></tr>
958 <tr><td class="paramname">false</td><td>- failure. </td></tr>
959 </table>
960 </dd>
961</dl>
962
963<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00266">266</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
964
965</div>
966</div>
967<a class="anchor" id="a247706884d60e85c8983bb65de26d346"></a>
968<div class="memitem">
969<div class="memproto">
970 <table class="memname">
971 <tr>
972 <td class="memname">bool ESP8266::setOprToSoftAP </td>
973 <td>(</td>
974 <td class="paramtype">void&#160;</td>
975 <td class="paramname"></td><td>)</td>
976 <td></td>
977 </tr>
978 </table>
979</div><div class="memdoc">
980
981<p>Set operation mode to softap. </p>
982<dl class="retval"><dt>Return values</dt><dd>
983 <table class="retval">
984 <tr><td class="paramname">true</td><td>- success. </td></tr>
985 <tr><td class="paramname">false</td><td>- failure. </td></tr>
986 </table>
987 </dd>
988</dl>
989
990<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00104">104</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
991
992</div>
993</div>
994<a class="anchor" id="a572c6f855d70078fdbff9ac2c4b1ce99"></a>
995<div class="memitem">
996<div class="memproto">
997 <table class="memname">
998 <tr>
999 <td class="memname">bool ESP8266::setOprToStation </td>
1000 <td>(</td>
1001 <td class="paramtype">void&#160;</td>
1002 <td class="paramname"></td><td>)</td>
1003 <td></td>
1004 </tr>
1005 </table>
1006</div><div class="memdoc">
1007
1008<p>Set operation mode to staion. </p>
1009<dl class="retval"><dt>Return values</dt><dd>
1010 <table class="retval">
1011 <tr><td class="paramname">true</td><td>- success. </td></tr>
1012 <tr><td class="paramname">false</td><td>- failure. </td></tr>
1013 </table>
1014 </dd>
1015</dl>
1016<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_connect_wi_fi_8ino-example.html#a2">ConnectWiFi.ino</a>.</dd>
1017</dl>
1018<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00087">87</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
1019
1020</div>
1021</div>
1022<a class="anchor" id="ac179183a46b218609a481747bcfd5a61"></a>
1023<div class="memitem">
1024<div class="memproto">
1025 <table class="memname">
1026 <tr>
1027 <td class="memname">bool ESP8266::setOprToStationSoftAP </td>
1028 <td>(</td>
1029 <td class="paramtype">void&#160;</td>
1030 <td class="paramname"></td><td>)</td>
1031 <td></td>
1032 </tr>
1033 </table>
1034</div><div class="memdoc">
1035
1036<p>Set operation mode to station + softap. </p>
1037<dl class="retval"><dt>Return values</dt><dd>
1038 <table class="retval">
1039 <tr><td class="paramname">true</td><td>- success. </td></tr>
1040 <tr><td class="paramname">false</td><td>- failure. </td></tr>
1041 </table>
1042 </dd>
1043</dl>
1044<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_h_t_t_p_g_e_t_8ino-example.html#a2">HTTPGET.ino</a>, <a class="el" href="_t_c_p_client_multiple_8ino-example.html#a2">TCPClientMultiple.ino</a>, <a class="el" href="_t_c_p_client_single_8ino-example.html#a2">TCPClientSingle.ino</a>, <a class="el" href="_t_c_p_client_single_u_n_o_8ino-example.html#a2">TCPClientSingleUNO.ino</a>, <a class="el" href="_t_c_p_server_8ino-example.html#a2">TCPServer.ino</a>, <a class="el" href="_u_d_p_client_multiple_8ino-example.html#a2">UDPClientMultiple.ino</a>, and <a class="el" href="_u_d_p_client_single_8ino-example.html#a2">UDPClientSingle.ino</a>.</dd>
1045</dl>
1046<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00121">121</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
1047
1048</div>
1049</div>
1050<a class="anchor" id="aacce786dc0ef289cd37a48642d2efef1"></a>
1051<div class="memitem">
1052<div class="memproto">
1053 <table class="memname">
1054 <tr>
1055 <td class="memname">bool ESP8266::setSoftAPParam </td>
1056 <td>(</td>
1057 <td class="paramtype">String&#160;</td>
1058 <td class="paramname"><em>ssid</em>, </td>
1059 </tr>
1060 <tr>
1061 <td class="paramkey"></td>
1062 <td></td>
1063 <td class="paramtype">String&#160;</td>
1064 <td class="paramname"><em>pwd</em>, </td>
1065 </tr>
1066 <tr>
1067 <td class="paramkey"></td>
1068 <td></td>
1069 <td class="paramtype">uint8_t&#160;</td>
1070 <td class="paramname"><em>chl</em> = <code>7</code>, </td>
1071 </tr>
1072 <tr>
1073 <td class="paramkey"></td>
1074 <td></td>
1075 <td class="paramtype">uint8_t&#160;</td>
1076 <td class="paramname"><em>ecn</em> = <code>4</code>&#160;</td>
1077 </tr>
1078 <tr>
1079 <td></td>
1080 <td>)</td>
1081 <td></td><td></td>
1082 </tr>
1083 </table>
1084</div><div class="memdoc">
1085
1086<p>Set SoftAP parameters. </p>
1087<dl class="params"><dt>Parameters</dt><dd>
1088 <table class="params">
1089 <tr><td class="paramname">ssid</td><td>- SSID of SoftAP. </td></tr>
1090 <tr><td class="paramname">pwd</td><td>- PASSWORD of SoftAP. </td></tr>
1091 <tr><td class="paramname">chl</td><td>- the channel (1 - 13, default: 7). </td></tr>
1092 <tr><td class="paramname">ecn</td><td>- the way of encrypstion (0 - OPEN, 1 - WEP, 2 - WPA_PSK, 3 - WPA2_PSK, 4 - WPA_WPA2_PSK, default: 4). </td></tr>
1093 </table>
1094 </dd>
1095</dl>
1096<dl class="section note"><dt>Note</dt><dd>This method should not be called when station mode. </dd></dl>
1097
1098<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00155">155</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
1099
1100</div>
1101</div>
1102<a class="anchor" id="a71f76c76d23fc66c26f1c7b357f58ac2"></a>
1103<div class="memitem">
1104<div class="memproto">
1105 <table class="memname">
1106 <tr>
1107 <td class="memname">bool ESP8266::setTCPServerTimeout </td>
1108 <td>(</td>
1109 <td class="paramtype">uint32_t&#160;</td>
1110 <td class="paramname"><em>timeout</em> = <code>180</code></td><td>)</td>
1111 <td></td>
1112 </tr>
1113 </table>
1114</div><div class="memdoc">
1115
1116<p>Set the timeout of TCP Server. </p>
1117<dl class="params"><dt>Parameters</dt><dd>
1118 <table class="params">
1119 <tr><td class="paramname">timeout</td><td>- the duration for timeout by second(0 ~ 28800, default:180). </td></tr>
1120 </table>
1121 </dd>
1122</dl>
1123<dl class="retval"><dt>Return values</dt><dd>
1124 <table class="retval">
1125 <tr><td class="paramname">true</td><td>- success. </td></tr>
1126 <tr><td class="paramname">false</td><td>- failure. </td></tr>
1127 </table>
1128 </dd>
1129</dl>
1130<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_t_c_p_server_8ino-example.html#a7">TCPServer.ino</a>.</dd>
1131</dl>
1132<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00231">231</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
1133
1134</div>
1135</div>
1136<a class="anchor" id="a88d9a6b130b6c278fd6cd2e6cda816d7"></a>
1137<div class="memitem">
1138<div class="memproto">
1139 <table class="memname">
1140 <tr>
1141 <td class="memname">bool ESP8266::startServer </td>
1142 <td>(</td>
1143 <td class="paramtype">uint32_t&#160;</td>
1144 <td class="paramname"><em>port</em> = <code>333</code></td><td>)</td>
1145 <td></td>
1146 </tr>
1147 </table>
1148</div><div class="memdoc">
1149
1150<p>Start Server(Only in multiple mode). </p>
1151<dl class="params"><dt>Parameters</dt><dd>
1152 <table class="params">
1153 <tr><td class="paramname">port</td><td>- the port number to listen(default: 333). </td></tr>
1154 </table>
1155 </dd>
1156</dl>
1157<dl class="retval"><dt>Return values</dt><dd>
1158 <table class="retval">
1159 <tr><td class="paramname">true</td><td>- success. </td></tr>
1160 <tr><td class="paramname">false</td><td>- failure.</td></tr>
1161 </table>
1162 </dd>
1163</dl>
1164<dl class="section see"><dt>See also</dt><dd>String <a class="el" href="class_e_s_p8266.html#ad273286fbb8627a612249a232d53ca22" title="Get the current status of connection(UDP and TCP). ">getIPStatus(void)</a>; </dd>
1165<dd>
1166uint32_t <a class="el" href="class_e_s_p8266.html#a7d68591021e6ddc6919cb5865827856f" title="Receive data from all of TCP or UDP builded already in multiple mode. ">recv(uint8_t *coming_mux_id, uint8_t *buffer, uint32_t len, uint32_t timeout)</a>; </dd></dl>
1167
1168<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00251">251</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
1169
1170</div>
1171</div>
1172<a class="anchor" id="a22a7768a76709c8d8f0b9809158b7ec9"></a>
1173<div class="memitem">
1174<div class="memproto">
1175 <table class="memname">
1176 <tr>
1177 <td class="memname">bool ESP8266::startTCPServer </td>
1178 <td>(</td>
1179 <td class="paramtype">uint32_t&#160;</td>
1180 <td class="paramname"><em>port</em> = <code>333</code></td><td>)</td>
1181 <td></td>
1182 </tr>
1183 </table>
1184</div><div class="memdoc">
1185
1186<p>Start TCP Server(Only in multiple mode). </p>
1187<p>After started, user should call method: getIPStatus to know the status of TCP connections. The methods of receiving data can be called for user's any purpose. After communication, release the TCP connection is needed by calling method: releaseTCP with mux_id.</p>
1188<dl class="params"><dt>Parameters</dt><dd>
1189 <table class="params">
1190 <tr><td class="paramname">port</td><td>- the port number to listen(default: 333). </td></tr>
1191 </table>
1192 </dd>
1193</dl>
1194<dl class="retval"><dt>Return values</dt><dd>
1195 <table class="retval">
1196 <tr><td class="paramname">true</td><td>- success. </td></tr>
1197 <tr><td class="paramname">false</td><td>- failure.</td></tr>
1198 </table>
1199 </dd>
1200</dl>
1201<dl class="section see"><dt>See also</dt><dd>String <a class="el" href="class_e_s_p8266.html#ad273286fbb8627a612249a232d53ca22" title="Get the current status of connection(UDP and TCP). ">getIPStatus(void)</a>; </dd>
1202<dd>
1203uint32_t <a class="el" href="class_e_s_p8266.html#a7d68591021e6ddc6919cb5865827856f" title="Receive data from all of TCP or UDP builded already in multiple mode. ">recv(uint8_t *coming_mux_id, uint8_t *buffer, uint32_t len, uint32_t timeout)</a>; </dd>
1204<dd>
1205bool <a class="el" href="class_e_s_p8266.html#a96fd1a01f8f52dd80ae7f7a267005300" title="Release TCP connection in multiple mode. ">releaseTCP(uint8_t mux_id)</a>; </dd></dl>
1206<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_t_c_p_server_8ino-example.html#a6">TCPServer.ino</a>.</dd>
1207</dl>
1208<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00236">236</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
1209
1210</div>
1211</div>
1212<a class="anchor" id="af272f2f57b7b99434e257f06c276acfc"></a>
1213<div class="memitem">
1214<div class="memproto">
1215 <table class="memname">
1216 <tr>
1217 <td class="memname">bool ESP8266::stopServer </td>
1218 <td>(</td>
1219 <td class="paramtype">void&#160;</td>
1220 <td class="paramname"></td><td>)</td>
1221 <td></td>
1222 </tr>
1223 </table>
1224</div><div class="memdoc">
1225
1226<p>Stop Server(Only in multiple mode). </p>
1227<dl class="retval"><dt>Return values</dt><dd>
1228 <table class="retval">
1229 <tr><td class="paramname">true</td><td>- success. </td></tr>
1230 <tr><td class="paramname">false</td><td>- failure. </td></tr>
1231 </table>
1232 </dd>
1233</dl>
1234
1235<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00256">256</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
1236
1237</div>
1238</div>
1239<a class="anchor" id="aa5355dce05aa59b92ce9f7ea76d86eef"></a>
1240<div class="memitem">
1241<div class="memproto">
1242 <table class="memname">
1243 <tr>
1244 <td class="memname">bool ESP8266::stopTCPServer </td>
1245 <td>(</td>
1246 <td class="paramtype">void&#160;</td>
1247 <td class="paramname"></td><td>)</td>
1248 <td></td>
1249 </tr>
1250 </table>
1251</div><div class="memdoc">
1252
1253<p>Stop TCP Server(Only in multiple mode). </p>
1254<dl class="retval"><dt>Return values</dt><dd>
1255 <table class="retval">
1256 <tr><td class="paramname">true</td><td>- success. </td></tr>
1257 <tr><td class="paramname">false</td><td>- failure. </td></tr>
1258 </table>
1259 </dd>
1260</dl>
1261
1262<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00244">244</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
1263
1264</div>
1265</div>
1266<a class="anchor" id="aa355332a78aa5f2b58cb11b0daa05cf5"></a>
1267<div class="memitem">
1268<div class="memproto">
1269 <table class="memname">
1270 <tr>
1271 <td class="memname">bool ESP8266::unregisterUDP </td>
1272 <td>(</td>
1273 <td class="paramtype">void&#160;</td>
1274 <td class="paramname"></td><td>)</td>
1275 <td></td>
1276 </tr>
1277 </table>
1278</div><div class="memdoc">
1279
1280<p>Unregister UDP port number in single mode. </p>
1281<dl class="retval"><dt>Return values</dt><dd>
1282 <table class="retval">
1283 <tr><td class="paramname">true</td><td>- success. </td></tr>
1284 <tr><td class="paramname">false</td><td>- failure. </td></tr>
1285 </table>
1286 </dd>
1287</dl>
1288<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_u_d_p_client_multiple_8ino-example.html#a9">UDPClientMultiple.ino</a>, and <a class="el" href="_u_d_p_client_single_8ino-example.html#a9">UDPClientSingle.ino</a>.</dd>
1289</dl>
1290<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00206">206</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
1291
1292</div>
1293</div>
1294<a class="anchor" id="a0a48619ad157fd2bd9c7f2e9c151f9b3"></a>
1295<div class="memitem">
1296<div class="memproto">
1297 <table class="memname">
1298 <tr>
1299 <td class="memname">bool ESP8266::unregisterUDP </td>
1300 <td>(</td>
1301 <td class="paramtype">uint8_t&#160;</td>
1302 <td class="paramname"><em>mux_id</em></td><td>)</td>
1303 <td></td>
1304 </tr>
1305 </table>
1306</div><div class="memdoc">
1307
1308<p>Unregister UDP port number in multiple mode. </p>
1309<dl class="params"><dt>Parameters</dt><dd>
1310 <table class="params">
1311 <tr><td class="paramname">mux_id</td><td>- the identifier of this TCP(available value: 0 - 4). </td></tr>
1312 </table>
1313 </dd>
1314</dl>
1315<dl class="retval"><dt>Return values</dt><dd>
1316 <table class="retval">
1317 <tr><td class="paramname">true</td><td>- success. </td></tr>
1318 <tr><td class="paramname">false</td><td>- failure. </td></tr>
1319 </table>
1320 </dd>
1321</dl>
1322
1323<p>Definition at line <a class="el" href="_e_s_p8266_8cpp_source.html#l00226">226</a> of file <a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a>.</p>
1324
1325</div>
1326</div>
1327<hr/>The documentation for this class was generated from the following files:<ul>
1328<li><a class="el" href="_e_s_p8266_8h_source.html">ESP8266.h</a></li>
1329<li><a class="el" href="_e_s_p8266_8cpp_source.html">ESP8266.cpp</a></li>
1330</ul>
1331</div><!-- contents -->
1332<!-- start footer part -->
1333<hr class="footer"/><address class="footer"><small>
1334Generated on Tue Mar 17 2015 10:34:17 for API by &#160;<a href="http://www.doxygen.org/index.html">
1335<img class="footer" src="doxygen.png" alt="doxygen"/>
1336</a> 1.8.7
1337</small></address>
1338</body>
1339</html>
Note: See TracBrowser for help on using the repository browser.