338 lines
50 KiB
HTML
338 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.9.1"/>
|
|
<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.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</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">#if !defined(_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">#if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor"> #include <SPI.h></span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="class_module.html"> 16</a></span> <span class="keyword">class </span><a class="code" href="class_module.html">Module</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="l00018"></a><span class="lineno"> 18</span>  </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="class_module.html#a1101d49f597f756141fc9de88a504f21">Module</a>(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio = RADIOLIB_NC);</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="class_module.html#a1101d49f597f756141fc9de88a504f21">Module</a>(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio, SPIClass& spi, SPISettings spiSettings = RADIOLIB_DEFAULT_SPI_SETTINGS);</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"> #else</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="class_module.html#a1101d49f597f756141fc9de88a504f21">Module</a>(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio = RADIOLIB_NC);</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="class_module.html#a1101d49f597f756141fc9de88a504f21">Module</a>(<span class="keyword">const</span> <a class="code" href="class_module.html">Module</a>& mod);</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</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="l00081"></a><span class="lineno"> 81</span>  </div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">// public member variables</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="class_module.html#a849ad85fc1bc3a7130e660c13973ab26"> 87</a></span>  uint8_t <a class="code" href="class_module.html#a849ad85fc1bc3a7130e660c13973ab26">SPIreadCommand</a> = 0b00000000;</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="class_module.html#ae89764d15e8df5694a6aec0e18f72d3f"> 92</a></span>  uint8_t <a class="code" href="class_module.html#ae89764d15e8df5694a6aec0e18f72d3f">SPIwriteCommand</a> = 0b10000000;</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="preprocessor"> #if defined(RADIOLIB_INTERRUPT_TIMING)</span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">typedef</span> void (*TimerSetupCb_t)(uint32_t len);</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  TimerSetupCb_t TimerSetupCb = <span class="keyword">nullptr</span>;</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">volatile</span> <span class="keywordtype">bool</span> TimerFlag = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  </div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="comment">// basic methods</span></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  </div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#ad1956ac81429ec1f61f83dbc081cf18c">init</a>();</div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  </div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a45bd514a1f2859d9a867c8f9b13eb332">term</a>();</div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  </div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="comment">// SPI methods</span></div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</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="l00139"></a><span class="lineno"> 139</span>  </div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</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="l00158"></a><span class="lineno"> 158</span>  </div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</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="l00169"></a><span class="lineno"> 169</span>  </div>
|
|
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  uint8_t <a class="code" href="class_module.html#a1d1a279cc7e1ab92e30c29c4dcca26a3">SPIreadRegister</a>(uint8_t reg);</div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  </div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</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="l00189"></a><span class="lineno"> 189</span>  </div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</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="l00198"></a><span class="lineno"> 198</span>  </div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"> 212</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="l00213"></a><span class="lineno"> 213</span>  </div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <span class="comment">// pin number access methods</span></div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  </div>
|
|
<div class="line"><a name="l00221"></a><span class="lineno"><a class="line" href="class_module.html#ae53e355a77f2b7ce6473c62ac5f37334"> 221</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="l00222"></a><span class="lineno"> 222</span>  </div>
|
|
<div class="line"><a name="l00228"></a><span class="lineno"><a class="line" href="class_module.html#a8c7f17a63b67117d953f1ba990b17f80"> 228</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="l00229"></a><span class="lineno"> 229</span>  </div>
|
|
<div class="line"><a name="l00235"></a><span class="lineno"><a class="line" href="class_module.html#ae352c7a7b997fc1b17189c1312a8347f"> 235</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="l00236"></a><span class="lineno"> 236</span>  </div>
|
|
<div class="line"><a name="l00242"></a><span class="lineno"><a class="line" href="class_module.html#aeb4c7447372d56a7cae6db91994aacfc"> 242</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>(_gpio); }</div>
|
|
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  </div>
|
|
<div class="line"><a name="l00252"></a><span class="lineno"> 252</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="l00253"></a><span class="lineno"> 253</span>  </div>
|
|
<div class="line"><a name="l00261"></a><span class="lineno"> 261</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="l00262"></a><span class="lineno"> 262</span>  </div>
|
|
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a47978200f7e2e408fb64f506c81cee9f">waitForMicroseconds</a>(uint32_t start, uint32_t len);</div>
|
|
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  </div>
|
|
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  <span class="comment">// Arduino core overrides</span></div>
|
|
<div class="line"><a name="l00274"></a><span class="lineno"> 274</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#af7e4872dad3d19b6f75f532c88683168">pinMode</a>(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode);</div>
|
|
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  </div>
|
|
<div class="line"><a name="l00291"></a><span class="lineno"> 291</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="l00292"></a><span class="lineno"> 292</span>  </div>
|
|
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  RADIOLIB_PIN_STATUS <a class="code" href="class_module.html#a7495c81640aac8f4686221dad34a274f">digitalRead</a>(RADIOLIB_PIN_TYPE pin);</div>
|
|
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  </div>
|
|
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a33e33df69d58660b8cd0e2dafe5e9189">tone</a>(RADIOLIB_PIN_TYPE pin, uint16_t value, uint32_t duration = 0);</div>
|
|
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  </div>
|
|
<div class="line"><a name="l00316"></a><span class="lineno"> 316</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="l00317"></a><span class="lineno"> 317</span>  </div>
|
|
<div class="line"><a name="l00327"></a><span class="lineno"> 327</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="l00328"></a><span class="lineno"> 328</span>  </div>
|
|
<div class="line"><a name="l00334"></a><span class="lineno"> 334</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="l00335"></a><span class="lineno"> 335</span>  </div>
|
|
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a227d2d38e4747d0f49bb4df1c80b45d7">yield</a>();</div>
|
|
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span>  </div>
|
|
<div class="line"><a name="l00346"></a><span class="lineno"> 346</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="l00347"></a><span class="lineno"> 347</span>  </div>
|
|
<div class="line"><a name="l00353"></a><span class="lineno"> 353</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="l00354"></a><span class="lineno"> 354</span>  </div>
|
|
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span>  uint32_t <a class="code" href="class_module.html#a216dd0c6ce140857f2b003ab8d89fbac">millis</a>();</div>
|
|
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span>  </div>
|
|
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span>  uint32_t <a class="code" href="class_module.html#af3f51e517a825949891ad29e30fd3f59">micros</a>();</div>
|
|
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span>  </div>
|
|
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span>  uint32_t <a class="code" href="class_module.html#a1310b9594f86fb1dc6646479922a1fdc">pulseIn</a>(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS state, uint32_t timeout);</div>
|
|
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span>  </div>
|
|
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#af6bfd022681d360082e3dd31a984e1f7">begin</a>();</div>
|
|
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span>  </div>
|
|
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a3d0caa9f5e38cfa2c609570a89a4a703">beginTransaction</a>();</div>
|
|
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span>  </div>
|
|
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span>  uint8_t <a class="code" href="class_module.html#a45e7823c44ac0aa8a10bd4f365890c98">transfer</a>(uint8_t b);</div>
|
|
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  </div>
|
|
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a015226566efc5131c8a39a184b6c4e6b">endTransaction</a>();</div>
|
|
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>  </div>
|
|
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#aa7fc017ee35f40c90e5badc5bc568c3d">end</a>();</div>
|
|
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span>  </div>
|
|
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span>  <span class="comment">// helper functions to set up SPI overrides on Arduino</span></div>
|
|
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span>  <span class="keywordtype">void</span> SPIbegin();</div>
|
|
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span>  <span class="keywordtype">void</span> SPIend();</div>
|
|
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> SPIbeginTransaction();</div>
|
|
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span>  <span class="keyword">virtual</span> uint8_t <a class="code" href="class_module.html#aefd955f1cd6d588b2cc229db87cb2121">SPItransfer</a>(uint8_t b);</div>
|
|
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> SPIendTransaction();</div>
|
|
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span>  </div>
|
|
<div class="line"><a name="l00407"></a><span class="lineno"> 407</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="l00408"></a><span class="lineno"> 408</span>  </div>
|
|
<div class="line"><a name="l00412"></a><span class="lineno"> 412</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="l00413"></a><span class="lineno"> 413</span>  </div>
|
|
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_module.html#ac2dc188128f32f9360a178f31659291a">hexdump</a>(uint8_t* data, <span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span>  </div>
|
|
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a7216d32fc55130d111409c6f2050d9c0">regdump</a>(uint8_t start, uint8_t len);</div>
|
|
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span>  </div>
|
|
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
|
|
<div class="line"><a name="l00433"></a><span class="lineno"> 433</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span>  </div>
|
|
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span>  <span class="comment">// pins</span></div>
|
|
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span>  RADIOLIB_PIN_TYPE _cs = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span>  RADIOLIB_PIN_TYPE _irq = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span>  RADIOLIB_PIN_TYPE _rst = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span>  RADIOLIB_PIN_TYPE _gpio = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span>  </div>
|
|
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span>  <span class="comment">// SPI interface (Arduino only)</span></div>
|
|
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span>  SPIClass* _spi = NULL;</div>
|
|
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span>  SPISettings _spiSettings = RADIOLIB_DEFAULT_SPI_SETTINGS;</div>
|
|
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span>  <span class="keywordtype">bool</span> _initInterface = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span>  </div>
|
|
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span>  <span class="comment">// RF switch presence and pins</span></div>
|
|
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  <span class="keywordtype">bool</span> _useRfSwitch = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span>  RADIOLIB_PIN_TYPE _rxEn = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span>  RADIOLIB_PIN_TYPE _txEn = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span>  </div>
|
|
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span> <span class="preprocessor"> #if defined(RADIOLIB_INTERRUPT_TIMING)</span></div>
|
|
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span>  uint32_t _prevTimingLen = 0;</div>
|
|
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span>  </div>
|
|
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span>  <span class="comment">// hardware abstraction layer callbacks</span></div>
|
|
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span>  <span class="comment">// this is placed at the end of Module class because the callback generator macros</span></div>
|
|
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span>  <span class="comment">// screw with the private/public access specifiers</span></div>
|
|
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_PIN_MODE);</div>
|
|
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DIGITAL_WRITE);</div>
|
|
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DIGITAL_READ);</div>
|
|
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_TONE);</div>
|
|
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_NO_TONE);</div>
|
|
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_ATTACH_INTERRUPT);</div>
|
|
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DETACH_INTERRUPT);</div>
|
|
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_YIELD);</div>
|
|
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DELAY);</div>
|
|
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DELAY_MICROSECONDS);</div>
|
|
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_MILLIS);</div>
|
|
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_MICROS);</div>
|
|
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_PULSE_IN);</div>
|
|
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span>  </div>
|
|
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span>  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_BEGIN);</div>
|
|
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span>  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_BEGIN_TRANSACTION);</div>
|
|
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_TRANSFER);</div>
|
|
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span>  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_END_TRANSACTION);</div>
|
|
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span>  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_END);</div>
|
|
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="preprocessor"> #else</span></div>
|
|
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_BEGIN);</div>
|
|
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_BEGIN_TRANSACTION);</div>
|
|
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_TRANSFER);</div>
|
|
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_END_TRANSACTION);</div>
|
|
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_END);</div>
|
|
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span> };</div>
|
|
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span>  </div>
|
|
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span> <span class="preprocessor">#endif</span></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 methods to control the wireless module. Every module class contains o...</div><div class="ttdef"><b>Definition:</b> Module.h:16</div></div>
|
|
<div class="ttc" id="aclass_module_html_a015226566efc5131c8a39a184b6c4e6b"><div class="ttname"><a href="class_module.html#a015226566efc5131c8a39a184b6c4e6b">Module::endTransaction</a></div><div class="ttdeci">void endTransaction()</div><div class="ttdoc">Arduino core SPI endTransaction override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:445</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:553</div></div>
|
|
<div class="ttc" id="aclass_module_html_a1101d49f597f756141fc9de88a504f21"><div class="ttname"><a href="class_module.html#a1101d49f597f756141fc9de88a504f21">Module::Module</a></div><div class="ttdeci">Module(RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio=RADIOLIB_NC)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> Module.cpp:81</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:140</div></div>
|
|
<div class="ttc" id="aclass_module_html_a1310b9594f86fb1dc6646479922a1fdc"><div class="ttname"><a href="class_module.html#a1310b9594f86fb1dc6646479922a1fdc">Module::pulseIn</a></div><div class="ttdeci">uint32_t pulseIn(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS state, uint32_t timeout)</div><div class="ttdoc">Arduino core pulseIn override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:411</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">void delayMicroseconds(uint32_t us)</div><div class="ttdoc">Arduino core delayMicroseconds override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:390</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:500</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:193</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">uint32_t millis()</div><div class="ttdoc">Arduino core millis override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:397</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">void yield()</div><div class="ttdoc">Arduino core yield override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:374</div></div>
|
|
<div class="ttc" id="aclass_module_html_a33e33df69d58660b8cd0e2dafe5e9189"><div class="ttname"><a href="class_module.html#a33e33df69d58660b8cd0e2dafe5e9189">Module::tone</a></div><div class="ttdeci">void tone(RADIOLIB_PIN_TYPE pin, uint16_t value, uint32_t duration=0)</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:298</div></div>
|
|
<div class="ttc" id="aclass_module_html_a3d0caa9f5e38cfa2c609570a89a4a703"><div class="ttname"><a href="class_module.html#a3d0caa9f5e38cfa2c609570a89a4a703">Module::beginTransaction</a></div><div class="ttdeci">void beginTransaction()</div><div class="ttdoc">Arduino core SPI beginTransaction override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:427</div></div>
|
|
<div class="ttc" id="aclass_module_html_a45bd514a1f2859d9a867c8f9b13eb332"><div class="ttname"><a href="class_module.html#a45bd514a1f2859d9a867c8f9b13eb332">Module::term</a></div><div class="ttdeci">void term()</div><div class="ttdoc">Terminate low-level module control.</div><div class="ttdef"><b>Definition:</b> Module.cpp:117</div></div>
|
|
<div class="ttc" id="aclass_module_html_a45e7823c44ac0aa8a10bd4f365890c98"><div class="ttname"><a href="class_module.html#a45e7823c44ac0aa8a10bd4f365890c98">Module::transfer</a></div><div class="ttdeci">uint8_t transfer(uint8_t b)</div><div class="ttdoc">Arduino core SPI transfer override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:436</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">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:279</div></div>
|
|
<div class="ttc" id="aclass_module_html_a47978200f7e2e408fb64f506c81cee9f"><div class="ttname"><a href="class_module.html#a47978200f7e2e408fb64f506c81cee9f">Module::waitForMicroseconds</a></div><div class="ttdeci">void waitForMicroseconds(uint32_t start, uint32_t len)</div><div class="ttdoc">Wait for time to elapse, either using the microsecond timer, or the TimerFlag. Note that in interrupt...</div><div class="ttdef"><b>Definition:</b> Module.cpp:254</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:561</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:96</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">void detachInterrupt(RADIOLIB_PIN_TYPE interruptNum)</div><div class="ttdoc">Arduino core detachInterrupt override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:367</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:189</div></div>
|
|
<div class="ttc" id="aclass_module_html_a7216d32fc55130d111409c6f2050d9c0"><div class="ttname"><a href="class_module.html#a7216d32fc55130d111409c6f2050d9c0">Module::regdump</a></div><div class="ttdeci">void regdump(uint8_t start, uint8_t len)</div><div class="ttdoc">Function to dump device registers as hex into the debug port.</div><div class="ttdef"><b>Definition:</b> Module.cpp:540</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">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:286</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:493</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:87</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:228</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">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:360</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:199</div></div>
|
|
<div class="ttc" id="aclass_module_html_aa7fc017ee35f40c90e5badc5bc568c3d"><div class="ttname"><a href="class_module.html#aa7fc017ee35f40c90e5badc5bc568c3d">Module::end</a></div><div class="ttdeci">void end()</div><div class="ttdoc">Arduino core SPI end override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:454</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:203</div></div>
|
|
<div class="ttc" id="aclass_module_html_ac2dc188128f32f9360a178f31659291a"><div class="ttname"><a href="class_module.html#ac2dc188128f32f9360a178f31659291a">Module::hexdump</a></div><div class="ttdeci">static void hexdump(uint8_t *data, size_t len)</div><div class="ttdoc">Function to dump data as hex into the debug port.</div><div class="ttdef"><b>Definition:</b> Module.cpp:508</div></div>
|
|
<div class="ttc" id="aclass_module_html_ad1956ac81429ec1f61f83dbc081cf18c"><div class="ttname"><a href="class_module.html#ad1956ac81429ec1f61f83dbc081cf18c">Module::init</a></div><div class="ttdeci">void init()</div><div class="ttdoc">Initialize low-level module control.</div><div class="ttdef"><b>Definition:</b> Module.cpp:107</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:130</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:235</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:221</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:92</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:242</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:207</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">void delay(uint32_t ms)</div><div class="ttdoc">Arduino core delay override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:383</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">uint32_t micros()</div><div class="ttdoc">Arduino core micros override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:404</div></div>
|
|
<div class="ttc" id="aclass_module_html_af6bfd022681d360082e3dd31a984e1f7"><div class="ttname"><a href="class_module.html#af6bfd022681d360082e3dd31a984e1f7">Module::begin</a></div><div class="ttdeci">void begin()</div><div class="ttdoc">Arduino core SPI begin override.</div><div class="ttdef"><b>Definition:</b> Module.cpp:418</div></div>
|
|
<div class="ttc" id="aclass_module_html_af7e4872dad3d19b6f75f532c88683168"><div class="ttname"><a href="class_module.html#af7e4872dad3d19b6f75f532c88683168">Module::pinMode</a></div><div class="ttdeci">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:272</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">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:333</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"><b>Module.h</b></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|