287 lines
33 KiB
HTML
287 lines
33 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RTOS_MSPM0: RTOS_Labs_common/esp8266.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="RobotSensors.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">RTOS_MSPM0
|
|
 <span id="projectnumber">1.1</span>
|
|
</div>
|
|
<div id="projectbrief">ECE445M starter code</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d9737668015ddda3d9b152d7c8d1103c.html">RTOS_Labs_common</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">esp8266.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//*********************** ESP8266.h ***********************</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Program written by:</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// - Steven Prickett steven.prickett@gmail.com</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// Driver for ESP8266 module to act as a WiFi client or server</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//*********************************************************</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">/* Modified by Jonathan Valvano, Sept 19, 2015</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> Modified by Andreas Gerstlauer, Apr 13, 2020 </span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#ifndef ESP8266_H</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#define ESP8266_H</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <stdint.h></span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#define ESP8266_ENCRYPT_MODE_OPEN 0</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define ESP8266_ENCRYPT_MODE_WEP 1</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define ESP8266_ENCRYPT_MODE_WPA_PSK 2</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define ESP8266_ENCRYPT_MODE_WPA2_PSK 3</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ESP8266_ENCRYPT_MODE_WPA_WPA2_PSK 4</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define ESP8266_WIFI_MODE_CLIENT 1</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define ESP8266_WIFI_MODE_AP 2</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define ESP8266_WIFI_MODE_AP_AND_CLIENT 3</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">//-------------------ESP8266_Init --------------</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// Initializes the module</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Inputs: RX and/or TX echo for debugging</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// Outputs: 1 for success, 0 for failure (no ESP detected)</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keywordtype">int</span> ESP8266_Init(<span class="keywordtype">int</span> rx_echo, <span class="keywordtype">int</span> tx_echo);</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">//-------------------ESP8266_Connect --------------</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// Bring interface up and connect to Wifi</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// Inputs: enable debug output</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// Outputs: 1 on success, 0 on failure</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">int</span> ESP8266_Connect(<span class="keywordtype">int</span> verbose);</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">//-------------------ESP8266_StartServer --------------</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// Start server on specific port</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// Inputs: port and server timeout</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// Outputs: 1 on success, 0 on failure</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keywordtype">int</span> ESP8266_StartServer(uint16_t port, uint16_t timeout);</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">//-------------------ESP8266_StopServer --------------</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">// Stop server and set to single-client mode</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// Inputs: none</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">// Outputs: 1 on success, 0 on failure</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">int</span> ESP8266_StopServer(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">//----------ESP8266_Reset------------</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// Soft resets the esp8266 module</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// Input: none</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// Output: 1 if success, 0 if fail</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">int</span> ESP8266_Reset(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">//---------ESP8266_Restore-----</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">// Restore the ESP8266 module to default values</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// Inputs: none</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">// Outputs: 1 if success, 0 if fail</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keywordtype">int</span> ESP8266_Restore(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">//---------ESP8266_GetVersionNumber----------</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">// Get status</span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">// Input: none</span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">// Output: 1 if success, 0 if fail </span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keywordtype">int</span> ESP8266_GetVersionNumber(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">//---------ESP8266_GetMACAddress----------</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">// Get MAC address</span></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">// Input: none</span></div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">// Output: 1 if success, 0 if fail </span></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">int</span> ESP8266_GetMACAddress(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">//---------ESP8266_SetWifiMode----------</span></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">// Configures the esp8266 to operate as a wifi client, access point, or both</span></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">// Input: mode accepts ESP8266_WIFI_MODE constants</span></div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">// Output: 1 if success, 0 if fail </span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keywordtype">int</span> ESP8266_SetWifiMode(uint8_t mode);</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">//---------ESP8266_SetConnectionMux----------</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">// Enables the esp8266 connection mux, required for starting tcp server</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">// Input: 0 (single) or 1 (multiple)</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">// Output: 1 if success, 0 if fail </span></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keywordtype">int</span> ESP8266_SetConnectionMux(uint8_t enabled);</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">//---------ESP8266_ListAccessPoints----------</span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">// Lists available wifi access points</span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">// Input: none</span></div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">// Output: 1 if success, 0 if fail </span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keywordtype">int</span> ESP8266_ListAccessPoints(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">//----------ESP8266_JoinAccessPoint------------</span></div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">// Joins a wifi access point using specified ssid and password</span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">// Input: SSID and PASSWORD</span></div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">// Output: 1 if success, 0 if fail</span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="keywordtype">int</span> ESP8266_JoinAccessPoint(<span class="keyword">const</span> <span class="keywordtype">char</span>* ssid, <span class="keyword">const</span> <span class="keywordtype">char</span>* password);</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">// ----------ESP8266_QuitAccessPoint-------------</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">// Disconnects from currently connected wifi access point</span></div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment">// Inputs: none</span></div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">// Outputs: 1 if success, 0 if fail </span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keywordtype">int</span> ESP8266_QuitAccessPoint(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  </div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment">//----------ESP8266_ConfigureAccessPoint------------</span></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">// Configures esp8266 wifi soft access point settings</span></div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment">// Use this function only when in AP mode (and not in client mode)</span></div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment">// Input: SSID, Password, channel, security</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">// Output: 1 if success, 0 if fail</span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keywordtype">int</span> ESP8266_ConfigureAccessPoint(<span class="keyword">const</span> <span class="keywordtype">char</span>* ssid, <span class="keyword">const</span> <span class="keywordtype">char</span>* password, uint8_t channel, uint8_t encryptMode);</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  </div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">//---------ESP8266_GetIPAddress----------</span></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment">// Get local IP address</span></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">// Input: none</span></div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment">// output: 1 if success, 0 if fail </span></div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="keywordtype">int</span> ESP8266_GetIPAddress(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  </div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment">//---------ESP8266_SetSSLClientConfiguration----------</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment">// Set SSL client configuration</span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment">// Requires certificates to be flashed into the ESP firmware</span></div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment">// Inputs: enable/disable client/server certificate checks</span></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment">// Output: 1 if success, 0 if fail </span></div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="keywordtype">int</span> ESP8266_SetSSLClientConfiguration(<span class="keywordtype">int</span> verifyClient, <span class="keywordtype">int</span> verifyServer);</div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  </div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment">//---------ESP8266_SetSSLBufferSize----------</span></div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment">// Set SSL buffer size</span></div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment">// Inputs: buffer size between 2048 and 4096</span></div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment">// Output: 1 if success, 0 if fail </span></div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="keywordtype">int</span> ESP8266_SetSSLBufferSize(uint16_t bufferSize);</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  </div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment">//---------ESP8266_MakeTCPConnection----------</span></div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment">// Establish TCP or SSL connection </span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment">// The ESP only seems to have limited SSL support, does not work with all servers</span></div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment">// Inputs: IP address or web page as a string, port, and keepalive time (0 if none)</span></div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment">// Output: 1 if success, 0 if fail </span></div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="keywordtype">int</span> ESP8266_MakeTCPConnection(<span class="keywordtype">char</span> *IPaddress, uint16_t port, uint16_t keepalive, <span class="keywordtype">int</span> ssl);</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  </div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment">//---------ESP8266_Send----------</span></div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment">// Send a packet to server </span></div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment">// Input: payload to send</span></div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment">// Output: 1 if success, 0 if fail </span></div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="keywordtype">int</span> ESP8266_Send(<span class="keyword">const</span> <span class="keywordtype">char</span>* fetch);</div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  </div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment">//---------ESP8266_SendBuffered----------</span></div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment">// Send a string to server using ESP TCP-send buffer</span></div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment">// Input: payload to send</span></div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment">// Output: 1 if success, 0 if fail </span></div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="keywordtype">int</span> ESP8266_SendBuffered(<span class="keyword">const</span> <span class="keywordtype">char</span>* fetch);</div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  </div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment">//---------ESP8266_SendBuferedStatus----------</span></div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment">// Check status of last buffered segment</span></div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment">// Input: none</span></div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment">// Output: 1 if success, 0 if fail </span></div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="keywordtype">int</span> ESP8266_SendBufferedStatus(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  </div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment">//---------ESP8266_Receive----------</span></div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment">// Receive a string from server </span></div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment">// Reads from data input until end of line or max length is reached</span></div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment">// Input: buffer and max length</span></div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment">// Output: 1 and null-terminated string if success, 0 if fail (disconnected)</span></div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="keywordtype">int</span> ESP8266_Receive(<span class="keywordtype">char</span>* fetch, uint32_t max);</div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  </div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment">//---------ESP8266_CloseTCPConnection----------</span></div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment">// Close TCP connection </span></div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment">// Input: none</span></div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment">// Output: 1 if success, 0 if fail </span></div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="keywordtype">int</span> ESP8266_CloseTCPConnection(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  </div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment">//---------ESP8266_SetDataTransmissionMode----------</span></div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment">// Set data transmission passthrough mode</span></div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment">// Input: 0 not data mode, 1 data mode; return "Link is builded" </span></div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment">// Output: 1 if success, 0 if fail </span></div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="keywordtype">int</span> ESP8266_SetDataTransmissionMode(uint8_t mode);</div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  </div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment">//---------ESP8266_GetStatus----------</span></div>
|
|
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment">// Get network connection status</span></div>
|
|
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment">// Input: none</span></div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment">// Output: 1 if success, 0 if fail </span></div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="keywordtype">int</span> ESP8266_GetStatus(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  </div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment">// --------ESP8266_EnableServer------------------</span></div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment">// Enables tcp server on specified port</span></div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment">// Inputs: port number</span></div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment">// Outputs: 1 if success, 0 if fail</span></div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="keywordtype">int</span> ESP8266_EnableServer(uint16_t port);</div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  </div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment">// ----------ESP8266_SetServerTimeout--------------</span></div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment">// Set connection timeout for tcp server, 0-28800 seconds</span></div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment">// Inputs: timeout parameter</span></div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment">// Outputs: 1 if success, 0 if fail</span></div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="keywordtype">int</span> ESP8266_SetServerTimeout(uint16_t timeout);</div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  </div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment">// ----------ESP8266_WaitForConnection--------------</span></div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment">// Wait for incoming connection on server</span></div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment">// Inputs: none</span></div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment">// Outputs: 1 if success, 0 if fail</span></div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="keywordtype">int</span> ESP8266_WaitForConnection(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  </div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment">//---------ESP8266_DisableServer----------</span></div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment">// Disables tcp server</span></div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment">// Input: none </span></div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment">// Output: 1 if success, 0 if fail </span></div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="keywordtype">int</span> ESP8266_DisableServer(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  </div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|