478 lines
89 KiB
HTML
478 lines
89 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">// common IRQ values - the IRQ flags in RadioLibIrqFlags_t arguments are offset by this value</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="keyword">enum</span> RadioLibIrqType_t {</div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  RADIOLIB_IRQ_TX_DONE = 0x00,</div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  RADIOLIB_IRQ_RX_DONE = 0x01,</div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  RADIOLIB_IRQ_PREAMBLE_DETECTED = 0x02,</div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  RADIOLIB_IRQ_SYNC_WORD_VALID = 0x03,</div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  RADIOLIB_IRQ_HEADER_VALID = 0x04,</div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  RADIOLIB_IRQ_HEADER_ERR = 0x05,</div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  RADIOLIB_IRQ_CRC_ERR = 0x06,</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  RADIOLIB_IRQ_CAD_DONE = 0x07,</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  RADIOLIB_IRQ_CAD_DETECTED = 0x08,</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  RADIOLIB_IRQ_TIMEOUT = 0x09,</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  RADIOLIB_IRQ_NOT_SUPPORTED = 0x1F, <span class="comment">// this must be the last value, intentionally set to 31</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> };</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// some commonly used default values - defined here to ensure all modules have the same default behavior</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define RADIOLIB_IRQ_RX_DEFAULT_FLAGS ((1UL << RADIOLIB_IRQ_RX_DONE) | (1UL << RADIOLIB_IRQ_TIMEOUT) | (1UL << RADIOLIB_IRQ_CRC_ERR) | (1UL << RADIOLIB_IRQ_HEADER_VALID) | (1UL << RADIOLIB_IRQ_HEADER_ERR))</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define RADIOLIB_IRQ_RX_DEFAULT_MASK ((1UL << RADIOLIB_IRQ_RX_DONE))</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define RADIOLIB_IRQ_CAD_DEFAULT_FLAGS ((1UL << RADIOLIB_IRQ_CAD_DETECTED) | (1UL << RADIOLIB_IRQ_CAD_DONE))</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define RADIOLIB_IRQ_CAD_DEFAULT_MASK ((1UL << RADIOLIB_IRQ_CAD_DETECTED) | (1UL << RADIOLIB_IRQ_CAD_DONE))</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="struct_lo_ra_rate__t.html"> 32</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="l00034"></a><span class="lineno"><a class="line" href="struct_lo_ra_rate__t.html#a24fcb6220c0577f985478dc109750076"> 34</a></span>  uint8_t <a class="code" href="struct_lo_ra_rate__t.html#a24fcb6220c0577f985478dc109750076">spreadingFactor</a>;</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="struct_lo_ra_rate__t.html#a97626ff6c8f659ecad84734cca7a87b1"> 37</a></span>  <span class="keywordtype">float</span> <a class="code" href="struct_lo_ra_rate__t.html#a97626ff6c8f659ecad84734cca7a87b1">bandwidth</a>;</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="struct_lo_ra_rate__t.html#ae382629257949329b2fcb01d565183df"> 40</a></span>  uint8_t <a class="code" href="struct_lo_ra_rate__t.html#ae382629257949329b2fcb01d565183df">codingRate</a>;</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> };</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="struct_f_s_k_rate__t.html"> 47</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="l00049"></a><span class="lineno"><a class="line" href="struct_f_s_k_rate__t.html#a2500c6dee65326b52d4e58ecf4b6d107"> 49</a></span>  <span class="keywordtype">float</span> <a class="code" href="struct_f_s_k_rate__t.html#a2500c6dee65326b52d4e58ecf4b6d107">bitRate</a>;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="struct_f_s_k_rate__t.html#a9d8801cd6a3533922db9410f81e2a244"> 52</a></span>  <span class="keywordtype">float</span> <a class="code" href="struct_f_s_k_rate__t.html#a9d8801cd6a3533922db9410f81e2a244">freqDev</a>;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> };</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="struct_lr_fhss_rate__t.html"> 59</a></span> <span class="keyword">struct </span><a class="code" href="struct_lr_fhss_rate__t.html">LrFhssRate_t</a> {</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="struct_lr_fhss_rate__t.html#a965dcb7da1b9adc4818ae9e908585f21"> 61</a></span>  uint8_t <a class="code" href="struct_lr_fhss_rate__t.html#a965dcb7da1b9adc4818ae9e908585f21">bw</a>;</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="struct_lr_fhss_rate__t.html#a3eb7a2c2f4f23face4d6706aa8084c6b"> 64</a></span>  uint8_t <a class="code" href="struct_lr_fhss_rate__t.html#a3eb7a2c2f4f23face4d6706aa8084c6b">cr</a>;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> };</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="union_data_rate__t.html"> 71</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="l00073"></a><span class="lineno"><a class="line" href="union_data_rate__t.html#ab25c3fcaf1934cd9d6d5e9820749137d"> 73</a></span>  <a class="code" href="struct_lo_ra_rate__t.html">LoRaRate_t</a> <a class="code" href="union_data_rate__t.html#ab25c3fcaf1934cd9d6d5e9820749137d">lora</a>;</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="union_data_rate__t.html#abfa0cbc4b33c49435e67662b6e6027cf"> 76</a></span>  <a class="code" href="struct_f_s_k_rate__t.html">FSKRate_t</a> <a class="code" href="union_data_rate__t.html#abfa0cbc4b33c49435e67662b6e6027cf">fsk</a>;</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> };</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="struct_c_a_d_scan_config__t.html"> 83</a></span> <span class="keyword">struct </span><a class="code" href="struct_c_a_d_scan_config__t.html">CADScanConfig_t</a> {</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="struct_c_a_d_scan_config__t.html#a5cb000f071f740c8cc81ea2f04dd9b60"> 85</a></span>  uint8_t <a class="code" href="struct_c_a_d_scan_config__t.html#a5cb000f071f740c8cc81ea2f04dd9b60">symNum</a>;</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="struct_c_a_d_scan_config__t.html#a474cc14f2a00ff351aac5aa0f3fa4e3a"> 88</a></span>  uint8_t <a class="code" href="struct_c_a_d_scan_config__t.html#a474cc14f2a00ff351aac5aa0f3fa4e3a">detPeak</a>;</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="struct_c_a_d_scan_config__t.html#af44adcf8659f5e3f861f4b29e9a997d1"> 91</a></span>  uint8_t <a class="code" href="struct_c_a_d_scan_config__t.html#af44adcf8659f5e3f861f4b29e9a997d1">detMin</a>;</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="struct_c_a_d_scan_config__t.html#a7830e01090d9a95d71cc6546d2dce3c1"> 94</a></span>  uint8_t <a class="code" href="struct_c_a_d_scan_config__t.html#a7830e01090d9a95d71cc6546d2dce3c1">exitMode</a>;</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="struct_c_a_d_scan_config__t.html#a44223617e2d046318e75f863c618e26c"> 97</a></span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> <a class="code" href="struct_c_a_d_scan_config__t.html#a44223617e2d046318e75f863c618e26c">timeout</a>;</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="struct_c_a_d_scan_config__t.html#ab390fd53aba1e32ae1b41aae4aa835a5"> 100</a></span>  <a class="code" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> <a class="code" href="struct_c_a_d_scan_config__t.html#ab390fd53aba1e32ae1b41aae4aa835a5">irqFlags</a>;</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  </div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="struct_c_a_d_scan_config__t.html#ae86870cda342f39ad417abdfcb832ac3"> 103</a></span>  <a class="code" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> <a class="code" href="struct_c_a_d_scan_config__t.html#ae86870cda342f39ad417abdfcb832ac3">irqMask</a>;</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> };</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="struct_r_s_s_i_scan_config__t.html"> 110</a></span> <span class="keyword">struct </span><a class="code" href="struct_r_s_s_i_scan_config__t.html">RSSIScanConfig_t</a> {</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="struct_r_s_s_i_scan_config__t.html#a8a9bf05648e82b49d43d6275ecf3cc3b"> 112</a></span>  <span class="keywordtype">float</span> <a class="code" href="struct_r_s_s_i_scan_config__t.html#a8a9bf05648e82b49d43d6275ecf3cc3b">limit</a>;</div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> };</div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  </div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="union_channel_scan_config__t.html"> 119</a></span> <span class="keyword">union </span><a class="code" href="union_channel_scan_config__t.html">ChannelScanConfig_t</a> {</div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="union_channel_scan_config__t.html#ad9cdc4ce1a4664a12802d1e652c9e098"> 121</a></span>  <a class="code" href="struct_c_a_d_scan_config__t.html">CADScanConfig_t</a> <a class="code" href="union_channel_scan_config__t.html#ad9cdc4ce1a4664a12802d1e652c9e098">cad</a>;</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  </div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"><a class="line" href="union_channel_scan_config__t.html#ad728b1bd8f0410660f51df0b27f2797e"> 124</a></span>  <a class="code" href="struct_r_s_s_i_scan_config__t.html">RSSIScanConfig_t</a> <a class="code" href="union_channel_scan_config__t.html#ad728b1bd8f0410660f51df0b27f2797e">rssi</a>;</div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> };</div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="class_physical_layer.html"> 135</a></span> <span class="keyword">class </span><a class="code" href="class_physical_layer.html">PhysicalLayer</a> {</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  </div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="comment">// constructor</span></div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  </div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</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="l00146"></a><span class="lineno"> 146</span>  </div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="comment">// basic methods</span></div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  </div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</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="l00157"></a><span class="lineno"> 157</span>  </div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</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="l00165"></a><span class="lineno"> 165</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  </div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</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="l00174"></a><span class="lineno"> 174</span>  </div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">transmit</a>(<span class="keyword">const</span> uint8_t* data, <span class="keywordtype">size_t</span> len, uint8_t addr = 0);</div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  </div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</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="l00192"></a><span class="lineno"> 192</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</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#af1bb9a5da26da8829795ebb72e9c666e">sleep</a>();</div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  </div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"> 204</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="l00205"></a><span class="lineno"> 205</span>  </div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</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="l00211"></a><span class="lineno"> 211</span>  </div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a18664ad615c5507ff1690baaca90b094">startReceive</a>();</div>
|
|
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  </div>
|
|
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a18664ad615c5507ff1690baaca90b094">startReceive</a>(uint32_t timeout, <a class="code" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> irqFlags, <a class="code" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> irqMask, <span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00229"></a><span class="lineno"> 229</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#ab82617fa3fa9f21d4cd427314ecc4af8">receive</a>(uint8_t* data, <span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  </div>
|
|
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00246"></a><span class="lineno"> 246</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="l00247"></a><span class="lineno"> 247</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  </div>
|
|
<div class="line"><a name="l00256"></a><span class="lineno"> 256</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="l00257"></a><span class="lineno"> 257</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#a923654706eff5118ef6e84214e837f27">startTransmit</a>(<span class="keyword">const</span> uint8_t* data, <span class="keywordtype">size_t</span> len, uint8_t addr = 0);</div>
|
|
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  </div>
|
|
<div class="line"><a name="l00271"></a><span class="lineno"> 271</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="l00272"></a><span class="lineno"> 272</span>  </div>
|
|
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00281"></a><span class="lineno"> 281</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="l00282"></a><span class="lineno"> 282</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  </div>
|
|
<div class="line"><a name="l00291"></a><span class="lineno"> 291</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="l00292"></a><span class="lineno"> 292</span>  </div>
|
|
<div class="line"><a name="l00299"></a><span class="lineno"> 299</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="l00300"></a><span class="lineno"> 300</span>  </div>
|
|
<div class="line"><a name="l00306"></a><span class="lineno"> 306</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="l00307"></a><span class="lineno"> 307</span>  </div>
|
|
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  <span class="comment">// configuration methods</span></div>
|
|
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  </div>
|
|
<div class="line"><a name="l00315"></a><span class="lineno"> 315</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="l00316"></a><span class="lineno"> 316</span>  </div>
|
|
<div class="line"><a name="l00322"></a><span class="lineno"> 322</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="l00323"></a><span class="lineno"> 323</span>  </div>
|
|
<div class="line"><a name="l00330"></a><span class="lineno"> 330</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="l00331"></a><span class="lineno"> 331</span>  </div>
|
|
<div class="line"><a name="l00337"></a><span class="lineno"> 337</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="l00338"></a><span class="lineno"> 338</span>  </div>
|
|
<div class="line"><a name="l00344"></a><span class="lineno"> 344</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="l00345"></a><span class="lineno"> 345</span>  </div>
|
|
<div class="line"><a name="l00351"></a><span class="lineno"> 351</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="l00352"></a><span class="lineno"> 352</span>  </div>
|
|
<div class="line"><a name="l00358"></a><span class="lineno"> 358</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="l00359"></a><span class="lineno"> 359</span>  </div>
|
|
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a1784cb227d04b3f2846625fda6797536">checkOutputPower</a>(int8_t power, int8_t* clipped);</div>
|
|
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>  </div>
|
|
<div class="line"><a name="l00374"></a><span class="lineno"> 374</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="l00375"></a><span class="lineno"> 375</span>  </div>
|
|
<div class="line"><a name="l00381"></a><span class="lineno"> 381</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="l00382"></a><span class="lineno"> 382</span>  </div>
|
|
<div class="line"><a name="l00388"></a><span class="lineno"> 388</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="l00389"></a><span class="lineno"> 389</span>  </div>
|
|
<div class="line"><a name="l00395"></a><span class="lineno"> 395</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="l00396"></a><span class="lineno"> 396</span>  </div>
|
|
<div class="line"><a name="l00401"></a><span class="lineno"> 401</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="l00402"></a><span class="lineno"> 402</span>  </div>
|
|
<div class="line"><a name="l00408"></a><span class="lineno"> 408</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="l00409"></a><span class="lineno"> 409</span>  </div>
|
|
<div class="line"><a name="l00414"></a><span class="lineno"> 414</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="l00415"></a><span class="lineno"> 415</span>  </div>
|
|
<div class="line"><a name="l00420"></a><span class="lineno"> 420</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="l00421"></a><span class="lineno"> 421</span>  </div>
|
|
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span>  <span class="keyword">virtual</span> <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> <a class="code" href="class_physical_layer.html#a50e730a894f60b58034507ad7730dd3c">getTimeOnAir</a>(<span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span>  </div>
|
|
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span>  <span class="keyword">virtual</span> <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> <a class="code" href="class_physical_layer.html#a7f8d12a90158864a8ebc471b0ec89dc9">calculateRxTimeout</a>(<a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> timeoutUs);</div>
|
|
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span>  </div>
|
|
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span>  uint32_t <a class="code" href="class_physical_layer.html#ae602ebd46d60da8670c9f353cef695d9">getIrqMapped</a>(<a class="code" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> irq);</div>
|
|
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span>  </div>
|
|
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span>  int16_t <a class="code" href="class_physical_layer.html#a2c7dd4704e3df353265010710bd26e83">checkIrq</a>(RadioLibIrqType_t irq);</div>
|
|
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  </div>
|
|
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span>  int16_t <a class="code" href="class_physical_layer.html#a8564f9834a0247e93e7620c23559ceb8">setIrq</a>(<a class="code" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> irq);</div>
|
|
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span>  </div>
|
|
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span>  int16_t <a class="code" href="class_physical_layer.html#af9a7e739e39705a72ffa8b63ec09bb15">clearIrq</a>(<a class="code" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> irq);</div>
|
|
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span>  </div>
|
|
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span>  <span class="keyword">virtual</span> uint32_t <a class="code" href="class_physical_layer.html#af1caeed34b2e2ff0355467507106a1a2">getIrqFlags</a>();</div>
|
|
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span>  </div>
|
|
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#af88dcb54dc8e9a1edaf9f1c3e5ee2b74">setIrqFlags</a>(uint32_t irq);</div>
|
|
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span>  </div>
|
|
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#ac282bb78da4f4da4661dce191cbd6d87">clearIrqFlags</a>(uint32_t irq);</div>
|
|
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span>  </div>
|
|
<div class="line"><a name="l00497"></a><span class="lineno"> 497</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="l00498"></a><span class="lineno"> 498</span>  </div>
|
|
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#ae30dfbb5445bb674898fc54f5f90b2f9">startChannelScan</a>(<span class="keyword">const</span> <a class="code" href="union_channel_scan_config__t.html">ChannelScanConfig_t</a> &config);</div>
|
|
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span>  </div>
|
|
<div class="line"><a name="l00511"></a><span class="lineno"> 511</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="l00512"></a><span class="lineno"> 512</span>  </div>
|
|
<div class="line"><a name="l00519"></a><span class="lineno"> 519</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="l00520"></a><span class="lineno"> 520</span>  </div>
|
|
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#abd9e39cc745acbf084cfa0d3f4d10718">scanChannel</a>(<span class="keyword">const</span> <a class="code" href="union_channel_scan_config__t.html">ChannelScanConfig_t</a> &config);</div>
|
|
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span>  </div>
|
|
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span>  int32_t <a class="code" href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">random</a>(int32_t max);</div>
|
|
<div class="line"><a name="l00536"></a><span class="lineno"> 536</span>  </div>
|
|
<div class="line"><a name="l00543"></a><span class="lineno"> 543</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="l00544"></a><span class="lineno"> 544</span>  </div>
|
|
<div class="line"><a name="l00549"></a><span class="lineno"> 549</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="l00550"></a><span class="lineno"> 550</span>  </div>
|
|
<div class="line"><a name="l00556"></a><span class="lineno"> 556</span>  int16_t <a class="code" href="class_physical_layer.html#a88a10657bd2215a11a2331f937414b55">startDirect</a>();</div>
|
|
<div class="line"><a name="l00557"></a><span class="lineno"> 557</span>  </div>
|
|
<div class="line"><a name="l00558"></a><span class="lineno"> 558</span> <span class="preprocessor"> #if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE</span></div>
|
|
<div class="line"><a name="l00565"></a><span class="lineno"> 565</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="l00566"></a><span class="lineno"> 566</span>  </div>
|
|
<div class="line"><a name="l00572"></a><span class="lineno"> 572</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="l00573"></a><span class="lineno"> 573</span>  </div>
|
|
<div class="line"><a name="l00578"></a><span class="lineno"> 578</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="l00579"></a><span class="lineno"> 579</span>  </div>
|
|
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span>  int16_t <a class="code" href="class_physical_layer.html#ab57182d32646861ef0d865e2740d6b26">available</a>();</div>
|
|
<div class="line"><a name="l00585"></a><span class="lineno"> 585</span>  </div>
|
|
<div class="line"><a name="l00589"></a><span class="lineno"> 589</span>  <span class="keywordtype">void</span> <a class="code" href="class_physical_layer.html#a429796eb2e7ea86781a2e8ca42af43f3">dropSync</a>();</div>
|
|
<div class="line"><a name="l00590"></a><span class="lineno"> 590</span>  </div>
|
|
<div class="line"><a name="l00597"></a><span class="lineno"> 597</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="l00598"></a><span class="lineno"> 598</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00599"></a><span class="lineno"> 599</span>  </div>
|
|
<div class="line"><a name="l00606"></a><span class="lineno"> 606</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="l00607"></a><span class="lineno"> 607</span>  </div>
|
|
<div class="line"><a name="l00612"></a><span class="lineno"> 612</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="l00613"></a><span class="lineno"> 613</span>  </div>
|
|
<div class="line"><a name="l00617"></a><span class="lineno"> 617</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="l00618"></a><span class="lineno"> 618</span>  </div>
|
|
<div class="line"><a name="l00623"></a><span class="lineno"> 623</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="l00624"></a><span class="lineno"> 624</span>  </div>
|
|
<div class="line"><a name="l00628"></a><span class="lineno"> 628</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="l00629"></a><span class="lineno"> 629</span>  </div>
|
|
<div class="line"><a name="l00634"></a><span class="lineno"> 634</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="l00635"></a><span class="lineno"> 635</span>  </div>
|
|
<div class="line"><a name="l00639"></a><span class="lineno"> 639</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="l00640"></a><span class="lineno"> 640</span>  </div>
|
|
<div class="line"><a name="l00641"></a><span class="lineno"> 641</span> <span class="preprocessor"> #if RADIOLIB_INTERRUPT_TIMING</span></div>
|
|
<div class="line"><a name="l00642"></a><span class="lineno"> 642</span>  </div>
|
|
<div class="line"><a name="l00648"></a><span class="lineno"> 648</span>  <span class="keywordtype">void</span> setInterruptSetup(<span class="keywordtype">void</span> (*func)(uint32_t));</div>
|
|
<div class="line"><a name="l00649"></a><span class="lineno"> 649</span>  </div>
|
|
<div class="line"><a name="l00654"></a><span class="lineno"> 654</span>  <span class="keywordtype">void</span> setTimerFlag();</div>
|
|
<div class="line"><a name="l00655"></a><span class="lineno"> 655</span>  </div>
|
|
<div class="line"><a name="l00656"></a><span class="lineno"> 656</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00657"></a><span class="lineno"> 657</span>  </div>
|
|
<div class="line"><a name="l00658"></a><span class="lineno"> 658</span> <span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
|
|
<div class="line"><a name="l00659"></a><span class="lineno"> 659</span>  <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00660"></a><span class="lineno"> 660</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00661"></a><span class="lineno"> 661</span>  uint32_t irqMap[10] = { 0 };</div>
|
|
<div class="line"><a name="l00662"></a><span class="lineno"> 662</span>  </div>
|
|
<div class="line"><a name="l00663"></a><span class="lineno"> 663</span> <span class="preprocessor">#if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE</span></div>
|
|
<div class="line"><a name="l00664"></a><span class="lineno"> 664</span>  <span class="keywordtype">void</span> updateDirectBuffer(uint8_t bit);</div>
|
|
<div class="line"><a name="l00665"></a><span class="lineno"> 665</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00666"></a><span class="lineno"> 666</span>  </div>
|
|
<div class="line"><a name="l00667"></a><span class="lineno"> 667</span> <span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
|
|
<div class="line"><a name="l00668"></a><span class="lineno"> 668</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00669"></a><span class="lineno"> 669</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00670"></a><span class="lineno"> 670</span>  <span class="keywordtype">float</span> freqStep;</div>
|
|
<div class="line"><a name="l00671"></a><span class="lineno"> 671</span>  <span class="keywordtype">size_t</span> maxPacketLength;</div>
|
|
<div class="line"><a name="l00672"></a><span class="lineno"> 672</span>  </div>
|
|
<div class="line"><a name="l00673"></a><span class="lineno"> 673</span> <span class="preprocessor"> #if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE</span></div>
|
|
<div class="line"><a name="l00674"></a><span class="lineno"> 674</span>  uint8_t bufferBitPos = 0;</div>
|
|
<div class="line"><a name="l00675"></a><span class="lineno"> 675</span>  uint8_t bufferWritePos = 0;</div>
|
|
<div class="line"><a name="l00676"></a><span class="lineno"> 676</span>  uint8_t bufferReadPos = 0;</div>
|
|
<div class="line"><a name="l00677"></a><span class="lineno"> 677</span>  uint8_t buffer[RADIOLIB_STATIC_ARRAY_SIZE] = { 0 };</div>
|
|
<div class="line"><a name="l00678"></a><span class="lineno"> 678</span>  uint32_t syncBuffer = 0;</div>
|
|
<div class="line"><a name="l00679"></a><span class="lineno"> 679</span>  uint32_t directSyncWord = 0;</div>
|
|
<div class="line"><a name="l00680"></a><span class="lineno"> 680</span>  uint8_t directSyncWordLen = 0;</div>
|
|
<div class="line"><a name="l00681"></a><span class="lineno"> 681</span>  uint32_t directSyncWordMask = 0;</div>
|
|
<div class="line"><a name="l00682"></a><span class="lineno"> 682</span>  <span class="keywordtype">bool</span> gotSync = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00683"></a><span class="lineno"> 683</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00684"></a><span class="lineno"> 684</span>  </div>
|
|
<div class="line"><a name="l00685"></a><span class="lineno"> 685</span>  <span class="keyword">virtual</span> <a class="code" href="class_module.html">Module</a>* getMod() = 0;</div>
|
|
<div class="line"><a name="l00686"></a><span class="lineno"> 686</span>  </div>
|
|
<div class="line"><a name="l00687"></a><span class="lineno"> 687</span>  <span class="comment">// allow specific classes access the private getMod method</span></div>
|
|
<div class="line"><a name="l00688"></a><span class="lineno"> 688</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="l00689"></a><span class="lineno"> 689</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="l00690"></a><span class="lineno"> 690</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="l00691"></a><span class="lineno"> 691</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="l00692"></a><span class="lineno"> 692</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="l00693"></a><span class="lineno"> 693</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="l00694"></a><span class="lineno"> 694</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="l00695"></a><span class="lineno"> 695</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="l00696"></a><span class="lineno"> 696</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="l00697"></a><span class="lineno"> 697</span>  <span class="keyword">friend</span> <span class="keyword">class </span>FT8Client;</div>
|
|
<div class="line"><a name="l00698"></a><span class="lineno"> 698</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="l00699"></a><span class="lineno"> 699</span> };</div>
|
|
<div class="line"><a name="l00700"></a><span class="lineno"> 700</span>  </div>
|
|
<div class="line"><a name="l00701"></a><span class="lineno"> 701</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:233</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:524</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:65</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:135</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:529</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a1784cb227d04b3f2846625fda6797536"><div class="ttname"><a href="class_physical_layer.html#a1784cb227d04b3f2846625fda6797536">PhysicalLayer::checkOutputPower</a></div><div class="ttdeci">virtual int16_t checkOutputPower(int8_t power, int8_t *clipped)</div><div class="ttdoc">Check if output power is configurable. 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_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:404</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_a2c7dd4704e3df353265010710bd26e83"><div class="ttname"><a href="class_physical_layer.html#a2c7dd4704e3df353265010710bd26e83">PhysicalLayer::checkIrq</a></div><div class="ttdeci">int16_t checkIrq(RadioLibIrqType_t irq)</div><div class="ttdoc">Check whether a specific IRQ bit is set (e.g. RxTimeout, CadDone).</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:325</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:290</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:517</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:503</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:427</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:434</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a50e730a894f60b58034507ad7730dd3c"><div class="ttname"><a href="class_physical_layer.html#a50e730a894f60b58034507ad7730dd3c">PhysicalLayer::getTimeOnAir</a></div><div class="ttdeci">virtual RadioLibTime_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:303</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:281</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:364</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:521</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:265</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:276</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:513</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a7f8d12a90158864a8ebc471b0ec89dc9"><div class="ttname"><a href="class_physical_layer.html#a7f8d12a90158864a8ebc471b0ec89dc9">PhysicalLayer::calculateRxTimeout</a></div><div class="ttdeci">virtual RadioLibTime_t calculateRxTimeout(RadioLibTime_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:308</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_a8564f9834a0247e93e7620c23559ceb8"><div class="ttname"><a href="class_physical_layer.html#a8564f9834a0247e93e7620c23559ceb8">PhysicalLayer::setIrq</a></div><div class="ttdeci">int16_t setIrq(RadioLibIrqFlags_t irq)</div><div class="ttdoc">Set interrupt on specific IRQ bit(s) (e.g. RxTimeout, CadDone). Keep in mind that not all radio modul...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:333</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:271</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:408</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:442</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:286</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:295</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:423</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:368</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:493</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_ac282bb78da4f4da4661dce191cbd6d87"><div class="ttname"><a href="class_physical_layer.html#ac282bb78da4f4da4661dce191cbd6d87">PhysicalLayer::clearIrqFlags</a></div><div class="ttdeci">virtual int16_t clearIrqFlags(uint32_t irq)</div><div class="ttdoc">Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone). Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:350</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_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:377</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:497</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:525</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:355</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_ae602ebd46d60da8670c9f353cef695d9"><div class="ttname"><a href="class_physical_layer.html#ae602ebd46d60da8670c9f353cef695d9">PhysicalLayer::getIrqMapped</a></div><div class="ttdeci">uint32_t getIrqMapped(RadioLibIrqFlags_t irq)</div><div class="ttdoc">Convert from radio-agnostic IRQ flags to radio-specific flags.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:313</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:509</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:299</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_physical_layer_html_af1caeed34b2e2ff0355467507106a1a2"><div class="ttname"><a href="class_physical_layer.html#af1caeed34b2e2ff0355467507106a1a2">PhysicalLayer::getIrqFlags</a></div><div class="ttdeci">virtual uint32_t getIrqFlags()</div><div class="ttdoc">Read currently active IRQ flags. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:341</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_af88dcb54dc8e9a1edaf9f1c3e5ee2b74"><div class="ttname"><a href="class_physical_layer.html#af88dcb54dc8e9a1edaf9f1c3e5ee2b74">PhysicalLayer::setIrqFlags</a></div><div class="ttdeci">virtual int16_t setIrqFlags(uint32_t irq)</div><div class="ttdoc">Set interrupt on DIO1 to be sent on a specific IRQ bit (e.g. RxTimeout, CadDone). Must be implemented...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:345</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html_af9a7e739e39705a72ffa8b63ec09bb15"><div class="ttname"><a href="class_physical_layer.html#af9a7e739e39705a72ffa8b63ec09bb15">PhysicalLayer::clearIrq</a></div><div class="ttdeci">int16_t clearIrq(RadioLibIrqFlags_t irq)</div><div class="ttdoc">Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone). Keep in mind that not all radio modu...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:337</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:121</div></div>
|
|
<div class="ttc" id="agroup__typedefs_html_ga210f31dd2bff7fb80563275648a5bbbd"><div class="ttname"><a href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a></div><div class="ttdeci">unsigned long RadioLibTime_t</div><div class="ttdoc">Type used for durations in RadioLib.</div><div class="ttdef"><b>Definition:</b> TypeDef.h:616</div></div>
|
|
<div class="ttc" id="agroup__typedefs_html_gafaf66becf1112a55ba8ad7402b802b77"><div class="ttname"><a href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a></div><div class="ttdeci">uint32_t RadioLibIrqFlags_t</div><div class="ttdoc">Type used for radio-agnostic IRQ flags. IRQ to enable corresponds to the bit index (RadioLibIrq_t)....</div><div class="ttdef"><b>Definition:</b> TypeDef.h:622</div></div>
|
|
<div class="ttc" id="astruct_c_a_d_scan_config__t_html"><div class="ttname"><a href="struct_c_a_d_scan_config__t.html">CADScanConfig_t</a></div><div class="ttdoc">Channel scan configuration interpretation in case LoRa CAD is used.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:83</div></div>
|
|
<div class="ttc" id="astruct_c_a_d_scan_config__t_html_a44223617e2d046318e75f863c618e26c"><div class="ttname"><a href="struct_c_a_d_scan_config__t.html#a44223617e2d046318e75f863c618e26c">CADScanConfig_t::timeout</a></div><div class="ttdeci">RadioLibTime_t timeout</div><div class="ttdoc">Timeout in microseconds.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:97</div></div>
|
|
<div class="ttc" id="astruct_c_a_d_scan_config__t_html_a474cc14f2a00ff351aac5aa0f3fa4e3a"><div class="ttname"><a href="struct_c_a_d_scan_config__t.html#a474cc14f2a00ff351aac5aa0f3fa4e3a">CADScanConfig_t::detPeak</a></div><div class="ttdeci">uint8_t detPeak</div><div class="ttdoc">Number of peak detection symbols.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:88</div></div>
|
|
<div class="ttc" id="astruct_c_a_d_scan_config__t_html_a5cb000f071f740c8cc81ea2f04dd9b60"><div class="ttname"><a href="struct_c_a_d_scan_config__t.html#a5cb000f071f740c8cc81ea2f04dd9b60">CADScanConfig_t::symNum</a></div><div class="ttdeci">uint8_t symNum</div><div class="ttdoc">Number of symbols to consider signal present.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:85</div></div>
|
|
<div class="ttc" id="astruct_c_a_d_scan_config__t_html_a7830e01090d9a95d71cc6546d2dce3c1"><div class="ttname"><a href="struct_c_a_d_scan_config__t.html#a7830e01090d9a95d71cc6546d2dce3c1">CADScanConfig_t::exitMode</a></div><div class="ttdeci">uint8_t exitMode</div><div class="ttdoc">Exit mode after signal detection is complete - module-specific value.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:94</div></div>
|
|
<div class="ttc" id="astruct_c_a_d_scan_config__t_html_ab390fd53aba1e32ae1b41aae4aa835a5"><div class="ttname"><a href="struct_c_a_d_scan_config__t.html#ab390fd53aba1e32ae1b41aae4aa835a5">CADScanConfig_t::irqFlags</a></div><div class="ttdeci">RadioLibIrqFlags_t irqFlags</div><div class="ttdoc">Optional IRQ flags to set, bits offset by the value of RADIOLIB_IRQ_.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:100</div></div>
|
|
<div class="ttc" id="astruct_c_a_d_scan_config__t_html_ae86870cda342f39ad417abdfcb832ac3"><div class="ttname"><a href="struct_c_a_d_scan_config__t.html#ae86870cda342f39ad417abdfcb832ac3">CADScanConfig_t::irqMask</a></div><div class="ttdeci">RadioLibIrqFlags_t irqMask</div><div class="ttdoc">Optional IRQ mask to set, bits offset by the value of RADIOLIB_IRQ_.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:103</div></div>
|
|
<div class="ttc" id="astruct_c_a_d_scan_config__t_html_af44adcf8659f5e3f861f4b29e9a997d1"><div class="ttname"><a href="struct_c_a_d_scan_config__t.html#af44adcf8659f5e3f861f4b29e9a997d1">CADScanConfig_t::detMin</a></div><div class="ttdeci">uint8_t detMin</div><div class="ttdoc">Number of minimum detection symbols.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:91</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="ttdoc">Data rate structure interpretation in case FSK is used.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:47</div></div>
|
|
<div class="ttc" id="astruct_f_s_k_rate__t_html_a2500c6dee65326b52d4e58ecf4b6d107"><div class="ttname"><a href="struct_f_s_k_rate__t.html#a2500c6dee65326b52d4e58ecf4b6d107">FSKRate_t::bitRate</a></div><div class="ttdeci">float bitRate</div><div class="ttdoc">FSK bit rate in kbps.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:49</div></div>
|
|
<div class="ttc" id="astruct_f_s_k_rate__t_html_a9d8801cd6a3533922db9410f81e2a244"><div class="ttname"><a href="struct_f_s_k_rate__t.html#a9d8801cd6a3533922db9410f81e2a244">FSKRate_t::freqDev</a></div><div class="ttdeci">float freqDev</div><div class="ttdoc">FSK frequency deviation in kHz.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:52</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="ttdoc">Data rate structure interpretation in case LoRa is used.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:32</div></div>
|
|
<div class="ttc" id="astruct_lo_ra_rate__t_html_a24fcb6220c0577f985478dc109750076"><div class="ttname"><a href="struct_lo_ra_rate__t.html#a24fcb6220c0577f985478dc109750076">LoRaRate_t::spreadingFactor</a></div><div class="ttdeci">uint8_t spreadingFactor</div><div class="ttdoc">LoRa spreading factor.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:34</div></div>
|
|
<div class="ttc" id="astruct_lo_ra_rate__t_html_a97626ff6c8f659ecad84734cca7a87b1"><div class="ttname"><a href="struct_lo_ra_rate__t.html#a97626ff6c8f659ecad84734cca7a87b1">LoRaRate_t::bandwidth</a></div><div class="ttdeci">float bandwidth</div><div class="ttdoc">LoRa bandwidth in kHz.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:37</div></div>
|
|
<div class="ttc" id="astruct_lo_ra_rate__t_html_ae382629257949329b2fcb01d565183df"><div class="ttname"><a href="struct_lo_ra_rate__t.html#ae382629257949329b2fcb01d565183df">LoRaRate_t::codingRate</a></div><div class="ttdeci">uint8_t codingRate</div><div class="ttdoc">LoRa coding rate.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:40</div></div>
|
|
<div class="ttc" id="astruct_lr_fhss_rate__t_html"><div class="ttname"><a href="struct_lr_fhss_rate__t.html">LrFhssRate_t</a></div><div class="ttdoc">Data rate structure interpretation in case LR-FHSS is used.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:59</div></div>
|
|
<div class="ttc" id="astruct_lr_fhss_rate__t_html_a3eb7a2c2f4f23face4d6706aa8084c6b"><div class="ttname"><a href="struct_lr_fhss_rate__t.html#a3eb7a2c2f4f23face4d6706aa8084c6b">LrFhssRate_t::cr</a></div><div class="ttdeci">uint8_t cr</div><div class="ttdoc">Coding rate.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:64</div></div>
|
|
<div class="ttc" id="astruct_lr_fhss_rate__t_html_a965dcb7da1b9adc4818ae9e908585f21"><div class="ttname"><a href="struct_lr_fhss_rate__t.html#a965dcb7da1b9adc4818ae9e908585f21">LrFhssRate_t::bw</a></div><div class="ttdeci">uint8_t bw</div><div class="ttdoc">Bandwidth.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:61</div></div>
|
|
<div class="ttc" id="astruct_r_s_s_i_scan_config__t_html"><div class="ttname"><a href="struct_r_s_s_i_scan_config__t.html">RSSIScanConfig_t</a></div><div class="ttdoc">Channel scan configuration interpretation in case RSSI threshold is used.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:110</div></div>
|
|
<div class="ttc" id="astruct_r_s_s_i_scan_config__t_html_a8a9bf05648e82b49d43d6275ecf3cc3b"><div class="ttname"><a href="struct_r_s_s_i_scan_config__t.html#a8a9bf05648e82b49d43d6275ecf3cc3b">RSSIScanConfig_t::limit</a></div><div class="ttdeci">float limit</div><div class="ttdoc">RSSI limit in dBm.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:112</div></div>
|
|
<div class="ttc" id="aunion_channel_scan_config__t_html"><div class="ttname"><a href="union_channel_scan_config__t.html">ChannelScanConfig_t</a></div><div class="ttdoc">Common channel scan configuration structure.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:119</div></div>
|
|
<div class="ttc" id="aunion_channel_scan_config__t_html_ad728b1bd8f0410660f51df0b27f2797e"><div class="ttname"><a href="union_channel_scan_config__t.html#ad728b1bd8f0410660f51df0b27f2797e">ChannelScanConfig_t::rssi</a></div><div class="ttdeci">RSSIScanConfig_t rssi</div><div class="ttdoc">Interpretation for modems that use RSSI threshold.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:124</div></div>
|
|
<div class="ttc" id="aunion_channel_scan_config__t_html_ad9cdc4ce1a4664a12802d1e652c9e098"><div class="ttname"><a href="union_channel_scan_config__t.html#ad9cdc4ce1a4664a12802d1e652c9e098">ChannelScanConfig_t::cad</a></div><div class="ttdeci">CADScanConfig_t cad</div><div class="ttdoc">Interpretation for modems that use CAD (usually LoRa modems)</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:121</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="ttdoc">Common data rate structure.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:71</div></div>
|
|
<div class="ttc" id="aunion_data_rate__t_html_ab25c3fcaf1934cd9d6d5e9820749137d"><div class="ttname"><a href="union_data_rate__t.html#ab25c3fcaf1934cd9d6d5e9820749137d">DataRate_t::lora</a></div><div class="ttdeci">LoRaRate_t lora</div><div class="ttdoc">Interpretation for LoRa modems.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:73</div></div>
|
|
<div class="ttc" id="aunion_data_rate__t_html_abfa0cbc4b33c49435e67662b6e6027cf"><div class="ttname"><a href="union_data_rate__t.html#abfa0cbc4b33c49435e67662b6e6027cf">DataRate_t::fsk</a></div><div class="ttdeci">FSKRate_t fsk</div><div class="ttdoc">Interpretation for FSK modems.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:76</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>
|