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: README.md 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 Page</span></a></li>
|
---|
34 | <li><a href="pages.html"><span>Related 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 List</span></a></li>
|
---|
43 | </ul>
|
---|
44 | </div>
|
---|
45 | </div><!-- top -->
|
---|
46 | <div class="header">
|
---|
47 | <div class="headertitle">
|
---|
48 | <div class="title">README.md</div> </div>
|
---|
49 | </div><!--header-->
|
---|
50 | <div class="contents">
|
---|
51 | <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> @mainpage</div>
|
---|
52 | <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div>
|
---|
53 | <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor"># WeeESP8266</span></div>
|
---|
54 | <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div>
|
---|
55 | <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> An <a class="code" href="class_e_s_p8266.html">ESP8266</a> library <span class="keywordflow">for</span> Arduino providing an easy-to-use way to manipulate <a class="code" href="class_e_s_p8266.html">ESP8266</a>.</div>
|
---|
56 | <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div>
|
---|
57 | <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> # Source </div>
|
---|
58 | <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
|
---|
59 | <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> Source can be download at <https:<span class="comment">//github.com/itead/ITEADLIB_Arduino_WeeESP8266>.</span></div>
|
---|
60 | <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div>
|
---|
61 | <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> You can clone it by:</div>
|
---|
62 | <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div>
|
---|
63 | <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  git clone https:<span class="comment">//github.com/itead/ITEADLIB_Arduino_WeeESP8266.git</span></div>
|
---|
64 | <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div>
|
---|
65 | <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor"># Documentation</span></div>
|
---|
66 | <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
|
---|
67 | <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> Online API documentation can be reached at <http:<span class="comment">//docs.iteadstudio.com/ITEADLIB_Arduino_WeeESP8266/index.html>.</span></div>
|
---|
68 | <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
|
---|
69 | <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> Offline API documentation can be found under directory </div>
|
---|
70 | <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> [doc](https:<span class="comment">//github.com/itead/ITEADLIB_Arduino_WeeESP8266/tree/master/doc).</span></div>
|
---|
71 | <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
|
---|
72 | <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"># How to get started</span></div>
|
---|
73 | <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
|
---|
74 | <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> On the home page of API documentation, the tabs of Examples, Classes and Modules </div>
|
---|
75 | <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> will be useful <span class="keywordflow">for</span> Arduino lovers. </div>
|
---|
76 | <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
|
---|
77 | <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"># API List</span></div>
|
---|
78 | <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
|
---|
79 | <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordtype">bool</span> kick (<span class="keywordtype">void</span>) : Verify <a class="code" href="class_e_s_p8266.html">ESP8266</a> whether live or not.</div>
|
---|
80 | <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
---|
81 | <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  bool restart (void) : Restart <a class="code" href="class_e_s_p8266.html">ESP8266</a> by <span class="stringliteral">"AT+RST"</span>.</div>
|
---|
82 | <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
---|
83 | <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  String getVersion (void) : Get the version of AT Command Set.</div>
|
---|
84 | <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
---|
85 | <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  bool setOprToStation (void) : Set operation mode to staion.</div>
|
---|
86 | <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
|
---|
87 | <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  bool setOprToSoftAP (void) : Set operation mode to softap.</div>
|
---|
88 | <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
---|
89 | <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  bool setOprToStationSoftAP (void) : Set operation mode to station + softap.</div>
|
---|
90 | <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
|
---|
91 | <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  String getAPList (void) : Search available AP list and return it.</div>
|
---|
92 | <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
---|
93 | <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  bool joinAP (String ssid, String pwd) : Join in AP. </div>
|
---|
94 | <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
---|
95 | <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  bool leaveAP (void) : Leave AP joined before. </div>
|
---|
96 | <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
---|
97 | <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  bool setSoftAPParam (String ssid, String pwd, uint8_t chl=7, uint8_t ecn=4) : Set SoftAP parameters. </div>
|
---|
98 | <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
|
---|
99 | <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  String getJoinedDeviceIP (void) : Get the IP list of devices connected to SoftAP. </div>
|
---|
100 | <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
---|
101 | <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  String getIPStatus (void) : Get the current status of connection(UDP and TCP). </div>
|
---|
102 | <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
|
---|
103 | <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  String getLocalIP (void) : Get the IP address of <a class="code" href="class_e_s_p8266.html">ESP8266</a>. </div>
|
---|
104 | <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
---|
105 | <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  bool enableMUX (void) : Enable IP MUX(multiple connection mode). </div>
|
---|
106 | <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
---|
107 | <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  bool disableMUX (void) : Disable IP MUX(single connection mode). </div>
|
---|
108 | <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
|
---|
109 | <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  bool createTCP (String addr, uint32_t port) : Create TCP connection in single mode. </div>
|
---|
110 | <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
---|
111 | <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  bool releaseTCP (void) : Release TCP connection in single mode. </div>
|
---|
112 | <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
|
---|
113 | <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  bool registerUDP (String addr, uint32_t port) : Register UDP port number in single mode. </div>
|
---|
114 | <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
|
---|
115 | <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  bool unregisterUDP (void) : Unregister UDP port number in single mode. </div>
|
---|
116 | <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
|
---|
117 | <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  bool createTCP (uint8_t mux_id, String addr, uint32_t port) : Create TCP connection in multiple mode. </div>
|
---|
118 | <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
---|
119 | <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  bool releaseTCP (uint8_t mux_id) : Release TCP connection in multiple mode. </div>
|
---|
120 | <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
|
---|
121 | <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  bool registerUDP (uint8_t mux_id, String addr, uint32_t port) : Register UDP port number in multiple mode. </div>
|
---|
122 | <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
|
---|
123 | <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  bool unregisterUDP (uint8_t mux_id) : Unregister UDP port number in multiple mode. </div>
|
---|
124 | <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
|
---|
125 | <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  bool setTCPServerTimeout (uint32_t timeout=180) : Set the timeout of TCP Server. </div>
|
---|
126 | <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
|
---|
127 | <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  bool startServer (uint32_t port=333) ï¼ Start Server(Only in multiple mode).</div>
|
---|
128 | <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div>
|
---|
129 | <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  bool stopServer (void) : Stop Server(Only in multiple mode).</div>
|
---|
130 | <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div>
|
---|
131 | <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  bool startTCPServer (uint32_t port=333) : Start TCP Server(Only in multiple mode). </div>
|
---|
132 | <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div>
|
---|
133 | <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  bool stopTCPServer (void) : Stop TCP Server(Only in multiple mode). </div>
|
---|
134 | <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
|
---|
135 | <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  bool send (const uint8_t *buffer, uint32_t len) : Send data based on TCP or UDP builded already in single mode. </div>
|
---|
136 | <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div>
|
---|
137 | <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  bool send (uint8_t mux_id, const uint8_t *buffer, uint32_t len) : Send data based on one of TCP or UDP builded already in multiple mode. </div>
|
---|
138 | <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div>
|
---|
139 | <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  uint32_t recv (uint8_t *buffer, uint32_t buffer_size, uint32_t timeout=1000) : Receive data from TCP or UDP builded already in single mode. </div>
|
---|
140 | <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div>
|
---|
141 | <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  uint32_t recv (uint8_t mux_id, uint8_t *buffer, uint32_t buffer_size, uint32_t timeout=1000) : Receive data from one of TCP or UDP builded already in multiple mode. </div>
|
---|
142 | <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div>
|
---|
143 | <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  uint32_t recv (uint8_t *coming_mux_id, uint8_t *buffer, uint32_t buffer_size, uint32_t timeout=1000) : Receive data from all of TCP or UDP builded already in multiple mode. </div>
|
---|
144 | <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
|
---|
145 | <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div>
|
---|
146 | <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> # Mainboard Requires</div>
|
---|
147 | <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
|
---|
148 | <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  - RAM: not less than 2KBytes</div>
|
---|
149 | <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  - Serial: one serial (HardwareSerial or SoftwareSerial) at least </div>
|
---|
150 | <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
|
---|
151 | <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> # Suppported Mainboards</div>
|
---|
152 | <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div>
|
---|
153 | <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  - Arduino UNO and its derivatives</div>
|
---|
154 | <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  - Arduino MEGA and its derivatives</div>
|
---|
155 | <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  - [Iteaduino UNO](http:<span class="comment">//imall.iteadstudio.com/im130312001.html)</span></div>
|
---|
156 | <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  - [WBoard Pro](http:<span class="comment">//imall.iteadstudio.com/im141125005.html)</span></div>
|
---|
157 | <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div>
|
---|
158 | <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> # Using SoftwareSerial</div>
|
---|
159 | <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div>
|
---|
160 | <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> If you want to use SoftwareSerial to communicate with <a class="code" href="class_e_s_p8266.html">ESP8266</a>, you need to modify</div>
|
---|
161 | <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> the line in file `<a class="code" href="class_e_s_p8266.html">ESP8266</a>.h`: </div>
|
---|
162 | <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div>
|
---|
163 | <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="comment">//#define ESP8266_USE_SOFTWARE_SERIAL</span></div>
|
---|
164 | <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div>
|
---|
165 | <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> After modification, it should be:</div>
|
---|
166 | <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div>
|
---|
167 | <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  #define ESP8266_USE_SOFTWARE_SERIAL</div>
|
---|
168 | <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div>
|
---|
169 | <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div>
|
---|
170 | <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> # Hardware Connection</div>
|
---|
171 | <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div>
|
---|
172 | <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> WeeESP8266 library only needs an uart for hardware connection. All communications </div>
|
---|
173 | <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> are done via uart. In each example, you must specify the uart used by mainboard </div>
|
---|
174 | <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> to communicate with <a class="code" href="class_e_s_p8266.html">ESP8266</a> flashed AT firmware.</div>
|
---|
175 | <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div>
|
---|
176 | <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> ## MEGA and WBoard Pro</div>
|
---|
177 | <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div>
|
---|
178 | <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> For MEGA and WBoard Pro, `Serial1` will be used if you create an object (named wifi) </div>
|
---|
179 | <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> of class <a class="code" href="class_e_s_p8266.html">ESP8266</a> in your code like this:</div>
|
---|
180 | <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div>
|
---|
181 | <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  #include <span class="stringliteral">"ESP8266.h"</span></div>
|
---|
182 | <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <a class="code" href="class_e_s_p8266.html">ESP8266</a> wifi(Serial1);</div>
|
---|
183 | <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div>
|
---|
184 | <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> The connection should be like these:</div>
|
---|
185 | <div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div>
|
---|
186 | <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  ESP8266_TX->RX1(D19)</div>
|
---|
187 | <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  ESP8266_RX->TX1(D18)</div>
|
---|
188 | <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  ESP8266_CH_PD->3.3V</div>
|
---|
189 | <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  ESP8266_VCC->3.3V</div>
|
---|
190 | <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  ESP8266_GND->GND</div>
|
---|
191 | <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div>
|
---|
192 | <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="preprocessor">## UNO</span></div>
|
---|
193 | <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div>
|
---|
194 | <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> To use SoftwareSerial, `mySerial` will be used <span class="keywordflow">if</span> you create an object (named wifi)</div>
|
---|
195 | <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> of <span class="keyword">class </span><a class="code" href="class_e_s_p8266.html">ESP8266</a> in your code like this:</div>
|
---|
196 | <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div>
|
---|
197 | <div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="preprocessor"> #include "ESP8266.h"</span></div>
|
---|
198 | <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="preprocessor"> #include <SoftwareSerial.h></span></div>
|
---|
199 | <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  </div>
|
---|
200 | <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  SoftwareSerial mySerial(3, 2); <span class="comment">/* RX:D3, TX:D2 */</span></div>
|
---|
201 | <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <a class="code" href="class_e_s_p8266.html">ESP8266</a> wifi(mySerial);</div>
|
---|
202 | <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div>
|
---|
203 | <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> The connection should be like these:</div>
|
---|
204 | <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div>
|
---|
205 | <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  ESP8266_TX->RX(D3)</div>
|
---|
206 | <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  ESP8266_RX->TX(D2)</div>
|
---|
207 | <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  ESP8266_CH_PD->3.3V</div>
|
---|
208 | <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  ESP8266_VCC->3.3V</div>
|
---|
209 | <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  ESP8266_GND->GND</div>
|
---|
210 | <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  </div>
|
---|
211 | <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="preprocessor"># Attention</span></div>
|
---|
212 | <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div>
|
---|
213 | <div class="line"><a name="l00163"></a><span class="lineno"> 163</span> The size of data from <a class="code" href="class_e_s_p8266.html">ESP8266</a> is too big for arduino sometimes, so the library can't</div>
|
---|
214 | <div class="line"><a name="l00164"></a><span class="lineno"> 164</span> receive the whole buffer because the size of the hardware serial buffer which is </div>
|
---|
215 | <div class="line"><a name="l00165"></a><span class="lineno"> 165</span> defined in HardwareSerial.h is too small.</div>
|
---|
216 | <div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div>
|
---|
217 | <div class="line"><a name="l00167"></a><span class="lineno"> 167</span> Open the file from `\arduino\hardware\arduino\avr\cores\arduino\HardwareSerial.h`. </div>
|
---|
218 | <div class="line"><a name="l00168"></a><span class="lineno"> 168</span> See the follow line in the HardwareSerial.h file.</div>
|
---|
219 | <div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div>
|
---|
220 | <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="preprocessor"> #define SERIAL_BUFFER_SIZE 64</span></div>
|
---|
221 | <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div>
|
---|
222 | <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> The default size of the buffer is 64. Change it into a bigger number, like 256 or more.</div>
|
---|
223 | <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div>
|
---|
224 | <div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div>
|
---|
225 | <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> -------------------------------------------------------------------------------</div>
|
---|
226 | <div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div>
|
---|
227 | <div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="preprocessor"># The End!</span></div>
|
---|
228 | <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div>
|
---|
229 | <div class="line"><a name="l00179"></a><span class="lineno"> 179</span> -------------------------------------------------------------------------------</div>
|
---|
230 | <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>
|
---|
231 | </div><!-- fragment --></div><!-- contents -->
|
---|
232 | <!-- start footer part -->
|
---|
233 | <hr class="footer"/><address class="footer"><small>
|
---|
234 | Generated on Tue Mar 17 2015 10:34:17 for API by  <a href="http://www.doxygen.org/index.html">
|
---|
235 | <img class="footer" src="doxygen.png" alt="doxygen"/>
|
---|
236 | </a> 1.8.7
|
---|
237 | </small></address>
|
---|
238 | </body>
|
---|
239 | </html>
|
---|