forks/RadioLibSmol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
RadioLibSmol/_module_8h_source.html
jgromes 2338e94f76 Deploying to gh-pages from @ 56729041b3 🚀
2025-03-02 08:38:41 +00:00

364 lines
58 KiB
HTML
Raw Permalink Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<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 id="projectrow">
<td id="projectalign">
<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.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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 id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#if !defined(_RADIOLIB_MODULE_H)</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define _RADIOLIB_MODULE_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &quot;TypeDef.h&quot;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &quot;Hal.h&quot;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &quot;utils/Utils.h&quot;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor"> #include &lt;SPI.h&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#if defined(STM32WLxx)</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor"> #include &lt;SubGhz.h&gt;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#define END_OF_MODE_TABLE { Module::MODE_END_OF_TABLE, {} }</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#define RFSWITCH_PIN_FLAG (0x01UL &lt;&lt; 31)</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#define RADIOLIB_MODULE_SPI_COMMAND_READ (0)</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="preprocessor">#define RADIOLIB_MODULE_SPI_COMMAND_WRITE (1)</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="preprocessor">#define RADIOLIB_MODULE_SPI_COMMAND_NOP (2)</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="preprocessor">#define RADIOLIB_MODULE_SPI_COMMAND_STATUS (3)</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#define RADIOLIB_MODULE_SPI_WIDTH_ADDR (0)</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="preprocessor">#define RADIOLIB_MODULE_SPI_WIDTH_CMD (1)</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="preprocessor">#define RADIOLIB_MODULE_SPI_WIDTH_STATUS (2)</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="foldopen" id="foldopen00073" data-start="{" data-end="};">
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="class_module.html"> 73</a></span><span class="keyword">class </span><a class="code hl_class" href="class_module.html">Module</a> {</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c"> 82</a></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a> = 5;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="foldopen" id="foldopen00089" data-start="{" data-end="};">
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="struct_module_1_1_rf_switch_mode__t.html"> 89</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_module_1_1_rf_switch_mode__t.html">RfSwitchMode_t</a> {</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="struct_module_1_1_rf_switch_mode__t.html#a2442217bfabfb124a3f46bb128aa7462"> 91</a></span> uint8_t <a class="code hl_variable" href="struct_module_1_1_rf_switch_mode__t.html#a2442217bfabfb124a3f46bb128aa7462">mode</a>;</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="struct_module_1_1_rf_switch_mode__t.html#a694fecae172f868d8ca400319920ed66"> 94</a></span> uint32_t <a class="code hl_variable" href="struct_module_1_1_rf_switch_mode__t.html#a694fecae172f868d8ca400319920ed66">values</a>[<a class="code hl_variable" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a>];</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> };</div>
</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="foldopen" id="foldopen00105" data-start="{" data-end="};">
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bf"> 105</a></span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="class_module.html#a5a67b3a63420d762ecba9448671c99bf">OpMode_t</a> {</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770"> 110</a></span> <a class="code hl_enumvalue" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770">MODE_END_OF_TABLE</a> = 0,</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671"> 113</a></span> <a class="code hl_enumvalue" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671">MODE_IDLE</a>,</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f"> 116</a></span> <a class="code hl_enumvalue" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f">MODE_RX</a>,</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571"> 119</a></span> <a class="code hl_enumvalue" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571">MODE_TX</a>,</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> };</div>
</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> <a class="code hl_class" href="class_module.html">Module</a>(uint32_t cs, uint32_t irq, uint32_t rst, uint32_t gpio = RADIOLIB_NC);</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> </div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> <a class="code hl_class" href="class_module.html">Module</a>(uint32_t cs, uint32_t irq, uint32_t rst, uint32_t gpio, SPIClass&amp; spi, SPISettings spiSettings = RADIOLIB_DEFAULT_SPI_SETTINGS);</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span><span class="preprocessor"> #endif</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> <a class="code hl_class" href="class_module.html">Module</a>(<a class="code hl_class" href="class_radio_lib_hal.html">RadioLibHal</a> *<a class="code hl_variable" href="class_module.html#a4483f0a39a523dd1b37b467d81418f7d">hal</a>, uint32_t cs, uint32_t irq, uint32_t rst, uint32_t gpio = RADIOLIB_NC);</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> </div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> <a class="code hl_class" href="class_module.html">Module</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_module.html">Module</a>&amp; mod);</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> </div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> <a class="code hl_class" href="class_module.html">Module</a>&amp; <a class="code hl_function" href="class_module.html#a4ea888758b4a7784082d513a1e7849a4">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_module.html">Module</a>&amp; mod);</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> </div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> <span class="comment">// public member variables</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"><a class="line" href="class_module.html#a4483f0a39a523dd1b37b467d81418f7d"> 168</a></span> <a class="code hl_class" href="class_radio_lib_hal.html">RadioLibHal</a>* <a class="code hl_variable" href="class_module.html#a4483f0a39a523dd1b37b467d81418f7d">hal</a> = NULL;</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> </div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"><a class="line" href="class_module.html#a9393088249856eab568126aeb2493e4a"> 171</a></span> <span class="keyword">typedef</span> int16_t (*<a class="code hl_typedef" href="class_module.html#a9393088249856eab568126aeb2493e4a">SPIparseStatusCb_t</a>)(uint8_t in);</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> </div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"><a class="line" href="class_module.html#a1ad7bef7d380d3b6b88dca99bd35d640"> 174</a></span> <span class="keyword">typedef</span> int16_t (*<a class="code hl_typedef" href="class_module.html#a1ad7bef7d380d3b6b88dca99bd35d640">SPIcheckStatusCb_t</a>)(<a class="code hl_class" href="class_module.html">Module</a>* mod);</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> </div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> <span class="keyword">enum</span> BitWidth_t {</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> BITS_0 = 0,</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> BITS_8 = 8,</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> BITS_16 = 16,</div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> BITS_32 = 32,</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> };</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span> </div>
<div class="foldopen" id="foldopen00187" data-start="{" data-end="};">
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html"> 187</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_module_1_1_s_p_i_config__t.html">SPIConfig_t</a> {</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html#a1a088c02ed02361746621ffbc2526681"> 189</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="struct_module_1_1_s_p_i_config__t.html#a1a088c02ed02361746621ffbc2526681">stream</a>;</div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span> </div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html#ae11c030be96a72cd09fdfe9778ecdd51"> 192</a></span> int16_t <a class="code hl_variable" href="struct_module_1_1_s_p_i_config__t.html#ae11c030be96a72cd09fdfe9778ecdd51">err</a>;</div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span> </div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html#a57ecca17835380862426d3cf38561185"> 195</a></span> uint16_t <a class="code hl_variable" href="struct_module_1_1_s_p_i_config__t.html#a57ecca17835380862426d3cf38561185">cmds</a>[4];</div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span> </div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html#a8cd88af331563749f10ac69b63e1755a"> 198</a></span> BitWidth_t <a class="code hl_variable" href="struct_module_1_1_s_p_i_config__t.html#a8cd88af331563749f10ac69b63e1755a">widths</a>[3];</div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> </div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html#a5b689d2722b8980a211a562ed394d23e"> 201</a></span> uint8_t <a class="code hl_variable" href="struct_module_1_1_s_p_i_config__t.html#a5b689d2722b8980a211a562ed394d23e">statusPos</a>;</div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span> </div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html#a9619dcb8b269bcbd125e5a05e6c0fc77"> 204</a></span> <a class="code hl_typedef" href="class_module.html#a9393088249856eab568126aeb2493e4a">SPIparseStatusCb_t</a> <a class="code hl_variable" href="struct_module_1_1_s_p_i_config__t.html#a9619dcb8b269bcbd125e5a05e6c0fc77">parseStatusCb</a>;</div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span> </div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html#ac1e7f50d134ec054ed2074b846f1124e"> 207</a></span> <a class="code hl_typedef" href="class_module.html#a1ad7bef7d380d3b6b88dca99bd35d640">SPIcheckStatusCb_t</a> <a class="code hl_variable" href="struct_module_1_1_s_p_i_config__t.html#ac1e7f50d134ec054ed2074b846f1124e">checkStatusCb</a>;</div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span> </div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html#a56ecc0b9c1207d655c581e90faa77bb5"> 210</a></span> <a class="code hl_typedef" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> <a class="code hl_variable" href="struct_module_1_1_s_p_i_config__t.html#a56ecc0b9c1207d655c581e90faa77bb5">timeout</a>;</div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> };</div>
</div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> </div>
<div class="foldopen" id="foldopen00214" data-start="{" data-end="};">
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"><a class="line" href="class_module.html#a3a4fc4101fb3f134152b458c447b8ecb"> 214</a></span> <a class="code hl_struct" href="struct_module_1_1_s_p_i_config__t.html">SPIConfig_t</a> <a class="code hl_variable" href="class_module.html#a3a4fc4101fb3f134152b458c447b8ecb">spiConfig</a> = {</div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> .<a class="code hl_variable" href="struct_module_1_1_s_p_i_config__t.html#a1a088c02ed02361746621ffbc2526681">stream</a> = <span class="keyword">false</span>,</div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> .err = <a class="code hl_define" href="group__status__codes.html#gacc0baeb3e5fc99760a07d18ba55531b6">RADIOLIB_ERR_UNKNOWN</a>,</div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span> .cmds = { 0x00, 0x80, 0x00, 0x00 },</div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span> .widths = { Module::BITS_8, Module::BITS_0, Module::BITS_8 },</div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span> .statusPos = 0,</div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> .parseStatusCb = <span class="keyword">nullptr</span>,</div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> .checkStatusCb = <span class="keyword">nullptr</span>,</div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> .timeout = 1000,</div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> };</div>
</div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> </div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span><span class="preprocessor"> #if RADIOLIB_INTERRUPT_TIMING</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> </div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> <span class="keyword">typedef</span> void (*TimerSetupCb_t)(uint32_t len);</div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> </div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno"> 235</span> TimerSetupCb_t TimerSetupCb = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno"> 236</span> </div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"> 240</span> <span class="keyword">volatile</span> <span class="keywordtype">bool</span> TimerFlag = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno"> 241</span> </div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno"> 242</span><span class="preprocessor"> #endif</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno"> 243</span> </div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno"> 244</span> <span class="comment">// basic methods</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno"> 245</span> </div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno"> 249</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_module.html#ad1956ac81429ec1f61f83dbc081cf18c">init</a>();</div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno"> 250</span> </div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno"> 254</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_module.html#a45bd514a1f2859d9a867c8f9b13eb332">term</a>();</div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span> </div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno"> 256</span> <span class="comment">// SPI methods</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno"> 257</span> </div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno"> 265</span> int16_t <a class="code hl_function" href="class_module.html#a369e916626c821ecec85f25d5b46d752">SPIgetRegValue</a>(uint32_t reg, uint8_t msb = 7, uint8_t lsb = 0);</div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span> </div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno"> 278</span> int16_t <a class="code hl_function" href="class_module.html#aed95fba2ee72d7a2a21f98dd63ae4ad1">SPIsetRegValue</a>(uint32_t reg, uint8_t value, uint8_t msb = 7, uint8_t lsb = 0, uint8_t checkInterval = 2, uint8_t checkMask = 0xFF, <span class="keywordtype">bool</span> force = <span class="keyword">false</span>);</div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno"> 279</span> </div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno"> 286</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_module.html#ac993ab8e2ea0f5aa93339d1f6ffb54ee">SPIreadRegisterBurst</a>(uint32_t reg, <span class="keywordtype">size_t</span> numBytes, uint8_t* inBytes);</div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno"> 287</span> </div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno"> 293</span> uint8_t <a class="code hl_function" href="class_module.html#ab250eb929068e0c890e16e8e6d7cd7e6">SPIreadRegister</a>(uint32_t reg);</div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno"> 294</span> </div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno"> 301</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_module.html#a10809e942c686b4e605269e58bd637b9">SPIwriteRegisterBurst</a>(uint32_t reg, <span class="keyword">const</span> uint8_t* data, <span class="keywordtype">size_t</span> numBytes);</div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno"> 302</span> </div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno"> 308</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_module.html#a60ca6b4cae98f7d935191a569d519913">SPIwriteRegister</a>(uint32_t reg, uint8_t data);</div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno"> 309</span> </div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno"> 318</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_module.html#a2bfbddb1ff044f8b1865aac89246445d">SPItransfer</a>(uint16_t cmd, uint32_t reg, <span class="keyword">const</span> uint8_t* dataOut, uint8_t* dataIn, <span class="keywordtype">size_t</span> numBytes);</div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno"> 319</span> </div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno"> 324</span> int16_t <a class="code hl_function" href="class_module.html#a5efa7ae78cab1d7f43005e965923f769">SPIcheckStream</a>();</div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno"> 325</span> </div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno"> 335</span> int16_t <a class="code hl_function" href="class_module.html#adacceb57ecfecb09150c135b2b44436f">SPIreadStream</a>(uint16_t cmd, uint8_t* data, <span class="keywordtype">size_t</span> numBytes, <span class="keywordtype">bool</span> waitForGpio = <span class="keyword">true</span>, <span class="keywordtype">bool</span> verify = <span class="keyword">true</span>);</div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno"> 336</span> </div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno"> 347</span> int16_t <a class="code hl_function" href="class_module.html#adacceb57ecfecb09150c135b2b44436f">SPIreadStream</a>(<span class="keyword">const</span> uint8_t* cmd, uint8_t cmdLen, uint8_t* data, <span class="keywordtype">size_t</span> numBytes, <span class="keywordtype">bool</span> waitForGpio = <span class="keyword">true</span>, <span class="keywordtype">bool</span> verify = <span class="keyword">true</span>);</div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno"> 348</span> </div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno"> 358</span> int16_t <a class="code hl_function" href="class_module.html#a47e6e0c4e792a5ef7b3bb040947666a6">SPIwriteStream</a>(uint16_t cmd, <span class="keyword">const</span> uint8_t* data, <span class="keywordtype">size_t</span> numBytes, <span class="keywordtype">bool</span> waitForGpio = <span class="keyword">true</span>, <span class="keywordtype">bool</span> verify = <span class="keyword">true</span>);</div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno"> 359</span> </div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno"> 370</span> int16_t <a class="code hl_function" href="class_module.html#a47e6e0c4e792a5ef7b3bb040947666a6">SPIwriteStream</a>(<span class="keyword">const</span> uint8_t* cmd, uint8_t cmdLen, <span class="keyword">const</span> uint8_t* data, <span class="keywordtype">size_t</span> numBytes, <span class="keywordtype">bool</span> waitForGpio = <span class="keyword">true</span>, <span class="keywordtype">bool</span> verify = <span class="keyword">true</span>);</div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno"> 371</span> </div>
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno"> 383</span> int16_t <a class="code hl_function" href="class_module.html#a2b3f89fc63a82eb5fd55a7ddd72318fe">SPItransferStream</a>(<span class="keyword">const</span> uint8_t* cmd, uint8_t cmdLen, <span class="keywordtype">bool</span> write, <span class="keyword">const</span> uint8_t* dataOut, uint8_t* dataIn, <span class="keywordtype">size_t</span> numBytes, <span class="keywordtype">bool</span> waitForGpio);</div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno"> 384</span> </div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno"> 385</span> <span class="comment">// pin number access methods</span></div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno"> 386</span> <span class="comment">// getCs is omitted on purpose, as it can interfere when accessing the SPI in a concurrent environment</span></div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno"> 387</span> <span class="comment">// so it is considered to be part of the SPI pins and hence not accessible from outside</span></div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno"> 388</span> <span class="comment">// see https://github.com/jgromes/RadioLib/discussions/1364</span></div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno"> 389</span> </div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno"><a class="line" href="class_module.html#ab61bc5066c356e2d0d79f08a2bd0fbc9"> 394</a></span> uint32_t <a class="code hl_function" href="class_module.html#ab61bc5066c356e2d0d79f08a2bd0fbc9">getIrq</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(irqPin); }</div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno"> 395</span> </div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno"><a class="line" href="class_module.html#ad6cddbf3aebec9717a1a381dd81ad398"> 400</a></span> uint32_t <a class="code hl_function" href="class_module.html#ad6cddbf3aebec9717a1a381dd81ad398">getRst</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(rstPin); }</div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno"> 401</span> </div>
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno"><a class="line" href="class_module.html#a4ec27f0ba5e0009ea9661a5110526b52"> 406</a></span> uint32_t <a class="code hl_function" href="class_module.html#a4ec27f0ba5e0009ea9661a5110526b52">getGpio</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(gpioPin); }</div>
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno"> 407</span> </div>
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno"> 424</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_module.html#a7d3adea64acab11c47c804afc74bd4f3">setRfSwitchPins</a>(uint32_t rxEn, uint32_t txEn);</div>
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno"> 425</span> </div>
<div class="line"><a id="l00488" name="l00488"></a><span class="lineno"> 488</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_module.html#ac308fa817a5c36c5dc724a0d15cefd4d">setRfSwitchTable</a>(<span class="keyword">const</span> uint32_t (&amp;pins)[<a class="code hl_variable" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a>], <span class="keyword">const</span> RfSwitchMode_t table[]);</div>
<div class="line"><a id="l00489" name="l00489"></a><span class="lineno"> 489</span> </div>
<div class="line"><a id="l00497" name="l00497"></a><span class="lineno"> 497</span> <span class="keyword">const</span> RfSwitchMode_t *<a class="code hl_function" href="class_module.html#a5699a937b62ba41387567b4d679b9377">findRfSwitchMode</a>(uint8_t mode) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00498" name="l00498"></a><span class="lineno"> 498</span> </div>
<div class="line"><a id="l00503" name="l00503"></a><span class="lineno"> 503</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_module.html#afbed643f082286012bf44bba22381ae6">setRfSwitchState</a>(uint8_t mode);</div>
<div class="line"><a id="l00504" name="l00504"></a><span class="lineno"> 504</span> </div>
<div class="line"><a id="l00512" name="l00512"></a><span class="lineno"> 512</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_module.html#a7df4c687249c07af2594a5f7ad0a946f">waitForMicroseconds</a>(<a class="code hl_typedef" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> start, <a class="code hl_typedef" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> len);</div>
<div class="line"><a id="l00513" name="l00513"></a><span class="lineno"> 513</span> </div>
<div class="line"><a id="l00514" name="l00514"></a><span class="lineno"> 514</span><span class="preprocessor"> #if RADIOLIB_DEBUG</span></div>
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno"> 521</span> <span class="keywordtype">void</span> regdump(<span class="keyword">const</span> <span class="keywordtype">char</span>* level, uint16_t start, <span class="keywordtype">size_t</span> len);</div>
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno"> 522</span><span class="preprocessor"> #endif</span></div>
<div class="line"><a id="l00523" name="l00523"></a><span class="lineno"> 523</span> </div>
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno"> 524</span><span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno"> 525</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00526" name="l00526"></a><span class="lineno"> 526</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00527" name="l00527"></a><span class="lineno"> 527</span> uint32_t csPin = RADIOLIB_NC;</div>
<div class="line"><a id="l00528" name="l00528"></a><span class="lineno"> 528</span> uint32_t irqPin = RADIOLIB_NC;</div>
<div class="line"><a id="l00529" name="l00529"></a><span class="lineno"> 529</span> uint32_t rstPin = RADIOLIB_NC;</div>
<div class="line"><a id="l00530" name="l00530"></a><span class="lineno"> 530</span> uint32_t gpioPin = RADIOLIB_NC;</div>
<div class="line"><a id="l00531" name="l00531"></a><span class="lineno"> 531</span> </div>
<div class="line"><a id="l00532" name="l00532"></a><span class="lineno"> 532</span> <span class="comment">// RF switch pins and table</span></div>
<div class="line"><a id="l00533" name="l00533"></a><span class="lineno"> 533</span> uint32_t rfSwitchPins[<a class="code hl_variable" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a>] = { RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC };</div>
<div class="line"><a id="l00534" name="l00534"></a><span class="lineno"> 534</span> <span class="keyword">const</span> RfSwitchMode_t *rfSwitchTable = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00535" name="l00535"></a><span class="lineno"> 535</span> </div>
<div class="line"><a id="l00536" name="l00536"></a><span class="lineno"> 536</span><span class="preprocessor"> #if RADIOLIB_INTERRUPT_TIMING</span></div>
<div class="line"><a id="l00537" name="l00537"></a><span class="lineno"> 537</span> uint32_t prevTimingLen = 0;</div>
<div class="line"><a id="l00538" name="l00538"></a><span class="lineno"> 538</span><span class="preprocessor"> #endif</span></div>
<div class="line"><a id="l00539" name="l00539"></a><span class="lineno"> 539</span>};</div>
</div>
<div class="line"><a id="l00540" name="l00540"></a><span class="lineno"> 540</span> </div>
<div class="line"><a id="l00541" name="l00541"></a><span class="lineno"> 541</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:73</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. Note: It is not recommended to use this c...</div><div class="ttdef"><b>Definition</b> Module.h:82</div></div>
<div class="ttc" id="aclass_module_html_a10809e942c686b4e605269e58bd637b9"><div class="ttname"><a href="class_module.html#a10809e942c686b4e605269e58bd637b9">Module::SPIwriteRegisterBurst</a></div><div class="ttdeci">void SPIwriteRegisterBurst(uint32_t reg, const uint8_t *data, size_t numBytes)</div><div class="ttdoc">SPI burst write method.</div><div class="ttdef"><b>Definition</b> Module.cpp:145</div></div>
<div class="ttc" id="aclass_module_html_a1ad7bef7d380d3b6b88dca99bd35d640"><div class="ttname"><a href="class_module.html#a1ad7bef7d380d3b6b88dca99bd35d640">Module::SPIcheckStatusCb_t</a></div><div class="ttdeci">int16_t(* SPIcheckStatusCb_t)(Module *mod)</div><div class="ttdoc">Callback for validation SPI status.</div><div class="ttdef"><b>Definition</b> Module.h:174</div></div>
<div class="ttc" id="aclass_module_html_a2b3f89fc63a82eb5fd55a7ddd72318fe"><div class="ttname"><a href="class_module.html#a2b3f89fc63a82eb5fd55a7ddd72318fe">Module::SPItransferStream</a></div><div class="ttdeci">int16_t SPItransferStream(const uint8_t *cmd, uint8_t cmdLen, bool write, const uint8_t *dataOut, uint8_t *dataIn, size_t numBytes, bool waitForGpio)</div><div class="ttdoc">SPI single transfer method for modules with stream-type SPI interface (SX126x, SX128x etc....</div><div class="ttdef"><b>Definition</b> Module.cpp:318</div></div>
<div class="ttc" id="aclass_module_html_a2bfbddb1ff044f8b1865aac89246445d"><div class="ttname"><a href="class_module.html#a2bfbddb1ff044f8b1865aac89246445d">Module::SPItransfer</a></div><div class="ttdeci">void SPItransfer(uint16_t cmd, uint32_t reg, const uint8_t *dataOut, uint8_t *dataIn, size_t numBytes)</div><div class="ttdoc">SPI single transfer method.</div><div class="ttdef"><b>Definition</b> Module.cpp:177</div></div>
<div class="ttc" id="aclass_module_html_a369e916626c821ecec85f25d5b46d752"><div class="ttname"><a href="class_module.html#a369e916626c821ecec85f25d5b46d752">Module::SPIgetRegValue</a></div><div class="ttdeci">int16_t SPIgetRegValue(uint32_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:49</div></div>
<div class="ttc" id="aclass_module_html_a3a4fc4101fb3f134152b458c447b8ecb"><div class="ttname"><a href="class_module.html#a3a4fc4101fb3f134152b458c447b8ecb">Module::spiConfig</a></div><div class="ttdeci">SPIConfig_t spiConfig</div><div class="ttdoc">SPI configuration structure. The default configuration corresponds to register-access modules,...</div><div class="ttdef"><b>Definition</b> Module.h:214</div></div>
<div class="ttc" id="aclass_module_html_a4483f0a39a523dd1b37b467d81418f7d"><div class="ttname"><a href="class_module.html#a4483f0a39a523dd1b37b467d81418f7d">Module::hal</a></div><div class="ttdeci">RadioLibHal * hal</div><div class="ttdoc">Hardware abstraction layer to be used.</div><div class="ttdef"><b>Definition</b> Module.h:168</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:44</div></div>
<div class="ttc" id="aclass_module_html_a47e6e0c4e792a5ef7b3bb040947666a6"><div class="ttname"><a href="class_module.html#a47e6e0c4e792a5ef7b3bb040947666a6">Module::SPIwriteStream</a></div><div class="ttdeci">int16_t SPIwriteStream(uint16_t cmd, const uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)</div><div class="ttdoc">Method to perform a write transaction with SPI stream.</div><div class="ttdef"><b>Definition</b> Module.cpp:267</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 &amp; operator=(const Module &amp;mod)</div><div class="ttdoc">Overload for assignment operator.</div><div class="ttdef"><b>Definition</b> Module.cpp:27</div></div>
<div class="ttc" id="aclass_module_html_a4ec27f0ba5e0009ea9661a5110526b52"><div class="ttname"><a href="class_module.html#a4ec27f0ba5e0009ea9661a5110526b52">Module::getGpio</a></div><div class="ttdeci">uint32_t 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:406</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:512</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="ttdoc">Constants to use in a mode table set be setRfSwitchTable. These constants work for most radios,...</div><div class="ttdef"><b>Definition</b> Module.h:105</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="ttdoc">Transmission mode.</div><div class="ttdef"><b>Definition</b> Module.h:119</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="ttdoc">Idle mode.</div><div class="ttdef"><b>Definition</b> Module.h:113</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="ttdoc">Receive mode.</div><div class="ttdef"><b>Definition</b> Module.h:116</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="ttdoc">End of table marker, use END_OF_MODE_TABLE constant instead. Value is zero to ensure zero-initialized...</div><div class="ttdef"><b>Definition</b> Module.h:110</div></div>
<div class="ttc" id="aclass_module_html_a5efa7ae78cab1d7f43005e965923f769"><div class="ttname"><a href="class_module.html#a5efa7ae78cab1d7f43005e965923f769">Module::SPIcheckStream</a></div><div class="ttdeci">int16_t SPIcheckStream()</div><div class="ttdoc">Method to check the result of last SPI stream transfer.</div><div class="ttdef"><b>Definition</b> Module.cpp:295</div></div>
<div class="ttc" id="aclass_module_html_a60ca6b4cae98f7d935191a569d519913"><div class="ttname"><a href="class_module.html#a60ca6b4cae98f7d935191a569d519913">Module::SPIwriteRegister</a></div><div class="ttdeci">void SPIwriteRegister(uint32_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:161</div></div>
<div class="ttc" id="aclass_module_html_a7d3adea64acab11c47c804afc74bd4f3"><div class="ttname"><a href="class_module.html#a7d3adea64acab11c47c804afc74bd4f3">Module::setRfSwitchPins</a></div><div class="ttdeci">void setRfSwitchPins(uint32_t rxEn, uint32_t 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:488</div></div>
<div class="ttc" id="aclass_module_html_a7df4c687249c07af2594a5f7ad0a946f"><div class="ttname"><a href="class_module.html#a7df4c687249c07af2594a5f7ad0a946f">Module::waitForMicroseconds</a></div><div class="ttdeci">void waitForMicroseconds(RadioLibTime_t start, RadioLibTime_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:455</div></div>
<div class="ttc" id="aclass_module_html_a9393088249856eab568126aeb2493e4a"><div class="ttname"><a href="class_module.html#a9393088249856eab568126aeb2493e4a">Module::SPIparseStatusCb_t</a></div><div class="ttdeci">int16_t(* SPIparseStatusCb_t)(uint8_t in)</div><div class="ttdoc">Callback for parsing SPI status.</div><div class="ttdef"><b>Definition</b> Module.h:171</div></div>
<div class="ttc" id="aclass_module_html_ab250eb929068e0c890e16e8e6d7cd7e6"><div class="ttname"><a href="class_module.html#ab250eb929068e0c890e16e8e6d7cd7e6">Module::SPIreadRegister</a></div><div class="ttdeci">uint8_t SPIreadRegister(uint32_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:127</div></div>
<div class="ttc" id="aclass_module_html_ab61bc5066c356e2d0d79f08a2bd0fbc9"><div class="ttname"><a href="class_module.html#ab61bc5066c356e2d0d79f08a2bd0fbc9">Module::getIrq</a></div><div class="ttdeci">uint32_t 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:394</div></div>
<div class="ttc" id="aclass_module_html_ac308fa817a5c36c5dc724a0d15cefd4d"><div class="ttname"><a href="class_module.html#ac308fa817a5c36c5dc724a0d15cefd4d">Module::setRfSwitchTable</a></div><div class="ttdeci">void setRfSwitchTable(const uint32_t(&amp;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:504</div></div>
<div class="ttc" id="aclass_module_html_ac993ab8e2ea0f5aa93339d1f6ffb54ee"><div class="ttname"><a href="class_module.html#ac993ab8e2ea0f5aa93339d1f6ffb54ee">Module::SPIreadRegisterBurst</a></div><div class="ttdeci">void SPIreadRegisterBurst(uint32_t reg, size_t numBytes, uint8_t *inBytes)</div><div class="ttdoc">SPI burst read method.</div><div class="ttdef"><b>Definition</b> Module.cpp:111</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:37</div></div>
<div class="ttc" id="aclass_module_html_ad6cddbf3aebec9717a1a381dd81ad398"><div class="ttname"><a href="class_module.html#ad6cddbf3aebec9717a1a381dd81ad398">Module::getRst</a></div><div class="ttdeci">uint32_t 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:400</div></div>
<div class="ttc" id="aclass_module_html_adacceb57ecfecb09150c135b2b44436f"><div class="ttname"><a href="class_module.html#adacceb57ecfecb09150c135b2b44436f">Module::SPIreadStream</a></div><div class="ttdeci">int16_t SPIreadStream(uint16_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)</div><div class="ttdoc">Method to perform a read transaction with SPI stream.</div><div class="ttdef"><b>Definition</b> Module.cpp:239</div></div>
<div class="ttc" id="aclass_module_html_aed95fba2ee72d7a2a21f98dd63ae4ad1"><div class="ttname"><a href="class_module.html#aed95fba2ee72d7a2a21f98dd63ae4ad1">Module::SPIsetRegValue</a></div><div class="ttdeci">int16_t SPIsetRegValue(uint32_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF, bool force=false)</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:59</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:523</div></div>
<div class="ttc" id="aclass_radio_lib_hal_html"><div class="ttname"><a href="class_radio_lib_hal.html">RadioLibHal</a></div><div class="ttdoc">Hardware abstraction library base interface.</div><div class="ttdef"><b>Definition</b> Hal.h:16</div></div>
<div class="ttc" id="agroup__status__codes_html_gacc0baeb3e5fc99760a07d18ba55531b6"><div class="ttname"><a href="group__status__codes.html#gacc0baeb3e5fc99760a07d18ba55531b6">RADIOLIB_ERR_UNKNOWN</a></div><div class="ttdeci">#define RADIOLIB_ERR_UNKNOWN</div><div class="ttdoc">There was an unexpected, unknown error. If you see this, something went incredibly wrong....</div><div class="ttdef"><b>Definition</b> TypeDef.h:110</div></div>
<div class="ttc" id="agroup__typedefs_html_ga210f31dd2bff7fb80563275648a5bbbd"><div class="ttname"><a href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a></div><div class="ttdeci">unsigned long RadioLibTime_t</div><div class="ttdoc">Type used for durations in RadioLib.</div><div class="ttdef"><b>Definition</b> TypeDef.h:642</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="ttdoc">Description of RF switch pin states for a single mode. See setRfSwitchTable for details.</div><div class="ttdef"><b>Definition</b> Module.h:89</div></div>
<div class="ttc" id="astruct_module_1_1_rf_switch_mode__t_html_a2442217bfabfb124a3f46bb128aa7462"><div class="ttname"><a href="struct_module_1_1_rf_switch_mode__t.html#a2442217bfabfb124a3f46bb128aa7462">Module::RfSwitchMode_t::mode</a></div><div class="ttdeci">uint8_t mode</div><div class="ttdoc">RF switching mode, one of OpMode_t or a custom radio-defined value.</div><div class="ttdef"><b>Definition</b> Module.h:91</div></div>
<div class="ttc" id="astruct_module_1_1_rf_switch_mode__t_html_a694fecae172f868d8ca400319920ed66"><div class="ttname"><a href="struct_module_1_1_rf_switch_mode__t.html#a694fecae172f868d8ca400319920ed66">Module::RfSwitchMode_t::values</a></div><div class="ttdeci">uint32_t values[RFSWITCH_MAX_PINS]</div><div class="ttdoc">Output pin values.</div><div class="ttdef"><b>Definition</b> Module.h:94</div></div>
<div class="ttc" id="astruct_module_1_1_s_p_i_config__t_html"><div class="ttname"><a href="struct_module_1_1_s_p_i_config__t.html">Module::SPIConfig_t</a></div><div class="ttdoc">SPI configuration structure.</div><div class="ttdef"><b>Definition</b> Module.h:187</div></div>
<div class="ttc" id="astruct_module_1_1_s_p_i_config__t_html_a1a088c02ed02361746621ffbc2526681"><div class="ttname"><a href="struct_module_1_1_s_p_i_config__t.html#a1a088c02ed02361746621ffbc2526681">Module::SPIConfig_t::stream</a></div><div class="ttdeci">bool stream</div><div class="ttdoc">Whether the SPI module is stream-type (SX126x/8x) or registrer access type (SX127x,...</div><div class="ttdef"><b>Definition</b> Module.h:189</div></div>
<div class="ttc" id="astruct_module_1_1_s_p_i_config__t_html_a56ecc0b9c1207d655c581e90faa77bb5"><div class="ttname"><a href="struct_module_1_1_s_p_i_config__t.html#a56ecc0b9c1207d655c581e90faa77bb5">Module::SPIConfig_t::timeout</a></div><div class="ttdeci">RadioLibTime_t timeout</div><div class="ttdoc">Timeout in ms when waiting for GPIO signals.</div><div class="ttdef"><b>Definition</b> Module.h:210</div></div>
<div class="ttc" id="astruct_module_1_1_s_p_i_config__t_html_a57ecca17835380862426d3cf38561185"><div class="ttname"><a href="struct_module_1_1_s_p_i_config__t.html#a57ecca17835380862426d3cf38561185">Module::SPIConfig_t::cmds</a></div><div class="ttdeci">uint16_t cmds[4]</div><div class="ttdoc">SPI commands.</div><div class="ttdef"><b>Definition</b> Module.h:195</div></div>
<div class="ttc" id="astruct_module_1_1_s_p_i_config__t_html_a5b689d2722b8980a211a562ed394d23e"><div class="ttname"><a href="struct_module_1_1_s_p_i_config__t.html#a5b689d2722b8980a211a562ed394d23e">Module::SPIConfig_t::statusPos</a></div><div class="ttdeci">uint8_t statusPos</div><div class="ttdoc">Byte position of status command in SPI stream.</div><div class="ttdef"><b>Definition</b> Module.h:201</div></div>
<div class="ttc" id="astruct_module_1_1_s_p_i_config__t_html_a8cd88af331563749f10ac69b63e1755a"><div class="ttname"><a href="struct_module_1_1_s_p_i_config__t.html#a8cd88af331563749f10ac69b63e1755a">Module::SPIConfig_t::widths</a></div><div class="ttdeci">BitWidth_t widths[3]</div><div class="ttdoc">Bit widths of SPI addresses, commands and status bytes.</div><div class="ttdef"><b>Definition</b> Module.h:198</div></div>
<div class="ttc" id="astruct_module_1_1_s_p_i_config__t_html_a9619dcb8b269bcbd125e5a05e6c0fc77"><div class="ttname"><a href="struct_module_1_1_s_p_i_config__t.html#a9619dcb8b269bcbd125e5a05e6c0fc77">Module::SPIConfig_t::parseStatusCb</a></div><div class="ttdeci">SPIparseStatusCb_t parseStatusCb</div><div class="ttdoc">Callback for parsing SPI status.</div><div class="ttdef"><b>Definition</b> Module.h:204</div></div>
<div class="ttc" id="astruct_module_1_1_s_p_i_config__t_html_ac1e7f50d134ec054ed2074b846f1124e"><div class="ttname"><a href="struct_module_1_1_s_p_i_config__t.html#ac1e7f50d134ec054ed2074b846f1124e">Module::SPIConfig_t::checkStatusCb</a></div><div class="ttdeci">SPIcheckStatusCb_t checkStatusCb</div><div class="ttdoc">Callback for validation SPI status.</div><div class="ttdef"><b>Definition</b> Module.h:207</div></div>
<div class="ttc" id="astruct_module_1_1_s_p_i_config__t_html_ae11c030be96a72cd09fdfe9778ecdd51"><div class="ttname"><a href="struct_module_1_1_s_p_i_config__t.html#ae11c030be96a72cd09fdfe9778ecdd51">Module::SPIConfig_t::err</a></div><div class="ttdeci">int16_t err</div><div class="ttdoc">Last recorded SPI error - only updated for modules that return status during SPI transfers.</div><div class="ttdef"><b>Definition</b> Module.h:192</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.8 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink