316 lines
50 KiB
HTML
316 lines
50 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: src/Module.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>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="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.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</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">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('_module_8h_source.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</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.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_MODULE_H</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_MODULE_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">#include <SPI.h></span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#ifndef RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <SoftwareSerial.h></span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="class_module.html"> 17</a></span> <span class="keyword">class </span><a class="code" href="class_module.html">Module</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="l00028"></a><span class="lineno"> 28</span>  <a class="code" href="class_module.html#a06b2e1f1eb9e07a280e55f517f2fab38">Module</a>(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst);</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="class_module.html#a06b2e1f1eb9e07a280e55f517f2fab38">Module</a>(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio);</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="class_module.html#a06b2e1f1eb9e07a280e55f517f2fab38">Module</a>(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, SPIClass& spi, SPISettings spiSettings);</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="class_module.html#a06b2e1f1eb9e07a280e55f517f2fab38">Module</a>(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio, SPIClass& spi, SPISettings spiSettings = SPISettings(2000000, MSBFIRST, SPI_MODE0));</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="preprocessor">#ifdef RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED</span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <a class="code" href="class_module.html#a06b2e1f1eb9e07a280e55f517f2fab38">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 = &RADIOLIB_HARDWARE_SERIAL_PORT);</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor">#else</span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <a class="code" href="class_module.html#a06b2e1f1eb9e07a280e55f517f2fab38">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 = <span class="keyword">nullptr</span>);</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <a class="code" href="class_module.html#a06b2e1f1eb9e07a280e55f517f2fab38">Module</a>(<span class="keyword">const</span> <a class="code" href="class_module.html">Module</a>& mod);</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  </div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <a class="code" href="class_module.html">Module</a>& <a class="code" href="class_module.html#a4ea888758b4a7784082d513a1e7849a4">operator=</a>(<span class="keyword">const</span> <a class="code" href="class_module.html">Module</a>& mod);</div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  </div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="comment">// public member variables</span></div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  </div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">#ifdef RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED</span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  HardwareSerial* <a class="code" href="class_module.html#a99556decb983f682b98220ae5434b004">ModuleSerial</a>;</div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor">#else</span></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="class_module.html#a99556decb983f682b98220ae5434b004"> 122</a></span>  SoftwareSerial* <a class="code" href="class_module.html#a99556decb983f682b98220ae5434b004">ModuleSerial</a>;</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  </div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="class_module.html#a128ead3f3198e3b06d39a128a5d6c777"> 128</a></span>  uint32_t <a class="code" href="class_module.html#a128ead3f3198e3b06d39a128a5d6c777">baudrate</a> = 9600;</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  </div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="class_module.html#a9d8ab2ff353bad5d0e7568d300a48ba0"> 133</a></span>  <span class="keywordtype">char</span> <a class="code" href="class_module.html#a9d8ab2ff353bad5d0e7568d300a48ba0">AtLineFeed</a>[3] = {<span class="charliteral">'\r'</span>, <span class="charliteral">'\n'</span>};</div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  </div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"><a class="line" href="class_module.html#a849ad85fc1bc3a7130e660c13973ab26"> 138</a></span>  uint8_t <a class="code" href="class_module.html#a849ad85fc1bc3a7130e660c13973ab26">SPIreadCommand</a> = 0b00000000;</div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  </div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="class_module.html#ae89764d15e8df5694a6aec0e18f72d3f"> 143</a></span>  uint8_t <a class="code" href="class_module.html#ae89764d15e8df5694a6aec0e18f72d3f">SPIwriteCommand</a> = 0b10000000;</div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  </div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="comment">// basic methods</span></div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  </div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#adb22d89bc5f532f1d056d9a9f3a6589c">init</a>(uint8_t interface);</div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  </div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#af0569f6930da7bee761eeca8158aed3a">term</a>(uint8_t interface);</div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  </div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="comment">// AT methods</span></div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  </div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#ad5767216ba9340ae6d86915b12e89bd6">ATemptyBuffer</a>();</div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  </div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="keywordtype">bool</span> <a class="code" href="class_module.html#ad1aadc2b52eea2bf9d26591091eec3f1">ATgetResponse</a>();</div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  </div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keywordtype">bool</span> <a class="code" href="class_module.html#a5c09c878b55f56990dd0c2972a3440c4">ATsendCommand</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* cmd);</div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  </div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <span class="keywordtype">bool</span> <a class="code" href="class_module.html#a623aee6405b330b7c935013ff3d01100">ATsendData</a>(uint8_t* data, uint32_t len);</div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  </div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <span class="comment">// SPI methods</span></div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  </div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  int16_t <a class="code" href="class_module.html#ad7ca9ae5a22cdacdf9437ca9cd37c9b4">SPIgetRegValue</a>(uint8_t reg, uint8_t msb = 7, uint8_t lsb = 0);</div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  </div>
|
|
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  int16_t <a class="code" href="class_module.html#a1286d7fd9673cbfab945c26b2585a129">SPIsetRegValue</a>(uint8_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2, uint8_t checkMask = 0xFF);</div>
|
|
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  </div>
|
|
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a6fa5239d73379e4140f5c4f513b1b8d2">SPIreadRegisterBurst</a>(uint8_t reg, uint8_t numBytes, uint8_t* inBytes);</div>
|
|
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  </div>
|
|
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  uint8_t <a class="code" href="class_module.html#a1d1a279cc7e1ab92e30c29c4dcca26a3">SPIreadRegister</a>(uint8_t reg);</div>
|
|
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  </div>
|
|
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a9d77a08070cbd48fd4ece62a739333e9">SPIwriteRegisterBurst</a>(uint8_t reg, uint8_t* data, uint8_t numBytes);</div>
|
|
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  </div>
|
|
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#ab814614ddd34b57f5a612a20f5fe4c57">SPIwriteRegister</a>(uint8_t reg, uint8_t data);</div>
|
|
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  </div>
|
|
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#aefd955f1cd6d588b2cc229db87cb2121">SPItransfer</a>(uint8_t cmd, uint8_t reg, uint8_t* dataOut, uint8_t* dataIn, uint8_t numBytes);</div>
|
|
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  </div>
|
|
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  <span class="comment">// pin number access methods</span></div>
|
|
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  </div>
|
|
<div class="line"><a name="l00291"></a><span class="lineno"><a class="line" href="class_module.html#ae53e355a77f2b7ce6473c62ac5f37334"> 291</a></span>  RADIOLIB_PIN_TYPE <a class="code" href="class_module.html#ae53e355a77f2b7ce6473c62ac5f37334">getCs</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(_cs); }</div>
|
|
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span>  </div>
|
|
<div class="line"><a name="l00298"></a><span class="lineno"><a class="line" href="class_module.html#a8c7f17a63b67117d953f1ba990b17f80"> 298</a></span>  RADIOLIB_PIN_TYPE <a class="code" href="class_module.html#a8c7f17a63b67117d953f1ba990b17f80">getIrq</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(_irq); }</div>
|
|
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>  </div>
|
|
<div class="line"><a name="l00305"></a><span class="lineno"><a class="line" href="class_module.html#ae352c7a7b997fc1b17189c1312a8347f"> 305</a></span>  RADIOLIB_PIN_TYPE <a class="code" href="class_module.html#ae352c7a7b997fc1b17189c1312a8347f">getRst</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(_rst); }</div>
|
|
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  </div>
|
|
<div class="line"><a name="l00312"></a><span class="lineno"><a class="line" href="class_module.html#aeb4c7447372d56a7cae6db91994aacfc"> 312</a></span>  RADIOLIB_PIN_TYPE <a class="code" href="class_module.html#aeb4c7447372d56a7cae6db91994aacfc">getGpio</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(_rx); }</div>
|
|
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  </div>
|
|
<div class="line"><a name="l00319"></a><span class="lineno"><a class="line" href="class_module.html#a5d66f76c11ac91a35a3a1d9647aa6f6d"> 319</a></span>  RADIOLIB_PIN_TYPE <a class="code" href="class_module.html#a5d66f76c11ac91a35a3a1d9647aa6f6d">getRx</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(_rx); }</div>
|
|
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  </div>
|
|
<div class="line"><a name="l00326"></a><span class="lineno"><a class="line" href="class_module.html#a680dd2e80255cab30cbe9773bf20b390"> 326</a></span>  RADIOLIB_PIN_TYPE <a class="code" href="class_module.html#a680dd2e80255cab30cbe9773bf20b390">getTx</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(_tx); }</div>
|
|
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  </div>
|
|
<div class="line"><a name="l00333"></a><span class="lineno"><a class="line" href="class_module.html#ae867ebfef795d63d1df234394510b96e"> 333</a></span>  SPIClass* <a class="code" href="class_module.html#ae867ebfef795d63d1df234394510b96e">getSpi</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(_spi); }</div>
|
|
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span>  </div>
|
|
<div class="line"><a name="l00340"></a><span class="lineno"><a class="line" href="class_module.html#a7b6da4ca8fe5178617a1cc28854929a0"> 340</a></span>  SPISettings <a class="code" href="class_module.html#a7b6da4ca8fe5178617a1cc28854929a0">getSpiSettings</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(_spiSettings); }</div>
|
|
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span>  </div>
|
|
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a0ecbb4e1e98094c1296b1e823dc14703">setRfSwitchPins</a>(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);</div>
|
|
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span>  </div>
|
|
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a4a87d59ad2bf6bb1bb9de1856a81b824">setRfSwitchState</a>(RADIOLIB_PIN_STATUS rxPinState, RADIOLIB_PIN_STATUS txPinState);</div>
|
|
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span>  </div>
|
|
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span>  <span class="comment">// Arduino core overrides</span></div>
|
|
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span>  </div>
|
|
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_module.html#af7e4872dad3d19b6f75f532c88683168">pinMode</a>(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode);</div>
|
|
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span>  </div>
|
|
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_module.html#a46ad10b113df7c7e0a932be19eff63cd">digitalWrite</a>(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value);</div>
|
|
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span>  </div>
|
|
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span>  <span class="keyword">static</span> RADIOLIB_PIN_STATUS <a class="code" href="class_module.html#a7495c81640aac8f4686221dad34a274f">digitalRead</a>(RADIOLIB_PIN_TYPE pin);</div>
|
|
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>  </div>
|
|
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_module.html#a32ba59613a2f1e77038956e18d9fedd7">tone</a>(RADIOLIB_PIN_TYPE pin, uint16_t value);</div>
|
|
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span>  </div>
|
|
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_module.html#af998b86ce1243f616f6fcb6df5336207">noTone</a>(RADIOLIB_PIN_TYPE pin);</div>
|
|
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span>  </div>
|
|
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_module.html#a91aaa34aecdfeaf24948551b037033be">attachInterrupt</a>(RADIOLIB_PIN_TYPE interruptNum, <span class="keywordtype">void</span> (*userFunc)(<span class="keywordtype">void</span>), RADIOLIB_INTERRUPT_STATUS mode);</div>
|
|
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span>  </div>
|
|
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_module.html#a656738f2fe41fb236d27aed02efa8ad4">detachInterrupt</a>(RADIOLIB_PIN_TYPE interruptNum);</div>
|
|
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span>  </div>
|
|
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_module.html#a227d2d38e4747d0f49bb4df1c80b45d7">yield</a>();</div>
|
|
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span>  </div>
|
|
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_module.html#af0f870b09b9dd9636f1587d708f07d38">delay</a>(uint32_t ms);</div>
|
|
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span>  </div>
|
|
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_module.html#a14d7cd8220bfa4440bda055ce5be748c">delayMicroseconds</a>(uint32_t us);</div>
|
|
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span>  </div>
|
|
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span>  <span class="keyword">static</span> uint32_t <a class="code" href="class_module.html#a216dd0c6ce140857f2b003ab8d89fbac">millis</a>();</div>
|
|
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span>  </div>
|
|
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span>  <span class="keyword">static</span> uint32_t <a class="code" href="class_module.html#af3f51e517a825949891ad29e30fd3f59">micros</a>();</div>
|
|
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span>  </div>
|
|
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span>  <span class="keyword">static</span> uint8_t <a class="code" href="class_module.html#a7f5fd7409f21d33a16ea1de589962ae6">flipBits</a>(uint8_t b);</div>
|
|
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span>  </div>
|
|
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span>  <span class="keyword">static</span> uint16_t <a class="code" href="class_module.html#a160006371be8e121a8a54cc4462b3a72">flipBits16</a>(uint16_t i);</div>
|
|
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span>  </div>
|
|
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="preprocessor">#ifndef RADIOLIB_GODMODE</span></div>
|
|
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span>  <span class="comment">// allow SerialModule class to access private members</span></div>
|
|
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_serial_module.html">SerialModule</a>;</div>
|
|
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span>  </div>
|
|
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span>  <span class="comment">// whether RadioLib should automatically initalize selected SPI or UART interface</span></div>
|
|
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span>  <span class="keywordtype">bool</span> _initInterface = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span>  </div>
|
|
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span>  <span class="comment">// pins</span></div>
|
|
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span>  RADIOLIB_PIN_TYPE _cs = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span>  RADIOLIB_PIN_TYPE _irq = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span>  RADIOLIB_PIN_TYPE _rst = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span>  RADIOLIB_PIN_TYPE _rx = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span>  RADIOLIB_PIN_TYPE _tx = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  </div>
|
|
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span>  <span class="comment">// SPI settings</span></div>
|
|
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span>  SPISettings _spiSettings = SPISettings(2000000, MSBFIRST, SPI_MODE0);</div>
|
|
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span>  SPIClass* _spi = NULL;</div>
|
|
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span>  </div>
|
|
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span>  <span class="comment">// RF switch presence and pins</span></div>
|
|
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span>  <span class="keywordtype">bool</span> _useRfSwitch = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span>  RADIOLIB_PIN_TYPE _rxEn = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span>  RADIOLIB_PIN_TYPE _txEn = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span>  </div>
|
|
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span>  <span class="comment">// AT command timeout in milliseconds</span></div>
|
|
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span>  uint32_t _ATtimeout = 15000;</div>
|
|
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span> };</div>
|
|
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span>  </div>
|
|
<div class="line"><a name="l00497"></a><span class="lineno"><a class="line" href="class_serial_module.html"> 497</a></span> <span class="keyword">class </span><a class="code" href="class_serial_module.html">SerialModule</a>: <span class="keyword">public</span> <a class="code" href="class_module.html">Module</a> {</div>
|
|
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="preprocessor"> #ifdef RADIOLIB_SOFTWARE_SERIAL_UNSUPPORTED</span></div>
|
|
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span>  <a class="code" href="class_serial_module.html">SerialModule</a>(RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, RADIOLIB_PIN_TYPE rst = RADIOLIB_NC, HardwareSerial* serial = &RADIOLIB_HARDWARE_SERIAL_PORT);</div>
|
|
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span> <span class="preprocessor"> #else</span></div>
|
|
<div class="line"><a name="l00513"></a><span class="lineno"> 513</span>  <a class="code" href="class_serial_module.html">SerialModule</a>(RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, RADIOLIB_PIN_TYPE rst = RADIOLIB_NC, HardwareSerial* serial = <span class="keyword">nullptr</span>);</div>
|
|
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span> };</div>
|
|
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span>  </div>
|
|
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="aclass_module_html_af7e4872dad3d19b6f75f532c88683168"><div class="ttname"><a href="class_module.html#af7e4872dad3d19b6f75f532c88683168">Module::pinMode</a></div><div class="ttdeci">static void pinMode(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode)</div><div class="ttdoc">Arduino core pinMode override that checks RADIOLIB_NC as alias for unused pin.</div><div class="ttdef"><b>Definition:</b> Module.cpp:318</div></div>
|
|
<div class="ttc" id="aclass_module_html_a8c7f17a63b67117d953f1ba990b17f80"><div class="ttname"><a href="class_module.html#a8c7f17a63b67117d953f1ba990b17f80">Module::getIrq</a></div><div class="ttdeci">RADIOLIB_PIN_TYPE getIrq() const</div><div class="ttdoc">Access method to get the pin number of interrupt/GPIO.</div><div class="ttdef"><b>Definition:</b> Module.h:298</div></div>
|
|
<div class="ttc" id="aclass_module_html_a5d66f76c11ac91a35a3a1d9647aa6f6d"><div class="ttname"><a href="class_module.html#a5d66f76c11ac91a35a3a1d9647aa6f6d">Module::getRx</a></div><div class="ttdeci">RADIOLIB_PIN_TYPE getRx() const</div><div class="ttdoc">Access method to get the pin number of UART Rx.</div><div class="ttdef"><b>Definition:</b> Module.h:319</div></div>
|
|
<div class="ttc" id="aclass_module_html_a7495c81640aac8f4686221dad34a274f"><div class="ttname"><a href="class_module.html#a7495c81640aac8f4686221dad34a274f">Module::digitalRead</a></div><div class="ttdeci">static RADIOLIB_PIN_STATUS digitalRead(RADIOLIB_PIN_TYPE pin)</div><div class="ttdoc">Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin.</div><div class="ttdef"><b>Definition:</b> Module.cpp:330</div></div>
|
|
<div class="ttc" id="aclass_module_html_aefd955f1cd6d588b2cc229db87cb2121"><div class="ttname"><a href="class_module.html#aefd955f1cd6d588b2cc229db87cb2121">Module::SPItransfer</a></div><div class="ttdeci">void SPItransfer(uint8_t cmd, uint8_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes)</div><div class="ttdoc">SPI single transfer method.</div><div class="ttdef"><b>Definition:</b> Module.cpp:271</div></div>
|
|
<div class="ttc" id="aclass_module_html_ad7ca9ae5a22cdacdf9437ca9cd37c9b4"><div class="ttname"><a href="class_module.html#ad7ca9ae5a22cdacdf9437ca9cd37c9b4">Module::SPIgetRegValue</a></div><div class="ttdeci">int16_t SPIgetRegValue(uint8_t reg, uint8_t msb=7, uint8_t lsb=0)</div><div class="ttdoc">SPI read method that automatically masks unused bits. This method is the preferred SPI read mechanism...</div><div class="ttdef"><b>Definition:</b> Module.cpp:194</div></div>
|
|
<div class="ttc" id="aclass_module_html_ae867ebfef795d63d1df234394510b96e"><div class="ttname"><a href="class_module.html#ae867ebfef795d63d1df234394510b96e">Module::getSpi</a></div><div class="ttdeci">SPIClass * getSpi() const</div><div class="ttdoc">Access method to get the SPI interface.</div><div class="ttdef"><b>Definition:</b> Module.h:333</div></div>
|
|
<div class="ttc" id="aclass_module_html_a99556decb983f682b98220ae5434b004"><div class="ttname"><a href="class_module.html#a99556decb983f682b98220ae5434b004">Module::ModuleSerial</a></div><div class="ttdeci">SoftwareSerial * ModuleSerial</div><div class="ttdoc">Internal SoftwareSerial instance.</div><div class="ttdef"><b>Definition:</b> Module.h:122</div></div>
|
|
<div class="ttc" id="aclass_module_html_a9d8ab2ff353bad5d0e7568d300a48ba0"><div class="ttname"><a href="class_module.html#a9d8ab2ff353bad5d0e7568d300a48ba0">Module::AtLineFeed</a></div><div class="ttdeci">char AtLineFeed[3]</div><div class="ttdoc">Line feed to be used when sending AT commands. Defaults to CR+LF.</div><div class="ttdef"><b>Definition:</b> Module.h:133</div></div>
|
|
<div class="ttc" id="aclass_module_html_ad1aadc2b52eea2bf9d26591091eec3f1"><div class="ttname"><a href="class_module.html#ad1aadc2b52eea2bf9d26591091eec3f1">Module::ATgetResponse</a></div><div class="ttdeci">bool ATgetResponse()</div><div class="ttdoc">Get response after sending AT command.</div><div class="ttdef"><b>Definition:</b> Module.cpp:170</div></div>
|
|
<div class="ttc" id="aclass_module_html_ae352c7a7b997fc1b17189c1312a8347f"><div class="ttname"><a href="class_module.html#ae352c7a7b997fc1b17189c1312a8347f">Module::getRst</a></div><div class="ttdeci">RADIOLIB_PIN_TYPE getRst() const</div><div class="ttdoc">Access method to get the pin number of hardware reset pin.</div><div class="ttdef"><b>Definition:</b> Module.h:305</div></div>
|
|
<div class="ttc" id="aclass_module_html_ae89764d15e8df5694a6aec0e18f72d3f"><div class="ttname"><a href="class_module.html#ae89764d15e8df5694a6aec0e18f72d3f">Module::SPIwriteCommand</a></div><div class="ttdeci">uint8_t SPIwriteCommand</div><div class="ttdoc">Basic SPI write command. Defaults to 0x80.</div><div class="ttdef"><b>Definition:</b> Module.h:143</div></div>
|
|
<div class="ttc" id="aclass_module_html_a623aee6405b330b7c935013ff3d01100"><div class="ttname"><a href="class_module.html#a623aee6405b330b7c935013ff3d01100">Module::ATsendData</a></div><div class="ttdeci">bool ATsendData(uint8_t *data, uint32_t len)</div><div class="ttdoc">Send raw AT data. Will also call ATgetResponse.</div><div class="ttdef"><b>Definition:</b> Module.cpp:160</div></div>
|
|
<div class="ttc" id="aclass_module_html_af0f870b09b9dd9636f1587d708f07d38"><div class="ttname"><a href="class_module.html#af0f870b09b9dd9636f1587d708f07d38">Module::delay</a></div><div class="ttdeci">static void delay(uint32_t ms)</div><div class="ttdoc">Arduino core delay override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:380</div></div>
|
|
<div class="ttc" id="aclass_module_html_a227d2d38e4747d0f49bb4df1c80b45d7"><div class="ttname"><a href="class_module.html#a227d2d38e4747d0f49bb4df1c80b45d7">Module::yield</a></div><div class="ttdeci">static void yield()</div><div class="ttdoc">Arduino core yield override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:376</div></div>
|
|
<div class="ttc" id="aclass_module_html_a46ad10b113df7c7e0a932be19eff63cd"><div class="ttname"><a href="class_module.html#a46ad10b113df7c7e0a932be19eff63cd">Module::digitalWrite</a></div><div class="ttdeci">static void digitalWrite(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value)</div><div class="ttdoc">Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin.</div><div class="ttdef"><b>Definition:</b> Module.cpp:324</div></div>
|
|
<div class="ttc" id="aclass_module_html_af3f51e517a825949891ad29e30fd3f59"><div class="ttname"><a href="class_module.html#af3f51e517a825949891ad29e30fd3f59">Module::micros</a></div><div class="ttdeci">static uint32_t micros()</div><div class="ttdoc">Arduino core micros override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:392</div></div>
|
|
<div class="ttc" id="aclass_module_html_ae53e355a77f2b7ce6473c62ac5f37334"><div class="ttname"><a href="class_module.html#ae53e355a77f2b7ce6473c62ac5f37334">Module::getCs</a></div><div class="ttdeci">RADIOLIB_PIN_TYPE getCs() const</div><div class="ttdoc">Access method to get the pin number of SPI chip select.</div><div class="ttdef"><b>Definition:</b> Module.h:291</div></div>
|
|
<div class="ttc" id="aclass_module_html_a1286d7fd9673cbfab945c26b2585a129"><div class="ttname"><a href="class_module.html#a1286d7fd9673cbfab945c26b2585a129">Module::SPIsetRegValue</a></div><div class="ttdeci">int16_t SPIsetRegValue(uint8_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF)</div><div class="ttdoc">Overwrite-safe SPI write method with verification. This method is the preferred SPI write mechanism.</div><div class="ttdef"><b>Definition:</b> Module.cpp:204</div></div>
|
|
<div class="ttc" id="aclass_module_html_ad5767216ba9340ae6d86915b12e89bd6"><div class="ttname"><a href="class_module.html#ad5767216ba9340ae6d86915b12e89bd6">Module::ATemptyBuffer</a></div><div class="ttdeci">void ATemptyBuffer()</div><div class="ttdoc">Empty internal AT buffer.</div><div class="ttdef"><b>Definition:</b> Module.cpp:147</div></div>
|
|
<div class="ttc" id="aclass_module_html_ab814614ddd34b57f5a612a20f5fe4c57"><div class="ttname"><a href="class_module.html#ab814614ddd34b57f5a612a20f5fe4c57">Module::SPIwriteRegister</a></div><div class="ttdeci">void SPIwriteRegister(uint8_t reg, uint8_t data)</div><div class="ttdoc">SPI basic write method. Use of this method is reserved for special cases, SPIsetRegValue should be us...</div><div class="ttdef"><b>Definition:</b> Module.cpp:267</div></div>
|
|
<div class="ttc" id="aclass_module_html_af0569f6930da7bee761eeca8158aed3a"><div class="ttname"><a href="class_module.html#af0569f6930da7bee761eeca8158aed3a">Module::term</a></div><div class="ttdeci">void term(uint8_t interface)</div><div class="ttdoc">Terminate low-level module control.</div><div class="ttdef"><b>Definition:</b> Module.cpp:132</div></div>
|
|
<div class="ttc" id="aclass_module_html_af998b86ce1243f616f6fcb6df5336207"><div class="ttname"><a href="class_module.html#af998b86ce1243f616f6fcb6df5336207">Module::noTone</a></div><div class="ttdeci">static void noTone(RADIOLIB_PIN_TYPE pin)</div><div class="ttdoc">Arduino core noTone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPP...</div><div class="ttdef"><b>Definition:</b> Module.cpp:353</div></div>
|
|
<div class="ttc" id="aclass_module_html_a0ecbb4e1e98094c1296b1e823dc14703"><div class="ttname"><a href="class_module.html#a0ecbb4e1e98094c1296b1e823dc14703">Module::setRfSwitchPins</a></div><div class="ttdeci">void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)</div><div class="ttdoc">Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...</div><div class="ttdef"><b>Definition:</b> Module.cpp:411</div></div>
|
|
<div class="ttc" id="aclass_module_html_a680dd2e80255cab30cbe9773bf20b390"><div class="ttname"><a href="class_module.html#a680dd2e80255cab30cbe9773bf20b390">Module::getTx</a></div><div class="ttdeci">RADIOLIB_PIN_TYPE getTx() const</div><div class="ttdoc">Access method to get the pin number of UART Rx.</div><div class="ttdef"><b>Definition:</b> Module.h:326</div></div>
|
|
<div class="ttc" id="aclass_module_html_aeb4c7447372d56a7cae6db91994aacfc"><div class="ttname"><a href="class_module.html#aeb4c7447372d56a7cae6db91994aacfc">Module::getGpio</a></div><div class="ttdeci">RADIOLIB_PIN_TYPE getGpio() const</div><div class="ttdoc">Access method to get the pin number of second interrupt/GPIO.</div><div class="ttdef"><b>Definition:</b> Module.h:312</div></div>
|
|
<div class="ttc" id="aclass_module_html_a160006371be8e121a8a54cc4462b3a72"><div class="ttname"><a href="class_module.html#a160006371be8e121a8a54cc4462b3a72">Module::flipBits16</a></div><div class="ttdeci">static uint16_t flipBits16(uint16_t i)</div><div class="ttdoc">Function to reflect bits within an integer.</div><div class="ttdef"><b>Definition:</b> Module.cpp:403</div></div>
|
|
<div class="ttc" id="aclass_module_html_a1d1a279cc7e1ab92e30c29c4dcca26a3"><div class="ttname"><a href="class_module.html#a1d1a279cc7e1ab92e30c29c4dcca26a3">Module::SPIreadRegister</a></div><div class="ttdeci">uint8_t SPIreadRegister(uint8_t reg)</div><div class="ttdoc">SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be use...</div><div class="ttdef"><b>Definition:</b> Module.cpp:257</div></div>
|
|
<div class="ttc" id="aclass_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...</div><div class="ttdef"><b>Definition:</b> Module.h:17</div></div>
|
|
<div class="ttc" id="aclass_module_html_a06b2e1f1eb9e07a280e55f517f2fab38"><div class="ttname"><a href="class_module.html#a06b2e1f1eb9e07a280e55f517f2fab38">Module::Module</a></div><div class="ttdeci">Module(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst)</div><div class="ttdoc">SPI-based module constructor. Will use the default SPI interface automatically initialize it.</div><div class="ttdef"><b>Definition:</b> Module.cpp:16</div></div>
|
|
<div class="ttc" id="aclass_module_html_a4ea888758b4a7784082d513a1e7849a4"><div class="ttname"><a href="class_module.html#a4ea888758b4a7784082d513a1e7849a4">Module::operator=</a></div><div class="ttdeci">Module & operator=(const Module &mod)</div><div class="ttdoc">Overload for assignment operator.</div><div class="ttdef"><b>Definition:</b> Module.cpp:91</div></div>
|
|
<div class="ttc" id="aclass_module_html_adb22d89bc5f532f1d056d9a9f3a6589c"><div class="ttname"><a href="class_module.html#adb22d89bc5f532f1d056d9a9f3a6589c">Module::init</a></div><div class="ttdeci">void init(uint8_t interface)</div><div class="ttdoc">Initialize low-level module control.</div><div class="ttdef"><b>Definition:</b> Module.cpp:108</div></div>
|
|
<div class="ttc" id="aclass_module_html_a849ad85fc1bc3a7130e660c13973ab26"><div class="ttname"><a href="class_module.html#a849ad85fc1bc3a7130e660c13973ab26">Module::SPIreadCommand</a></div><div class="ttdeci">uint8_t SPIreadCommand</div><div class="ttdoc">Basic SPI read command. Defaults to 0x00.</div><div class="ttdef"><b>Definition:</b> Module.h:138</div></div>
|
|
<div class="ttc" id="aclass_module_html_a656738f2fe41fb236d27aed02efa8ad4"><div class="ttname"><a href="class_module.html#a656738f2fe41fb236d27aed02efa8ad4">Module::detachInterrupt</a></div><div class="ttdeci">static void detachInterrupt(RADIOLIB_PIN_TYPE interruptNum)</div><div class="ttdoc">Arduino core detachInterrupt override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:372</div></div>
|
|
<div class="ttc" id="aclass_module_html_a7b6da4ca8fe5178617a1cc28854929a0"><div class="ttname"><a href="class_module.html#a7b6da4ca8fe5178617a1cc28854929a0">Module::getSpiSettings</a></div><div class="ttdeci">SPISettings getSpiSettings() const</div><div class="ttdoc">Access method to get the SPI interface settings.</div><div class="ttdef"><b>Definition:</b> Module.h:340</div></div>
|
|
<div class="ttc" id="aclass_module_html_a4a87d59ad2bf6bb1bb9de1856a81b824"><div class="ttname"><a href="class_module.html#a4a87d59ad2bf6bb1bb9de1856a81b824">Module::setRfSwitchState</a></div><div class="ttdeci">void setRfSwitchState(RADIOLIB_PIN_STATUS rxPinState, RADIOLIB_PIN_STATUS txPinState)</div><div class="ttdoc">Set RF switch state.</div><div class="ttdef"><b>Definition:</b> Module.cpp:419</div></div>
|
|
<div class="ttc" id="aclass_module_html_a6fa5239d73379e4140f5c4f513b1b8d2"><div class="ttname"><a href="class_module.html#a6fa5239d73379e4140f5c4f513b1b8d2">Module::SPIreadRegisterBurst</a></div><div class="ttdeci">void SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t *inBytes)</div><div class="ttdoc">SPI burst read method.</div><div class="ttdef"><b>Definition:</b> Module.cpp:253</div></div>
|
|
<div class="ttc" id="aclass_module_html_a32ba59613a2f1e77038956e18d9fedd7"><div class="ttname"><a href="class_module.html#a32ba59613a2f1e77038956e18d9fedd7">Module::tone</a></div><div class="ttdeci">static void tone(RADIOLIB_PIN_TYPE pin, uint16_t value)</div><div class="ttdoc">Arduino core tone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPOR...</div><div class="ttdef"><b>Definition:</b> Module.cpp:337</div></div>
|
|
<div class="ttc" id="aclass_module_html_a7f5fd7409f21d33a16ea1de589962ae6"><div class="ttname"><a href="class_module.html#a7f5fd7409f21d33a16ea1de589962ae6">Module::flipBits</a></div><div class="ttdeci">static uint8_t flipBits(uint8_t b)</div><div class="ttdoc">Function to reflect bits within a byte.</div><div class="ttdef"><b>Definition:</b> Module.cpp:396</div></div>
|
|
<div class="ttc" id="aclass_serial_module_html"><div class="ttname"><a href="class_serial_module.html">SerialModule</a></div><div class="ttdoc">Extension of Module class for UART-based modules, only exists to distinguish the UART constructor.</div><div class="ttdef"><b>Definition:</b> Module.h:497</div></div>
|
|
<div class="ttc" id="aclass_module_html_a128ead3f3198e3b06d39a128a5d6c777"><div class="ttname"><a href="class_module.html#a128ead3f3198e3b06d39a128a5d6c777">Module::baudrate</a></div><div class="ttdeci">uint32_t baudrate</div><div class="ttdoc">Baud rate of SoftwareSerial UART communication. Defaults to 9600 baud.</div><div class="ttdef"><b>Definition:</b> Module.h:128</div></div>
|
|
<div class="ttc" id="aclass_module_html_a216dd0c6ce140857f2b003ab8d89fbac"><div class="ttname"><a href="class_module.html#a216dd0c6ce140857f2b003ab8d89fbac">Module::millis</a></div><div class="ttdeci">static uint32_t millis()</div><div class="ttdoc">Arduino core millis override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:388</div></div>
|
|
<div class="ttc" id="aclass_module_html_a5c09c878b55f56990dd0c2972a3440c4"><div class="ttname"><a href="class_module.html#a5c09c878b55f56990dd0c2972a3440c4">Module::ATsendCommand</a></div><div class="ttdeci">bool ATsendCommand(const char *cmd)</div><div class="ttdoc">Send AT command. Will also call ATgetResponse.</div><div class="ttdef"><b>Definition:</b> Module.cpp:153</div></div>
|
|
<div class="ttc" id="aclass_module_html_a14d7cd8220bfa4440bda055ce5be748c"><div class="ttname"><a href="class_module.html#a14d7cd8220bfa4440bda055ce5be748c">Module::delayMicroseconds</a></div><div class="ttdeci">static void delayMicroseconds(uint32_t us)</div><div class="ttdoc">Arduino core delayMicroseconds override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:384</div></div>
|
|
<div class="ttc" id="aclass_module_html_a91aaa34aecdfeaf24948551b037033be"><div class="ttname"><a href="class_module.html#a91aaa34aecdfeaf24948551b037033be">Module::attachInterrupt</a></div><div class="ttdeci">static void attachInterrupt(RADIOLIB_PIN_TYPE interruptNum, void(*userFunc)(void), RADIOLIB_INTERRUPT_STATUS mode)</div><div class="ttdoc">Arduino core attachInterrupt override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:368</div></div>
|
|
<div class="ttc" id="aclass_module_html_a9d77a08070cbd48fd4ece62a739333e9"><div class="ttname"><a href="class_module.html#a9d77a08070cbd48fd4ece62a739333e9">Module::SPIwriteRegisterBurst</a></div><div class="ttdeci">void SPIwriteRegisterBurst(uint8_t reg, uint8_t *data, uint8_t numBytes)</div><div class="ttdoc">SPI burst write method.</div><div class="ttdef"><b>Definition:</b> Module.cpp:263</div></div>
|
|
<!-- 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"><b>Module.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.17 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|