341 lines
56 KiB
HTML
341 lines
56 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> <span class="preprocessor">#include "Hal.h"</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include "utils/Utils.h"</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  </div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor"> #include <SPI.h></span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#if defined(STM32WLxx)</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor"> #include <SubGhz.h></span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  </div>
|
|
<div class="line"><a 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 name="l00021"></a><span class="lineno"> 21</span>  </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#define RADIOLIB_MODULE_SPI_COMMAND_READ (0)</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#define RADIOLIB_MODULE_SPI_COMMAND_WRITE (1)</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#define RADIOLIB_MODULE_SPI_COMMAND_NOP (2)</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#define RADIOLIB_MODULE_SPI_COMMAND_STATUS (3)</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#define RADIOLIB_MODULE_SPI_WIDTH_ADDR (0)</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#define RADIOLIB_MODULE_SPI_WIDTH_CMD (1)</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#define RADIOLIB_MODULE_SPI_WIDTH_STATUS (2)</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="class_module.html"> 66</a></span> <span class="keyword">class </span><a class="code" href="class_module.html">Module</a> {</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c"> 75</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> = 5;</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="struct_module_1_1_rf_switch_mode__t.html"> 82</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="l00084"></a><span class="lineno"><a class="line" href="struct_module_1_1_rf_switch_mode__t.html#a2442217bfabfb124a3f46bb128aa7462"> 84</a></span>  uint8_t <a class="code" href="struct_module_1_1_rf_switch_mode__t.html#a2442217bfabfb124a3f46bb128aa7462">mode</a>;</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="struct_module_1_1_rf_switch_mode__t.html#a694fecae172f868d8ca400319920ed66"> 87</a></span>  uint32_t <a class="code" href="struct_module_1_1_rf_switch_mode__t.html#a694fecae172f868d8ca400319920ed66">values</a>[<a class="code" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a>];</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  };</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bf"> 98</a></span>  <span class="keyword">enum</span> <a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bf">OpMode_t</a> {</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770"> 103</a></span>  <a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770">MODE_END_OF_TABLE</a> = 0,</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  </div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671"> 106</a></span>  <a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671">MODE_IDLE</a>,</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f"> 109</a></span>  <a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f">MODE_RX</a>,</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  </div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571"> 112</a></span>  <a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571">MODE_TX</a>,</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>  </div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <a class="code" href="class_module.html#a817178405f125e068e88bad62aeb6f3b">Module</a>(uint32_t cs, uint32_t irq, uint32_t rst, uint32_t gpio = RADIOLIB_NC);</div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  </div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <a class="code" href="class_module.html#a817178405f125e068e88bad62aeb6f3b">Module</a>(uint32_t cs, uint32_t irq, uint32_t rst, uint32_t gpio, SPIClass& spi, SPISettings spiSettings = RADIOLIB_DEFAULT_SPI_SETTINGS);</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  </div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <a class="code" href="class_module.html#a817178405f125e068e88bad62aeb6f3b">Module</a>(<a class="code" href="class_radio_lib_hal.html">RadioLibHal</a> *<a class="code" 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 name="l00146"></a><span class="lineno"> 146</span>  </div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <a class="code" href="class_module.html#a817178405f125e068e88bad62aeb6f3b">Module</a>(<span class="keyword">const</span> <a class="code" href="class_module.html">Module</a>& mod);</div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  </div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</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="l00158"></a><span class="lineno"> 158</span>  </div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="comment">// public member variables</span></div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"><a class="line" href="class_module.html#a4483f0a39a523dd1b37b467d81418f7d"> 161</a></span> <span class="comment"></span> <a class="code" href="class_radio_lib_hal.html">RadioLibHal</a>* <a class="code" href="class_module.html#a4483f0a39a523dd1b37b467d81418f7d">hal</a> = NULL;</div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  </div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"><a class="line" href="class_module.html#a9393088249856eab568126aeb2493e4a"> 164</a></span>  <span class="keyword">typedef</span> int16_t (*<a class="code" href="class_module.html#a9393088249856eab568126aeb2493e4a">SPIparseStatusCb_t</a>)(uint8_t in);</div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  </div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"><a class="line" href="class_module.html#a1ad7bef7d380d3b6b88dca99bd35d640"> 167</a></span>  <span class="keyword">typedef</span> int16_t (*<a class="code" href="class_module.html#a1ad7bef7d380d3b6b88dca99bd35d640">SPIcheckStatusCb_t</a>)(<a class="code" href="class_module.html">Module</a>* mod);</div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  </div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keyword">enum</span> BitWidth_t {</div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  BITS_0 = 0,</div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  BITS_8 = 8,</div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  BITS_16 = 16,</div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  BITS_32 = 32,</div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  };</div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  </div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html"> 180</a></span>  <span class="keyword">struct </span><a class="code" href="struct_module_1_1_s_p_i_config__t.html">SPIConfig_t</a> {</div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html#a1a088c02ed02361746621ffbc2526681"> 182</a></span>  <span class="keywordtype">bool</span> <a class="code" href="struct_module_1_1_s_p_i_config__t.html#a1a088c02ed02361746621ffbc2526681">stream</a>;</div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  </div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html#ae11c030be96a72cd09fdfe9778ecdd51"> 185</a></span>  int16_t <a class="code" href="struct_module_1_1_s_p_i_config__t.html#ae11c030be96a72cd09fdfe9778ecdd51">err</a>;</div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  </div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html#a57ecca17835380862426d3cf38561185"> 188</a></span>  uint16_t <a class="code" href="struct_module_1_1_s_p_i_config__t.html#a57ecca17835380862426d3cf38561185">cmds</a>[4];</div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  </div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html#a8cd88af331563749f10ac69b63e1755a"> 191</a></span>  BitWidth_t <a class="code" href="struct_module_1_1_s_p_i_config__t.html#a8cd88af331563749f10ac69b63e1755a">widths</a>[3];</div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  </div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html#a5b689d2722b8980a211a562ed394d23e"> 194</a></span>  uint8_t <a class="code" href="struct_module_1_1_s_p_i_config__t.html#a5b689d2722b8980a211a562ed394d23e">statusPos</a>;</div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  </div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html#a9619dcb8b269bcbd125e5a05e6c0fc77"> 197</a></span>  <a class="code" href="class_module.html#a9393088249856eab568126aeb2493e4a">SPIparseStatusCb_t</a> <a class="code" href="struct_module_1_1_s_p_i_config__t.html#a9619dcb8b269bcbd125e5a05e6c0fc77">parseStatusCb</a>;</div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  </div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html#ac1e7f50d134ec054ed2074b846f1124e"> 200</a></span>  <a class="code" href="class_module.html#a1ad7bef7d380d3b6b88dca99bd35d640">SPIcheckStatusCb_t</a> <a class="code" href="struct_module_1_1_s_p_i_config__t.html#ac1e7f50d134ec054ed2074b846f1124e">checkStatusCb</a>;</div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  </div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"><a class="line" href="struct_module_1_1_s_p_i_config__t.html#a56ecc0b9c1207d655c581e90faa77bb5"> 203</a></span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> <a class="code" href="struct_module_1_1_s_p_i_config__t.html#a56ecc0b9c1207d655c581e90faa77bb5">timeout</a>;</div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  };</div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  </div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"><a class="line" href="class_module.html#a3a4fc4101fb3f134152b458c447b8ecb"> 207</a></span>  <a class="code" href="struct_module_1_1_s_p_i_config__t.html">SPIConfig_t</a> <a class="code" href="class_module.html#a3a4fc4101fb3f134152b458c447b8ecb">spiConfig</a> = {</div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  .<a class="code" href="struct_module_1_1_s_p_i_config__t.html#a1a088c02ed02361746621ffbc2526681">stream</a> = <span class="keyword">false</span>,</div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  .err = <a class="code" href="group__status__codes.html#gacc0baeb3e5fc99760a07d18ba55531b6">RADIOLIB_ERR_UNKNOWN</a>,</div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  .cmds = { 0x00, 0x80, 0x00, 0x00 },</div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  .widths = { Module::BITS_8, Module::BITS_0, Module::BITS_8 },</div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  .statusPos = 0,</div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  .parseStatusCb = <span class="keyword">nullptr</span>,</div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  .checkStatusCb = <span class="keyword">nullptr</span>,</div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  .timeout = 1000,</div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  };</div>
|
|
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  </div>
|
|
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="preprocessor"> #if RADIOLIB_INTERRUPT_TIMING</span></div>
|
|
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  </div>
|
|
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <span class="keyword">typedef</span> void (*TimerSetupCb_t)(uint32_t len);</div>
|
|
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  </div>
|
|
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  TimerSetupCb_t TimerSetupCb = <span class="keyword">nullptr</span>;</div>
|
|
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  </div>
|
|
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="keyword">volatile</span> <span class="keywordtype">bool</span> TimerFlag = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  </div>
|
|
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  </div>
|
|
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  <span class="comment">// basic methods</span></div>
|
|
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  </div>
|
|
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#ad1956ac81429ec1f61f83dbc081cf18c">init</a>();</div>
|
|
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  </div>
|
|
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a45bd514a1f2859d9a867c8f9b13eb332">term</a>();</div>
|
|
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  </div>
|
|
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  <span class="comment">// SPI methods</span></div>
|
|
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  </div>
|
|
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  int16_t <a class="code" href="class_module.html#a369e916626c821ecec85f25d5b46d752">SPIgetRegValue</a>(uint32_t reg, uint8_t msb = 7, uint8_t lsb = 0);</div>
|
|
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  </div>
|
|
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  int16_t <a class="code" href="class_module.html#ade75c5403a05156b43cc7562563ae2d7">SPIsetRegValue</a>(uint32_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="l00271"></a><span class="lineno"> 271</span>  </div>
|
|
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  <span class="keywordtype">void</span> <a class="code" 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 name="l00279"></a><span class="lineno"> 279</span>  </div>
|
|
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  uint8_t <a class="code" href="class_module.html#ab250eb929068e0c890e16e8e6d7cd7e6">SPIreadRegister</a>(uint32_t reg);</div>
|
|
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  </div>
|
|
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a2826f0fa116eb0a4dd18ddb9b21e4caf">SPIwriteRegisterBurst</a>(uint32_t reg, uint8_t* data, <span class="keywordtype">size_t</span> numBytes);</div>
|
|
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  </div>
|
|
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a60ca6b4cae98f7d935191a569d519913">SPIwriteRegister</a>(uint32_t reg, uint8_t data);</div>
|
|
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  </div>
|
|
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#aa6df70520aa015dd3a1bccdceae67232">SPItransfer</a>(uint16_t cmd, uint32_t reg, uint8_t* dataOut, uint8_t* dataIn, <span class="keywordtype">size_t</span> numBytes);</div>
|
|
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span>  </div>
|
|
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  int16_t <a class="code" href="class_module.html#a5efa7ae78cab1d7f43005e965923f769">SPIcheckStream</a>();</div>
|
|
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  </div>
|
|
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  int16_t <a class="code" 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 name="l00328"></a><span class="lineno"> 328</span>  </div>
|
|
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span>  int16_t <a class="code" href="class_module.html#adacceb57ecfecb09150c135b2b44436f">SPIreadStream</a>(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 name="l00340"></a><span class="lineno"> 340</span>  </div>
|
|
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span>  int16_t <a class="code" href="class_module.html#af99b0e74e67417a88f500ab7261ddd20">SPIwriteStream</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 name="l00351"></a><span class="lineno"> 351</span>  </div>
|
|
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span>  int16_t <a class="code" href="class_module.html#af99b0e74e67417a88f500ab7261ddd20">SPIwriteStream</a>(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 name="l00363"></a><span class="lineno"> 363</span>  </div>
|
|
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span>  int16_t <a class="code" href="class_module.html#a4174159e476de5cef6ea3f89c883cb5e">SPItransferStream</a>(<span class="keyword">const</span> uint8_t* cmd, uint8_t cmdLen, <span class="keywordtype">bool</span> write, uint8_t* dataOut, uint8_t* dataIn, <span class="keywordtype">size_t</span> numBytes, <span class="keywordtype">bool</span> waitForGpio);</div>
|
|
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span>  </div>
|
|
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span>  <span class="comment">// pin number access methods</span></div>
|
|
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span>  </div>
|
|
<div class="line"><a name="l00383"></a><span class="lineno"><a class="line" href="class_module.html#aa6cac04c7cb6d5278a318db0966ad1a7"> 383</a></span>  uint32_t <a class="code" href="class_module.html#aa6cac04c7cb6d5278a318db0966ad1a7">getCs</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(csPin); }</div>
|
|
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  </div>
|
|
<div class="line"><a name="l00389"></a><span class="lineno"><a class="line" href="class_module.html#ab61bc5066c356e2d0d79f08a2bd0fbc9"> 389</a></span>  uint32_t <a class="code" href="class_module.html#ab61bc5066c356e2d0d79f08a2bd0fbc9">getIrq</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(irqPin); }</div>
|
|
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span>  </div>
|
|
<div class="line"><a name="l00395"></a><span class="lineno"><a class="line" href="class_module.html#ad6cddbf3aebec9717a1a381dd81ad398"> 395</a></span>  uint32_t <a class="code" href="class_module.html#ad6cddbf3aebec9717a1a381dd81ad398">getRst</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(rstPin); }</div>
|
|
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span>  </div>
|
|
<div class="line"><a name="l00401"></a><span class="lineno"><a class="line" href="class_module.html#a4ec27f0ba5e0009ea9661a5110526b52"> 401</a></span>  uint32_t <a class="code" href="class_module.html#a4ec27f0ba5e0009ea9661a5110526b52">getGpio</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(gpioPin); }</div>
|
|
<div class="line"><a name="l00402"></a><span class="lineno"> 402</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#a7d3adea64acab11c47c804afc74bd4f3">setRfSwitchPins</a>(uint32_t rxEn, uint32_t txEn);</div>
|
|
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span>  </div>
|
|
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#ac308fa817a5c36c5dc724a0d15cefd4d">setRfSwitchTable</a>(<span class="keyword">const</span> uint32_t (&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="l00484"></a><span class="lineno"> 484</span>  </div>
|
|
<div class="line"><a name="l00492"></a><span class="lineno"> 492</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="l00493"></a><span class="lineno"> 493</span>  </div>
|
|
<div class="line"><a name="l00498"></a><span class="lineno"> 498</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="l00499"></a><span class="lineno"> 499</span>  </div>
|
|
<div class="line"><a name="l00507"></a><span class="lineno"> 507</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a7df4c687249c07af2594a5f7ad0a946f">waitForMicroseconds</a>(<a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> start, <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> len);</div>
|
|
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span>  </div>
|
|
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span> <span class="preprocessor"> #if RADIOLIB_DEBUG</span></div>
|
|
<div class="line"><a name="l00516"></a><span class="lineno"> 516</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 name="l00517"></a><span class="lineno"> 517</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span>  </div>
|
|
<div class="line"><a name="l00519"></a><span class="lineno"> 519</span> <span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
|
|
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00522"></a><span class="lineno"> 522</span>  uint32_t csPin = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00523"></a><span class="lineno"> 523</span>  uint32_t irqPin = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00524"></a><span class="lineno"> 524</span>  uint32_t rstPin = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00525"></a><span class="lineno"> 525</span>  uint32_t gpioPin = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span>  </div>
|
|
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span>  <span class="comment">// RF switch pins and table</span></div>
|
|
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span>  uint32_t rfSwitchPins[<a class="code" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a>] = { RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC };</div>
|
|
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span>  <span class="keyword">const</span> RfSwitchMode_t *rfSwitchTable = <span class="keyword">nullptr</span>;</div>
|
|
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span>  </div>
|
|
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span> <span class="preprocessor"> #if RADIOLIB_INTERRUPT_TIMING</span></div>
|
|
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span>  uint32_t prevTimingLen = 0;</div>
|
|
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00534"></a><span class="lineno"> 534</span> };</div>
|
|
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span>  </div>
|
|
<div class="line"><a name="l00536"></a><span class="lineno"> 536</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:66</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:75</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:167</div></div>
|
|
<div class="ttc" id="aclass_module_html_a2826f0fa116eb0a4dd18ddb9b21e4caf"><div class="ttname"><a href="class_module.html#a2826f0fa116eb0a4dd18ddb9b21e4caf">Module::SPIwriteRegisterBurst</a></div><div class="ttdeci">void SPIwriteRegisterBurst(uint32_t reg, uint8_t *data, size_t numBytes)</div><div class="ttdoc">SPI burst write method.</div><div class="ttdef"><b>Definition:</b> Module.cpp:137</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:207</div></div>
|
|
<div class="ttc" id="aclass_module_html_a4174159e476de5cef6ea3f89c883cb5e"><div class="ttname"><a href="class_module.html#a4174159e476de5cef6ea3f89c883cb5e">Module::SPItransferStream</a></div><div class="ttdeci">int16_t SPItransferStream(const uint8_t *cmd, uint8_t cmdLen, bool write, 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:310</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:161</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_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: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:401</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:496</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:98</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:112</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:106</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:109</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:103</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:287</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:153</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:473</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:440</div></div>
|
|
<div class="ttc" id="aclass_module_html_a817178405f125e068e88bad62aeb6f3b"><div class="ttname"><a href="class_module.html#a817178405f125e068e88bad62aeb6f3b">Module::Module</a></div><div class="ttdeci">Module(RadioLibHal *hal, uint32_t cs, uint32_t irq, uint32_t rst, uint32_t gpio=RADIOLIB_NC)</div><div class="ttdoc">Module constructor.</div><div class="ttdef"><b>Definition:</b> Module.cpp:19</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:164</div></div>
|
|
<div class="ttc" id="aclass_module_html_aa6cac04c7cb6d5278a318db0966ad1a7"><div class="ttname"><a href="class_module.html#aa6cac04c7cb6d5278a318db0966ad1a7">Module::getCs</a></div><div class="ttdeci">uint32_t 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:383</div></div>
|
|
<div class="ttc" id="aclass_module_html_aa6df70520aa015dd3a1bccdceae67232"><div class="ttname"><a href="class_module.html#aa6df70520aa015dd3a1bccdceae67232">Module::SPItransfer</a></div><div class="ttdeci">void SPItransfer(uint16_t cmd, uint32_t reg, 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:169</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:119</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:389</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(&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:489</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:103</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:395</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:231</div></div>
|
|
<div class="ttc" id="aclass_module_html_ade75c5403a05156b43cc7562563ae2d7"><div class="ttname"><a href="class_module.html#ade75c5403a05156b43cc7562563ae2d7">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)</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_af99b0e74e67417a88f500ab7261ddd20"><div class="ttname"><a href="class_module.html#af99b0e74e67417a88f500ab7261ddd20">Module::SPIwriteStream</a></div><div class="ttdeci">int16_t SPIwriteStream(uint16_t cmd, 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:259</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:506</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:13</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:82</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:84</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:87</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:180</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:182</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:203</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:188</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:194</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:191</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:197</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:200</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:185</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>
|