615 lines
73 KiB
HTML
615 lines
73 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: SX1268 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>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">RadioLib
|
|
</div>
|
|
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</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">
|
|
$(document).ready(function(){initNavTree('class_s_x1268.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_s_x1268-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">SX1268 Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Derived class for SX1268 modules.
|
|
<a href="class_s_x1268.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_s_x1268_8h_source.html">SX1268.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for SX1268:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_s_x1268.png" usemap="#SX1268_map" alt=""/>
|
|
<map id="SX1268_map" name="SX1268_map">
|
|
<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="0,56,93,80"/>
|
|
<area href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN..." alt="PhysicalLayer" shape="rect" coords="0,0,93,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a6bc50597d50fd9a2387628e452eac42f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1268.html#a6bc50597d50fd9a2387628e452eac42f">SX1268</a> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
|
<tr class="memdesc:a6bc50597d50fd9a2387628e452eac42f"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a6bc50597d50fd9a2387628e452eac42f">More...</a><br /></td></tr>
|
|
<tr class="separator:a6bc50597d50fd9a2387628e452eac42f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a19554c257984c0806ae95ee209dfa296"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1268.html#a19554c257984c0806ae95ee209dfa296">begin</a> (float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=SX126X_SYNC_WORD_PRIVATE, int8_t power=10, uint16_t preambleLength=8, float tcxoVoltage=1.6, bool useRegulatorLDO=false)</td></tr>
|
|
<tr class="memdesc:a19554c257984c0806ae95ee209dfa296"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for LoRa modem. <a href="#a19554c257984c0806ae95ee209dfa296">More...</a><br /></td></tr>
|
|
<tr class="separator:a19554c257984c0806ae95ee209dfa296"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6523b6928ee5ed26e205b07ee4f07b60"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1268.html#a6523b6928ee5ed26e205b07ee4f07b60">beginFSK</a> (float freq=434.0, float br=48.0, float freqDev=50.0, float rxBw=156.2, int8_t power=10, uint16_t preambleLength=16, float tcxoVoltage=1.6, bool useRegulatorLDO=false)</td></tr>
|
|
<tr class="memdesc:a6523b6928ee5ed26e205b07ee4f07b60"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for FSK modem. <a href="#a6523b6928ee5ed26e205b07ee4f07b60">More...</a><br /></td></tr>
|
|
<tr class="separator:a6523b6928ee5ed26e205b07ee4f07b60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ad998275281de5c6f24f8a64db88052"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1268.html#a6ad998275281de5c6f24f8a64db88052">setFrequency</a> (float freq, bool calibrate=true)</td></tr>
|
|
<tr class="memdesc:a6ad998275281de5c6f24f8a64db88052"><td class="mdescLeft"> </td><td class="mdescRight">Sets carrier frequency. Allowed values are in range from 410.0 to 810.0 MHz. <a href="#a6ad998275281de5c6f24f8a64db88052">More...</a><br /></td></tr>
|
|
<tr class="separator:a6ad998275281de5c6f24f8a64db88052"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b0744aa46fbb4f8c738b010dfcc9b45"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1268.html#a5b0744aa46fbb4f8c738b010dfcc9b45">setOutputPower</a> (int8_t power)</td></tr>
|
|
<tr class="memdesc:a5b0744aa46fbb4f8c738b010dfcc9b45"><td class="mdescLeft"> </td><td class="mdescRight">Sets output power. Allowed values are in range from -9 to 22 dBm. <a href="#a5b0744aa46fbb4f8c738b010dfcc9b45">More...</a><br /></td></tr>
|
|
<tr class="separator:a5b0744aa46fbb4f8c738b010dfcc9b45"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_s_x126x"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_s_x126x')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_s_x126x.html">SX126x</a></td></tr>
|
|
<tr class="memitem:aaca5a8fa8a3e634dd1b5b4c2bb5058d8 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#aaca5a8fa8a3e634dd1b5b4c2bb5058d8">SX126x</a> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
|
<tr class="memdesc:aaca5a8fa8a3e634dd1b5b4c2bb5058d8 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_s_x126x.html#aaca5a8fa8a3e634dd1b5b4c2bb5058d8">More...</a><br /></td></tr>
|
|
<tr class="separator:aaca5a8fa8a3e634dd1b5b4c2bb5058d8 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b97488c6887df2e0291bba1b852605e inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a1b97488c6887df2e0291bba1b852605e">begin</a> (float bw, uint8_t sf, uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)</td></tr>
|
|
<tr class="memdesc:a1b97488c6887df2e0291bba1b852605e inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for LoRa modem. <a href="class_s_x126x.html#a1b97488c6887df2e0291bba1b852605e">More...</a><br /></td></tr>
|
|
<tr class="separator:a1b97488c6887df2e0291bba1b852605e inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2e500e5b6044ccab8f6b19af4ffa917c inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a2e500e5b6044ccab8f6b19af4ffa917c">beginFSK</a> (float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)</td></tr>
|
|
<tr class="memdesc:a2e500e5b6044ccab8f6b19af4ffa917c inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for FSK modem. <a href="class_s_x126x.html#a2e500e5b6044ccab8f6b19af4ffa917c">More...</a><br /></td></tr>
|
|
<tr class="separator:a2e500e5b6044ccab8f6b19af4ffa917c inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9aa6dd05dd32ef717a06cc8ba28ff71f inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a9aa6dd05dd32ef717a06cc8ba28ff71f">reset</a> (bool verify=true)</td></tr>
|
|
<tr class="memdesc:a9aa6dd05dd32ef717a06cc8ba28ff71f inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Reset method. Will reset the chip to the default state using RST pin. <a href="class_s_x126x.html#a9aa6dd05dd32ef717a06cc8ba28ff71f">More...</a><br /></td></tr>
|
|
<tr class="separator:a9aa6dd05dd32ef717a06cc8ba28ff71f inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aab18364237ddac0c56aeaf63f08cf009 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#aab18364237ddac0c56aeaf63f08cf009">transmit</a> (uint8_t *data, size_t len, uint8_t addr=0) override</td></tr>
|
|
<tr class="memdesc:aab18364237ddac0c56aeaf63f08cf009 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Blocking binary transmit method. Overloads for string-based transmissions are implemented in <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN...">PhysicalLayer</a>. <a href="class_s_x126x.html#aab18364237ddac0c56aeaf63f08cf009">More...</a><br /></td></tr>
|
|
<tr class="separator:aab18364237ddac0c56aeaf63f08cf009 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3db6b29c482d94eef8a43cd8b5751c0 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ae3db6b29c482d94eef8a43cd8b5751c0">receive</a> (uint8_t *data, size_t len) override</td></tr>
|
|
<tr class="memdesc:ae3db6b29c482d94eef8a43cd8b5751c0 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Blocking binary receive method. Overloads for string-based transmissions are implemented in <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN...">PhysicalLayer</a>. <a href="class_s_x126x.html#ae3db6b29c482d94eef8a43cd8b5751c0">More...</a><br /></td></tr>
|
|
<tr class="separator:ae3db6b29c482d94eef8a43cd8b5751c0 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a921aa8afb8d33b2660731c1f8d67664b inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a921aa8afb8d33b2660731c1f8d67664b">transmitDirect</a> (uint32_t frf=0) override</td></tr>
|
|
<tr class="memdesc:a921aa8afb8d33b2660731c1f8d67664b inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Starts direct mode transmission. <a href="class_s_x126x.html#a921aa8afb8d33b2660731c1f8d67664b">More...</a><br /></td></tr>
|
|
<tr class="separator:a921aa8afb8d33b2660731c1f8d67664b inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8a18aee2bf05793aa29b5cf6b47bb435 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a8a18aee2bf05793aa29b5cf6b47bb435">receiveDirect</a> () override</td></tr>
|
|
<tr class="memdesc:a8a18aee2bf05793aa29b5cf6b47bb435 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Starts direct mode reception. Only implemented for <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN...">PhysicalLayer</a> compatibility, as SX126x series does not support direct mode reception. Will always return ERR_UNKNOWN. <a href="class_s_x126x.html#a8a18aee2bf05793aa29b5cf6b47bb435">More...</a><br /></td></tr>
|
|
<tr class="separator:a8a18aee2bf05793aa29b5cf6b47bb435 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9f24414bd684434c310df54b3558f21 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ae9f24414bd684434c310df54b3558f21">scanChannel</a> ()</td></tr>
|
|
<tr class="memdesc:ae9f24414bd684434c310df54b3558f21 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. <a href="class_s_x126x.html#ae9f24414bd684434c310df54b3558f21">More...</a><br /></td></tr>
|
|
<tr class="separator:ae9f24414bd684434c310df54b3558f21 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb5509f0705cdd971065251ed6b2fb4e inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#afb5509f0705cdd971065251ed6b2fb4e">sleep</a> (bool retainConfig=true)</td></tr>
|
|
<tr class="memdesc:afb5509f0705cdd971065251ed6b2fb4e inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets the module to sleep mode. <a href="class_s_x126x.html#afb5509f0705cdd971065251ed6b2fb4e">More...</a><br /></td></tr>
|
|
<tr class="separator:afb5509f0705cdd971065251ed6b2fb4e inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a1579e2557c36a4a34b09039c0d0c71 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a7a1579e2557c36a4a34b09039c0d0c71">standby</a> () override</td></tr>
|
|
<tr class="memdesc:a7a1579e2557c36a4a34b09039c0d0c71 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets the module to standby mode (overload for <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN...">PhysicalLayer</a> compatibility, uses 13 MHz RC oscillator). <a href="class_s_x126x.html#a7a1579e2557c36a4a34b09039c0d0c71">More...</a><br /></td></tr>
|
|
<tr class="separator:a7a1579e2557c36a4a34b09039c0d0c71 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7569396f09f3867dc1bd4d4a0613acd inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ad7569396f09f3867dc1bd4d4a0613acd">standby</a> (uint8_t mode)</td></tr>
|
|
<tr class="memdesc:ad7569396f09f3867dc1bd4d4a0613acd inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets the module to standby mode. <a href="class_s_x126x.html#ad7569396f09f3867dc1bd4d4a0613acd">More...</a><br /></td></tr>
|
|
<tr class="separator:ad7569396f09f3867dc1bd4d4a0613acd inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0da667fe702d7b4aafaa4bf7e69ea40d inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a0da667fe702d7b4aafaa4bf7e69ea40d">setDio1Action</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:a0da667fe702d7b4aafaa4bf7e69ea40d inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when DIO1 activates. <a href="class_s_x126x.html#a0da667fe702d7b4aafaa4bf7e69ea40d">More...</a><br /></td></tr>
|
|
<tr class="separator:a0da667fe702d7b4aafaa4bf7e69ea40d inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6848afe4c16a47edb3e0b342a86ecdfd inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top"><a id="a6848afe4c16a47edb3e0b342a86ecdfd"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a6848afe4c16a47edb3e0b342a86ecdfd">clearDio1Action</a> ()</td></tr>
|
|
<tr class="memdesc:a6848afe4c16a47edb3e0b342a86ecdfd inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when DIO1 activates. <br /></td></tr>
|
|
<tr class="separator:a6848afe4c16a47edb3e0b342a86ecdfd inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab843614658a79db7aa24e48d5b6e84f1 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ab843614658a79db7aa24e48d5b6e84f1">startTransmit</a> (uint8_t *data, size_t len, uint8_t addr=0) override</td></tr>
|
|
<tr class="memdesc:ab843614658a79db7aa24e48d5b6e84f1 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven binary transmit method. Overloads for string-based transmissions are implemented in <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN...">PhysicalLayer</a>. <a href="class_s_x126x.html#ab843614658a79db7aa24e48d5b6e84f1">More...</a><br /></td></tr>
|
|
<tr class="separator:ab843614658a79db7aa24e48d5b6e84f1 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5052dc09f4b10ee22e169129f368685f inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a5052dc09f4b10ee22e169129f368685f">startReceive</a> (uint32_t timeout=SX126X_RX_TIMEOUT_INF)</td></tr>
|
|
<tr class="memdesc:a5052dc09f4b10ee22e169129f368685f inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven receive method. DIO1 will be activated when full packet is received. <a href="class_s_x126x.html#a5052dc09f4b10ee22e169129f368685f">More...</a><br /></td></tr>
|
|
<tr class="separator:a5052dc09f4b10ee22e169129f368685f inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adc46b6adda2d0e82e25ed1fc78274136 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#adc46b6adda2d0e82e25ed1fc78274136">startReceiveDutyCycle</a> (uint32_t rxPeriod, uint32_t sleepPeriod)</td></tr>
|
|
<tr class="memdesc:adc46b6adda2d0e82e25ed1fc78274136 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen. Note that this function assumes the unit will take 500us + TCXO_delay to change state. See datasheet section 13.1.7, version 1.2. <a href="class_s_x126x.html#adc46b6adda2d0e82e25ed1fc78274136">More...</a><br /></td></tr>
|
|
<tr class="separator:adc46b6adda2d0e82e25ed1fc78274136 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6b50cb78f02a3d93939437eb48489d3f inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a6b50cb78f02a3d93939437eb48489d3f">startReceiveDutyCycleAuto</a> (uint16_t senderPreambleLength=0, uint16_t minSymbols=8)</td></tr>
|
|
<tr class="memdesc:a6b50cb78f02a3d93939437eb48489d3f inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Calls <a class="el" href="class_s_x126x.html#adc46b6adda2d0e82e25ed1fc78274136">startReceiveDutyCycle</a> with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages. <a href="class_s_x126x.html#a6b50cb78f02a3d93939437eb48489d3f">More...</a><br /></td></tr>
|
|
<tr class="separator:a6b50cb78f02a3d93939437eb48489d3f inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3350cbfab628956c1a456383ac7bb2b2 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a3350cbfab628956c1a456383ac7bb2b2">readData</a> (uint8_t *data, size_t len) override</td></tr>
|
|
<tr class="memdesc:a3350cbfab628956c1a456383ac7bb2b2 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Reads data received after calling startReceive method. <a href="class_s_x126x.html#a3350cbfab628956c1a456383ac7bb2b2">More...</a><br /></td></tr>
|
|
<tr class="separator:a3350cbfab628956c1a456383ac7bb2b2 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f60df59c80241d98ce078c0417a7f08 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a2f60df59c80241d98ce078c0417a7f08">setBandwidth</a> (float bw)</td></tr>
|
|
<tr class="memdesc:a2f60df59c80241d98ce078c0417a7f08 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets LoRa bandwidth. Allowed values are 7.8, 10.4, 15.6, 20.8, 31.25, 41.7, 62.5, 125.0, 250.0 and 500.0 kHz. <a href="class_s_x126x.html#a2f60df59c80241d98ce078c0417a7f08">More...</a><br /></td></tr>
|
|
<tr class="separator:a2f60df59c80241d98ce078c0417a7f08 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae5993359ace652fbdc862eb23fdd263d inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ae5993359ace652fbdc862eb23fdd263d">setSpreadingFactor</a> (uint8_t sf)</td></tr>
|
|
<tr class="memdesc:ae5993359ace652fbdc862eb23fdd263d inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets LoRa spreading factor. Allowed values range from 5 to 12. <a href="class_s_x126x.html#ae5993359ace652fbdc862eb23fdd263d">More...</a><br /></td></tr>
|
|
<tr class="separator:ae5993359ace652fbdc862eb23fdd263d inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afd3113858966e878e9c67a1e710bd586 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#afd3113858966e878e9c67a1e710bd586">setCodingRate</a> (uint8_t cr)</td></tr>
|
|
<tr class="memdesc:afd3113858966e878e9c67a1e710bd586 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets LoRa coding rate denominator. Allowed values range from 5 to 8. <a href="class_s_x126x.html#afd3113858966e878e9c67a1e710bd586">More...</a><br /></td></tr>
|
|
<tr class="separator:afd3113858966e878e9c67a1e710bd586 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d92dce566f8aefa836fe8f332e9560f inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a9d92dce566f8aefa836fe8f332e9560f">setSyncWord</a> (uint8_t syncWord, uint8_t controlBits=0x44)</td></tr>
|
|
<tr class="memdesc:a9d92dce566f8aefa836fe8f332e9560f inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets LoRa sync word. <a href="class_s_x126x.html#a9d92dce566f8aefa836fe8f332e9560f">More...</a><br /></td></tr>
|
|
<tr class="separator:a9d92dce566f8aefa836fe8f332e9560f inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8f971dca834be7e0470a9a9f0c01854e inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a8f971dca834be7e0470a9a9f0c01854e">setCurrentLimit</a> (float currentLimit)</td></tr>
|
|
<tr class="memdesc:a8f971dca834be7e0470a9a9f0c01854e inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets current protection limit. Can be set in 0.25 mA steps. <a href="class_s_x126x.html#a8f971dca834be7e0470a9a9f0c01854e">More...</a><br /></td></tr>
|
|
<tr class="separator:a8f971dca834be7e0470a9a9f0c01854e inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa668babb0bd129b2facee9fd280525ab inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#aa668babb0bd129b2facee9fd280525ab">getCurrentLimit</a> ()</td></tr>
|
|
<tr class="memdesc:aa668babb0bd129b2facee9fd280525ab inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Reads current protection limit. <a href="class_s_x126x.html#aa668babb0bd129b2facee9fd280525ab">More...</a><br /></td></tr>
|
|
<tr class="separator:aa668babb0bd129b2facee9fd280525ab inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab00f765bbfbfaa8c693532ea3a90c29b inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ab00f765bbfbfaa8c693532ea3a90c29b">setPreambleLength</a> (uint16_t preambleLength)</td></tr>
|
|
<tr class="memdesc:ab00f765bbfbfaa8c693532ea3a90c29b inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535. <a href="class_s_x126x.html#ab00f765bbfbfaa8c693532ea3a90c29b">More...</a><br /></td></tr>
|
|
<tr class="separator:ab00f765bbfbfaa8c693532ea3a90c29b inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7cd95a5f2e39ae8fb1a3040e77fa21a3 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a7cd95a5f2e39ae8fb1a3040e77fa21a3">setFrequencyDeviation</a> (float freqDev) override</td></tr>
|
|
<tr class="memdesc:a7cd95a5f2e39ae8fb1a3040e77fa21a3 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz. <a href="class_s_x126x.html#a7cd95a5f2e39ae8fb1a3040e77fa21a3">More...</a><br /></td></tr>
|
|
<tr class="separator:a7cd95a5f2e39ae8fb1a3040e77fa21a3 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7deeef45d7f64a4018a3e56aaea4eb0e inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a7deeef45d7f64a4018a3e56aaea4eb0e">setBitRate</a> (float br)</td></tr>
|
|
<tr class="memdesc:a7deeef45d7f64a4018a3e56aaea4eb0e inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps. <a href="class_s_x126x.html#a7deeef45d7f64a4018a3e56aaea4eb0e">More...</a><br /></td></tr>
|
|
<tr class="separator:a7deeef45d7f64a4018a3e56aaea4eb0e inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59d443c02d4620cda32c63a00c6bcc22 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a59d443c02d4620cda32c63a00c6bcc22">setRxBandwidth</a> (float rxBw)</td></tr>
|
|
<tr class="memdesc:a59d443c02d4620cda32c63a00c6bcc22 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK receiver bandwidth. Allowed values are 4.8, 5.8, 7.3, 9.7, 11.7, 14.6, 19.5, 23.4, 29.3, 39.0, 46.9, 58.6, 78.2, 93.8, 117.3, 156.2, 187.2, 234.3, 312.0, 373.6 and 467.0 kHz. <a href="class_s_x126x.html#a59d443c02d4620cda32c63a00c6bcc22">More...</a><br /></td></tr>
|
|
<tr class="separator:a59d443c02d4620cda32c63a00c6bcc22 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d8f4deb555844b24c2426dd86e69676 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a1d8f4deb555844b24c2426dd86e69676">setDataShaping</a> (uint8_t sh) override</td></tr>
|
|
<tr class="memdesc:a1d8f4deb555844b24c2426dd86e69676 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPING_0_3, RADIOLIB_SHAPING_0_5, RADIOLIB_SHAPING_0_7 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping. <a href="class_s_x126x.html#a1d8f4deb555844b24c2426dd86e69676">More...</a><br /></td></tr>
|
|
<tr class="separator:a1d8f4deb555844b24c2426dd86e69676 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38e6d7831f35893a5b8328c10a2901bf inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a38e6d7831f35893a5b8328c10a2901bf">setSyncWord</a> (uint8_t *syncWord, uint8_t len)</td></tr>
|
|
<tr class="memdesc:a38e6d7831f35893a5b8328c10a2901bf inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK sync word in the form of array of up to 8 bytes. <a href="class_s_x126x.html#a38e6d7831f35893a5b8328c10a2901bf">More...</a><br /></td></tr>
|
|
<tr class="separator:a38e6d7831f35893a5b8328c10a2901bf inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac594fbb30c5010658c970a64654c7162 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ac594fbb30c5010658c970a64654c7162">setSyncBits</a> (uint8_t *syncWord, uint8_t bitsLen)</td></tr>
|
|
<tr class="memdesc:ac594fbb30c5010658c970a64654c7162 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK sync word in the form of array of up to 8 bytes. <a href="class_s_x126x.html#ac594fbb30c5010658c970a64654c7162">More...</a><br /></td></tr>
|
|
<tr class="separator:ac594fbb30c5010658c970a64654c7162 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a514cabe74bbe3434d7e4f244c4077752 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a514cabe74bbe3434d7e4f244c4077752">setNodeAddress</a> (uint8_t nodeAddr)</td></tr>
|
|
<tr class="memdesc:a514cabe74bbe3434d7e4f244c4077752 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets node address. Calling this method will also enable address filtering for node address only. <a href="class_s_x126x.html#a514cabe74bbe3434d7e4f244c4077752">More...</a><br /></td></tr>
|
|
<tr class="separator:a514cabe74bbe3434d7e4f244c4077752 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd8eea7e468db3d6064c19d4934d5034 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#abd8eea7e468db3d6064c19d4934d5034">setBroadcastAddress</a> (uint8_t broadAddr)</td></tr>
|
|
<tr class="memdesc:abd8eea7e468db3d6064c19d4934d5034 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets broadcast address. Calling this method will also enable address filtering for node and broadcast address. <a href="class_s_x126x.html#abd8eea7e468db3d6064c19d4934d5034">More...</a><br /></td></tr>
|
|
<tr class="separator:abd8eea7e468db3d6064c19d4934d5034 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc3a7a42c401b6c44e00cb6c5b9696f2 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#afc3a7a42c401b6c44e00cb6c5b9696f2">disableAddressFiltering</a> ()</td></tr>
|
|
<tr class="memdesc:afc3a7a42c401b6c44e00cb6c5b9696f2 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Disables address filtering. Calling this method will also erase previously set addresses. <a href="class_s_x126x.html#afc3a7a42c401b6c44e00cb6c5b9696f2">More...</a><br /></td></tr>
|
|
<tr class="separator:afc3a7a42c401b6c44e00cb6c5b9696f2 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a95007639c2648a1dbb614493224606f1 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a95007639c2648a1dbb614493224606f1">setCRC</a> (uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)</td></tr>
|
|
<tr class="memdesc:a95007639c2648a1dbb614493224606f1 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets CRC configuration. <a href="class_s_x126x.html#a95007639c2648a1dbb614493224606f1">More...</a><br /></td></tr>
|
|
<tr class="separator:a95007639c2648a1dbb614493224606f1 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a67702de41ae866b9f9d73234fc9ae376 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a67702de41ae866b9f9d73234fc9ae376">setWhitening</a> (bool enabled, uint16_t initial=0x0100)</td></tr>
|
|
<tr class="memdesc:a67702de41ae866b9f9d73234fc9ae376 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK whitening parameters. <a href="class_s_x126x.html#a67702de41ae866b9f9d73234fc9ae376">More...</a><br /></td></tr>
|
|
<tr class="separator:a67702de41ae866b9f9d73234fc9ae376 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a57bee6f4b3a3b7ec646ac8de347ee0d6 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a57bee6f4b3a3b7ec646ac8de347ee0d6">setTCXO</a> (float voltage, uint32_t delay=5000)</td></tr>
|
|
<tr class="memdesc:a57bee6f4b3a3b7ec646ac8de347ee0d6 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets TCXO (Temperature Compensated Crystal Oscillator) configuration. <a href="class_s_x126x.html#a57bee6f4b3a3b7ec646ac8de347ee0d6">More...</a><br /></td></tr>
|
|
<tr class="separator:a57bee6f4b3a3b7ec646ac8de347ee0d6 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae46e08d579f4acbad029b4cd4f4fffaf inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ae46e08d579f4acbad029b4cd4f4fffaf">setDio2AsRfSwitch</a> (bool enable=true)</td></tr>
|
|
<tr class="memdesc:ae46e08d579f4acbad029b4cd4f4fffaf inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Set DIO2 to function as RF switch (default in Semtech example designs). <a href="class_s_x126x.html#ae46e08d579f4acbad029b4cd4f4fffaf">More...</a><br /></td></tr>
|
|
<tr class="separator:ae46e08d579f4acbad029b4cd4f4fffaf inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acbe2d75b1e2df8bcc58c4fd9d8e6e4f9 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#acbe2d75b1e2df8bcc58c4fd9d8e6e4f9">getDataRate</a> () const</td></tr>
|
|
<tr class="memdesc:acbe2d75b1e2df8bcc58c4fd9d8e6e4f9 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Gets effective data rate for the last transmitted packet. The value is calculated only for payload bytes. <a href="class_s_x126x.html#acbe2d75b1e2df8bcc58c4fd9d8e6e4f9">More...</a><br /></td></tr>
|
|
<tr class="separator:acbe2d75b1e2df8bcc58c4fd9d8e6e4f9 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e5f0032a91686b9673a48c908eb1925 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a0e5f0032a91686b9673a48c908eb1925">getRSSI</a> ()</td></tr>
|
|
<tr class="memdesc:a0e5f0032a91686b9673a48c908eb1925 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. <a href="class_s_x126x.html#a0e5f0032a91686b9673a48c908eb1925">More...</a><br /></td></tr>
|
|
<tr class="separator:a0e5f0032a91686b9673a48c908eb1925 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae36823d3539667bdf7d2f073bd4fa1ca inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ae36823d3539667bdf7d2f073bd4fa1ca">getSNR</a> ()</td></tr>
|
|
<tr class="memdesc:ae36823d3539667bdf7d2f073bd4fa1ca inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. <a href="class_s_x126x.html#ae36823d3539667bdf7d2f073bd4fa1ca">More...</a><br /></td></tr>
|
|
<tr class="separator:ae36823d3539667bdf7d2f073bd4fa1ca inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac4ef8c8751a3c09d64e431684840c987 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ac4ef8c8751a3c09d64e431684840c987">getPacketLength</a> (bool update=true) override</td></tr>
|
|
<tr class="memdesc:ac4ef8c8751a3c09d64e431684840c987 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Query modem for the packet length of received payload. <a href="class_s_x126x.html#ac4ef8c8751a3c09d64e431684840c987">More...</a><br /></td></tr>
|
|
<tr class="separator:ac4ef8c8751a3c09d64e431684840c987 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa768ce757a0f7ee66cdd72cab7a855fa inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#aa768ce757a0f7ee66cdd72cab7a855fa">fixedPacketLengthMode</a> (uint8_t len=SX126X_MAX_PACKET_LENGTH)</td></tr>
|
|
<tr class="memdesc:aa768ce757a0f7ee66cdd72cab7a855fa inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Set modem in fixed packet length mode. Available in FSK mode only. <a href="class_s_x126x.html#aa768ce757a0f7ee66cdd72cab7a855fa">More...</a><br /></td></tr>
|
|
<tr class="separator:aa768ce757a0f7ee66cdd72cab7a855fa inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa11ab2c6f4488daf2ece93288e05c504 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#aa11ab2c6f4488daf2ece93288e05c504">variablePacketLengthMode</a> (uint8_t maxLen=SX126X_MAX_PACKET_LENGTH)</td></tr>
|
|
<tr class="memdesc:aa11ab2c6f4488daf2ece93288e05c504 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Set modem in variable packet length mode. Available in FSK mode only. <a href="class_s_x126x.html#aa11ab2c6f4488daf2ece93288e05c504">More...</a><br /></td></tr>
|
|
<tr class="separator:aa11ab2c6f4488daf2ece93288e05c504 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7e342ddbef84cf845bef8f4448b8da10 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a7e342ddbef84cf845bef8f4448b8da10">getTimeOnAir</a> (size_t len)</td></tr>
|
|
<tr class="memdesc:a7e342ddbef84cf845bef8f4448b8da10 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Get expected time-on-air for a given size of payload. <a href="class_s_x126x.html#a7e342ddbef84cf845bef8f4448b8da10">More...</a><br /></td></tr>
|
|
<tr class="separator:a7e342ddbef84cf845bef8f4448b8da10 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae36664f9c605a8fe74b2f357e0ec3323 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ae36664f9c605a8fe74b2f357e0ec3323">getRSSIInst</a> ()</td></tr>
|
|
<tr class="memdesc:ae36664f9c605a8fe74b2f357e0ec3323 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Get instantaneous RSSI value during recption of the packet. Should switch to FSK receive mode for LBT implementation. <a href="class_s_x126x.html#ae36664f9c605a8fe74b2f357e0ec3323">More...</a><br /></td></tr>
|
|
<tr class="separator:ae36664f9c605a8fe74b2f357e0ec3323 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adec09cba71494bd927ad1da786606ca6 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#adec09cba71494bd927ad1da786606ca6">implicitHeader</a> (size_t len)</td></tr>
|
|
<tr class="memdesc:adec09cba71494bd927ad1da786606ca6 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Set implicit header mode for future reception/transmission. <a href="class_s_x126x.html#adec09cba71494bd927ad1da786606ca6">More...</a><br /></td></tr>
|
|
<tr class="separator:adec09cba71494bd927ad1da786606ca6 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3765f534418d4e0540c179621c019138 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a3765f534418d4e0540c179621c019138">explicitHeader</a> ()</td></tr>
|
|
<tr class="memdesc:a3765f534418d4e0540c179621c019138 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Set explicit header mode for future reception/transmission. <a href="class_s_x126x.html#a3765f534418d4e0540c179621c019138">More...</a><br /></td></tr>
|
|
<tr class="separator:a3765f534418d4e0540c179621c019138 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a21c263ce1a339faa74c568d9afb81cd2 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a21c263ce1a339faa74c568d9afb81cd2">setRegulatorLDO</a> ()</td></tr>
|
|
<tr class="memdesc:a21c263ce1a339faa74c568d9afb81cd2 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Set regulator mode to LDO. <a href="class_s_x126x.html#a21c263ce1a339faa74c568d9afb81cd2">More...</a><br /></td></tr>
|
|
<tr class="separator:a21c263ce1a339faa74c568d9afb81cd2 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ae69309ca0cf5f13c60f2d162916ff8 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a5ae69309ca0cf5f13c60f2d162916ff8">setRegulatorDCDC</a> ()</td></tr>
|
|
<tr class="memdesc:a5ae69309ca0cf5f13c60f2d162916ff8 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Set regulator mode to DC-DC. <a href="class_s_x126x.html#a5ae69309ca0cf5f13c60f2d162916ff8">More...</a><br /></td></tr>
|
|
<tr class="separator:a5ae69309ca0cf5f13c60f2d162916ff8 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b3eb51117558c58384b03de4b7bfe60 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a2b3eb51117558c58384b03de4b7bfe60">setEncoding</a> (uint8_t encoding) override</td></tr>
|
|
<tr class="memdesc:a2b3eb51117558c58384b03de4b7bfe60 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets transmission encoding. Available in FSK mode only. Serves only as alias for <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN...">PhysicalLayer</a> compatibility. <a href="class_s_x126x.html#a2b3eb51117558c58384b03de4b7bfe60">More...</a><br /></td></tr>
|
|
<tr class="separator:a2b3eb51117558c58384b03de4b7bfe60 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a288257242e483cb3eb6944333179dd26 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a288257242e483cb3eb6944333179dd26">setRfSwitchPins</a> (RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)</td></tr>
|
|
<tr class="memdesc:a288257242e483cb3eb6944333179dd26 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Some modules contain external RF switch controlled by two pins. This function gives RadioLib control over those two pins to automatically switch Rx and Tx state. When using automatic RF switch control, DO NOT change the pin mode of rxEn or txEn from Arduino sketch! <a href="class_s_x126x.html#a288257242e483cb3eb6944333179dd26">More...</a><br /></td></tr>
|
|
<tr class="separator:a288257242e483cb3eb6944333179dd26 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a420c23bb1861646e29f44c0f4c646ee8 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a420c23bb1861646e29f44c0f4c646ee8">forceLDRO</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:a420c23bb1861646e29f44c0f4c646ee8 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method, LDRO will always be set to the provided value, regardless of symbol length. To re-enable automatic LDRO configuration, call <a class="el" href="class_s_x126x.html#ab9ce38cfeaa36ddcc2d82b2974d7088c" title="Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method...">SX126x::autoLDRO()</a> <a href="class_s_x126x.html#a420c23bb1861646e29f44c0f4c646ee8">More...</a><br /></td></tr>
|
|
<tr class="separator:a420c23bb1861646e29f44c0f4c646ee8 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9ce38cfeaa36ddcc2d82b2974d7088c inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ab9ce38cfeaa36ddcc2d82b2974d7088c">autoLDRO</a> ()</td></tr>
|
|
<tr class="memdesc:ab9ce38cfeaa36ddcc2d82b2974d7088c inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method, LDRO will be enabled automatically when symbol length exceeds 16 ms. <a href="class_s_x126x.html#ab9ce38cfeaa36ddcc2d82b2974d7088c">More...</a><br /></td></tr>
|
|
<tr class="separator:ab9ce38cfeaa36ddcc2d82b2974d7088c inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3dd88861454d8b6e742470dee04961be inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a3dd88861454d8b6e742470dee04961be">random</a> ()</td></tr>
|
|
<tr class="memdesc:a3dd88861454d8b6e742470dee04961be inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Get one truly random byte from RSSI noise. <a href="class_s_x126x.html#a3dd88861454d8b6e742470dee04961be">More...</a><br /></td></tr>
|
|
<tr class="separator:a3dd88861454d8b6e742470dee04961be inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_physical_layer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_physical_layer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_physical_layer.html">PhysicalLayer</a></td></tr>
|
|
<tr class="memitem:a5e02457f1d519cf81b1590a182321c62 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a5e02457f1d519cf81b1590a182321c62">PhysicalLayer</a> (float freqStep, size_t maxPacketLength)</td></tr>
|
|
<tr class="memdesc:a5e02457f1d519cf81b1590a182321c62 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_physical_layer.html#a5e02457f1d519cf81b1590a182321c62">More...</a><br /></td></tr>
|
|
<tr class="separator:a5e02457f1d519cf81b1590a182321c62 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab139a34e03a6fd5a781cd54da21d308f inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">transmit</a> (__FlashStringHelper *fstr, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:ab139a34e03a6fd5a781cd54da21d308f inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Arduino Flash String transmit method. <a href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">More...</a><br /></td></tr>
|
|
<tr class="separator:ab139a34e03a6fd5a781cd54da21d308f inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb62c5a521aafc1e0525c58e9364482b inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#aeb62c5a521aafc1e0525c58e9364482b">transmit</a> (String &str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:aeb62c5a521aafc1e0525c58e9364482b inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Arduino String transmit method. <a href="class_physical_layer.html#aeb62c5a521aafc1e0525c58e9364482b">More...</a><br /></td></tr>
|
|
<tr class="separator:aeb62c5a521aafc1e0525c58e9364482b inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_physical_layer"><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 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">C-string transmit method. <a href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">More...</a><br /></td></tr>
|
|
<tr class="separator:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb1b090348d9091bfa3a0b5ba3d85b36 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">receive</a> (String &str, size_t len=0)</td></tr>
|
|
<tr class="memdesc:afb1b090348d9091bfa3a0b5ba3d85b36 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Arduino String receive method. <a href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">More...</a><br /></td></tr>
|
|
<tr class="separator:afb1b090348d9091bfa3a0b5ba3d85b36 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af068e6e862c99e39d0261a7971dd56db inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">startTransmit</a> (String &str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:af068e6e862c99e39d0261a7971dd56db inherit pub_methods_class_physical_layer"><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. <a href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">More...</a><br /></td></tr>
|
|
<tr class="separator:af068e6e862c99e39d0261a7971dd56db inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_physical_layer"><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 inherit pub_methods_class_physical_layer"><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. <a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">More...</a><br /></td></tr>
|
|
<tr class="separator:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8eed0e888a7c8742e89d2b850977de2 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">readData</a> (String &str, size_t len=0)</td></tr>
|
|
<tr class="memdesc:ae8eed0e888a7c8742e89d2b850977de2 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Reads data that was received after calling startReceive method. <a href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">More...</a><br /></td></tr>
|
|
<tr class="separator:ae8eed0e888a7c8742e89d2b850977de2 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a977e5236693960bb1c79090a201e9e1c inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a977e5236693960bb1c79090a201e9e1c">getFreqStep</a> () const</td></tr>
|
|
<tr class="memdesc:a977e5236693960bb1c79090a201e9e1c inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Gets the module frequency step size that was set in constructor. <a href="class_physical_layer.html#a977e5236693960bb1c79090a201e9e1c">More...</a><br /></td></tr>
|
|
<tr class="separator:a977e5236693960bb1c79090a201e9e1c inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd9171bd71aa80fb86113b612c42de53 inherit pub_methods_class_physical_layer"><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 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get truly random number in range 0 - max. <a href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">More...</a><br /></td></tr>
|
|
<tr class="separator:acd9171bd71aa80fb86113b612c42de53 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a76113e10481743094a1cd0280692b0a9 inherit pub_methods_class_physical_layer"><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 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get truly random number in range min - max. <a href="class_physical_layer.html#a76113e10481743094a1cd0280692b0a9">More...</a><br /></td></tr>
|
|
<tr class="separator:a76113e10481743094a1cd0280692b0a9 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88a10657bd2215a11a2331f937414b55 inherit pub_methods_class_physical_layer"><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 inherit pub_methods_class_physical_layer"><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. <a href="class_physical_layer.html#a88a10657bd2215a11a2331f937414b55">More...</a><br /></td></tr>
|
|
<tr class="separator:a88a10657bd2215a11a2331f937414b55 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Derived class for SX1268 modules. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a6bc50597d50fd9a2387628e452eac42f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6bc50597d50fd9a2387628e452eac42f">◆ </a></span>SX1268()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">SX1268::SX1268 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_module.html">Module</a> * </td>
|
|
<td class="paramname"><em>mod</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mod</td><td>Instance of <a class="el" href="class_module.html" title="Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class. ">Module</a> that will be used to communicate with the radio. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a19554c257984c0806ae95ee209dfa296"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a19554c257984c0806ae95ee209dfa296">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX1268::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freq</em> = <code>434.0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>bw</em> = <code>125.0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>sf</em> = <code>9</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>cr</em> = <code>7</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>syncWord</em> = <code>SX126X_SYNC_WORD_PRIVATE</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int8_t </td>
|
|
<td class="paramname"><em>power</em> = <code>10</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>preambleLength</em> = <code>8</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>tcxoVoltage</em> = <code>1.6</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>useRegulatorLDO</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialization method for LoRa modem. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">freq</td><td>Carrier frequency in MHz. Defaults to 434.0 MHz.</td></tr>
|
|
<tr><td class="paramname">bw</td><td>LoRa bandwidth in kHz. Defaults to 125.0 kHz.</td></tr>
|
|
<tr><td class="paramname">sf</td><td>LoRa spreading factor. Defaults to 9.</td></tr>
|
|
<tr><td class="paramname">cr</td><td>LoRa coding rate denominator. Defaults to 7 (coding rate 4/7).</td></tr>
|
|
<tr><td class="paramname">syncWord</td><td>2-byte LoRa sync word. Defaults to SX126X_SYNC_WORD_PRIVATE (0x12).</td></tr>
|
|
<tr><td class="paramname">power</td><td>Output power in dBm. Defaults to 10 dBm.</td></tr>
|
|
<tr><td class="paramname">preambleLength</td><td>LoRa preamble length in symbols. Defaults to 8 symbols.</td></tr>
|
|
<tr><td class="paramname">tcxoVoltage</td><td>TCXO reference voltage to be set on DIO3. Defaults to 1.6 V, set to 0 to skip.</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="a6523b6928ee5ed26e205b07ee4f07b60"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6523b6928ee5ed26e205b07ee4f07b60">◆ </a></span>beginFSK()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX1268::beginFSK </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freq</em> = <code>434.0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>br</em> = <code>48.0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freqDev</em> = <code>50.0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>rxBw</em> = <code>156.2</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int8_t </td>
|
|
<td class="paramname"><em>power</em> = <code>10</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>preambleLength</em> = <code>16</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>tcxoVoltage</em> = <code>1.6</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>useRegulatorLDO</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialization method for FSK modem. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">freq</td><td>Carrier frequency in MHz. Defaults to 434.0 MHz.</td></tr>
|
|
<tr><td class="paramname">br</td><td>FSK bit rate in kbps. Defaults to 48.0 kbps.</td></tr>
|
|
<tr><td class="paramname">freqDev</td><td>Frequency deviation from carrier frequency in kHz. Defaults to 50.0 kHz.</td></tr>
|
|
<tr><td class="paramname">rxBw</td><td>Receiver bandwidth in kHz. Defaults to 156.2 kHz.</td></tr>
|
|
<tr><td class="paramname">power</td><td>Output power in dBm. Defaults to 10 dBm.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>preambleLength FSK preamble length in bits. Defaults to 16 bits.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">tcxoVoltage</td><td>TCXO reference voltage to be set on DIO3. Defaults to 1.6 V, set to 0 to skip.</td></tr>
|
|
<tr><td class="paramname">useRegulatorLDO</td><td>Whether to use only LDO regulator (true) or DC-DC regulator (false). Defaults to false.</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="a6ad998275281de5c6f24f8a64db88052"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6ad998275281de5c6f24f8a64db88052">◆ </a></span>setFrequency()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX1268::setFrequency </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freq</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>calibrate</em> = <code>true</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets carrier frequency. Allowed values are in range from 410.0 to 810.0 MHz. </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>
|
|
<tr><td class="paramname">calibrate</td><td>Run image calibration.</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>
|
|
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000010">Todo:</a></b></dt><dd>integers only (all modules - frequency, data rate, bandwidth etc.) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5b0744aa46fbb4f8c738b010dfcc9b45"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5b0744aa46fbb4f8c738b010dfcc9b45">◆ </a></span>setOutputPower()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX1268::setOutputPower </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int8_t </td>
|
|
<td class="paramname"><em>power</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets output power. Allowed values are in range from -9 to 22 dBm. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">power</td><td>Output power to be set in dBm.</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>
|
|
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000011">Todo:</a></b></dt><dd>power ramp time configuration </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/modules/SX126x/<a class="el" href="_s_x1268_8h_source.html">SX1268.h</a></li>
|
|
<li>src/modules/SX126x/SX1268.cpp</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_s_x1268.html">SX1268</a></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|