375 lines
63 KiB
HTML
375 lines
63 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="l00007"></a><span class="lineno"> 7</span> <span class="comment">// data rate structure interpretation in case LoRa is used</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="struct_lo_ra_rate__t.html"> 8</a></span> <span class="keyword">struct </span><a class="code" href="struct_lo_ra_rate__t.html">LoRaRate_t</a> {</div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  uint8_t spreadingFactor;</div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  <span class="keywordtype">float</span> bandwidth;</div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  uint8_t codingRate;</div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> };</div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// data rate structure interpretation in case FSK is used</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="struct_f_s_k_rate__t.html"> 15</a></span> <span class="keyword">struct </span><a class="code" href="struct_f_s_k_rate__t.html">FSKRate_t</a> {</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keywordtype">float</span> bitRate;</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keywordtype">float</span> freqDev;</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> };</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// common data rate</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="union_data_rate__t.html"> 21</a></span> <span class="keyword">union </span><a class="code" href="union_data_rate__t.html">DataRate_t</a> {</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <a class="code" href="struct_lo_ra_rate__t.html">LoRaRate_t</a> lora;</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <a class="code" href="struct_f_s_k_rate__t.html">FSKRate_t</a> fsk;</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> };</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="class_physical_layer.html"> 34</a></span> <span class="keyword">class </span><a class="code" href="class_physical_layer.html">PhysicalLayer</a> {</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// constructor</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="class_physical_layer.html#add63d7d4fa8b14df5e185813794a49d5">PhysicalLayer</a>(<span class="keywordtype">float</span> step, <span class="keywordtype">size_t</span> maxLen);</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// basic methods</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  int16_t <a class="code" href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">transmit</a>(__FlashStringHelper* fstr, uint8_t addr = 0);</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  int16_t <a class="code" href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">transmit</a>(String& str, uint8_t addr = 0);</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  int16_t <a class="code" href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">transmit</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* str, uint8_t addr = 0);</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">transmit</a>(uint8_t* data, <span class="keywordtype">size_t</span> len, uint8_t addr = 0);</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  int16_t <a class="code" href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">receive</a>(String& str, <span class="keywordtype">size_t</span> len = 0);</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="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#af1bb9a5da26da8829795ebb72e9c666e">sleep</a>();</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</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#acbcaf6aefcb77a354797e66222fe5018">standby</a>();</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  </div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</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="l00110"></a><span class="lineno"> 110</span>  </div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a18664ad615c5507ff1690baaca90b094">startReceive</a>();</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>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a18664ad615c5507ff1690baaca90b094">startReceive</a>(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, <span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  </div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">receive</a>(uint8_t* data, <span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  </div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  int16_t <a class="code" href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">startTransmit</a>(String& str, uint8_t addr = 0);</div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  </div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  int16_t <a class="code" href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">startTransmit</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* str, uint8_t addr = 0);</div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  </div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">startTransmit</a>(uint8_t* data, <span class="keywordtype">size_t</span> len, uint8_t addr = 0);</div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  </div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</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="l00171"></a><span class="lineno"> 171</span>  </div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  int16_t <a class="code" href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">readData</a>(String& str, <span class="keywordtype">size_t</span> len = 0);</div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  </div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">readData</a>(uint8_t* data, <span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  </div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</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="l00199"></a><span class="lineno"> 199</span>  </div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</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="l00206"></a><span class="lineno"> 206</span>  </div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="comment">// configuration methods</span></div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  </div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</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="l00215"></a><span class="lineno"> 215</span>  </div>
|
|
<div class="line"><a name="l00221"></a><span class="lineno"> 221</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="l00222"></a><span class="lineno"> 222</span>  </div>
|
|
<div class="line"><a name="l00229"></a><span class="lineno"> 229</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="l00230"></a><span class="lineno"> 230</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#aeba04366a0cf05ff3d8227c4f7c8e1e9">setDataShaping</a>(uint8_t sh);</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="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="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a11b4c6d0bf3ae7b9ca04e9434180feab">invertIQ</a>(<span class="keywordtype">bool</span> enable);</div>
|
|
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  </div>
|
|
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#ad2286dc78dbf8e3084f38e9159b99ae5">setOutputPower</a>(int8_t power);</div>
|
|
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  </div>
|
|
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a6c71cdc1238e1368274670758431a977">setSyncWord</a>(uint8_t* sync, <span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  </div>
|
|
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a85db1ff64e6c56e054f276c511194633">setPreambleLength</a>(<span class="keywordtype">size_t</span> len);</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> int16_t <a class="code" href="class_physical_layer.html#a6ee1fed6bbb8d3571974153ac6f26751">setDataRate</a>(<a class="code" href="union_data_rate__t.html">DataRate_t</a> dr);</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> int16_t <a class="code" href="class_physical_layer.html#a58d54eeb40fb586013ba48e15318abba">checkDataRate</a>(<a class="code" href="union_data_rate__t.html">DataRate_t</a> dr);</div>
|
|
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  </div>
|
|
<div class="line"><a name="l00292"></a><span class="lineno"> 292</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="l00293"></a><span class="lineno"> 293</span>  </div>
|
|
<div class="line"><a name="l00299"></a><span class="lineno"> 299</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="l00300"></a><span class="lineno"> 300</span>  </div>
|
|
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="class_physical_layer.html#aabc94ab27a9ee6daaafa9b47dde5f75b">getRSSI</a>();</div>
|
|
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  </div>
|
|
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span>  <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="class_physical_layer.html#aedddaf9460941b90e43e9005035faa0f">getSNR</a>();</div>
|
|
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  </div>
|
|
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span>  <span class="keyword">virtual</span> uint32_t <a class="code" href="class_physical_layer.html#a55ccbe60bfc1ab58814dbd5f9cd4939e">getTimeOnAir</a>(<span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  </div>
|
|
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span>  <span class="keyword">virtual</span> uint32_t <a class="code" href="class_physical_layer.html#a50c3c0866faa474ae2ea8d5b79a73358">calculateRxTimeout</a>(uint32_t timeoutUs);</div>
|
|
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span>  </div>
|
|
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a1d1fe00d107bbc23b0315fd442bc3292">irqRxDoneRxTimeout</a>(uint16_t &irqFlags, uint16_t &irqMask);</div>
|
|
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span>  </div>
|
|
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_physical_layer.html#acb8d8182a32439fe91f2806d73e629f4">isRxTimeout</a>();</div>
|
|
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span>  </div>
|
|
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#ae30dfbb5445bb674898fc54f5f90b2f9">startChannelScan</a>();</div>
|
|
<div class="line"><a name="l00347"></a><span class="lineno"> 347</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#a63979795a7b53557560bb95b65480906">getChannelScanResult</a>();</div>
|
|
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span>  </div>
|
|
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#abd9e39cc745acbf084cfa0d3f4d10718">scanChannel</a>();</div>
|
|
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span>  </div>
|
|
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>  int32_t <a class="code" href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">random</a>(int32_t max);</div>
|
|
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span>  </div>
|
|
<div class="line"><a name="l00375"></a><span class="lineno"> 375</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="l00376"></a><span class="lineno"> 376</span>  </div>
|
|
<div class="line"><a name="l00381"></a><span class="lineno"> 381</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="l00382"></a><span class="lineno"> 382</span>  </div>
|
|
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span>  int16_t <a class="code" href="class_physical_layer.html#a88a10657bd2215a11a2331f937414b55">startDirect</a>();</div>
|
|
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>  </div>
|
|
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="preprocessor"> #if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE</span></div>
|
|
<div class="line"><a name="l00397"></a><span class="lineno"> 397</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="l00398"></a><span class="lineno"> 398</span>  </div>
|
|
<div class="line"><a name="l00404"></a><span class="lineno"> 404</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="l00405"></a><span class="lineno"> 405</span>  </div>
|
|
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_physical_layer.html#acda61fc99cfa373153c50c78380ed885">readBit</a>(uint32_t pin);</div>
|
|
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span>  </div>
|
|
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span>  int16_t <a class="code" href="class_physical_layer.html#ab57182d32646861ef0d865e2740d6b26">available</a>();</div>
|
|
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span>  </div>
|
|
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span>  <span class="keywordtype">void</span> <a class="code" href="class_physical_layer.html#a429796eb2e7ea86781a2e8ca42af43f3">dropSync</a>();</div>
|
|
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span>  </div>
|
|
<div class="line"><a name="l00429"></a><span class="lineno"> 429</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="l00430"></a><span class="lineno"> 430</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span>  </div>
|
|
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a349e8a22cd28ad89d45460fdeeefc05c">setDIOMapping</a>(uint32_t pin, uint32_t value);</div>
|
|
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span>  </div>
|
|
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_physical_layer.html#aec928bb26f65752aa20cd236fbabb95c">setPacketReceivedAction</a>(<span class="keywordtype">void</span> (*func)(<span class="keywordtype">void</span>));</div>
|
|
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span>  </div>
|
|
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_physical_layer.html#a7edf27f03600b96f72f011fc82fa4ef9">clearPacketReceivedAction</a>();</div>
|
|
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  </div>
|
|
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_physical_layer.html#a32b512b34f6575b2109ae3c3f35d1369">setPacketSentAction</a>(<span class="keywordtype">void</span> (*func)(<span class="keywordtype">void</span>));</div>
|
|
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span>  </div>
|
|
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_physical_layer.html#a67ee4ec36f352d06dda0102260f6bfce">clearPacketSentAction</a>();</div>
|
|
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span>  </div>
|
|
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_physical_layer.html#ae11c191a7edf3116bf468b9153237260">setChannelScanAction</a>(<span class="keywordtype">void</span> (*func)(<span class="keywordtype">void</span>));</div>
|
|
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span>  </div>
|
|
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_physical_layer.html#a169a4d04c5c50d3336e274d70930d9f6">clearChannelScanAction</a>();</div>
|
|
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span>  </div>
|
|
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span> <span class="preprocessor"> #if RADIOLIB_INTERRUPT_TIMING</span></div>
|
|
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span>  </div>
|
|
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span>  <span class="keywordtype">void</span> setInterruptSetup(<span class="keywordtype">void</span> (*func)(uint32_t));</div>
|
|
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span>  </div>
|
|
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span>  <span class="keywordtype">void</span> setTimerFlag();</div>
|
|
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span>  </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 !RADIOLIB_GODMODE</span></div>
|
|
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span>  <span class="keyword">protected</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> <span class="preprocessor">#if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE</span></div>
|
|
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span>  <span class="keywordtype">void</span> updateDirectBuffer(uint8_t bit);</div>
|
|
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span>  </div>
|
|
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span> <span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
|
|
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span>  <span class="keywordtype">float</span> freqStep;</div>
|
|
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span>  <span class="keywordtype">size_t</span> maxPacketLength;</div>
|
|
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span>  </div>
|
|
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span> <span class="preprocessor"> #if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE</span></div>
|
|
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span>  uint8_t bufferBitPos;</div>
|
|
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span>  uint8_t bufferWritePos;</div>
|
|
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span>  uint8_t bufferReadPos;</div>
|
|
<div class="line"><a name="l00507"></a><span class="lineno"> 507</span>  uint8_t buffer[RADIOLIB_STATIC_ARRAY_SIZE];</div>
|
|
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span>  uint32_t syncBuffer;</div>
|
|
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span>  uint32_t directSyncWord;</div>
|
|
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span>  uint8_t directSyncWordLen;</div>
|
|
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span>  uint32_t directSyncWordMask;</div>
|
|
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span>  <span class="keywordtype">bool</span> gotSync;</div>
|
|
<div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span>  </div>
|
|
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span>  <span class="keyword">virtual</span> <a class="code" href="class_module.html">Module</a>* getMod() = 0;</div>
|
|
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span>  </div>
|
|
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span>  <span class="comment">// allow specific classes access the private getMod method</span></div>
|
|
<div class="line"><a name="l00518"></a><span class="lineno"> 518</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="l00519"></a><span class="lineno"> 519</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="l00520"></a><span class="lineno"> 520</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="l00521"></a><span class="lineno"> 521</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="l00522"></a><span class="lineno"> 522</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="l00523"></a><span class="lineno"> 523</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="l00524"></a><span class="lineno"> 524</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="l00525"></a><span class="lineno"> 525</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="l00526"></a><span class="lineno"> 526</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_bell_client.html">BellClient</a>;</div>
|
|
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span>  <span class="keyword">friend</span> <span class="keyword">class </span>FT8Client;</div>
|
|
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_lo_ra_w_a_n_node.html">LoRaWANNode</a>;</div>
|
|
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span> };</div>
|
|
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span>  </div>
|
|
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span> <span class="preprocessor">#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:16</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:238</div></div>
|
|
<div class="ttc" id="aclass_bell_client_html"><div class="ttname"><a href="class_bell_client.html">BellClient</a></div><div class="ttdoc">Client for Bell modem communication. The public interface is the same as Arduino Serial.</div><div class="ttdef"><b>Definition:</b> BellModem.h:57</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:15</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:90</div></div>
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html">LoRaWANNode</a></div><div class="ttdoc">LoRaWAN-compatible node (class A device).</div><div class="ttdef"><b>Definition:</b> LoRaWAN.h:454</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:31</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:62</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:34</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a11b4c6d0bf3ae7b9ca04e9434180feab"><div class="ttname"><a href="class_physical_layer.html#a11b4c6d0bf3ae7b9ca04e9434180feab">PhysicalLayer::invertIQ</a></div><div class="ttdeci">virtual int16_t invertIQ(bool enable)</div><div class="ttdoc">Set IQ inversion. Must be implemented in module class if the module supports it.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:249</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a169a4d04c5c50d3336e274d70930d9f6"><div class="ttname"><a href="class_physical_layer.html#a169a4d04c5c50d3336e274d70930d9f6">PhysicalLayer::clearChannelScanAction</a></div><div class="ttdeci">virtual void clearChannelScanAction()</div><div class="ttdoc">Clears interrupt service routine to call when a channel scan is finished.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:481</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a18664ad615c5507ff1690baaca90b094"><div class="ttname"><a href="class_physical_layer.html#a18664ad615c5507ff1690baaca90b094">PhysicalLayer::startReceive</a></div><div class="ttdeci">virtual int16_t startReceive()</div><div class="ttdoc">Sets module to received mode using its default configuration.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:131</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:356</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a1d1fe00d107bbc23b0315fd442bc3292"><div class="ttname"><a href="class_physical_layer.html#a1d1fe00d107bbc23b0315fd442bc3292">PhysicalLayer::irqRxDoneRxTimeout</a></div><div class="ttdeci">virtual int16_t irqRxDoneRxTimeout(uint16_t &irqFlags, uint16_t &irqMask)</div><div class="ttdoc">Create the flags that make up RxDone and RxTimeout used for receiving downlinks.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:307</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:160</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:234</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:284</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a32b512b34f6575b2109ae3c3f35d1369"><div class="ttname"><a href="class_physical_layer.html#a32b512b34f6575b2109ae3c3f35d1369">PhysicalLayer::setPacketSentAction</a></div><div class="ttdeci">virtual void setPacketSentAction(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:469</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a349e8a22cd28ad89d45460fdeeefc05c"><div class="ttname"><a href="class_physical_layer.html#a349e8a22cd28ad89d45460fdeeefc05c">PhysicalLayer::setDIOMapping</a></div><div class="ttdeci">virtual int16_t setDIOMapping(uint32_t pin, uint32_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:455</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:209</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:379</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a492b2d057dd803c3884fa1adc8e22534"><div class="ttname"><a href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">PhysicalLayer::transmit</a></div><div class="ttdeci">int16_t transmit(const char *str, uint8_t addr=0)</div><div class="ttdoc">C-string transmit method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:52</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:386</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a50c3c0866faa474ae2ea8d5b79a73358"><div class="ttname"><a href="class_physical_layer.html#a50c3c0866faa474ae2ea8d5b79a73358">PhysicalLayer::calculateRxTimeout</a></div><div class="ttdeci">virtual uint32_t calculateRxTimeout(uint32_t timeoutUs)</div><div class="ttdoc">Calculate the timeout value for this specific module / series (in number of symbols or units of time)</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:302</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a55ccbe60bfc1ab58814dbd5f9cd4939e"><div class="ttname"><a href="class_physical_layer.html#a55ccbe60bfc1ab58814dbd5f9cd4939e">PhysicalLayer::getTimeOnAir</a></div><div class="ttdeci">virtual uint32_t getTimeOnAir(size_t len)</div><div class="ttdoc">Get expected time-on-air for a given size of payload.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:297</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a58d54eeb40fb586013ba48e15318abba"><div class="ttname"><a href="class_physical_layer.html#a58d54eeb40fb586013ba48e15318abba">PhysicalLayer::checkDataRate</a></div><div class="ttdeci">virtual int16_t checkDataRate(DataRate_t dr)</div><div class="ttdoc">Check the data rate can be configured by this module. Must be implemented in module class if the modu...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:275</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a63979795a7b53557560bb95b65480906"><div class="ttname"><a href="class_physical_layer.html#a63979795a7b53557560bb95b65480906">PhysicalLayer::getChannelScanResult</a></div><div class="ttdeci">virtual int16_t getChannelScanResult()</div><div class="ttdoc">Read the channel scan result.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:321</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a67ee4ec36f352d06dda0102260f6bfce"><div class="ttname"><a href="class_physical_layer.html#a67ee4ec36f352d06dda0102260f6bfce">PhysicalLayer::clearPacketSentAction</a></div><div class="ttdeci">virtual void clearPacketSentAction()</div><div class="ttdoc">Clears interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:473</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a6c71cdc1238e1368274670758431a977"><div class="ttname"><a href="class_physical_layer.html#a6c71cdc1238e1368274670758431a977">PhysicalLayer::setSyncWord</a></div><div class="ttdeci">virtual int16_t setSyncWord(uint8_t *sync, size_t len)</div><div class="ttdoc">Set sync word. Must be implemented in module class if the module supports it.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:259</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a6ee1fed6bbb8d3571974153ac6f26751"><div class="ttname"><a href="class_physical_layer.html#a6ee1fed6bbb8d3571974153ac6f26751">PhysicalLayer::setDataRate</a></div><div class="ttdeci">virtual int16_t setDataRate(DataRate_t dr)</div><div class="ttdoc">Set data. Must be implemented in module class if the module supports it.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:270</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a7edf27f03600b96f72f011fc82fa4ef9"><div class="ttname"><a href="class_physical_layer.html#a7edf27f03600b96f72f011fc82fa4ef9">PhysicalLayer::clearPacketReceivedAction</a></div><div class="ttdeci">virtual void clearPacketReceivedAction()</div><div class="ttdoc">Clears interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:465</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a85db1ff64e6c56e054f276c511194633"><div class="ttname"><a href="class_physical_layer.html#a85db1ff64e6c56e054f276c511194633">PhysicalLayer::setPreambleLength</a></div><div class="ttdeci">virtual int16_t setPreambleLength(size_t len)</div><div class="ttdoc">Set preamble length. Must be implemented in module class if the module supports it.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:265</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:360</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:224</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:394</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:149</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:280</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:215</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_aabc94ab27a9ee6daaafa9b47dde5f75b"><div class="ttname"><a href="class_physical_layer.html#aabc94ab27a9ee6daaafa9b47dde5f75b">PhysicalLayer::getRSSI</a></div><div class="ttdeci">virtual float getRSSI()</div><div class="ttdoc">Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:289</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:375</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::receive</a></div><div class="ttdeci">virtual int16_t receive(uint8_t *data, size_t len)</div><div class="ttdoc">Binary receive method. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:112</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_abd9e39cc745acbf084cfa0d3f4d10718"><div class="ttname"><a href="class_physical_layer.html#abd9e39cc745acbf084cfa0d3f4d10718">PhysicalLayer::scanChannel</a></div><div class="ttdeci">virtual int16_t scanChannel()</div><div class="ttdoc">Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules,...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:325</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 received in direct mode....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:445</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:244</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_acb8d8182a32439fe91f2806d73e629f4"><div class="ttname"><a href="class_physical_layer.html#acb8d8182a32439fe91f2806d73e629f4">PhysicalLayer::isRxTimeout</a></div><div class="ttdeci">virtual bool isRxTimeout()</div><div class="ttdoc">Check whether the IRQ bit for RxTimeout is set.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:313</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:122</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:329</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_acda61fc99cfa373153c50c78380ed885"><div class="ttname"><a href="class_physical_layer.html#acda61fc99cfa373153c50c78380ed885">PhysicalLayer::readBit</a></div><div class="ttdeci">virtual void readBit(uint32_t 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:449</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_ad2286dc78dbf8e3084f38e9159b99ae5"><div class="ttname"><a href="class_physical_layer.html#ad2286dc78dbf8e3084f38e9159b99ae5">PhysicalLayer::setOutputPower</a></div><div class="ttdeci">virtual int16_t setOutputPower(int8_t power)</div><div class="ttdoc">Set output power. Must be implemented in module class if the module supports it.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:254</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:220</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_add63d7d4fa8b14df5e185813794a49d5"><div class="ttname"><a href="class_physical_layer.html#add63d7d4fa8b14df5e185813794a49d5">PhysicalLayer::PhysicalLayer</a></div><div class="ttdeci">PhysicalLayer(float step, size_t maxLen)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:4</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_ae11c191a7edf3116bf468b9153237260"><div class="ttname"><a href="class_physical_layer.html#ae11c191a7edf3116bf468b9153237260">PhysicalLayer::setChannelScanAction</a></div><div class="ttdeci">virtual void setChannelScanAction(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when a channel scan is finished.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:477</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_ae30dfbb5445bb674898fc54f5f90b2f9"><div class="ttname"><a href="class_physical_layer.html#ae30dfbb5445bb674898fc54f5f90b2f9">PhysicalLayer::startChannelScan</a></div><div class="ttdeci">virtual int16_t startChannelScan()</div><div class="ttdoc">Interrupt-driven channel activity detection method. interrupt will be activated when packet is detect...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:317</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:239</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_aec928bb26f65752aa20cd236fbabb95c"><div class="ttname"><a href="class_physical_layer.html#aec928bb26f65752aa20cd236fbabb95c">PhysicalLayer::setPacketReceivedAction</a></div><div class="ttdeci">virtual void setPacketReceivedAction(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:461</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:229</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_aedddaf9460941b90e43e9005035faa0f"><div class="ttname"><a href="class_physical_layer.html#aedddaf9460941b90e43e9005035faa0f">PhysicalLayer::getSNR</a></div><div class="ttdeci">virtual float getSNR()</div><div class="ttdoc">Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:293</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_af1bb9a5da26da8829795ebb72e9c666e"><div class="ttname"><a href="class_physical_layer.html#af1bb9a5da26da8829795ebb72e9c666e">PhysicalLayer::sleep</a></div><div class="ttdeci">virtual int16_t sleep()</div><div class="ttdoc">Sets module to sleep.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:118</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:17</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:117</div></div>
|
|
<div class="ttc" id="astruct_f_s_k_rate__t_html"><div class="ttname"><a href="struct_f_s_k_rate__t.html">FSKRate_t</a></div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:15</div></div>
|
|
<div class="ttc" id="astruct_lo_ra_rate__t_html"><div class="ttname"><a href="struct_lo_ra_rate__t.html">LoRaRate_t</a></div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:8</div></div>
|
|
<div class="ttc" id="aunion_data_rate__t_html"><div class="ttname"><a href="union_data_rate__t.html">DataRate_t</a></div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:21</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>
|