366 lines
58 KiB
HTML
366 lines
58 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="l00027"></a><span class="lineno"><a class="line" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c"> 27</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a> = 3;</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="struct_module_1_1_rf_switch_mode__t.html"> 34</a></span>  <span class="keyword">struct </span><a class="code" href="struct_module_1_1_rf_switch_mode__t.html">RfSwitchMode_t</a> {</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  uint8_t mode;</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  RADIOLIB_PIN_STATUS values[<a class="code" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a>];</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  };</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bf"> 46</a></span>  <span class="keyword">enum</span> <a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bf">OpMode_t</a> {</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770"> 50</a></span>  <a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770">MODE_END_OF_TABLE</a> = 0,</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671"> 52</a></span>  <a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671">MODE_IDLE</a>,</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f"> 54</a></span>  <a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f">MODE_RX</a>,</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571"> 56</a></span>  <a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571">MODE_TX</a>,</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  };</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="class_module.html#a4819e8b5e1fba0c99aa11477296e0927"> 65</a></span>  <span class="keyword">static</span> constexpr <a class="code" href="struct_module_1_1_rf_switch_mode__t.html">RfSwitchMode_t</a> <a class="code" href="class_module.html#a4819e8b5e1fba0c99aa11477296e0927">END_OF_MODE_TABLE</a> = {<a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770">MODE_END_OF_TABLE</a>, {}};</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</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="l00081"></a><span class="lineno"> 81</span>  </div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</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="l00098"></a><span class="lineno"> 98</span>  </div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor"> #else</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</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="l00113"></a><span class="lineno"> 113</span>  </div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  </div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</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="l00122"></a><span class="lineno"> 122</span>  </div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</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="l00129"></a><span class="lineno"> 129</span>  </div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="comment">// public member variables</span></div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  </div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="class_module.html#a849ad85fc1bc3a7130e660c13973ab26"> 135</a></span>  uint8_t <a class="code" href="class_module.html#a849ad85fc1bc3a7130e660c13973ab26">SPIreadCommand</a> = 0b00000000;</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  </div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"><a class="line" href="class_module.html#ae89764d15e8df5694a6aec0e18f72d3f"> 140</a></span>  uint8_t <a class="code" href="class_module.html#ae89764d15e8df5694a6aec0e18f72d3f">SPIwriteCommand</a> = 0b10000000;</div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  </div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="preprocessor"> #if defined(RADIOLIB_INTERRUPT_TIMING)</span></div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  </div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keyword">typedef</span> void (*TimerSetupCb_t)(uint32_t len);</div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  </div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  TimerSetupCb_t TimerSetupCb = <span class="keyword">nullptr</span>;</div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  </div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keyword">volatile</span> <span class="keywordtype">bool</span> TimerFlag = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  </div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="preprocessor"> #endif</span></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">// basic 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#ad1956ac81429ec1f61f83dbc081cf18c">init</a>();</div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  </div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a45bd514a1f2859d9a867c8f9b13eb332">term</a>();</div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  </div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="comment">// SPI methods</span></div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  </div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</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="l00187"></a><span class="lineno"> 187</span>  </div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</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="l00206"></a><span class="lineno"> 206</span>  </div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</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="l00217"></a><span class="lineno"> 217</span>  </div>
|
|
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  uint8_t <a class="code" href="class_module.html#a1d1a279cc7e1ab92e30c29c4dcca26a3">SPIreadRegister</a>(uint8_t reg);</div>
|
|
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  </div>
|
|
<div class="line"><a name="l00236"></a><span class="lineno"> 236</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="l00237"></a><span class="lineno"> 237</span>  </div>
|
|
<div class="line"><a name="l00245"></a><span class="lineno"> 245</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="l00246"></a><span class="lineno"> 246</span>  </div>
|
|
<div class="line"><a name="l00260"></a><span class="lineno"> 260</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="l00261"></a><span class="lineno"> 261</span>  </div>
|
|
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  <span class="comment">// pin number access methods</span></div>
|
|
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  </div>
|
|
<div class="line"><a name="l00269"></a><span class="lineno"><a class="line" href="class_module.html#ae53e355a77f2b7ce6473c62ac5f37334"> 269</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="l00270"></a><span class="lineno"> 270</span>  </div>
|
|
<div class="line"><a name="l00276"></a><span class="lineno"><a class="line" href="class_module.html#a8c7f17a63b67117d953f1ba990b17f80"> 276</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="l00277"></a><span class="lineno"> 277</span>  </div>
|
|
<div class="line"><a name="l00283"></a><span class="lineno"><a class="line" href="class_module.html#ae352c7a7b997fc1b17189c1312a8347f"> 283</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="l00284"></a><span class="lineno"> 284</span>  </div>
|
|
<div class="line"><a name="l00290"></a><span class="lineno"><a class="line" href="class_module.html#aeb4c7447372d56a7cae6db91994aacfc"> 290</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="l00291"></a><span class="lineno"> 291</span>  </div>
|
|
<div class="line"><a name="l00308"></a><span class="lineno"> 308</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="l00309"></a><span class="lineno"> 309</span>  </div>
|
|
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a870c63233146d03380f753498c975050">setRfSwitchTable</a>(<span class="keyword">const</span> RADIOLIB_PIN_TYPE (&pins)[<a class="code" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a>], <span class="keyword">const</span> RfSwitchMode_t table[]);</div>
|
|
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span>  </div>
|
|
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span>  <span class="keyword">const</span> RfSwitchMode_t *<a class="code" href="class_module.html#a5699a937b62ba41387567b4d679b9377">findRfSwitchMode</a>(uint8_t mode) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  </div>
|
|
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#afbed643f082286012bf44bba22381ae6">setRfSwitchState</a>(uint8_t mode);</div>
|
|
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span>  </div>
|
|
<div class="line"><a name="l00399"></a><span class="lineno"> 399</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="l00400"></a><span class="lineno"> 400</span>  </div>
|
|
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span>  <span class="comment">// Arduino core overrides</span></div>
|
|
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span>  </div>
|
|
<div class="line"><a name="l00410"></a><span class="lineno"> 410</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="l00411"></a><span class="lineno"> 411</span>  </div>
|
|
<div class="line"><a name="l00419"></a><span class="lineno"> 419</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="l00420"></a><span class="lineno"> 420</span>  </div>
|
|
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span>  RADIOLIB_PIN_STATUS <a class="code" href="class_module.html#a7495c81640aac8f4686221dad34a274f">digitalRead</a>(RADIOLIB_PIN_TYPE pin);</div>
|
|
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span>  </div>
|
|
<div class="line"><a name="l00437"></a><span class="lineno"> 437</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="l00438"></a><span class="lineno"> 438</span>  </div>
|
|
<div class="line"><a name="l00444"></a><span class="lineno"> 444</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="l00445"></a><span class="lineno"> 445</span>  </div>
|
|
<div class="line"><a name="l00455"></a><span class="lineno"> 455</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="l00456"></a><span class="lineno"> 456</span>  </div>
|
|
<div class="line"><a name="l00462"></a><span class="lineno"> 462</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="l00463"></a><span class="lineno"> 463</span>  </div>
|
|
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a227d2d38e4747d0f49bb4df1c80b45d7">yield</a>();</div>
|
|
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span>  </div>
|
|
<div class="line"><a name="l00474"></a><span class="lineno"> 474</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="l00475"></a><span class="lineno"> 475</span>  </div>
|
|
<div class="line"><a name="l00481"></a><span class="lineno"> 481</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="l00482"></a><span class="lineno"> 482</span>  </div>
|
|
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span>  uint32_t <a class="code" href="class_module.html#a216dd0c6ce140857f2b003ab8d89fbac">millis</a>();</div>
|
|
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span>  </div>
|
|
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span>  uint32_t <a class="code" href="class_module.html#af3f51e517a825949891ad29e30fd3f59">micros</a>();</div>
|
|
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span>  </div>
|
|
<div class="line"><a name="l00496"></a><span class="lineno"> 496</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="l00497"></a><span class="lineno"> 497</span>  </div>
|
|
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#af6bfd022681d360082e3dd31a984e1f7">begin</a>();</div>
|
|
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span>  </div>
|
|
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a3d0caa9f5e38cfa2c609570a89a4a703">beginTransaction</a>();</div>
|
|
<div class="line"><a name="l00507"></a><span class="lineno"> 507</span>  </div>
|
|
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span>  uint8_t <a class="code" href="class_module.html#a45e7823c44ac0aa8a10bd4f365890c98">transfer</a>(uint8_t b);</div>
|
|
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span>  </div>
|
|
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a015226566efc5131c8a39a184b6c4e6b">endTransaction</a>();</div>
|
|
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span>  </div>
|
|
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#aa7fc017ee35f40c90e5badc5bc568c3d">end</a>();</div>
|
|
<div class="line"><a name="l00522"></a><span class="lineno"> 522</span>  </div>
|
|
<div class="line"><a name="l00523"></a><span class="lineno"> 523</span>  <span class="comment">// helper functions to set up SPI overrides on Arduino</span></div>
|
|
<div class="line"><a name="l00524"></a><span class="lineno"> 524</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00525"></a><span class="lineno"> 525</span>  <span class="keywordtype">void</span> SPIbegin();</div>
|
|
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span>  <span class="keywordtype">void</span> SPIend();</div>
|
|
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> SPIbeginTransaction();</div>
|
|
<div class="line"><a name="l00529"></a><span class="lineno"> 529</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="l00530"></a><span class="lineno"> 530</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> SPIendTransaction();</div>
|
|
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span>  </div>
|
|
<div class="line"><a name="l00535"></a><span class="lineno"> 535</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="l00536"></a><span class="lineno"> 536</span>  </div>
|
|
<div class="line"><a name="l00540"></a><span class="lineno"> 540</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="l00541"></a><span class="lineno"> 541</span>  </div>
|
|
<div class="line"><a name="l00549"></a><span class="lineno"> 549</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="l00550"></a><span class="lineno"> 550</span>  </div>
|
|
<div class="line"><a name="l00558"></a><span class="lineno"> 558</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="l00559"></a><span class="lineno"> 559</span>  </div>
|
|
<div class="line"><a name="l00560"></a><span class="lineno"> 560</span> <span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
|
|
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span>  </div>
|
|
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span>  <span class="comment">// pins</span></div>
|
|
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span>  RADIOLIB_PIN_TYPE _cs = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00566"></a><span class="lineno"> 566</span>  RADIOLIB_PIN_TYPE _irq = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span>  RADIOLIB_PIN_TYPE _rst = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span>  RADIOLIB_PIN_TYPE _gpio = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span>  </div>
|
|
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span>  <span class="comment">// SPI interface (Arduino only)</span></div>
|
|
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00572"></a><span class="lineno"> 572</span>  SPIClass* _spi = NULL;</div>
|
|
<div class="line"><a name="l00573"></a><span class="lineno"> 573</span>  SPISettings _spiSettings = RADIOLIB_DEFAULT_SPI_SETTINGS;</div>
|
|
<div class="line"><a name="l00574"></a><span class="lineno"> 574</span>  <span class="keywordtype">bool</span> _initInterface = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00575"></a><span class="lineno"> 575</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span>  </div>
|
|
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span>  <span class="comment">// RF switch pins and table</span></div>
|
|
<div class="line"><a name="l00578"></a><span class="lineno"> 578</span>  RADIOLIB_PIN_TYPE _rfSwitchPins[<a class="code" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a>] = { RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC };</div>
|
|
<div class="line"><a name="l00579"></a><span class="lineno"> 579</span>  <span class="keyword">const</span> RfSwitchMode_t *_rfSwitchTable = <span class="keyword">nullptr</span>;</div>
|
|
<div class="line"><a name="l00580"></a><span class="lineno"> 580</span>  </div>
|
|
<div class="line"><a name="l00581"></a><span class="lineno"> 581</span> <span class="preprocessor"> #if defined(RADIOLIB_INTERRUPT_TIMING)</span></div>
|
|
<div class="line"><a name="l00582"></a><span class="lineno"> 582</span>  uint32_t _prevTimingLen = 0;</div>
|
|
<div class="line"><a name="l00583"></a><span class="lineno"> 583</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span>  </div>
|
|
<div class="line"><a name="l00585"></a><span class="lineno"> 585</span>  <span class="comment">// hardware abstraction layer callbacks</span></div>
|
|
<div class="line"><a name="l00586"></a><span class="lineno"> 586</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="l00587"></a><span class="lineno"> 587</span>  <span class="comment">// screw with the private/public access specifiers</span></div>
|
|
<div class="line"><a name="l00588"></a><span class="lineno"> 588</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_PIN_MODE);</div>
|
|
<div class="line"><a name="l00589"></a><span class="lineno"> 589</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DIGITAL_WRITE);</div>
|
|
<div class="line"><a name="l00590"></a><span class="lineno"> 590</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DIGITAL_READ);</div>
|
|
<div class="line"><a name="l00591"></a><span class="lineno"> 591</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_TONE);</div>
|
|
<div class="line"><a name="l00592"></a><span class="lineno"> 592</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_NO_TONE);</div>
|
|
<div class="line"><a name="l00593"></a><span class="lineno"> 593</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_ATTACH_INTERRUPT);</div>
|
|
<div class="line"><a name="l00594"></a><span class="lineno"> 594</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DETACH_INTERRUPT);</div>
|
|
<div class="line"><a name="l00595"></a><span class="lineno"> 595</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_YIELD);</div>
|
|
<div class="line"><a name="l00596"></a><span class="lineno"> 596</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DELAY);</div>
|
|
<div class="line"><a name="l00597"></a><span class="lineno"> 597</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_DELAY_MICROSECONDS);</div>
|
|
<div class="line"><a name="l00598"></a><span class="lineno"> 598</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_MILLIS);</div>
|
|
<div class="line"><a name="l00599"></a><span class="lineno"> 599</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_MICROS);</div>
|
|
<div class="line"><a name="l00600"></a><span class="lineno"> 600</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_PULSE_IN);</div>
|
|
<div class="line"><a name="l00601"></a><span class="lineno"> 601</span>  </div>
|
|
<div class="line"><a name="l00602"></a><span class="lineno"> 602</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00603"></a><span class="lineno"> 603</span>  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_BEGIN);</div>
|
|
<div class="line"><a name="l00604"></a><span class="lineno"> 604</span>  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_BEGIN_TRANSACTION);</div>
|
|
<div class="line"><a name="l00605"></a><span class="lineno"> 605</span>  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_TRANSFER);</div>
|
|
<div class="line"><a name="l00606"></a><span class="lineno"> 606</span>  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_END_TRANSACTION);</div>
|
|
<div class="line"><a name="l00607"></a><span class="lineno"> 607</span>  RADIOLIB_GENERATE_CALLBACK_SPI(RADIOLIB_CB_ARGS_SPI_END);</div>
|
|
<div class="line"><a name="l00608"></a><span class="lineno"> 608</span> <span class="preprocessor"> #else</span></div>
|
|
<div class="line"><a name="l00609"></a><span class="lineno"> 609</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_BEGIN);</div>
|
|
<div class="line"><a name="l00610"></a><span class="lineno"> 610</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_BEGIN_TRANSACTION);</div>
|
|
<div class="line"><a name="l00611"></a><span class="lineno"> 611</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_TRANSFER);</div>
|
|
<div class="line"><a name="l00612"></a><span class="lineno"> 612</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_END_TRANSACTION);</div>
|
|
<div class="line"><a name="l00613"></a><span class="lineno"> 613</span>  RADIOLIB_GENERATE_CALLBACK(RADIOLIB_CB_ARGS_SPI_END);</div>
|
|
<div class="line"><a name="l00614"></a><span class="lineno"> 614</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00615"></a><span class="lineno"> 615</span> };</div>
|
|
<div class="line"><a name="l00616"></a><span class="lineno"> 616</span>  </div>
|
|
<div class="line"><a name="l00617"></a><span class="lineno"> 617</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_a0c11551e12579bbabf57b19e12555b3c"><div class="ttname"><a href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">Module::RFSWITCH_MAX_PINS</a></div><div class="ttdeci">static const size_t RFSWITCH_MAX_PINS</div><div class="ttdoc">The maximum number of pins supported by the RF switch code.</div><div class="ttdef"><b>Definition:</b> Module.h:27</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 pins. This function gives RadioLib control over...</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_a4819e8b5e1fba0c99aa11477296e0927"><div class="ttname"><a href="class_module.html#a4819e8b5e1fba0c99aa11477296e0927">Module::END_OF_MODE_TABLE</a></div><div class="ttdeci">static constexpr RfSwitchMode_t END_OF_MODE_TABLE</div><div class="ttdef"><b>Definition:</b> Module.h:65</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_a5699a937b62ba41387567b4d679b9377"><div class="ttname"><a href="class_module.html#a5699a937b62ba41387567b4d679b9377">Module::findRfSwitchMode</a></div><div class="ttdeci">const RfSwitchMode_t * findRfSwitchMode(uint8_t mode) const</div><div class="ttdoc">Find a mode in the RfSwitchTable.</div><div class="ttdef"><b>Definition:</b> Module.cpp:575</div></div>
|
|
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bf"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bf">Module::OpMode_t</a></div><div class="ttdeci">OpMode_t</div><div class="ttdef"><b>Definition:</b> Module.h:46</div></div>
|
|
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571">Module::MODE_TX</a></div><div class="ttdeci">@ MODE_TX</div><div class="ttdef"><b>Definition:</b> Module.h:56</div></div>
|
|
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671">Module::MODE_IDLE</a></div><div class="ttdeci">@ MODE_IDLE</div><div class="ttdef"><b>Definition:</b> Module.h:52</div></div>
|
|
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f">Module::MODE_RX</a></div><div class="ttdeci">@ MODE_RX</div><div class="ttdef"><b>Definition:</b> Module.h:54</div></div>
|
|
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770">Module::MODE_END_OF_TABLE</a></div><div class="ttdeci">@ MODE_END_OF_TABLE</div><div class="ttdef"><b>Definition:</b> Module.h:50</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:135</div></div>
|
|
<div class="ttc" id="aclass_module_html_a870c63233146d03380f753498c975050"><div class="ttname"><a href="class_module.html#a870c63233146d03380f753498c975050">Module::setRfSwitchTable</a></div><div class="ttdeci">void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[])</div><div class="ttdoc">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...</div><div class="ttdef"><b>Definition:</b> Module.cpp:568</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:276</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:283</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:269</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:140</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:290</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 class="ttc" id="aclass_module_html_afbed643f082286012bf44bba22381ae6"><div class="ttname"><a href="class_module.html#afbed643f082286012bf44bba22381ae6">Module::setRfSwitchState</a></div><div class="ttdeci">void setRfSwitchState(uint8_t mode)</div><div class="ttdoc">Set RF switch state.</div><div class="ttdef"><b>Definition:</b> Module.cpp:585</div></div>
|
|
<div class="ttc" id="astruct_module_1_1_rf_switch_mode__t_html"><div class="ttname"><a href="struct_module_1_1_rf_switch_mode__t.html">Module::RfSwitchMode_t</a></div><div class="ttdef"><b>Definition:</b> Module.h:34</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>
|