260 lines
36 KiB
HTML
260 lines
36 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.8.17"/>
|
|
<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.8.17 -->
|
|
<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');
|
|
/* @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) = 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#a0e77da761a2cbb5c9535df0bdea993f9">standby</a>() = 0;</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</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) = 0;</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  </div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</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="l00116"></a><span class="lineno"> 116</span>  </div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</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="l00128"></a><span class="lineno"> 128</span>  </div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</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) = 0;</div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</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#aeba51a21ad3c6d56b61a55061de7fc92">finishTransmit</a>() = 0;</div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  </div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</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="l00160"></a><span class="lineno"> 160</span>  </div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</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) = 0;</div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  </div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a4b04eb6155b06d8ef400131c647d54e7">transmitDirect</a>(uint32_t frf = 0) = 0;</div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  </div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a46b22145b33e97cf6065ed826799b6b4">receiveDirect</a>() = 0;</div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  </div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <span class="comment">// configuration methods</span></div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  </div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a4928642e647f2dd5b614b87b681cb0a6">setFrequency</a>(<span class="keywordtype">float</span> freq) = 0;</div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  </div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a56e9cf39bc8847492f7f3cd67ebf1c46">setBitRate</a>(<span class="keywordtype">float</span> br) = 0;</div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  </div>
|
|
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#ab9060e8ab7a2da192b3bf53b3501553b">setFrequencyDeviation</a>(<span class="keywordtype">float</span> freqDev) = 0;</div>
|
|
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  </div>
|
|
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#ab643a814dce48f71a13bf6ea23f44cbd">setDataShaping</a>(uint8_t sh) = 0;</div>
|
|
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  </div>
|
|
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a7d3419227d201d6912b77784636d437d">setEncoding</a>(uint8_t encoding) = 0;</div>
|
|
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  </div>
|
|
<div class="line"><a name="l00243"></a><span class="lineno"> 243</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="l00244"></a><span class="lineno"> 244</span>  </div>
|
|
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="class_physical_layer.html#a0bd6046e068ef63e3f2b6bead48e02a7">getPacketLength</a>(<span class="keywordtype">bool</span> update = <span class="keyword">true</span>) = 0;</div>
|
|
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  </div>
|
|
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  int32_t <a class="code" href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">random</a>(int32_t max);</div>
|
|
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  </div>
|
|
<div class="line"><a name="l00272"></a><span class="lineno"> 272</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="l00273"></a><span class="lineno"> 273</span>  </div>
|
|
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  <span class="keyword">virtual</span> uint8_t <a class="code" href="class_physical_layer.html#a34543b885aa57ade08a4c659991e523e">randomByte</a>() = 0;</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>  int16_t <a class="code" href="class_physical_layer.html#a88a10657bd2215a11a2331f937414b55">startDirect</a>();</div>
|
|
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  </div>
|
|
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="preprocessor"> #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)</span></div>
|
|
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  </div>
|
|
<div class="line"><a name="l00298"></a><span class="lineno"> 298</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="l00299"></a><span class="lineno"> 299</span>  </div>
|
|
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_physical_layer.html#ab76fe7d3e0f453a807b205161c980086">setDirectAction</a>(<span class="keywordtype">void</span> (*func)(<span class="keywordtype">void</span>)) = 0;</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#a9b720e7776ad7ea805932578907b0058">readBit</a>(RADIOLIB_PIN_TYPE pin) = 0;</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>  int16_t <a class="code" href="class_physical_layer.html#ab57182d32646861ef0d865e2740d6b26">available</a>();</div>
|
|
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  </div>
|
|
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span>  <span class="keywordtype">void</span> <a class="code" href="class_physical_layer.html#a429796eb2e7ea86781a2e8ca42af43f3">dropSync</a>();</div>
|
|
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span>  </div>
|
|
<div class="line"><a name="l00333"></a><span class="lineno"> 333</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="l00334"></a><span class="lineno"> 334</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span>  </div>
|
|
<div class="line"><a name="l00345"></a><span class="lineno"> 345</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="l00346"></a><span class="lineno"> 346</span>  </div>
|
|
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="preprocessor">#if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)</span></div>
|
|
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span>  <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>  <span class="keywordtype">void</span> updateDirectBuffer(uint8_t bit);</div>
|
|
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span>  </div>
|
|
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
|
|
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span>  <span class="keywordtype">float</span> _freqStep;</div>
|
|
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span>  <span class="keywordtype">size_t</span> _maxPacketLength;</div>
|
|
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span>  </div>
|
|
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="preprocessor"> #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)</span></div>
|
|
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span>  uint8_t _bufferBitPos;</div>
|
|
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span>  uint8_t _bufferWritePos;</div>
|
|
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span>  uint8_t _bufferReadPos;</div>
|
|
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span>  uint8_t _buffer[RADIOLIB_STATIC_ARRAY_SIZE];</div>
|
|
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span>  uint32_t _syncBuffer;</div>
|
|
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span>  uint32_t _directSyncWord;</div>
|
|
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span>  uint8_t _directSyncWordLen;</div>
|
|
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span>  uint32_t _directSyncWordMask;</div>
|
|
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>  <span class="keywordtype">bool</span> _gotSync;</div>
|
|
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="preprocessor"> #endif</span></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="keyword">virtual</span> <a class="code" href="class_module.html">Module</a>* getMod() = 0;</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="comment">// allow specific classes access the private getMod method</span></div>
|
|
<div class="line"><a name="l00373"></a><span class="lineno"> 373</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="l00374"></a><span class="lineno"> 374</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="l00375"></a><span class="lineno"> 375</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="l00376"></a><span class="lineno"> 376</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="l00377"></a><span class="lineno"> 377</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="l00378"></a><span class="lineno"> 378</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="l00379"></a><span class="lineno"> 379</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="l00380"></a><span class="lineno"> 380</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="l00381"></a><span class="lineno"> 381</span> };</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">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<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_a0e77da761a2cbb5c9535df0bdea993f9"><div class="ttname"><a href="class_physical_layer.html#a0e77da761a2cbb5c9535df0bdea993f9">PhysicalLayer::standby</a></div><div class="ttdeci">virtual int16_t standby()=0</div><div class="ttdoc">Sets module to standby.</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a56e9cf39bc8847492f7f3cd67ebf1c46"><div class="ttname"><a href="class_physical_layer.html#a56e9cf39bc8847492f7f3cd67ebf1c46">PhysicalLayer::setBitRate</a></div><div class="ttdeci">virtual int16_t setBitRate(float br)=0</div><div class="ttdoc">Sets FSK bit rate. Only available in FSK mode. Must be implemented in module class.</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_ab9060e8ab7a2da192b3bf53b3501553b"><div class="ttname"><a href="class_physical_layer.html#ab9060e8ab7a2da192b3bf53b3501553b">PhysicalLayer::setFrequencyDeviation</a></div><div class="ttdeci">virtual int16_t setFrequencyDeviation(float freqDev)=0</div><div class="ttdoc">Sets FSK frequency deviation from carrier frequency. Only available in FSK mode. Must be implemented ...</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a4928642e647f2dd5b614b87b681cb0a6"><div class="ttname"><a href="class_physical_layer.html#a4928642e647f2dd5b614b87b681cb0a6">PhysicalLayer::setFrequency</a></div><div class="ttdeci">virtual int16_t setFrequency(float freq)=0</div><div class="ttdoc">Sets carrier frequency. Must be implemented in module class.</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_physical_layer_html_a7d3419227d201d6912b77784636d437d"><div class="ttname"><a href="class_physical_layer.html#a7d3419227d201d6912b77784636d437d">PhysicalLayer::setEncoding</a></div><div class="ttdeci">virtual int16_t setEncoding(uint8_t encoding)=0</div><div class="ttdoc">Sets FSK data encoding. Only available in FSK mode. Must be implemented in module class.</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a4b04eb6155b06d8ef400131c647d54e7"><div class="ttname"><a href="class_physical_layer.html#a4b04eb6155b06d8ef400131c647d54e7">PhysicalLayer::transmitDirect</a></div><div class="ttdeci">virtual int16_t transmitDirect(uint32_t frf=0)=0</div><div class="ttdoc">Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module ...</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:194</div></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_physical_layer_html_ab76fe7d3e0f453a807b205161c980086"><div class="ttname"><a href="class_physical_layer.html#ab76fe7d3e0f453a807b205161c980086">PhysicalLayer::setDirectAction</a></div><div class="ttdeci">virtual void setDirectAction(void(*func)(void))=0</div><div class="ttdoc">Set interrupt service routine function to call when data bit is receveid in direct mode....</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:198</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a9b720e7776ad7ea805932578907b0058"><div class="ttname"><a href="class_physical_layer.html#a9b720e7776ad7ea805932578907b0058">PhysicalLayer::readBit</a></div><div class="ttdeci">virtual void readBit(RADIOLIB_PIN_TYPE pin)=0</div><div class="ttdoc">Function to read and process data bit in direct reception mode. Must be implemented in module class.</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:61</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a46b22145b33e97cf6065ed826799b6b4"><div class="ttname"><a href="class_physical_layer.html#a46b22145b33e97cf6065ed826799b6b4">PhysicalLayer::receiveDirect</a></div><div class="ttdeci">virtual int16_t receiveDirect()=0</div><div class="ttdoc">Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module cla...</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_aeba51a21ad3c6d56b61a55061de7fc92"><div class="ttname"><a href="class_physical_layer.html#aeba51a21ad3c6d56b61a55061de7fc92">PhysicalLayer::finishTransmit</a></div><div class="ttdeci">virtual int16_t finishTransmit()=0</div><div class="ttdoc">Clean up after transmission is done.</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:205</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:179</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_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_physical_layer_html_a34543b885aa57ade08a4c659991e523e"><div class="ttname"><a href="class_physical_layer.html#a34543b885aa57ade08a4c659991e523e">PhysicalLayer::randomByte</a></div><div class="ttdeci">virtual uint8_t randomByte()=0</div><div class="ttdoc">Get one truly random byte from RSSI noise. Must be implemented in module class.</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:151</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:260</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_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:102</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_physical_layer_html_a0bd6046e068ef63e3f2b6bead48e02a7"><div class="ttname"><a href="class_physical_layer.html#a0bd6046e068ef63e3f2b6bead48e02a7">PhysicalLayer::getPacketLength</a></div><div class="ttdeci">virtual size_t getPacketLength(bool update=true)=0</div><div class="ttdoc">Query modem for the packet length of received payload. Must be implemented in module class.</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 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_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:213</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_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:147</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_ab643a814dce48f71a13bf6ea23f44cbd"><div class="ttname"><a href="class_physical_layer.html#ab643a814dce48f71a13bf6ea23f44cbd">PhysicalLayer::setDataShaping</a></div><div class="ttdeci">virtual int16_t setDataShaping(uint8_t sh)=0</div><div class="ttdoc">Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class.</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:53</div></div>
|
|
<!-- 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="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|