306 lines
50 KiB
HTML
306 lines
50 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: src/Module.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">RadioLib
|
|
</div>
|
|
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('_module_8h_source.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Module.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#if !defined(_RADIOLIB_MODULE_H)</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_MODULE_H</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "TypeDef.h"</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include "Hal.h"</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor"> #include <SPI.h></span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#if defined(STM32WLxx)</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"> #include <SubGhz.h></span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define END_OF_MODE_TABLE { Module::MODE_END_OF_TABLE, {} }</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="class_module.html"> 28</a></span> <span class="keyword">class </span><a class="code" href="class_module.html">Module</a> {</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c"> 39</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a> = 3;</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="struct_module_1_1_rf_switch_mode__t.html"> 46</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="l00047"></a><span class="lineno"> 47</span>  uint8_t mode;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  uint32_t values[<a class="code" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a>];</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  };</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bf"> 58</a></span>  <span class="keyword">enum</span> <a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bf">OpMode_t</a> {</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770"> 62</a></span>  <a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770">MODE_END_OF_TABLE</a> = 0,</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671"> 64</a></span>  <a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671">MODE_IDLE</a>,</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f"> 66</a></span>  <a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f">MODE_RX</a>,</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571"> 68</a></span>  <a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571">MODE_TX</a>,</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  };</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</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="l00080"></a><span class="lineno"> 80</span>  </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</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="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</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="l00102"></a><span class="lineno"> 102</span>  </div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</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="l00108"></a><span class="lineno"> 108</span>  </div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</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="l00114"></a><span class="lineno"> 114</span>  </div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="comment">// public member variables</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="class_module.html#a4483f0a39a523dd1b37b467d81418f7d"> 119</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="l00120"></a><span class="lineno"> 120</span>  </div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"><a class="line" href="class_module.html#a849ad85fc1bc3a7130e660c13973ab26"> 124</a></span>  uint8_t <a class="code" href="class_module.html#a849ad85fc1bc3a7130e660c13973ab26">SPIreadCommand</a> = 0b00000000;</div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  </div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"><a class="line" href="class_module.html#ae89764d15e8df5694a6aec0e18f72d3f"> 129</a></span>  uint8_t <a class="code" href="class_module.html#ae89764d15e8df5694a6aec0e18f72d3f">SPIwriteCommand</a> = 0b10000000;</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  </div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"><a class="line" href="class_module.html#a466112286d19675ca2dbe481358e4365"> 134</a></span>  uint8_t <a class="code" href="class_module.html#a466112286d19675ca2dbe481358e4365">SPInopCommand</a> = 0x00;</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  </div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"><a class="line" href="class_module.html#a06d8d4257c584b57a529fcc405d87c79"> 139</a></span>  uint8_t <a class="code" href="class_module.html#a06d8d4257c584b57a529fcc405d87c79">SPIstatusCommand</a> = 0x00;</div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  </div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="class_module.html#ac19a495026aae62f5c2f089aa1b2b57a"> 144</a></span>  uint8_t <a class="code" href="class_module.html#ac19a495026aae62f5c2f089aa1b2b57a">SPIaddrWidth</a> = 8;</div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  </div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"><a class="line" href="class_module.html#a34927454be3a34df8a5a586c46c428af"> 150</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_module.html#a34927454be3a34df8a5a586c46c428af">SPIstreamType</a> = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  </div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"><a class="line" href="class_module.html#a66b06e69d57b97116bed1c6f185381f1"> 155</a></span>  int16_t <a class="code" href="class_module.html#a66b06e69d57b97116bed1c6f185381f1">SPIstreamError</a> = <a class="code" href="group__status__codes.html#gacc0baeb3e5fc99760a07d18ba55531b6">RADIOLIB_ERR_UNKNOWN</a>;</div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  </div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="class_module.html#a9393088249856eab568126aeb2493e4a"> 160</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="l00161"></a><span class="lineno"> 161</span>  </div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"><a class="line" href="class_module.html#af6e89e2bc4976e8c5dc42dedda9fa6a2"> 166</a></span>  <a class="code" href="class_module.html#a9393088249856eab568126aeb2493e4a">SPIparseStatusCb_t</a> <a class="code" href="class_module.html#af6e89e2bc4976e8c5dc42dedda9fa6a2">SPIparseStatusCb</a> = <span class="keyword">nullptr</span>;</div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  </div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="preprocessor"> #if defined(RADIOLIB_INTERRUPT_TIMING)</span></div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  </div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="keyword">typedef</span> void (*TimerSetupCb_t)(uint32_t len);</div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  </div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  TimerSetupCb_t TimerSetupCb = <span class="keyword">nullptr</span>;</div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  </div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keyword">volatile</span> <span class="keywordtype">bool</span> TimerFlag = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  </div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  </div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="comment">// basic methods</span></div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  </div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#ad1956ac81429ec1f61f83dbc081cf18c">init</a>();</div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  </div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a45bd514a1f2859d9a867c8f9b13eb332">term</a>();</div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  </div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <span class="comment">// SPI methods</span></div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  </div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  int16_t <a class="code" href="class_module.html#a01e15988ec448c76142ee5709929be2c">SPIgetRegValue</a>(uint16_t reg, uint8_t msb = 7, uint8_t lsb = 0);</div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  </div>
|
|
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  int16_t <a class="code" href="class_module.html#a081191402ad5c49e6c21982fc4587b77">SPIsetRegValue</a>(uint16_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="l00221"></a><span class="lineno"> 221</span>  </div>
|
|
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a874e030f1931e606e380930d37dd83ee">SPIreadRegisterBurst</a>(uint16_t reg, <span class="keywordtype">size_t</span> numBytes, uint8_t* inBytes);</div>
|
|
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  </div>
|
|
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  uint8_t <a class="code" href="class_module.html#a9a545e4a001da0d9f6358279ac40d4f0">SPIreadRegister</a>(uint16_t reg);</div>
|
|
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  </div>
|
|
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#af474f82d00fffc1ee0fc8def2c7f220c">SPIwriteRegisterBurst</a>(uint16_t reg, uint8_t* data, <span class="keywordtype">size_t</span> numBytes);</div>
|
|
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  </div>
|
|
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a4437af6552e258e95ed8ed452afa6dd4">SPIwriteRegister</a>(uint16_t reg, uint8_t data);</div>
|
|
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  </div>
|
|
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a78dd39aa71d97e2220a880df8162fdde">SPItransfer</a>(uint8_t cmd, uint16_t reg, uint8_t* dataOut, uint8_t* dataIn, <span class="keywordtype">size_t</span> numBytes);</div>
|
|
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  </div>
|
|
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  int16_t <a class="code" href="class_module.html#a5efa7ae78cab1d7f43005e965923f769">SPIcheckStream</a>();</div>
|
|
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  </div>
|
|
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  int16_t <a class="code" href="class_module.html#ab9fc874adc8dbe7c3f1fd3c267c27708">SPIreadStream</a>(uint8_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="l00278"></a><span class="lineno"> 278</span>  </div>
|
|
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  int16_t <a class="code" href="class_module.html#ab9fc874adc8dbe7c3f1fd3c267c27708">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="l00290"></a><span class="lineno"> 290</span>  </div>
|
|
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  int16_t <a class="code" href="class_module.html#a74ce586afa403130007a474d3295d762">SPIwriteStream</a>(uint8_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="l00301"></a><span class="lineno"> 301</span>  </div>
|
|
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  int16_t <a class="code" href="class_module.html#a74ce586afa403130007a474d3295d762">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="l00313"></a><span class="lineno"> 313</span>  </div>
|
|
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span>  int16_t <a class="code" href="class_module.html#ac3586c8d4013cbdd22cf34032632c181">SPItransferStream</a>(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, uint32_t timeout);</div>
|
|
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  </div>
|
|
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span>  <span class="comment">// pin number access methods</span></div>
|
|
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span>  </div>
|
|
<div class="line"><a name="l00334"></a><span class="lineno"><a class="line" href="class_module.html#aa6cac04c7cb6d5278a318db0966ad1a7"> 334</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="l00335"></a><span class="lineno"> 335</span>  </div>
|
|
<div class="line"><a name="l00340"></a><span class="lineno"><a class="line" href="class_module.html#ab61bc5066c356e2d0d79f08a2bd0fbc9"> 340</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="l00341"></a><span class="lineno"> 341</span>  </div>
|
|
<div class="line"><a name="l00346"></a><span class="lineno"><a class="line" href="class_module.html#ad6cddbf3aebec9717a1a381dd81ad398"> 346</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="l00347"></a><span class="lineno"> 347</span>  </div>
|
|
<div class="line"><a name="l00352"></a><span class="lineno"><a class="line" href="class_module.html#a4ec27f0ba5e0009ea9661a5110526b52"> 352</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="l00353"></a><span class="lineno"> 353</span>  </div>
|
|
<div class="line"><a name="l00370"></a><span class="lineno"> 370</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="l00371"></a><span class="lineno"> 371</span>  </div>
|
|
<div class="line"><a name="l00434"></a><span class="lineno"> 434</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="l00435"></a><span class="lineno"> 435</span>  </div>
|
|
<div class="line"><a name="l00443"></a><span class="lineno"> 443</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="l00444"></a><span class="lineno"> 444</span>  </div>
|
|
<div class="line"><a name="l00449"></a><span class="lineno"> 449</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="l00450"></a><span class="lineno"> 450</span>  </div>
|
|
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#a47978200f7e2e408fb64f506c81cee9f">waitForMicroseconds</a>(uint32_t start, uint32_t len);</div>
|
|
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span>  </div>
|
|
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span>  <span class="keyword">static</span> uint8_t <a class="code" href="class_module.html#a7f5fd7409f21d33a16ea1de589962ae6">flipBits</a>(uint8_t b);</div>
|
|
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span>  </div>
|
|
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span>  <span class="keyword">static</span> uint16_t <a class="code" href="class_module.html#a160006371be8e121a8a54cc4462b3a72">flipBits16</a>(uint16_t i);</div>
|
|
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span>  </div>
|
|
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_module.html#ad0532274dafe433ba68529945bfe6a1b">hexdump</a>(uint8_t* data, <span class="keywordtype">size_t</span> len, uint32_t offset = 0, uint8_t width = 1, <span class="keywordtype">bool</span> be = <span class="keyword">false</span>);</div>
|
|
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  </div>
|
|
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span>  <span class="keywordtype">void</span> <a class="code" href="class_module.html#abb13a50ed53b009c04dc2ed6caf78423">regdump</a>(uint16_t start, <span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span>  </div>
|
|
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="preprocessor"> #if defined(RADIOLIB_DEBUG) and defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span>  <span class="keyword">static</span> <span class="keywordtype">size_t</span> serialPrintf(<span class="keyword">const</span> <span class="keywordtype">char</span>* format, ...);</div>
|
|
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span>  </div>
|
|
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span> <span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
|
|
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span>  uint32_t csPin = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span>  uint32_t irqPin = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span>  uint32_t rstPin = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span>  uint32_t gpioPin = RADIOLIB_NC;</div>
|
|
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span>  </div>
|
|
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span>  <span class="comment">// RF switch pins and table</span></div>
|
|
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span>  uint32_t rfSwitchPins[<a class="code" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a>] = { RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC };</div>
|
|
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span>  <span class="keyword">const</span> RfSwitchMode_t *rfSwitchTable = <span class="keyword">nullptr</span>;</div>
|
|
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span>  </div>
|
|
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span> <span class="preprocessor"> #if defined(RADIOLIB_INTERRUPT_TIMING)</span></div>
|
|
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span>  uint32_t prevTimingLen = 0;</div>
|
|
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span> };</div>
|
|
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span>  </div>
|
|
<div class="line"><a name="l00507"></a><span class="lineno"> 507</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:28</div></div>
|
|
<div class="ttc" id="aclass_module_html_a01e15988ec448c76142ee5709929be2c"><div class="ttname"><a href="class_module.html#a01e15988ec448c76142ee5709929be2c">Module::SPIgetRegValue</a></div><div class="ttdeci">int16_t SPIgetRegValue(uint16_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:54</div></div>
|
|
<div class="ttc" id="aclass_module_html_a06d8d4257c584b57a529fcc405d87c79"><div class="ttname"><a href="class_module.html#a06d8d4257c584b57a529fcc405d87c79">Module::SPIstatusCommand</a></div><div class="ttdeci">uint8_t SPIstatusCommand</div><div class="ttdoc">Basic SPI status read command. Defaults to 0x00.</div><div class="ttdef"><b>Definition:</b> Module.h:139</div></div>
|
|
<div class="ttc" id="aclass_module_html_a081191402ad5c49e6c21982fc4587b77"><div class="ttname"><a href="class_module.html#a081191402ad5c49e6c21982fc4587b77">Module::SPIsetRegValue</a></div><div class="ttdeci">int16_t SPIsetRegValue(uint16_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:64</div></div>
|
|
<div class="ttc" id="aclass_module_html_a0c11551e12579bbabf57b19e12555b3c"><div class="ttname"><a href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">Module::RFSWITCH_MAX_PINS</a></div><div class="ttdeci">static const size_t RFSWITCH_MAX_PINS</div><div class="ttdoc">The maximum number of pins supported by the RF switch code.</div><div class="ttdef"><b>Definition:</b> Module.h:39</div></div>
|
|
<div class="ttc" id="aclass_module_html_a160006371be8e121a8a54cc4462b3a72"><div class="ttname"><a href="class_module.html#a160006371be8e121a8a54cc4462b3a72">Module::flipBits16</a></div><div class="ttdeci">static uint16_t flipBits16(uint16_t i)</div><div class="ttdoc">Function to reflect bits within an integer.</div><div class="ttdef"><b>Definition:</b> Module.cpp:382</div></div>
|
|
<div class="ttc" id="aclass_module_html_a34927454be3a34df8a5a586c46c428af"><div class="ttname"><a href="class_module.html#a34927454be3a34df8a5a586c46c428af">Module::SPIstreamType</a></div><div class="ttdeci">bool SPIstreamType</div><div class="ttdoc">Whether the SPI interface is stream-type (e.g. SX126x) or register-type (e.g. SX127x)....</div><div class="ttdef"><b>Definition:</b> Module.h:150</div></div>
|
|
<div class="ttc" id="aclass_module_html_a4437af6552e258e95ed8ed452afa6dd4"><div class="ttname"><a href="class_module.html#a4437af6552e258e95ed8ed452afa6dd4">Module::SPIwriteRegister</a></div><div class="ttdeci">void SPIwriteRegister(uint16_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:132</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:119</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:49</div></div>
|
|
<div class="ttc" id="aclass_module_html_a466112286d19675ca2dbe481358e4365"><div class="ttname"><a href="class_module.html#a466112286d19675ca2dbe481358e4365">Module::SPInopCommand</a></div><div class="ttdeci">uint8_t SPInopCommand</div><div class="ttdoc">Basic SPI no-operation command. Defaults to 0x00.</div><div class="ttdef"><b>Definition:</b> Module.h:134</div></div>
|
|
<div class="ttc" id="aclass_module_html_a47978200f7e2e408fb64f506c81cee9f"><div class="ttname"><a href="class_module.html#a47978200f7e2e408fb64f506c81cee9f">Module::waitForMicroseconds</a></div><div class="ttdeci">void waitForMicroseconds(uint32_t start, uint32_t len)</div><div class="ttdoc">Wait for time to elapse, either using the microsecond timer, or the TimerFlag. Note that in interrupt...</div><div class="ttdef"><b>Definition:</b> Module.cpp:357</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:33</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:352</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:497</div></div>
|
|
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bf"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bf">Module::OpMode_t</a></div><div class="ttdeci">OpMode_t</div><div class="ttdef"><b>Definition:</b> Module.h:58</div></div>
|
|
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571">Module::MODE_TX</a></div><div class="ttdeci">@ MODE_TX</div><div class="ttdef"><b>Definition:</b> Module.h:68</div></div>
|
|
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671">Module::MODE_IDLE</a></div><div class="ttdeci">@ MODE_IDLE</div><div class="ttdef"><b>Definition:</b> Module.h:64</div></div>
|
|
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f">Module::MODE_RX</a></div><div class="ttdeci">@ MODE_RX</div><div class="ttdef"><b>Definition:</b> Module.h:66</div></div>
|
|
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770">Module::MODE_END_OF_TABLE</a></div><div class="ttdeci">@ MODE_END_OF_TABLE</div><div class="ttdef"><b>Definition:</b> Module.h:62</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:224</div></div>
|
|
<div class="ttc" id="aclass_module_html_a66b06e69d57b97116bed1c6f185381f1"><div class="ttname"><a href="class_module.html#a66b06e69d57b97116bed1c6f185381f1">Module::SPIstreamError</a></div><div class="ttdeci">int16_t SPIstreamError</div><div class="ttdoc">The last recorded SPI stream error.</div><div class="ttdef"><b>Definition:</b> Module.h:155</div></div>
|
|
<div class="ttc" id="aclass_module_html_a74ce586afa403130007a474d3295d762"><div class="ttname"><a href="class_module.html#a74ce586afa403130007a474d3295d762">Module::SPIwriteStream</a></div><div class="ttdeci">int16_t SPIwriteStream(uint8_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:207</div></div>
|
|
<div class="ttc" id="aclass_module_html_a78dd39aa71d97e2220a880df8162fdde"><div class="ttname"><a href="class_module.html#a78dd39aa71d97e2220a880df8162fdde">Module::SPItransfer</a></div><div class="ttdeci">void SPItransfer(uint8_t cmd, uint16_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:141</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:474</div></div>
|
|
<div class="ttc" id="aclass_module_html_a7f5fd7409f21d33a16ea1de589962ae6"><div class="ttname"><a href="class_module.html#a7f5fd7409f21d33a16ea1de589962ae6">Module::flipBits</a></div><div class="ttdeci">static uint8_t flipBits(uint8_t b)</div><div class="ttdoc">Function to reflect bits within a byte.</div><div class="ttdef"><b>Definition:</b> Module.cpp:375</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:25</div></div>
|
|
<div class="ttc" id="aclass_module_html_a849ad85fc1bc3a7130e660c13973ab26"><div class="ttname"><a href="class_module.html#a849ad85fc1bc3a7130e660c13973ab26">Module::SPIreadCommand</a></div><div class="ttdeci">uint8_t SPIreadCommand</div><div class="ttdoc">Basic SPI read command. Defaults to 0x00.</div><div class="ttdef"><b>Definition:</b> Module.h:124</div></div>
|
|
<div class="ttc" id="aclass_module_html_a874e030f1931e606e380930d37dd83ee"><div class="ttname"><a href="class_module.html#a874e030f1931e606e380930d37dd83ee">Module::SPIreadRegisterBurst</a></div><div class="ttdeci">void SPIreadRegisterBurst(uint16_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_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">SPI status parsing callback typedef.</div><div class="ttdef"><b>Definition:</b> Module.h:160</div></div>
|
|
<div class="ttc" id="aclass_module_html_a9a545e4a001da0d9f6358279ac40d4f0"><div class="ttname"><a href="class_module.html#a9a545e4a001da0d9f6358279ac40d4f0">Module::SPIreadRegister</a></div><div class="ttdeci">uint8_t SPIreadRegister(uint16_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:112</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:334</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:340</div></div>
|
|
<div class="ttc" id="aclass_module_html_ab9fc874adc8dbe7c3f1fd3c267c27708"><div class="ttname"><a href="class_module.html#ab9fc874adc8dbe7c3f1fd3c267c27708">Module::SPIreadStream</a></div><div class="ttdeci">int16_t SPIreadStream(uint8_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:190</div></div>
|
|
<div class="ttc" id="aclass_module_html_abb13a50ed53b009c04dc2ed6caf78423"><div class="ttname"><a href="class_module.html#abb13a50ed53b009c04dc2ed6caf78423">Module::regdump</a></div><div class="ttdeci">void regdump(uint16_t start, size_t len)</div><div class="ttdoc">Function to dump device registers as hex into the debug port.</div><div class="ttdef"><b>Definition:</b> Module.cpp:435</div></div>
|
|
<div class="ttc" id="aclass_module_html_ac19a495026aae62f5c2f089aa1b2b57a"><div class="ttname"><a href="class_module.html#ac19a495026aae62f5c2f089aa1b2b57a">Module::SPIaddrWidth</a></div><div class="ttdeci">uint8_t SPIaddrWidth</div><div class="ttdoc">SPI address width. Defaults to 8, currently only supports 8 and 16-bit addresses.</div><div class="ttdef"><b>Definition:</b> Module.h:144</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:490</div></div>
|
|
<div class="ttc" id="aclass_module_html_ac3586c8d4013cbdd22cf34032632c181"><div class="ttname"><a href="class_module.html#ac3586c8d4013cbdd22cf34032632c181">Module::SPItransferStream</a></div><div class="ttdeci">int16_t SPItransferStream(uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes, bool waitForGpio, uint32_t timeout)</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:243</div></div>
|
|
<div class="ttc" id="aclass_module_html_ad0532274dafe433ba68529945bfe6a1b"><div class="ttname"><a href="class_module.html#ad0532274dafe433ba68529945bfe6a1b">Module::hexdump</a></div><div class="ttdeci">static void hexdump(uint8_t *data, size_t len, uint32_t offset=0, uint8_t width=1, bool be=false)</div><div class="ttdoc">Function to dump data as hex into the debug port.</div><div class="ttdef"><b>Definition:</b> Module.cpp:390</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:43</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:346</div></div>
|
|
<div class="ttc" id="aclass_module_html_ae89764d15e8df5694a6aec0e18f72d3f"><div class="ttname"><a href="class_module.html#ae89764d15e8df5694a6aec0e18f72d3f">Module::SPIwriteCommand</a></div><div class="ttdeci">uint8_t SPIwriteCommand</div><div class="ttdoc">Basic SPI write command. Defaults to 0x80.</div><div class="ttdef"><b>Definition:</b> Module.h:129</div></div>
|
|
<div class="ttc" id="aclass_module_html_af474f82d00fffc1ee0fc8def2c7f220c"><div class="ttname"><a href="class_module.html#af474f82d00fffc1ee0fc8def2c7f220c">Module::SPIwriteRegisterBurst</a></div><div class="ttdeci">void SPIwriteRegisterBurst(uint16_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:123</div></div>
|
|
<div class="ttc" id="aclass_module_html_af6e89e2bc4976e8c5dc42dedda9fa6a2"><div class="ttname"><a href="class_module.html#af6e89e2bc4976e8c5dc42dedda9fa6a2">Module::SPIparseStatusCb</a></div><div class="ttdeci">SPIparseStatusCb_t SPIparseStatusCb</div><div class="ttdoc">Callback to function that will parse the module-specific status codes to RadioLib status codes....</div><div class="ttdef"><b>Definition:</b> Module.h:166</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:507</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="ttdef"><b>Definition:</b> Hal.h:11</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="astruct_module_1_1_rf_switch_mode__t_html"><div class="ttname"><a href="struct_module_1_1_rf_switch_mode__t.html">Module::RfSwitchMode_t</a></div><div class="ttdef"><b>Definition:</b> Module.h:46</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>
|