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

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

ライブラリとOS及びベーシックなサンプルの追加．
File size: 41.9 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.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
36 <li class="current"><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="files.html"><span>File&#160;List</span></a></li>
43 </ul>
44 </div>
45</div><!-- top -->
46<div class="header">
47 <div class="headertitle">
48<div class="title">ESP8266.h</div> </div>
49</div><!--header-->
50<div class="contents">
51<a href="_e_s_p8266_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
52<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#ifndef __ESP8266_H__</span></div>
53<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#define __ESP8266_H__</span></div>
54<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
55<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;Arduino.h&quot;</span></div>
56<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
57<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
58<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">//#define ESP8266_USE_SOFTWARE_SERIAL</span></div>
59<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
60<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div>
61<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#ifdef ESP8266_USE_SOFTWARE_SERIAL</span></div>
62<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &quot;SoftwareSerial.h&quot;</span></div>
63<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#endif</span></div>
64<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
65<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
66<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="class_e_s_p8266.html"> 38</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_e_s_p8266.html">ESP8266</a> {</div>
67<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">public</span>:</div>
68<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
69<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#ifdef ESP8266_USE_SOFTWARE_SERIAL</span></div>
70<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="comment">/*</span></div>
71<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment"> * Constuctor. </span></div>
72<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment"> *</span></div>
73<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment"> * @param uart - an reference of SoftwareSerial object. </span></div>
74<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"> * @param baud - the buad rate to communicate with ESP8266(default:9600). </span></div>
75<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment"> *</span></div>
76<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment"> * @warning parameter baud depends on the AT firmware. 9600 is an common value. </span></div>
77<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment"> */</span></div>
78<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <a class="code" href="class_e_s_p8266.html">ESP8266</a>(SoftwareSerial &amp;uart, uint32_t baud = 9600);</div>
79<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#else </span><span class="comment">/* HardwareSerial */</span><span class="preprocessor"></span></div>
80<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="comment">/*</span></div>
81<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment"> * Constuctor. </span></div>
82<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="comment"> *</span></div>
83<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment"> * @param uart - an reference of HardwareSerial object. </span></div>
84<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment"> * @param baud - the buad rate to communicate with ESP8266(default:9600). </span></div>
85<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="comment"> *</span></div>
86<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="comment"> * @warning parameter baud depends on the AT firmware. 9600 is an common value. </span></div>
87<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="comment"> */</span></div>
88<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <a class="code" href="class_e_s_p8266.html">ESP8266</a>(HardwareSerial &amp;uart, uint32_t baud = 9600);</div>
89<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor">#endif</span></div>
90<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
91<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
92<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#a5ed71947606435c3b03b73efdaf810a5">kick</a>(<span class="keywordtype">void</span>);</div>
93<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; </div>
94<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#a04b61a01af4ee5e8820c9de79b4b3c39">restart</a>(<span class="keywordtype">void</span>);</div>
95<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
96<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; String <a class="code" href="class_e_s_p8266.html#a4e2d8a0637b437d4b03209cebfa5b750">getVersion</a>(<span class="keywordtype">void</span>);</div>
97<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div>
98<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#a572c6f855d70078fdbff9ac2c4b1ce99">setOprToStation</a>(<span class="keywordtype">void</span>);</div>
99<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; </div>
100<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#a247706884d60e85c8983bb65de26d346">setOprToSoftAP</a>(<span class="keywordtype">void</span>);</div>
101<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; </div>
102<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#ac179183a46b218609a481747bcfd5a61">setOprToStationSoftAP</a>(<span class="keywordtype">void</span>);</div>
103<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; </div>
104<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; String <a class="code" href="class_e_s_p8266.html#af0cafe8a994349e81e75a35af9645a76">getAPList</a>(<span class="keywordtype">void</span>);</div>
105<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; </div>
106<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#a300535b4b5f001b74058ebcc694a749f">joinAP</a>(String ssid, String pwd);</div>
107<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; </div>
108<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#aeda29748e0d28efa9d82c9c7fab1859b">leaveAP</a>(<span class="keywordtype">void</span>);</div>
109<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; </div>
110<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#aacce786dc0ef289cd37a48642d2efef1">setSoftAPParam</a>(String ssid, String pwd, uint8_t chl = 7, uint8_t ecn = 4);</div>
111<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; </div>
112<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; String <a class="code" href="class_e_s_p8266.html#a10c82a5196a8f349720a9c9ba7209a6e">getJoinedDeviceIP</a>(<span class="keywordtype">void</span>);</div>
113<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; </div>
114<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; String <a class="code" href="class_e_s_p8266.html#ad273286fbb8627a612249a232d53ca22">getIPStatus</a>(<span class="keywordtype">void</span>);</div>
115<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; </div>
116<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; String <a class="code" href="class_e_s_p8266.html#a20819d4dabf19fed6e3dcb3fd04ee49d">getLocalIP</a>(<span class="keywordtype">void</span>);</div>
117<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; </div>
118<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#a16963a076b80906563d2269c0cd52007">enableMUX</a>(<span class="keywordtype">void</span>);</div>
119<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; </div>
120<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#a2bc64145329ea45018e956b97ced030a">disableMUX</a>(<span class="keywordtype">void</span>);</div>
121<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; </div>
122<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; </div>
123<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#aa927b7b8aaef163011015c22da1f07e2">createTCP</a>(String addr, uint32_t port);</div>
124<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160; </div>
125<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#ac15ce9df69dc566c37b3fa2c3c869337">releaseTCP</a>(<span class="keywordtype">void</span>);</div>
126<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160; </div>
127<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#af8d3305a28d862c0cf353d0d758b96d4">registerUDP</a>(String addr, uint32_t port);</div>
128<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; </div>
129<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#aa355332a78aa5f2b58cb11b0daa05cf5">unregisterUDP</a>(<span class="keywordtype">void</span>);</div>
130<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160; </div>
131<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#aa927b7b8aaef163011015c22da1f07e2">createTCP</a>(uint8_t mux_id, String addr, uint32_t port);</div>
132<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160; </div>
133<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#ac15ce9df69dc566c37b3fa2c3c869337">releaseTCP</a>(uint8_t mux_id);</div>
134<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160; </div>
135<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#af8d3305a28d862c0cf353d0d758b96d4">registerUDP</a>(uint8_t mux_id, String addr, uint32_t port);</div>
136<div class="line"><a name="l00265"></a><span class="lineno"> 265</span>&#160; </div>
137<div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#aa355332a78aa5f2b58cb11b0daa05cf5">unregisterUDP</a>(uint8_t mux_id);</div>
138<div class="line"><a name="l00274"></a><span class="lineno"> 274</span>&#160;</div>
139<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>&#160;</div>
140<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#a71f76c76d23fc66c26f1c7b357f58ac2">setTCPServerTimeout</a>(uint32_t timeout = 180);</div>
141<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160; </div>
142<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#a22a7768a76709c8d8f0b9809158b7ec9">startTCPServer</a>(uint32_t port = 333);</div>
143<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>&#160;</div>
144<div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#aa5355dce05aa59b92ce9f7ea76d86eef">stopTCPServer</a>(<span class="keywordtype">void</span>);</div>
145<div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160; </div>
146<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#a88d9a6b130b6c278fd6cd2e6cda816d7">startServer</a>(uint32_t port = 333);</div>
147<div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160;</div>
148<div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#af272f2f57b7b99434e257f06c276acfc">stopServer</a>(<span class="keywordtype">void</span>);</div>
149<div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160;</div>
150<div class="line"><a name="l00338"></a><span class="lineno"> 338</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#a6ba21b921a7afc79a36d0e41c20d59bc">send</a>(<span class="keyword">const</span> uint8_t *buffer, uint32_t len);</div>
151<div class="line"><a name="l00339"></a><span class="lineno"> 339</span>&#160; </div>
152<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_e_s_p8266.html#a6ba21b921a7afc79a36d0e41c20d59bc">send</a>(uint8_t mux_id, <span class="keyword">const</span> uint8_t *buffer, uint32_t len);</div>
153<div class="line"><a name="l00350"></a><span class="lineno"> 350</span>&#160; </div>
154<div class="line"><a name="l00359"></a><span class="lineno"> 359</span>&#160; uint32_t <a class="code" href="class_e_s_p8266.html#af8ce40bd14556bcfb5d4c521047fc821">recv</a>(uint8_t *buffer, uint32_t buffer_size, uint32_t timeout = 1000);</div>
155<div class="line"><a name="l00360"></a><span class="lineno"> 360</span>&#160; </div>
156<div class="line"><a name="l00370"></a><span class="lineno"> 370</span>&#160; uint32_t <a class="code" href="class_e_s_p8266.html#af8ce40bd14556bcfb5d4c521047fc821">recv</a>(uint8_t mux_id, uint8_t *buffer, uint32_t buffer_size, uint32_t timeout = 1000);</div>
157<div class="line"><a name="l00371"></a><span class="lineno"> 371</span>&#160; </div>
158<div class="line"><a name="l00384"></a><span class="lineno"> 384</span>&#160; uint32_t <a class="code" href="class_e_s_p8266.html#af8ce40bd14556bcfb5d4c521047fc821">recv</a>(uint8_t *coming_mux_id, uint8_t *buffer, uint32_t buffer_size, uint32_t timeout = 1000);</div>
159<div class="line"><a name="l00385"></a><span class="lineno"> 385</span>&#160;</div>
160<div class="line"><a name="l00386"></a><span class="lineno"> 386</span>&#160; <span class="keyword">private</span>:</div>
161<div class="line"><a name="l00387"></a><span class="lineno"> 387</span>&#160;</div>
162<div class="line"><a name="l00388"></a><span class="lineno"> 388</span>&#160; <span class="comment">/* </span></div>
163<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>&#160;<span class="comment"> * Empty the buffer or UART RX.</span></div>
164<div class="line"><a name="l00390"></a><span class="lineno"> 390</span>&#160;<span class="comment"> */</span></div>
165<div class="line"><a name="l00391"></a><span class="lineno"> 391</span>&#160; <span class="keywordtype">void</span> rx_empty(<span class="keywordtype">void</span>);</div>
166<div class="line"><a name="l00392"></a><span class="lineno"> 392</span>&#160; </div>
167<div class="line"><a name="l00393"></a><span class="lineno"> 393</span>&#160; <span class="comment">/* </span></div>
168<div class="line"><a name="l00394"></a><span class="lineno"> 394</span>&#160;<span class="comment"> * Recvive data from uart. Return all received data if target found or timeout. </span></div>
169<div class="line"><a name="l00395"></a><span class="lineno"> 395</span>&#160;<span class="comment"> */</span></div>
170<div class="line"><a name="l00396"></a><span class="lineno"> 396</span>&#160; String recvString(String target, uint32_t timeout = 1000);</div>
171<div class="line"><a name="l00397"></a><span class="lineno"> 397</span>&#160; </div>
172<div class="line"><a name="l00398"></a><span class="lineno"> 398</span>&#160; <span class="comment">/* </span></div>
173<div class="line"><a name="l00399"></a><span class="lineno"> 399</span>&#160;<span class="comment"> * Recvive data from uart. Return all received data if one of target1 and target2 found or timeout. </span></div>
174<div class="line"><a name="l00400"></a><span class="lineno"> 400</span>&#160;<span class="comment"> */</span></div>
175<div class="line"><a name="l00401"></a><span class="lineno"> 401</span>&#160; String recvString(String target1, String target2, uint32_t timeout = 1000);</div>
176<div class="line"><a name="l00402"></a><span class="lineno"> 402</span>&#160; </div>
177<div class="line"><a name="l00403"></a><span class="lineno"> 403</span>&#160; <span class="comment">/* </span></div>
178<div class="line"><a name="l00404"></a><span class="lineno"> 404</span>&#160;<span class="comment"> * Recvive data from uart. Return all received data if one of target1, target2 and target3 found or timeout. </span></div>
179<div class="line"><a name="l00405"></a><span class="lineno"> 405</span>&#160;<span class="comment"> */</span></div>
180<div class="line"><a name="l00406"></a><span class="lineno"> 406</span>&#160; String recvString(String target1, String target2, String target3, uint32_t timeout = 1000);</div>
181<div class="line"><a name="l00407"></a><span class="lineno"> 407</span>&#160; </div>
182<div class="line"><a name="l00408"></a><span class="lineno"> 408</span>&#160; <span class="comment">/* </span></div>
183<div class="line"><a name="l00409"></a><span class="lineno"> 409</span>&#160;<span class="comment"> * Recvive data from uart and search first target. Return true if target found, false for timeout.</span></div>
184<div class="line"><a name="l00410"></a><span class="lineno"> 410</span>&#160;<span class="comment"> */</span></div>
185<div class="line"><a name="l00411"></a><span class="lineno"> 411</span>&#160; <span class="keywordtype">bool</span> recvFind(String target, uint32_t timeout = 1000);</div>
186<div class="line"><a name="l00412"></a><span class="lineno"> 412</span>&#160; </div>
187<div class="line"><a name="l00413"></a><span class="lineno"> 413</span>&#160; <span class="comment">/* </span></div>
188<div class="line"><a name="l00414"></a><span class="lineno"> 414</span>&#160;<span class="comment"> * Recvive data from uart and search first target and cut out the substring between begin and end(excluding begin and end self). </span></div>
189<div class="line"><a name="l00415"></a><span class="lineno"> 415</span>&#160;<span class="comment"> * Return true if target found, false for timeout.</span></div>
190<div class="line"><a name="l00416"></a><span class="lineno"> 416</span>&#160;<span class="comment"> */</span></div>
191<div class="line"><a name="l00417"></a><span class="lineno"> 417</span>&#160; <span class="keywordtype">bool</span> recvFindAndFilter(String target, String begin, String end, String &amp;data, uint32_t timeout = 1000);</div>
192<div class="line"><a name="l00418"></a><span class="lineno"> 418</span>&#160; </div>
193<div class="line"><a name="l00419"></a><span class="lineno"> 419</span>&#160; <span class="comment">/*</span></div>
194<div class="line"><a name="l00420"></a><span class="lineno"> 420</span>&#160;<span class="comment"> * Receive a package from uart. </span></div>
195<div class="line"><a name="l00421"></a><span class="lineno"> 421</span>&#160;<span class="comment"> *</span></div>
196<div class="line"><a name="l00422"></a><span class="lineno"> 422</span>&#160;<span class="comment"> * @param buffer - the buffer storing data. </span></div>
197<div class="line"><a name="l00423"></a><span class="lineno"> 423</span>&#160;<span class="comment"> * @param buffer_size - guess what!</span></div>
198<div class="line"><a name="l00424"></a><span class="lineno"> 424</span>&#160;<span class="comment"> * @param data_len - the length of data actually received(maybe more than buffer_size, the remained data will be abandoned).</span></div>
199<div class="line"><a name="l00425"></a><span class="lineno"> 425</span>&#160;<span class="comment"> * @param timeout - the duration waitting data comming.</span></div>
200<div class="line"><a name="l00426"></a><span class="lineno"> 426</span>&#160;<span class="comment"> * @param coming_mux_id - in single connection mode, should be NULL and not NULL in multiple. </span></div>
201<div class="line"><a name="l00427"></a><span class="lineno"> 427</span>&#160;<span class="comment"> */</span></div>
202<div class="line"><a name="l00428"></a><span class="lineno"> 428</span>&#160; uint32_t recvPkg(uint8_t *buffer, uint32_t buffer_size, uint32_t *data_len, uint32_t timeout, uint8_t *coming_mux_id);</div>
203<div class="line"><a name="l00429"></a><span class="lineno"> 429</span>&#160; </div>
204<div class="line"><a name="l00430"></a><span class="lineno"> 430</span>&#160; </div>
205<div class="line"><a name="l00431"></a><span class="lineno"> 431</span>&#160; <span class="keywordtype">bool</span> eAT(<span class="keywordtype">void</span>);</div>
206<div class="line"><a name="l00432"></a><span class="lineno"> 432</span>&#160; <span class="keywordtype">bool</span> eATRST(<span class="keywordtype">void</span>);</div>
207<div class="line"><a name="l00433"></a><span class="lineno"> 433</span>&#160; <span class="keywordtype">bool</span> eATGMR(String &amp;version);</div>
208<div class="line"><a name="l00434"></a><span class="lineno"> 434</span>&#160; </div>
209<div class="line"><a name="l00435"></a><span class="lineno"> 435</span>&#160; <span class="keywordtype">bool</span> qATCWMODE(uint8_t *mode);</div>
210<div class="line"><a name="l00436"></a><span class="lineno"> 436</span>&#160; <span class="keywordtype">bool</span> sATCWMODE(uint8_t mode);</div>
211<div class="line"><a name="l00437"></a><span class="lineno"> 437</span>&#160; <span class="keywordtype">bool</span> sATCWJAP(String ssid, String pwd);</div>
212<div class="line"><a name="l00438"></a><span class="lineno"> 438</span>&#160; <span class="keywordtype">bool</span> eATCWLAP(String &amp;list);</div>
213<div class="line"><a name="l00439"></a><span class="lineno"> 439</span>&#160; <span class="keywordtype">bool</span> eATCWQAP(<span class="keywordtype">void</span>);</div>
214<div class="line"><a name="l00440"></a><span class="lineno"> 440</span>&#160; <span class="keywordtype">bool</span> sATCWSAP(String ssid, String pwd, uint8_t chl, uint8_t ecn);</div>
215<div class="line"><a name="l00441"></a><span class="lineno"> 441</span>&#160; <span class="keywordtype">bool</span> eATCWLIF(String &amp;list);</div>
216<div class="line"><a name="l00442"></a><span class="lineno"> 442</span>&#160; </div>
217<div class="line"><a name="l00443"></a><span class="lineno"> 443</span>&#160; <span class="keywordtype">bool</span> eATCIPSTATUS(String &amp;list);</div>
218<div class="line"><a name="l00444"></a><span class="lineno"> 444</span>&#160; <span class="keywordtype">bool</span> sATCIPSTARTSingle(String type, String addr, uint32_t port);</div>
219<div class="line"><a name="l00445"></a><span class="lineno"> 445</span>&#160; <span class="keywordtype">bool</span> sATCIPSTARTMultiple(uint8_t mux_id, String type, String addr, uint32_t port);</div>
220<div class="line"><a name="l00446"></a><span class="lineno"> 446</span>&#160; <span class="keywordtype">bool</span> sATCIPSENDSingle(<span class="keyword">const</span> uint8_t *buffer, uint32_t len);</div>
221<div class="line"><a name="l00447"></a><span class="lineno"> 447</span>&#160; <span class="keywordtype">bool</span> sATCIPSENDMultiple(uint8_t mux_id, <span class="keyword">const</span> uint8_t *buffer, uint32_t len);</div>
222<div class="line"><a name="l00448"></a><span class="lineno"> 448</span>&#160; <span class="keywordtype">bool</span> sATCIPCLOSEMulitple(uint8_t mux_id);</div>
223<div class="line"><a name="l00449"></a><span class="lineno"> 449</span>&#160; <span class="keywordtype">bool</span> eATCIPCLOSESingle(<span class="keywordtype">void</span>);</div>
224<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>&#160; <span class="keywordtype">bool</span> eATCIFSR(String &amp;list);</div>
225<div class="line"><a name="l00451"></a><span class="lineno"> 451</span>&#160; <span class="keywordtype">bool</span> sATCIPMUX(uint8_t mode);</div>
226<div class="line"><a name="l00452"></a><span class="lineno"> 452</span>&#160; <span class="keywordtype">bool</span> sATCIPSERVER(uint8_t mode, uint32_t port = 333);</div>
227<div class="line"><a name="l00453"></a><span class="lineno"> 453</span>&#160; <span class="keywordtype">bool</span> sATCIPSTO(uint32_t timeout);</div>
228<div class="line"><a name="l00454"></a><span class="lineno"> 454</span>&#160; </div>
229<div class="line"><a name="l00455"></a><span class="lineno"> 455</span>&#160; <span class="comment">/*</span></div>
230<div class="line"><a name="l00456"></a><span class="lineno"> 456</span>&#160;<span class="comment"> * +IPD,len:data</span></div>
231<div class="line"><a name="l00457"></a><span class="lineno"> 457</span>&#160;<span class="comment"> * +IPD,id,len:data</span></div>
232<div class="line"><a name="l00458"></a><span class="lineno"> 458</span>&#160;<span class="comment"> */</span></div>
233<div class="line"><a name="l00459"></a><span class="lineno"> 459</span>&#160; </div>
234<div class="line"><a name="l00460"></a><span class="lineno"> 460</span>&#160;<span class="preprocessor">#ifdef ESP8266_USE_SOFTWARE_SERIAL</span></div>
235<div class="line"><a name="l00461"></a><span class="lineno"> 461</span>&#160; SoftwareSerial *m_puart; <span class="comment">/* The UART to communicate with ESP8266 */</span></div>
236<div class="line"><a name="l00462"></a><span class="lineno"> 462</span>&#160;<span class="preprocessor">#else</span></div>
237<div class="line"><a name="l00463"></a><span class="lineno"> 463</span>&#160; HardwareSerial *m_puart; <span class="comment">/* The UART to communicate with ESP8266 */</span></div>
238<div class="line"><a name="l00464"></a><span class="lineno"> 464</span>&#160;<span class="preprocessor">#endif</span></div>
239<div class="line"><a name="l00465"></a><span class="lineno"> 465</span>&#160;};</div>
240<div class="line"><a name="l00466"></a><span class="lineno"> 466</span>&#160;</div>
241<div class="line"><a name="l00467"></a><span class="lineno"> 467</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* #ifndef __ESP8266_H__ */</span><span class="preprocessor"></span></div>
242<div class="line"><a name="l00468"></a><span class="lineno"> 468</span>&#160;</div>
243<div class="ttc" id="class_e_s_p8266_html_a6ba21b921a7afc79a36d0e41c20d59bc"><div class="ttname"><a href="class_e_s_p8266.html#a6ba21b921a7afc79a36d0e41c20d59bc">ESP8266::send</a></div><div class="ttdeci">bool send(const uint8_t *buffer, uint32_t len)</div><div class="ttdoc">Send data based on TCP or UDP builded already in single mode. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00261">ESP8266.cpp:261</a></div></div>
244<div class="ttc" id="class_e_s_p8266_html_a4e2d8a0637b437d4b03209cebfa5b750"><div class="ttname"><a href="class_e_s_p8266.html#a4e2d8a0637b437d4b03209cebfa5b750">ESP8266::getVersion</a></div><div class="ttdeci">String getVersion(void)</div><div class="ttdoc">Get the version of AT Command Set. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00080">ESP8266.cpp:80</a></div></div>
245<div class="ttc" id="class_e_s_p8266_html_ac15ce9df69dc566c37b3fa2c3c869337"><div class="ttname"><a href="class_e_s_p8266.html#ac15ce9df69dc566c37b3fa2c3c869337">ESP8266::releaseTCP</a></div><div class="ttdeci">bool releaseTCP(void)</div><div class="ttdoc">Release TCP connection in single mode. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00196">ESP8266.cpp:196</a></div></div>
246<div class="ttc" id="class_e_s_p8266_html_af8ce40bd14556bcfb5d4c521047fc821"><div class="ttname"><a href="class_e_s_p8266.html#af8ce40bd14556bcfb5d4c521047fc821">ESP8266::recv</a></div><div class="ttdeci">uint32_t recv(uint8_t *buffer, uint32_t buffer_size, uint32_t timeout=1000)</div><div class="ttdoc">Receive data from TCP or UDP builded already in single mode. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00271">ESP8266.cpp:271</a></div></div>
247<div class="ttc" id="class_e_s_p8266_html_a16963a076b80906563d2269c0cd52007"><div class="ttname"><a href="class_e_s_p8266.html#a16963a076b80906563d2269c0cd52007">ESP8266::enableMUX</a></div><div class="ttdeci">bool enableMUX(void)</div><div class="ttdoc">Enable IP MUX(multiple connection mode). </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00181">ESP8266.cpp:181</a></div></div>
248<div class="ttc" id="class_e_s_p8266_html_a20819d4dabf19fed6e3dcb3fd04ee49d"><div class="ttname"><a href="class_e_s_p8266.html#a20819d4dabf19fed6e3dcb3fd04ee49d">ESP8266::getLocalIP</a></div><div class="ttdeci">String getLocalIP(void)</div><div class="ttdoc">Get the IP address of ESP8266. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00174">ESP8266.cpp:174</a></div></div>
249<div class="ttc" id="class_e_s_p8266_html_a247706884d60e85c8983bb65de26d346"><div class="ttname"><a href="class_e_s_p8266.html#a247706884d60e85c8983bb65de26d346">ESP8266::setOprToSoftAP</a></div><div class="ttdeci">bool setOprToSoftAP(void)</div><div class="ttdoc">Set operation mode to softap. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00104">ESP8266.cpp:104</a></div></div>
250<div class="ttc" id="class_e_s_p8266_html_ac179183a46b218609a481747bcfd5a61"><div class="ttname"><a href="class_e_s_p8266.html#ac179183a46b218609a481747bcfd5a61">ESP8266::setOprToStationSoftAP</a></div><div class="ttdeci">bool setOprToStationSoftAP(void)</div><div class="ttdoc">Set operation mode to station + softap. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00121">ESP8266.cpp:121</a></div></div>
251<div class="ttc" id="class_e_s_p8266_html_aa927b7b8aaef163011015c22da1f07e2"><div class="ttname"><a href="class_e_s_p8266.html#aa927b7b8aaef163011015c22da1f07e2">ESP8266::createTCP</a></div><div class="ttdeci">bool createTCP(String addr, uint32_t port)</div><div class="ttdoc">Create TCP connection in single mode. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00191">ESP8266.cpp:191</a></div></div>
252<div class="ttc" id="class_e_s_p8266_html_aa355332a78aa5f2b58cb11b0daa05cf5"><div class="ttname"><a href="class_e_s_p8266.html#aa355332a78aa5f2b58cb11b0daa05cf5">ESP8266::unregisterUDP</a></div><div class="ttdeci">bool unregisterUDP(void)</div><div class="ttdoc">Unregister UDP port number in single mode. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00206">ESP8266.cpp:206</a></div></div>
253<div class="ttc" id="class_e_s_p8266_html_a88d9a6b130b6c278fd6cd2e6cda816d7"><div class="ttname"><a href="class_e_s_p8266.html#a88d9a6b130b6c278fd6cd2e6cda816d7">ESP8266::startServer</a></div><div class="ttdeci">bool startServer(uint32_t port=333)</div><div class="ttdoc">Start Server(Only in multiple mode). </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00251">ESP8266.cpp:251</a></div></div>
254<div class="ttc" id="class_e_s_p8266_html_aa5355dce05aa59b92ce9f7ea76d86eef"><div class="ttname"><a href="class_e_s_p8266.html#aa5355dce05aa59b92ce9f7ea76d86eef">ESP8266::stopTCPServer</a></div><div class="ttdeci">bool stopTCPServer(void)</div><div class="ttdoc">Stop TCP Server(Only in multiple mode). </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00244">ESP8266.cpp:244</a></div></div>
255<div class="ttc" id="class_e_s_p8266_html_af272f2f57b7b99434e257f06c276acfc"><div class="ttname"><a href="class_e_s_p8266.html#af272f2f57b7b99434e257f06c276acfc">ESP8266::stopServer</a></div><div class="ttdeci">bool stopServer(void)</div><div class="ttdoc">Stop Server(Only in multiple mode). </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00256">ESP8266.cpp:256</a></div></div>
256<div class="ttc" id="class_e_s_p8266_html_a2bc64145329ea45018e956b97ced030a"><div class="ttname"><a href="class_e_s_p8266.html#a2bc64145329ea45018e956b97ced030a">ESP8266::disableMUX</a></div><div class="ttdeci">bool disableMUX(void)</div><div class="ttdoc">Disable IP MUX(single connection mode). </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00186">ESP8266.cpp:186</a></div></div>
257<div class="ttc" id="class_e_s_p8266_html_a04b61a01af4ee5e8820c9de79b4b3c39"><div class="ttname"><a href="class_e_s_p8266.html#a04b61a01af4ee5e8820c9de79b4b3c39">ESP8266::restart</a></div><div class="ttdeci">bool restart(void)</div><div class="ttdoc">Restart ESP8266 by "AT+RST". </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00063">ESP8266.cpp:63</a></div></div>
258<div class="ttc" id="class_e_s_p8266_html_a5ed71947606435c3b03b73efdaf810a5"><div class="ttname"><a href="class_e_s_p8266.html#a5ed71947606435c3b03b73efdaf810a5">ESP8266::kick</a></div><div class="ttdeci">bool kick(void)</div><div class="ttdoc">Verify ESP8266 whether live or not. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00058">ESP8266.cpp:58</a></div></div>
259<div class="ttc" id="class_e_s_p8266_html_a300535b4b5f001b74058ebcc694a749f"><div class="ttname"><a href="class_e_s_p8266.html#a300535b4b5f001b74058ebcc694a749f">ESP8266::joinAP</a></div><div class="ttdeci">bool joinAP(String ssid, String pwd)</div><div class="ttdoc">Join in AP. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00145">ESP8266.cpp:145</a></div></div>
260<div class="ttc" id="class_e_s_p8266_html_af8d3305a28d862c0cf353d0d758b96d4"><div class="ttname"><a href="class_e_s_p8266.html#af8d3305a28d862c0cf353d0d758b96d4">ESP8266::registerUDP</a></div><div class="ttdeci">bool registerUDP(String addr, uint32_t port)</div><div class="ttdoc">Register UDP port number in single mode. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00201">ESP8266.cpp:201</a></div></div>
261<div class="ttc" id="class_e_s_p8266_html_aeda29748e0d28efa9d82c9c7fab1859b"><div class="ttname"><a href="class_e_s_p8266.html#aeda29748e0d28efa9d82c9c7fab1859b">ESP8266::leaveAP</a></div><div class="ttdeci">bool leaveAP(void)</div><div class="ttdoc">Leave AP joined before. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00150">ESP8266.cpp:150</a></div></div>
262<div class="ttc" id="class_e_s_p8266_html_a71f76c76d23fc66c26f1c7b357f58ac2"><div class="ttname"><a href="class_e_s_p8266.html#a71f76c76d23fc66c26f1c7b357f58ac2">ESP8266::setTCPServerTimeout</a></div><div class="ttdeci">bool setTCPServerTimeout(uint32_t timeout=180)</div><div class="ttdoc">Set the timeout of TCP Server. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00231">ESP8266.cpp:231</a></div></div>
263<div class="ttc" id="class_e_s_p8266_html"><div class="ttname"><a href="class_e_s_p8266.html">ESP8266</a></div><div class="ttdoc">Provide an easy-to-use way to manipulate ESP8266. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8h_source.html#l00038">ESP8266.h:38</a></div></div>
264<div class="ttc" id="class_e_s_p8266_html_a22a7768a76709c8d8f0b9809158b7ec9"><div class="ttname"><a href="class_e_s_p8266.html#a22a7768a76709c8d8f0b9809158b7ec9">ESP8266::startTCPServer</a></div><div class="ttdeci">bool startTCPServer(uint32_t port=333)</div><div class="ttdoc">Start TCP Server(Only in multiple mode). </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00236">ESP8266.cpp:236</a></div></div>
265<div class="ttc" id="class_e_s_p8266_html_aacce786dc0ef289cd37a48642d2efef1"><div class="ttname"><a href="class_e_s_p8266.html#aacce786dc0ef289cd37a48642d2efef1">ESP8266::setSoftAPParam</a></div><div class="ttdeci">bool setSoftAPParam(String ssid, String pwd, uint8_t chl=7, uint8_t ecn=4)</div><div class="ttdoc">Set SoftAP parameters. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00155">ESP8266.cpp:155</a></div></div>
266<div class="ttc" id="class_e_s_p8266_html_a572c6f855d70078fdbff9ac2c4b1ce99"><div class="ttname"><a href="class_e_s_p8266.html#a572c6f855d70078fdbff9ac2c4b1ce99">ESP8266::setOprToStation</a></div><div class="ttdeci">bool setOprToStation(void)</div><div class="ttdoc">Set operation mode to staion. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00087">ESP8266.cpp:87</a></div></div>
267<div class="ttc" id="class_e_s_p8266_html_af0cafe8a994349e81e75a35af9645a76"><div class="ttname"><a href="class_e_s_p8266.html#af0cafe8a994349e81e75a35af9645a76">ESP8266::getAPList</a></div><div class="ttdeci">String getAPList(void)</div><div class="ttdoc">Search available AP list and return it. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00138">ESP8266.cpp:138</a></div></div>
268<div class="ttc" id="class_e_s_p8266_html_ad273286fbb8627a612249a232d53ca22"><div class="ttname"><a href="class_e_s_p8266.html#ad273286fbb8627a612249a232d53ca22">ESP8266::getIPStatus</a></div><div class="ttdeci">String getIPStatus(void)</div><div class="ttdoc">Get the current status of connection(UDP and TCP). </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00167">ESP8266.cpp:167</a></div></div>
269<div class="ttc" id="class_e_s_p8266_html_a10c82a5196a8f349720a9c9ba7209a6e"><div class="ttname"><a href="class_e_s_p8266.html#a10c82a5196a8f349720a9c9ba7209a6e">ESP8266::getJoinedDeviceIP</a></div><div class="ttdeci">String getJoinedDeviceIP(void)</div><div class="ttdoc">Get the IP list of devices connected to SoftAP. </div><div class="ttdef"><b>Definition:</b> <a href="_e_s_p8266_8cpp_source.html#l00160">ESP8266.cpp:160</a></div></div>
270</div><!-- fragment --></div><!-- contents -->
271<!-- start footer part -->
272<hr class="footer"/><address class="footer"><small>
273Generated on Tue Mar 17 2015 10:34:17 for API by &#160;<a href="http://www.doxygen.org/index.html">
274<img class="footer" src="doxygen.png" alt="doxygen"/>
275</a> 1.8.7
276</small></address>
277</body>
278</html>
Note: See TracBrowser for help on using the repository browser.