2633 lines
164 KiB
HTML
2633 lines
164 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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: PhysicalLayer Class Reference</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 id="projectrow">
|
|
<td id="projectalign">
|
|
<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.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('class_physical_layer.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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="class_physical_layer-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">PhysicalLayer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN. Also extracts some common module-independent methods. Using this interface class allows to use the protocols on various modules without much code duplicity. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class.
|
|
<a href="class_physical_layer.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_physical_layer_8h_source.html">PhysicalLayer.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for PhysicalLayer:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_physical_layer.png" usemap="#PhysicalLayer_map" alt=""/>
|
|
<map id="PhysicalLayer_map" name="PhysicalLayer_map">
|
|
<area href="class_c_c1101.html" title="Control class for CC1101 module." alt="CC1101" shape="rect" coords="103,56,196,80"/>
|
|
<area href="class_external_radio.html" title="Class to interface with external radio hardware." alt="ExternalRadio" shape="rect" coords="103,112,196,136"/>
|
|
<area href="class_l_r11x0.html" title="Base class for LR11x0 series. All derived classes for LR11x0 (e.g. LR1110 or LR1120) inherit from thi..." alt="LR11x0" shape="rect" coords="103,168,196,192"/>
|
|
<area href="class_r_f69.html" title="Control class for RF69 module. Also serves as base class for SX1231." alt="RF69" shape="rect" coords="103,224,196,248"/>
|
|
<area href="class_s_x126x.html" title="Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi..." alt="SX126x" shape="rect" coords="103,280,196,304"/>
|
|
<area href="class_s_x127x.html" title="Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from thi..." alt="SX127x" shape="rect" coords="103,336,196,360"/>
|
|
<area href="class_s_x128x.html" title="Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from thi..." alt="SX128x" shape="rect" coords="103,392,196,416"/>
|
|
<area href="class_si443x.html" title="Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from thi..." alt="Si443x" shape="rect" coords="103,448,196,472"/>
|
|
<area href="classn_r_f24.html" title="Control class for nRF24 module." alt="nRF24" shape="rect" coords="103,504,196,528"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:afc972a84153977d6ccd9e116b6181ad4" id="r_afc972a84153977d6ccd9e116b6181ad4"><td class="memItemLeft" align="right" valign="top"><a id="afc972a84153977d6ccd9e116b6181ad4" name="afc972a84153977d6ccd9e116b6181ad4"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>PhysicalLayer</b> ()</td></tr>
|
|
<tr class="memdesc:afc972a84153977d6ccd9e116b6181ad4"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:afc972a84153977d6ccd9e116b6181ad4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a492b2d057dd803c3884fa1adc8e22534" id="r_a492b2d057dd803c3884fa1adc8e22534"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">transmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a492b2d057dd803c3884fa1adc8e22534"><td class="mdescLeft"> </td><td class="mdescRight">C-string transmit method. <br /></td></tr>
|
|
<tr class="separator:a492b2d057dd803c3884fa1adc8e22534"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ada508497ee2e70170da3afe078e2fe0e" id="r_ada508497ee2e70170da3afe078e2fe0e"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ada508497ee2e70170da3afe078e2fe0e">transmit</a> (const uint8_t *data, size_t len, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:ada508497ee2e70170da3afe078e2fe0e"><td class="mdescLeft"> </td><td class="mdescRight">Binary transmit method. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:ada508497ee2e70170da3afe078e2fe0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af1bb9a5da26da8829795ebb72e9c666e" id="r_af1bb9a5da26da8829795ebb72e9c666e"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#af1bb9a5da26da8829795ebb72e9c666e">sleep</a> ()</td></tr>
|
|
<tr class="memdesc:af1bb9a5da26da8829795ebb72e9c666e"><td class="mdescLeft"> </td><td class="mdescRight">Sets module to sleep. <br /></td></tr>
|
|
<tr class="separator:af1bb9a5da26da8829795ebb72e9c666e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acbcaf6aefcb77a354797e66222fe5018" id="r_acbcaf6aefcb77a354797e66222fe5018"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#acbcaf6aefcb77a354797e66222fe5018">standby</a> ()</td></tr>
|
|
<tr class="memdesc:acbcaf6aefcb77a354797e66222fe5018"><td class="mdescLeft"> </td><td class="mdescRight">Sets module to standby. <br /></td></tr>
|
|
<tr class="separator:acbcaf6aefcb77a354797e66222fe5018"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d5da4311092e3df6b193ff303a0c5e8" id="r_a7d5da4311092e3df6b193ff303a0c5e8"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a7d5da4311092e3df6b193ff303a0c5e8">standby</a> (uint8_t mode)</td></tr>
|
|
<tr class="memdesc:a7d5da4311092e3df6b193ff303a0c5e8"><td class="mdescLeft"> </td><td class="mdescRight">Sets module to a specific standby mode. <br /></td></tr>
|
|
<tr class="separator:a7d5da4311092e3df6b193ff303a0c5e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a18664ad615c5507ff1690baaca90b094" id="r_a18664ad615c5507ff1690baaca90b094"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a18664ad615c5507ff1690baaca90b094">startReceive</a> ()</td></tr>
|
|
<tr class="memdesc:a18664ad615c5507ff1690baaca90b094"><td class="mdescLeft"> </td><td class="mdescRight">Sets module to received mode using its default configuration. <br /></td></tr>
|
|
<tr class="separator:a18664ad615c5507ff1690baaca90b094"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae93500dfbcfd39837e04c0f3eaa40d97" id="r_ae93500dfbcfd39837e04c0f3eaa40d97"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ae93500dfbcfd39837e04c0f3eaa40d97">startReceive</a> (uint32_t timeout, <a class="el" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> irqFlags=RADIOLIB_IRQ_RX_DEFAULT_FLAGS, <a class="el" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> irqMask=RADIOLIB_IRQ_RX_DEFAULT_MASK, size_t len=0)</td></tr>
|
|
<tr class="memdesc:ae93500dfbcfd39837e04c0f3eaa40d97"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven receive method. A DIO pin will be activated when full packet is received. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:ae93500dfbcfd39837e04c0f3eaa40d97"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab82617fa3fa9f21d4cd427314ecc4af8" id="r_ab82617fa3fa9f21d4cd427314ecc4af8"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">receive</a> (uint8_t *data, size_t len)</td></tr>
|
|
<tr class="memdesc:ab82617fa3fa9f21d4cd427314ecc4af8"><td class="mdescLeft"> </td><td class="mdescRight">Binary receive method. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:ab82617fa3fa9f21d4cd427314ecc4af8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a923654706eff5118ef6e84214e837f27" id="r_a923654706eff5118ef6e84214e837f27"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">startTransmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a923654706eff5118ef6e84214e837f27"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. <br /></td></tr>
|
|
<tr class="separator:a923654706eff5118ef6e84214e837f27"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af79757dbbd62e080c1bad2e608ab940c" id="r_af79757dbbd62e080c1bad2e608ab940c"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#af79757dbbd62e080c1bad2e608ab940c">startTransmit</a> (const uint8_t *data, size_t len, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:af79757dbbd62e080c1bad2e608ab940c"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven binary transmit method. <br /></td></tr>
|
|
<tr class="separator:af79757dbbd62e080c1bad2e608ab940c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1de26f68b939f5af79ec29cc34c7be18" id="r_a1de26f68b939f5af79ec29cc34c7be18"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a1de26f68b939f5af79ec29cc34c7be18">finishTransmit</a> ()</td></tr>
|
|
<tr class="memdesc:a1de26f68b939f5af79ec29cc34c7be18"><td class="mdescLeft"> </td><td class="mdescRight">Clean up after transmission is done. <br /></td></tr>
|
|
<tr class="separator:a1de26f68b939f5af79ec29cc34c7be18"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3563453988a83d22dd07d4691543a300" id="r_a3563453988a83d22dd07d4691543a300"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">readData</a> (uint8_t *data, size_t len)</td></tr>
|
|
<tr class="memdesc:a3563453988a83d22dd07d4691543a300"><td class="mdescLeft"> </td><td class="mdescRight">Reads data that was received after calling startReceive method. <br /></td></tr>
|
|
<tr class="separator:a3563453988a83d22dd07d4691543a300"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4c99ac794ee653c2061be4201724b65" id="r_aa4c99ac794ee653c2061be4201724b65"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#aa4c99ac794ee653c2061be4201724b65">transmitDirect</a> (uint32_t frf=0)</td></tr>
|
|
<tr class="memdesc:aa4c99ac794ee653c2061be4201724b65"><td class="mdescLeft"> </td><td class="mdescRight">Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module class. While in direct mode, the module will not be able to transmit or receive packets. Can only be activated in FSK mode. <br /></td></tr>
|
|
<tr class="separator:aa4c99ac794ee653c2061be4201724b65"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9d1dbb2041e87af5a80e12f125a60e6" id="r_ad9d1dbb2041e87af5a80e12f125a60e6"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ad9d1dbb2041e87af5a80e12f125a60e6">receiveDirect</a> ()</td></tr>
|
|
<tr class="memdesc:ad9d1dbb2041e87af5a80e12f125a60e6"><td class="mdescLeft"> </td><td class="mdescRight">Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module class. While in direct mode, the module will not be able to transmit or receive packets. Can only be activated in FSK mode. <br /></td></tr>
|
|
<tr class="separator:ad9d1dbb2041e87af5a80e12f125a60e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8a194b0fbb66b1a953288bf3b9478d6e" id="r_a8a194b0fbb66b1a953288bf3b9478d6e"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a8a194b0fbb66b1a953288bf3b9478d6e">setFrequency</a> (float freq)</td></tr>
|
|
<tr class="memdesc:a8a194b0fbb66b1a953288bf3b9478d6e"><td class="mdescLeft"> </td><td class="mdescRight">Sets carrier frequency. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:a8a194b0fbb66b1a953288bf3b9478d6e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aedd39ad84b45c6392087b12d59192d8c" id="r_aedd39ad84b45c6392087b12d59192d8c"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#aedd39ad84b45c6392087b12d59192d8c">setBitRate</a> (float br)</td></tr>
|
|
<tr class="memdesc:aedd39ad84b45c6392087b12d59192d8c"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK bit rate. Only available in FSK mode. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:aedd39ad84b45c6392087b12d59192d8c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f4f9b428d9ea9af886ca85e5088ed7b" id="r_a2f4f9b428d9ea9af886ca85e5088ed7b"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a2f4f9b428d9ea9af886ca85e5088ed7b">setFrequencyDeviation</a> (float freqDev)</td></tr>
|
|
<tr class="memdesc:a2f4f9b428d9ea9af886ca85e5088ed7b"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK frequency deviation from carrier frequency. Only available in FSK mode. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:a2f4f9b428d9ea9af886ca85e5088ed7b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeba04366a0cf05ff3d8227c4f7c8e1e9" id="r_aeba04366a0cf05ff3d8227c4f7c8e1e9"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#aeba04366a0cf05ff3d8227c4f7c8e1e9">setDataShaping</a> (uint8_t sh)</td></tr>
|
|
<tr class="memdesc:aeba04366a0cf05ff3d8227c4f7c8e1e9"><td class="mdescLeft"> </td><td class="mdescRight">Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:aeba04366a0cf05ff3d8227c4f7c8e1e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acb45b2342400a03a914a91d2ac7fb488" id="r_acb45b2342400a03a914a91d2ac7fb488"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#acb45b2342400a03a914a91d2ac7fb488">setEncoding</a> (uint8_t encoding)</td></tr>
|
|
<tr class="memdesc:acb45b2342400a03a914a91d2ac7fb488"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK data encoding. Only available in FSK mode. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:acb45b2342400a03a914a91d2ac7fb488"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a11b4c6d0bf3ae7b9ca04e9434180feab" id="r_a11b4c6d0bf3ae7b9ca04e9434180feab"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a11b4c6d0bf3ae7b9ca04e9434180feab">invertIQ</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:a11b4c6d0bf3ae7b9ca04e9434180feab"><td class="mdescLeft"> </td><td class="mdescRight">Set IQ inversion. Must be implemented in module class if the module supports it. <br /></td></tr>
|
|
<tr class="separator:a11b4c6d0bf3ae7b9ca04e9434180feab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2286dc78dbf8e3084f38e9159b99ae5" id="r_ad2286dc78dbf8e3084f38e9159b99ae5"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ad2286dc78dbf8e3084f38e9159b99ae5">setOutputPower</a> (int8_t power)</td></tr>
|
|
<tr class="memdesc:ad2286dc78dbf8e3084f38e9159b99ae5"><td class="mdescLeft"> </td><td class="mdescRight">Set output power. Must be implemented in module class if the module supports it. <br /></td></tr>
|
|
<tr class="separator:ad2286dc78dbf8e3084f38e9159b99ae5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1784cb227d04b3f2846625fda6797536" id="r_a1784cb227d04b3f2846625fda6797536"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a1784cb227d04b3f2846625fda6797536">checkOutputPower</a> (int8_t power, int8_t *clipped)</td></tr>
|
|
<tr class="memdesc:a1784cb227d04b3f2846625fda6797536"><td class="mdescLeft"> </td><td class="mdescRight">Check if output power is configurable. Must be implemented in module class if the module supports it. <br /></td></tr>
|
|
<tr class="separator:a1784cb227d04b3f2846625fda6797536"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c71cdc1238e1368274670758431a977" id="r_a6c71cdc1238e1368274670758431a977"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a6c71cdc1238e1368274670758431a977">setSyncWord</a> (uint8_t *sync, size_t len)</td></tr>
|
|
<tr class="memdesc:a6c71cdc1238e1368274670758431a977"><td class="mdescLeft"> </td><td class="mdescRight">Set sync word. Must be implemented in module class if the module supports it. <br /></td></tr>
|
|
<tr class="separator:a6c71cdc1238e1368274670758431a977"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85db1ff64e6c56e054f276c511194633" id="r_a85db1ff64e6c56e054f276c511194633"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a85db1ff64e6c56e054f276c511194633">setPreambleLength</a> (size_t len)</td></tr>
|
|
<tr class="memdesc:a85db1ff64e6c56e054f276c511194633"><td class="mdescLeft"> </td><td class="mdescRight">Set preamble length. Must be implemented in module class if the module supports it. <br /></td></tr>
|
|
<tr class="separator:a85db1ff64e6c56e054f276c511194633"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ee1fed6bbb8d3571974153ac6f26751" id="r_a6ee1fed6bbb8d3571974153ac6f26751"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a6ee1fed6bbb8d3571974153ac6f26751">setDataRate</a> (<a class="el" href="union_data_rate__t.html">DataRate_t</a> dr)</td></tr>
|
|
<tr class="memdesc:a6ee1fed6bbb8d3571974153ac6f26751"><td class="mdescLeft"> </td><td class="mdescRight">Set data. Must be implemented in module class if the module supports it. <br /></td></tr>
|
|
<tr class="separator:a6ee1fed6bbb8d3571974153ac6f26751"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a58d54eeb40fb586013ba48e15318abba" id="r_a58d54eeb40fb586013ba48e15318abba"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a58d54eeb40fb586013ba48e15318abba">checkDataRate</a> (<a class="el" href="union_data_rate__t.html">DataRate_t</a> dr)</td></tr>
|
|
<tr class="memdesc:a58d54eeb40fb586013ba48e15318abba"><td class="mdescLeft"> </td><td class="mdescRight">Check the data rate can be configured by this module. Must be implemented in module class if the module supports it. <br /></td></tr>
|
|
<tr class="separator:a58d54eeb40fb586013ba48e15318abba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2fe95169b5cdc8cabe1f2af66cad6ef6" id="r_a2fe95169b5cdc8cabe1f2af66cad6ef6"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a2fe95169b5cdc8cabe1f2af66cad6ef6">getPacketLength</a> (bool update=true)</td></tr>
|
|
<tr class="memdesc:a2fe95169b5cdc8cabe1f2af66cad6ef6"><td class="mdescLeft"> </td><td class="mdescRight">Query modem for the packet length of received payload. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:a2fe95169b5cdc8cabe1f2af66cad6ef6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aabc94ab27a9ee6daaafa9b47dde5f75b" id="r_aabc94ab27a9ee6daaafa9b47dde5f75b"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#aabc94ab27a9ee6daaafa9b47dde5f75b">getRSSI</a> ()</td></tr>
|
|
<tr class="memdesc:aabc94ab27a9ee6daaafa9b47dde5f75b"><td class="mdescLeft"> </td><td class="mdescRight">Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. <br /></td></tr>
|
|
<tr class="separator:aabc94ab27a9ee6daaafa9b47dde5f75b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aedddaf9460941b90e43e9005035faa0f" id="r_aedddaf9460941b90e43e9005035faa0f"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#aedddaf9460941b90e43e9005035faa0f">getSNR</a> ()</td></tr>
|
|
<tr class="memdesc:aedddaf9460941b90e43e9005035faa0f"><td class="mdescLeft"> </td><td class="mdescRight">Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. <br /></td></tr>
|
|
<tr class="separator:aedddaf9460941b90e43e9005035faa0f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50e730a894f60b58034507ad7730dd3c" id="r_a50e730a894f60b58034507ad7730dd3c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a50e730a894f60b58034507ad7730dd3c">getTimeOnAir</a> (size_t len)</td></tr>
|
|
<tr class="memdesc:a50e730a894f60b58034507ad7730dd3c"><td class="mdescLeft"> </td><td class="mdescRight">Get expected time-on-air for a given size of payload. <br /></td></tr>
|
|
<tr class="separator:a50e730a894f60b58034507ad7730dd3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f8d12a90158864a8ebc471b0ec89dc9" id="r_a7f8d12a90158864a8ebc471b0ec89dc9"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a7f8d12a90158864a8ebc471b0ec89dc9">calculateRxTimeout</a> (<a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> timeoutUs)</td></tr>
|
|
<tr class="memdesc:a7f8d12a90158864a8ebc471b0ec89dc9"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the timeout value for this specific module / series (in number of symbols or units of time). <br /></td></tr>
|
|
<tr class="separator:a7f8d12a90158864a8ebc471b0ec89dc9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae602ebd46d60da8670c9f353cef695d9" id="r_ae602ebd46d60da8670c9f353cef695d9"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ae602ebd46d60da8670c9f353cef695d9">getIrqMapped</a> (<a class="el" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> irq)</td></tr>
|
|
<tr class="memdesc:ae602ebd46d60da8670c9f353cef695d9"><td class="mdescLeft"> </td><td class="mdescRight">Convert from radio-agnostic IRQ flags to radio-specific flags. <br /></td></tr>
|
|
<tr class="separator:ae602ebd46d60da8670c9f353cef695d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c7dd4704e3df353265010710bd26e83" id="r_a2c7dd4704e3df353265010710bd26e83"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a2c7dd4704e3df353265010710bd26e83">checkIrq</a> (RadioLibIrqType_t irq)</td></tr>
|
|
<tr class="memdesc:a2c7dd4704e3df353265010710bd26e83"><td class="mdescLeft"> </td><td class="mdescRight">Check whether a specific IRQ bit is set (e.g. RxTimeout, CadDone). <br /></td></tr>
|
|
<tr class="separator:a2c7dd4704e3df353265010710bd26e83"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8564f9834a0247e93e7620c23559ceb8" id="r_a8564f9834a0247e93e7620c23559ceb8"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a8564f9834a0247e93e7620c23559ceb8">setIrq</a> (<a class="el" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> irq)</td></tr>
|
|
<tr class="memdesc:a8564f9834a0247e93e7620c23559ceb8"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt on specific IRQ bit(s) (e.g. RxTimeout, CadDone). Keep in mind that not all radio modules support all RADIOLIB_IRQ_ flags! <br /></td></tr>
|
|
<tr class="separator:a8564f9834a0247e93e7620c23559ceb8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af9a7e739e39705a72ffa8b63ec09bb15" id="r_af9a7e739e39705a72ffa8b63ec09bb15"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#af9a7e739e39705a72ffa8b63ec09bb15">clearIrq</a> (<a class="el" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> irq)</td></tr>
|
|
<tr class="memdesc:af9a7e739e39705a72ffa8b63ec09bb15"><td class="mdescLeft"> </td><td class="mdescRight">Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone). Keep in mind that not all radio modules support all RADIOLIB_IRQ_ flags! <br /></td></tr>
|
|
<tr class="separator:af9a7e739e39705a72ffa8b63ec09bb15"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af1caeed34b2e2ff0355467507106a1a2" id="r_af1caeed34b2e2ff0355467507106a1a2"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#af1caeed34b2e2ff0355467507106a1a2">getIrqFlags</a> ()</td></tr>
|
|
<tr class="memdesc:af1caeed34b2e2ff0355467507106a1a2"><td class="mdescLeft"> </td><td class="mdescRight">Read currently active IRQ flags. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:af1caeed34b2e2ff0355467507106a1a2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af88dcb54dc8e9a1edaf9f1c3e5ee2b74" id="r_af88dcb54dc8e9a1edaf9f1c3e5ee2b74"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#af88dcb54dc8e9a1edaf9f1c3e5ee2b74">setIrqFlags</a> (uint32_t irq)</td></tr>
|
|
<tr class="memdesc:af88dcb54dc8e9a1edaf9f1c3e5ee2b74"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt on DIO1 to be sent on a specific IRQ bit (e.g. RxTimeout, CadDone). Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:af88dcb54dc8e9a1edaf9f1c3e5ee2b74"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac282bb78da4f4da4661dce191cbd6d87" id="r_ac282bb78da4f4da4661dce191cbd6d87"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ac282bb78da4f4da4661dce191cbd6d87">clearIrqFlags</a> (uint32_t irq)</td></tr>
|
|
<tr class="memdesc:ac282bb78da4f4da4661dce191cbd6d87"><td class="mdescLeft"> </td><td class="mdescRight">Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone). Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:ac282bb78da4f4da4661dce191cbd6d87"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae30dfbb5445bb674898fc54f5f90b2f9" id="r_ae30dfbb5445bb674898fc54f5f90b2f9"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ae30dfbb5445bb674898fc54f5f90b2f9">startChannelScan</a> ()</td></tr>
|
|
<tr class="memdesc:ae30dfbb5445bb674898fc54f5f90b2f9"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven channel activity detection method. Interrupt will be activated when packet is detected. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:ae30dfbb5445bb674898fc54f5f90b2f9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a82a52062d9259c2c546d7bf8072b7a72" id="r_a82a52062d9259c2c546d7bf8072b7a72"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a82a52062d9259c2c546d7bf8072b7a72">startChannelScan</a> (const <a class="el" href="union_channel_scan_config__t.html">ChannelScanConfig_t</a> &config)</td></tr>
|
|
<tr class="memdesc:a82a52062d9259c2c546d7bf8072b7a72"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven channel activity detection method. interrupt will be activated when packet is detected. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:a82a52062d9259c2c546d7bf8072b7a72"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a63979795a7b53557560bb95b65480906" id="r_a63979795a7b53557560bb95b65480906"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a63979795a7b53557560bb95b65480906">getChannelScanResult</a> ()</td></tr>
|
|
<tr class="memdesc:a63979795a7b53557560bb95b65480906"><td class="mdescLeft"> </td><td class="mdescRight">Read the channel scan result. <br /></td></tr>
|
|
<tr class="separator:a63979795a7b53557560bb95b65480906"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd9e39cc745acbf084cfa0d3f4d10718" id="r_abd9e39cc745acbf084cfa0d3f4d10718"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#abd9e39cc745acbf084cfa0d3f4d10718">scanChannel</a> ()</td></tr>
|
|
<tr class="memdesc:abd9e39cc745acbf084cfa0d3f4d10718"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules, or RSSI measurement for FSK modules. <br /></td></tr>
|
|
<tr class="separator:abd9e39cc745acbf084cfa0d3f4d10718"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af788cf83ceb0222cd0fa4a1323b9041b" id="r_af788cf83ceb0222cd0fa4a1323b9041b"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#af788cf83ceb0222cd0fa4a1323b9041b">scanChannel</a> (const <a class="el" href="union_channel_scan_config__t.html">ChannelScanConfig_t</a> &config)</td></tr>
|
|
<tr class="memdesc:af788cf83ceb0222cd0fa4a1323b9041b"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules, or RSSI measurement for FSK modules. <br /></td></tr>
|
|
<tr class="separator:af788cf83ceb0222cd0fa4a1323b9041b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd9171bd71aa80fb86113b612c42de53" id="r_acd9171bd71aa80fb86113b612c42de53"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">random</a> (int32_t max)</td></tr>
|
|
<tr class="memdesc:acd9171bd71aa80fb86113b612c42de53"><td class="mdescLeft"> </td><td class="mdescRight">Get truly random number in range 0 - max. <br /></td></tr>
|
|
<tr class="separator:acd9171bd71aa80fb86113b612c42de53"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a76113e10481743094a1cd0280692b0a9" id="r_a76113e10481743094a1cd0280692b0a9"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a76113e10481743094a1cd0280692b0a9">random</a> (int32_t min, int32_t max)</td></tr>
|
|
<tr class="memdesc:a76113e10481743094a1cd0280692b0a9"><td class="mdescLeft"> </td><td class="mdescRight">Get truly random number in range min - max. <br /></td></tr>
|
|
<tr class="separator:a76113e10481743094a1cd0280692b0a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a5985308904261dd431f373d47ddee4" id="r_a1a5985308904261dd431f373d47ddee4"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a1a5985308904261dd431f373d47ddee4">randomByte</a> ()</td></tr>
|
|
<tr class="memdesc:a1a5985308904261dd431f373d47ddee4"><td class="mdescLeft"> </td><td class="mdescRight">Get one truly random byte from RSSI noise. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:a1a5985308904261dd431f373d47ddee4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88a10657bd2215a11a2331f937414b55" id="r_a88a10657bd2215a11a2331f937414b55"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a88a10657bd2215a11a2331f937414b55">startDirect</a> ()</td></tr>
|
|
<tr class="memdesc:a88a10657bd2215a11a2331f937414b55"><td class="mdescLeft"> </td><td class="mdescRight">Configure module parameters for direct modes. Must be called prior to "ham" modes like RTTY or AX.25. Only available in FSK mode. <br /></td></tr>
|
|
<tr class="separator:a88a10657bd2215a11a2331f937414b55"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8e378fe136a498ea485a9c10f5e15aab" id="r_a8e378fe136a498ea485a9c10f5e15aab"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a8e378fe136a498ea485a9c10f5e15aab">setDirectSyncWord</a> (uint32_t syncWord, uint8_t len)</td></tr>
|
|
<tr class="memdesc:a8e378fe136a498ea485a9c10f5e15aab"><td class="mdescLeft"> </td><td class="mdescRight">Set sync word to be used to determine start of packet in direct reception mode. <br /></td></tr>
|
|
<tr class="separator:a8e378fe136a498ea485a9c10f5e15aab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf96cf4f3cb4c82d44be581dbe615966" id="r_abf96cf4f3cb4c82d44be581dbe615966"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#abf96cf4f3cb4c82d44be581dbe615966">setDirectAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:abf96cf4f3cb4c82d44be581dbe615966"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt service routine function to call when data bit is received in direct mode. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:abf96cf4f3cb4c82d44be581dbe615966"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acda61fc99cfa373153c50c78380ed885" id="r_acda61fc99cfa373153c50c78380ed885"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#acda61fc99cfa373153c50c78380ed885">readBit</a> (uint32_t pin)</td></tr>
|
|
<tr class="memdesc:acda61fc99cfa373153c50c78380ed885"><td class="mdescLeft"> </td><td class="mdescRight">Function to read and process data bit in direct reception mode. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:acda61fc99cfa373153c50c78380ed885"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab57182d32646861ef0d865e2740d6b26" id="r_ab57182d32646861ef0d865e2740d6b26"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ab57182d32646861ef0d865e2740d6b26">available</a> ()</td></tr>
|
|
<tr class="memdesc:ab57182d32646861ef0d865e2740d6b26"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of direct mode bytes currently available in buffer. <br /></td></tr>
|
|
<tr class="separator:ab57182d32646861ef0d865e2740d6b26"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a429796eb2e7ea86781a2e8ca42af43f3" id="r_a429796eb2e7ea86781a2e8ca42af43f3"><td class="memItemLeft" align="right" valign="top"><a id="a429796eb2e7ea86781a2e8ca42af43f3" name="a429796eb2e7ea86781a2e8ca42af43f3"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>dropSync</b> ()</td></tr>
|
|
<tr class="memdesc:a429796eb2e7ea86781a2e8ca42af43f3"><td class="mdescLeft"> </td><td class="mdescRight">Forcefully drop synchronization. <br /></td></tr>
|
|
<tr class="separator:a429796eb2e7ea86781a2e8ca42af43f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d5b30493c8d7fcfb784e128362d596c" id="r_a4d5b30493c8d7fcfb784e128362d596c"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a4d5b30493c8d7fcfb784e128362d596c">read</a> (bool drop=true)</td></tr>
|
|
<tr class="memdesc:a4d5b30493c8d7fcfb784e128362d596c"><td class="mdescLeft"> </td><td class="mdescRight">Get data from direct mode buffer. <br /></td></tr>
|
|
<tr class="separator:a4d5b30493c8d7fcfb784e128362d596c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a349e8a22cd28ad89d45460fdeeefc05c" id="r_a349e8a22cd28ad89d45460fdeeefc05c"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a349e8a22cd28ad89d45460fdeeefc05c">setDIOMapping</a> (uint32_t pin, uint32_t value)</td></tr>
|
|
<tr class="memdesc:a349e8a22cd28ad89d45460fdeeefc05c"><td class="mdescLeft"> </td><td class="mdescRight">Configure DIO pin mapping to get a given signal on a DIO pin (if available). <br /></td></tr>
|
|
<tr class="separator:a349e8a22cd28ad89d45460fdeeefc05c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aec928bb26f65752aa20cd236fbabb95c" id="r_aec928bb26f65752aa20cd236fbabb95c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#aec928bb26f65752aa20cd236fbabb95c">setPacketReceivedAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:aec928bb26f65752aa20cd236fbabb95c"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a packet is received. <br /></td></tr>
|
|
<tr class="separator:aec928bb26f65752aa20cd236fbabb95c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7edf27f03600b96f72f011fc82fa4ef9" id="r_a7edf27f03600b96f72f011fc82fa4ef9"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a7edf27f03600b96f72f011fc82fa4ef9">clearPacketReceivedAction</a> ()</td></tr>
|
|
<tr class="memdesc:a7edf27f03600b96f72f011fc82fa4ef9"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a packet is received. <br /></td></tr>
|
|
<tr class="separator:a7edf27f03600b96f72f011fc82fa4ef9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a32b512b34f6575b2109ae3c3f35d1369" id="r_a32b512b34f6575b2109ae3c3f35d1369"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a32b512b34f6575b2109ae3c3f35d1369">setPacketSentAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:a32b512b34f6575b2109ae3c3f35d1369"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a packet is sent. <br /></td></tr>
|
|
<tr class="separator:a32b512b34f6575b2109ae3c3f35d1369"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a67ee4ec36f352d06dda0102260f6bfce" id="r_a67ee4ec36f352d06dda0102260f6bfce"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a67ee4ec36f352d06dda0102260f6bfce">clearPacketSentAction</a> ()</td></tr>
|
|
<tr class="memdesc:a67ee4ec36f352d06dda0102260f6bfce"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a packet is sent. <br /></td></tr>
|
|
<tr class="separator:a67ee4ec36f352d06dda0102260f6bfce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae11c191a7edf3116bf468b9153237260" id="r_ae11c191a7edf3116bf468b9153237260"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ae11c191a7edf3116bf468b9153237260">setChannelScanAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:ae11c191a7edf3116bf468b9153237260"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a channel scan is finished. <br /></td></tr>
|
|
<tr class="separator:ae11c191a7edf3116bf468b9153237260"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a169a4d04c5c50d3336e274d70930d9f6" id="r_a169a4d04c5c50d3336e274d70930d9f6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a169a4d04c5c50d3336e274d70930d9f6">clearChannelScanAction</a> ()</td></tr>
|
|
<tr class="memdesc:a169a4d04c5c50d3336e274d70930d9f6"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a channel scan is finished. <br /></td></tr>
|
|
<tr class="separator:a169a4d04c5c50d3336e274d70930d9f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a77415bf4ed34be18c92c0cf4b2de7149" id="r_a77415bf4ed34be18c92c0cf4b2de7149"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a77415bf4ed34be18c92c0cf4b2de7149">setModem</a> (ModemType_t modem)</td></tr>
|
|
<tr class="memdesc:a77415bf4ed34be18c92c0cf4b2de7149"><td class="mdescLeft"> </td><td class="mdescRight">Set modem for the radio to use. Will perform full reset and reconfigure the radio using its default parameters. <br /></td></tr>
|
|
<tr class="separator:a77415bf4ed34be18c92c0cf4b2de7149"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af061879bf694735297593c048d04a196" id="r_af061879bf694735297593c048d04a196"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#af061879bf694735297593c048d04a196">getModem</a> (ModemType_t *modem)</td></tr>
|
|
<tr class="memdesc:af061879bf694735297593c048d04a196"><td class="mdescLeft"> </td><td class="mdescRight">Get modem currently in use by the radio. <br /></td></tr>
|
|
<tr class="separator:af061879bf694735297593c048d04a196"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06fa3b844c6028a78e29b7dff58c7c79" id="r_a06fa3b844c6028a78e29b7dff58c7c79"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a06fa3b844c6028a78e29b7dff58c7c79">stageMode</a> (RadioModeType_t mode, <a class="el" href="union_radio_mode_config__t.html">RadioModeConfig_t</a> *cfg)</td></tr>
|
|
<tr class="memdesc:a06fa3b844c6028a78e29b7dff58c7c79"><td class="mdescLeft"> </td><td class="mdescRight">Stage mode of the radio to be launched later using launchMode. <br /></td></tr>
|
|
<tr class="separator:a06fa3b844c6028a78e29b7dff58c7c79"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c5977bc9f54f21665b022a99e6c87cc" id="r_a5c5977bc9f54f21665b022a99e6c87cc"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a5c5977bc9f54f21665b022a99e6c87cc">launchMode</a> ()</td></tr>
|
|
<tr class="memdesc:a5c5977bc9f54f21665b022a99e6c87cc"><td class="mdescLeft"> </td><td class="mdescRight">Launch previously staged mode. <br /></td></tr>
|
|
<tr class="separator:a5c5977bc9f54f21665b022a99e6c87cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:aa949616080a463a82bb6ad5075a9e16e" id="r_aa949616080a463a82bb6ad5075a9e16e"><td class="memItemLeft" align="right" valign="top"><a id="aa949616080a463a82bb6ad5075a9e16e" name="aa949616080a463a82bb6ad5075a9e16e"></a>
|
|
float </td><td class="memItemRight" valign="bottom"><b>freqStep</b></td></tr>
|
|
<tr class="memdesc:aa949616080a463a82bb6ad5075a9e16e"><td class="mdescLeft"> </td><td class="mdescRight">Frequency step of the synthesizer in Hz. <br /></td></tr>
|
|
<tr class="separator:aa949616080a463a82bb6ad5075a9e16e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1c04f8fba5eef96e59972004e8abc623" id="r_a1c04f8fba5eef96e59972004e8abc623"><td class="memItemLeft" align="right" valign="top"><a id="a1c04f8fba5eef96e59972004e8abc623" name="a1c04f8fba5eef96e59972004e8abc623"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>maxPacketLength</b></td></tr>
|
|
<tr class="memdesc:a1c04f8fba5eef96e59972004e8abc623"><td class="mdescLeft"> </td><td class="mdescRight">Maximum length of packet that can be received by the module. <br /></td></tr>
|
|
<tr class="separator:a1c04f8fba5eef96e59972004e8abc623"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:acb94e5999123b5a1c63dd279b2a5a251" id="r_acb94e5999123b5a1c63dd279b2a5a251"><td class="memItemLeft" align="right" valign="top"><a id="acb94e5999123b5a1c63dd279b2a5a251" name="acb94e5999123b5a1c63dd279b2a5a251"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>AFSKClient</b></td></tr>
|
|
<tr class="separator:acb94e5999123b5a1c63dd279b2a5a251"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a018393f703a257e39cd263cccf4ffad5" id="r_a018393f703a257e39cd263cccf4ffad5"><td class="memItemLeft" align="right" valign="top"><a id="a018393f703a257e39cd263cccf4ffad5" name="a018393f703a257e39cd263cccf4ffad5"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>RTTYClient</b></td></tr>
|
|
<tr class="separator:a018393f703a257e39cd263cccf4ffad5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae5c5757c553100373984a416b6c3690a" id="r_ae5c5757c553100373984a416b6c3690a"><td class="memItemLeft" align="right" valign="top"><a id="ae5c5757c553100373984a416b6c3690a" name="ae5c5757c553100373984a416b6c3690a"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>MorseClient</b></td></tr>
|
|
<tr class="separator:ae5c5757c553100373984a416b6c3690a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afeb005bab389f137def61f1acc3714d3" id="r_afeb005bab389f137def61f1acc3714d3"><td class="memItemLeft" align="right" valign="top"><a id="afeb005bab389f137def61f1acc3714d3" name="afeb005bab389f137def61f1acc3714d3"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>HellClient</b></td></tr>
|
|
<tr class="separator:afeb005bab389f137def61f1acc3714d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8dd4f2f60ef4fd1fa1868a7a630ab20" id="r_ae8dd4f2f60ef4fd1fa1868a7a630ab20"><td class="memItemLeft" align="right" valign="top"><a id="ae8dd4f2f60ef4fd1fa1868a7a630ab20" name="ae8dd4f2f60ef4fd1fa1868a7a630ab20"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>SSTVClient</b></td></tr>
|
|
<tr class="separator:ae8dd4f2f60ef4fd1fa1868a7a630ab20"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0012621c1414f4c7573e961b57884a5b" id="r_a0012621c1414f4c7573e961b57884a5b"><td class="memItemLeft" align="right" valign="top"><a id="a0012621c1414f4c7573e961b57884a5b" name="a0012621c1414f4c7573e961b57884a5b"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>AX25Client</b></td></tr>
|
|
<tr class="separator:a0012621c1414f4c7573e961b57884a5b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac0313fe86041eb37d290019203e095d3" id="r_ac0313fe86041eb37d290019203e095d3"><td class="memItemLeft" align="right" valign="top"><a id="ac0313fe86041eb37d290019203e095d3" name="ac0313fe86041eb37d290019203e095d3"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>FSK4Client</b></td></tr>
|
|
<tr class="separator:ac0313fe86041eb37d290019203e095d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41ff2710d9e3a626becfa7a093900052" id="r_a41ff2710d9e3a626becfa7a093900052"><td class="memItemLeft" align="right" valign="top"><a id="a41ff2710d9e3a626becfa7a093900052" name="a41ff2710d9e3a626becfa7a093900052"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>PagerClient</b></td></tr>
|
|
<tr class="separator:a41ff2710d9e3a626becfa7a093900052"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af9f435b28f04a142bdf136fc6fdc49b3" id="r_af9f435b28f04a142bdf136fc6fdc49b3"><td class="memItemLeft" align="right" valign="top"><a id="af9f435b28f04a142bdf136fc6fdc49b3" name="af9f435b28f04a142bdf136fc6fdc49b3"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>BellClient</b></td></tr>
|
|
<tr class="separator:af9f435b28f04a142bdf136fc6fdc49b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3870f0bd18d0a60e195bc7d39058190c" id="r_a3870f0bd18d0a60e195bc7d39058190c"><td class="memItemLeft" align="right" valign="top"><a id="a3870f0bd18d0a60e195bc7d39058190c" name="a3870f0bd18d0a60e195bc7d39058190c"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>FT8Client</b></td></tr>
|
|
<tr class="separator:a3870f0bd18d0a60e195bc7d39058190c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ec0776e58831979405850594429e2d2" id="r_a9ec0776e58831979405850594429e2d2"><td class="memItemLeft" align="right" valign="top"><a id="a9ec0776e58831979405850594429e2d2" name="a9ec0776e58831979405850594429e2d2"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>LoRaWANNode</b></td></tr>
|
|
<tr class="separator:a9ec0776e58831979405850594429e2d2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a831cdfbf3895309806bef744d4bc77c6" id="r_a831cdfbf3895309806bef744d4bc77c6"><td class="memItemLeft" align="right" valign="top"><a id="a831cdfbf3895309806bef744d4bc77c6" name="a831cdfbf3895309806bef744d4bc77c6"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>M17Client</b></td></tr>
|
|
<tr class="separator:a831cdfbf3895309806bef744d4bc77c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN. Also extracts some common module-independent methods. Using this interface class allows to use the protocols on various modules without much code duplicity. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ab57182d32646861ef0d865e2740d6b26" name="ab57182d32646861ef0d865e2740d6b26"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab57182d32646861ef0d865e2740d6b26">◆ </a></span>available()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::available </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the number of direct mode bytes currently available in buffer. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of available bytes. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7f8d12a90158864a8ebc471b0ec89dc9" name="a7f8d12a90158864a8ebc471b0ec89dc9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7f8d12a90158864a8ebc471b0ec89dc9">◆ </a></span>calculateRxTimeout()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> PhysicalLayer::calculateRxTimeout </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td>
|
|
<td class="paramname"><em>timeoutUs</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Calculate the timeout value for this specific module / series (in number of symbols or units of time). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">timeoutUs</td><td>Timeout in microseconds to listen for. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Timeout value in a unit that is specific for the used module. </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#a260c7f4ee4739e532ddb465a276205d3">LR11x0</a>, <a class="el" href="class_s_x126x.html#a19f3c26d7a7959e302fc8174fc88a6d4">SX126x</a>, and <a class="el" href="class_s_x127x.html#adbc4021380dc557114625dc51262cf90">SX127x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a58d54eeb40fb586013ba48e15318abba" name="a58d54eeb40fb586013ba48e15318abba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a58d54eeb40fb586013ba48e15318abba">◆ </a></span>checkDataRate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::checkDataRate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="union_data_rate__t.html">DataRate_t</a> </td>
|
|
<td class="paramname"><em>dr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check the data rate can be configured by this module. Must be implemented in module class if the module supports it. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dr</td><td>Data rate struct. Interpretation depends on currently active modem (FSK or LoRa). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_l_c_c68.html#a708183645ec0b9fec54d6369e7b1345f">LLCC68</a>, <a class="el" href="class_l_r11x0.html#a4d18ad719be79c083f2b0ce77bbaa448">LR11x0</a>, <a class="el" href="class_s_x126x.html#a75c8d32cee712e0c940163446b98e587">SX126x</a>, <a class="el" href="class_s_x1272.html#a2a36487740f15731c6e508428e4b11f0">SX1272</a>, <a class="el" href="class_s_x1273.html#a5eae1e82596f3a6c4c926c381c2737a7">SX1273</a>, <a class="el" href="class_s_x1277.html#aef5d9e27edc2173d1b4cc1cb0d9733bc">SX1277</a>, and <a class="el" href="class_s_x1278.html#a7f238fd38f436d9e86aa92a387d48467">SX1278</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2c7dd4704e3df353265010710bd26e83" name="a2c7dd4704e3df353265010710bd26e83"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2c7dd4704e3df353265010710bd26e83">◆ </a></span>checkIrq()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::checkIrq </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RadioLibIrqType_t </td>
|
|
<td class="paramname"><em>irq</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check whether a specific IRQ bit is set (e.g. RxTimeout, CadDone). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">irq</td><td>IRQ type to check, one of RADIOLIB_IRQ_*. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 when requested IRQ is set, 0 when it is not or RADIOLIB_ERR_UNSUPPORTED if the IRQ is not supported. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1784cb227d04b3f2846625fda6797536" name="a1784cb227d04b3f2846625fda6797536"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1784cb227d04b3f2846625fda6797536">◆ </a></span>checkOutputPower()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::checkOutputPower </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int8_t </td>
|
|
<td class="paramname"><em>power</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int8_t * </td>
|
|
<td class="paramname"><em>clipped</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if output power is configurable. Must be implemented in module class if the module supports it. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">power</td><td>Output power in dBm. The allowed range depends on the module used. </td></tr>
|
|
<tr><td class="paramname">clipped</td><td>Clipped output power value to what is possible within the module's range. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#ab500e75fcf63f123eb3945925f361bd0">CC1101</a>, <a class="el" href="class_l_r1110.html#af1f6dddd12805fdecb55ef5703d23ef1">LR1110</a>, <a class="el" href="class_l_r1120.html#acf6ea475643c6eba63133641a8681a8f">LR1120</a>, <a class="el" href="class_s_x1261.html#ae8e9968a9ee1c2199ed9f968d8f4e3b1">SX1261</a>, <a class="el" href="class_s_x1262.html#a33c304c19634a905c7318d9ca88f4e93">SX1262</a>, <a class="el" href="class_s_x1268.html#ae1b1f56336fcef9ce31d9408fbbbfe3c">SX1268</a>, <a class="el" href="class_s_x1272.html#a2510072152c936d9f62557f46a4248d0">SX1272</a>, <a class="el" href="class_s_x1278.html#aac7b585c4a616a1cd6f89a8b46a7d9f8">SX1278</a>, and <a class="el" href="class_s_x128x.html#a5e876e02fd527390905004718225c25f">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a169a4d04c5c50d3336e274d70930d9f6" name="a169a4d04c5c50d3336e274d70930d9f6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a169a4d04c5c50d3336e274d70930d9f6">◆ </a></span>clearChannelScanAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PhysicalLayer::clearChannelScanAction </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clears interrupt service routine to call when a channel scan is finished. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_s_t_m32_w_lx.html#a366a83d5f5ed02859717a83c21768378">STM32WLx</a>, <a class="el" href="class_s_x126x.html#a37dab0ab3c4cab82e367971fc31588a6">SX126x</a>, and <a class="el" href="class_s_x127x.html#a0ce9beca21406e3556b3518370947ee2">SX127x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af9a7e739e39705a72ffa8b63ec09bb15" name="af9a7e739e39705a72ffa8b63ec09bb15"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af9a7e739e39705a72ffa8b63ec09bb15">◆ </a></span>clearIrq()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::clearIrq </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> </td>
|
|
<td class="paramname"><em>irq</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone). Keep in mind that not all radio modules support all RADIOLIB_IRQ_ flags! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">irq</td><td>Flags to set, multiple bits may be enabled. IRQ to enable corresponds to the bit index (RadioLibIrq_t). For example, if bit 0 is enabled, the module will enable its RADIOLIB_IRQ_TX_DONE (if it is supported). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac282bb78da4f4da4661dce191cbd6d87" name="ac282bb78da4f4da4661dce191cbd6d87"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac282bb78da4f4da4661dce191cbd6d87">◆ </a></span>clearIrqFlags()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::clearIrqFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>irq</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone). Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">irq</td><td>Module-specific IRQ flags. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#aa524b0be7b8d125c24319072d6178e74">LR11x0</a>, <a class="el" href="class_si443x.html#a1cf4a145680562c66474267cbcf5c630">Si443x</a>, <a class="el" href="class_s_x126x.html#ab4c29619a38391805a11231c67424847">SX126x</a>, <a class="el" href="class_s_x127x.html#aa3eae13a7f0558c1bc881abebd958242">SX127x</a>, and <a class="el" href="class_s_x128x.html#afb95ca5f2c8494042fbbe52802fc265d">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7edf27f03600b96f72f011fc82fa4ef9" name="a7edf27f03600b96f72f011fc82fa4ef9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7edf27f03600b96f72f011fc82fa4ef9">◆ </a></span>clearPacketReceivedAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PhysicalLayer::clearPacketReceivedAction </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clears interrupt service routine to call when a packet is received. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#a0221c4fe494a590cc9714e4752675d61">CC1101</a>, <a class="el" href="class_l_r11x0.html#a96e4a220bbd3487423acfd217b479fe3">LR11x0</a>, <a class="el" href="classn_r_f24.html#a52c097dc0078fc4e8707c095378aff3d">nRF24</a>, <a class="el" href="class_r_f69.html#a31390763956a50182b0b5b8a7e5ff4e3">RF69</a>, <a class="el" href="class_si443x.html#ae8e1a9a70407d80d660496baa560c5ca">Si443x</a>, <a class="el" href="class_s_t_m32_w_lx.html#aad377b018cf65ceb6b23cac523ba96b4">STM32WLx</a>, <a class="el" href="class_s_x126x.html#a56f88f6a2b88ae6dbd3ad04b1950e7b2">SX126x</a>, <a class="el" href="class_s_x127x.html#a6cbc4c256d37f9cdabf9e5f2ef16aa92">SX127x</a>, and <a class="el" href="class_s_x128x.html#ac79047a072a038194f3429a913e7aaee">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a67ee4ec36f352d06dda0102260f6bfce" name="a67ee4ec36f352d06dda0102260f6bfce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a67ee4ec36f352d06dda0102260f6bfce">◆ </a></span>clearPacketSentAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PhysicalLayer::clearPacketSentAction </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clears interrupt service routine to call when a packet is sent. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#a2791ebc7fe71626407278de5852b492f">CC1101</a>, <a class="el" href="class_l_r11x0.html#a95ddec84ae2fb19989c333d42d4dc5fa">LR11x0</a>, <a class="el" href="classn_r_f24.html#a41499cf2c1a6c83a04ff89dd59e3fa56">nRF24</a>, <a class="el" href="class_r_f69.html#ac4ada0c4243b092ffb4c9812519fe947">RF69</a>, <a class="el" href="class_si443x.html#a4fdc84341b1ec602f89ad00c7ca20f26">Si443x</a>, <a class="el" href="class_s_t_m32_w_lx.html#ac11d53d29bf5a845e3797ba6bb875930">STM32WLx</a>, <a class="el" href="class_s_x126x.html#af38ba3d27ab2ac10c703eefa1c428913">SX126x</a>, <a class="el" href="class_s_x127x.html#a2ec32a52b13752d75f3076a5868c312d">SX127x</a>, and <a class="el" href="class_s_x128x.html#ab2335d91c7899291312e3cd6576446e5">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1de26f68b939f5af79ec29cc34c7be18" name="a1de26f68b939f5af79ec29cc34c7be18"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1de26f68b939f5af79ec29cc34c7be18">◆ </a></span>finishTransmit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::finishTransmit </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clean up after transmission is done. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#af70ea860154cd6d2b2e2a6962e161c8f">CC1101</a>, <a class="el" href="class_l_r11x0.html#aaff9a5b9b7636693c98bd1c93a5863e5">LR11x0</a>, <a class="el" href="classn_r_f24.html#af0c21ff66c011dfdc1ad12bc7dd11c2f">nRF24</a>, <a class="el" href="class_r_f69.html#a3e449fa06c9e76cf69585bfbeed1c46b">RF69</a>, <a class="el" href="class_si443x.html#a6792f13441a1bbb3340d2ba3d9abbec3">Si443x</a>, <a class="el" href="class_s_x126x.html#a8e22d67b64953c8b4da779d87d563f3e">SX126x</a>, <a class="el" href="class_s_x127x.html#a7fd9cec52b7fbd0c69cbd861dc17549f">SX127x</a>, and <a class="el" href="class_s_x128x.html#a4587409a9b96a0c496cf12b3acac20c4">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a63979795a7b53557560bb95b65480906" name="a63979795a7b53557560bb95b65480906"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a63979795a7b53557560bb95b65480906">◆ </a></span>getChannelScanResult()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::getChannelScanResult </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read the channel scan result. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#a1ae2cddeb7671d9b71e9c83bf020820f">LR11x0</a>, <a class="el" href="class_s_x126x.html#afdd901c5eac2ca8773d0977e2c493317">SX126x</a>, <a class="el" href="class_s_x127x.html#a81189ce77541d78fc8feb99c2a3f35b2">SX127x</a>, and <a class="el" href="class_s_x128x.html#ac39f77b77a2e4124cc30aeae08b4c653">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af1caeed34b2e2ff0355467507106a1a2" name="af1caeed34b2e2ff0355467507106a1a2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af1caeed34b2e2ff0355467507106a1a2">◆ </a></span>getIrqFlags()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t PhysicalLayer::getIrqFlags </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read currently active IRQ flags. Must be implemented in module class. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>IRQ flags. </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#a205364e65d54f3f87b9b8f5972cdcb99">LR11x0</a>, <a class="el" href="class_si443x.html#adaf6256b4de1607da2122c23c528de3a">Si443x</a>, <a class="el" href="class_s_x126x.html#ab4f9b0c6496a796211e9816bf92146a7">SX126x</a>, <a class="el" href="class_s_x127x.html#a22de05835dda9ed287ec48f60ef91f55">SX127x</a>, and <a class="el" href="class_s_x128x.html#aa17ffcb939f6b2eb0712e63b6ee7a71f">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae602ebd46d60da8670c9f353cef695d9" name="ae602ebd46d60da8670c9f353cef695d9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae602ebd46d60da8670c9f353cef695d9">◆ </a></span>getIrqMapped()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t PhysicalLayer::getIrqMapped </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> </td>
|
|
<td class="paramname"><em>irq</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert from radio-agnostic IRQ flags to radio-specific flags. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">irq</td><td>Radio-agnostic IRQ flags. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Flags for a specific radio module. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af061879bf694735297593c048d04a196" name="af061879bf694735297593c048d04a196"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af061879bf694735297593c048d04a196">◆ </a></span>getModem()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::getModem </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ModemType_t * </td>
|
|
<td class="paramname"><em>modem</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get modem currently in use by the radio. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">modem</td><td>Pointer to a variable to save the retrieved configuration into. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#afe8684b336a8137cde591283297a869c">LR11x0</a>, <a class="el" href="class_s_x126x.html#a867b111d21308319e117695051e157ae">SX126x</a>, <a class="el" href="class_s_x127x.html#a333a9004cc05ff8aba2e9610db31109d">SX127x</a>, and <a class="el" href="class_s_x128x.html#ad7bb0f4aa60a600d24d6268b430e719d">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2fe95169b5cdc8cabe1f2af66cad6ef6" name="a2fe95169b5cdc8cabe1f2af66cad6ef6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2fe95169b5cdc8cabe1f2af66cad6ef6">◆ </a></span>getPacketLength()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t PhysicalLayer::getPacketLength </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>update</em> = <code>true</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Query modem for the packet length of received payload. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">update</td><td>Update received packet length. Will return cached value when set to false. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Length of last received packet in bytes. </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#a122281f6a915b77ee9dafc9926e731a0">CC1101</a>, <a class="el" href="class_l_r11x0.html#ac1f541bdee1d983126ceae47940b8f9d">LR11x0</a>, <a class="el" href="classn_r_f24.html#a23ea1749c21863ebc5bd3a2b08d64f3b">nRF24</a>, <a class="el" href="class_r_f69.html#a86a080086c0228d23e2cb77d2b1915c1">RF69</a>, <a class="el" href="class_si443x.html#a2d944669dc69ccd47f9e6c360f2ffd10">Si443x</a>, <a class="el" href="class_s_x126x.html#ac4ef8c8751a3c09d64e431684840c987">SX126x</a>, <a class="el" href="class_s_x127x.html#a462fa74275e67c296328a01f361892d5">SX127x</a>, and <a class="el" href="class_s_x128x.html#a390fd0749b316eed67da7b54f4f24735">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aabc94ab27a9ee6daaafa9b47dde5f75b" name="aabc94ab27a9ee6daaafa9b47dde5f75b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aabc94ab27a9ee6daaafa9b47dde5f75b">◆ </a></span>getRSSI()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float PhysicalLayer::getRSSI </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>RSSI of the last received packet in dBm. </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#ab80835be83e5a43010afe4e8185114eb">CC1101</a>, <a class="el" href="class_l_r11x0.html#a6cd2b2363501b2de064c9d1f32fabaa3">LR11x0</a>, <a class="el" href="class_r_f69.html#af107c6a510d7e0314f1f4d76637c833d">RF69</a>, <a class="el" href="class_s_x126x.html#a782a2e4ab7779369c0dc0cb4779fda81">SX126x</a>, <a class="el" href="class_s_x1272.html#a54a4b070d6899bd1edae6ae4a17c7d90">SX1272</a>, <a class="el" href="class_s_x1278.html#a0fcdc2962d1cf3410be208154d98ae4b">SX1278</a>, and <a class="el" href="class_s_x128x.html#a260b99d8427e089546e33084803d955a">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aedddaf9460941b90e43e9005035faa0f" name="aedddaf9460941b90e43e9005035faa0f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aedddaf9460941b90e43e9005035faa0f">◆ </a></span>getSNR()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float PhysicalLayer::getSNR </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>SNR of the last received packet in dB. </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#a004782e6e5c6ad213c3b0c677bb8642d">LR11x0</a>, <a class="el" href="class_s_x126x.html#a59b761a67d15cdbfdccd6a759f464d00">SX126x</a>, <a class="el" href="class_s_x127x.html#a47b3f7464303085d34191dd334c1976f">SX127x</a>, and <a class="el" href="class_s_x128x.html#adce2e6c7215caa7c904b0d8f9cbd107d">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a50e730a894f60b58034507ad7730dd3c" name="a50e730a894f60b58034507ad7730dd3c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a50e730a894f60b58034507ad7730dd3c">◆ </a></span>getTimeOnAir()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> PhysicalLayer::getTimeOnAir </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get expected time-on-air for a given size of payload. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">len</td><td>Payload length in bytes. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Expected time-on-air in microseconds. </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#abccf5dc80aab71090a5f19bfffa0201d">LR11x0</a>, <a class="el" href="class_s_x126x.html#a16eb0bdb051f3cf288db752d18182ae2">SX126x</a>, <a class="el" href="class_s_x127x.html#a9e7ecbc92c9d70f93211d21399d237d0">SX127x</a>, and <a class="el" href="class_s_x128x.html#ae7d3676df8f28c79b9bee23df884fa55">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a11b4c6d0bf3ae7b9ca04e9434180feab" name="a11b4c6d0bf3ae7b9ca04e9434180feab"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a11b4c6d0bf3ae7b9ca04e9434180feab">◆ </a></span>invertIQ()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::invertIQ </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set IQ inversion. Must be implemented in module class if the module supports it. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>True to use inverted IQ, false for non-inverted. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#af85c16956c2250dbf338a298c074d28c">LR11x0</a>, <a class="el" href="class_s_x126x.html#a269c8e4ae0d21af88e9422ccf9708c1e">SX126x</a>, <a class="el" href="class_s_x127x.html#a363a436978ba990e1bf7d73f648ad7e9">SX127x</a>, and <a class="el" href="class_s_x128x.html#a46e7979288205689ea97f1c26d1da07e">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c5977bc9f54f21665b022a99e6c87cc" name="a5c5977bc9f54f21665b022a99e6c87cc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c5977bc9f54f21665b022a99e6c87cc">◆ </a></span>launchMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::launchMode </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Launch previously staged mode. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#aaeae4664f6b20a8a88f625b71245480d">LR11x0</a>, <a class="el" href="class_s_x126x.html#aadc732e47fb44acf5d6e0ede7b00b4d2">SX126x</a>, <a class="el" href="class_s_x127x.html#a538b43314081e8b3eda95e0011d1e5b9">SX127x</a>, and <a class="el" href="class_s_x128x.html#ad34368fb77de08630ed06ae797c9e483">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acd9171bd71aa80fb86113b612c42de53" name="acd9171bd71aa80fb86113b612c42de53"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acd9171bd71aa80fb86113b612c42de53">◆ </a></span>random() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32_t PhysicalLayer::random </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32_t </td>
|
|
<td class="paramname"><em>max</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get truly random number in range 0 - max. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">max</td><td>The maximum value of the random number (non-inclusive). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Random number. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a76113e10481743094a1cd0280692b0a9" name="a76113e10481743094a1cd0280692b0a9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a76113e10481743094a1cd0280692b0a9">◆ </a></span>random() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32_t PhysicalLayer::random </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32_t </td>
|
|
<td class="paramname"><em>min</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int32_t </td>
|
|
<td class="paramname"><em>max</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get truly random number in range min - max. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">min</td><td>The minimum value of the random number (inclusive). </td></tr>
|
|
<tr><td class="paramname">max</td><td>The maximum value of the random number (non-inclusive). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Random number. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1a5985308904261dd431f373d47ddee4" name="a1a5985308904261dd431f373d47ddee4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1a5985308904261dd431f373d47ddee4">◆ </a></span>randomByte()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t PhysicalLayer::randomByte </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get one truly random byte from RSSI noise. Must be implemented in module class. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>TRNG byte. </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#a13cf332824479442cc20fc1c6972b092">CC1101</a>, <a class="el" href="class_l_r11x0.html#a89b16d2231f588b67dc3aab0c0a467f4">LR11x0</a>, <a class="el" href="class_r_f69.html#ac47d0f59cb190361fa9b7d10efacc297">RF69</a>, <a class="el" href="class_si443x.html#a16750016db8a3bf27c35822b08d81155">Si443x</a>, <a class="el" href="class_s_x126x.html#a187a616285c5872f9603a86c122deaf2">SX126x</a>, <a class="el" href="class_s_x127x.html#a9877550ed7881be06d00ea190f230fb9">SX127x</a>, and <a class="el" href="class_s_x128x.html#a8d331080599e09ef0b11a77cffd6f13a">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4d5b30493c8d7fcfb784e128362d596c" name="a4d5b30493c8d7fcfb784e128362d596c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d5b30493c8d7fcfb784e128362d596c">◆ </a></span>read()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t PhysicalLayer::read </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>drop</em> = <code>true</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get data from direct mode buffer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">drop</td><td>Drop synchronization on read - next reading will require waiting for the sync word again. Defaults to true. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Byte from direct mode buffer. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acda61fc99cfa373153c50c78380ed885" name="acda61fc99cfa373153c50c78380ed885"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acda61fc99cfa373153c50c78380ed885">◆ </a></span>readBit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PhysicalLayer::readBit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>pin</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Function to read and process data bit in direct reception mode. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin on which to read. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#a11a92d885beefdf2db291301550a980c">CC1101</a>, <a class="el" href="class_r_f69.html#a5a340c38b9b8b79d4fe59fb987b12746">RF69</a>, <a class="el" href="class_si443x.html#a2bff9ba621ad00964bdfc72dd374a50b">Si443x</a>, <a class="el" href="class_s_x126x.html#acb1a1c51f207439880ae537f5ffeb17c">SX126x</a>, <a class="el" href="class_s_x127x.html#a0e149fac59b3accbc9550bf605d6bbf0">SX127x</a>, and <a class="el" href="class_s_x128x.html#af2e1d173694a59082a22922a6f7d50a8">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3563453988a83d22dd07d4691543a300" name="a3563453988a83d22dd07d4691543a300"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3563453988a83d22dd07d4691543a300">◆ </a></span>readData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::readData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads data that was received after calling startReceive method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to array to save the received binary data. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes that will be read. When set to 0, the packet length will be retrieved automatically. When more bytes than received are requested, only the number of bytes requested will be returned. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#a3563453988a83d22dd07d4691543a300">CC1101</a>, <a class="el" href="class_l_r11x0.html#a3563453988a83d22dd07d4691543a300">LR11x0</a>, <a class="el" href="classn_r_f24.html#a3563453988a83d22dd07d4691543a300">nRF24</a>, <a class="el" href="class_r_f69.html#a3563453988a83d22dd07d4691543a300">RF69</a>, <a class="el" href="class_si443x.html#a3563453988a83d22dd07d4691543a300">Si443x</a>, <a class="el" href="class_s_x126x.html#a3563453988a83d22dd07d4691543a300">SX126x</a>, <a class="el" href="class_s_x127x.html#a3563453988a83d22dd07d4691543a300">SX127x</a>, <a class="el" href="class_s_x128x.html#a3563453988a83d22dd07d4691543a300">SX128x</a>, <a class="el" href="class_c_c1101.html#a8c79975a7bbe8a37f8214ecd1f69ba22">CC1101</a>, <a class="el" href="class_l_r11x0.html#a20279f1b267e936991f47fd703924833">LR11x0</a>, <a class="el" href="classn_r_f24.html#a410fb78acb4ed358818c132687b8857a">nRF24</a>, <a class="el" href="class_r_f69.html#a3983b66c83818b4082805bcafc712f00">RF69</a>, <a class="el" href="class_si443x.html#ad00ff8b58c68118ad74fee82028aa71e">Si443x</a>, <a class="el" href="class_s_x126x.html#a3350cbfab628956c1a456383ac7bb2b2">SX126x</a>, <a class="el" href="class_s_x127x.html#abfc840e8d6fe5e222f0143be17876745">SX127x</a>, and <a class="el" href="class_s_x128x.html#a94bca43258b09217fb476a2d8db784bb">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab82617fa3fa9f21d4cd427314ecc4af8" name="ab82617fa3fa9f21d4cd427314ecc4af8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab82617fa3fa9f21d4cd427314ecc4af8">◆ </a></span>receive()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::receive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Binary receive method. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to array to save the received binary data. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Packet length, needed for some modules under special circumstances (e.g. LoRa implicit header mode). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#ab82617fa3fa9f21d4cd427314ecc4af8">CC1101</a>, <a class="el" href="class_l_r11x0.html#ab82617fa3fa9f21d4cd427314ecc4af8">LR11x0</a>, <a class="el" href="classn_r_f24.html#ab82617fa3fa9f21d4cd427314ecc4af8">nRF24</a>, <a class="el" href="class_r_f69.html#ab82617fa3fa9f21d4cd427314ecc4af8">RF69</a>, <a class="el" href="class_si443x.html#ab82617fa3fa9f21d4cd427314ecc4af8">Si443x</a>, <a class="el" href="class_s_x126x.html#ab82617fa3fa9f21d4cd427314ecc4af8">SX126x</a>, <a class="el" href="class_s_x127x.html#ab82617fa3fa9f21d4cd427314ecc4af8">SX127x</a>, <a class="el" href="class_s_x128x.html#ab82617fa3fa9f21d4cd427314ecc4af8">SX128x</a>, <a class="el" href="class_c_c1101.html#aedc1067d0334bb69ed5316146014097d">CC1101</a>, <a class="el" href="class_l_r11x0.html#a377c287f18c939c2b4da3241d8329e58">LR11x0</a>, <a class="el" href="classn_r_f24.html#a239e94511d9ee67ad3d64a49a5c4d7ac">nRF24</a>, <a class="el" href="class_r_f69.html#ae36e8e6042245621a182b29526fe2245">RF69</a>, <a class="el" href="class_si443x.html#aabca3ba8eda212938febab1df2e764b4">Si443x</a>, <a class="el" href="class_s_x126x.html#ae3db6b29c482d94eef8a43cd8b5751c0">SX126x</a>, <a class="el" href="class_s_x127x.html#adfe0d3f033a23ec2f3c2a407285d357c">SX127x</a>, and <a class="el" href="class_s_x128x.html#a32b7b674d63c36f15b7f58a2cb837a99">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad9d1dbb2041e87af5a80e12f125a60e6" name="ad9d1dbb2041e87af5a80e12f125a60e6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad9d1dbb2041e87af5a80e12f125a60e6">◆ </a></span>receiveDirect()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::receiveDirect </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module class. While in direct mode, the module will not be able to transmit or receive packets. Can only be activated in FSK mode. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#ab053c185330519d58f364790108d29ac">CC1101</a>, <a class="el" href="class_l_r11x0.html#ae1a8e8eda78113c47f1a865e63051bb5">LR11x0</a>, <a class="el" href="classn_r_f24.html#a415d86947742e981bfcf7f2371f8605c">nRF24</a>, <a class="el" href="class_r_f69.html#abd556b0f455f9510213b17588a4baf1b">RF69</a>, <a class="el" href="class_si443x.html#a178b471527813a608c04db7d3c9648d6">Si443x</a>, <a class="el" href="class_s_x126x.html#a8a18aee2bf05793aa29b5cf6b47bb435">SX126x</a>, <a class="el" href="class_s_x127x.html#aa7ac558d537c6364c4bc82c8f33e398f">SX127x</a>, and <a class="el" href="class_s_x128x.html#aff7d86352c98771595375e17d19a2a97">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abd9e39cc745acbf084cfa0d3f4d10718" name="abd9e39cc745acbf084cfa0d3f4d10718"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd9e39cc745acbf084cfa0d3f4d10718">◆ </a></span>scanChannel() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::scanChannel </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules, or RSSI measurement for FSK modules. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>RADIOLIB_CHANNEL_FREE when channel is free, RADIOLIB_PREAMBLE_DETECTEDwhen occupied or other <a class="el" href="group__status__codes.html">Status Codes</a>. </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#a6a3034c91f5bce70c853ab1620725b3c">LR11x0</a>, <a class="el" href="class_s_x126x.html#acb8611a9c3862dd1bfa73ef47b8f9b20">SX126x</a>, <a class="el" href="class_s_x127x.html#a13ae97e18744dc617bc9326cfbaad3a3">SX127x</a>, and <a class="el" href="class_s_x128x.html#a2f8427103d6609f3ac44b23fcca4f301">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af788cf83ceb0222cd0fa4a1323b9041b" name="af788cf83ceb0222cd0fa4a1323b9041b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af788cf83ceb0222cd0fa4a1323b9041b">◆ </a></span>scanChannel() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::scanChannel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="union_channel_scan_config__t.html">ChannelScanConfig_t</a> & </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules, or RSSI measurement for FSK modules. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Scan configuration structure. Interpretation depends on currently active modem. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>RADIOLIB_CHANNEL_FREE when channel is free, RADIOLIB_PREAMBLE_DETECTEDwhen occupied or other <a class="el" href="group__status__codes.html">Status Codes</a>. </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#a5e8f21878bdab1439805aea1e9da168d">LR11x0</a>, <a class="el" href="class_s_x126x.html#a373012fb3276872238f654b66879a710">SX126x</a>, and <a class="el" href="class_s_x128x.html#ab55112682432f369fb17f8107ba5158b">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aedd39ad84b45c6392087b12d59192d8c" name="aedd39ad84b45c6392087b12d59192d8c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aedd39ad84b45c6392087b12d59192d8c">◆ </a></span>setBitRate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::setBitRate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>br</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets FSK bit rate. Only available in FSK mode. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">br</td><td>Bit rate to be set (in kbps). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#a6fd22cdec29e1e34a92aa9854b90fdc9">CC1101</a>, <a class="el" href="class_l_r11x0.html#ab1954e4733a7fbea4129d9a2de2285d9">LR11x0</a>, <a class="el" href="classn_r_f24.html#a760d3f47f58ddacdf41975447484a47c">nRF24</a>, <a class="el" href="class_r_f69.html#aa3bfb830901728e9a3c140036aa91c56">RF69</a>, <a class="el" href="class_si443x.html#afcba86e79d229b3fd7268dcbd7c47b62">Si443x</a>, <a class="el" href="class_s_x1233.html#a98e0248cfcca7158261f7ebb31e0aa9f">SX1233</a>, <a class="el" href="class_s_x126x.html#ac38a19db6b8b9aff438d6e23051d487d">SX126x</a>, <a class="el" href="class_s_x1272.html#ab5c9a79d72996c3d793cee812b0aded5">SX1272</a>, <a class="el" href="class_s_x1278.html#afd6df07fc4972cc656f05670e6802f67">SX1278</a>, and <a class="el" href="class_s_x128x.html#ad6570f33bae09bc8b7617f9da39033ac">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae11c191a7edf3116bf468b9153237260" name="ae11c191a7edf3116bf468b9153237260"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae11c191a7edf3116bf468b9153237260">◆ </a></span>setChannelScanAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PhysicalLayer::setChannelScanAction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets interrupt service routine to call when a channel scan is finished. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>ISR to call. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_s_t_m32_w_lx.html#a119ad225f9eba91e7c38f82cf0f1c89d">STM32WLx</a>, <a class="el" href="class_s_x126x.html#aed0e7dcd60479c9db3d7a3408e7f396d">SX126x</a>, and <a class="el" href="class_s_x127x.html#ac23c2b384ae8611d59e10ef6a14fe7e4">SX127x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6ee1fed6bbb8d3571974153ac6f26751" name="a6ee1fed6bbb8d3571974153ac6f26751"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6ee1fed6bbb8d3571974153ac6f26751">◆ </a></span>setDataRate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::setDataRate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="union_data_rate__t.html">DataRate_t</a> </td>
|
|
<td class="paramname"><em>dr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set data. Must be implemented in module class if the module supports it. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dr</td><td>Data rate struct. Interpretation depends on currently active modem (FSK or LoRa). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_l_c_c68.html#ac630770441cadc547892173bde7504f9">LLCC68</a>, <a class="el" href="class_l_r11x0.html#a056e65c58ff8fb18bd84917512790ee6">LR11x0</a>, <a class="el" href="class_s_x126x.html#af30a581d31feae6f50c0591d1ee113f1">SX126x</a>, <a class="el" href="class_s_x1272.html#a5b79b7cd20c4c3cd1f486f777b3457d1">SX1272</a>, <a class="el" href="class_s_x1273.html#acaffc772f70e7db371cbe736dc4a19ab">SX1273</a>, <a class="el" href="class_s_x1277.html#ac4bfae9258662381e685e46c803c984c">SX1277</a>, <a class="el" href="class_s_x1278.html#a286f1ee00e2c7f2ab1bd06b66196c3f9">SX1278</a>, and <a class="el" href="class_s_x128x.html#adbf5a9ac62460efb1c709e51260dbe3d">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeba04366a0cf05ff3d8227c4f7c8e1e9" name="aeba04366a0cf05ff3d8227c4f7c8e1e9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeba04366a0cf05ff3d8227c4f7c8e1e9">◆ </a></span>setDataShaping()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::setDataShaping </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>sh</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sh</td><td>Shaping to be set. See <a class="el" href="group__config__shaping.html">Data shaping filter values aliases.</a> for possible values. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#adf96e77f25b7e256891601bef04f35a6">CC1101</a>, <a class="el" href="class_l_r11x0.html#a5a33df702da3f5b010e07d5e6fac7aa6">LR11x0</a>, <a class="el" href="classn_r_f24.html#a0db248d2bcdb4ca2b401e8e638442916">nRF24</a>, <a class="el" href="class_r_f69.html#a42b99e437454e92c6932c3b7acc1fc4a">RF69</a>, <a class="el" href="class_si443x.html#ade08c79074c7e4414d34eefa25cee168">Si443x</a>, <a class="el" href="class_s_x126x.html#a1d8f4deb555844b24c2426dd86e69676">SX126x</a>, <a class="el" href="class_s_x1272.html#a91aca64124321c07a67f26b3c6934aea">SX1272</a>, <a class="el" href="class_s_x1278.html#afb740a4925b64d83d5edca10d93f0563">SX1278</a>, <a class="el" href="class_s_x128x.html#a99491c705e88dddc820f884b778f1660">SX128x</a>, and <a class="el" href="class_external_radio.html#abe0bfb0f178783eff28bdc867e9324fd">ExternalRadio</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a349e8a22cd28ad89d45460fdeeefc05c" name="a349e8a22cd28ad89d45460fdeeefc05c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a349e8a22cd28ad89d45460fdeeefc05c">◆ </a></span>setDIOMapping()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::setDIOMapping </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>pin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configure DIO pin mapping to get a given signal on a DIO pin (if available). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin number onto which a signal is to be placed. </td></tr>
|
|
<tr><td class="paramname">value</td><td>The value that indicates which function to place on that pin. See chip datasheet for details. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#a544bb8d7be9c0e1ff7f7103b30925862">CC1101</a>, <a class="el" href="class_r_f69.html#a7243b3396edc1e6e67575894a5033afe">RF69</a>, and <a class="el" href="class_s_x127x.html#af7d373bc93e99790912cebe8d5ae6403">SX127x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abf96cf4f3cb4c82d44be581dbe615966" name="abf96cf4f3cb4c82d44be581dbe615966"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abf96cf4f3cb4c82d44be581dbe615966">◆ </a></span>setDirectAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PhysicalLayer::setDirectAction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set interrupt service routine function to call when data bit is received in direct mode. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>Pointer to interrupt service routine. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#a24f4b059cc56238499c6117b88cd5505">CC1101</a>, <a class="el" href="class_r_f69.html#a9852fe520aec018d2bb4aff0cd17de77">RF69</a>, <a class="el" href="class_si443x.html#a48a59ff1ddc7c8ec820328174955de43">Si443x</a>, <a class="el" href="class_s_x126x.html#a4f514b341b8982650526c6d8e20fd1a4">SX126x</a>, <a class="el" href="class_s_x127x.html#ae4b99d1bc67ac2c81eeb11dd6793a8c5">SX127x</a>, and <a class="el" href="class_s_x128x.html#a2326cf28c385b8dd709cb62c9f665000">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8e378fe136a498ea485a9c10f5e15aab" name="a8e378fe136a498ea485a9c10f5e15aab"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8e378fe136a498ea485a9c10f5e15aab">◆ </a></span>setDirectSyncWord()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::setDirectSyncWord </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>syncWord</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set sync word to be used to determine start of packet in direct reception mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">syncWord</td><td>Sync word bits. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Sync word length in bits. Set to zero to disable sync word matching. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acb45b2342400a03a914a91d2ac7fb488" name="acb45b2342400a03a914a91d2ac7fb488"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acb45b2342400a03a914a91d2ac7fb488">◆ </a></span>setEncoding()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::setEncoding </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>encoding</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets FSK data encoding. Only available in FSK mode. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">encoding</td><td>Encoding to be used. See <a class="el" href="group__config__encoding.html">Encoding type aliases.</a> for possible values. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#ab4b98eb6af33d006306bb7514ed216ea">CC1101</a>, <a class="el" href="class_l_r11x0.html#a8ae178a17f6e41b545b79cfffd3e2864">LR11x0</a>, <a class="el" href="classn_r_f24.html#a0429a9d6524005065e6fac21aaebdcbf">nRF24</a>, <a class="el" href="class_r_f69.html#aae828ce8dda16da4e54d2f18b1fb8af2">RF69</a>, <a class="el" href="class_si443x.html#a1382fc3b68f447e381613e6670747128">Si443x</a>, <a class="el" href="class_s_x126x.html#a2b3eb51117558c58384b03de4b7bfe60">SX126x</a>, <a class="el" href="class_s_x127x.html#abad2d455012bd28d304589c8164390eb">SX127x</a>, <a class="el" href="class_s_x128x.html#a8720a388d2cd10fac3112b89f4a80947">SX128x</a>, and <a class="el" href="class_external_radio.html#ae619f011daea49a97098d2897e5a3c2c">ExternalRadio</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8a194b0fbb66b1a953288bf3b9478d6e" name="a8a194b0fbb66b1a953288bf3b9478d6e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8a194b0fbb66b1a953288bf3b9478d6e">◆ </a></span>setFrequency()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::setFrequency </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freq</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets carrier frequency. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">freq</td><td>Carrier frequency to be set in MHz. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#ad428d7e6fc9ac119101bb0716fa80bee">CC1101</a>, <a class="el" href="class_l_r1110.html#ade94d20ea438cbd92c61e28d2232d7e8">LR1110</a>, <a class="el" href="class_l_r1120.html#a8d13c0f91a90a2aab43229133caf41fb">LR1120</a>, <a class="el" href="classn_r_f24.html#a18f24764b2ecffc076e72dce0b036116">nRF24</a>, <a class="el" href="class_r_f69.html#aa7f47c37eec6c7e3ebf6e6d30ebd5532">RF69</a>, <a class="el" href="class_si4430.html#a3959e91bcae77b8240e9e447985e05b3">Si4430</a>, <a class="el" href="class_si4432.html#aed3561abdb30b4eaad52d984366aadf1">Si4432</a>, <a class="el" href="class_s_x1262.html#a2122feee1a3bffaaa20e85b24dc8a899">SX1262</a>, <a class="el" href="class_s_x1268.html#af412a9361fe413b2d0c426100056d8c2">SX1268</a>, <a class="el" href="class_s_x1272.html#ac1467a23e1f1bfdbd02f6d30654ed850">SX1272</a>, <a class="el" href="class_s_x1276.html#a981b59110e514b7dcaec8490e1c4320c">SX1276</a>, <a class="el" href="class_s_x1277.html#ad68ea24b46d9e7d3f82282cdccd20e00">SX1277</a>, <a class="el" href="class_s_x1278.html#adb4d95d3b2798cf8ea94890ae71dcc59">SX1278</a>, <a class="el" href="class_s_x1279.html#ab60691d073ca75ef09dab7a8f28fb7fb">SX1279</a>, and <a class="el" href="class_s_x128x.html#ab9e16231c2c6bd0e4b4c6c2900b5b332">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2f4f9b428d9ea9af886ca85e5088ed7b" name="a2f4f9b428d9ea9af886ca85e5088ed7b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2f4f9b428d9ea9af886ca85e5088ed7b">◆ </a></span>setFrequencyDeviation()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::setFrequencyDeviation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freqDev</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets FSK frequency deviation from carrier frequency. Only available in FSK mode. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">freqDev</td><td>Frequency deviation to be set (in kHz). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#a0d69713b9f20c9de354c13c3167b18b3">CC1101</a>, <a class="el" href="class_l_r11x0.html#ac003cfe3a4dbd9bad1f01fd0147031d1">LR11x0</a>, <a class="el" href="classn_r_f24.html#a5170284f0a5535de7d00216d450b87a4">nRF24</a>, <a class="el" href="class_r_f69.html#adb9fbfedf95f34ac537815870b98a9be">RF69</a>, <a class="el" href="class_si443x.html#a7c4e6caa95e5622f6f515ba0339a1c66">Si443x</a>, <a class="el" href="class_s_x126x.html#a7cd95a5f2e39ae8fb1a3040e77fa21a3">SX126x</a>, <a class="el" href="class_s_x127x.html#a448ea8a6a6011a9cdddd4e09bd6c9679">SX127x</a>, <a class="el" href="class_s_x128x.html#a26d0d02e5e53a3172df9208fa343a3f1">SX128x</a>, and <a class="el" href="class_external_radio.html#a02928a19eab0eab615c02180cedda3eb">ExternalRadio</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8564f9834a0247e93e7620c23559ceb8" name="a8564f9834a0247e93e7620c23559ceb8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8564f9834a0247e93e7620c23559ceb8">◆ </a></span>setIrq()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::setIrq </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> </td>
|
|
<td class="paramname"><em>irq</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set interrupt on specific IRQ bit(s) (e.g. RxTimeout, CadDone). Keep in mind that not all radio modules support all RADIOLIB_IRQ_ flags! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">irq</td><td>Flags to set, multiple bits may be enabled. IRQ to enable corresponds to the bit index (RadioLibIrq_t). For example, if bit 0 is enabled, the module will enable its RADIOLIB_IRQ_TX_DONE (if it is supported). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af88dcb54dc8e9a1edaf9f1c3e5ee2b74" name="af88dcb54dc8e9a1edaf9f1c3e5ee2b74"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af88dcb54dc8e9a1edaf9f1c3e5ee2b74">◆ </a></span>setIrqFlags()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::setIrqFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>irq</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set interrupt on DIO1 to be sent on a specific IRQ bit (e.g. RxTimeout, CadDone). Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">irq</td><td>Module-specific IRQ flags. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#a62c715ab18ea8a2e08a2791d3e764ee9">LR11x0</a>, <a class="el" href="class_s_x126x.html#a50e757c2a63e5c7da5b0d0d6c00f91b5">SX126x</a>, <a class="el" href="class_s_x127x.html#aae42b94ab2ecf729f29f101222e97666">SX127x</a>, and <a class="el" href="class_s_x128x.html#a6a2ec5d316975f390f20b4e0a2e11e98">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a77415bf4ed34be18c92c0cf4b2de7149" name="a77415bf4ed34be18c92c0cf4b2de7149"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a77415bf4ed34be18c92c0cf4b2de7149">◆ </a></span>setModem()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::setModem </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ModemType_t </td>
|
|
<td class="paramname"><em>modem</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set modem for the radio to use. Will perform full reset and reconfigure the radio using its default parameters. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">modem</td><td>Modem type to set. Not all modems are implemented by all radio modules! </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_l_c_c68.html#aee4457d48c708f05154e931eed05c691">LLCC68</a>, <a class="el" href="class_l_r1110.html#a18f525740237b023056a8ca6f3671c6a">LR1110</a>, <a class="el" href="class_l_r1120.html#a6cd250e0145ed19f2f91ed96a57a825e">LR1120</a>, <a class="el" href="class_s_x1262.html#a7cdbfc39c779b3846aa5fd04d50d3eb8">SX1262</a>, <a class="el" href="class_s_x1268.html#ae66e37a6897315f36a13c8d5cefe521b">SX1268</a>, <a class="el" href="class_s_x1272.html#a2c99afea2bb3bbb1146c8a4536b4843c">SX1272</a>, <a class="el" href="class_s_x1273.html#af9f0969764fde3e12b6b05409718fa83">SX1273</a>, <a class="el" href="class_s_x1276.html#a36a526b6c8540cda36d058fb47a9e099">SX1276</a>, <a class="el" href="class_s_x1277.html#aec55de7c6622936ff48384bb33424b84">SX1277</a>, <a class="el" href="class_s_x1278.html#a609dd3faf2036e8c2d046fd191e0137d">SX1278</a>, <a class="el" href="class_s_x1279.html#aea8bd74e7c5d7b97d4fe4a8182680d5c">SX1279</a>, and <a class="el" href="class_s_x128x.html#a209d69e710a785da2c69474f94fdccf3">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad2286dc78dbf8e3084f38e9159b99ae5" name="ad2286dc78dbf8e3084f38e9159b99ae5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad2286dc78dbf8e3084f38e9159b99ae5">◆ </a></span>setOutputPower()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::setOutputPower </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int8_t </td>
|
|
<td class="paramname"><em>power</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set output power. Must be implemented in module class if the module supports it. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">power</td><td>Output power in dBm. The allowed range depends on the module used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r1110.html#a65c08f0475f888537e55401b75e58b23">LR1110</a>, <a class="el" href="class_l_r1120.html#a1b1321eb695e4a6b583074bb92c33193">LR1120</a>, <a class="el" href="class_si4430.html#ab1303e014a4b8d2307a2b1deb061fdeb">Si4430</a>, <a class="el" href="class_si4431.html#ad1538dbe67ed5d3682591d1d780ab0e9">Si4431</a>, <a class="el" href="class_si4432.html#a5e3017bce6d66d35b867e7878d108c68">Si4432</a>, <a class="el" href="class_s_t_m32_w_lx.html#a9afbde1c466907598974cc3923784c5b">STM32WLx</a>, <a class="el" href="class_s_x1261.html#a3d197bb8a301f3594c7bfa1c9375aef1">SX1261</a>, <a class="el" href="class_s_x1262.html#aa455a7f0e69abdcca55cf35388d9dc52">SX1262</a>, <a class="el" href="class_s_x1268.html#a6b6adaee1c8d76c3d766225298d84709">SX1268</a>, <a class="el" href="class_s_x1272.html#aec51f08c0902145ff5f11e27e7cab638">SX1272</a>, <a class="el" href="class_s_x1278.html#a69abc18e7fa0055e6b80024e8cde7db4">SX1278</a>, <a class="el" href="class_c_c1101.html#a5d6dce30fc7da668975b6da663784cdf">CC1101</a>, <a class="el" href="classn_r_f24.html#a4fa66ce5fb6d7b22bbb439c2f9103bf3">nRF24</a>, and <a class="el" href="class_s_x128x.html#a1bc3372c47a4e3c81ef15bee448ba6b6">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aec928bb26f65752aa20cd236fbabb95c" name="aec928bb26f65752aa20cd236fbabb95c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aec928bb26f65752aa20cd236fbabb95c">◆ </a></span>setPacketReceivedAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PhysicalLayer::setPacketReceivedAction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets interrupt service routine to call when a packet is received. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>ISR to call. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#a29a16e8ed85432c6fae8d9e45399de6e">CC1101</a>, <a class="el" href="class_l_r11x0.html#ac2a8ece736198c966e3870dac09f4e87">LR11x0</a>, <a class="el" href="classn_r_f24.html#a60df9afa489eabe3a3ca193ab7709165">nRF24</a>, <a class="el" href="class_r_f69.html#a74962c069e08890ac9566d48634c778e">RF69</a>, <a class="el" href="class_si443x.html#a0e098ea9aa3945f0c38f59efe43b147e">Si443x</a>, <a class="el" href="class_s_t_m32_w_lx.html#ad23dafdeb21b97165be74ef8f093866c">STM32WLx</a>, <a class="el" href="class_s_x126x.html#a7603aa60ae8d975eb262a4b7e2aed1d0">SX126x</a>, <a class="el" href="class_s_x127x.html#ae236a467095fb5364d0fc4a98d85f96e">SX127x</a>, and <a class="el" href="class_s_x128x.html#ad98c4526ef971f9aadb30e351a37eaf9">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a32b512b34f6575b2109ae3c3f35d1369" name="a32b512b34f6575b2109ae3c3f35d1369"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a32b512b34f6575b2109ae3c3f35d1369">◆ </a></span>setPacketSentAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PhysicalLayer::setPacketSentAction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets interrupt service routine to call when a packet is sent. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>ISR to call. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#a336999da23e554073a9fa628131883f5">CC1101</a>, <a class="el" href="class_l_r11x0.html#a92299e41f839590008b4e344776838a1">LR11x0</a>, <a class="el" href="classn_r_f24.html#a26b5f873db167733df143a0608eea3ac">nRF24</a>, <a class="el" href="class_r_f69.html#a97603856caada65676ff4b11630c7f72">RF69</a>, <a class="el" href="class_si443x.html#af2d36121ca94736ef3ecb4c09aded753">Si443x</a>, <a class="el" href="class_s_t_m32_w_lx.html#a7c0e3aef03f0b6834d0465d8f8568c32">STM32WLx</a>, <a class="el" href="class_s_x126x.html#ac79f7ebab97ae91fff6933be3207c873">SX126x</a>, <a class="el" href="class_s_x127x.html#a3530e8e19cfe4d96fe49ca4e6386b099">SX127x</a>, and <a class="el" href="class_s_x128x.html#a1e6f938ce715dad9a6609bf56626a50d">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a85db1ff64e6c56e054f276c511194633" name="a85db1ff64e6c56e054f276c511194633"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a85db1ff64e6c56e054f276c511194633">◆ </a></span>setPreambleLength()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::setPreambleLength </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set preamble length. Must be implemented in module class if the module supports it. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">len</td><td>Preamble length in bytes. Maximum length depends on the module used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#aa5d7ae65666f8f9abcb7e9b169884a4a">LR11x0</a>, <a class="el" href="class_s_x126x.html#ad6274222ccf534e98e3cd17dfa1520d4">SX126x</a>, and <a class="el" href="class_s_x127x.html#a844499bace6ae001446d71bee2877656">SX127x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6c71cdc1238e1368274670758431a977" name="a6c71cdc1238e1368274670758431a977"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6c71cdc1238e1368274670758431a977">◆ </a></span>setSyncWord()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::setSyncWord </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>sync</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set sync word. Must be implemented in module class if the module supports it. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sync</td><td>Pointer to the sync word. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Sync word length in bytes. Maximum length depends on the module used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#ab8c54b1b105605ffe0908c5ff9362932">LR11x0</a>, <a class="el" href="class_si443x.html#af257fb09afaa6162e1506cfe87b219b3">Si443x</a>, <a class="el" href="class_s_x126x.html#a827a4754ea53388513d263e5d9171395">SX126x</a>, and <a class="el" href="class_s_x127x.html#aaf400f33e17c1679c0b55cd70bef90b0">SX127x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af1bb9a5da26da8829795ebb72e9c666e" name="af1bb9a5da26da8829795ebb72e9c666e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af1bb9a5da26da8829795ebb72e9c666e">◆ </a></span>sleep()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::sleep </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets module to sleep. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#a0ead6224d4378274df465f779199bc92">CC1101</a>, <a class="el" href="class_l_r11x0.html#ad5dde79f751bbd7ea277872e237f2a69">LR11x0</a>, <a class="el" href="classn_r_f24.html#a69b75e0889c609099487a43c8c3b6721">nRF24</a>, <a class="el" href="class_r_f69.html#adec9debf69f5ee846a5b6e34831ade3c">RF69</a>, <a class="el" href="class_si443x.html#ab0cc51d6b4264acf8e3e49a3a490dee9">Si443x</a>, <a class="el" href="class_s_x126x.html#a882cec40d9aa98a0d536e6afb65b1719">SX126x</a>, <a class="el" href="class_s_x127x.html#a1ff85ee7979da08b4e66316f1ba2c6a9">SX127x</a>, and <a class="el" href="class_s_x128x.html#ab0c26aebd432d36974b3066055df6b01">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a06fa3b844c6028a78e29b7dff58c7c79" name="a06fa3b844c6028a78e29b7dff58c7c79"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a06fa3b844c6028a78e29b7dff58c7c79">◆ </a></span>stageMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::stageMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RadioModeType_t </td>
|
|
<td class="paramname"><em>mode</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="union_radio_mode_config__t.html">RadioModeConfig_t</a> * </td>
|
|
<td class="paramname"><em>cfg</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Stage mode of the radio to be launched later using launchMode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mode</td><td>Radio mode to prepare. </td></tr>
|
|
<tr><td class="paramname">cfg</td><td>Configuration of this mode (mode-dependent). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#a66af76a767045af7ef248868ab6a6c28">LR11x0</a>, <a class="el" href="class_s_x126x.html#ab30acdc12ee310873189df2cfa376ed6">SX126x</a>, <a class="el" href="class_s_x127x.html#a3bd7fb49a3b27707aff6636ff6dee550">SX127x</a>, and <a class="el" href="class_s_x128x.html#a65441afe4db0e96788d35b35a2075818">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acbcaf6aefcb77a354797e66222fe5018" name="acbcaf6aefcb77a354797e66222fe5018"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acbcaf6aefcb77a354797e66222fe5018">◆ </a></span>standby() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::standby </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets module to standby. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#a7612bf81e48086004c62548de2682266">CC1101</a>, <a class="el" href="class_l_r11x0.html#a74c3f3f8409f1fd0f41347b7d3c7dc24">LR11x0</a>, <a class="el" href="classn_r_f24.html#a5957f06a891d3d9c07e87b59c239ce56">nRF24</a>, <a class="el" href="class_r_f69.html#a20242499eb926ff7b7da6e3f74a9ece1">RF69</a>, <a class="el" href="class_si443x.html#ac45d2776df3ff338db154ead143fb7b8">Si443x</a>, <a class="el" href="class_s_x126x.html#a7a1579e2557c36a4a34b09039c0d0c71">SX126x</a>, <a class="el" href="class_s_x127x.html#a760b8c5103128f122fbe489c6529ce41">SX127x</a>, and <a class="el" href="class_s_x128x.html#a2be8cc6c3b61b59cb6a6ca4f6a030b45">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7d5da4311092e3df6b193ff303a0c5e8" name="a7d5da4311092e3df6b193ff303a0c5e8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7d5da4311092e3df6b193ff303a0c5e8">◆ </a></span>standby() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::standby </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>mode</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets module to a specific standby mode. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#af374ad0ecd820a01baef7d177a30132a">CC1101</a>, <a class="el" href="classn_r_f24.html#a03e9ae7fbd0d55887acf1996df28ed5b">nRF24</a>, <a class="el" href="class_r_f69.html#a6e3002ab0c58e2087a7d101eda7afa82">RF69</a>, <a class="el" href="class_si443x.html#acbc0f95f32ca961294666405596ff529">Si443x</a>, and <a class="el" href="class_s_x127x.html#aa565bbff460e487672953dc05d335cb0">SX127x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae30dfbb5445bb674898fc54f5f90b2f9" name="ae30dfbb5445bb674898fc54f5f90b2f9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae30dfbb5445bb674898fc54f5f90b2f9">◆ </a></span>startChannelScan() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::startChannelScan </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven channel activity detection method. Interrupt will be activated when packet is detected. Must be implemented in module class. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#a4f3bc362530b85dd643669705f03998d">LR11x0</a>, <a class="el" href="class_s_x126x.html#a001c4637f01ed6f0216cd6c4d7e10da3">SX126x</a>, <a class="el" href="class_s_x127x.html#a6fa5723724393576ed597509200e17d1">SX127x</a>, and <a class="el" href="class_s_x128x.html#a948156af6e886bc46a6c6c5fb10a087a">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a82a52062d9259c2c546d7bf8072b7a72" name="a82a52062d9259c2c546d7bf8072b7a72"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a82a52062d9259c2c546d7bf8072b7a72">◆ </a></span>startChannelScan() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::startChannelScan </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="union_channel_scan_config__t.html">ChannelScanConfig_t</a> & </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven channel activity detection method. interrupt will be activated when packet is detected. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>Scan configuration structure. Interpretation depends on currently active modem. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#ab073ade3f6b9bbb383e388904812f575">LR11x0</a>, <a class="el" href="class_s_x126x.html#a09a8fe05c23c652c7ace2e2f1bf51d93">SX126x</a>, and <a class="el" href="class_s_x128x.html#acdee68d9be73509f464226722551c4d9">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a88a10657bd2215a11a2331f937414b55" name="a88a10657bd2215a11a2331f937414b55"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a88a10657bd2215a11a2331f937414b55">◆ </a></span>startDirect()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::startDirect </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configure module parameters for direct modes. Must be called prior to "ham" modes like RTTY or AX.25. Only available in FSK mode. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a18664ad615c5507ff1690baaca90b094" name="a18664ad615c5507ff1690baaca90b094"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a18664ad615c5507ff1690baaca90b094">◆ </a></span>startReceive() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::startReceive </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets module to received mode using its default configuration. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#a18664ad615c5507ff1690baaca90b094">LR11x0</a>, <a class="el" href="class_s_x126x.html#a18664ad615c5507ff1690baaca90b094">SX126x</a>, <a class="el" href="class_s_x127x.html#a18664ad615c5507ff1690baaca90b094">SX127x</a>, <a class="el" href="class_s_x128x.html#a18664ad615c5507ff1690baaca90b094">SX128x</a>, <a class="el" href="class_c_c1101.html#ae71e947abf6a07b194c6c6d64fd3eb19">CC1101</a>, <a class="el" href="class_l_r11x0.html#aa6ce285cc1b76ce028db6442a421ed8d">LR11x0</a>, <a class="el" href="classn_r_f24.html#a3c6aa3622c887118fb8d8cb2689fdff2">nRF24</a>, <a class="el" href="class_r_f69.html#a3bece228d369dcc1aab6a5b29d0685a8">RF69</a>, <a class="el" href="class_si443x.html#ae188dec3175a3aec96844a613e911500">Si443x</a>, <a class="el" href="class_s_x126x.html#a66ad433561b02fe61b09afd735ce56cc">SX126x</a>, <a class="el" href="class_s_x127x.html#abbe1076252a366c3c4aa323fdff7d40c">SX127x</a>, and <a class="el" href="class_s_x128x.html#a803eaca8bb7fdfa3570cf4aa95f8e729">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae93500dfbcfd39837e04c0f3eaa40d97" name="ae93500dfbcfd39837e04c0f3eaa40d97"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae93500dfbcfd39837e04c0f3eaa40d97">◆ </a></span>startReceive() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::startReceive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>timeout</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> </td>
|
|
<td class="paramname"><em>irqFlags</em> = <code>RADIOLIB_IRQ_RX_DEFAULT_FLAGS</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> </td>
|
|
<td class="paramname"><em>irqMask</em> = <code>RADIOLIB_IRQ_RX_DEFAULT_MASK</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven receive method. A DIO pin will be activated when full packet is received. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">timeout</td><td>Raw timeout value. Some modules use this argument to specify operation mode (single vs. continuous receive). </td></tr>
|
|
<tr><td class="paramname">irqFlags</td><td>Sets the IRQ flags. </td></tr>
|
|
<tr><td class="paramname">irqMask</td><td>Sets the mask of IRQ flags that will trigger the radio interrupt pin. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Packet length, needed for some modules under special circumstances (e.g. LoRa implicit header mode). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_l_r11x0.html#ae93500dfbcfd39837e04c0f3eaa40d97">LR11x0</a>, <a class="el" href="class_s_x126x.html#ae93500dfbcfd39837e04c0f3eaa40d97">SX126x</a>, <a class="el" href="class_s_x127x.html#ae93500dfbcfd39837e04c0f3eaa40d97">SX127x</a>, <a class="el" href="class_s_x128x.html#ae93500dfbcfd39837e04c0f3eaa40d97">SX128x</a>, <a class="el" href="class_c_c1101.html#abf153c8fcf2a0d60439426b03692642e">CC1101</a>, <a class="el" href="classn_r_f24.html#a38b0084ad11090f918f4f370b9df7514">nRF24</a>, <a class="el" href="class_r_f69.html#a21ae7524fe573f1a7e74dee342418222">RF69</a>, and <a class="el" href="class_si443x.html#ad5adec16d570b0d1b09420919dbe77e4">Si443x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a923654706eff5118ef6e84214e837f27" name="a923654706eff5118ef6e84214e837f27"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a923654706eff5118ef6e84214e837f27">◆ </a></span>startTransmit() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::startTransmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>str</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>addr</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">str</td><td>C-string that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. Only used in FSK mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af79757dbbd62e080c1bad2e608ab940c" name="af79757dbbd62e080c1bad2e608ab940c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af79757dbbd62e080c1bad2e608ab940c">◆ </a></span>startTransmit() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::startTransmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>addr</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven binary transmit method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Binary data that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of binary data to transmit (in bytes). </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. Only used in FSK mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="classn_r_f24.html#a8b2365ad11840d1d05b0e17b37ddacd2">nRF24</a>, <a class="el" href="class_c_c1101.html#af79757dbbd62e080c1bad2e608ab940c">CC1101</a>, <a class="el" href="class_l_r11x0.html#af79757dbbd62e080c1bad2e608ab940c">LR11x0</a>, <a class="el" href="classn_r_f24.html#af79757dbbd62e080c1bad2e608ab940c">nRF24</a>, <a class="el" href="class_r_f69.html#af79757dbbd62e080c1bad2e608ab940c">RF69</a>, <a class="el" href="class_si443x.html#af79757dbbd62e080c1bad2e608ab940c">Si443x</a>, <a class="el" href="class_s_x126x.html#af79757dbbd62e080c1bad2e608ab940c">SX126x</a>, <a class="el" href="class_s_x127x.html#af79757dbbd62e080c1bad2e608ab940c">SX127x</a>, <a class="el" href="class_s_x128x.html#af79757dbbd62e080c1bad2e608ab940c">SX128x</a>, <a class="el" href="class_c_c1101.html#a6ff7e4066d189482c142e05384a38df0">CC1101</a>, <a class="el" href="class_r_f69.html#af645f6b5d37812f6bb9ec11788e12066">RF69</a>, and <a class="el" href="class_si443x.html#a187ea9ee96a67cd48e5b28be5b237c95">Si443x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a492b2d057dd803c3884fa1adc8e22534" name="a492b2d057dd803c3884fa1adc8e22534"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a492b2d057dd803c3884fa1adc8e22534">◆ </a></span>transmit() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::transmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>str</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>addr</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>C-string transmit method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">str</td><td>C-string that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. Only used in FSK mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ada508497ee2e70170da3afe078e2fe0e" name="ada508497ee2e70170da3afe078e2fe0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ada508497ee2e70170da3afe078e2fe0e">◆ </a></span>transmit() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::transmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>addr</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Binary transmit method. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Binary data that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of binary data to transmit (in bytes). </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. Only used in FSK mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="classn_r_f24.html#af7c4cf05b992d8a97331b9888e95fc2f">nRF24</a>, <a class="el" href="class_c_c1101.html#ada508497ee2e70170da3afe078e2fe0e">CC1101</a>, <a class="el" href="class_l_r11x0.html#ada508497ee2e70170da3afe078e2fe0e">LR11x0</a>, <a class="el" href="classn_r_f24.html#ada508497ee2e70170da3afe078e2fe0e">nRF24</a>, <a class="el" href="class_r_f69.html#ada508497ee2e70170da3afe078e2fe0e">RF69</a>, <a class="el" href="class_si443x.html#ada508497ee2e70170da3afe078e2fe0e">Si443x</a>, <a class="el" href="class_s_x126x.html#ada508497ee2e70170da3afe078e2fe0e">SX126x</a>, <a class="el" href="class_s_x127x.html#ada508497ee2e70170da3afe078e2fe0e">SX127x</a>, <a class="el" href="class_s_x128x.html#ada508497ee2e70170da3afe078e2fe0e">SX128x</a>, <a class="el" href="class_c_c1101.html#a5086eb8a27aa842e94d1df54f385c39b">CC1101</a>, <a class="el" href="class_l_r11x0.html#a21e865665318dece7d95336a275dd973">LR11x0</a>, <a class="el" href="class_r_f69.html#a8d68f041b20ed765f2ff2fbdff06171f">RF69</a>, <a class="el" href="class_si443x.html#a379fb39c9ab79aa67601c84736b1fec4">Si443x</a>, <a class="el" href="class_s_x126x.html#a5fa48e147ee54e1b0fc4d28ef5247180">SX126x</a>, <a class="el" href="class_s_x127x.html#a75cb0d8810a5ce025d3bf5b51ca263d6">SX127x</a>, and <a class="el" href="class_s_x128x.html#a45f4ac293d869a35ad737032efa8e884">SX128x</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa4c99ac794ee653c2061be4201724b65" name="aa4c99ac794ee653c2061be4201724b65"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa4c99ac794ee653c2061be4201724b65">◆ </a></span>transmitDirect()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::transmitDirect </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>frf</em> = <code>0</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module class. While in direct mode, the module will not be able to transmit or receive packets. Can only be activated in FSK mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">frf</td><td>24-bit raw frequency value to start transmitting at. Required for quick frequency shifts in RTTY. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_c_c1101.html#a240eef8fa7d838d76f3c11086dc50e46">CC1101</a>, <a class="el" href="class_l_r11x0.html#ae077957969f6274a53f63b314b6f1359">LR11x0</a>, <a class="el" href="classn_r_f24.html#a090bb64f65309efabfa1ffd86daa2303">nRF24</a>, <a class="el" href="class_r_f69.html#a222682569338abb49d6952430b6eebdd">RF69</a>, <a class="el" href="class_si443x.html#a5a86a2032c4b876c1c8e4a7cf4730c99">Si443x</a>, <a class="el" href="class_s_x126x.html#a921aa8afb8d33b2660731c1f8d67664b">SX126x</a>, <a class="el" href="class_s_x127x.html#aefeeb9f7192e11a75b5dfb1ab8488e84">SX127x</a>, <a class="el" href="class_s_x128x.html#a53892566b0259d348158efe3c3c3601a">SX128x</a>, and <a class="el" href="class_external_radio.html#a25be77aea48cfbdcae05ed32b660daef">ExternalRadio</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/protocols/PhysicalLayer/<a class="el" href="_physical_layer_8h_source.html">PhysicalLayer.h</a></li>
|
|
<li>src/protocols/PhysicalLayer/<b>PhysicalLayer.cpp</b></li>
|
|
</ul>
|
|
</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="class_physical_layer.html">PhysicalLayer</a></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.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|