267 lines
38 KiB
HTML
267 lines
38 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/protocols/PhysicalLayer/PhysicalLayer.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('_physical_layer_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">PhysicalLayer.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_PHYSICAL_LAYER_H)</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_PHYSICAL_LAYER_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 "../../Module.h"</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="class_physical_layer.html"> 14</a></span> <span class="keyword">class </span><a class="code" href="class_physical_layer.html">PhysicalLayer</a> {</div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="comment">// constructor</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <a class="code" href="class_physical_layer.html#a5e02457f1d519cf81b1590a182321c62">PhysicalLayer</a>(<span class="keywordtype">float</span> freqStep, <span class="keywordtype">size_t</span> maxPacketLength);</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="comment">// basic methods</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  int16_t <a class="code" href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">transmit</a>(__FlashStringHelper* fstr, uint8_t addr = 0);</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  int16_t <a class="code" href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">transmit</a>(String& str, uint8_t addr = 0);</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  int16_t <a class="code" href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">transmit</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* str, uint8_t addr = 0);</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">transmit</a>(uint8_t* data, <span class="keywordtype">size_t</span> len, uint8_t addr = 0);</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  int16_t <a class="code" href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">receive</a>(String& str, <span class="keywordtype">size_t</span> len = 0);</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#acbcaf6aefcb77a354797e66222fe5018">standby</a>();</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#acbcaf6aefcb77a354797e66222fe5018">standby</a>(uint8_t mode);</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">receive</a>(uint8_t* data, <span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  </div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  int16_t <a class="code" href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">startTransmit</a>(String& str, uint8_t addr = 0);</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  </div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  int16_t <a class="code" href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">startTransmit</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* str, uint8_t addr = 0);</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  </div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">startTransmit</a>(uint8_t* data, <span class="keywordtype">size_t</span> len, uint8_t addr = 0);</div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  </div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a1de26f68b939f5af79ec29cc34c7be18">finishTransmit</a>();</div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  </div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  int16_t <a class="code" href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">readData</a>(String& str, <span class="keywordtype">size_t</span> len = 0);</div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  </div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">readData</a>(uint8_t* data, <span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  </div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#aa4c99ac794ee653c2061be4201724b65">transmitDirect</a>(uint32_t frf = 0);</div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  </div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#ad9d1dbb2041e87af5a80e12f125a60e6">receiveDirect</a>();</div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  </div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <span class="comment">// configuration methods</span></div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  </div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a8a194b0fbb66b1a953288bf3b9478d6e">setFrequency</a>(<span class="keywordtype">float</span> freq);</div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  </div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#aedd39ad84b45c6392087b12d59192d8c">setBitRate</a>(<span class="keywordtype">float</span> br);</div>
|
|
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  </div>
|
|
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a2f4f9b428d9ea9af886ca85e5088ed7b">setFrequencyDeviation</a>(<span class="keywordtype">float</span> freqDev);</div>
|
|
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  </div>
|
|
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#aeba04366a0cf05ff3d8227c4f7c8e1e9">setDataShaping</a>(uint8_t sh);</div>
|
|
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  </div>
|
|
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#acb45b2342400a03a914a91d2ac7fb488">setEncoding</a>(uint8_t encoding);</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">float</span> <a class="code" href="class_physical_layer.html#a977e5236693960bb1c79090a201e9e1c">getFreqStep</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  </div>
|
|
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="class_physical_layer.html#a2fe95169b5cdc8cabe1f2af66cad6ef6">getPacketLength</a>(<span class="keywordtype">bool</span> update = <span class="keyword">true</span>);</div>
|
|
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  </div>
|
|
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  int32_t <a class="code" href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">random</a>(int32_t max);</div>
|
|
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  </div>
|
|
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  int32_t <a class="code" href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">random</a>(int32_t min, int32_t max);</div>
|
|
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  </div>
|
|
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  <span class="keyword">virtual</span> uint8_t <a class="code" href="class_physical_layer.html#a1a5985308904261dd431f373d47ddee4">randomByte</a>();</div>
|
|
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  </div>
|
|
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  int16_t <a class="code" href="class_physical_layer.html#a88a10657bd2215a11a2331f937414b55">startDirect</a>();</div>
|
|
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  </div>
|
|
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="preprocessor"> #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)</span></div>
|
|
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  int16_t <a class="code" href="class_physical_layer.html#a8e378fe136a498ea485a9c10f5e15aab">setDirectSyncWord</a>(uint32_t syncWord, uint8_t len);</div>
|
|
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  </div>
|
|
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_physical_layer.html#abf96cf4f3cb4c82d44be581dbe615966">setDirectAction</a>(<span class="keywordtype">void</span> (*func)(<span class="keywordtype">void</span>));</div>
|
|
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  </div>
|
|
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_physical_layer.html#ae868adcc63ee0869999e8ccac86b6ff2">readBit</a>(RADIOLIB_PIN_TYPE pin);</div>
|
|
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  </div>
|
|
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span>  int16_t <a class="code" href="class_physical_layer.html#ab57182d32646861ef0d865e2740d6b26">available</a>();</div>
|
|
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  </div>
|
|
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span>  <span class="keywordtype">void</span> <a class="code" href="class_physical_layer.html#a429796eb2e7ea86781a2e8ca42af43f3">dropSync</a>();</div>
|
|
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span>  </div>
|
|
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span>  uint8_t <a class="code" href="class_physical_layer.html#a4d5b30493c8d7fcfb784e128362d596c">read</a>(<span class="keywordtype">bool</span> drop = <span class="keyword">true</span>);</div>
|
|
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span>  </div>
|
|
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a47c1d94d2ad2fd7eb5d11480b44cc368">setDIOMapping</a>(RADIOLIB_PIN_TYPE pin, uint8_t value);</div>
|
|
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span>  </div>
|
|
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="preprocessor"> #if defined(RADIOLIB_INTERRUPT_TIMING)</span></div>
|
|
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span>  </div>
|
|
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span>  <span class="keywordtype">void</span> setInterruptSetup(<span class="keywordtype">void</span> (*func)(uint32_t));</div>
|
|
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span>  </div>
|
|
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span>  <span class="keywordtype">void</span> setTimerFlag();</div>
|
|
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span>  </div>
|
|
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span>  </div>
|
|
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="preprocessor">#if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)</span></div>
|
|
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span>  <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span>  <span class="keywordtype">void</span> updateDirectBuffer(uint8_t bit);</div>
|
|
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="preprocessor">#endif</span></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="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
|
|
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span>  <span class="keywordtype">float</span> _freqStep;</div>
|
|
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span>  <span class="keywordtype">size_t</span> _maxPacketLength;</div>
|
|
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span>  </div>
|
|
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="preprocessor"> #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)</span></div>
|
|
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  uint8_t _bufferBitPos;</div>
|
|
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span>  uint8_t _bufferWritePos;</div>
|
|
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span>  uint8_t _bufferReadPos;</div>
|
|
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span>  uint8_t _buffer[RADIOLIB_STATIC_ARRAY_SIZE];</div>
|
|
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span>  uint32_t _syncBuffer;</div>
|
|
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>  uint32_t _directSyncWord;</div>
|
|
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span>  uint8_t _directSyncWordLen;</div>
|
|
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span>  uint32_t _directSyncWordMask;</div>
|
|
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span>  <span class="keywordtype">bool</span> _gotSync;</div>
|
|
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span>  </div>
|
|
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span>  <span class="keyword">virtual</span> <a class="code" href="class_module.html">Module</a>* getMod() = 0;</div>
|
|
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span>  </div>
|
|
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span>  <span class="comment">// allow specific classes access the private getMod method</span></div>
|
|
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_a_f_s_k_client.html">AFSKClient</a>;</div>
|
|
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_r_t_t_y_client.html">RTTYClient</a>;</div>
|
|
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_morse_client.html">MorseClient</a>;</div>
|
|
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_hell_client.html">HellClient</a>;</div>
|
|
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_s_s_t_v_client.html">SSTVClient</a>;</div>
|
|
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_a_x25_client.html">AX25Client</a>;</div>
|
|
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_f_s_k4_client.html">FSK4Client</a>;</div>
|
|
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_pager_client.html">PagerClient</a>;</div>
|
|
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span> };</div>
|
|
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span>  </div>
|
|
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="aclass_a_f_s_k_client_html"><div class="ttname"><a href="class_a_f_s_k_client.html">AFSKClient</a></div><div class="ttdoc">Client for audio-based transmissions. Requires Arduino tone() function, and a module capable of direc...</div><div class="ttdef"><b>Definition:</b> AFSK.h:17</div></div>
|
|
<div class="ttc" id="aclass_a_x25_client_html"><div class="ttname"><a href="class_a_x25_client.html">AX25Client</a></div><div class="ttdoc">Client for AX25 communication.</div><div class="ttdef"><b>Definition:</b> AX25.h:279</div></div>
|
|
<div class="ttc" id="aclass_f_s_k4_client_html"><div class="ttname"><a href="class_f_s_k4_client.html">FSK4Client</a></div><div class="ttdoc">Client for FSK-4 communication. The public interface is the same as Arduino Serial.</div><div class="ttdef"><b>Definition:</b> FSK4.h:16</div></div>
|
|
<div class="ttc" id="aclass_hell_client_html"><div class="ttname"><a href="class_hell_client.html">HellClient</a></div><div class="ttdoc">Client for Hellschreiber transmissions.</div><div class="ttdef"><b>Definition:</b> Hellschreiber.h:89</div></div>
|
|
<div class="ttc" id="aclass_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level methods to control the wireless module. Every module class contains o...</div><div class="ttdef"><b>Definition:</b> Module.h:16</div></div>
|
|
<div class="ttc" id="aclass_morse_client_html"><div class="ttname"><a href="class_morse_client.html">MorseClient</a></div><div class="ttdoc">Client for Morse Code communication. The public interface is the same as Arduino Serial.</div><div class="ttdef"><b>Definition:</b> Morse.h:93</div></div>
|
|
<div class="ttc" id="aclass_pager_client_html"><div class="ttname"><a href="class_pager_client.html">PagerClient</a></div><div class="ttdoc">Client for Pager communication.</div><div class="ttdef"><b>Definition:</b> Pager.h:69</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html"><div class="ttname"><a href="class_physical_layer.html">PhysicalLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:14</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a1a5985308904261dd431f373d47ddee4"><div class="ttname"><a href="class_physical_layer.html#a1a5985308904261dd431f373d47ddee4">PhysicalLayer::randomByte</a></div><div class="ttdeci">virtual uint8_t randomByte()</div><div class="ttdoc">Get one truly random byte from RSSI noise. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:261</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a1de26f68b939f5af79ec29cc34c7be18"><div class="ttname"><a href="class_physical_layer.html#a1de26f68b939f5af79ec29cc34c7be18">PhysicalLayer::finishTransmit</a></div><div class="ttdeci">virtual int16_t finishTransmit()</div><div class="ttdoc">Clean up after transmission is done.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:137</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a2f4f9b428d9ea9af886ca85e5088ed7b"><div class="ttname"><a href="class_physical_layer.html#a2f4f9b428d9ea9af886ca85e5088ed7b">PhysicalLayer::setFrequencyDeviation</a></div><div class="ttdeci">virtual int16_t setFrequencyDeviation(float freqDev)</div><div class="ttdoc">Sets FSK frequency deviation from carrier frequency. Only available in FSK mode. Must be implemented ...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:209</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a2fe95169b5cdc8cabe1f2af66cad6ef6"><div class="ttname"><a href="class_physical_layer.html#a2fe95169b5cdc8cabe1f2af66cad6ef6">PhysicalLayer::getPacketLength</a></div><div class="ttdeci">virtual size_t getPacketLength(bool update=true)</div><div class="ttdoc">Query modem for the packet length of received payload. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:228</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a429796eb2e7ea86781a2e8ca42af43f3"><div class="ttname"><a href="class_physical_layer.html#a429796eb2e7ea86781a2e8ca42af43f3">PhysicalLayer::dropSync</a></div><div class="ttdeci">void dropSync()</div><div class="ttdoc">Forcefully drop synchronization.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:284</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a47c1d94d2ad2fd7eb5d11480b44cc368"><div class="ttname"><a href="class_physical_layer.html#a47c1d94d2ad2fd7eb5d11480b44cc368">PhysicalLayer::setDIOMapping</a></div><div class="ttdeci">virtual int16_t setDIOMapping(RADIOLIB_PIN_TYPE pin, uint8_t value)</div><div class="ttdoc">Configure DIO pin mapping to get a given signal on a DIO pin (if available).</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:362</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a4d5b30493c8d7fcfb784e128362d596c"><div class="ttname"><a href="class_physical_layer.html#a4d5b30493c8d7fcfb784e128362d596c">PhysicalLayer::read</a></div><div class="ttdeci">uint8_t read(bool drop=true)</div><div class="ttdoc">Get data from direct mode buffer.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:291</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a5e02457f1d519cf81b1590a182321c62"><div class="ttname"><a href="class_physical_layer.html#a5e02457f1d519cf81b1590a182321c62">PhysicalLayer::PhysicalLayer</a></div><div class="ttdeci">PhysicalLayer(float freqStep, size_t maxPacketLength)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:3</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a88a10657bd2215a11a2331f937414b55"><div class="ttname"><a href="class_physical_layer.html#a88a10657bd2215a11a2331f937414b55">PhysicalLayer::startDirect</a></div><div class="ttdeci">int16_t startDirect()</div><div class="ttdoc">Configure module parameters for direct modes. Must be called prior to "ham" modes like RTTY or AX....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:265</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a8a194b0fbb66b1a953288bf3b9478d6e"><div class="ttname"><a href="class_physical_layer.html#a8a194b0fbb66b1a953288bf3b9478d6e">PhysicalLayer::setFrequency</a></div><div class="ttdeci">virtual int16_t setFrequency(float freq)</div><div class="ttdoc">Sets carrier frequency. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:199</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a8e378fe136a498ea485a9c10f5e15aab"><div class="ttname"><a href="class_physical_layer.html#a8e378fe136a498ea485a9c10f5e15aab">PhysicalLayer::setDirectSyncWord</a></div><div class="ttdeci">int16_t setDirectSyncWord(uint32_t syncWord, uint8_t len)</div><div class="ttdoc">Set sync word to be used to determine start of packet in direct reception mode.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:299</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a977e5236693960bb1c79090a201e9e1c"><div class="ttname"><a href="class_physical_layer.html#a977e5236693960bb1c79090a201e9e1c">PhysicalLayer::getFreqStep</a></div><div class="ttdeci">float getFreqStep() const</div><div class="ttdoc">Gets the module frequency step size that was set in constructor.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:224</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_aa4c99ac794ee653c2061be4201724b65"><div class="ttname"><a href="class_physical_layer.html#aa4c99ac794ee653c2061be4201724b65">PhysicalLayer::transmitDirect</a></div><div class="ttdeci">virtual int16_t transmitDirect(uint32_t frf=0)</div><div class="ttdoc">Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module ...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:190</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_ab139a34e03a6fd5a781cd54da21d308f"><div class="ttname"><a href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">PhysicalLayer::transmit</a></div><div class="ttdeci">int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)</div><div class="ttdoc">Arduino Flash String transmit method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:12</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_ab57182d32646861ef0d865e2740d6b26"><div class="ttname"><a href="class_physical_layer.html#ab57182d32646861ef0d865e2740d6b26">PhysicalLayer::available</a></div><div class="ttdeci">int16_t available()</div><div class="ttdoc">Get the number of direct mode bytes currently available in buffer.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:280</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_abf96cf4f3cb4c82d44be581dbe615966"><div class="ttname"><a href="class_physical_layer.html#abf96cf4f3cb4c82d44be581dbe615966">PhysicalLayer::setDirectAction</a></div><div class="ttdeci">virtual void setDirectAction(void(*func)(void))</div><div class="ttdoc">Set interrupt service routine function to call when data bit is receveid in direct mode....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:352</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_acb45b2342400a03a914a91d2ac7fb488"><div class="ttname"><a href="class_physical_layer.html#acb45b2342400a03a914a91d2ac7fb488">PhysicalLayer::setEncoding</a></div><div class="ttdeci">virtual int16_t setEncoding(uint8_t encoding)</div><div class="ttdoc">Sets FSK data encoding. Only available in FSK mode. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:219</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_acbcaf6aefcb77a354797e66222fe5018"><div class="ttname"><a href="class_physical_layer.html#acbcaf6aefcb77a354797e66222fe5018">PhysicalLayer::standby</a></div><div class="ttdeci">virtual int16_t standby()</div><div class="ttdoc">Sets module to standby.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:113</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_acd9171bd71aa80fb86113b612c42de53"><div class="ttname"><a href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">PhysicalLayer::random</a></div><div class="ttdeci">int32_t random(int32_t max)</div><div class="ttdoc">Get truly random number in range 0 - max.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:233</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_ad9d1dbb2041e87af5a80e12f125a60e6"><div class="ttname"><a href="class_physical_layer.html#ad9d1dbb2041e87af5a80e12f125a60e6">PhysicalLayer::receiveDirect</a></div><div class="ttdeci">virtual int16_t receiveDirect()</div><div class="ttdoc">Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module cla...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:195</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_ae868adcc63ee0869999e8ccac86b6ff2"><div class="ttname"><a href="class_physical_layer.html#ae868adcc63ee0869999e8ccac86b6ff2">PhysicalLayer::readBit</a></div><div class="ttdeci">virtual void readBit(RADIOLIB_PIN_TYPE pin)</div><div class="ttdoc">Function to read and process data bit in direct reception mode. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:356</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_ae8eed0e888a7c8742e89d2b850977de2"><div class="ttname"><a href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">PhysicalLayer::readData</a></div><div class="ttdeci">int16_t readData(String &str, size_t len=0)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:141</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_aeba04366a0cf05ff3d8227c4f7c8e1e9"><div class="ttname"><a href="class_physical_layer.html#aeba04366a0cf05ff3d8227c4f7c8e1e9">PhysicalLayer::setDataShaping</a></div><div class="ttdeci">virtual int16_t setDataShaping(uint8_t sh)</div><div class="ttdoc">Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:214</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_aedd39ad84b45c6392087b12d59192d8c"><div class="ttname"><a href="class_physical_layer.html#aedd39ad84b45c6392087b12d59192d8c">PhysicalLayer::setBitRate</a></div><div class="ttdeci">virtual int16_t setBitRate(float br)</div><div class="ttdoc">Sets FSK bit rate. Only available in FSK mode. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:204</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_af068e6e862c99e39d0261a7971dd56db"><div class="ttname"><a href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(String &str, uint8_t addr=0)</div><div class="ttdoc">Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:122</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_afb1b090348d9091bfa3a0b5ba3d85b36"><div class="ttname"><a href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">PhysicalLayer::receive</a></div><div class="ttdeci">int16_t receive(String &str, size_t len=0)</div><div class="ttdoc">Arduino String receive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:60</div></div>
|
|
<div class="ttc" id="aclass_r_t_t_y_client_html"><div class="ttname"><a href="class_r_t_t_y_client.html">RTTYClient</a></div><div class="ttdoc">Client for RTTY communication. The public interface is the same as Arduino Serial.</div><div class="ttdef"><b>Definition:</b> RTTY.h:88</div></div>
|
|
<div class="ttc" id="aclass_s_s_t_v_client_html"><div class="ttname"><a href="class_s_s_t_v_client.html">SSTVClient</a></div><div class="ttdoc">Client for SSTV transmissions.</div><div class="ttdef"><b>Definition:</b> SSTV.h:120</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"><a class="el" href="dir_79690749eba542503bb1a9a3dbb495e1.html">protocols</a></li><li class="navelem"><a class="el" href="dir_2cdd3c47e80335731aa10f67042c391a.html">PhysicalLayer</a></li><li class="navelem"><b>PhysicalLayer.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>
|