Deploy jgromes/RadioLib to github.com/jgromes/RadioLib.git:gh-pages
This commit is contained in:
Deployment Bot (from Travis CI)
commit
d8926568cd
555 changed files with 67939 additions and 0 deletions
133
_a_f_s_k_8h_source.html
Normal file
133
_a_f_s_k_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
146
_a_x25_8h_source.html
Normal file
146
_a_x25_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
123
_build_opt_8h_source.html
Normal file
123
_build_opt_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
167
_c_c1101_8h_source.html
Normal file
167
_c_c1101_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
135
_e_s_p8266_8h_source.html
Normal file
135
_e_s_p8266_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
128
_h_c05_8h_source.html
Normal file
128
_h_c05_8h_source.html
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: src/modules/HC05/HC05.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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('_h_c05_8h_source.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">HC05.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="preprocessor">#if !defined(_RADIOLIB_HC05_H) && !defined(RADIOLIB_EXCLUDE_HC05)</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_HC05_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "../../ISerial.h"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="class_h_c05.html"> 12</a></span> <span class="keyword">class </span><a class="code" href="class_h_c05.html">HC05</a>: <span class="keyword">public</span> <a class="code" href="class_i_serial.html">ISerial</a> {</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <a class="code" href="class_h_c05.html#a5cc3184c58de65cbff18447c6d03de18">HC05</a>(<a class="code" href="class_module.html">Module</a>* mod);</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordtype">void</span> <a class="code" href="class_h_c05.html#a83cf61ee5a79c06f43861a6e5a8a15b6">begin</a>(<span class="keywordtype">long</span> speed);</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> };</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_h_c05_html_a5cc3184c58de65cbff18447c6d03de18"><div class="ttname"><a href="class_h_c05.html#a5cc3184c58de65cbff18447c6d03de18">HC05::HC05</a></div><div class="ttdeci">HC05(Module *mod)</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> HC05.cpp:4</div></div>
|
||||
<div class="ttc" id="class_h_c05_html_a83cf61ee5a79c06f43861a6e5a8a15b6"><div class="ttname"><a href="class_h_c05.html#a83cf61ee5a79c06f43861a6e5a8a15b6">HC05::begin</a></div><div class="ttdeci">void begin(long speed)</div><div class="ttdoc">Initialization method. </div><div class="ttdef"><b>Definition:</b> HC05.cpp:8</div></div>
|
||||
<div class="ttc" id="class_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class. </div><div class="ttdef"><b>Definition:</b> Module.h:17</div></div>
|
||||
<div class="ttc" id="class_i_serial_html"><div class="ttname"><a href="class_i_serial.html">ISerial</a></div><div class="ttdoc">Interface class for Arduino Serial. Only calls the appropriate methods for the active UART interface...</div><div class="ttdef"><b>Definition:</b> ISerial.h:16</div></div>
|
||||
<div class="ttc" id="class_h_c05_html"><div class="ttname"><a href="class_h_c05.html">HC05</a></div><div class="ttdoc">Control class for HC05 module. Most methods supported by this module are implemented in ISerial inter...</div><div class="ttdef"><b>Definition:</b> HC05.h:12</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ddb4d7e95cc2d6c8e1ade10a20d7247d.html">modules</a></li><li class="navelem"><a class="el" href="dir_66baa0cb3ce3b01929266fe63d8714ed.html">HC05</a></li><li class="navelem"><b>HC05.h</b></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
127
_h_t_t_p_8h_source.html
Normal file
127
_h_t_t_p_8h_source.html
Normal file
|
|
@ -0,0 +1,127 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: src/protocols/HTTP/HTTP.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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('_h_t_t_p_8h_source.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">HTTP.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="preprocessor">#if !defined(_RADIOLIB_HTTP_H)</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_HTTP_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "../../TypeDef.h"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#if !defined(RADIOLIB_EXCLUDE_HTTP)</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "../TransportLayer/TransportLayer.h"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="class_h_t_t_p_client.html"> 15</a></span> <span class="keyword">class </span><a class="code" href="class_h_t_t_p_client.html">HTTPClient</a> {</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keyword">explicit</span> <a class="code" href="class_h_t_t_p_client.html#a7c6fdd5681e55437ebddaac785f35557">HTTPClient</a>(<a class="code" href="class_transport_layer.html">TransportLayer</a>* tl, uint16_t port = 80);</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  int16_t <span class="keyword">get</span>(String& url, String& response);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  int16_t <span class="keyword">get</span>(<span class="keyword">const</span> <span class="keywordtype">char</span>* url, String& response);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  int16_t <a class="code" href="class_h_t_t_p_client.html#ac1119b889b6fed7bd4d119d3e4842acb">post</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* url, <span class="keyword">const</span> <span class="keywordtype">char</span>* content, String& response, <span class="keyword">const</span> <span class="keywordtype">char</span>* contentType = <span class="stringliteral">"text/plain"</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="preprocessor">#ifndef RADIOLIB_GODMODE</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="class_transport_layer.html">TransportLayer</a>* _tl;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  uint16_t _port;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> };</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_transport_layer_html"><div class="ttname"><a href="class_transport_layer.html">TransportLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on modules with Internet connectivity, such as HTTP or MQTT. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class. </div><div class="ttdef"><b>Definition:</b> TransportLayer.h:12</div></div>
|
||||
<div class="ttc" id="class_h_t_t_p_client_html_ac1119b889b6fed7bd4d119d3e4842acb"><div class="ttname"><a href="class_h_t_t_p_client.html#ac1119b889b6fed7bd4d119d3e4842acb">HTTPClient::post</a></div><div class="ttdeci">int16_t post(const char *url, const char *content, String &response, const char *contentType="text/plain")</div><div class="ttdoc">Sends HTTP POST request. </div><div class="ttdef"><b>Definition:</b> HTTP.cpp:112</div></div>
|
||||
<div class="ttc" id="class_h_t_t_p_client_html_a7c6fdd5681e55437ebddaac785f35557"><div class="ttname"><a href="class_h_t_t_p_client.html#a7c6fdd5681e55437ebddaac785f35557">HTTPClient::HTTPClient</a></div><div class="ttdeci">HTTPClient(TransportLayer *tl, uint16_t port=80)</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> HTTP.cpp:4</div></div>
|
||||
<div class="ttc" id="class_h_t_t_p_client_html"><div class="ttname"><a href="class_h_t_t_p_client.html">HTTPClient</a></div><div class="ttdoc">Client for simple HTTP communication. </div><div class="ttdef"><b>Definition:</b> HTTP.h:15</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_79690749eba542503bb1a9a3dbb495e1.html">protocols</a></li><li class="navelem"><a class="el" href="dir_47c60a953c7c148861b9fe25d51850eb.html">HTTP</a></li><li class="navelem"><b>HTTP.h</b></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
129
_hellschreiber_8h_source.html
Normal file
129
_hellschreiber_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
125
_i_serial_8h_source.html
Normal file
125
_i_serial_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
128
_j_d_y08_8h_source.html
Normal file
128
_j_d_y08_8h_source.html
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: src/modules/JDY08/JDY08.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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('_j_d_y08_8h_source.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">JDY08.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="preprocessor">#if !defined(_RADIOLIB_JDY08_H) && !defined(RADIOLIB_EXCLUDE_JDY08)</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_JDY08_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "../../ISerial.h"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="class_j_d_y08.html"> 12</a></span> <span class="keyword">class </span><a class="code" href="class_j_d_y08.html">JDY08</a>: <span class="keyword">public</span> <a class="code" href="class_i_serial.html">ISerial</a> {</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <a class="code" href="class_j_d_y08.html#a9e2895c29cbbb30bc49aa2b3b9d2c4d6">JDY08</a>(<a class="code" href="class_module.html">Module</a>* mod);</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordtype">void</span> <a class="code" href="class_j_d_y08.html#a6fca03bb9f163c16d193904beac6b0b1">begin</a>(<span class="keywordtype">long</span> speed);</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> };</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_j_d_y08_html"><div class="ttname"><a href="class_j_d_y08.html">JDY08</a></div><div class="ttdoc">Control class for JDY08 module. Most methods supported by this module are implemented in ISerial inte...</div><div class="ttdef"><b>Definition:</b> JDY08.h:12</div></div>
|
||||
<div class="ttc" id="class_j_d_y08_html_a6fca03bb9f163c16d193904beac6b0b1"><div class="ttname"><a href="class_j_d_y08.html#a6fca03bb9f163c16d193904beac6b0b1">JDY08::begin</a></div><div class="ttdeci">void begin(long speed)</div><div class="ttdoc">Initialization method. </div><div class="ttdef"><b>Definition:</b> JDY08.cpp:8</div></div>
|
||||
<div class="ttc" id="class_j_d_y08_html_a9e2895c29cbbb30bc49aa2b3b9d2c4d6"><div class="ttname"><a href="class_j_d_y08.html#a9e2895c29cbbb30bc49aa2b3b9d2c4d6">JDY08::JDY08</a></div><div class="ttdeci">JDY08(Module *mod)</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> JDY08.cpp:4</div></div>
|
||||
<div class="ttc" id="class_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class. </div><div class="ttdef"><b>Definition:</b> Module.h:17</div></div>
|
||||
<div class="ttc" id="class_i_serial_html"><div class="ttname"><a href="class_i_serial.html">ISerial</a></div><div class="ttdoc">Interface class for Arduino Serial. Only calls the appropriate methods for the active UART interface...</div><div class="ttdef"><b>Definition:</b> ISerial.h:16</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ddb4d7e95cc2d6c8e1ade10a20d7247d.html">modules</a></li><li class="navelem"><a class="el" href="dir_31c953e8b112b915d208fa745d66f12e.html">JDY08</a></li><li class="navelem"><b>JDY08.h</b></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
133
_m_q_t_t_8h_source.html
Normal file
133
_m_q_t_t_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
166
_module_8h_source.html
Normal file
166
_module_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
129
_morse_8h_source.html
Normal file
129
_morse_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
137
_physical_layer_8h_source.html
Normal file
137
_physical_layer_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
173
_r_f69_8h_source.html
Normal file
173
_r_f69_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
125
_r_f_m22_8h_source.html
Normal file
125
_r_f_m22_8h_source.html
Normal file
|
|
@ -0,0 +1,125 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: src/modules/RFM2x/RFM22.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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('_r_f_m22_8h_source.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">RFM22.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="preprocessor">#if !defined(_RADIOLIB_RFM22_H)</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_RFM22_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "../../TypeDef.h"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#if !defined(RADIOLIB_EXCLUDE_RFM2X)</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "../../Module.h"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "../Si443x/Si443x.h"</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "../Si443x/Si4432.h"</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">using</span> <a class="code" href="class_r_f_m22.html">RFM22</a> = <a class="code" href="class_si4432.html">Si4432</a>;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_r_f_m22_html"><div class="ttname"><a href="class_r_f_m22.html">RFM22</a></div><div class="ttdoc">Only exists as alias for Si4432, since there seems to be no difference between RFM22 and Si4432 modul...</div></div>
|
||||
<div class="ttc" id="class_si4432_html"><div class="ttname"><a href="class_si4432.html">Si4432</a></div><div class="ttdoc">Derived class for Si4432 modules. </div><div class="ttdef"><b>Definition:</b> Si4432.h:16</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ddb4d7e95cc2d6c8e1ade10a20d7247d.html">modules</a></li><li class="navelem"><a class="el" href="dir_1496c164e9c77875dd570f4157f3157f.html">RFM2x</a></li><li class="navelem"><b>RFM22.h</b></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
125
_r_f_m23_8h_source.html
Normal file
125
_r_f_m23_8h_source.html
Normal file
|
|
@ -0,0 +1,125 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: src/modules/RFM2x/RFM23.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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('_r_f_m23_8h_source.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">RFM23.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="preprocessor">#if !defined(_RADIOLIB_RFM23_H)</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_RFM23_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "../../TypeDef.h"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#if !defined(RADIOLIB_EXCLUDE_RFM2X)</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "../../Module.h"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "../Si443x/Si443x.h"</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "../Si443x/Si4431.h"</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">using</span> <a class="code" href="class_r_f_m23.html">RFM23</a> = <a class="code" href="class_si4431.html">Si4431</a>;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_si4431_html"><div class="ttname"><a href="class_si4431.html">Si4431</a></div><div class="ttdoc">Derived class for Si4431 modules. </div><div class="ttdef"><b>Definition:</b> Si4431.h:16</div></div>
|
||||
<div class="ttc" id="class_r_f_m23_html"><div class="ttname"><a href="class_r_f_m23.html">RFM23</a></div><div class="ttdoc">Only exists as alias for Si4431, since there seems to be no difference between RFM23 and Si4431 modul...</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ddb4d7e95cc2d6c8e1ade10a20d7247d.html">modules</a></li><li class="navelem"><a class="el" href="dir_1496c164e9c77875dd570f4157f3157f.html">RFM2x</a></li><li class="navelem"><b>RFM23.h</b></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
129
_r_f_m95_8h_source.html
Normal file
129
_r_f_m95_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
130
_r_f_m96_8h_source.html
Normal file
130
_r_f_m96_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
128
_r_f_m97_8h_source.html
Normal file
128
_r_f_m97_8h_source.html
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: src/modules/RFM9x/RFM97.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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('_r_f_m97_8h_source.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">RFM97.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="preprocessor">#if !defined(_RADIOLIB_RFM97_H)</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_RFM97_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "../../TypeDef.h"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#if !defined(RADIOLIB_EXCLUDE_RFM9X)</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "../../Module.h"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "../SX127x/SX127x.h"</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "../SX127x/SX1278.h"</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "RFM95.h"</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="class_r_f_m97.html"> 18</a></span> <span class="keyword">class </span><a class="code" href="class_r_f_m97.html">RFM97</a>: <span class="keyword">public</span> <a class="code" href="class_r_f_m95.html">RFM95</a> {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="comment">// constructor</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <a class="code" href="class_r_f_m97.html#ab7a6b22776df24d081225dcfe177e1be">RFM97</a>(<a class="code" href="class_module.html">Module</a>* mod);</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="comment">// configuration methods</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  int16_t <a class="code" href="class_r_f_m97.html#ae8d0ead424c0c9950ad9d5b7132bdf67">setSpreadingFactor</a>(uint8_t sf);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#ifndef RADIOLIB_GODMODE</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#endif</span></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> };</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_r_f_m97_html_ab7a6b22776df24d081225dcfe177e1be"><div class="ttname"><a href="class_r_f_m97.html#ab7a6b22776df24d081225dcfe177e1be">RFM97::RFM97</a></div><div class="ttdeci">RFM97(Module *mod)</div><div class="ttdoc">Default constructor. Called from Arduino sketch when creating new LoRa instance. </div><div class="ttdef"><b>Definition:</b> RFM97.cpp:4</div></div>
|
||||
<div class="ttc" id="class_r_f_m97_html"><div class="ttname"><a href="class_r_f_m97.html">RFM97</a></div><div class="ttdoc">Derived class for RFM97 modules. Overrides some methods from RFM95 due to different parameter ranges...</div><div class="ttdef"><b>Definition:</b> RFM97.h:18</div></div>
|
||||
<div class="ttc" id="class_r_f_m97_html_ae8d0ead424c0c9950ad9d5b7132bdf67"><div class="ttname"><a href="class_r_f_m97.html#ae8d0ead424c0c9950ad9d5b7132bdf67">RFM97::setSpreadingFactor</a></div><div class="ttdeci">int16_t setSpreadingFactor(uint8_t sf)</div><div class="ttdoc">Sets LoRa link spreading factor. Allowed values range from 6 to 9. Only available in LoRa mode...</div><div class="ttdef"><b>Definition:</b> RFM97.cpp:8</div></div>
|
||||
<div class="ttc" id="class_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class. </div><div class="ttdef"><b>Definition:</b> Module.h:17</div></div>
|
||||
<div class="ttc" id="class_r_f_m95_html"><div class="ttname"><a href="class_r_f_m95.html">RFM95</a></div><div class="ttdoc">Derived class for RFM95 modules. Overrides some methods from SX1278 due to different parameter ranges...</div><div class="ttdef"><b>Definition:</b> RFM95.h:21</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ddb4d7e95cc2d6c8e1ade10a20d7247d.html">modules</a></li><li class="navelem"><a class="el" href="dir_6baa7f88a31cf8c1ad1b651eaa1fd5b9.html">RFM9x</a></li><li class="navelem"><b>RFM97.h</b></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
131
_r_t_t_y_8h_source.html
Normal file
131
_r_t_t_y_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
124
_radio_lib_8h_source.html
Normal file
124
_radio_lib_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
136
_s_s_t_v_8h_source.html
Normal file
136
_s_s_t_v_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
128
_s_x1231_8h_source.html
Normal file
128
_s_x1231_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
128
_s_x1261_8h_source.html
Normal file
128
_s_x1261_8h_source.html
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: src/modules/SX126x/SX1261.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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('_s_x1261_8h_source.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">SX1261.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="preprocessor">#if !defined(_RADIOLIB_SX1261_H)</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_SX1261_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "../../TypeDef.h"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#if !defined(RADIOLIB_EXCLUDE_SX126X)</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "../../Module.h"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "SX126x.h"</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "SX1262.h"</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="comment">//SX126X_CMD_SET_PA_CONFIG</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#define SX126X_PA_CONFIG_SX1261 0x01</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="class_s_x1261.html"> 20</a></span> <span class="keyword">class </span><a class="code" href="class_s_x1261.html">SX1261</a> : <span class="keyword">public</span> <a class="code" href="class_s_x1262.html">SX1262</a> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="code" href="class_s_x1261.html#a7d74b8684dd49b5b3ba23baf336f1c35">SX1261</a>(<a class="code" href="class_module.html">Module</a>* mod);</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  int16_t <a class="code" href="class_s_x1261.html#aa541f927995a1756c651b93fd24edc65">setOutputPower</a>(int8_t power);</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#ifndef RADIOLIB_GODMODE</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> };</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_s_x1261_html"><div class="ttname"><a href="class_s_x1261.html">SX1261</a></div><div class="ttdoc">Derived class for SX1261 modules. </div><div class="ttdef"><b>Definition:</b> SX1261.h:20</div></div>
|
||||
<div class="ttc" id="class_s_x1261_html_a7d74b8684dd49b5b3ba23baf336f1c35"><div class="ttname"><a href="class_s_x1261.html#a7d74b8684dd49b5b3ba23baf336f1c35">SX1261::SX1261</a></div><div class="ttdeci">SX1261(Module *mod)</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> SX1261.cpp:4</div></div>
|
||||
<div class="ttc" id="class_s_x1262_html"><div class="ttname"><a href="class_s_x1262.html">SX1262</a></div><div class="ttdoc">Derived class for SX1262 modules. </div><div class="ttdef"><b>Definition:</b> SX1262.h:19</div></div>
|
||||
<div class="ttc" id="class_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class. </div><div class="ttdef"><b>Definition:</b> Module.h:17</div></div>
|
||||
<div class="ttc" id="class_s_x1261_html_aa541f927995a1756c651b93fd24edc65"><div class="ttname"><a href="class_s_x1261.html#aa541f927995a1756c651b93fd24edc65">SX1261::setOutputPower</a></div><div class="ttdeci">int16_t setOutputPower(int8_t power)</div><div class="ttdoc">Sets output power. Allowed values are in range from -17 to 14 dBm. </div><div class="ttdef"><b>Definition:</b> SX1261.cpp:8</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ddb4d7e95cc2d6c8e1ade10a20d7247d.html">modules</a></li><li class="navelem"><a class="el" href="dir_747c20e84f9dfe1cc835713177129efc.html">SX126x</a></li><li class="navelem"><b>SX1261.h</b></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
131
_s_x1262_8h_source.html
Normal file
131
_s_x1262_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
131
_s_x1268_8h_source.html
Normal file
131
_s_x1268_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
182
_s_x126x_8h_source.html
Normal file
182
_s_x126x_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
142
_s_x1272_8h_source.html
Normal file
142
_s_x1272_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
129
_s_x1273_8h_source.html
Normal file
129
_s_x1273_8h_source.html
Normal file
|
|
@ -0,0 +1,129 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: src/modules/SX127x/SX1273.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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('_s_x1273_8h_source.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">SX1273.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="preprocessor">#if !defined(_RADIOLIB_SX1273_H)</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_SX1273_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "../../TypeDef.h"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#if !defined(RADIOLIB_EXCLUDE_SX127X)</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "SX1272.h"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="class_s_x1273.html"> 15</a></span> <span class="keyword">class </span><a class="code" href="class_s_x1273.html">SX1273</a>: <span class="keyword">public</span> <a class="code" href="class_s_x1272.html">SX1272</a> {</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="comment">// constructor</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <a class="code" href="class_s_x1273.html#ad0387b22d6dcc876bc5f85174714149b">SX1273</a>(<a class="code" href="class_module.html">Module</a>* mod);</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">// basic methods</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  int16_t <a class="code" href="class_s_x1273.html#adf46338bf36c2d43e591426ae7b6082a">begin</a>(<span class="keywordtype">float</span> freq = 915.0, <span class="keywordtype">float</span> bw = 125.0, uint8_t sf = 9, uint8_t cr = 7, uint8_t syncWord = SX127X_SYNC_WORD, int8_t power = 10, uint16_t preambleLength = 8, uint8_t gain = 0);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// configuration methods</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  int16_t <a class="code" href="class_s_x1273.html#a1dbc5a0847c2b62d2ec5fc439ddfec3f">setSpreadingFactor</a>(uint8_t sf);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#ifndef RADIOLIB_GODMODE</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#endif</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> };</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_s_x1272_html"><div class="ttname"><a href="class_s_x1272.html">SX1272</a></div><div class="ttdoc">Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic...</div><div class="ttdef"><b>Definition:</b> SX1272.h:95</div></div>
|
||||
<div class="ttc" id="class_s_x1273_html"><div class="ttname"><a href="class_s_x1273.html">SX1273</a></div><div class="ttdoc">Derived class for SX1273 modules. Overrides some methods from SX1272 due to different parameter range...</div><div class="ttdef"><b>Definition:</b> SX1273.h:15</div></div>
|
||||
<div class="ttc" id="class_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class. </div><div class="ttdef"><b>Definition:</b> Module.h:17</div></div>
|
||||
<div class="ttc" id="class_s_x1273_html_adf46338bf36c2d43e591426ae7b6082a"><div class="ttname"><a href="class_s_x1273.html#adf46338bf36c2d43e591426ae7b6082a">SX1273::begin</a></div><div class="ttdeci">int16_t begin(float freq=915.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=SX127X_SYNC_WORD, int8_t power=10, uint16_t preambleLength=8, uint8_t gain=0)</div><div class="ttdoc">LoRa modem initialization method. Must be called at least once from Arduino sketch to initialize the ...</div><div class="ttdef"><b>Definition:</b> SX1273.cpp:8</div></div>
|
||||
<div class="ttc" id="class_s_x1273_html_a1dbc5a0847c2b62d2ec5fc439ddfec3f"><div class="ttname"><a href="class_s_x1273.html#a1dbc5a0847c2b62d2ec5fc439ddfec3f">SX1273::setSpreadingFactor</a></div><div class="ttdeci">int16_t setSpreadingFactor(uint8_t sf)</div><div class="ttdoc">Sets LoRa link spreading factor. Allowed values range from 6 to 9. Only available in LoRa mode...</div><div class="ttdef"><b>Definition:</b> SX1273.cpp:44</div></div>
|
||||
<div class="ttc" id="class_s_x1273_html_ad0387b22d6dcc876bc5f85174714149b"><div class="ttname"><a href="class_s_x1273.html#ad0387b22d6dcc876bc5f85174714149b">SX1273::SX1273</a></div><div class="ttdeci">SX1273(Module *mod)</div><div class="ttdoc">Default constructor. Called from Arduino sketch when creating new LoRa instance. </div><div class="ttdef"><b>Definition:</b> SX1273.cpp:4</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ddb4d7e95cc2d6c8e1ade10a20d7247d.html">modules</a></li><li class="navelem"><a class="el" href="dir_f980efad9544c0545d0fa50a84ff12f2.html">SX127x</a></li><li class="navelem"><b>SX1273.h</b></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
130
_s_x1276_8h_source.html
Normal file
130
_s_x1276_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
131
_s_x1277_8h_source.html
Normal file
131
_s_x1277_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
142
_s_x1278_8h_source.html
Normal file
142
_s_x1278_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
130
_s_x1279_8h_source.html
Normal file
130
_s_x1279_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
171
_s_x127x_8h_source.html
Normal file
171
_s_x127x_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
130
_s_x1280_8h_source.html
Normal file
130
_s_x1280_8h_source.html
Normal file
|
|
@ -0,0 +1,130 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: src/modules/SX128x/SX1280.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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('_s_x1280_8h_source.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">SX1280.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="preprocessor">#if !defined(_RADIOLIB_SX1280_H)</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_SX1280_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "../../TypeDef.h"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#if !defined(RADIOLIB_EXCLUDE_SX128X)</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "../../Module.h"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "SX128x.h"</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "SX1281.h"</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="class_s_x1280.html"> 17</a></span> <span class="keyword">class </span><a class="code" href="class_s_x1280.html">SX1280</a>: <span class="keyword">public</span> <a class="code" href="class_s_x1281.html">SX1281</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <a class="code" href="class_s_x1280.html#a0356199b89860e15cda4979cd9dc13eb">SX1280</a>(<a class="code" href="class_module.html">Module</a>* mod);</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  int16_t <a class="code" href="class_s_x1280.html#a812e289084b2f78977b254c28f0fff7c">range</a>(<span class="keywordtype">bool</span> master, uint32_t addr);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  int16_t <a class="code" href="class_s_x1280.html#af30ff497ca3bcc043dc4dc2e7587a795">startRanging</a>(<span class="keywordtype">bool</span> master, uint32_t addr);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">float</span> <a class="code" href="class_s_x1280.html#a91f4f241f02cd4e79d15a9ba08eb1e8f">getRangingResult</a>();</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#ifndef RADIOLIB_GODMODE</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> };</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#endif</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="preprocessor">#endif</span></div><div class="ttc" id="class_s_x1280_html"><div class="ttname"><a href="class_s_x1280.html">SX1280</a></div><div class="ttdoc">Derived class for SX1280 modules. </div><div class="ttdef"><b>Definition:</b> SX1280.h:17</div></div>
|
||||
<div class="ttc" id="class_s_x1280_html_a812e289084b2f78977b254c28f0fff7c"><div class="ttname"><a href="class_s_x1280.html#a812e289084b2f78977b254c28f0fff7c">SX1280::range</a></div><div class="ttdeci">int16_t range(bool master, uint32_t addr)</div><div class="ttdoc">Blocking ranging method. </div><div class="ttdef"><b>Definition:</b> SX1280.cpp:8</div></div>
|
||||
<div class="ttc" id="class_s_x1280_html_af30ff497ca3bcc043dc4dc2e7587a795"><div class="ttname"><a href="class_s_x1280.html#af30ff497ca3bcc043dc4dc2e7587a795">SX1280::startRanging</a></div><div class="ttdeci">int16_t startRanging(bool master, uint32_t addr)</div><div class="ttdoc">Interrupt-driven ranging method. </div><div class="ttdef"><b>Definition:</b> SX1280.cpp:34</div></div>
|
||||
<div class="ttc" id="class_s_x1281_html"><div class="ttname"><a href="class_s_x1281.html">SX1281</a></div><div class="ttdoc">Derived class for SX1281 modules. </div><div class="ttdef"><b>Definition:</b> SX1281.h:16</div></div>
|
||||
<div class="ttc" id="class_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class. </div><div class="ttdef"><b>Definition:</b> Module.h:17</div></div>
|
||||
<div class="ttc" id="class_s_x1280_html_a91f4f241f02cd4e79d15a9ba08eb1e8f"><div class="ttname"><a href="class_s_x1280.html#a91f4f241f02cd4e79d15a9ba08eb1e8f">SX1280::getRangingResult</a></div><div class="ttdeci">float getRangingResult()</div><div class="ttdoc">Gets ranging result of the last ranging exchange. </div><div class="ttdef"><b>Definition:</b> SX1280.cpp:104</div></div>
|
||||
<div class="ttc" id="class_s_x1280_html_a0356199b89860e15cda4979cd9dc13eb"><div class="ttname"><a href="class_s_x1280.html#a0356199b89860e15cda4979cd9dc13eb">SX1280::SX1280</a></div><div class="ttdeci">SX1280(Module *mod)</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> SX1280.cpp:4</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ddb4d7e95cc2d6c8e1ade10a20d7247d.html">modules</a></li><li class="navelem"><a class="el" href="dir_ed12d23d857ca7061030f8751e72e77c.html">SX128x</a></li><li class="navelem"><b>SX1280.h</b></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
127
_s_x1281_8h_source.html
Normal file
127
_s_x1281_8h_source.html
Normal file
|
|
@ -0,0 +1,127 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: src/modules/SX128x/SX1281.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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('_s_x1281_8h_source.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">SX1281.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="preprocessor">#if !defined(_RADIOLIB_SX1281_H)</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_SX1281_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "../../TypeDef.h"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#if !defined(RADIOLIB_EXCLUDE_SX128X)</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "../../Module.h"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "SX128x.h"</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="class_s_x1281.html"> 16</a></span> <span class="keyword">class </span><a class="code" href="class_s_x1281.html">SX1281</a>: <span class="keyword">public</span> <a class="code" href="class_s_x128x.html">SX128x</a> {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <a class="code" href="class_s_x1281.html#a0dd7678cdf7fad9ecfc9139c5092f998">SX1281</a>(<a class="code" href="class_module.html">Module</a>* mod);</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef RADIOLIB_GODMODE</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> };</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#endif</span></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="preprocessor">#endif</span></div><div class="ttc" id="class_s_x1281_html"><div class="ttname"><a href="class_s_x1281.html">SX1281</a></div><div class="ttdoc">Derived class for SX1281 modules. </div><div class="ttdef"><b>Definition:</b> SX1281.h:16</div></div>
|
||||
<div class="ttc" id="class_s_x1281_html_a0dd7678cdf7fad9ecfc9139c5092f998"><div class="ttname"><a href="class_s_x1281.html#a0dd7678cdf7fad9ecfc9139c5092f998">SX1281::SX1281</a></div><div class="ttdeci">SX1281(Module *mod)</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> SX1281.cpp:4</div></div>
|
||||
<div class="ttc" id="class_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class. </div><div class="ttdef"><b>Definition:</b> Module.h:17</div></div>
|
||||
<div class="ttc" id="class_s_x128x_html"><div class="ttname"><a href="class_s_x128x.html">SX128x</a></div><div class="ttdoc">Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from thi...</div><div class="ttdef"><b>Definition:</b> SX128x.h:339</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ddb4d7e95cc2d6c8e1ade10a20d7247d.html">modules</a></li><li class="navelem"><a class="el" href="dir_ed12d23d857ca7061030f8751e72e77c.html">SX128x</a></li><li class="navelem"><b>SX1281.h</b></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
127
_s_x1282_8h_source.html
Normal file
127
_s_x1282_8h_source.html
Normal file
|
|
@ -0,0 +1,127 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: src/modules/SX128x/SX1282.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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('_s_x1282_8h_source.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">SX1282.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="preprocessor">#if !defined(_RADIOLIB_SX1282_H)</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_SX1282_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "../../TypeDef.h"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#if !defined(RADIOLIB_EXCLUDE_SX128X)</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "../../Module.h"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "SX128x.h"</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "SX1280.h"</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="class_s_x1282.html"> 17</a></span> <span class="keyword">class </span><a class="code" href="class_s_x1282.html">SX1282</a>: <span class="keyword">public</span> <a class="code" href="class_s_x1280.html">SX1280</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <a class="code" href="class_s_x1282.html#ae90b7dcd7167c4cbe20e33ced04e4232">SX1282</a>(<a class="code" href="class_module.html">Module</a>* mod);</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#ifndef RADIOLIB_GODMODE</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> };</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_s_x1280_html"><div class="ttname"><a href="class_s_x1280.html">SX1280</a></div><div class="ttdoc">Derived class for SX1280 modules. </div><div class="ttdef"><b>Definition:</b> SX1280.h:17</div></div>
|
||||
<div class="ttc" id="class_s_x1282_html_ae90b7dcd7167c4cbe20e33ced04e4232"><div class="ttname"><a href="class_s_x1282.html#ae90b7dcd7167c4cbe20e33ced04e4232">SX1282::SX1282</a></div><div class="ttdeci">SX1282(Module *mod)</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> SX1282.cpp:5</div></div>
|
||||
<div class="ttc" id="class_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class. </div><div class="ttdef"><b>Definition:</b> Module.h:17</div></div>
|
||||
<div class="ttc" id="class_s_x1282_html"><div class="ttname"><a href="class_s_x1282.html">SX1282</a></div><div class="ttdoc">Derived class for SX1282 modules. </div><div class="ttdef"><b>Definition:</b> SX1282.h:17</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ddb4d7e95cc2d6c8e1ade10a20d7247d.html">modules</a></li><li class="navelem"><a class="el" href="dir_ed12d23d857ca7061030f8751e72e77c.html">SX128x</a></li><li class="navelem"><b>SX1282.h</b></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
170
_s_x128x_8h_source.html
Normal file
170
_s_x128x_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
130
_si4430_8h_source.html
Normal file
130
_si4430_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
129
_si4431_8h_source.html
Normal file
129
_si4431_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
130
_si4432_8h_source.html
Normal file
130
_si4432_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
154
_si443x_8h_source.html
Normal file
154
_si443x_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
129
_transport_layer_8h_source.html
Normal file
129
_transport_layer_8h_source.html
Normal file
|
|
@ -0,0 +1,129 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: src/protocols/TransportLayer/TransportLayer.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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('_transport_layer_8h_source.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">TransportLayer.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="preprocessor">#ifndef _RADIOLIB_TRANSPORT_LAYER_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_TRANSPORT_LAYER_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "../../TypeDef.h"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="class_transport_layer.html"> 12</a></span> <span class="keyword">class </span><a class="code" href="class_transport_layer.html">TransportLayer</a> {</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <span class="comment">// constructor</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  <span class="comment">// this class is purely virtual and does not require explicit constructor</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="comment">// basic methods</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_transport_layer.html#a36b1ceebca3643fb475607d3d92f5d63">openTransportConnection</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* host, <span class="keyword">const</span> <span class="keywordtype">char</span>* protocol, uint16_t port, uint16_t tcpKeepAlive = 0) = 0;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_transport_layer.html#a82fc1c71a0f6d0aac1be7f6c184a0021">closeTransportConnection</a>() = 0;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_transport_layer.html#a1d9cb76640868aa0338b52808e4f022d">send</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* data) = 0;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_transport_layer.html#a1d9cb76640868aa0338b52808e4f022d">send</a>(uint8_t* data, <span class="keywordtype">size_t</span> len) = 0;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="class_transport_layer.html#a846492348f71d7328834076c9046dc3f">receive</a>(uint8_t* data, <span class="keywordtype">size_t</span> len, uint32_t timeout = 10000) = 0;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="class_transport_layer.html#a730e6671632844b1effc114e5c7d95c8">getNumBytes</a>(uint32_t timeout = 10000, <span class="keywordtype">size_t</span> minBytes = 10) = 0;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> };</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_transport_layer_html"><div class="ttname"><a href="class_transport_layer.html">TransportLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on modules with Internet connectivity, such as HTTP or MQTT. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class. </div><div class="ttdef"><b>Definition:</b> TransportLayer.h:12</div></div>
|
||||
<div class="ttc" id="class_transport_layer_html_a730e6671632844b1effc114e5c7d95c8"><div class="ttname"><a href="class_transport_layer.html#a730e6671632844b1effc114e5c7d95c8">TransportLayer::getNumBytes</a></div><div class="ttdeci">virtual size_t getNumBytes(uint32_t timeout=10000, size_t minBytes=10)=0</div><div class="ttdoc">Get number of received bytes. </div></div>
|
||||
<div class="ttc" id="class_transport_layer_html_a846492348f71d7328834076c9046dc3f"><div class="ttname"><a href="class_transport_layer.html#a846492348f71d7328834076c9046dc3f">TransportLayer::receive</a></div><div class="ttdeci">virtual size_t receive(uint8_t *data, size_t len, uint32_t timeout=10000)=0</div><div class="ttdoc">Receive data. </div></div>
|
||||
<div class="ttc" id="class_transport_layer_html_a36b1ceebca3643fb475607d3d92f5d63"><div class="ttname"><a href="class_transport_layer.html#a36b1ceebca3643fb475607d3d92f5d63">TransportLayer::openTransportConnection</a></div><div class="ttdeci">virtual int16_t openTransportConnection(const char *host, const char *protocol, uint16_t port, uint16_t tcpKeepAlive=0)=0</div><div class="ttdoc">Open transport layer connection. </div></div>
|
||||
<div class="ttc" id="class_transport_layer_html_a1d9cb76640868aa0338b52808e4f022d"><div class="ttname"><a href="class_transport_layer.html#a1d9cb76640868aa0338b52808e4f022d">TransportLayer::send</a></div><div class="ttdeci">virtual int16_t send(const char *data)=0</div><div class="ttdoc">Send string-based data. </div></div>
|
||||
<div class="ttc" id="class_transport_layer_html_a82fc1c71a0f6d0aac1be7f6c184a0021"><div class="ttname"><a href="class_transport_layer.html#a82fc1c71a0f6d0aac1be7f6c184a0021">TransportLayer::closeTransportConnection</a></div><div class="ttdeci">virtual int16_t closeTransportConnection()=0</div><div class="ttdoc">Close transport layer connection. </div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_79690749eba542503bb1a9a3dbb495e1.html">protocols</a></li><li class="navelem"><a class="el" href="dir_022d1f7e87f0a3cd97fb9c4aa339f7b1.html">TransportLayer</a></li><li class="navelem"><b>TransportLayer.h</b></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
123
_type_def_8h_source.html
Normal file
123
_type_def_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
132
_x_bee_8h_source.html
Normal file
132
_x_bee_8h_source.html
Normal file
File diff suppressed because one or more lines are too long
179
annotated.html
Normal file
179
annotated.html
Normal file
|
|
@ -0,0 +1,179 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: Class List</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li class="current"><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('annotated.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">Class List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
|
||||
<table class="directory">
|
||||
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_a_f_s_k_client.html" target="_self">AFSKClient</a></td><td class="desc">Client for audio-based transmissions. Requires Arduino <a class="el" href="class_a_f_s_k_client.html#a6d2341901c83e45f853c077e60f1fa33" title="Start transmitting audio tone. ">tone()</a> function, and a module capable of direct mode transmission using DIO pins </td></tr>
|
||||
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_a_x25_client.html" target="_self">AX25Client</a></td><td class="desc">Client for AX25 communication </td></tr>
|
||||
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_a_x25_frame.html" target="_self">AX25Frame</a></td><td class="desc">Abstraction of AX.25 frame format </td></tr>
|
||||
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_c_c1101.html" target="_self">CC1101</a></td><td class="desc">Control class for CC1101 module </td></tr>
|
||||
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_e_s_p8266.html" target="_self">ESP8266</a></td><td class="desc">Control class for ESP8266 module. Implements <a class="el" href="class_transport_layer.html" title="Provides common interface for protocols that run on modules with Internet connectivity, such as HTTP or MQTT. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class. ">TransportLayer</a> methods </td></tr>
|
||||
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_h_c05.html" target="_self">HC05</a></td><td class="desc">Control class for HC05 module. Most methods supported by this module are implemented in <a class="el" href="class_i_serial.html" title="Interface class for Arduino Serial. Only calls the appropriate methods for the active UART interface...">ISerial</a> interface </td></tr>
|
||||
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_hell_client.html" target="_self">HellClient</a></td><td class="desc">Client for Hellschreiber transmissions </td></tr>
|
||||
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_h_t_t_p_client.html" target="_self">HTTPClient</a></td><td class="desc">Client for simple HTTP communication </td></tr>
|
||||
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_i_serial.html" target="_self">ISerial</a></td><td class="desc">Interface class for Arduino Serial. Only calls the appropriate methods for the active UART interface </td></tr>
|
||||
<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_i_t_a2_string.html" target="_self">ITA2String</a></td><td class="desc">ITA2-encoded string </td></tr>
|
||||
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_j_d_y08.html" target="_self">JDY08</a></td><td class="desc">Control class for JDY08 module. Most methods supported by this module are implemented in <a class="el" href="class_i_serial.html" title="Interface class for Arduino Serial. Only calls the appropriate methods for the active UART interface...">ISerial</a> interface </td></tr>
|
||||
<tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_module.html" target="_self">Module</a></td><td class="desc">Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class </td></tr>
|
||||
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_morse_client.html" target="_self">MorseClient</a></td><td class="desc">Client for Morse Code communication. The public interface is the same as Arduino Serial </td></tr>
|
||||
<tr id="row_13_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_m_q_t_t_client.html" target="_self">MQTTClient</a></td><td class="desc">Client for simple MQTT communication </td></tr>
|
||||
<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classn_r_f24.html" target="_self">nRF24</a></td><td class="desc">Control class for nRF24 module </td></tr>
|
||||
<tr id="row_15_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_physical_layer.html" target="_self">PhysicalLayer</a></td><td class="desc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN. Also extracts some common module-independent methods. Using this interface class allows to use the protocols on various modules without much code duplicity. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class </td></tr>
|
||||
<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_r_f69.html" target="_self">RF69</a></td><td class="desc">Control class for RF69 module. Also serves as base class for <a class="el" href="class_s_x1231.html" title="Control class for SX1231 module. Overrides some methods from RF69 due to different register values...">SX1231</a> </td></tr>
|
||||
<tr id="row_17_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_r_f_m22.html" target="_self">RFM22</a></td><td class="desc">Only exists as alias for <a class="el" href="class_si4432.html" title="Derived class for Si4432 modules. ">Si4432</a>, since there seems to be no difference between RFM22 and Si4432 modules </td></tr>
|
||||
<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_r_f_m23.html" target="_self">RFM23</a></td><td class="desc">Only exists as alias for <a class="el" href="class_si4431.html" title="Derived class for Si4431 modules. ">Si4431</a>, since there seems to be no difference between RFM23 and Si4431 modules </td></tr>
|
||||
<tr id="row_19_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_r_f_m95.html" target="_self">RFM95</a></td><td class="desc">Derived class for RFM95 modules. Overrides some methods from <a class="el" href="class_s_x1278.html" title="Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279, RFM95 and RFM96. All of these modules use the same basic hardware and only differ in parameter ranges (and names). ">SX1278</a> due to different parameter ranges </td></tr>
|
||||
<tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_r_f_m96.html" target="_self">RFM96</a></td><td class="desc">Derived class for RFM96 modules. Overrides some methods from <a class="el" href="class_s_x1278.html" title="Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279, RFM95 and RFM96. All of these modules use the same basic hardware and only differ in parameter ranges (and names). ">SX1278</a> due to different parameter ranges </td></tr>
|
||||
<tr id="row_21_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_r_f_m97.html" target="_self">RFM97</a></td><td class="desc">Derived class for RFM97 modules. Overrides some methods from <a class="el" href="class_r_f_m95.html" title="Derived class for RFM95 modules. Overrides some methods from SX1278 due to different parameter ranges...">RFM95</a> due to different parameter ranges </td></tr>
|
||||
<tr id="row_22_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_r_f_m98.html" target="_self">RFM98</a></td><td class="desc">Only exists as alias for <a class="el" href="class_r_f_m96.html" title="Derived class for RFM96 modules. Overrides some methods from SX1278 due to different parameter ranges...">RFM96</a>, since there seems to be no difference between RFM96 and RFM98 modules </td></tr>
|
||||
<tr id="row_23_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_r_t_t_y_client.html" target="_self">RTTYClient</a></td><td class="desc">Client for RTTY communication. The public interface is the same as Arduino Serial </td></tr>
|
||||
<tr id="row_24_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_si4430.html" target="_self">Si4430</a></td><td class="desc">Derived class for Si4430 modules </td></tr>
|
||||
<tr id="row_25_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_si4431.html" target="_self">Si4431</a></td><td class="desc">Derived class for Si4431 modules </td></tr>
|
||||
<tr id="row_26_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_si4432.html" target="_self">Si4432</a></td><td class="desc">Derived class for Si4432 modules </td></tr>
|
||||
<tr id="row_27_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_si443x.html" target="_self">Si443x</a></td><td class="desc">Base class for <a class="el" href="class_si443x.html" title="Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from thi...">Si443x</a> series. All derived classes for <a class="el" href="class_si443x.html" title="Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from thi...">Si443x</a> (e.g. <a class="el" href="class_si4431.html" title="Derived class for Si4431 modules. ">Si4431</a> or <a class="el" href="class_si4432.html" title="Derived class for Si4432 modules. ">Si4432</a>) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes </td></tr>
|
||||
<tr id="row_28_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_s_t_v_client.html" target="_self">SSTVClient</a></td><td class="desc">Client for SSTV transmissions </td></tr>
|
||||
<tr id="row_29_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_s_s_t_v_mode__t.html" target="_self">SSTVMode_t</a></td><td class="desc">Structure to save data about supported SSTV modes </td></tr>
|
||||
<tr id="row_30_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1231.html" target="_self">SX1231</a></td><td class="desc">Control class for SX1231 module. Overrides some methods from <a class="el" href="class_r_f69.html" title="Control class for RF69 module. Also serves as base class for SX1231. ">RF69</a> due to different register values </td></tr>
|
||||
<tr id="row_31_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1261.html" target="_self">SX1261</a></td><td class="desc">Derived class for SX1261 modules </td></tr>
|
||||
<tr id="row_32_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1262.html" target="_self">SX1262</a></td><td class="desc">Derived class for SX1262 modules </td></tr>
|
||||
<tr id="row_33_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1268.html" target="_self">SX1268</a></td><td class="desc">Derived class for SX1268 modules </td></tr>
|
||||
<tr id="row_34_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x126x.html" target="_self">SX126x</a></td><td class="desc">Base class for SX126x series. All derived classes for SX126x (e.g. <a class="el" href="class_s_x1262.html" title="Derived class for SX1262 modules. ">SX1262</a> or <a class="el" href="class_s_x1268.html" title="Derived class for SX1268 modules. ">SX1268</a>) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes </td></tr>
|
||||
<tr id="row_35_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1272.html" target="_self">SX1272</a></td><td class="desc">Derived class for SX1272 modules. Also used as base class for <a class="el" href="class_s_x1273.html" title="Derived class for SX1273 modules. Overrides some methods from SX1272 due to different parameter range...">SX1273</a>. Both modules use the same basic hardware and only differ in parameter ranges </td></tr>
|
||||
<tr id="row_36_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1273.html" target="_self">SX1273</a></td><td class="desc">Derived class for SX1273 modules. Overrides some methods from <a class="el" href="class_s_x1272.html" title="Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic...">SX1272</a> due to different parameter ranges </td></tr>
|
||||
<tr id="row_37_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1276.html" target="_self">SX1276</a></td><td class="desc">Derived class for SX1276 modules. Overrides some methods from <a class="el" href="class_s_x1278.html" title="Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279, RFM95 and RFM96. All of these modules use the same basic hardware and only differ in parameter ranges (and names). ">SX1278</a> due to different parameter ranges </td></tr>
|
||||
<tr id="row_38_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1277.html" target="_self">SX1277</a></td><td class="desc">Derived class for SX1277 modules. Overrides some methods from <a class="el" href="class_s_x1278.html" title="Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279, RFM95 and RFM96. All of these modules use the same basic hardware and only differ in parameter ranges (and names). ">SX1278</a> due to different parameter ranges </td></tr>
|
||||
<tr id="row_39_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1278.html" target="_self">SX1278</a></td><td class="desc">Derived class for SX1278 modules. Also used as base class for <a class="el" href="class_s_x1276.html" title="Derived class for SX1276 modules. Overrides some methods from SX1278 due to different parameter range...">SX1276</a>, <a class="el" href="class_s_x1277.html" title="Derived class for SX1277 modules. Overrides some methods from SX1278 due to different parameter range...">SX1277</a>, <a class="el" href="class_s_x1279.html" title="Derived class for SX1279 modules. Overrides some methods from SX1278 due to different parameter range...">SX1279</a>, <a class="el" href="class_r_f_m95.html" title="Derived class for RFM95 modules. Overrides some methods from SX1278 due to different parameter ranges...">RFM95</a> and <a class="el" href="class_r_f_m96.html" title="Derived class for RFM96 modules. Overrides some methods from SX1278 due to different parameter ranges...">RFM96</a>. All of these modules use the same basic hardware and only differ in parameter ranges (and names) </td></tr>
|
||||
<tr id="row_40_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1279.html" target="_self">SX1279</a></td><td class="desc">Derived class for SX1279 modules. Overrides some methods from <a class="el" href="class_s_x1278.html" title="Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279, RFM95 and RFM96. All of these modules use the same basic hardware and only differ in parameter ranges (and names). ">SX1278</a> due to different parameter ranges </td></tr>
|
||||
<tr id="row_41_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x127x.html" target="_self">SX127x</a></td><td class="desc">Base class for <a class="el" href="class_s_x127x.html" title="Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from thi...">SX127x</a> series. All derived classes for <a class="el" href="class_s_x127x.html" title="Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from thi...">SX127x</a> (e.g. <a class="el" href="class_s_x1278.html" title="Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279, RFM95 and RFM96. All of these modules use the same basic hardware and only differ in parameter ranges (and names). ">SX1278</a> or <a class="el" href="class_s_x1272.html" title="Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic...">SX1272</a>) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes </td></tr>
|
||||
<tr id="row_42_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1280.html" target="_self">SX1280</a></td><td class="desc">Derived class for SX1280 modules </td></tr>
|
||||
<tr id="row_43_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1281.html" target="_self">SX1281</a></td><td class="desc">Derived class for SX1281 modules </td></tr>
|
||||
<tr id="row_44_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x1282.html" target="_self">SX1282</a></td><td class="desc">Derived class for SX1282 modules </td></tr>
|
||||
<tr id="row_45_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_s_x128x.html" target="_self">SX128x</a></td><td class="desc">Base class for SX128x series. All derived classes for SX128x (e.g. <a class="el" href="class_s_x1280.html" title="Derived class for SX1280 modules. ">SX1280</a> or <a class="el" href="class_s_x1281.html" title="Derived class for SX1281 modules. ">SX1281</a>) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes </td></tr>
|
||||
<tr id="row_46_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structtone__t.html" target="_self">tone_t</a></td><td class="desc">Structure to save data about tone </td></tr>
|
||||
<tr id="row_47_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_transport_layer.html" target="_self">TransportLayer</a></td><td class="desc">Provides common interface for protocols that run on modules with Internet connectivity, such as HTTP or MQTT. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class </td></tr>
|
||||
<tr id="row_48_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_x_bee.html" target="_self">XBee</a></td><td class="desc">Control class for XBee modules </td></tr>
|
||||
<tr id="row_49_"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_x_bee_serial.html" target="_self">XBeeSerial</a></td><td class="desc">XBee Serial interface. This class is used for XBees in transparent mode, i.e. when two XBees act as a "wireless UART" </td></tr>
|
||||
</table>
|
||||
</div><!-- directory -->
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
53
annotated_dup.js
Normal file
53
annotated_dup.js
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
var annotated_dup =
|
||||
[
|
||||
[ "AFSKClient", "class_a_f_s_k_client.html", "class_a_f_s_k_client" ],
|
||||
[ "AX25Client", "class_a_x25_client.html", "class_a_x25_client" ],
|
||||
[ "AX25Frame", "class_a_x25_frame.html", "class_a_x25_frame" ],
|
||||
[ "CC1101", "class_c_c1101.html", "class_c_c1101" ],
|
||||
[ "ESP8266", "class_e_s_p8266.html", "class_e_s_p8266" ],
|
||||
[ "HC05", "class_h_c05.html", "class_h_c05" ],
|
||||
[ "HellClient", "class_hell_client.html", "class_hell_client" ],
|
||||
[ "HTTPClient", "class_h_t_t_p_client.html", "class_h_t_t_p_client" ],
|
||||
[ "ISerial", "class_i_serial.html", "class_i_serial" ],
|
||||
[ "ITA2String", "class_i_t_a2_string.html", "class_i_t_a2_string" ],
|
||||
[ "JDY08", "class_j_d_y08.html", "class_j_d_y08" ],
|
||||
[ "Module", "class_module.html", "class_module" ],
|
||||
[ "MorseClient", "class_morse_client.html", "class_morse_client" ],
|
||||
[ "MQTTClient", "class_m_q_t_t_client.html", "class_m_q_t_t_client" ],
|
||||
[ "nRF24", "classn_r_f24.html", "classn_r_f24" ],
|
||||
[ "PhysicalLayer", "class_physical_layer.html", "class_physical_layer" ],
|
||||
[ "RF69", "class_r_f69.html", "class_r_f69" ],
|
||||
[ "RFM22", "class_r_f_m22.html", null ],
|
||||
[ "RFM23", "class_r_f_m23.html", null ],
|
||||
[ "RFM95", "class_r_f_m95.html", "class_r_f_m95" ],
|
||||
[ "RFM96", "class_r_f_m96.html", "class_r_f_m96" ],
|
||||
[ "RFM97", "class_r_f_m97.html", "class_r_f_m97" ],
|
||||
[ "RFM98", "class_r_f_m98.html", null ],
|
||||
[ "RTTYClient", "class_r_t_t_y_client.html", "class_r_t_t_y_client" ],
|
||||
[ "Si4430", "class_si4430.html", "class_si4430" ],
|
||||
[ "Si4431", "class_si4431.html", "class_si4431" ],
|
||||
[ "Si4432", "class_si4432.html", "class_si4432" ],
|
||||
[ "Si443x", "class_si443x.html", "class_si443x" ],
|
||||
[ "SSTVClient", "class_s_s_t_v_client.html", "class_s_s_t_v_client" ],
|
||||
[ "SSTVMode_t", "struct_s_s_t_v_mode__t.html", "struct_s_s_t_v_mode__t" ],
|
||||
[ "SX1231", "class_s_x1231.html", "class_s_x1231" ],
|
||||
[ "SX1261", "class_s_x1261.html", "class_s_x1261" ],
|
||||
[ "SX1262", "class_s_x1262.html", "class_s_x1262" ],
|
||||
[ "SX1268", "class_s_x1268.html", "class_s_x1268" ],
|
||||
[ "SX126x", "class_s_x126x.html", "class_s_x126x" ],
|
||||
[ "SX1272", "class_s_x1272.html", "class_s_x1272" ],
|
||||
[ "SX1273", "class_s_x1273.html", "class_s_x1273" ],
|
||||
[ "SX1276", "class_s_x1276.html", "class_s_x1276" ],
|
||||
[ "SX1277", "class_s_x1277.html", "class_s_x1277" ],
|
||||
[ "SX1278", "class_s_x1278.html", "class_s_x1278" ],
|
||||
[ "SX1279", "class_s_x1279.html", "class_s_x1279" ],
|
||||
[ "SX127x", "class_s_x127x.html", "class_s_x127x" ],
|
||||
[ "SX1280", "class_s_x1280.html", "class_s_x1280" ],
|
||||
[ "SX1281", "class_s_x1281.html", "class_s_x1281" ],
|
||||
[ "SX1282", "class_s_x1282.html", "class_s_x1282" ],
|
||||
[ "SX128x", "class_s_x128x.html", "class_s_x128x" ],
|
||||
[ "tone_t", "structtone__t.html", "structtone__t" ],
|
||||
[ "TransportLayer", "class_transport_layer.html", "class_transport_layer" ],
|
||||
[ "XBee", "class_x_bee.html", "class_x_bee" ],
|
||||
[ "XBeeSerial", "class_x_bee_serial.html", "class_x_bee_serial" ]
|
||||
];
|
||||
BIN
arrowdown.png
Normal file
BIN
arrowdown.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 246 B |
BIN
arrowright.png
Normal file
BIN
arrowright.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 229 B |
BIN
bc_s.png
Normal file
BIN
bc_s.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 676 B |
BIN
bdwn.png
Normal file
BIN
bdwn.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 147 B |
136
class_a_f_s_k_client-members.html
Normal file
136
class_a_f_s_k_client-members.html
Normal file
|
|
@ -0,0 +1,136 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: Member List</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_a_f_s_k_client.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">AFSKClient Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_a_f_s_k_client.html">AFSKClient</a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_a_f_s_k_client.html#acfe53917bcba7f79611e01865c42fefd">AFSKClient</a>(PhysicalLayer *phy, RADIOLIB_PIN_TYPE pin)</td><td class="entry"><a class="el" href="class_a_f_s_k_client.html">AFSKClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>AX25Client</b> (defined in <a class="el" href="class_a_f_s_k_client.html">AFSKClient</a>)</td><td class="entry"><a class="el" href="class_a_f_s_k_client.html">AFSKClient</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>HellClient</b> (defined in <a class="el" href="class_a_f_s_k_client.html">AFSKClient</a>)</td><td class="entry"><a class="el" href="class_a_f_s_k_client.html">AFSKClient</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>MorseClient</b> (defined in <a class="el" href="class_a_f_s_k_client.html">AFSKClient</a>)</td><td class="entry"><a class="el" href="class_a_f_s_k_client.html">AFSKClient</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_a_f_s_k_client.html#ade91356bb158bbc820d28855dd5818d1">noTone</a>()</td><td class="entry"><a class="el" href="class_a_f_s_k_client.html">AFSKClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>RTTYClient</b> (defined in <a class="el" href="class_a_f_s_k_client.html">AFSKClient</a>)</td><td class="entry"><a class="el" href="class_a_f_s_k_client.html">AFSKClient</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>SSTVClient</b> (defined in <a class="el" href="class_a_f_s_k_client.html">AFSKClient</a>)</td><td class="entry"><a class="el" href="class_a_f_s_k_client.html">AFSKClient</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_a_f_s_k_client.html#a6d2341901c83e45f853c077e60f1fa33">tone</a>(uint16_t freq, bool autoStart=true)</td><td class="entry"><a class="el" href="class_a_f_s_k_client.html">AFSKClient</a></td><td class="entry"></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
263
class_a_f_s_k_client.html
Normal file
263
class_a_f_s_k_client.html
Normal file
|
|
@ -0,0 +1,263 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: AFSKClient Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_a_f_s_k_client.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="#friends">Friends</a> |
|
||||
<a href="class_a_f_s_k_client-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">AFSKClient Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Client for audio-based transmissions. Requires Arduino <a class="el" href="class_a_f_s_k_client.html#a6d2341901c83e45f853c077e60f1fa33" title="Start transmitting audio tone. ">tone()</a> function, and a module capable of direct mode transmission using DIO pins.
|
||||
<a href="class_a_f_s_k_client.html#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="_a_f_s_k_8h_source.html">AFSK.h</a>></code></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:acfe53917bcba7f79611e01865c42fefd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_f_s_k_client.html#acfe53917bcba7f79611e01865c42fefd">AFSKClient</a> (<a class="el" href="class_physical_layer.html">PhysicalLayer</a> *phy, RADIOLIB_PIN_TYPE pin)</td></tr>
|
||||
<tr class="memdesc:acfe53917bcba7f79611e01865c42fefd"><td class="mdescLeft"> </td><td class="mdescRight">Default contructor. <a href="#acfe53917bcba7f79611e01865c42fefd">More...</a><br /></td></tr>
|
||||
<tr class="separator:acfe53917bcba7f79611e01865c42fefd"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6d2341901c83e45f853c077e60f1fa33"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_f_s_k_client.html#a6d2341901c83e45f853c077e60f1fa33">tone</a> (uint16_t freq, bool autoStart=true)</td></tr>
|
||||
<tr class="memdesc:a6d2341901c83e45f853c077e60f1fa33"><td class="mdescLeft"> </td><td class="mdescRight">Start transmitting audio tone. <a href="#a6d2341901c83e45f853c077e60f1fa33">More...</a><br /></td></tr>
|
||||
<tr class="separator:a6d2341901c83e45f853c077e60f1fa33"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ade91356bb158bbc820d28855dd5818d1"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_f_s_k_client.html#ade91356bb158bbc820d28855dd5818d1">noTone</a> ()</td></tr>
|
||||
<tr class="memdesc:ade91356bb158bbc820d28855dd5818d1"><td class="mdescLeft"> </td><td class="mdescRight">Stops transmitting audio tone. <a href="#ade91356bb158bbc820d28855dd5818d1">More...</a><br /></td></tr>
|
||||
<tr class="separator:ade91356bb158bbc820d28855dd5818d1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
||||
Friends</h2></td></tr>
|
||||
<tr class="memitem:a018393f703a257e39cd263cccf4ffad5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a018393f703a257e39cd263cccf4ffad5"></a>
|
||||
class </td><td class="memItemRight" valign="bottom"><b>RTTYClient</b></td></tr>
|
||||
<tr class="separator:a018393f703a257e39cd263cccf4ffad5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ae5c5757c553100373984a416b6c3690a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae5c5757c553100373984a416b6c3690a"></a>
|
||||
class </td><td class="memItemRight" valign="bottom"><b>MorseClient</b></td></tr>
|
||||
<tr class="separator:ae5c5757c553100373984a416b6c3690a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:afeb005bab389f137def61f1acc3714d3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afeb005bab389f137def61f1acc3714d3"></a>
|
||||
class </td><td class="memItemRight" valign="bottom"><b>HellClient</b></td></tr>
|
||||
<tr class="separator:afeb005bab389f137def61f1acc3714d3"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ae8dd4f2f60ef4fd1fa1868a7a630ab20"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae8dd4f2f60ef4fd1fa1868a7a630ab20"></a>
|
||||
class </td><td class="memItemRight" valign="bottom"><b>SSTVClient</b></td></tr>
|
||||
<tr class="separator:ae8dd4f2f60ef4fd1fa1868a7a630ab20"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0012621c1414f4c7573e961b57884a5b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0012621c1414f4c7573e961b57884a5b"></a>
|
||||
class </td><td class="memItemRight" valign="bottom"><b>AX25Client</b></td></tr>
|
||||
<tr class="separator:a0012621c1414f4c7573e961b57884a5b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Client for audio-based transmissions. Requires Arduino <a class="el" href="class_a_f_s_k_client.html#a6d2341901c83e45f853c077e60f1fa33" title="Start transmitting audio tone. ">tone()</a> function, and a module capable of direct mode transmission using DIO pins. </p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="acfe53917bcba7f79611e01865c42fefd"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">AFSKClient::AFSKClient </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="class_physical_layer.html">PhysicalLayer</a> * </td>
|
||||
<td class="paramname"><em>phy</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">RADIOLIB_PIN_TYPE </td>
|
||||
<td class="paramname"><em>pin</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Default contructor. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">phy</td><td>Pointer to the wireless module providing <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN...">PhysicalLayer</a> communication.</td></tr>
|
||||
<tr><td class="paramname">pin</td><td>The pin that will be used for audio output. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a class="anchor" id="ade91356bb158bbc820d28855dd5818d1"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t AFSKClient::noTone </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Stops transmitting audio tone. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a6d2341901c83e45f853c077e60f1fa33"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t AFSKClient::tone </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint16_t </td>
|
||||
<td class="paramname"><em>freq</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>autoStart</em> = <code>true</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Start transmitting audio tone. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">freq</td><td>Frequency of the tone in Hz.</td></tr>
|
||||
<tr><td class="paramname">autoStart</td><td>Whether to automatically enter transmission mode. Defaults to true.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||
<li>src/protocols/AFSK/<a class="el" href="_a_f_s_k_8h_source.html">AFSK.h</a></li>
|
||||
<li>src/protocols/AFSK/AFSK.cpp</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="class_a_f_s_k_client.html">AFSKClient</a></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
11
class_a_f_s_k_client.js
Normal file
11
class_a_f_s_k_client.js
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
var class_a_f_s_k_client =
|
||||
[
|
||||
[ "AFSKClient", "class_a_f_s_k_client.html#acfe53917bcba7f79611e01865c42fefd", null ],
|
||||
[ "noTone", "class_a_f_s_k_client.html#ade91356bb158bbc820d28855dd5818d1", null ],
|
||||
[ "tone", "class_a_f_s_k_client.html#a6d2341901c83e45f853c077e60f1fa33", null ],
|
||||
[ "AX25Client", "class_a_f_s_k_client.html#a0012621c1414f4c7573e961b57884a5b", null ],
|
||||
[ "HellClient", "class_a_f_s_k_client.html#afeb005bab389f137def61f1acc3714d3", null ],
|
||||
[ "MorseClient", "class_a_f_s_k_client.html#ae5c5757c553100373984a416b6c3690a", null ],
|
||||
[ "RTTYClient", "class_a_f_s_k_client.html#a018393f703a257e39cd263cccf4ffad5", null ],
|
||||
[ "SSTVClient", "class_a_f_s_k_client.html#ae8dd4f2f60ef4fd1fa1868a7a630ab20", null ]
|
||||
];
|
||||
133
class_a_x25_client-members.html
Normal file
133
class_a_x25_client-members.html
Normal file
|
|
@ -0,0 +1,133 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: Member List</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_a_x25_client.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">AX25Client Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_a_x25_client.html">AX25Client</a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_a_x25_client.html#ab074563d4d22a42d5ea9ad1693d6f373">AX25Client</a>(PhysicalLayer *phy)</td><td class="entry"><a class="el" href="class_a_x25_client.html">AX25Client</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_a_x25_client.html#a6e81e629817cdf1b377e4b4f7e4d6520">AX25Client</a>(AFSKClient *audio)</td><td class="entry"><a class="el" href="class_a_x25_client.html">AX25Client</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_a_x25_client.html#a38be2b9385e4804339b3e4b57b90c2ca">begin</a>(const char *srcCallsign, uint8_t srcSSID=0x00, uint8_t preambleLen=8)</td><td class="entry"><a class="el" href="class_a_x25_client.html">AX25Client</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_a_x25_client.html#a341db993853c6817a8f6c7087ead0ba6">sendFrame</a>(AX25Frame *frame)</td><td class="entry"><a class="el" href="class_a_x25_client.html">AX25Client</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_a_x25_client.html#a985790943f3f3e06a2dfdd36977d0b98">transmit</a>(const char *str, const char *destCallsign, uint8_t destSSID=0x00)</td><td class="entry"><a class="el" href="class_a_x25_client.html">AX25Client</a></td><td class="entry"></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
336
class_a_x25_client.html
Normal file
336
class_a_x25_client.html
Normal file
|
|
@ -0,0 +1,336 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: AX25Client Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_a_x25_client.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="class_a_x25_client-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">AX25Client Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Client for AX25 communication.
|
||||
<a href="class_a_x25_client.html#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="_a_x25_8h_source.html">AX25.h</a>></code></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:ab074563d4d22a42d5ea9ad1693d6f373"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_client.html#ab074563d4d22a42d5ea9ad1693d6f373">AX25Client</a> (<a class="el" href="class_physical_layer.html">PhysicalLayer</a> *phy)</td></tr>
|
||||
<tr class="memdesc:ab074563d4d22a42d5ea9ad1693d6f373"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for 2-FSK mode. <a href="#ab074563d4d22a42d5ea9ad1693d6f373">More...</a><br /></td></tr>
|
||||
<tr class="separator:ab074563d4d22a42d5ea9ad1693d6f373"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6e81e629817cdf1b377e4b4f7e4d6520"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_client.html#a6e81e629817cdf1b377e4b4f7e4d6520">AX25Client</a> (<a class="el" href="class_a_f_s_k_client.html">AFSKClient</a> *audio)</td></tr>
|
||||
<tr class="memdesc:a6e81e629817cdf1b377e4b4f7e4d6520"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for AFSK mode. <a href="#a6e81e629817cdf1b377e4b4f7e4d6520">More...</a><br /></td></tr>
|
||||
<tr class="separator:a6e81e629817cdf1b377e4b4f7e4d6520"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a38be2b9385e4804339b3e4b57b90c2ca"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_client.html#a38be2b9385e4804339b3e4b57b90c2ca">begin</a> (const char *srcCallsign, uint8_t srcSSID=0x00, uint8_t preambleLen=8)</td></tr>
|
||||
<tr class="memdesc:a38be2b9385e4804339b3e4b57b90c2ca"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. <a href="#a38be2b9385e4804339b3e4b57b90c2ca">More...</a><br /></td></tr>
|
||||
<tr class="separator:a38be2b9385e4804339b3e4b57b90c2ca"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a985790943f3f3e06a2dfdd36977d0b98"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_client.html#a985790943f3f3e06a2dfdd36977d0b98">transmit</a> (const char *str, const char *destCallsign, uint8_t destSSID=0x00)</td></tr>
|
||||
<tr class="memdesc:a985790943f3f3e06a2dfdd36977d0b98"><td class="mdescLeft"> </td><td class="mdescRight">Transmit unnumbered information (UI) frame. <a href="#a985790943f3f3e06a2dfdd36977d0b98">More...</a><br /></td></tr>
|
||||
<tr class="separator:a985790943f3f3e06a2dfdd36977d0b98"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a341db993853c6817a8f6c7087ead0ba6"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_client.html#a341db993853c6817a8f6c7087ead0ba6">sendFrame</a> (<a class="el" href="class_a_x25_frame.html">AX25Frame</a> *frame)</td></tr>
|
||||
<tr class="memdesc:a341db993853c6817a8f6c7087ead0ba6"><td class="mdescLeft"> </td><td class="mdescRight">Transmit arbitrary AX.25 frame. <a href="#a341db993853c6817a8f6c7087ead0ba6">More...</a><br /></td></tr>
|
||||
<tr class="separator:a341db993853c6817a8f6c7087ead0ba6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Client for AX25 communication. </p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="ab074563d4d22a42d5ea9ad1693d6f373"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">AX25Client::AX25Client </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="class_physical_layer.html">PhysicalLayer</a> * </td>
|
||||
<td class="paramname"><em>phy</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Constructor for 2-FSK mode. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">phy</td><td>Pointer to the wireless module providing <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN...">PhysicalLayer</a> communication. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a6e81e629817cdf1b377e4b4f7e4d6520"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">AX25Client::AX25Client </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="class_a_f_s_k_client.html">AFSKClient</a> * </td>
|
||||
<td class="paramname"><em>audio</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Constructor for AFSK mode. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">audio</td><td>Pointer to the AFSK instance providing audio. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a class="anchor" id="a38be2b9385e4804339b3e4b57b90c2ca"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t AX25Client::begin </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>srcCallsign</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>srcSSID</em> = <code>0x00</code>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>preambleLen</em> = <code>8</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Initialization method. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">srcCallsign</td><td>Callsign of the source station.</td></tr>
|
||||
<tr><td class="paramname">srcSSID</td><td>4-bit SSID of the source station (in case there are more stations with the same callsign). Defaults to 0.</td></tr>
|
||||
<tr><td class="paramname">preambleLen</td><td>Number of "preamble" bytes (AX25_FLAG) sent ahead of the actual AX.25 frame. Does not include the first AX25_FLAG byte, which is considered part of the frame. Defaults to 8.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a341db993853c6817a8f6c7087ead0ba6"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t AX25Client::sendFrame </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="class_a_x25_frame.html">AX25Frame</a> * </td>
|
||||
<td class="paramname"><em>frame</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Transmit arbitrary AX.25 frame. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">frame</td><td>Frame to be sent.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a985790943f3f3e06a2dfdd36977d0b98"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t AX25Client::transmit </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>str</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>destCallsign</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>destSSID</em> = <code>0x00</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Transmit unnumbered information (UI) frame. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">str</td><td>Data to be sent.</td></tr>
|
||||
<tr><td class="paramname">destCallsign</td><td>Callsign of the destination station.</td></tr>
|
||||
<tr><td class="paramname">destSSID</td><td>4-bit SSID of the destination station (in case there are more stations with the same callsign). Defaults to 0.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||
<li>src/protocols/AX25/<a class="el" href="_a_x25_8h_source.html">AX25.h</a></li>
|
||||
<li>src/protocols/AX25/AX25.cpp</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="class_a_x25_client.html">AX25Client</a></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
8
class_a_x25_client.js
Normal file
8
class_a_x25_client.js
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
var class_a_x25_client =
|
||||
[
|
||||
[ "AX25Client", "class_a_x25_client.html#ab074563d4d22a42d5ea9ad1693d6f373", null ],
|
||||
[ "AX25Client", "class_a_x25_client.html#a6e81e629817cdf1b377e4b4f7e4d6520", null ],
|
||||
[ "begin", "class_a_x25_client.html#a38be2b9385e4804339b3e4b57b90c2ca", null ],
|
||||
[ "sendFrame", "class_a_x25_client.html#a341db993853c6817a8f6c7087ead0ba6", null ],
|
||||
[ "transmit", "class_a_x25_client.html#a985790943f3f3e06a2dfdd36977d0b98", null ]
|
||||
];
|
||||
150
class_a_x25_frame-members.html
Normal file
150
class_a_x25_frame-members.html
Normal file
|
|
@ -0,0 +1,150 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: Member List</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_a_x25_frame.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">AX25Frame Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_a_x25_frame.html">AX25Frame</a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_a_x25_frame.html#a138d97d90a371bef7ebd86cce1cc4979">AX25Frame</a>(const char *destCallsign, uint8_t destSSID, const char *srcCallsign, uint8_t srcSSID, uint8_t control)</td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_a_x25_frame.html#a60e1b318d6e4b9299a4eab72e40877fc">AX25Frame</a>(const char *destCallsign, uint8_t destSSID, const char *srcCallsign, uint8_t srcSSID, uint8_t control, uint8_t protocolID, const char *info)</td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_a_x25_frame.html#a3899b8698d772b8285629d6a4f2a642a">AX25Frame</a>(const char *destCallsign, uint8_t destSSID, const char *srcCallsign, uint8_t srcSSID, uint8_t control, uint8_t protocolID, uint8_t *info, uint16_t infoLen)</td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_a_x25_frame.html#a25b83cc9c281d2758165833fe238fe0e">AX25Frame</a>(const AX25Frame &frame)</td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_a_x25_frame.html#a5b196079b539dc417ca65dd4ad622f8f">control</a></td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_a_x25_frame.html#a78e72871e3a9370675318876f4a4b432">destCallsign</a></td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_a_x25_frame.html#af62935e56dc24bca5d2e2aeb932b63f8">destSSID</a></td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_a_x25_frame.html#aa82f006b84b71b9c5d036a4946a65988">info</a></td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_a_x25_frame.html#a75e8ad33c2540ede5bb130050f6ffc41">infoLen</a></td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_a_x25_frame.html#ad27453a838ba90f917a1a9853358bb9a">numRepeaters</a></td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_a_x25_frame.html#a52e7e5f6f48c3e62544721d2a5e00640">operator=</a>(const AX25Frame &frame)</td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_a_x25_frame.html#aa8895fea37220c82f68bd320331595c8">protocolID</a></td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_a_x25_frame.html#adce5294af25f09df752997d33ac0e87f">rcvSeqNumber</a></td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_a_x25_frame.html#a29eb08c9e72bbaced8d37dcb2343ee94">repeaterCallsigns</a></td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_a_x25_frame.html#a5b63c6b6f69e0ac47ba9230ad39c6830">repeaterSSIDs</a></td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_a_x25_frame.html#a4c0fdf148d3b779d48441d45af87add2">sendSeqNumber</a></td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_a_x25_frame.html#a4696a8eede8bac85f0ee6de6fee79ea8">setRecvSequence</a>(uint8_t seqNumber)</td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_a_x25_frame.html#a7f2d9f4f1ba29d0fd9f9f3f2cf03f797">setRepeaters</a>(char **repeaterCallsigns, uint8_t *repeaterSSIDs, uint8_t numRepeaters)</td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_a_x25_frame.html#a026e9b96fa69018590fcf6842df8be70">setSendSequence</a>(uint8_t seqNumber)</td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_a_x25_frame.html#ab76eaa8445e7953059a46bb78082dd5a">srcCallsign</a></td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_a_x25_frame.html#a50c63276facf8126f0f8555b1fc6b2c9">srcSSID</a></td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_a_x25_frame.html#ab84a13f720ada37aee6201a560d9dc5a">~AX25Frame</a>()</td><td class="entry"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></td><td class="entry"></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
572
class_a_x25_frame.html
Normal file
572
class_a_x25_frame.html
Normal file
|
|
@ -0,0 +1,572 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: AX25Frame Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_a_x25_frame.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="#pub-attribs">Public Attributes</a> |
|
||||
<a href="class_a_x25_frame-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">AX25Frame Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Abstraction of AX.25 frame format.
|
||||
<a href="class_a_x25_frame.html#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="_a_x25_8h_source.html">AX25.h</a>></code></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a138d97d90a371bef7ebd86cce1cc4979"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a138d97d90a371bef7ebd86cce1cc4979">AX25Frame</a> (const char *<a class="el" href="class_a_x25_frame.html#a78e72871e3a9370675318876f4a4b432">destCallsign</a>, uint8_t <a class="el" href="class_a_x25_frame.html#af62935e56dc24bca5d2e2aeb932b63f8">destSSID</a>, const char *<a class="el" href="class_a_x25_frame.html#ab76eaa8445e7953059a46bb78082dd5a">srcCallsign</a>, uint8_t <a class="el" href="class_a_x25_frame.html#a50c63276facf8126f0f8555b1fc6b2c9">srcSSID</a>, uint8_t <a class="el" href="class_a_x25_frame.html#a5b196079b539dc417ca65dd4ad622f8f">control</a>)</td></tr>
|
||||
<tr class="memdesc:a138d97d90a371bef7ebd86cce1cc4979"><td class="mdescLeft"> </td><td class="mdescRight">Overloaded constructor, for frames without info field. <a href="#a138d97d90a371bef7ebd86cce1cc4979">More...</a><br /></td></tr>
|
||||
<tr class="separator:a138d97d90a371bef7ebd86cce1cc4979"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a60e1b318d6e4b9299a4eab72e40877fc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a60e1b318d6e4b9299a4eab72e40877fc">AX25Frame</a> (const char *<a class="el" href="class_a_x25_frame.html#a78e72871e3a9370675318876f4a4b432">destCallsign</a>, uint8_t <a class="el" href="class_a_x25_frame.html#af62935e56dc24bca5d2e2aeb932b63f8">destSSID</a>, const char *<a class="el" href="class_a_x25_frame.html#ab76eaa8445e7953059a46bb78082dd5a">srcCallsign</a>, uint8_t <a class="el" href="class_a_x25_frame.html#a50c63276facf8126f0f8555b1fc6b2c9">srcSSID</a>, uint8_t <a class="el" href="class_a_x25_frame.html#a5b196079b539dc417ca65dd4ad622f8f">control</a>, uint8_t <a class="el" href="class_a_x25_frame.html#aa8895fea37220c82f68bd320331595c8">protocolID</a>, const char *<a class="el" href="class_a_x25_frame.html#aa82f006b84b71b9c5d036a4946a65988">info</a>)</td></tr>
|
||||
<tr class="memdesc:a60e1b318d6e4b9299a4eab72e40877fc"><td class="mdescLeft"> </td><td class="mdescRight">Overloaded constructor, for frames with C-string info field. <a href="#a60e1b318d6e4b9299a4eab72e40877fc">More...</a><br /></td></tr>
|
||||
<tr class="separator:a60e1b318d6e4b9299a4eab72e40877fc"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a3899b8698d772b8285629d6a4f2a642a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a3899b8698d772b8285629d6a4f2a642a">AX25Frame</a> (const char *<a class="el" href="class_a_x25_frame.html#a78e72871e3a9370675318876f4a4b432">destCallsign</a>, uint8_t <a class="el" href="class_a_x25_frame.html#af62935e56dc24bca5d2e2aeb932b63f8">destSSID</a>, const char *<a class="el" href="class_a_x25_frame.html#ab76eaa8445e7953059a46bb78082dd5a">srcCallsign</a>, uint8_t <a class="el" href="class_a_x25_frame.html#a50c63276facf8126f0f8555b1fc6b2c9">srcSSID</a>, uint8_t <a class="el" href="class_a_x25_frame.html#a5b196079b539dc417ca65dd4ad622f8f">control</a>, uint8_t <a class="el" href="class_a_x25_frame.html#aa8895fea37220c82f68bd320331595c8">protocolID</a>, uint8_t *<a class="el" href="class_a_x25_frame.html#aa82f006b84b71b9c5d036a4946a65988">info</a>, uint16_t <a class="el" href="class_a_x25_frame.html#a75e8ad33c2540ede5bb130050f6ffc41">infoLen</a>)</td></tr>
|
||||
<tr class="memdesc:a3899b8698d772b8285629d6a4f2a642a"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a3899b8698d772b8285629d6a4f2a642a">More...</a><br /></td></tr>
|
||||
<tr class="separator:a3899b8698d772b8285629d6a4f2a642a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a25b83cc9c281d2758165833fe238fe0e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a25b83cc9c281d2758165833fe238fe0e">AX25Frame</a> (const <a class="el" href="class_a_x25_frame.html">AX25Frame</a> &frame)</td></tr>
|
||||
<tr class="memdesc:a25b83cc9c281d2758165833fe238fe0e"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a25b83cc9c281d2758165833fe238fe0e">More...</a><br /></td></tr>
|
||||
<tr class="separator:a25b83cc9c281d2758165833fe238fe0e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ab84a13f720ada37aee6201a560d9dc5a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab84a13f720ada37aee6201a560d9dc5a"></a>
|
||||
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#ab84a13f720ada37aee6201a560d9dc5a">~AX25Frame</a> ()</td></tr>
|
||||
<tr class="memdesc:ab84a13f720ada37aee6201a560d9dc5a"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br /></td></tr>
|
||||
<tr class="separator:ab84a13f720ada37aee6201a560d9dc5a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a52e7e5f6f48c3e62544721d2a5e00640"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_a_x25_frame.html">AX25Frame</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a52e7e5f6f48c3e62544721d2a5e00640">operator=</a> (const <a class="el" href="class_a_x25_frame.html">AX25Frame</a> &frame)</td></tr>
|
||||
<tr class="memdesc:a52e7e5f6f48c3e62544721d2a5e00640"><td class="mdescLeft"> </td><td class="mdescRight">Overload for assignment operator. <a href="#a52e7e5f6f48c3e62544721d2a5e00640">More...</a><br /></td></tr>
|
||||
<tr class="separator:a52e7e5f6f48c3e62544721d2a5e00640"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a7f2d9f4f1ba29d0fd9f9f3f2cf03f797"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a7f2d9f4f1ba29d0fd9f9f3f2cf03f797">setRepeaters</a> (char **<a class="el" href="class_a_x25_frame.html#a29eb08c9e72bbaced8d37dcb2343ee94">repeaterCallsigns</a>, uint8_t *<a class="el" href="class_a_x25_frame.html#a5b63c6b6f69e0ac47ba9230ad39c6830">repeaterSSIDs</a>, uint8_t <a class="el" href="class_a_x25_frame.html#ad27453a838ba90f917a1a9853358bb9a">numRepeaters</a>)</td></tr>
|
||||
<tr class="memdesc:a7f2d9f4f1ba29d0fd9f9f3f2cf03f797"><td class="mdescLeft"> </td><td class="mdescRight">Method to set the repeater callsigns and SSIDs. <a href="#a7f2d9f4f1ba29d0fd9f9f3f2cf03f797">More...</a><br /></td></tr>
|
||||
<tr class="separator:a7f2d9f4f1ba29d0fd9f9f3f2cf03f797"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a4696a8eede8bac85f0ee6de6fee79ea8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a4696a8eede8bac85f0ee6de6fee79ea8">setRecvSequence</a> (uint8_t seqNumber)</td></tr>
|
||||
<tr class="memdesc:a4696a8eede8bac85f0ee6de6fee79ea8"><td class="mdescLeft"> </td><td class="mdescRight">Method to set receive sequence number. <a href="#a4696a8eede8bac85f0ee6de6fee79ea8">More...</a><br /></td></tr>
|
||||
<tr class="separator:a4696a8eede8bac85f0ee6de6fee79ea8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a026e9b96fa69018590fcf6842df8be70"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a026e9b96fa69018590fcf6842df8be70">setSendSequence</a> (uint8_t seqNumber)</td></tr>
|
||||
<tr class="memdesc:a026e9b96fa69018590fcf6842df8be70"><td class="mdescLeft"> </td><td class="mdescRight">Method to set send sequence number. <a href="#a026e9b96fa69018590fcf6842df8be70">More...</a><br /></td></tr>
|
||||
<tr class="separator:a026e9b96fa69018590fcf6842df8be70"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
||||
Public Attributes</h2></td></tr>
|
||||
<tr class="memitem:a78e72871e3a9370675318876f4a4b432"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78e72871e3a9370675318876f4a4b432"></a>
|
||||
char </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a78e72871e3a9370675318876f4a4b432">destCallsign</a> [AX25_MAX_CALLSIGN_LEN+1]</td></tr>
|
||||
<tr class="memdesc:a78e72871e3a9370675318876f4a4b432"><td class="mdescLeft"> </td><td class="mdescRight">Callsign of the destination station. <br /></td></tr>
|
||||
<tr class="separator:a78e72871e3a9370675318876f4a4b432"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:af62935e56dc24bca5d2e2aeb932b63f8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af62935e56dc24bca5d2e2aeb932b63f8"></a>
|
||||
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#af62935e56dc24bca5d2e2aeb932b63f8">destSSID</a></td></tr>
|
||||
<tr class="memdesc:af62935e56dc24bca5d2e2aeb932b63f8"><td class="mdescLeft"> </td><td class="mdescRight">SSID of the destination station. <br /></td></tr>
|
||||
<tr class="separator:af62935e56dc24bca5d2e2aeb932b63f8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ab76eaa8445e7953059a46bb78082dd5a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab76eaa8445e7953059a46bb78082dd5a"></a>
|
||||
char </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#ab76eaa8445e7953059a46bb78082dd5a">srcCallsign</a> [AX25_MAX_CALLSIGN_LEN+1]</td></tr>
|
||||
<tr class="memdesc:ab76eaa8445e7953059a46bb78082dd5a"><td class="mdescLeft"> </td><td class="mdescRight">Callsign of the source station. <br /></td></tr>
|
||||
<tr class="separator:ab76eaa8445e7953059a46bb78082dd5a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a50c63276facf8126f0f8555b1fc6b2c9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a50c63276facf8126f0f8555b1fc6b2c9"></a>
|
||||
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a50c63276facf8126f0f8555b1fc6b2c9">srcSSID</a></td></tr>
|
||||
<tr class="memdesc:a50c63276facf8126f0f8555b1fc6b2c9"><td class="mdescLeft"> </td><td class="mdescRight">SSID of the source station. <br /></td></tr>
|
||||
<tr class="separator:a50c63276facf8126f0f8555b1fc6b2c9"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ad27453a838ba90f917a1a9853358bb9a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad27453a838ba90f917a1a9853358bb9a"></a>
|
||||
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#ad27453a838ba90f917a1a9853358bb9a">numRepeaters</a></td></tr>
|
||||
<tr class="memdesc:ad27453a838ba90f917a1a9853358bb9a"><td class="mdescLeft"> </td><td class="mdescRight">Number of repeaters to be used. <br /></td></tr>
|
||||
<tr class="separator:ad27453a838ba90f917a1a9853358bb9a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a5b196079b539dc417ca65dd4ad622f8f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b196079b539dc417ca65dd4ad622f8f"></a>
|
||||
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a5b196079b539dc417ca65dd4ad622f8f">control</a></td></tr>
|
||||
<tr class="memdesc:a5b196079b539dc417ca65dd4ad622f8f"><td class="mdescLeft"> </td><td class="mdescRight">The control field. <br /></td></tr>
|
||||
<tr class="separator:a5b196079b539dc417ca65dd4ad622f8f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa8895fea37220c82f68bd320331595c8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa8895fea37220c82f68bd320331595c8"></a>
|
||||
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#aa8895fea37220c82f68bd320331595c8">protocolID</a></td></tr>
|
||||
<tr class="memdesc:aa8895fea37220c82f68bd320331595c8"><td class="mdescLeft"> </td><td class="mdescRight">The protocol identifier (PID) field. <br /></td></tr>
|
||||
<tr class="separator:aa8895fea37220c82f68bd320331595c8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a75e8ad33c2540ede5bb130050f6ffc41"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75e8ad33c2540ede5bb130050f6ffc41"></a>
|
||||
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a75e8ad33c2540ede5bb130050f6ffc41">infoLen</a></td></tr>
|
||||
<tr class="memdesc:a75e8ad33c2540ede5bb130050f6ffc41"><td class="mdescLeft"> </td><td class="mdescRight">Number of bytes in the information field. <br /></td></tr>
|
||||
<tr class="separator:a75e8ad33c2540ede5bb130050f6ffc41"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:adce5294af25f09df752997d33ac0e87f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adce5294af25f09df752997d33ac0e87f"></a>
|
||||
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#adce5294af25f09df752997d33ac0e87f">rcvSeqNumber</a></td></tr>
|
||||
<tr class="memdesc:adce5294af25f09df752997d33ac0e87f"><td class="mdescLeft"> </td><td class="mdescRight">Receive sequence number. <br /></td></tr>
|
||||
<tr class="separator:adce5294af25f09df752997d33ac0e87f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a4c0fdf148d3b779d48441d45af87add2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4c0fdf148d3b779d48441d45af87add2"></a>
|
||||
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a4c0fdf148d3b779d48441d45af87add2">sendSeqNumber</a></td></tr>
|
||||
<tr class="memdesc:a4c0fdf148d3b779d48441d45af87add2"><td class="mdescLeft"> </td><td class="mdescRight">Send sequence number. <br /></td></tr>
|
||||
<tr class="separator:a4c0fdf148d3b779d48441d45af87add2"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa82f006b84b71b9c5d036a4946a65988"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa82f006b84b71b9c5d036a4946a65988"></a>
|
||||
uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#aa82f006b84b71b9c5d036a4946a65988">info</a></td></tr>
|
||||
<tr class="memdesc:aa82f006b84b71b9c5d036a4946a65988"><td class="mdescLeft"> </td><td class="mdescRight">The info field. <br /></td></tr>
|
||||
<tr class="separator:aa82f006b84b71b9c5d036a4946a65988"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a29eb08c9e72bbaced8d37dcb2343ee94"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29eb08c9e72bbaced8d37dcb2343ee94"></a>
|
||||
char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a29eb08c9e72bbaced8d37dcb2343ee94">repeaterCallsigns</a></td></tr>
|
||||
<tr class="memdesc:a29eb08c9e72bbaced8d37dcb2343ee94"><td class="mdescLeft"> </td><td class="mdescRight">Array of repeater callsigns. <br /></td></tr>
|
||||
<tr class="separator:a29eb08c9e72bbaced8d37dcb2343ee94"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a5b63c6b6f69e0ac47ba9230ad39c6830"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b63c6b6f69e0ac47ba9230ad39c6830"></a>
|
||||
uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a5b63c6b6f69e0ac47ba9230ad39c6830">repeaterSSIDs</a></td></tr>
|
||||
<tr class="memdesc:a5b63c6b6f69e0ac47ba9230ad39c6830"><td class="mdescLeft"> </td><td class="mdescRight">Array of repeater SSIDs. <br /></td></tr>
|
||||
<tr class="separator:a5b63c6b6f69e0ac47ba9230ad39c6830"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Abstraction of AX.25 frame format. </p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="a138d97d90a371bef7ebd86cce1cc4979"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">AX25Frame::AX25Frame </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>destCallsign</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>destSSID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>srcCallsign</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>srcSSID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>control</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Overloaded constructor, for frames without info field. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">destCallsign</td><td>Callsign of the destination station.</td></tr>
|
||||
<tr><td class="paramname">destSSID</td><td>SSID of the destination station.</td></tr>
|
||||
<tr><td class="paramname">srcCallsign</td><td>Callsign of the source station.</td></tr>
|
||||
<tr><td class="paramname">srcSSID</td><td>SSID of the source station.</td></tr>
|
||||
<tr><td class="paramname">control</td><td>The control field. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a60e1b318d6e4b9299a4eab72e40877fc"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">AX25Frame::AX25Frame </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>destCallsign</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>destSSID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>srcCallsign</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>srcSSID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>control</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>protocolID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>info</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Overloaded constructor, for frames with C-string info field. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">destCallsign</td><td>Callsign of the destination station.</td></tr>
|
||||
<tr><td class="paramname">destSSID</td><td>SSID of the destination station.</td></tr>
|
||||
<tr><td class="paramname">srcCallsign</td><td>Callsign of the source station.</td></tr>
|
||||
<tr><td class="paramname">srcSSID</td><td>SSID of the source station.</td></tr>
|
||||
<tr><td class="paramname">control</td><td>The control field.</td></tr>
|
||||
<tr><td class="paramname">protocolID</td><td>The protocol identifier (PID) field. Set to zero if the frame doesn't have this field.</td></tr>
|
||||
<tr><td class="paramname">info</td><td>Information field, in the form of null-terminated C-string. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a3899b8698d772b8285629d6a4f2a642a"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">AX25Frame::AX25Frame </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>destCallsign</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>destSSID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>srcCallsign</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>srcSSID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>control</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>protocolID</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t * </td>
|
||||
<td class="paramname"><em>info</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint16_t </td>
|
||||
<td class="paramname"><em>infoLen</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Default constructor. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">destCallsign</td><td>Callsign of the destination station.</td></tr>
|
||||
<tr><td class="paramname">destSSID</td><td>SSID of the destination station.</td></tr>
|
||||
<tr><td class="paramname">srcCallsign</td><td>Callsign of the source station.</td></tr>
|
||||
<tr><td class="paramname">srcSSID</td><td>SSID of the source station.</td></tr>
|
||||
<tr><td class="paramname">control</td><td>The control field.</td></tr>
|
||||
<tr><td class="paramname">protocolID</td><td>The protocol identifier (PID) field. Set to zero if the frame doesn't have this field.</td></tr>
|
||||
<tr><td class="paramname">info</td><td>Information field, in the form of arbitrary binary buffer.</td></tr>
|
||||
<tr><td class="paramname">infoLen</td><td>Number of bytes in the information field. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a25b83cc9c281d2758165833fe238fe0e"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">AX25Frame::AX25Frame </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const <a class="el" href="class_a_x25_frame.html">AX25Frame</a> & </td>
|
||||
<td class="paramname"><em>frame</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Copy constructor. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">frame</td><td><a class="el" href="class_a_x25_frame.html" title="Abstraction of AX.25 frame format. ">AX25Frame</a> instance to copy. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a class="anchor" id="a52e7e5f6f48c3e62544721d2a5e00640"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="class_a_x25_frame.html">AX25Frame</a> & AX25Frame::operator= </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const <a class="el" href="class_a_x25_frame.html">AX25Frame</a> & </td>
|
||||
<td class="paramname"><em>frame</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Overload for assignment operator. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">frame</td><td>rvalue <a class="el" href="class_a_x25_frame.html" title="Abstraction of AX.25 frame format. ">AX25Frame</a>. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a4696a8eede8bac85f0ee6de6fee79ea8"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void AX25Frame::setRecvSequence </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>seqNumber</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Method to set receive sequence number. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">seqNumber</td><td>Sequence number to set, 0 to 7. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a7f2d9f4f1ba29d0fd9f9f3f2cf03f797"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t AX25Frame::setRepeaters </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">char ** </td>
|
||||
<td class="paramname"><em>repeaterCallsigns</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t * </td>
|
||||
<td class="paramname"><em>repeaterSSIDs</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>numRepeaters</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Method to set the repeater callsigns and SSIDs. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">repeaterCallsigns</td><td>Array of repeater callsigns in the form of null-terminated C-strings.</td></tr>
|
||||
<tr><td class="paramname">repeaterSSIDs</td><td>Array of repeater SSIDs.</td></tr>
|
||||
<tr><td class="paramname">numRepeaters</td><td>Number of repeaters, maximum is 8.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a026e9b96fa69018590fcf6842df8be70"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void AX25Frame::setSendSequence </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>seqNumber</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Method to set send sequence number. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">seqNumber</td><td>Sequence number to set, 0 to 7. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||
<li>src/protocols/AX25/<a class="el" href="_a_x25_8h_source.html">AX25.h</a></li>
|
||||
<li>src/protocols/AX25/AX25.cpp</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
25
class_a_x25_frame.js
Normal file
25
class_a_x25_frame.js
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
var class_a_x25_frame =
|
||||
[
|
||||
[ "AX25Frame", "class_a_x25_frame.html#a138d97d90a371bef7ebd86cce1cc4979", null ],
|
||||
[ "AX25Frame", "class_a_x25_frame.html#a60e1b318d6e4b9299a4eab72e40877fc", null ],
|
||||
[ "AX25Frame", "class_a_x25_frame.html#a3899b8698d772b8285629d6a4f2a642a", null ],
|
||||
[ "AX25Frame", "class_a_x25_frame.html#a25b83cc9c281d2758165833fe238fe0e", null ],
|
||||
[ "~AX25Frame", "class_a_x25_frame.html#ab84a13f720ada37aee6201a560d9dc5a", null ],
|
||||
[ "operator=", "class_a_x25_frame.html#a52e7e5f6f48c3e62544721d2a5e00640", null ],
|
||||
[ "setRecvSequence", "class_a_x25_frame.html#a4696a8eede8bac85f0ee6de6fee79ea8", null ],
|
||||
[ "setRepeaters", "class_a_x25_frame.html#a7f2d9f4f1ba29d0fd9f9f3f2cf03f797", null ],
|
||||
[ "setSendSequence", "class_a_x25_frame.html#a026e9b96fa69018590fcf6842df8be70", null ],
|
||||
[ "control", "class_a_x25_frame.html#a5b196079b539dc417ca65dd4ad622f8f", null ],
|
||||
[ "destCallsign", "class_a_x25_frame.html#a78e72871e3a9370675318876f4a4b432", null ],
|
||||
[ "destSSID", "class_a_x25_frame.html#af62935e56dc24bca5d2e2aeb932b63f8", null ],
|
||||
[ "info", "class_a_x25_frame.html#aa82f006b84b71b9c5d036a4946a65988", null ],
|
||||
[ "infoLen", "class_a_x25_frame.html#a75e8ad33c2540ede5bb130050f6ffc41", null ],
|
||||
[ "numRepeaters", "class_a_x25_frame.html#ad27453a838ba90f917a1a9853358bb9a", null ],
|
||||
[ "protocolID", "class_a_x25_frame.html#aa8895fea37220c82f68bd320331595c8", null ],
|
||||
[ "rcvSeqNumber", "class_a_x25_frame.html#adce5294af25f09df752997d33ac0e87f", null ],
|
||||
[ "repeaterCallsigns", "class_a_x25_frame.html#a29eb08c9e72bbaced8d37dcb2343ee94", null ],
|
||||
[ "repeaterSSIDs", "class_a_x25_frame.html#a5b63c6b6f69e0ac47ba9230ad39c6830", null ],
|
||||
[ "sendSeqNumber", "class_a_x25_frame.html#a4c0fdf148d3b779d48441d45af87add2", null ],
|
||||
[ "srcCallsign", "class_a_x25_frame.html#ab76eaa8445e7953059a46bb78082dd5a", null ],
|
||||
[ "srcSSID", "class_a_x25_frame.html#a50c63276facf8126f0f8555b1fc6b2c9", null ]
|
||||
];
|
||||
175
class_c_c1101-members.html
Normal file
175
class_c_c1101-members.html
Normal file
|
|
@ -0,0 +1,175 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: Member List</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_c_c1101.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">CC1101 Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_c_c1101.html">CC1101</a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#adcf6b5c4e1a066d6b9be326a9ee04284">begin</a>(float freq=434.0, float br=48.0, float freqDev=48.0, float rxBw=135.0, int8_t power=10, uint8_t preambleLength=16)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#a6807e4254c4b55fa8d393b2bf8f2db3e">CC1101</a>(Module *module)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#ab5e6b3745f80cf61e1ced33303311df8">clearGdo0Action</a>()</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#ac7a8b1fe7d08dc6db20cf1569b0d37b4">clearGdo2Action</a>()</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#a9aee5df428d30b9c80b8a8700609a883">disableAddressFiltering</a>()</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#a4f2dc4176b62a0636636088e31b8e85b">disableSyncWordFiltering</a>(bool requireCarrierSense=false)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#a6fe55d0217bf5218865198ef8d6fdab4">enableSyncWordFiltering</a>(uint8_t maxErrBits=0, bool requireCarrierSense=false)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#a9335f1d5ccab7aab2357449002203810">fixedPacketLengthMode</a>(uint8_t len=CC1101_MAX_PACKET_LENGTH)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_physical_layer.html#ac48339cc9fc93931379903ab0c195e40">getFreqStep</a>() const </td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#af252f2c3c591289cb73089e51f0f967d">getLQI</a>() const </td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#a122281f6a915b77ee9dafc9926e731a0">getPacketLength</a>(bool update=true) override</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#af55b5ec0dd2d73bac6cb8a6d9862e6c1">getRSSI</a>() const </td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#a38f6978c757b0dd73e3ef98164a735a2">packetMode</a>()</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_physical_layer.html#a5e02457f1d519cf81b1590a182321c62">PhysicalLayer</a>(float freqStep, size_t maxPacketLength)</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#a8c79975a7bbe8a37f8214ecd1f69ba22">readData</a>(uint8_t *data, size_t len) override</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">PhysicalLayer::readData</a>(String &str, size_t len=0)</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#aedc1067d0334bb69ed5316146014097d">receive</a>(uint8_t *data, size_t len) override</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">PhysicalLayer::receive</a>(String &str, size_t len=0)</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#ab053c185330519d58f364790108d29ac">receiveDirect</a>() override</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#aa53427cabcda0778f287ed1d850bbe37">setBitRate</a>(float br)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#aafac40359c4a1bb01aae12da6b03be26">setCrcFiltering</a>(bool crcOn=true)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#adf96e77f25b7e256891601bef04f35a6">setDataShaping</a>(uint8_t sh) override</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#ab4b98eb6af33d006306bb7514ed216ea">setEncoding</a>(uint8_t encoding) override</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#a9592c023556c38c2b8066a23da96ae5e">setFrequency</a>(float freq)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#a0d69713b9f20c9de354c13c3167b18b3">setFrequencyDeviation</a>(float freqDev) override</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#a6dfd6a57cdbb3196ad021b152b0c65ed">setGdo0Action</a>(void(*func)(void), RADIOLIB_INTERRUPT_STATUS dir=FALLING)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#ac6338c2f5c937a12dac06069944ffb77">setGdo2Action</a>(void(*func)(void), RADIOLIB_INTERRUPT_STATUS dir=FALLING)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#a6e62914790f132816134fc68c2bb5eb8">setNodeAddress</a>(uint8_t nodeAddr, uint8_t numBroadcastAddrs=0)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#afa64d1ad4789d3146b38d14437234756">setOOK</a>(bool enableOOK)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#ac3ff8051af5ca50c349e02257f1a3bda">setOutputPower</a>(int8_t power)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#acbfa80f431f335d5597500319f0affa8">setPreambleLength</a>(uint8_t preambleLength)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#a2911d49d1c293542f7a374c9af60df0e">setPromiscuousMode</a>(bool promiscuous=true)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#a45ab4e3f4f9db367185333d36ba21ed2">setRfSwitchPins</a>(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#a381d0059d7a0ccd8a2f54d7d3376f9b6">setRxBandwidth</a>(float rxBw)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#a433f1a40b33be6c84d3665a1b4cd57d6">setSyncWord</a>(uint8_t syncH, uint8_t syncL, uint8_t maxErrBits=0, bool requireCarrierSense=false)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#ab89b0932dbacadc34d049a2bd2292001">setSyncWord</a>(uint8_t *syncWord, uint8_t len, uint8_t maxErrBits=0, bool requireCarrierSense=false)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#a7612bf81e48086004c62548de2682266">standby</a>() override</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#af727750d05be0bcef4bb8ac260d110e3">startReceive</a>()</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#a0df2938e2509a8f2746b20ae0558d4ea">startTransmit</a>(uint8_t *data, size_t len, uint8_t addr=0) override</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">PhysicalLayer::startTransmit</a>(String &str, uint8_t addr=0)</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a>(const char *str, uint8_t addr=0)</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#a7cb99a9200b21829b50e3fc3878573f4">transmit</a>(uint8_t *data, size_t len, uint8_t addr=0) override</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">PhysicalLayer::transmit</a>(__FlashStringHelper *fstr, uint8_t addr=0)</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_physical_layer.html#aeb62c5a521aafc1e0525c58e9364482b">PhysicalLayer::transmit</a>(String &str, uint8_t addr=0)</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">PhysicalLayer::transmit</a>(const char *str, uint8_t addr=0)</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_c_c1101.html#a240eef8fa7d838d76f3c11086dc50e46">transmitDirect</a>(uint32_t frf=0) override</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_c_c1101.html#a881122ec3457c5f95760859f8e0297c7">variablePacketLengthMode</a>(uint8_t maxLen=CC1101_MAX_PACKET_LENGTH)</td><td class="entry"><a class="el" href="class_c_c1101.html">CC1101</a></td><td class="entry"></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
1441
class_c_c1101.html
Normal file
1441
class_c_c1101.html
Normal file
File diff suppressed because it is too large
Load diff
41
class_c_c1101.js
Normal file
41
class_c_c1101.js
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
var class_c_c1101 =
|
||||
[
|
||||
[ "CC1101", "class_c_c1101.html#a6807e4254c4b55fa8d393b2bf8f2db3e", null ],
|
||||
[ "begin", "class_c_c1101.html#adcf6b5c4e1a066d6b9be326a9ee04284", null ],
|
||||
[ "clearGdo0Action", "class_c_c1101.html#ab5e6b3745f80cf61e1ced33303311df8", null ],
|
||||
[ "clearGdo2Action", "class_c_c1101.html#ac7a8b1fe7d08dc6db20cf1569b0d37b4", null ],
|
||||
[ "disableAddressFiltering", "class_c_c1101.html#a9aee5df428d30b9c80b8a8700609a883", null ],
|
||||
[ "disableSyncWordFiltering", "class_c_c1101.html#a4f2dc4176b62a0636636088e31b8e85b", null ],
|
||||
[ "enableSyncWordFiltering", "class_c_c1101.html#a6fe55d0217bf5218865198ef8d6fdab4", null ],
|
||||
[ "fixedPacketLengthMode", "class_c_c1101.html#a9335f1d5ccab7aab2357449002203810", null ],
|
||||
[ "getLQI", "class_c_c1101.html#af252f2c3c591289cb73089e51f0f967d", null ],
|
||||
[ "getPacketLength", "class_c_c1101.html#a122281f6a915b77ee9dafc9926e731a0", null ],
|
||||
[ "getRSSI", "class_c_c1101.html#af55b5ec0dd2d73bac6cb8a6d9862e6c1", null ],
|
||||
[ "packetMode", "class_c_c1101.html#a38f6978c757b0dd73e3ef98164a735a2", null ],
|
||||
[ "readData", "class_c_c1101.html#a8c79975a7bbe8a37f8214ecd1f69ba22", null ],
|
||||
[ "receive", "class_c_c1101.html#aedc1067d0334bb69ed5316146014097d", null ],
|
||||
[ "receiveDirect", "class_c_c1101.html#ab053c185330519d58f364790108d29ac", null ],
|
||||
[ "setBitRate", "class_c_c1101.html#aa53427cabcda0778f287ed1d850bbe37", null ],
|
||||
[ "setCrcFiltering", "class_c_c1101.html#aafac40359c4a1bb01aae12da6b03be26", null ],
|
||||
[ "setDataShaping", "class_c_c1101.html#adf96e77f25b7e256891601bef04f35a6", null ],
|
||||
[ "setEncoding", "class_c_c1101.html#ab4b98eb6af33d006306bb7514ed216ea", null ],
|
||||
[ "setFrequency", "class_c_c1101.html#a9592c023556c38c2b8066a23da96ae5e", null ],
|
||||
[ "setFrequencyDeviation", "class_c_c1101.html#a0d69713b9f20c9de354c13c3167b18b3", null ],
|
||||
[ "setGdo0Action", "class_c_c1101.html#a6dfd6a57cdbb3196ad021b152b0c65ed", null ],
|
||||
[ "setGdo2Action", "class_c_c1101.html#ac6338c2f5c937a12dac06069944ffb77", null ],
|
||||
[ "setNodeAddress", "class_c_c1101.html#a6e62914790f132816134fc68c2bb5eb8", null ],
|
||||
[ "setOOK", "class_c_c1101.html#afa64d1ad4789d3146b38d14437234756", null ],
|
||||
[ "setOutputPower", "class_c_c1101.html#ac3ff8051af5ca50c349e02257f1a3bda", null ],
|
||||
[ "setPreambleLength", "class_c_c1101.html#acbfa80f431f335d5597500319f0affa8", null ],
|
||||
[ "setPromiscuousMode", "class_c_c1101.html#a2911d49d1c293542f7a374c9af60df0e", null ],
|
||||
[ "setRfSwitchPins", "class_c_c1101.html#a45ab4e3f4f9db367185333d36ba21ed2", null ],
|
||||
[ "setRxBandwidth", "class_c_c1101.html#a381d0059d7a0ccd8a2f54d7d3376f9b6", null ],
|
||||
[ "setSyncWord", "class_c_c1101.html#a433f1a40b33be6c84d3665a1b4cd57d6", null ],
|
||||
[ "setSyncWord", "class_c_c1101.html#ab89b0932dbacadc34d049a2bd2292001", null ],
|
||||
[ "standby", "class_c_c1101.html#a7612bf81e48086004c62548de2682266", null ],
|
||||
[ "startReceive", "class_c_c1101.html#af727750d05be0bcef4bb8ac260d110e3", null ],
|
||||
[ "startTransmit", "class_c_c1101.html#a0df2938e2509a8f2746b20ae0558d4ea", null ],
|
||||
[ "transmit", "class_c_c1101.html#a7cb99a9200b21829b50e3fc3878573f4", null ],
|
||||
[ "transmitDirect", "class_c_c1101.html#a240eef8fa7d838d76f3c11086dc50e46", null ],
|
||||
[ "variablePacketLengthMode", "class_c_c1101.html#a881122ec3457c5f95760859f8e0297c7", null ]
|
||||
];
|
||||
BIN
class_c_c1101.png
Normal file
BIN
class_c_c1101.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 423 B |
138
class_e_s_p8266-members.html
Normal file
138
class_e_s_p8266-members.html
Normal file
|
|
@ -0,0 +1,138 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: Member List</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_e_s_p8266.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">ESP8266 Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_e_s_p8266.html">ESP8266</a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_e_s_p8266.html#ae25a6901976a548443e2b7d49ca94d9b">begin</a>(long speed)</td><td class="entry"><a class="el" href="class_e_s_p8266.html">ESP8266</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_e_s_p8266.html#aa71846340d1a679a12ddb9b9597f8f91">closeTransportConnection</a>() override</td><td class="entry"><a class="el" href="class_e_s_p8266.html">ESP8266</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_e_s_p8266.html#ac0adb20130a378b8b99fcb9101823636">ESP8266</a>(Module *module)</td><td class="entry"><a class="el" href="class_e_s_p8266.html">ESP8266</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_e_s_p8266.html#ac463b6a80cdc52e7db50b1f6760cec3f">getNumBytes</a>(uint32_t timeout=10000, size_t minBytes=10) override</td><td class="entry"><a class="el" href="class_e_s_p8266.html">ESP8266</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_e_s_p8266.html#abb39d205464bc4789c87120564258432">join</a>(const char *ssid, const char *password)</td><td class="entry"><a class="el" href="class_e_s_p8266.html">ESP8266</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_e_s_p8266.html#a535f4b7a8ef104b208753f9361568d20">openTransportConnection</a>(const char *host, const char *protocol, uint16_t port, uint16_t tcpKeepAlive=0) override</td><td class="entry"><a class="el" href="class_e_s_p8266.html">ESP8266</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_e_s_p8266.html#aa79f841de9ae9c5d6057e89a9f1721ea">receive</a>(uint8_t *data, size_t len, uint32_t timeout=10000) override</td><td class="entry"><a class="el" href="class_e_s_p8266.html">ESP8266</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_e_s_p8266.html#aee0279b476a83a55f54ab22e6d8f3904">reset</a>()</td><td class="entry"><a class="el" href="class_e_s_p8266.html">ESP8266</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_e_s_p8266.html#a1caaa537edd52d1c2b7a0a25ef69c1c9">send</a>(const char *data) override</td><td class="entry"><a class="el" href="class_e_s_p8266.html">ESP8266</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_e_s_p8266.html#a2f34474953b7dbe4d057c8e3f65e0dc4">send</a>(uint8_t *data, size_t len) override</td><td class="entry"><a class="el" href="class_e_s_p8266.html">ESP8266</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
555
class_e_s_p8266.html
Normal file
555
class_e_s_p8266.html
Normal file
|
|
@ -0,0 +1,555 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: ESP8266 Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_e_s_p8266.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="class_e_s_p8266-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">ESP8266 Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Control class for ESP8266 module. Implements <a class="el" href="class_transport_layer.html" title="Provides common interface for protocols that run on modules with Internet connectivity, such as HTTP or MQTT. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class. ">TransportLayer</a> methods.
|
||||
<a href="class_e_s_p8266.html#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="_e_s_p8266_8h_source.html">ESP8266.h</a>></code></p>
|
||||
<div class="dynheader">
|
||||
Inheritance diagram for ESP8266:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center">
|
||||
<img src="class_e_s_p8266.png" usemap="#ESP8266_map" alt=""/>
|
||||
<map id="ESP8266_map" name="ESP8266_map">
|
||||
<area href="class_transport_layer.html" title="Provides common interface for protocols that run on modules with Internet connectivity, such as HTTP or MQTT. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class. " alt="TransportLayer" shape="rect" coords="0,0,99,24"/>
|
||||
</map>
|
||||
</div></div>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:ac0adb20130a378b8b99fcb9101823636"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#ac0adb20130a378b8b99fcb9101823636">ESP8266</a> (<a class="el" href="class_module.html">Module</a> *module)</td></tr>
|
||||
<tr class="memdesc:ac0adb20130a378b8b99fcb9101823636"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#ac0adb20130a378b8b99fcb9101823636">More...</a><br /></td></tr>
|
||||
<tr class="separator:ac0adb20130a378b8b99fcb9101823636"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ae25a6901976a548443e2b7d49ca94d9b"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#ae25a6901976a548443e2b7d49ca94d9b">begin</a> (long speed)</td></tr>
|
||||
<tr class="memdesc:ae25a6901976a548443e2b7d49ca94d9b"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. <a href="#ae25a6901976a548443e2b7d49ca94d9b">More...</a><br /></td></tr>
|
||||
<tr class="separator:ae25a6901976a548443e2b7d49ca94d9b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aee0279b476a83a55f54ab22e6d8f3904"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#aee0279b476a83a55f54ab22e6d8f3904">reset</a> ()</td></tr>
|
||||
<tr class="memdesc:aee0279b476a83a55f54ab22e6d8f3904"><td class="mdescLeft"> </td><td class="mdescRight">Resets module using AT command. <a href="#aee0279b476a83a55f54ab22e6d8f3904">More...</a><br /></td></tr>
|
||||
<tr class="separator:aee0279b476a83a55f54ab22e6d8f3904"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:abb39d205464bc4789c87120564258432"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#abb39d205464bc4789c87120564258432">join</a> (const char *ssid, const char *password)</td></tr>
|
||||
<tr class="memdesc:abb39d205464bc4789c87120564258432"><td class="mdescLeft"> </td><td class="mdescRight">Joins access point. <a href="#abb39d205464bc4789c87120564258432">More...</a><br /></td></tr>
|
||||
<tr class="separator:abb39d205464bc4789c87120564258432"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a535f4b7a8ef104b208753f9361568d20"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a535f4b7a8ef104b208753f9361568d20">openTransportConnection</a> (const char *host, const char *protocol, uint16_t port, uint16_t tcpKeepAlive=0) override</td></tr>
|
||||
<tr class="memdesc:a535f4b7a8ef104b208753f9361568d20"><td class="mdescLeft"> </td><td class="mdescRight">Open transport layer connection. <a href="#a535f4b7a8ef104b208753f9361568d20">More...</a><br /></td></tr>
|
||||
<tr class="separator:a535f4b7a8ef104b208753f9361568d20"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa71846340d1a679a12ddb9b9597f8f91"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#aa71846340d1a679a12ddb9b9597f8f91">closeTransportConnection</a> () override</td></tr>
|
||||
<tr class="memdesc:aa71846340d1a679a12ddb9b9597f8f91"><td class="mdescLeft"> </td><td class="mdescRight">Close transport layer connection. <a href="#aa71846340d1a679a12ddb9b9597f8f91">More...</a><br /></td></tr>
|
||||
<tr class="separator:aa71846340d1a679a12ddb9b9597f8f91"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a1caaa537edd52d1c2b7a0a25ef69c1c9"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a1caaa537edd52d1c2b7a0a25ef69c1c9">send</a> (const char *data) override</td></tr>
|
||||
<tr class="memdesc:a1caaa537edd52d1c2b7a0a25ef69c1c9"><td class="mdescLeft"> </td><td class="mdescRight">Send string-based data. <a href="#a1caaa537edd52d1c2b7a0a25ef69c1c9">More...</a><br /></td></tr>
|
||||
<tr class="separator:a1caaa537edd52d1c2b7a0a25ef69c1c9"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a2f34474953b7dbe4d057c8e3f65e0dc4"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#a2f34474953b7dbe4d057c8e3f65e0dc4">send</a> (uint8_t *data, size_t len) override</td></tr>
|
||||
<tr class="memdesc:a2f34474953b7dbe4d057c8e3f65e0dc4"><td class="mdescLeft"> </td><td class="mdescRight">Send arbitrary binary data. <a href="#a2f34474953b7dbe4d057c8e3f65e0dc4">More...</a><br /></td></tr>
|
||||
<tr class="separator:a2f34474953b7dbe4d057c8e3f65e0dc4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa79f841de9ae9c5d6057e89a9f1721ea"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#aa79f841de9ae9c5d6057e89a9f1721ea">receive</a> (uint8_t *data, size_t len, uint32_t timeout=10000) override</td></tr>
|
||||
<tr class="memdesc:aa79f841de9ae9c5d6057e89a9f1721ea"><td class="mdescLeft"> </td><td class="mdescRight">Receive data. <a href="#aa79f841de9ae9c5d6057e89a9f1721ea">More...</a><br /></td></tr>
|
||||
<tr class="separator:aa79f841de9ae9c5d6057e89a9f1721ea"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac463b6a80cdc52e7db50b1f6760cec3f"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_e_s_p8266.html#ac463b6a80cdc52e7db50b1f6760cec3f">getNumBytes</a> (uint32_t timeout=10000, size_t minBytes=10) override</td></tr>
|
||||
<tr class="memdesc:ac463b6a80cdc52e7db50b1f6760cec3f"><td class="mdescLeft"> </td><td class="mdescRight">Get number of received bytes. <a href="#ac463b6a80cdc52e7db50b1f6760cec3f">More...</a><br /></td></tr>
|
||||
<tr class="separator:ac463b6a80cdc52e7db50b1f6760cec3f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Control class for ESP8266 module. Implements <a class="el" href="class_transport_layer.html" title="Provides common interface for protocols that run on modules with Internet connectivity, such as HTTP or MQTT. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class. ">TransportLayer</a> methods. </p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="ac0adb20130a378b8b99fcb9101823636"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ESP8266::ESP8266 </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="class_module.html">Module</a> * </td>
|
||||
<td class="paramname"><em>module</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Default constructor. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">mod</td><td>Instance of <a class="el" href="class_module.html" title="Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class. ">Module</a> that will be used to communicate with the radio. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a class="anchor" id="ae25a6901976a548443e2b7d49ca94d9b"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t ESP8266::begin </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">long </td>
|
||||
<td class="paramname"><em>speed</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Initialization method. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">speed</td><td>Baud rate to use for UART interface.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="aa71846340d1a679a12ddb9b9597f8f91"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t ESP8266::closeTransportConnection </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Close transport layer connection. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
<p>Implements <a class="el" href="class_transport_layer.html#a82fc1c71a0f6d0aac1be7f6c184a0021">TransportLayer</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ac463b6a80cdc52e7db50b1f6760cec3f"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">size_t ESP8266::getNumBytes </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>timeout</em> = <code>10000</code>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">size_t </td>
|
||||
<td class="paramname"><em>minBytes</em> = <code>10</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Get number of received bytes. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">timeout</td><td>Reception timeout in ms. Defaults to 10000.</td></tr>
|
||||
<tr><td class="paramname">minBytes</td><td>Minimum required number of bytes that must be received.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Number of received bytes, or 0 on timeout. </dd></dl>
|
||||
|
||||
<p>Implements <a class="el" href="class_transport_layer.html#a730e6671632844b1effc114e5c7d95c8">TransportLayer</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="abb39d205464bc4789c87120564258432"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t ESP8266::join </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>ssid</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>password</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Joins access point. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">ssid</td><td>Access point SSID.</td></tr>
|
||||
<tr><td class="paramname">password</td><td>Access point password. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a535f4b7a8ef104b208753f9361568d20"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t ESP8266::openTransportConnection </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>host</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>protocol</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint16_t </td>
|
||||
<td class="paramname"><em>port</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint16_t </td>
|
||||
<td class="paramname"><em>tcpKeepAlive</em> = <code>0</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Open transport layer connection. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">host</td><td>Host to connect to.</td></tr>
|
||||
<tr><td class="paramname">protocol</td><td>Transport protocol to use. Usually "TCP" or "UDP".</td></tr>
|
||||
<tr><td class="paramname">port</td><td>to be used for the connection.</td></tr>
|
||||
<tr><td class="paramname">tcpKeepAlive</td><td>TCP keep alive interval. Defaults to 0.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
<p>Implements <a class="el" href="class_transport_layer.html#a36b1ceebca3643fb475607d3d92f5d63">TransportLayer</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="aa79f841de9ae9c5d6057e89a9f1721ea"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">size_t ESP8266::receive </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint8_t * </td>
|
||||
<td class="paramname"><em>data</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">size_t </td>
|
||||
<td class="paramname"><em>len</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>timeout</em> = <code>10000</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Receive data. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">data</td><td>Pointer to array to save the received data.</td></tr>
|
||||
<tr><td class="paramname">len</td><td>Number of bytes to read.</td></tr>
|
||||
<tr><td class="paramname">timeout</td><td>Reception timeout in ms. Defaults to 10000.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
<p>Implements <a class="el" href="class_transport_layer.html#a846492348f71d7328834076c9046dc3f">TransportLayer</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="aee0279b476a83a55f54ab22e6d8f3904"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t ESP8266::reset </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Resets module using AT command. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a1caaa537edd52d1c2b7a0a25ef69c1c9"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t ESP8266::send </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>data</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Send string-based data. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">string</td><td>String data to be sent.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
<p>Implements <a class="el" href="class_transport_layer.html#a1d9cb76640868aa0338b52808e4f022d">TransportLayer</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a2f34474953b7dbe4d057c8e3f65e0dc4"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t ESP8266::send </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint8_t * </td>
|
||||
<td class="paramname"><em>data</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">size_t </td>
|
||||
<td class="paramname"><em>len</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Send arbitrary binary data. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">data</td><td>Data to be sent.</td></tr>
|
||||
<tr><td class="paramname">len</td><td>Number of bytes to send.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
<p>Implements <a class="el" href="class_transport_layer.html#afb001c6348bc19694090532cc5f00e52">TransportLayer</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||
<li>src/modules/ESP8266/<a class="el" href="_e_s_p8266_8h_source.html">ESP8266.h</a></li>
|
||||
<li>src/modules/ESP8266/ESP8266.cpp</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="class_e_s_p8266.html">ESP8266</a></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
13
class_e_s_p8266.js
Normal file
13
class_e_s_p8266.js
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
var class_e_s_p8266 =
|
||||
[
|
||||
[ "ESP8266", "class_e_s_p8266.html#ac0adb20130a378b8b99fcb9101823636", null ],
|
||||
[ "begin", "class_e_s_p8266.html#ae25a6901976a548443e2b7d49ca94d9b", null ],
|
||||
[ "closeTransportConnection", "class_e_s_p8266.html#aa71846340d1a679a12ddb9b9597f8f91", null ],
|
||||
[ "getNumBytes", "class_e_s_p8266.html#ac463b6a80cdc52e7db50b1f6760cec3f", null ],
|
||||
[ "join", "class_e_s_p8266.html#abb39d205464bc4789c87120564258432", null ],
|
||||
[ "openTransportConnection", "class_e_s_p8266.html#a535f4b7a8ef104b208753f9361568d20", null ],
|
||||
[ "receive", "class_e_s_p8266.html#aa79f841de9ae9c5d6057e89a9f1721ea", null ],
|
||||
[ "reset", "class_e_s_p8266.html#aee0279b476a83a55f54ab22e6d8f3904", null ],
|
||||
[ "send", "class_e_s_p8266.html#a1caaa537edd52d1c2b7a0a25ef69c1c9", null ],
|
||||
[ "send", "class_e_s_p8266.html#a2f34474953b7dbe4d057c8e3f65e0dc4", null ]
|
||||
];
|
||||
BIN
class_e_s_p8266.png
Normal file
BIN
class_e_s_p8266.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 472 B |
160
class_h_c05-members.html
Normal file
160
class_h_c05-members.html
Normal file
|
|
@ -0,0 +1,160 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: Member List</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_h_c05.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">HC05 Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_h_c05.html">HC05</a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>available</b>() (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_h_c05.html#a83cf61ee5a79c06f43861a6e5a8a15b6">begin</a>(long speed)</td><td class="entry"><a class="el" href="class_h_c05.html">HC05</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>end</b>() (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>flush</b>() (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_h_c05.html#a5cc3184c58de65cbff18447c6d03de18">HC05</a>(Module *mod)</td><td class="entry"><a class="el" href="class_h_c05.html">HC05</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>ISerial</b>(Module *mod) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>peek</b>() (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(const __FlashStringHelper *) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(const String &) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(const char[]) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(char) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(unsigned char, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(int, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(unsigned int, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(long, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(unsigned long, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(double, int=2) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(const Printable &) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(const __FlashStringHelper *) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(const String &s) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(const char[]) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(char) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(unsigned char, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(int, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(unsigned int, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(long, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(unsigned long, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(double, int=2) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(const Printable &) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(void) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>read</b>() (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>write</b>(uint8_t) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
303
class_h_c05.html
Normal file
303
class_h_c05.html
Normal file
|
|
@ -0,0 +1,303 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: HC05 Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_h_c05.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="class_h_c05-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">HC05 Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Control class for HC05 module. Most methods supported by this module are implemented in <a class="el" href="class_i_serial.html" title="Interface class for Arduino Serial. Only calls the appropriate methods for the active UART interface...">ISerial</a> interface.
|
||||
<a href="class_h_c05.html#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="_h_c05_8h_source.html">HC05.h</a>></code></p>
|
||||
<div class="dynheader">
|
||||
Inheritance diagram for HC05:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center">
|
||||
<img src="class_h_c05.png" usemap="#HC05_map" alt=""/>
|
||||
<map id="HC05_map" name="HC05_map">
|
||||
<area href="class_i_serial.html" title="Interface class for Arduino Serial. Only calls the appropriate methods for the active UART interface..." alt="ISerial" shape="rect" coords="0,0,48,24"/>
|
||||
</map>
|
||||
</div></div>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a5cc3184c58de65cbff18447c6d03de18"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_c05.html#a5cc3184c58de65cbff18447c6d03de18">HC05</a> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
||||
<tr class="memdesc:a5cc3184c58de65cbff18447c6d03de18"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a5cc3184c58de65cbff18447c6d03de18">More...</a><br /></td></tr>
|
||||
<tr class="separator:a5cc3184c58de65cbff18447c6d03de18"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a83cf61ee5a79c06f43861a6e5a8a15b6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_c05.html#a83cf61ee5a79c06f43861a6e5a8a15b6">begin</a> (long speed)</td></tr>
|
||||
<tr class="memdesc:a83cf61ee5a79c06f43861a6e5a8a15b6"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. <a href="#a83cf61ee5a79c06f43861a6e5a8a15b6">More...</a><br /></td></tr>
|
||||
<tr class="separator:a83cf61ee5a79c06f43861a6e5a8a15b6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="inherit_header pub_methods_class_i_serial"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_i_serial')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_i_serial.html">ISerial</a></td></tr>
|
||||
<tr class="memitem:ae40ab8688a45d252264a45fe7eeb1fec inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae40ab8688a45d252264a45fe7eeb1fec"></a>
|
||||
 </td><td class="memItemRight" valign="bottom"><b>ISerial</b> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
||||
<tr class="separator:ae40ab8688a45d252264a45fe7eeb1fec inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac88cbd52dd52081012c7ebc5e4877a71 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac88cbd52dd52081012c7ebc5e4877a71"></a>
|
||||
void </td><td class="memItemRight" valign="bottom"><b>begin</b> (long)</td></tr>
|
||||
<tr class="separator:ac88cbd52dd52081012c7ebc5e4877a71 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9ab275543e32bbd26093936e93901a64 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ab275543e32bbd26093936e93901a64"></a>
|
||||
void </td><td class="memItemRight" valign="bottom"><b>end</b> ()</td></tr>
|
||||
<tr class="separator:a9ab275543e32bbd26093936e93901a64 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aaec3e37c852ab96dc0cb406f25927020 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaec3e37c852ab96dc0cb406f25927020"></a>
|
||||
int </td><td class="memItemRight" valign="bottom"><b>peek</b> ()</td></tr>
|
||||
<tr class="separator:aaec3e37c852ab96dc0cb406f25927020 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0e3eac99b53d90cd8c725a5cc409e438 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e3eac99b53d90cd8c725a5cc409e438"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (uint8_t)</td></tr>
|
||||
<tr class="separator:a0e3eac99b53d90cd8c725a5cc409e438 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a59bdc39fa8633f3bb6154dacb043ae10 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59bdc39fa8633f3bb6154dacb043ae10"></a>
|
||||
int </td><td class="memItemRight" valign="bottom"><b>read</b> ()</td></tr>
|
||||
<tr class="separator:a59bdc39fa8633f3bb6154dacb043ae10 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a7dfceaa2cb8f849211e64ffbb26a9ccb inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7dfceaa2cb8f849211e64ffbb26a9ccb"></a>
|
||||
int </td><td class="memItemRight" valign="bottom"><b>available</b> ()</td></tr>
|
||||
<tr class="separator:a7dfceaa2cb8f849211e64ffbb26a9ccb inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a5073d939918c6ae56e1eb28da4362fc8 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5073d939918c6ae56e1eb28da4362fc8"></a>
|
||||
void </td><td class="memItemRight" valign="bottom"><b>flush</b> ()</td></tr>
|
||||
<tr class="separator:a5073d939918c6ae56e1eb28da4362fc8 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a71ff41667bb4cb865fae0cb392ba2480 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a71ff41667bb4cb865fae0cb392ba2480"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (const __FlashStringHelper *)</td></tr>
|
||||
<tr class="separator:a71ff41667bb4cb865fae0cb392ba2480 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:afa73455a632e6c6819a2552ad58d3e4a inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa73455a632e6c6819a2552ad58d3e4a"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (const String &)</td></tr>
|
||||
<tr class="separator:afa73455a632e6c6819a2552ad58d3e4a inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a50a1a3292b06f0b0283bb365e4274e74 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a50a1a3292b06f0b0283bb365e4274e74"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (const char[])</td></tr>
|
||||
<tr class="separator:a50a1a3292b06f0b0283bb365e4274e74 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a37e78871669df20cc65ddd0b3f98eba4 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37e78871669df20cc65ddd0b3f98eba4"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (char)</td></tr>
|
||||
<tr class="separator:a37e78871669df20cc65ddd0b3f98eba4 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa7de5539ed01b0abd7c3c5c5767b855a inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7de5539ed01b0abd7c3c5c5767b855a"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned char, int=DEC)</td></tr>
|
||||
<tr class="separator:aa7de5539ed01b0abd7c3c5c5767b855a inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6cbd12b7b47005ab0153066c34f28426 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6cbd12b7b47005ab0153066c34f28426"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (int, int=DEC)</td></tr>
|
||||
<tr class="separator:a6cbd12b7b47005ab0153066c34f28426 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a86997b02021c420e2c1bd7fdd11b1e14 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a86997b02021c420e2c1bd7fdd11b1e14"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned int, int=DEC)</td></tr>
|
||||
<tr class="separator:a86997b02021c420e2c1bd7fdd11b1e14 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a8e5003afc67d7488af5c546f51c9222c inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e5003afc67d7488af5c546f51c9222c"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (long, int=DEC)</td></tr>
|
||||
<tr class="separator:a8e5003afc67d7488af5c546f51c9222c inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a466ab09bad9fbcb514ffef6528de5d7f inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a466ab09bad9fbcb514ffef6528de5d7f"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned long, int=DEC)</td></tr>
|
||||
<tr class="separator:a466ab09bad9fbcb514ffef6528de5d7f inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:af66546833df21b2949b26e4771a9f9d6 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af66546833df21b2949b26e4771a9f9d6"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (double, int=2)</td></tr>
|
||||
<tr class="separator:af66546833df21b2949b26e4771a9f9d6 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a54f478dbde6921d212fe5b2159f4ee93 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54f478dbde6921d212fe5b2159f4ee93"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (const Printable &)</td></tr>
|
||||
<tr class="separator:a54f478dbde6921d212fe5b2159f4ee93 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a16eaec118c2c38db031cc0e9b641b203 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16eaec118c2c38db031cc0e9b641b203"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (const __FlashStringHelper *)</td></tr>
|
||||
<tr class="separator:a16eaec118c2c38db031cc0e9b641b203 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a94f1c1b1e6a94ea418251c666b72eac5 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94f1c1b1e6a94ea418251c666b72eac5"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (const String &s)</td></tr>
|
||||
<tr class="separator:a94f1c1b1e6a94ea418251c666b72eac5 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a7a91c6fc4dd9e70b438a4ebc2c62b881 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a91c6fc4dd9e70b438a4ebc2c62b881"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (const char[])</td></tr>
|
||||
<tr class="separator:a7a91c6fc4dd9e70b438a4ebc2c62b881 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0ab1d33067885e6456ab61b3b51f07b4 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ab1d33067885e6456ab61b3b51f07b4"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (char)</td></tr>
|
||||
<tr class="separator:a0ab1d33067885e6456ab61b3b51f07b4 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0b669c99851a4a36945bc7d9b26f1c15 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b669c99851a4a36945bc7d9b26f1c15"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned char, int=DEC)</td></tr>
|
||||
<tr class="separator:a0b669c99851a4a36945bc7d9b26f1c15 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ae96f7b598e2e9bdb5f8bf5b7feb56983 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae96f7b598e2e9bdb5f8bf5b7feb56983"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (int, int=DEC)</td></tr>
|
||||
<tr class="separator:ae96f7b598e2e9bdb5f8bf5b7feb56983 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a85f3dff9f42387e12be59049cb020a88 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a85f3dff9f42387e12be59049cb020a88"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned int, int=DEC)</td></tr>
|
||||
<tr class="separator:a85f3dff9f42387e12be59049cb020a88 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aaa489fda4cc41dac95ed157105f08de6 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa489fda4cc41dac95ed157105f08de6"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (long, int=DEC)</td></tr>
|
||||
<tr class="separator:aaa489fda4cc41dac95ed157105f08de6 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac46c8197c06b703bcb83ed3947492a4f inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac46c8197c06b703bcb83ed3947492a4f"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned long, int=DEC)</td></tr>
|
||||
<tr class="separator:ac46c8197c06b703bcb83ed3947492a4f inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a5e25366fa6386a413bb46dd4a62e1931 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e25366fa6386a413bb46dd4a62e1931"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (double, int=2)</td></tr>
|
||||
<tr class="separator:a5e25366fa6386a413bb46dd4a62e1931 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0607b2c508006f1e43d685404be50f23 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0607b2c508006f1e43d685404be50f23"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (const Printable &)</td></tr>
|
||||
<tr class="separator:a0607b2c508006f1e43d685404be50f23 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ab9bb40acf5dd420afed4ea80d7989a20 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9bb40acf5dd420afed4ea80d7989a20"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (void)</td></tr>
|
||||
<tr class="separator:ab9bb40acf5dd420afed4ea80d7989a20 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Control class for HC05 module. Most methods supported by this module are implemented in <a class="el" href="class_i_serial.html" title="Interface class for Arduino Serial. Only calls the appropriate methods for the active UART interface...">ISerial</a> interface. </p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="a5cc3184c58de65cbff18447c6d03de18"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">HC05::HC05 </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="class_module.html">Module</a> * </td>
|
||||
<td class="paramname"><em>mod</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Default constructor. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">mod</td><td>Instance of <a class="el" href="class_module.html" title="Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class. ">Module</a> that will be used to communicate with the radio. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a class="anchor" id="a83cf61ee5a79c06f43861a6e5a8a15b6"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void HC05::begin </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">long </td>
|
||||
<td class="paramname"><em>speed</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Initialization method. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">speed</td><td>Baud rate to use for UART interface. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||
<li>src/modules/HC05/<a class="el" href="_h_c05_8h_source.html">HC05.h</a></li>
|
||||
<li>src/modules/HC05/HC05.cpp</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="class_h_c05.html">HC05</a></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
5
class_h_c05.js
Normal file
5
class_h_c05.js
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
var class_h_c05 =
|
||||
[
|
||||
[ "HC05", "class_h_c05.html#a5cc3184c58de65cbff18447c6d03de18", null ],
|
||||
[ "begin", "class_h_c05.html#a83cf61ee5a79c06f43861a6e5a8a15b6", null ]
|
||||
];
|
||||
BIN
class_h_c05.png
Normal file
BIN
class_h_c05.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 332 B |
132
class_h_t_t_p_client-members.html
Normal file
132
class_h_t_t_p_client-members.html
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: Member List</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_h_t_t_p_client.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">HTTPClient Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_h_t_t_p_client.html">HTTPClient</a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_h_t_t_p_client.html#abc505d06d29fdc774d27c163e0be7ff8">get</a>(String &url, String &response)</td><td class="entry"><a class="el" href="class_h_t_t_p_client.html">HTTPClient</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_h_t_t_p_client.html#a7ae493bf7db12ca2201cd6cead54c64f">get</a>(const char *url, String &response)</td><td class="entry"><a class="el" href="class_h_t_t_p_client.html">HTTPClient</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_h_t_t_p_client.html#a7c6fdd5681e55437ebddaac785f35557">HTTPClient</a>(TransportLayer *tl, uint16_t port=80)</td><td class="entry"><a class="el" href="class_h_t_t_p_client.html">HTTPClient</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_h_t_t_p_client.html#ac1119b889b6fed7bd4d119d3e4842acb">post</a>(const char *url, const char *content, String &response, const char *contentType="text/plain")</td><td class="entry"><a class="el" href="class_h_t_t_p_client.html">HTTPClient</a></td><td class="entry"></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
323
class_h_t_t_p_client.html
Normal file
323
class_h_t_t_p_client.html
Normal file
|
|
@ -0,0 +1,323 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: HTTPClient Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_h_t_t_p_client.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="class_h_t_t_p_client-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">HTTPClient Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Client for simple HTTP communication.
|
||||
<a href="class_h_t_t_p_client.html#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="_h_t_t_p_8h_source.html">HTTP.h</a>></code></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a7c6fdd5681e55437ebddaac785f35557"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_t_t_p_client.html#a7c6fdd5681e55437ebddaac785f35557">HTTPClient</a> (<a class="el" href="class_transport_layer.html">TransportLayer</a> *tl, uint16_t port=80)</td></tr>
|
||||
<tr class="memdesc:a7c6fdd5681e55437ebddaac785f35557"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a7c6fdd5681e55437ebddaac785f35557">More...</a><br /></td></tr>
|
||||
<tr class="separator:a7c6fdd5681e55437ebddaac785f35557"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:abc505d06d29fdc774d27c163e0be7ff8"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_t_t_p_client.html#abc505d06d29fdc774d27c163e0be7ff8">get</a> (String &url, String &response)</td></tr>
|
||||
<tr class="memdesc:abc505d06d29fdc774d27c163e0be7ff8"><td class="mdescLeft"> </td><td class="mdescRight">Sends HTTP GET request. <a href="#abc505d06d29fdc774d27c163e0be7ff8">More...</a><br /></td></tr>
|
||||
<tr class="separator:abc505d06d29fdc774d27c163e0be7ff8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a7ae493bf7db12ca2201cd6cead54c64f"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_t_t_p_client.html#a7ae493bf7db12ca2201cd6cead54c64f">get</a> (const char *url, String &response)</td></tr>
|
||||
<tr class="memdesc:a7ae493bf7db12ca2201cd6cead54c64f"><td class="mdescLeft"> </td><td class="mdescRight">Sends HTTP GET request. <a href="#a7ae493bf7db12ca2201cd6cead54c64f">More...</a><br /></td></tr>
|
||||
<tr class="separator:a7ae493bf7db12ca2201cd6cead54c64f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac1119b889b6fed7bd4d119d3e4842acb"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_t_t_p_client.html#ac1119b889b6fed7bd4d119d3e4842acb">post</a> (const char *url, const char *content, String &response, const char *contentType="text/plain")</td></tr>
|
||||
<tr class="memdesc:ac1119b889b6fed7bd4d119d3e4842acb"><td class="mdescLeft"> </td><td class="mdescRight">Sends HTTP POST request. <a href="#ac1119b889b6fed7bd4d119d3e4842acb">More...</a><br /></td></tr>
|
||||
<tr class="separator:ac1119b889b6fed7bd4d119d3e4842acb"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Client for simple HTTP communication. </p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="a7c6fdd5681e55437ebddaac785f35557"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">HTTPClient::HTTPClient </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="class_transport_layer.html">TransportLayer</a> * </td>
|
||||
<td class="paramname"><em>tl</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint16_t </td>
|
||||
<td class="paramname"><em>port</em> = <code>80</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Default constructor. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">tl</td><td>Pointer to the wireless module providing <a class="el" href="class_transport_layer.html" title="Provides common interface for protocols that run on modules with Internet connectivity, such as HTTP or MQTT. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class. ">TransportLayer</a> communication.</td></tr>
|
||||
<tr><td class="paramname">port</td><td>Port to be used for HTTP. Defaults to 80. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a class="anchor" id="abc505d06d29fdc774d27c163e0be7ff8"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t HTTPClient::get </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">String & </td>
|
||||
<td class="paramname"><em>url</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">String & </td>
|
||||
<td class="paramname"><em>response</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Sends HTTP GET request. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">url</td><td>URL to send the request to.</td></tr>
|
||||
<tr><td class="paramname">response</td><td>Arduino String object that will save the response.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a7ae493bf7db12ca2201cd6cead54c64f"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t HTTPClient::get </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>url</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">String & </td>
|
||||
<td class="paramname"><em>response</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Sends HTTP GET request. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">url</td><td>URL to send the request to.</td></tr>
|
||||
<tr><td class="paramname">response</td><td>Arduino String object that will save the response.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ac1119b889b6fed7bd4d119d3e4842acb"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t HTTPClient::post </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>url</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>content</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">String & </td>
|
||||
<td class="paramname"><em>response</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>contentType</em> = <code>"text/plain"</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Sends HTTP POST request. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">url</td><td>URL to send the request to.</td></tr>
|
||||
<tr><td class="paramname">content</td><td>Request content.</td></tr>
|
||||
<tr><td class="paramname">response</td><td>Arduino String object that will save the response.</td></tr>
|
||||
<tr><td class="paramname">contentType</td><td>MIME type of request content. Defaults to "text/plain".</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||
<li>src/protocols/HTTP/<a class="el" href="_h_t_t_p_8h_source.html">HTTP.h</a></li>
|
||||
<li>src/protocols/HTTP/HTTP.cpp</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="class_h_t_t_p_client.html">HTTPClient</a></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
7
class_h_t_t_p_client.js
Normal file
7
class_h_t_t_p_client.js
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
var class_h_t_t_p_client =
|
||||
[
|
||||
[ "HTTPClient", "class_h_t_t_p_client.html#a7c6fdd5681e55437ebddaac785f35557", null ],
|
||||
[ "get", "class_h_t_t_p_client.html#abc505d06d29fdc774d27c163e0be7ff8", null ],
|
||||
[ "get", "class_h_t_t_p_client.html#a7ae493bf7db12ca2201cd6cead54c64f", null ],
|
||||
[ "post", "class_h_t_t_p_client.html#ac1119b889b6fed7bd4d119d3e4842acb", null ]
|
||||
];
|
||||
156
class_hell_client-members.html
Normal file
156
class_hell_client-members.html
Normal file
|
|
@ -0,0 +1,156 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: Member List</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_hell_client.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">HellClient Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_hell_client.html">HellClient</a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_hell_client.html#a225775fe87f9ed3c3a04142697641242">begin</a>(float base, float rate=122.5)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_hell_client.html#a6e3ed5db1904f3f9602e20c3c0d0cbd0">HellClient</a>(PhysicalLayer *phy)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_hell_client.html#afeb347f04148700427ad40614fd057c3">HellClient</a>(AFSKClient *audio)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(__FlashStringHelper *) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(const String &) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(const char[]) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(char) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(unsigned char, int=DEC) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(int, int=DEC) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(unsigned int, int=DEC) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(long, int=DEC) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(unsigned long, int=DEC) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(double, int=2) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_hell_client.html#ac527806ef871dc12555afe7c43a72ed9">printGlyph</a>(uint8_t *buff)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(void) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(__FlashStringHelper *) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(const String &) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(const char[]) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(char) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(unsigned char, int=DEC) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(int, int=DEC) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(unsigned int, int=DEC) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(long, int=DEC) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(unsigned long, int=DEC) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(double, int=2) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>write</b>(const char *str) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>write</b>(uint8_t *buff, size_t len) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>write</b>(uint8_t b) (defined in <a class="el" href="class_hell_client.html">HellClient</a>)</td><td class="entry"><a class="el" href="class_hell_client.html">HellClient</a></td><td class="entry"></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
353
class_hell_client.html
Normal file
353
class_hell_client.html
Normal file
|
|
@ -0,0 +1,353 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: HellClient Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_hell_client.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="class_hell_client-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">HellClient Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Client for Hellschreiber transmissions.
|
||||
<a href="class_hell_client.html#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="_hellschreiber_8h_source.html">Hellschreiber.h</a>></code></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a6e3ed5db1904f3f9602e20c3c0d0cbd0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_hell_client.html#a6e3ed5db1904f3f9602e20c3c0d0cbd0">HellClient</a> (<a class="el" href="class_physical_layer.html">PhysicalLayer</a> *phy)</td></tr>
|
||||
<tr class="memdesc:a6e3ed5db1904f3f9602e20c3c0d0cbd0"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for 2-FSK mode. <a href="#a6e3ed5db1904f3f9602e20c3c0d0cbd0">More...</a><br /></td></tr>
|
||||
<tr class="separator:a6e3ed5db1904f3f9602e20c3c0d0cbd0"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:afeb347f04148700427ad40614fd057c3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_hell_client.html#afeb347f04148700427ad40614fd057c3">HellClient</a> (<a class="el" href="class_a_f_s_k_client.html">AFSKClient</a> *audio)</td></tr>
|
||||
<tr class="memdesc:afeb347f04148700427ad40614fd057c3"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for AFSK mode. <a href="#afeb347f04148700427ad40614fd057c3">More...</a><br /></td></tr>
|
||||
<tr class="separator:afeb347f04148700427ad40614fd057c3"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a225775fe87f9ed3c3a04142697641242"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_hell_client.html#a225775fe87f9ed3c3a04142697641242">begin</a> (float base, float rate=122.5)</td></tr>
|
||||
<tr class="memdesc:a225775fe87f9ed3c3a04142697641242"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. <a href="#a225775fe87f9ed3c3a04142697641242">More...</a><br /></td></tr>
|
||||
<tr class="separator:a225775fe87f9ed3c3a04142697641242"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac527806ef871dc12555afe7c43a72ed9"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_hell_client.html#ac527806ef871dc12555afe7c43a72ed9">printGlyph</a> (uint8_t *buff)</td></tr>
|
||||
<tr class="memdesc:ac527806ef871dc12555afe7c43a72ed9"><td class="mdescLeft"> </td><td class="mdescRight">Method to "print" a buffer of pixels, this is exposed to allow users to send custom characters. <a href="#ac527806ef871dc12555afe7c43a72ed9">More...</a><br /></td></tr>
|
||||
<tr class="separator:ac527806ef871dc12555afe7c43a72ed9"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ad82abc52034fafdea84c15530039a6f5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad82abc52034fafdea84c15530039a6f5"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (const char *str)</td></tr>
|
||||
<tr class="separator:ad82abc52034fafdea84c15530039a6f5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a472555cea11854700db91843c335bded"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a472555cea11854700db91843c335bded"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (uint8_t *buff, size_t len)</td></tr>
|
||||
<tr class="separator:a472555cea11854700db91843c335bded"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a5c5117dadbe33da1cda5fd4981b405eb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c5117dadbe33da1cda5fd4981b405eb"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (uint8_t b)</td></tr>
|
||||
<tr class="separator:a5c5117dadbe33da1cda5fd4981b405eb"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0ff4b94104bc9058884f7129c629a6d3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ff4b94104bc9058884f7129c629a6d3"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (__FlashStringHelper *)</td></tr>
|
||||
<tr class="separator:a0ff4b94104bc9058884f7129c629a6d3"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a68683a4d8c8b2f4a4d987d5c08a027d0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68683a4d8c8b2f4a4d987d5c08a027d0"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (const String &)</td></tr>
|
||||
<tr class="separator:a68683a4d8c8b2f4a4d987d5c08a027d0"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa6a4e522a21ffd337de213f7f5ead190"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6a4e522a21ffd337de213f7f5ead190"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (const char[])</td></tr>
|
||||
<tr class="separator:aa6a4e522a21ffd337de213f7f5ead190"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a96110fc9b723c92455e0427d4fc7563f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a96110fc9b723c92455e0427d4fc7563f"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (char)</td></tr>
|
||||
<tr class="separator:a96110fc9b723c92455e0427d4fc7563f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0dcf129b97dda7cd7f343344dabfa2ec"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0dcf129b97dda7cd7f343344dabfa2ec"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned char, int=DEC)</td></tr>
|
||||
<tr class="separator:a0dcf129b97dda7cd7f343344dabfa2ec"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0b47e81258fd838dc8c587daad9c75ef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b47e81258fd838dc8c587daad9c75ef"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (int, int=DEC)</td></tr>
|
||||
<tr class="separator:a0b47e81258fd838dc8c587daad9c75ef"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aed7039049b21c0ae5acf650449f6d001"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed7039049b21c0ae5acf650449f6d001"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned int, int=DEC)</td></tr>
|
||||
<tr class="separator:aed7039049b21c0ae5acf650449f6d001"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac3fa4949b30186a215bcdc4eedb8ef7a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac3fa4949b30186a215bcdc4eedb8ef7a"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (long, int=DEC)</td></tr>
|
||||
<tr class="separator:ac3fa4949b30186a215bcdc4eedb8ef7a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a079475eb50465c6b9c8e5e568648925d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a079475eb50465c6b9c8e5e568648925d"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned long, int=DEC)</td></tr>
|
||||
<tr class="separator:a079475eb50465c6b9c8e5e568648925d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a41acb11ec5afacce7217d94a038442b6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a41acb11ec5afacce7217d94a038442b6"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (double, int=2)</td></tr>
|
||||
<tr class="separator:a41acb11ec5afacce7217d94a038442b6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aeded114263fcd3c023a5a7b177041449"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeded114263fcd3c023a5a7b177041449"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (void)</td></tr>
|
||||
<tr class="separator:aeded114263fcd3c023a5a7b177041449"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aab738dbdadc60e5aec75e877d8d64143"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aab738dbdadc60e5aec75e877d8d64143"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (__FlashStringHelper *)</td></tr>
|
||||
<tr class="separator:aab738dbdadc60e5aec75e877d8d64143"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aabac8ec885594abbd85ec2e7b4e07d95"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aabac8ec885594abbd85ec2e7b4e07d95"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (const String &)</td></tr>
|
||||
<tr class="separator:aabac8ec885594abbd85ec2e7b4e07d95"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9c8af8fbfefda966f5400d06dfa10d76"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9c8af8fbfefda966f5400d06dfa10d76"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (const char[])</td></tr>
|
||||
<tr class="separator:a9c8af8fbfefda966f5400d06dfa10d76"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a3f6a25662f28c525fb8ed727358890ea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f6a25662f28c525fb8ed727358890ea"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (char)</td></tr>
|
||||
<tr class="separator:a3f6a25662f28c525fb8ed727358890ea"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:afd39423e75134b2587983418a6a37682"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afd39423e75134b2587983418a6a37682"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned char, int=DEC)</td></tr>
|
||||
<tr class="separator:afd39423e75134b2587983418a6a37682"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a5be90660b3fa491fcfa80609b8f29f56"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5be90660b3fa491fcfa80609b8f29f56"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (int, int=DEC)</td></tr>
|
||||
<tr class="separator:a5be90660b3fa491fcfa80609b8f29f56"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac7eab91507bf0413563c097cfca5196f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac7eab91507bf0413563c097cfca5196f"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned int, int=DEC)</td></tr>
|
||||
<tr class="separator:ac7eab91507bf0413563c097cfca5196f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a236dc21d338d36fd3b7130fe2c46e85e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a236dc21d338d36fd3b7130fe2c46e85e"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (long, int=DEC)</td></tr>
|
||||
<tr class="separator:a236dc21d338d36fd3b7130fe2c46e85e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a72ee891123decbb2d883b8c120e30c18"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72ee891123decbb2d883b8c120e30c18"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned long, int=DEC)</td></tr>
|
||||
<tr class="separator:a72ee891123decbb2d883b8c120e30c18"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ad929fdea641afb17dd56cfcc6e47a438"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad929fdea641afb17dd56cfcc6e47a438"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (double, int=2)</td></tr>
|
||||
<tr class="separator:ad929fdea641afb17dd56cfcc6e47a438"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Client for Hellschreiber transmissions. </p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="a6e3ed5db1904f3f9602e20c3c0d0cbd0"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">HellClient::HellClient </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="class_physical_layer.html">PhysicalLayer</a> * </td>
|
||||
<td class="paramname"><em>phy</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Constructor for 2-FSK mode. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">phy</td><td>Pointer to the wireless module providing <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN...">PhysicalLayer</a> communication. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="afeb347f04148700427ad40614fd057c3"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">HellClient::HellClient </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="class_a_f_s_k_client.html">AFSKClient</a> * </td>
|
||||
<td class="paramname"><em>audio</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Constructor for AFSK mode. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">audio</td><td>Pointer to the AFSK instance providing audio. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a class="anchor" id="a225775fe87f9ed3c3a04142697641242"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t HellClient::begin </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">float </td>
|
||||
<td class="paramname"><em>base</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">float </td>
|
||||
<td class="paramname"><em>rate</em> = <code>122.5</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Initialization method. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">base</td><td>Base RF frequency to be used in MHz (in 2-FSK mode), or the tone frequency in Hz (in AFSK mode).</td></tr>
|
||||
<tr><td class="paramname">rate</td><td>Baud rate to be used during transmission. Defaults to 122.5 ("Feld Hell") </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ac527806ef871dc12555afe7c43a72ed9"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">size_t HellClient::printGlyph </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint8_t * </td>
|
||||
<td class="paramname"><em>buff</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Method to "print" a buffer of pixels, this is exposed to allow users to send custom characters. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">buff</td><td>Buffer of pixels to send, in a 7x7 pixel array. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||
<li>src/protocols/Hellschreiber/<a class="el" href="_hellschreiber_8h_source.html">Hellschreiber.h</a></li>
|
||||
<li>src/protocols/Hellschreiber/Hellschreiber.cpp</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="class_hell_client.html">HellClient</a></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
31
class_hell_client.js
Normal file
31
class_hell_client.js
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
var class_hell_client =
|
||||
[
|
||||
[ "HellClient", "class_hell_client.html#a6e3ed5db1904f3f9602e20c3c0d0cbd0", null ],
|
||||
[ "HellClient", "class_hell_client.html#afeb347f04148700427ad40614fd057c3", null ],
|
||||
[ "begin", "class_hell_client.html#a225775fe87f9ed3c3a04142697641242", null ],
|
||||
[ "print", "class_hell_client.html#a0ff4b94104bc9058884f7129c629a6d3", null ],
|
||||
[ "print", "class_hell_client.html#a68683a4d8c8b2f4a4d987d5c08a027d0", null ],
|
||||
[ "print", "class_hell_client.html#aa6a4e522a21ffd337de213f7f5ead190", null ],
|
||||
[ "print", "class_hell_client.html#a96110fc9b723c92455e0427d4fc7563f", null ],
|
||||
[ "print", "class_hell_client.html#a0dcf129b97dda7cd7f343344dabfa2ec", null ],
|
||||
[ "print", "class_hell_client.html#a0b47e81258fd838dc8c587daad9c75ef", null ],
|
||||
[ "print", "class_hell_client.html#aed7039049b21c0ae5acf650449f6d001", null ],
|
||||
[ "print", "class_hell_client.html#ac3fa4949b30186a215bcdc4eedb8ef7a", null ],
|
||||
[ "print", "class_hell_client.html#a079475eb50465c6b9c8e5e568648925d", null ],
|
||||
[ "print", "class_hell_client.html#a41acb11ec5afacce7217d94a038442b6", null ],
|
||||
[ "printGlyph", "class_hell_client.html#ac527806ef871dc12555afe7c43a72ed9", null ],
|
||||
[ "println", "class_hell_client.html#aeded114263fcd3c023a5a7b177041449", null ],
|
||||
[ "println", "class_hell_client.html#aab738dbdadc60e5aec75e877d8d64143", null ],
|
||||
[ "println", "class_hell_client.html#aabac8ec885594abbd85ec2e7b4e07d95", null ],
|
||||
[ "println", "class_hell_client.html#a9c8af8fbfefda966f5400d06dfa10d76", null ],
|
||||
[ "println", "class_hell_client.html#a3f6a25662f28c525fb8ed727358890ea", null ],
|
||||
[ "println", "class_hell_client.html#afd39423e75134b2587983418a6a37682", null ],
|
||||
[ "println", "class_hell_client.html#a5be90660b3fa491fcfa80609b8f29f56", null ],
|
||||
[ "println", "class_hell_client.html#ac7eab91507bf0413563c097cfca5196f", null ],
|
||||
[ "println", "class_hell_client.html#a236dc21d338d36fd3b7130fe2c46e85e", null ],
|
||||
[ "println", "class_hell_client.html#a72ee891123decbb2d883b8c120e30c18", null ],
|
||||
[ "println", "class_hell_client.html#ad929fdea641afb17dd56cfcc6e47a438", null ],
|
||||
[ "write", "class_hell_client.html#ad82abc52034fafdea84c15530039a6f5", null ],
|
||||
[ "write", "class_hell_client.html#a472555cea11854700db91843c335bded", null ],
|
||||
[ "write", "class_hell_client.html#a5c5117dadbe33da1cda5fd4981b405eb", null ]
|
||||
];
|
||||
159
class_i_serial-members.html
Normal file
159
class_i_serial-members.html
Normal file
|
|
@ -0,0 +1,159 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: Member List</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_i_serial.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">ISerial Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_i_serial.html">ISerial</a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>available</b>() (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>begin</b>(long) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>end</b>() (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>flush</b>() (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>ISerial</b>(Module *mod) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>peek</b>() (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(const __FlashStringHelper *) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(const String &) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(const char[]) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(char) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(unsigned char, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(int, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(unsigned int, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(long, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(unsigned long, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(double, int=2) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(const Printable &) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(const __FlashStringHelper *) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(const String &s) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(const char[]) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(char) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(unsigned char, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(int, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(unsigned int, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(long, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(unsigned long, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(double, int=2) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(const Printable &) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(void) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>read</b>() (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>write</b>(uint8_t) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
248
class_i_serial.html
Normal file
248
class_i_serial.html
Normal file
|
|
@ -0,0 +1,248 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: ISerial Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_i_serial.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="class_i_serial-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">ISerial Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Interface class for Arduino Serial. Only calls the appropriate methods for the active UART interface.
|
||||
<a href="class_i_serial.html#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="_i_serial_8h_source.html">ISerial.h</a>></code></p>
|
||||
<div class="dynheader">
|
||||
Inheritance diagram for ISerial:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center">
|
||||
<img src="class_i_serial.png" usemap="#ISerial_map" alt=""/>
|
||||
<map id="ISerial_map" name="ISerial_map">
|
||||
<area href="class_h_c05.html" title="Control class for HC05 module. Most methods supported by this module are implemented in ISerial inter..." alt="HC05" shape="rect" coords="0,56,76,80"/>
|
||||
<area href="class_j_d_y08.html" title="Control class for JDY08 module. Most methods supported by this module are implemented in ISerial inte..." alt="JDY08" shape="rect" coords="86,56,162,80"/>
|
||||
<area href="class_x_bee_serial.html" title="XBee Serial interface. This class is used for XBees in transparent mode, i.e. when two XBees act as a..." alt="XBeeSerial" shape="rect" coords="172,56,248,80"/>
|
||||
</map>
|
||||
</div></div>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:ae40ab8688a45d252264a45fe7eeb1fec"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae40ab8688a45d252264a45fe7eeb1fec"></a>
|
||||
 </td><td class="memItemRight" valign="bottom"><b>ISerial</b> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
||||
<tr class="separator:ae40ab8688a45d252264a45fe7eeb1fec"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac88cbd52dd52081012c7ebc5e4877a71"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac88cbd52dd52081012c7ebc5e4877a71"></a>
|
||||
void </td><td class="memItemRight" valign="bottom"><b>begin</b> (long)</td></tr>
|
||||
<tr class="separator:ac88cbd52dd52081012c7ebc5e4877a71"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9ab275543e32bbd26093936e93901a64"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ab275543e32bbd26093936e93901a64"></a>
|
||||
void </td><td class="memItemRight" valign="bottom"><b>end</b> ()</td></tr>
|
||||
<tr class="separator:a9ab275543e32bbd26093936e93901a64"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aaec3e37c852ab96dc0cb406f25927020"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaec3e37c852ab96dc0cb406f25927020"></a>
|
||||
int </td><td class="memItemRight" valign="bottom"><b>peek</b> ()</td></tr>
|
||||
<tr class="separator:aaec3e37c852ab96dc0cb406f25927020"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0e3eac99b53d90cd8c725a5cc409e438"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e3eac99b53d90cd8c725a5cc409e438"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (uint8_t)</td></tr>
|
||||
<tr class="separator:a0e3eac99b53d90cd8c725a5cc409e438"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a59bdc39fa8633f3bb6154dacb043ae10"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59bdc39fa8633f3bb6154dacb043ae10"></a>
|
||||
int </td><td class="memItemRight" valign="bottom"><b>read</b> ()</td></tr>
|
||||
<tr class="separator:a59bdc39fa8633f3bb6154dacb043ae10"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a7dfceaa2cb8f849211e64ffbb26a9ccb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7dfceaa2cb8f849211e64ffbb26a9ccb"></a>
|
||||
int </td><td class="memItemRight" valign="bottom"><b>available</b> ()</td></tr>
|
||||
<tr class="separator:a7dfceaa2cb8f849211e64ffbb26a9ccb"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a5073d939918c6ae56e1eb28da4362fc8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5073d939918c6ae56e1eb28da4362fc8"></a>
|
||||
void </td><td class="memItemRight" valign="bottom"><b>flush</b> ()</td></tr>
|
||||
<tr class="separator:a5073d939918c6ae56e1eb28da4362fc8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a71ff41667bb4cb865fae0cb392ba2480"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a71ff41667bb4cb865fae0cb392ba2480"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (const __FlashStringHelper *)</td></tr>
|
||||
<tr class="separator:a71ff41667bb4cb865fae0cb392ba2480"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:afa73455a632e6c6819a2552ad58d3e4a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa73455a632e6c6819a2552ad58d3e4a"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (const String &)</td></tr>
|
||||
<tr class="separator:afa73455a632e6c6819a2552ad58d3e4a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a50a1a3292b06f0b0283bb365e4274e74"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a50a1a3292b06f0b0283bb365e4274e74"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (const char[])</td></tr>
|
||||
<tr class="separator:a50a1a3292b06f0b0283bb365e4274e74"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a37e78871669df20cc65ddd0b3f98eba4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37e78871669df20cc65ddd0b3f98eba4"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (char)</td></tr>
|
||||
<tr class="separator:a37e78871669df20cc65ddd0b3f98eba4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa7de5539ed01b0abd7c3c5c5767b855a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7de5539ed01b0abd7c3c5c5767b855a"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned char, int=DEC)</td></tr>
|
||||
<tr class="separator:aa7de5539ed01b0abd7c3c5c5767b855a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6cbd12b7b47005ab0153066c34f28426"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6cbd12b7b47005ab0153066c34f28426"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (int, int=DEC)</td></tr>
|
||||
<tr class="separator:a6cbd12b7b47005ab0153066c34f28426"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a86997b02021c420e2c1bd7fdd11b1e14"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a86997b02021c420e2c1bd7fdd11b1e14"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned int, int=DEC)</td></tr>
|
||||
<tr class="separator:a86997b02021c420e2c1bd7fdd11b1e14"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a8e5003afc67d7488af5c546f51c9222c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e5003afc67d7488af5c546f51c9222c"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (long, int=DEC)</td></tr>
|
||||
<tr class="separator:a8e5003afc67d7488af5c546f51c9222c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a466ab09bad9fbcb514ffef6528de5d7f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a466ab09bad9fbcb514ffef6528de5d7f"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned long, int=DEC)</td></tr>
|
||||
<tr class="separator:a466ab09bad9fbcb514ffef6528de5d7f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:af66546833df21b2949b26e4771a9f9d6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af66546833df21b2949b26e4771a9f9d6"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (double, int=2)</td></tr>
|
||||
<tr class="separator:af66546833df21b2949b26e4771a9f9d6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a54f478dbde6921d212fe5b2159f4ee93"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54f478dbde6921d212fe5b2159f4ee93"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (const Printable &)</td></tr>
|
||||
<tr class="separator:a54f478dbde6921d212fe5b2159f4ee93"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a16eaec118c2c38db031cc0e9b641b203"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16eaec118c2c38db031cc0e9b641b203"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (const __FlashStringHelper *)</td></tr>
|
||||
<tr class="separator:a16eaec118c2c38db031cc0e9b641b203"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a94f1c1b1e6a94ea418251c666b72eac5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94f1c1b1e6a94ea418251c666b72eac5"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (const String &s)</td></tr>
|
||||
<tr class="separator:a94f1c1b1e6a94ea418251c666b72eac5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a7a91c6fc4dd9e70b438a4ebc2c62b881"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a91c6fc4dd9e70b438a4ebc2c62b881"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (const char[])</td></tr>
|
||||
<tr class="separator:a7a91c6fc4dd9e70b438a4ebc2c62b881"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0ab1d33067885e6456ab61b3b51f07b4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ab1d33067885e6456ab61b3b51f07b4"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (char)</td></tr>
|
||||
<tr class="separator:a0ab1d33067885e6456ab61b3b51f07b4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0b669c99851a4a36945bc7d9b26f1c15"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b669c99851a4a36945bc7d9b26f1c15"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned char, int=DEC)</td></tr>
|
||||
<tr class="separator:a0b669c99851a4a36945bc7d9b26f1c15"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ae96f7b598e2e9bdb5f8bf5b7feb56983"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae96f7b598e2e9bdb5f8bf5b7feb56983"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (int, int=DEC)</td></tr>
|
||||
<tr class="separator:ae96f7b598e2e9bdb5f8bf5b7feb56983"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a85f3dff9f42387e12be59049cb020a88"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a85f3dff9f42387e12be59049cb020a88"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned int, int=DEC)</td></tr>
|
||||
<tr class="separator:a85f3dff9f42387e12be59049cb020a88"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aaa489fda4cc41dac95ed157105f08de6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa489fda4cc41dac95ed157105f08de6"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (long, int=DEC)</td></tr>
|
||||
<tr class="separator:aaa489fda4cc41dac95ed157105f08de6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac46c8197c06b703bcb83ed3947492a4f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac46c8197c06b703bcb83ed3947492a4f"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned long, int=DEC)</td></tr>
|
||||
<tr class="separator:ac46c8197c06b703bcb83ed3947492a4f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a5e25366fa6386a413bb46dd4a62e1931"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e25366fa6386a413bb46dd4a62e1931"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (double, int=2)</td></tr>
|
||||
<tr class="separator:a5e25366fa6386a413bb46dd4a62e1931"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0607b2c508006f1e43d685404be50f23"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0607b2c508006f1e43d685404be50f23"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (const Printable &)</td></tr>
|
||||
<tr class="separator:a0607b2c508006f1e43d685404be50f23"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ab9bb40acf5dd420afed4ea80d7989a20"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9bb40acf5dd420afed4ea80d7989a20"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (void)</td></tr>
|
||||
<tr class="separator:ab9bb40acf5dd420afed4ea80d7989a20"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Interface class for Arduino Serial. Only calls the appropriate methods for the active UART interface. </p>
|
||||
</div><hr/>The documentation for this class was generated from the following files:<ul>
|
||||
<li>src/<a class="el" href="_i_serial_8h_source.html">ISerial.h</a></li>
|
||||
<li>src/ISerial.cpp</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="class_i_serial.html">ISerial</a></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
34
class_i_serial.js
Normal file
34
class_i_serial.js
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
var class_i_serial =
|
||||
[
|
||||
[ "ISerial", "class_i_serial.html#ae40ab8688a45d252264a45fe7eeb1fec", null ],
|
||||
[ "available", "class_i_serial.html#a7dfceaa2cb8f849211e64ffbb26a9ccb", null ],
|
||||
[ "begin", "class_i_serial.html#ac88cbd52dd52081012c7ebc5e4877a71", null ],
|
||||
[ "end", "class_i_serial.html#a9ab275543e32bbd26093936e93901a64", null ],
|
||||
[ "flush", "class_i_serial.html#a5073d939918c6ae56e1eb28da4362fc8", null ],
|
||||
[ "peek", "class_i_serial.html#aaec3e37c852ab96dc0cb406f25927020", null ],
|
||||
[ "print", "class_i_serial.html#a71ff41667bb4cb865fae0cb392ba2480", null ],
|
||||
[ "print", "class_i_serial.html#afa73455a632e6c6819a2552ad58d3e4a", null ],
|
||||
[ "print", "class_i_serial.html#a50a1a3292b06f0b0283bb365e4274e74", null ],
|
||||
[ "print", "class_i_serial.html#a37e78871669df20cc65ddd0b3f98eba4", null ],
|
||||
[ "print", "class_i_serial.html#aa7de5539ed01b0abd7c3c5c5767b855a", null ],
|
||||
[ "print", "class_i_serial.html#a6cbd12b7b47005ab0153066c34f28426", null ],
|
||||
[ "print", "class_i_serial.html#a86997b02021c420e2c1bd7fdd11b1e14", null ],
|
||||
[ "print", "class_i_serial.html#a8e5003afc67d7488af5c546f51c9222c", null ],
|
||||
[ "print", "class_i_serial.html#a466ab09bad9fbcb514ffef6528de5d7f", null ],
|
||||
[ "print", "class_i_serial.html#af66546833df21b2949b26e4771a9f9d6", null ],
|
||||
[ "print", "class_i_serial.html#a54f478dbde6921d212fe5b2159f4ee93", null ],
|
||||
[ "println", "class_i_serial.html#a16eaec118c2c38db031cc0e9b641b203", null ],
|
||||
[ "println", "class_i_serial.html#a94f1c1b1e6a94ea418251c666b72eac5", null ],
|
||||
[ "println", "class_i_serial.html#a7a91c6fc4dd9e70b438a4ebc2c62b881", null ],
|
||||
[ "println", "class_i_serial.html#a0ab1d33067885e6456ab61b3b51f07b4", null ],
|
||||
[ "println", "class_i_serial.html#a0b669c99851a4a36945bc7d9b26f1c15", null ],
|
||||
[ "println", "class_i_serial.html#ae96f7b598e2e9bdb5f8bf5b7feb56983", null ],
|
||||
[ "println", "class_i_serial.html#a85f3dff9f42387e12be59049cb020a88", null ],
|
||||
[ "println", "class_i_serial.html#aaa489fda4cc41dac95ed157105f08de6", null ],
|
||||
[ "println", "class_i_serial.html#ac46c8197c06b703bcb83ed3947492a4f", null ],
|
||||
[ "println", "class_i_serial.html#a5e25366fa6386a413bb46dd4a62e1931", null ],
|
||||
[ "println", "class_i_serial.html#a0607b2c508006f1e43d685404be50f23", null ],
|
||||
[ "println", "class_i_serial.html#ab9bb40acf5dd420afed4ea80d7989a20", null ],
|
||||
[ "read", "class_i_serial.html#a59bdc39fa8633f3bb6154dacb043ae10", null ],
|
||||
[ "write", "class_i_serial.html#a0e3eac99b53d90cd8c725a5cc409e438", null ]
|
||||
];
|
||||
BIN
class_i_serial.png
Normal file
BIN
class_i_serial.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 669 B |
133
class_i_t_a2_string-members.html
Normal file
133
class_i_t_a2_string-members.html
Normal file
|
|
@ -0,0 +1,133 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: Member List</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_i_t_a2_string.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">ITA2String Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_i_t_a2_string.html">ITA2String</a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_i_t_a2_string.html#a3f42f7ad98473dbe36515e676622ed3d">byteArr</a>()</td><td class="entry"><a class="el" href="class_i_t_a2_string.html">ITA2String</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_i_t_a2_string.html#addb6c39167aa5da53fb72e9a94c9c8f5">ITA2String</a>(char c)</td><td class="entry"><a class="el" href="class_i_t_a2_string.html">ITA2String</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_i_t_a2_string.html#a92ca563bdc2ae4d05ee91ce9372e7a55">ITA2String</a>(const char *str)</td><td class="entry"><a class="el" href="class_i_t_a2_string.html">ITA2String</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_i_t_a2_string.html#a79b48f6e1eab664b841f3fd20c333e8e">length</a>()</td><td class="entry"><a class="el" href="class_i_t_a2_string.html">ITA2String</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_i_t_a2_string.html#afde24c931997581878953660192e09a2">~ITA2String</a>()</td><td class="entry"><a class="el" href="class_i_t_a2_string.html">ITA2String</a></td><td class="entry"></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
262
class_i_t_a2_string.html
Normal file
262
class_i_t_a2_string.html
Normal file
|
|
@ -0,0 +1,262 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: ITA2String Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_i_t_a2_string.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="class_i_t_a2_string-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">ITA2String Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>ITA2-encoded string.
|
||||
<a href="class_i_t_a2_string.html#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="_r_t_t_y_8h_source.html">RTTY.h</a>></code></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:addb6c39167aa5da53fb72e9a94c9c8f5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_t_a2_string.html#addb6c39167aa5da53fb72e9a94c9c8f5">ITA2String</a> (char c)</td></tr>
|
||||
<tr class="memdesc:addb6c39167aa5da53fb72e9a94c9c8f5"><td class="mdescLeft"> </td><td class="mdescRight">Default single-character constructor. <a href="#addb6c39167aa5da53fb72e9a94c9c8f5">More...</a><br /></td></tr>
|
||||
<tr class="separator:addb6c39167aa5da53fb72e9a94c9c8f5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a92ca563bdc2ae4d05ee91ce9372e7a55"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_t_a2_string.html#a92ca563bdc2ae4d05ee91ce9372e7a55">ITA2String</a> (const char *str)</td></tr>
|
||||
<tr class="memdesc:a92ca563bdc2ae4d05ee91ce9372e7a55"><td class="mdescLeft"> </td><td class="mdescRight">Default string constructor. <a href="#a92ca563bdc2ae4d05ee91ce9372e7a55">More...</a><br /></td></tr>
|
||||
<tr class="separator:a92ca563bdc2ae4d05ee91ce9372e7a55"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:afde24c931997581878953660192e09a2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afde24c931997581878953660192e09a2"></a>
|
||||
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_t_a2_string.html#afde24c931997581878953660192e09a2">~ITA2String</a> ()</td></tr>
|
||||
<tr class="memdesc:afde24c931997581878953660192e09a2"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br /></td></tr>
|
||||
<tr class="separator:afde24c931997581878953660192e09a2"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a79b48f6e1eab664b841f3fd20c333e8e"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_t_a2_string.html#a79b48f6e1eab664b841f3fd20c333e8e">length</a> ()</td></tr>
|
||||
<tr class="memdesc:a79b48f6e1eab664b841f3fd20c333e8e"><td class="mdescLeft"> </td><td class="mdescRight">Gets the length of the ITA2 string. This number is not the same as the length of ASCII-encoded string! <a href="#a79b48f6e1eab664b841f3fd20c333e8e">More...</a><br /></td></tr>
|
||||
<tr class="separator:a79b48f6e1eab664b841f3fd20c333e8e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a3f42f7ad98473dbe36515e676622ed3d"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_t_a2_string.html#a3f42f7ad98473dbe36515e676622ed3d">byteArr</a> ()</td></tr>
|
||||
<tr class="memdesc:a3f42f7ad98473dbe36515e676622ed3d"><td class="mdescLeft"> </td><td class="mdescRight">Gets the ITA2 representation of the ASCII string set in constructor. <a href="#a3f42f7ad98473dbe36515e676622ed3d">More...</a><br /></td></tr>
|
||||
<tr class="separator:a3f42f7ad98473dbe36515e676622ed3d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>ITA2-encoded string. </p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="addb6c39167aa5da53fb72e9a94c9c8f5"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ITA2String::ITA2String </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">char </td>
|
||||
<td class="paramname"><em>c</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Default single-character constructor. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">c</td><td>ASCII-encoded character to encode as ITA2. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a92ca563bdc2ae4d05ee91ce9372e7a55"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">ITA2String::ITA2String </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>str</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Default string constructor. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">str</td><td>ASCII-encoded string to encode as ITA2. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a class="anchor" id="a3f42f7ad98473dbe36515e676622ed3d"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint8_t * ITA2String::byteArr </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Gets the ITA2 representation of the ASCII string set in constructor. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Pointer to dynamically allocated array, which contains ITA2-encoded bytes. It is the caller's responsibility to deallocate this memory! </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a79b48f6e1eab664b841f3fd20c333e8e"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">size_t ITA2String::length </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Gets the length of the ITA2 string. This number is not the same as the length of ASCII-encoded string! </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Length of ITA2-encoded string. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||
<li>src/protocols/RTTY/<a class="el" href="_r_t_t_y_8h_source.html">RTTY.h</a></li>
|
||||
<li>src/protocols/RTTY/RTTY.cpp</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="class_i_t_a2_string.html">ITA2String</a></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
8
class_i_t_a2_string.js
Normal file
8
class_i_t_a2_string.js
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
var class_i_t_a2_string =
|
||||
[
|
||||
[ "ITA2String", "class_i_t_a2_string.html#addb6c39167aa5da53fb72e9a94c9c8f5", null ],
|
||||
[ "ITA2String", "class_i_t_a2_string.html#a92ca563bdc2ae4d05ee91ce9372e7a55", null ],
|
||||
[ "~ITA2String", "class_i_t_a2_string.html#afde24c931997581878953660192e09a2", null ],
|
||||
[ "byteArr", "class_i_t_a2_string.html#a3f42f7ad98473dbe36515e676622ed3d", null ],
|
||||
[ "length", "class_i_t_a2_string.html#a79b48f6e1eab664b841f3fd20c333e8e", null ]
|
||||
];
|
||||
160
class_j_d_y08-members.html
Normal file
160
class_j_d_y08-members.html
Normal file
|
|
@ -0,0 +1,160 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: Member List</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_j_d_y08.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">JDY08 Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_j_d_y08.html">JDY08</a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>available</b>() (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_j_d_y08.html#a6fca03bb9f163c16d193904beac6b0b1">begin</a>(long speed)</td><td class="entry"><a class="el" href="class_j_d_y08.html">JDY08</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>end</b>() (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>flush</b>() (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>ISerial</b>(Module *mod) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_j_d_y08.html#a9e2895c29cbbb30bc49aa2b3b9d2c4d6">JDY08</a>(Module *mod)</td><td class="entry"><a class="el" href="class_j_d_y08.html">JDY08</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>peek</b>() (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(const __FlashStringHelper *) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(const String &) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(const char[]) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(char) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(unsigned char, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(int, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(unsigned int, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(long, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(unsigned long, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(double, int=2) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(const Printable &) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(const __FlashStringHelper *) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(const String &s) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(const char[]) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(char) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(unsigned char, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(int, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(unsigned int, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(long, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(unsigned long, int=DEC) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(double, int=2) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(const Printable &) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(void) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>read</b>() (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>write</b>(uint8_t) (defined in <a class="el" href="class_i_serial.html">ISerial</a>)</td><td class="entry"><a class="el" href="class_i_serial.html">ISerial</a></td><td class="entry"></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
303
class_j_d_y08.html
Normal file
303
class_j_d_y08.html
Normal file
|
|
@ -0,0 +1,303 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: JDY08 Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_j_d_y08.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="class_j_d_y08-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">JDY08 Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Control class for JDY08 module. Most methods supported by this module are implemented in <a class="el" href="class_i_serial.html" title="Interface class for Arduino Serial. Only calls the appropriate methods for the active UART interface...">ISerial</a> interface.
|
||||
<a href="class_j_d_y08.html#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="_j_d_y08_8h_source.html">JDY08.h</a>></code></p>
|
||||
<div class="dynheader">
|
||||
Inheritance diagram for JDY08:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center">
|
||||
<img src="class_j_d_y08.png" usemap="#JDY08_map" alt=""/>
|
||||
<map id="JDY08_map" name="JDY08_map">
|
||||
<area href="class_i_serial.html" title="Interface class for Arduino Serial. Only calls the appropriate methods for the active UART interface..." alt="ISerial" shape="rect" coords="0,0,51,24"/>
|
||||
</map>
|
||||
</div></div>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a9e2895c29cbbb30bc49aa2b3b9d2c4d6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_d_y08.html#a9e2895c29cbbb30bc49aa2b3b9d2c4d6">JDY08</a> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
||||
<tr class="memdesc:a9e2895c29cbbb30bc49aa2b3b9d2c4d6"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a9e2895c29cbbb30bc49aa2b3b9d2c4d6">More...</a><br /></td></tr>
|
||||
<tr class="separator:a9e2895c29cbbb30bc49aa2b3b9d2c4d6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6fca03bb9f163c16d193904beac6b0b1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_d_y08.html#a6fca03bb9f163c16d193904beac6b0b1">begin</a> (long speed)</td></tr>
|
||||
<tr class="memdesc:a6fca03bb9f163c16d193904beac6b0b1"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. <a href="#a6fca03bb9f163c16d193904beac6b0b1">More...</a><br /></td></tr>
|
||||
<tr class="separator:a6fca03bb9f163c16d193904beac6b0b1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="inherit_header pub_methods_class_i_serial"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_i_serial')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_i_serial.html">ISerial</a></td></tr>
|
||||
<tr class="memitem:ae40ab8688a45d252264a45fe7eeb1fec inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae40ab8688a45d252264a45fe7eeb1fec"></a>
|
||||
 </td><td class="memItemRight" valign="bottom"><b>ISerial</b> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
||||
<tr class="separator:ae40ab8688a45d252264a45fe7eeb1fec inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac88cbd52dd52081012c7ebc5e4877a71 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac88cbd52dd52081012c7ebc5e4877a71"></a>
|
||||
void </td><td class="memItemRight" valign="bottom"><b>begin</b> (long)</td></tr>
|
||||
<tr class="separator:ac88cbd52dd52081012c7ebc5e4877a71 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9ab275543e32bbd26093936e93901a64 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ab275543e32bbd26093936e93901a64"></a>
|
||||
void </td><td class="memItemRight" valign="bottom"><b>end</b> ()</td></tr>
|
||||
<tr class="separator:a9ab275543e32bbd26093936e93901a64 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aaec3e37c852ab96dc0cb406f25927020 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaec3e37c852ab96dc0cb406f25927020"></a>
|
||||
int </td><td class="memItemRight" valign="bottom"><b>peek</b> ()</td></tr>
|
||||
<tr class="separator:aaec3e37c852ab96dc0cb406f25927020 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0e3eac99b53d90cd8c725a5cc409e438 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e3eac99b53d90cd8c725a5cc409e438"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (uint8_t)</td></tr>
|
||||
<tr class="separator:a0e3eac99b53d90cd8c725a5cc409e438 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a59bdc39fa8633f3bb6154dacb043ae10 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59bdc39fa8633f3bb6154dacb043ae10"></a>
|
||||
int </td><td class="memItemRight" valign="bottom"><b>read</b> ()</td></tr>
|
||||
<tr class="separator:a59bdc39fa8633f3bb6154dacb043ae10 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a7dfceaa2cb8f849211e64ffbb26a9ccb inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7dfceaa2cb8f849211e64ffbb26a9ccb"></a>
|
||||
int </td><td class="memItemRight" valign="bottom"><b>available</b> ()</td></tr>
|
||||
<tr class="separator:a7dfceaa2cb8f849211e64ffbb26a9ccb inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a5073d939918c6ae56e1eb28da4362fc8 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5073d939918c6ae56e1eb28da4362fc8"></a>
|
||||
void </td><td class="memItemRight" valign="bottom"><b>flush</b> ()</td></tr>
|
||||
<tr class="separator:a5073d939918c6ae56e1eb28da4362fc8 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a71ff41667bb4cb865fae0cb392ba2480 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a71ff41667bb4cb865fae0cb392ba2480"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (const __FlashStringHelper *)</td></tr>
|
||||
<tr class="separator:a71ff41667bb4cb865fae0cb392ba2480 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:afa73455a632e6c6819a2552ad58d3e4a inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa73455a632e6c6819a2552ad58d3e4a"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (const String &)</td></tr>
|
||||
<tr class="separator:afa73455a632e6c6819a2552ad58d3e4a inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a50a1a3292b06f0b0283bb365e4274e74 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a50a1a3292b06f0b0283bb365e4274e74"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (const char[])</td></tr>
|
||||
<tr class="separator:a50a1a3292b06f0b0283bb365e4274e74 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a37e78871669df20cc65ddd0b3f98eba4 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37e78871669df20cc65ddd0b3f98eba4"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (char)</td></tr>
|
||||
<tr class="separator:a37e78871669df20cc65ddd0b3f98eba4 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa7de5539ed01b0abd7c3c5c5767b855a inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7de5539ed01b0abd7c3c5c5767b855a"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned char, int=DEC)</td></tr>
|
||||
<tr class="separator:aa7de5539ed01b0abd7c3c5c5767b855a inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6cbd12b7b47005ab0153066c34f28426 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6cbd12b7b47005ab0153066c34f28426"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (int, int=DEC)</td></tr>
|
||||
<tr class="separator:a6cbd12b7b47005ab0153066c34f28426 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a86997b02021c420e2c1bd7fdd11b1e14 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a86997b02021c420e2c1bd7fdd11b1e14"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned int, int=DEC)</td></tr>
|
||||
<tr class="separator:a86997b02021c420e2c1bd7fdd11b1e14 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a8e5003afc67d7488af5c546f51c9222c inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e5003afc67d7488af5c546f51c9222c"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (long, int=DEC)</td></tr>
|
||||
<tr class="separator:a8e5003afc67d7488af5c546f51c9222c inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a466ab09bad9fbcb514ffef6528de5d7f inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a466ab09bad9fbcb514ffef6528de5d7f"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned long, int=DEC)</td></tr>
|
||||
<tr class="separator:a466ab09bad9fbcb514ffef6528de5d7f inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:af66546833df21b2949b26e4771a9f9d6 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af66546833df21b2949b26e4771a9f9d6"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (double, int=2)</td></tr>
|
||||
<tr class="separator:af66546833df21b2949b26e4771a9f9d6 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a54f478dbde6921d212fe5b2159f4ee93 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54f478dbde6921d212fe5b2159f4ee93"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (const Printable &)</td></tr>
|
||||
<tr class="separator:a54f478dbde6921d212fe5b2159f4ee93 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a16eaec118c2c38db031cc0e9b641b203 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16eaec118c2c38db031cc0e9b641b203"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (const __FlashStringHelper *)</td></tr>
|
||||
<tr class="separator:a16eaec118c2c38db031cc0e9b641b203 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a94f1c1b1e6a94ea418251c666b72eac5 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94f1c1b1e6a94ea418251c666b72eac5"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (const String &s)</td></tr>
|
||||
<tr class="separator:a94f1c1b1e6a94ea418251c666b72eac5 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a7a91c6fc4dd9e70b438a4ebc2c62b881 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a91c6fc4dd9e70b438a4ebc2c62b881"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (const char[])</td></tr>
|
||||
<tr class="separator:a7a91c6fc4dd9e70b438a4ebc2c62b881 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0ab1d33067885e6456ab61b3b51f07b4 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ab1d33067885e6456ab61b3b51f07b4"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (char)</td></tr>
|
||||
<tr class="separator:a0ab1d33067885e6456ab61b3b51f07b4 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0b669c99851a4a36945bc7d9b26f1c15 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b669c99851a4a36945bc7d9b26f1c15"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned char, int=DEC)</td></tr>
|
||||
<tr class="separator:a0b669c99851a4a36945bc7d9b26f1c15 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ae96f7b598e2e9bdb5f8bf5b7feb56983 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae96f7b598e2e9bdb5f8bf5b7feb56983"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (int, int=DEC)</td></tr>
|
||||
<tr class="separator:ae96f7b598e2e9bdb5f8bf5b7feb56983 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a85f3dff9f42387e12be59049cb020a88 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a85f3dff9f42387e12be59049cb020a88"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned int, int=DEC)</td></tr>
|
||||
<tr class="separator:a85f3dff9f42387e12be59049cb020a88 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aaa489fda4cc41dac95ed157105f08de6 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa489fda4cc41dac95ed157105f08de6"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (long, int=DEC)</td></tr>
|
||||
<tr class="separator:aaa489fda4cc41dac95ed157105f08de6 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac46c8197c06b703bcb83ed3947492a4f inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac46c8197c06b703bcb83ed3947492a4f"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned long, int=DEC)</td></tr>
|
||||
<tr class="separator:ac46c8197c06b703bcb83ed3947492a4f inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a5e25366fa6386a413bb46dd4a62e1931 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e25366fa6386a413bb46dd4a62e1931"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (double, int=2)</td></tr>
|
||||
<tr class="separator:a5e25366fa6386a413bb46dd4a62e1931 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0607b2c508006f1e43d685404be50f23 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0607b2c508006f1e43d685404be50f23"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (const Printable &)</td></tr>
|
||||
<tr class="separator:a0607b2c508006f1e43d685404be50f23 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ab9bb40acf5dd420afed4ea80d7989a20 inherit pub_methods_class_i_serial"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9bb40acf5dd420afed4ea80d7989a20"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (void)</td></tr>
|
||||
<tr class="separator:ab9bb40acf5dd420afed4ea80d7989a20 inherit pub_methods_class_i_serial"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Control class for JDY08 module. Most methods supported by this module are implemented in <a class="el" href="class_i_serial.html" title="Interface class for Arduino Serial. Only calls the appropriate methods for the active UART interface...">ISerial</a> interface. </p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="a9e2895c29cbbb30bc49aa2b3b9d2c4d6"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">JDY08::JDY08 </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="class_module.html">Module</a> * </td>
|
||||
<td class="paramname"><em>mod</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Default constructor. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">mod</td><td>Instance of <a class="el" href="class_module.html" title="Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class. ">Module</a> that will be used to communicate with the radio. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a class="anchor" id="a6fca03bb9f163c16d193904beac6b0b1"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void JDY08::begin </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">long </td>
|
||||
<td class="paramname"><em>speed</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Initialization method. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">speed</td><td>Baud rate to use for UART interface. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||
<li>src/modules/JDY08/<a class="el" href="_j_d_y08_8h_source.html">JDY08.h</a></li>
|
||||
<li>src/modules/JDY08/JDY08.cpp</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="class_j_d_y08.html">JDY08</a></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
5
class_j_d_y08.js
Normal file
5
class_j_d_y08.js
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
var class_j_d_y08 =
|
||||
[
|
||||
[ "JDY08", "class_j_d_y08.html#a9e2895c29cbbb30bc49aa2b3b9d2c4d6", null ],
|
||||
[ "begin", "class_j_d_y08.html#a6fca03bb9f163c16d193904beac6b0b1", null ]
|
||||
];
|
||||
BIN
class_j_d_y08.png
Normal file
BIN
class_j_d_y08.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 330 B |
137
class_m_q_t_t_client-members.html
Normal file
137
class_m_q_t_t_client-members.html
Normal file
|
|
@ -0,0 +1,137 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: Member List</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_m_q_t_t_client.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">MQTTClient Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_m_q_t_t_client.html">MQTTClient</a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_m_q_t_t_client.html#a49cb16ef730ad50ba5dc472ac10d933e">check</a>(void(*func)(const char *, const char *))</td><td class="entry"><a class="el" href="class_m_q_t_t_client.html">MQTTClient</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_m_q_t_t_client.html#ac15b32e89df903b20b066113bf8c4a88">connect</a>(const char *host, const char *clientId, const char *userName="", const char *password="", uint16_t keepAlive=60, bool cleanSession=true, const char *willTopic="", const char *willMessage="")</td><td class="entry"><a class="el" href="class_m_q_t_t_client.html">MQTTClient</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_m_q_t_t_client.html#af10176e2cf67bd652823d44f3203a96e">disconnect</a>()</td><td class="entry"><a class="el" href="class_m_q_t_t_client.html">MQTTClient</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_m_q_t_t_client.html#a6ecdbc80b76ae32b926e84af620dacb6">MQTTClient</a>(TransportLayer *tl, uint16_t port=1883)</td><td class="entry"><a class="el" href="class_m_q_t_t_client.html">MQTTClient</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_m_q_t_t_client.html#aea3fb930ed43a0b3122ccc90efebb99d">ping</a>()</td><td class="entry"><a class="el" href="class_m_q_t_t_client.html">MQTTClient</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_m_q_t_t_client.html#ace3ee45313dea2f853207accf20b7c87">publish</a>(String &topic, String &message)</td><td class="entry"><a class="el" href="class_m_q_t_t_client.html">MQTTClient</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_m_q_t_t_client.html#ab59a1174098dfdf514d8ec6d0bd9d015">publish</a>(const char *topic, const char *message)</td><td class="entry"><a class="el" href="class_m_q_t_t_client.html">MQTTClient</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_m_q_t_t_client.html#a9488df90534953c33d76e9183965a300">subscribe</a>(const char *topicFilter)</td><td class="entry"><a class="el" href="class_m_q_t_t_client.html">MQTTClient</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_m_q_t_t_client.html#a782158f20b289746b7b6884fd922a22c">unsubscribe</a>(const char *topicFilter)</td><td class="entry"><a class="el" href="class_m_q_t_t_client.html">MQTTClient</a></td><td class="entry"></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
471
class_m_q_t_t_client.html
Normal file
471
class_m_q_t_t_client.html
Normal file
|
|
@ -0,0 +1,471 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: MQTTClient Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_m_q_t_t_client.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="class_m_q_t_t_client-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">MQTTClient Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Client for simple MQTT communication.
|
||||
<a href="class_m_q_t_t_client.html#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="_m_q_t_t_8h_source.html">MQTT.h</a>></code></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a6ecdbc80b76ae32b926e84af620dacb6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_q_t_t_client.html#a6ecdbc80b76ae32b926e84af620dacb6">MQTTClient</a> (<a class="el" href="class_transport_layer.html">TransportLayer</a> *tl, uint16_t port=1883)</td></tr>
|
||||
<tr class="memdesc:a6ecdbc80b76ae32b926e84af620dacb6"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a6ecdbc80b76ae32b926e84af620dacb6">More...</a><br /></td></tr>
|
||||
<tr class="separator:a6ecdbc80b76ae32b926e84af620dacb6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac15b32e89df903b20b066113bf8c4a88"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_q_t_t_client.html#ac15b32e89df903b20b066113bf8c4a88">connect</a> (const char *host, const char *clientId, const char *userName="", const char *password="", uint16_t keepAlive=60, bool cleanSession=true, const char *willTopic="", const char *willMessage="")</td></tr>
|
||||
<tr class="memdesc:ac15b32e89df903b20b066113bf8c4a88"><td class="mdescLeft"> </td><td class="mdescRight">Connects to MQTT broker (/server). <a href="#ac15b32e89df903b20b066113bf8c4a88">More...</a><br /></td></tr>
|
||||
<tr class="separator:ac15b32e89df903b20b066113bf8c4a88"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:af10176e2cf67bd652823d44f3203a96e"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_q_t_t_client.html#af10176e2cf67bd652823d44f3203a96e">disconnect</a> ()</td></tr>
|
||||
<tr class="memdesc:af10176e2cf67bd652823d44f3203a96e"><td class="mdescLeft"> </td><td class="mdescRight">Disconnect from MQTT broker. <a href="#af10176e2cf67bd652823d44f3203a96e">More...</a><br /></td></tr>
|
||||
<tr class="separator:af10176e2cf67bd652823d44f3203a96e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ace3ee45313dea2f853207accf20b7c87"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_q_t_t_client.html#ace3ee45313dea2f853207accf20b7c87">publish</a> (String &topic, String &message)</td></tr>
|
||||
<tr class="memdesc:ace3ee45313dea2f853207accf20b7c87"><td class="mdescLeft"> </td><td class="mdescRight">Publish MQTT message. <a href="#ace3ee45313dea2f853207accf20b7c87">More...</a><br /></td></tr>
|
||||
<tr class="separator:ace3ee45313dea2f853207accf20b7c87"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ab59a1174098dfdf514d8ec6d0bd9d015"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_q_t_t_client.html#ab59a1174098dfdf514d8ec6d0bd9d015">publish</a> (const char *topic, const char *message)</td></tr>
|
||||
<tr class="memdesc:ab59a1174098dfdf514d8ec6d0bd9d015"><td class="mdescLeft"> </td><td class="mdescRight">Publish MQTT message. <a href="#ab59a1174098dfdf514d8ec6d0bd9d015">More...</a><br /></td></tr>
|
||||
<tr class="separator:ab59a1174098dfdf514d8ec6d0bd9d015"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9488df90534953c33d76e9183965a300"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_q_t_t_client.html#a9488df90534953c33d76e9183965a300">subscribe</a> (const char *topicFilter)</td></tr>
|
||||
<tr class="memdesc:a9488df90534953c33d76e9183965a300"><td class="mdescLeft"> </td><td class="mdescRight">Subscribe to MQTT topic. <a href="#a9488df90534953c33d76e9183965a300">More...</a><br /></td></tr>
|
||||
<tr class="separator:a9488df90534953c33d76e9183965a300"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a782158f20b289746b7b6884fd922a22c"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_q_t_t_client.html#a782158f20b289746b7b6884fd922a22c">unsubscribe</a> (const char *topicFilter)</td></tr>
|
||||
<tr class="memdesc:a782158f20b289746b7b6884fd922a22c"><td class="mdescLeft"> </td><td class="mdescRight">Unsubscribe from MQTT topic. <a href="#a782158f20b289746b7b6884fd922a22c">More...</a><br /></td></tr>
|
||||
<tr class="separator:a782158f20b289746b7b6884fd922a22c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aea3fb930ed43a0b3122ccc90efebb99d"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_q_t_t_client.html#aea3fb930ed43a0b3122ccc90efebb99d">ping</a> ()</td></tr>
|
||||
<tr class="memdesc:aea3fb930ed43a0b3122ccc90efebb99d"><td class="mdescLeft"> </td><td class="mdescRight">Ping MQTT broker. This method can be used to keep connection open. <a href="#aea3fb930ed43a0b3122ccc90efebb99d">More...</a><br /></td></tr>
|
||||
<tr class="separator:aea3fb930ed43a0b3122ccc90efebb99d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a49cb16ef730ad50ba5dc472ac10d933e"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_q_t_t_client.html#a49cb16ef730ad50ba5dc472ac10d933e">check</a> (void(*func)(const char *, const char *))</td></tr>
|
||||
<tr class="memdesc:a49cb16ef730ad50ba5dc472ac10d933e"><td class="mdescLeft"> </td><td class="mdescRight">Set function to be called when checking new messages in subscribed topics. <a href="#a49cb16ef730ad50ba5dc472ac10d933e">More...</a><br /></td></tr>
|
||||
<tr class="separator:a49cb16ef730ad50ba5dc472ac10d933e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Client for simple MQTT communication. </p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="a6ecdbc80b76ae32b926e84af620dacb6"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">MQTTClient::MQTTClient </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="class_transport_layer.html">TransportLayer</a> * </td>
|
||||
<td class="paramname"><em>tl</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint16_t </td>
|
||||
<td class="paramname"><em>port</em> = <code>1883</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Default constructor. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">tl</td><td>Pointer to the wireless module providing <a class="el" href="class_transport_layer.html" title="Provides common interface for protocols that run on modules with Internet connectivity, such as HTTP or MQTT. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class. ">TransportLayer</a> communication. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a class="anchor" id="a49cb16ef730ad50ba5dc472ac10d933e"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t MQTTClient::check </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void(*)(const char *, const char *) </td>
|
||||
<td class="paramname"><em>func</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Set function to be called when checking new messages in subscribed topics. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ac15b32e89df903b20b066113bf8c4a88"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t MQTTClient::connect </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>host</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>clientId</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>userName</em> = <code>""</code>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>password</em> = <code>""</code>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint16_t </td>
|
||||
<td class="paramname"><em>keepAlive</em> = <code>60</code>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>cleanSession</em> = <code>true</code>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>willTopic</em> = <code>""</code>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>willMessage</em> = <code>""</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Connects to MQTT broker (/server). </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">host</td><td>URL of the MQTT broker.</td></tr>
|
||||
<tr><td class="paramname">clientId</td><td>ID of the client.</td></tr>
|
||||
<tr><td class="paramname">username</td><td>Username to be used in the connection. Defaults to empty string (no username).</td></tr>
|
||||
<tr><td class="paramname">password</td><td>Password to be used in the connection. Defaults to empty string (no password).</td></tr>
|
||||
<tr><td class="paramname">keepAlive</td><td>Connection keep-alive period in seconds. Defaults to 60.</td></tr>
|
||||
<tr><td class="paramname">cleanSession</td><td>MQTT CleanSession flag. Defaults to true.</td></tr>
|
||||
<tr><td class="paramname">willTopic</td><td>MQTT will topic. Defaults to empty string (no will topic).</td></tr>
|
||||
<tr><td class="paramname">willMessage</td><td>MQTT will message. Defaults to empty string (no will message).</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="af10176e2cf67bd652823d44f3203a96e"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t MQTTClient::disconnect </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Disconnect from MQTT broker. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="aea3fb930ed43a0b3122ccc90efebb99d"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t MQTTClient::ping </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Ping MQTT broker. This method can be used to keep connection open. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ace3ee45313dea2f853207accf20b7c87"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t MQTTClient::publish </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">String & </td>
|
||||
<td class="paramname"><em>topic</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">String & </td>
|
||||
<td class="paramname"><em>message</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Publish MQTT message. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">topic</td><td>MQTT topic to which the message will be published.</td></tr>
|
||||
<tr><td class="paramname">message</td><td>Message to be published.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ab59a1174098dfdf514d8ec6d0bd9d015"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t MQTTClient::publish </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>topic</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>message</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Publish MQTT message. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">topic</td><td>MQTT topic to which the message will be published.</td></tr>
|
||||
<tr><td class="paramname">message</td><td>Message to be published.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000017">Todo:</a></b></dt><dd>implement QoS > 0 and PUBACK response checking </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a9488df90534953c33d76e9183965a300"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t MQTTClient::subscribe </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>topicFilter</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Subscribe to MQTT topic. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">topicFilter</td><td>Topic to subscribe to.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a782158f20b289746b7b6884fd922a22c"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t MQTTClient::unsubscribe </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>topicFilter</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Unsubscribe from MQTT topic. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">topicFilter</td><td>Topic to unsubscribe from.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||
<li>src/protocols/MQTT/<a class="el" href="_m_q_t_t_8h_source.html">MQTT.h</a></li>
|
||||
<li>src/protocols/MQTT/MQTT.cpp</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="class_m_q_t_t_client.html">MQTTClient</a></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
12
class_m_q_t_t_client.js
Normal file
12
class_m_q_t_t_client.js
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
var class_m_q_t_t_client =
|
||||
[
|
||||
[ "MQTTClient", "class_m_q_t_t_client.html#a6ecdbc80b76ae32b926e84af620dacb6", null ],
|
||||
[ "check", "class_m_q_t_t_client.html#a49cb16ef730ad50ba5dc472ac10d933e", null ],
|
||||
[ "connect", "class_m_q_t_t_client.html#ac15b32e89df903b20b066113bf8c4a88", null ],
|
||||
[ "disconnect", "class_m_q_t_t_client.html#af10176e2cf67bd652823d44f3203a96e", null ],
|
||||
[ "ping", "class_m_q_t_t_client.html#aea3fb930ed43a0b3122ccc90efebb99d", null ],
|
||||
[ "publish", "class_m_q_t_t_client.html#ace3ee45313dea2f853207accf20b7c87", null ],
|
||||
[ "publish", "class_m_q_t_t_client.html#ab59a1174098dfdf514d8ec6d0bd9d015", null ],
|
||||
[ "subscribe", "class_m_q_t_t_client.html#a9488df90534953c33d76e9183965a300", null ],
|
||||
[ "unsubscribe", "class_m_q_t_t_client.html#a782158f20b289746b7b6884fd922a22c", null ]
|
||||
];
|
||||
176
class_module-members.html
Normal file
176
class_module-members.html
Normal file
|
|
@ -0,0 +1,176 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: Member List</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_module.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">Module Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_module.html">Module</a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#ad5767216ba9340ae6d86915b12e89bd6">ATemptyBuffer</a>()</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#ad1aadc2b52eea2bf9d26591091eec3f1">ATgetResponse</a>()</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#a9d8ab2ff353bad5d0e7568d300a48ba0">AtLineFeed</a></td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#a5c09c878b55f56990dd0c2972a3440c4">ATsendCommand</a>(const char *cmd)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#a623aee6405b330b7c935013ff3d01100">ATsendData</a>(uint8_t *data, uint32_t len)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#a91aaa34aecdfeaf24948551b037033be">attachInterrupt</a>(RADIOLIB_PIN_TYPE interruptNum, void(*userFunc)(void), RADIOLIB_INTERRUPT_STATUS mode)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#a128ead3f3198e3b06d39a128a5d6c777">baudrate</a></td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#af0f870b09b9dd9636f1587d708f07d38">delay</a>(uint32_t ms)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#a14d7cd8220bfa4440bda055ce5be748c">delayMicroseconds</a>(uint32_t us)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#a656738f2fe41fb236d27aed02efa8ad4">detachInterrupt</a>(RADIOLIB_PIN_TYPE interruptNum)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#a7495c81640aac8f4686221dad34a274f">digitalRead</a>(RADIOLIB_PIN_TYPE pin)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#a46ad10b113df7c7e0a932be19eff63cd">digitalWrite</a>(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#ad9e1458c0eb4f7c117d53e35450bbd76">getCs</a>() const </td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#a3b1d62f6df09d175179effd04c931881">getGpio</a>() const </td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#a55ddb0fc8ce53db3a333b71fb798e0af">getIrq</a>() const </td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#aa4179db40b566a336d28ca33763c6b11">getRst</a>() const </td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#acbffe457d532fed652664debcb3c7748">getRx</a>() const </td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#a9909bad63883b996e856deceb2a2d48d">getSpi</a>() const </td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#a2ba602f873ba747733eed9f54ca94ed1">getSpiSettings</a>() const </td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#a5a2b7fd8c262a01d1abc1b5f4f9c3513">getTx</a>() const </td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#adb22d89bc5f532f1d056d9a9f3a6589c">init</a>(uint8_t interface)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#af3f51e517a825949891ad29e30fd3f59">micros</a>()</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#a216dd0c6ce140857f2b003ab8d89fbac">millis</a>()</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#a5ea76bc25ef979ec1ff90c032e476004">Module</a>(RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, HardwareSerial *serial=nullptr, RADIOLIB_PIN_TYPE rst=RADIOLIB_NC)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#a06b2e1f1eb9e07a280e55f517f2fab38">Module</a>(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#ae8709b81f592a23ebd72ba3fd8066b0f">Module</a>(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#ac65f3d9e022b3284134ced1c20bcff09">Module</a>(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, SPIClass &spi, SPISettings spiSettings)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#af67217bf4771f4becb0f89b2a90054c4">Module</a>(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio, SPIClass &spi, SPISettings spiSettings)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#a56456ade4eeffa2c566a6fc3fd098276">Module</a>(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, SPIClass &spi=RADIOLIB_DEFAULT_SPI, SPISettings spiSettings=SPISettings(2000000, MSBFIRST, SPI_MODE0), HardwareSerial *serial=nullptr)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#a919baf2e46c357ebfcdbc1025b6c551e">Module</a>(const Module &mod)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#a99556decb983f682b98220ae5434b004">ModuleSerial</a></td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#af998b86ce1243f616f6fcb6df5336207">noTone</a>(RADIOLIB_PIN_TYPE pin)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#a4ea888758b4a7784082d513a1e7849a4">operator=</a>(const Module &mod)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#af7e4872dad3d19b6f75f532c88683168">pinMode</a>(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#a0ecbb4e1e98094c1296b1e823dc14703">setRfSwitchPins</a>(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#a4a87d59ad2bf6bb1bb9de1856a81b824">setRfSwitchState</a>(RADIOLIB_PIN_STATUS rxPinState, RADIOLIB_PIN_STATUS txPinState)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#ad7ca9ae5a22cdacdf9437ca9cd37c9b4">SPIgetRegValue</a>(uint8_t reg, uint8_t msb=7, uint8_t lsb=0)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#a849ad85fc1bc3a7130e660c13973ab26">SPIreadCommand</a></td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#a1d1a279cc7e1ab92e30c29c4dcca26a3">SPIreadRegister</a>(uint8_t reg)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#a6fa5239d73379e4140f5c4f513b1b8d2">SPIreadRegisterBurst</a>(uint8_t reg, uint8_t numBytes, uint8_t *inBytes)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#a87ca265fa2d1fe7c251b4230ef6bd6ca">SPIsetRegValue</a>(uint8_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#aefd955f1cd6d588b2cc229db87cb2121">SPItransfer</a>(uint8_t cmd, uint8_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#ae89764d15e8df5694a6aec0e18f72d3f">SPIwriteCommand</a></td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#ab814614ddd34b57f5a612a20f5fe4c57">SPIwriteRegister</a>(uint8_t reg, uint8_t data)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#a9d77a08070cbd48fd4ece62a739333e9">SPIwriteRegisterBurst</a>(uint8_t reg, uint8_t *data, uint8_t numBytes)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#af0569f6930da7bee761eeca8158aed3a">term</a>(uint8_t interface)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_module.html#a32ba59613a2f1e77038956e18d9fedd7">tone</a>(RADIOLIB_PIN_TYPE pin, uint16_t value)</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_module.html#a227d2d38e4747d0f49bb4df1c80b45d7">yield</a>()</td><td class="entry"><a class="el" href="class_module.html">Module</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
1736
class_module.html
Normal file
1736
class_module.html
Normal file
File diff suppressed because it is too large
Load diff
39
class_module.js
Normal file
39
class_module.js
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
var class_module =
|
||||
[
|
||||
[ "Module", "class_module.html#a5ea76bc25ef979ec1ff90c032e476004", null ],
|
||||
[ "Module", "class_module.html#a06b2e1f1eb9e07a280e55f517f2fab38", null ],
|
||||
[ "Module", "class_module.html#ae8709b81f592a23ebd72ba3fd8066b0f", null ],
|
||||
[ "Module", "class_module.html#ac65f3d9e022b3284134ced1c20bcff09", null ],
|
||||
[ "Module", "class_module.html#af67217bf4771f4becb0f89b2a90054c4", null ],
|
||||
[ "Module", "class_module.html#a56456ade4eeffa2c566a6fc3fd098276", null ],
|
||||
[ "Module", "class_module.html#a919baf2e46c357ebfcdbc1025b6c551e", null ],
|
||||
[ "ATemptyBuffer", "class_module.html#ad5767216ba9340ae6d86915b12e89bd6", null ],
|
||||
[ "ATgetResponse", "class_module.html#ad1aadc2b52eea2bf9d26591091eec3f1", null ],
|
||||
[ "ATsendCommand", "class_module.html#a5c09c878b55f56990dd0c2972a3440c4", null ],
|
||||
[ "ATsendData", "class_module.html#a623aee6405b330b7c935013ff3d01100", null ],
|
||||
[ "getCs", "class_module.html#ad9e1458c0eb4f7c117d53e35450bbd76", null ],
|
||||
[ "getGpio", "class_module.html#a3b1d62f6df09d175179effd04c931881", null ],
|
||||
[ "getIrq", "class_module.html#a55ddb0fc8ce53db3a333b71fb798e0af", null ],
|
||||
[ "getRst", "class_module.html#aa4179db40b566a336d28ca33763c6b11", null ],
|
||||
[ "getRx", "class_module.html#acbffe457d532fed652664debcb3c7748", null ],
|
||||
[ "getSpi", "class_module.html#a9909bad63883b996e856deceb2a2d48d", null ],
|
||||
[ "getSpiSettings", "class_module.html#a2ba602f873ba747733eed9f54ca94ed1", null ],
|
||||
[ "getTx", "class_module.html#a5a2b7fd8c262a01d1abc1b5f4f9c3513", null ],
|
||||
[ "init", "class_module.html#adb22d89bc5f532f1d056d9a9f3a6589c", null ],
|
||||
[ "operator=", "class_module.html#a4ea888758b4a7784082d513a1e7849a4", null ],
|
||||
[ "setRfSwitchPins", "class_module.html#a0ecbb4e1e98094c1296b1e823dc14703", null ],
|
||||
[ "setRfSwitchState", "class_module.html#a4a87d59ad2bf6bb1bb9de1856a81b824", null ],
|
||||
[ "SPIgetRegValue", "class_module.html#ad7ca9ae5a22cdacdf9437ca9cd37c9b4", null ],
|
||||
[ "SPIreadRegister", "class_module.html#a1d1a279cc7e1ab92e30c29c4dcca26a3", null ],
|
||||
[ "SPIreadRegisterBurst", "class_module.html#a6fa5239d73379e4140f5c4f513b1b8d2", null ],
|
||||
[ "SPIsetRegValue", "class_module.html#a87ca265fa2d1fe7c251b4230ef6bd6ca", null ],
|
||||
[ "SPItransfer", "class_module.html#aefd955f1cd6d588b2cc229db87cb2121", null ],
|
||||
[ "SPIwriteRegister", "class_module.html#ab814614ddd34b57f5a612a20f5fe4c57", null ],
|
||||
[ "SPIwriteRegisterBurst", "class_module.html#a9d77a08070cbd48fd4ece62a739333e9", null ],
|
||||
[ "term", "class_module.html#af0569f6930da7bee761eeca8158aed3a", null ],
|
||||
[ "AtLineFeed", "class_module.html#a9d8ab2ff353bad5d0e7568d300a48ba0", null ],
|
||||
[ "baudrate", "class_module.html#a128ead3f3198e3b06d39a128a5d6c777", null ],
|
||||
[ "ModuleSerial", "class_module.html#a99556decb983f682b98220ae5434b004", null ],
|
||||
[ "SPIreadCommand", "class_module.html#a849ad85fc1bc3a7130e660c13973ab26", null ],
|
||||
[ "SPIwriteCommand", "class_module.html#ae89764d15e8df5694a6aec0e18f72d3f", null ]
|
||||
];
|
||||
156
class_morse_client-members.html
Normal file
156
class_morse_client-members.html
Normal file
|
|
@ -0,0 +1,156 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: Member List</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_morse_client.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">MorseClient Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_morse_client.html">MorseClient</a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_morse_client.html#a516f19bb51b87ead7f7ed149f2ca92cf">begin</a>(float base, uint8_t speed=20)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_morse_client.html#aeade3a433da40e6a9f28688f2e6e3b5a">MorseClient</a>(PhysicalLayer *phy)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_morse_client.html#aa5c8ec6823388877b7acfa0deab689a2">MorseClient</a>(AFSKClient *audio)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"><span class="mlabel">explicit</span></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(__FlashStringHelper *) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(const String &) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(const char[]) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(char) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(unsigned char, int=DEC) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(int, int=DEC) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(unsigned int, int=DEC) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(long, int=DEC) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>print</b>(unsigned long, int=DEC) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>print</b>(double, int=2) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(void) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(__FlashStringHelper *) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(const String &) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(const char[]) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(char) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(unsigned char, int=DEC) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(int, int=DEC) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(unsigned int, int=DEC) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(long, int=DEC) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>println</b>(unsigned long, int=DEC) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>println</b>(double, int=2) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_morse_client.html#a3c718208786f8fe55f30eee990ec28e3">startSignal</a>()</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>write</b>(const char *str) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>write</b>(uint8_t *buff, size_t len) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
<tr bgcolor="#f0f0f0"><td class="entry"><b>write</b>(uint8_t b) (defined in <a class="el" href="class_morse_client.html">MorseClient</a>)</td><td class="entry"><a class="el" href="class_morse_client.html">MorseClient</a></td><td class="entry"></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
348
class_morse_client.html
Normal file
348
class_morse_client.html
Normal file
|
|
@ -0,0 +1,348 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: MorseClient Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_morse_client.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="class_morse_client-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">MorseClient Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Client for Morse Code communication. The public interface is the same as Arduino Serial.
|
||||
<a href="class_morse_client.html#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="_morse_8h_source.html">Morse.h</a>></code></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:aeade3a433da40e6a9f28688f2e6e3b5a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_morse_client.html#aeade3a433da40e6a9f28688f2e6e3b5a">MorseClient</a> (<a class="el" href="class_physical_layer.html">PhysicalLayer</a> *phy)</td></tr>
|
||||
<tr class="memdesc:aeade3a433da40e6a9f28688f2e6e3b5a"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for 2-FSK mode. <a href="#aeade3a433da40e6a9f28688f2e6e3b5a">More...</a><br /></td></tr>
|
||||
<tr class="separator:aeade3a433da40e6a9f28688f2e6e3b5a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa5c8ec6823388877b7acfa0deab689a2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_morse_client.html#aa5c8ec6823388877b7acfa0deab689a2">MorseClient</a> (<a class="el" href="class_a_f_s_k_client.html">AFSKClient</a> *audio)</td></tr>
|
||||
<tr class="memdesc:aa5c8ec6823388877b7acfa0deab689a2"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for AFSK mode. <a href="#aa5c8ec6823388877b7acfa0deab689a2">More...</a><br /></td></tr>
|
||||
<tr class="separator:aa5c8ec6823388877b7acfa0deab689a2"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a516f19bb51b87ead7f7ed149f2ca92cf"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_morse_client.html#a516f19bb51b87ead7f7ed149f2ca92cf">begin</a> (float base, uint8_t speed=20)</td></tr>
|
||||
<tr class="memdesc:a516f19bb51b87ead7f7ed149f2ca92cf"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. <a href="#a516f19bb51b87ead7f7ed149f2ca92cf">More...</a><br /></td></tr>
|
||||
<tr class="separator:a516f19bb51b87ead7f7ed149f2ca92cf"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a3c718208786f8fe55f30eee990ec28e3"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_morse_client.html#a3c718208786f8fe55f30eee990ec28e3">startSignal</a> ()</td></tr>
|
||||
<tr class="memdesc:a3c718208786f8fe55f30eee990ec28e3"><td class="mdescLeft"> </td><td class="mdescRight">Send start signal. <a href="#a3c718208786f8fe55f30eee990ec28e3">More...</a><br /></td></tr>
|
||||
<tr class="separator:a3c718208786f8fe55f30eee990ec28e3"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a1be826249b4936e2b0bca20311714726"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1be826249b4936e2b0bca20311714726"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (const char *str)</td></tr>
|
||||
<tr class="separator:a1be826249b4936e2b0bca20311714726"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9b46b2755abd59ece4abd69fab4f7808"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b46b2755abd59ece4abd69fab4f7808"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (uint8_t *buff, size_t len)</td></tr>
|
||||
<tr class="separator:a9b46b2755abd59ece4abd69fab4f7808"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:abd37869212f3338eb7c95c6f16dadbba"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd37869212f3338eb7c95c6f16dadbba"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (uint8_t b)</td></tr>
|
||||
<tr class="separator:abd37869212f3338eb7c95c6f16dadbba"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a051cba718c88b0d25a0f6f6dbfeb1e46"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a051cba718c88b0d25a0f6f6dbfeb1e46"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (__FlashStringHelper *)</td></tr>
|
||||
<tr class="separator:a051cba718c88b0d25a0f6f6dbfeb1e46"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a2040051afe09bbd4fada12bdf76203b1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2040051afe09bbd4fada12bdf76203b1"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (const String &)</td></tr>
|
||||
<tr class="separator:a2040051afe09bbd4fada12bdf76203b1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a5e0ecaccbc92e6790f73542133c34535"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e0ecaccbc92e6790f73542133c34535"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (const char[])</td></tr>
|
||||
<tr class="separator:a5e0ecaccbc92e6790f73542133c34535"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a1125d874d18a507b2e77675b687cce0f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1125d874d18a507b2e77675b687cce0f"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (char)</td></tr>
|
||||
<tr class="separator:a1125d874d18a507b2e77675b687cce0f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a8b54b926bcd4115822e4c901371f1e53"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b54b926bcd4115822e4c901371f1e53"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned char, int=DEC)</td></tr>
|
||||
<tr class="separator:a8b54b926bcd4115822e4c901371f1e53"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a2fcdfba81f12782f44fff8fdf845ea0b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2fcdfba81f12782f44fff8fdf845ea0b"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (int, int=DEC)</td></tr>
|
||||
<tr class="separator:a2fcdfba81f12782f44fff8fdf845ea0b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a5714515867807053a63843d5ae647dd1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5714515867807053a63843d5ae647dd1"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned int, int=DEC)</td></tr>
|
||||
<tr class="separator:a5714515867807053a63843d5ae647dd1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a1b7a4467adf49a3afa062fc93bf6f80f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b7a4467adf49a3afa062fc93bf6f80f"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (long, int=DEC)</td></tr>
|
||||
<tr class="separator:a1b7a4467adf49a3afa062fc93bf6f80f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:abcbc1b964ddb20984c3d6f32f07c8cce"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abcbc1b964ddb20984c3d6f32f07c8cce"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned long, int=DEC)</td></tr>
|
||||
<tr class="separator:abcbc1b964ddb20984c3d6f32f07c8cce"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a64e20542281e100ab92ebe5e8f915c3c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a64e20542281e100ab92ebe5e8f915c3c"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (double, int=2)</td></tr>
|
||||
<tr class="separator:a64e20542281e100ab92ebe5e8f915c3c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ae1dd17e96858c9b6948ee7e5871c7efd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1dd17e96858c9b6948ee7e5871c7efd"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (void)</td></tr>
|
||||
<tr class="separator:ae1dd17e96858c9b6948ee7e5871c7efd"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a2f4433a88741564f28f673cf51486615"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f4433a88741564f28f673cf51486615"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (__FlashStringHelper *)</td></tr>
|
||||
<tr class="separator:a2f4433a88741564f28f673cf51486615"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a83a064f138d5bf55420ffbfd534dacfb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a83a064f138d5bf55420ffbfd534dacfb"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (const String &)</td></tr>
|
||||
<tr class="separator:a83a064f138d5bf55420ffbfd534dacfb"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a178726e7279d49d873c715371d558751"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a178726e7279d49d873c715371d558751"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (const char[])</td></tr>
|
||||
<tr class="separator:a178726e7279d49d873c715371d558751"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa26d803db2d9ab6f3b13f843811f923f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa26d803db2d9ab6f3b13f843811f923f"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (char)</td></tr>
|
||||
<tr class="separator:aa26d803db2d9ab6f3b13f843811f923f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a7eecc8f5a61115b39fa67f1f7be4747e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7eecc8f5a61115b39fa67f1f7be4747e"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned char, int=DEC)</td></tr>
|
||||
<tr class="separator:a7eecc8f5a61115b39fa67f1f7be4747e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa930ef3852b22e973129daf2ceaf58c3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa930ef3852b22e973129daf2ceaf58c3"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (int, int=DEC)</td></tr>
|
||||
<tr class="separator:aa930ef3852b22e973129daf2ceaf58c3"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9094ea2ccb2528be5a830485575e2b5e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9094ea2ccb2528be5a830485575e2b5e"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned int, int=DEC)</td></tr>
|
||||
<tr class="separator:a9094ea2ccb2528be5a830485575e2b5e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:afea22f16b6360e122116da4b7b6cc2f7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afea22f16b6360e122116da4b7b6cc2f7"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (long, int=DEC)</td></tr>
|
||||
<tr class="separator:afea22f16b6360e122116da4b7b6cc2f7"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a95d0edd2ab9a590668c6aaa67a893c49"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a95d0edd2ab9a590668c6aaa67a893c49"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned long, int=DEC)</td></tr>
|
||||
<tr class="separator:a95d0edd2ab9a590668c6aaa67a893c49"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:af466855a342b3cc70b496a79caf65232"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af466855a342b3cc70b496a79caf65232"></a>
|
||||
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (double, int=2)</td></tr>
|
||||
<tr class="separator:af466855a342b3cc70b496a79caf65232"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Client for Morse Code communication. The public interface is the same as Arduino Serial. </p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="aeade3a433da40e6a9f28688f2e6e3b5a"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">MorseClient::MorseClient </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="class_physical_layer.html">PhysicalLayer</a> * </td>
|
||||
<td class="paramname"><em>phy</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Constructor for 2-FSK mode. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">phy</td><td>Pointer to the wireless module providing <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN...">PhysicalLayer</a> communication. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="aa5c8ec6823388877b7acfa0deab689a2"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">MorseClient::MorseClient </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="class_a_f_s_k_client.html">AFSKClient</a> * </td>
|
||||
<td class="paramname"><em>audio</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Constructor for AFSK mode. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">audio</td><td>Pointer to the AFSK instance providing audio. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a class="anchor" id="a516f19bb51b87ead7f7ed149f2ca92cf"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">int16_t MorseClient::begin </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">float </td>
|
||||
<td class="paramname"><em>base</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">uint8_t </td>
|
||||
<td class="paramname"><em>speed</em> = <code>20</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Initialization method. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">base</td><td>Base RF frequency to be used in MHz (in 2-FSK mode), or the tone frequency in Hz (in AFSK mode)</td></tr>
|
||||
<tr><td class="paramname">speed</td><td>Coding speed in words per minute.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a3c718208786f8fe55f30eee990ec28e3"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">size_t MorseClient::startSignal </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Send start signal. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Number of bytes sent (always 0). </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following files:<ul>
|
||||
<li>src/protocols/Morse/<a class="el" href="_morse_8h_source.html">Morse.h</a></li>
|
||||
<li>src/protocols/Morse/Morse.cpp</li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="class_morse_client.html">MorseClient</a></li>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
31
class_morse_client.js
Normal file
31
class_morse_client.js
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
var class_morse_client =
|
||||
[
|
||||
[ "MorseClient", "class_morse_client.html#aeade3a433da40e6a9f28688f2e6e3b5a", null ],
|
||||
[ "MorseClient", "class_morse_client.html#aa5c8ec6823388877b7acfa0deab689a2", null ],
|
||||
[ "begin", "class_morse_client.html#a516f19bb51b87ead7f7ed149f2ca92cf", null ],
|
||||
[ "print", "class_morse_client.html#a051cba718c88b0d25a0f6f6dbfeb1e46", null ],
|
||||
[ "print", "class_morse_client.html#a2040051afe09bbd4fada12bdf76203b1", null ],
|
||||
[ "print", "class_morse_client.html#a5e0ecaccbc92e6790f73542133c34535", null ],
|
||||
[ "print", "class_morse_client.html#a1125d874d18a507b2e77675b687cce0f", null ],
|
||||
[ "print", "class_morse_client.html#a8b54b926bcd4115822e4c901371f1e53", null ],
|
||||
[ "print", "class_morse_client.html#a2fcdfba81f12782f44fff8fdf845ea0b", null ],
|
||||
[ "print", "class_morse_client.html#a5714515867807053a63843d5ae647dd1", null ],
|
||||
[ "print", "class_morse_client.html#a1b7a4467adf49a3afa062fc93bf6f80f", null ],
|
||||
[ "print", "class_morse_client.html#abcbc1b964ddb20984c3d6f32f07c8cce", null ],
|
||||
[ "print", "class_morse_client.html#a64e20542281e100ab92ebe5e8f915c3c", null ],
|
||||
[ "println", "class_morse_client.html#ae1dd17e96858c9b6948ee7e5871c7efd", null ],
|
||||
[ "println", "class_morse_client.html#a2f4433a88741564f28f673cf51486615", null ],
|
||||
[ "println", "class_morse_client.html#a83a064f138d5bf55420ffbfd534dacfb", null ],
|
||||
[ "println", "class_morse_client.html#a178726e7279d49d873c715371d558751", null ],
|
||||
[ "println", "class_morse_client.html#aa26d803db2d9ab6f3b13f843811f923f", null ],
|
||||
[ "println", "class_morse_client.html#a7eecc8f5a61115b39fa67f1f7be4747e", null ],
|
||||
[ "println", "class_morse_client.html#aa930ef3852b22e973129daf2ceaf58c3", null ],
|
||||
[ "println", "class_morse_client.html#a9094ea2ccb2528be5a830485575e2b5e", null ],
|
||||
[ "println", "class_morse_client.html#afea22f16b6360e122116da4b7b6cc2f7", null ],
|
||||
[ "println", "class_morse_client.html#a95d0edd2ab9a590668c6aaa67a893c49", null ],
|
||||
[ "println", "class_morse_client.html#af466855a342b3cc70b496a79caf65232", null ],
|
||||
[ "startSignal", "class_morse_client.html#a3c718208786f8fe55f30eee990ec28e3", null ],
|
||||
[ "write", "class_morse_client.html#a1be826249b4936e2b0bca20311714726", null ],
|
||||
[ "write", "class_morse_client.html#a9b46b2755abd59ece4abd69fab4f7808", null ],
|
||||
[ "write", "class_morse_client.html#abd37869212f3338eb7c95c6f16dadbba", null ]
|
||||
];
|
||||
148
class_physical_layer-members.html
Normal file
148
class_physical_layer-members.html
Normal file
|
|
@ -0,0 +1,148 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
||||
<title>RadioLib: Member List</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="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { init_search(); });
|
||||
</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="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">RadioLib
|
||||
</div>
|
||||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.11 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||||
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||||
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('class_physical_layer.html','');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">PhysicalLayer Member List</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>This is the complete list of members for <a class="el" href="class_physical_layer.html">PhysicalLayer</a>, including all inherited members.</p>
|
||||
<table class="directory">
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_physical_layer.html#ac48339cc9fc93931379903ab0c195e40">getFreqStep</a>() const </td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_physical_layer.html#a0bd6046e068ef63e3f2b6bead48e02a7">getPacketLength</a>(bool update=true)=0</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_physical_layer.html#a5e02457f1d519cf81b1590a182321c62">PhysicalLayer</a>(float freqStep, size_t maxPacketLength)</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">readData</a>(String &str, size_t len=0)</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_physical_layer.html#ae8b6c756eb4b92855433ca389d73c632">readData</a>(uint8_t *data, size_t len)=0</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">receive</a>(String &str, size_t len=0)</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_physical_layer.html#a2ad4c6a8ac267f8ac590260414ffcda3">receive</a>(uint8_t *data, size_t len)=0</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_physical_layer.html#a46b22145b33e97cf6065ed826799b6b4">receiveDirect</a>()=0</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_physical_layer.html#ab643a814dce48f71a13bf6ea23f44cbd">setDataShaping</a>(uint8_t sh)=0</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_physical_layer.html#a7d3419227d201d6912b77784636d437d">setEncoding</a>(uint8_t encoding)=0</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_physical_layer.html#ab9060e8ab7a2da192b3bf53b3501553b">setFrequencyDeviation</a>(float freqDev)=0</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_physical_layer.html#a0e77da761a2cbb5c9535df0bdea993f9">standby</a>()=0</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">startTransmit</a>(String &str, uint8_t addr=0)</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">startTransmit</a>(const char *str, uint8_t addr=0)</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_physical_layer.html#a41a1de0ebffe7b65de6fd8cceb9a5123">startTransmit</a>(uint8_t *data, size_t len, uint8_t addr=0)=0</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">transmit</a>(__FlashStringHelper *fstr, uint8_t addr=0)</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_physical_layer.html#aeb62c5a521aafc1e0525c58e9364482b">transmit</a>(String &str, uint8_t addr=0)</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">transmit</a>(const char *str, uint8_t addr=0)</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"></td></tr>
|
||||
<tr class="even"><td class="entry"><a class="el" href="class_physical_layer.html#af81565ee82ef9a7de9c5663c745f4ef7">transmit</a>(uint8_t *data, size_t len, uint8_t addr=0)=0</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
|
||||
<tr><td class="entry"><a class="el" href="class_physical_layer.html#a4b04eb6155b06d8ef400131c647d54e7">transmitDirect</a>(uint32_t frf=0)=0</td><td class="entry"><a class="el" href="class_physical_layer.html">PhysicalLayer</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
|
||||
</table></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="footer">Generated by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Reference in a new issue