kopia lustrzana https://github.com/jgromes/RadioLib
853 wiersze
115 KiB
HTML
853 wiersze
115 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: SX1262 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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">RadioLib
|
|
</div>
|
|
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('class_s_x1262.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_s_x1262-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">SX1262 Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Derived class for SX1262 modules.
|
|
<a href="class_s_x1262.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_s_x1262_8h_source.html">SX1262.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for SX1262:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_s_x1262.png" usemap="#SX1262_map" alt=""/>
|
|
<map id="SX1262_map" name="SX1262_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="103,56,196,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="103,0,196,24"/>
|
|
<area href="class_l_l_c_c68.html" title="Derived class for LLCC68 modules." alt="LLCC68" shape="rect" coords="0,168,93,192"/>
|
|
<area href="class_s_t_m32_w_lx.html" title="Derived class for STM32WL modules." alt="STM32WLx" shape="rect" coords="103,168,196,192"/>
|
|
<area href="class_s_x1261.html" title="Derived class for SX1261 modules." alt="SX1261" shape="rect" coords="206,168,299,192"/>
|
|
</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:a0da317728ec8ef23c5032d550c9acb8d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1262.html#a0da317728ec8ef23c5032d550c9acb8d">SX1262</a> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
|
<tr class="memdesc:a0da317728ec8ef23c5032d550c9acb8d"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_s_x1262.html#a0da317728ec8ef23c5032d550c9acb8d">More...</a><br /></td></tr>
|
|
<tr class="separator:a0da317728ec8ef23c5032d550c9acb8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ceab9913d102c2fd657a1a91afaf9cc"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1262.html#a9ceab9913d102c2fd657a1a91afaf9cc">begin</a> (float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX126X_SYNC_WORD_PRIVATE, int8_t power=10, uint16_t preambleLength=8, float tcxoVoltage=1.6, bool useRegulatorLDO=false)</td></tr>
|
|
<tr class="memdesc:a9ceab9913d102c2fd657a1a91afaf9cc"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for LoRa modem. <a href="class_s_x1262.html#a9ceab9913d102c2fd657a1a91afaf9cc">More...</a><br /></td></tr>
|
|
<tr class="separator:a9ceab9913d102c2fd657a1a91afaf9cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36d2c94ff9c3b9126fde23e3c54630f1"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1262.html#a36d2c94ff9c3b9126fde23e3c54630f1">beginFSK</a> (float freq=434.0, float br=4.8, float freqDev=5.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:a36d2c94ff9c3b9126fde23e3c54630f1"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for FSK modem. <a href="class_s_x1262.html#a36d2c94ff9c3b9126fde23e3c54630f1">More...</a><br /></td></tr>
|
|
<tr class="separator:a36d2c94ff9c3b9126fde23e3c54630f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2122feee1a3bffaaa20e85b24dc8a899"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1262.html#a2122feee1a3bffaaa20e85b24dc8a899">setFrequency</a> (float freq) override</td></tr>
|
|
<tr class="memdesc:a2122feee1a3bffaaa20e85b24dc8a899"><td class="mdescLeft"> </td><td class="mdescRight">Sets carrier frequency. Allowed values are in range from 150.0 to 960.0 MHz. <a href="class_s_x1262.html#a2122feee1a3bffaaa20e85b24dc8a899">More...</a><br /></td></tr>
|
|
<tr class="separator:a2122feee1a3bffaaa20e85b24dc8a899"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1f70b082116b03d1fafe395fc5a288f6"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1262.html#a1f70b082116b03d1fafe395fc5a288f6">setFrequency</a> (float freq, bool calibrate)</td></tr>
|
|
<tr class="memdesc:a1f70b082116b03d1fafe395fc5a288f6"><td class="mdescLeft"> </td><td class="mdescRight">Sets carrier frequency. Allowed values are in range from 150.0 to 960.0 MHz. <a href="class_s_x1262.html#a1f70b082116b03d1fafe395fc5a288f6">More...</a><br /></td></tr>
|
|
<tr class="separator:a1f70b082116b03d1fafe395fc5a288f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa455a7f0e69abdcca55cf35388d9dc52"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1262.html#aa455a7f0e69abdcca55cf35388d9dc52">setOutputPower</a> (int8_t power) override</td></tr>
|
|
<tr class="memdesc:aa455a7f0e69abdcca55cf35388d9dc52"><td class="mdescLeft"> </td><td class="mdescRight">Sets output power. Allowed values are in range from -9 to 22 dBm. This method is virtual to allow override from the <a class="el" href="class_s_x1261.html" title="Derived class for SX1261 modules.">SX1261</a> class. <a href="class_s_x1262.html#aa455a7f0e69abdcca55cf35388d9dc52">More...</a><br /></td></tr>
|
|
<tr class="separator:aa455a7f0e69abdcca55cf35388d9dc52"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a33c304c19634a905c7318d9ca88f4e93"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1262.html#a33c304c19634a905c7318d9ca88f4e93">checkOutputPower</a> (int8_t power, int8_t *clipped) override</td></tr>
|
|
<tr class="memdesc:a33c304c19634a905c7318d9ca88f4e93"><td class="mdescLeft"> </td><td class="mdescRight">Check if output power is configurable. <a href="class_s_x1262.html#a33c304c19634a905c7318d9ca88f4e93">More...</a><br /></td></tr>
|
|
<tr class="separator:a33c304c19634a905c7318d9ca88f4e93"><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:a936a40038e05740a528f2b53f8e17010 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#a936a40038e05740a528f2b53f8e17010">begin</a> (uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)</td></tr>
|
|
<tr class="memdesc:a936a40038e05740a528f2b53f8e17010 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for LoRa modem. <a href="class_s_x126x.html#a936a40038e05740a528f2b53f8e17010">More...</a><br /></td></tr>
|
|
<tr class="separator:a936a40038e05740a528f2b53f8e17010 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 RADIOLIB_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:acb8611a9c3862dd1bfa73ef47b8f9b20 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#acb8611a9c3862dd1bfa73ef47b8f9b20">scanChannel</a> () override</td></tr>
|
|
<tr class="memdesc:acb8611a9c3862dd1bfa73ef47b8f9b20 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#acb8611a9c3862dd1bfa73ef47b8f9b20">More...</a><br /></td></tr>
|
|
<tr class="separator:acb8611a9c3862dd1bfa73ef47b8f9b20 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4bbc29f5dc7253b7743599c68137df48 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#a4bbc29f5dc7253b7743599c68137df48">scanChannel</a> (uint8_t symbolNum, uint8_t detPeak, uint8_t detMin)</td></tr>
|
|
<tr class="memdesc:a4bbc29f5dc7253b7743599c68137df48 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#a4bbc29f5dc7253b7743599c68137df48">More...</a><br /></td></tr>
|
|
<tr class="separator:a4bbc29f5dc7253b7743599c68137df48 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a882cec40d9aa98a0d536e6afb65b1719 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#a882cec40d9aa98a0d536e6afb65b1719">sleep</a> () override</td></tr>
|
|
<tr class="memdesc:a882cec40d9aa98a0d536e6afb65b1719 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets the module to sleep mode. To wake the device up, call <a class="el" href="class_s_x126x.html#a7a1579e2557c36a4a34b09039c0d0c71" title="Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...">standby()</a>. Overload with warm start enabled 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#a882cec40d9aa98a0d536e6afb65b1719">More...</a><br /></td></tr>
|
|
<tr class="separator:a882cec40d9aa98a0d536e6afb65b1719 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad7e4df3e1ca20d524e1d776047e1013 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#aad7e4df3e1ca20d524e1d776047e1013">sleep</a> (bool retainConfig)</td></tr>
|
|
<tr class="memdesc:aad7e4df3e1ca20d524e1d776047e1013 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets the module to sleep mode. To wake the device up, call <a class="el" href="class_s_x126x.html#a7a1579e2557c36a4a34b09039c0d0c71" title="Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...">standby()</a>. <a href="class_s_x126x.html#aad7e4df3e1ca20d524e1d776047e1013">More...</a><br /></td></tr>
|
|
<tr class="separator:aad7e4df3e1ca20d524e1d776047e1013 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:a2fa0384a529746811e2dcb2eeb4188ec 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#a2fa0384a529746811e2dcb2eeb4188ec">standby</a> (uint8_t mode, bool wakeup=true)</td></tr>
|
|
<tr class="memdesc:a2fa0384a529746811e2dcb2eeb4188ec 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#a2fa0384a529746811e2dcb2eeb4188ec">More...</a><br /></td></tr>
|
|
<tr class="separator:a2fa0384a529746811e2dcb2eeb4188ec 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:a7603aa60ae8d975eb262a4b7e2aed1d0 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#a7603aa60ae8d975eb262a4b7e2aed1d0">setPacketReceivedAction</a> (void(*func)(void)) override</td></tr>
|
|
<tr class="memdesc:a7603aa60ae8d975eb262a4b7e2aed1d0 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a packet is received. <a href="class_s_x126x.html#a7603aa60ae8d975eb262a4b7e2aed1d0">More...</a><br /></td></tr>
|
|
<tr class="separator:a7603aa60ae8d975eb262a4b7e2aed1d0 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a56f88f6a2b88ae6dbd3ad04b1950e7b2 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top"><a id="a56f88f6a2b88ae6dbd3ad04b1950e7b2"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a56f88f6a2b88ae6dbd3ad04b1950e7b2">clearPacketReceivedAction</a> () override</td></tr>
|
|
<tr class="memdesc:a56f88f6a2b88ae6dbd3ad04b1950e7b2 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a packet is received. <br /></td></tr>
|
|
<tr class="separator:a56f88f6a2b88ae6dbd3ad04b1950e7b2 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac79f7ebab97ae91fff6933be3207c873 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#ac79f7ebab97ae91fff6933be3207c873">setPacketSentAction</a> (void(*func)(void)) override</td></tr>
|
|
<tr class="memdesc:ac79f7ebab97ae91fff6933be3207c873 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a packet is sent. <a href="class_s_x126x.html#ac79f7ebab97ae91fff6933be3207c873">More...</a><br /></td></tr>
|
|
<tr class="separator:ac79f7ebab97ae91fff6933be3207c873 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af38ba3d27ab2ac10c703eefa1c428913 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top"><a id="af38ba3d27ab2ac10c703eefa1c428913"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#af38ba3d27ab2ac10c703eefa1c428913">clearPacketSentAction</a> () override</td></tr>
|
|
<tr class="memdesc:af38ba3d27ab2ac10c703eefa1c428913 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a packet is sent. <br /></td></tr>
|
|
<tr class="separator:af38ba3d27ab2ac10c703eefa1c428913 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed0e7dcd60479c9db3d7a3408e7f396d 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#aed0e7dcd60479c9db3d7a3408e7f396d">setChannelScanAction</a> (void(*func)(void)) override</td></tr>
|
|
<tr class="memdesc:aed0e7dcd60479c9db3d7a3408e7f396d inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a channel scan is finished. <a href="class_s_x126x.html#aed0e7dcd60479c9db3d7a3408e7f396d">More...</a><br /></td></tr>
|
|
<tr class="separator:aed0e7dcd60479c9db3d7a3408e7f396d inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a37dab0ab3c4cab82e367971fc31588a6 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top"><a id="a37dab0ab3c4cab82e367971fc31588a6"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a37dab0ab3c4cab82e367971fc31588a6">clearChannelScanAction</a> () override</td></tr>
|
|
<tr class="memdesc:a37dab0ab3c4cab82e367971fc31588a6 inherit pub_methods_class_s_x126x"><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:a37dab0ab3c4cab82e367971fc31588a6 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:a8e22d67b64953c8b4da779d87d563f3e 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#a8e22d67b64953c8b4da779d87d563f3e">finishTransmit</a> () override</td></tr>
|
|
<tr class="memdesc:a8e22d67b64953c8b4da779d87d563f3e inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Clean up after transmission is done. <a href="class_s_x126x.html#a8e22d67b64953c8b4da779d87d563f3e">More...</a><br /></td></tr>
|
|
<tr class="separator:a8e22d67b64953c8b4da779d87d563f3e inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66ad433561b02fe61b09afd735ce56cc 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#a66ad433561b02fe61b09afd735ce56cc">startReceive</a> () override</td></tr>
|
|
<tr class="memdesc:a66ad433561b02fe61b09afd735ce56cc inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven receive method with default parameters. Implemented for compatibility with <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#a66ad433561b02fe61b09afd735ce56cc">More...</a><br /></td></tr>
|
|
<tr class="separator:a66ad433561b02fe61b09afd735ce56cc inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6c81423768480e3bc04d636486241f8 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#ad6c81423768480e3bc04d636486241f8">startReceive</a> (uint32_t timeout, uint32_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint32_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0)</td></tr>
|
|
<tr class="memdesc:ad6c81423768480e3bc04d636486241f8 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#ad6c81423768480e3bc04d636486241f8">More...</a><br /></td></tr>
|
|
<tr class="separator:ad6c81423768480e3bc04d636486241f8 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b4f8a41b593436b8c7a2a2d46ac387e 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#a5b4f8a41b593436b8c7a2a2d46ac387e">startReceiveDutyCycle</a> (uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)</td></tr>
|
|
<tr class="memdesc:a5b4f8a41b593436b8c7a2a2d46ac387e 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#a5b4f8a41b593436b8c7a2a2d46ac387e">More...</a><br /></td></tr>
|
|
<tr class="separator:a5b4f8a41b593436b8c7a2a2d46ac387e inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a077f180905ce4818cbdacad0cd9fe841 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#a077f180905ce4818cbdacad0cd9fe841">startReceiveDutyCycleAuto</a> (uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)</td></tr>
|
|
<tr class="memdesc:a077f180905ce4818cbdacad0cd9fe841 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Calls <a class="el" href="class_s_x126x.html#a5b4f8a41b593436b8c7a2a2d46ac387e">startReceiveDutyCycle</a> with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages. <a href="class_s_x126x.html#a077f180905ce4818cbdacad0cd9fe841">More...</a><br /></td></tr>
|
|
<tr class="separator:a077f180905ce4818cbdacad0cd9fe841 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a9b090eddcb811ee19b595debfab1df inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a9a9b090eddcb811ee19b595debfab1df">getIrqStatus</a> ()</td></tr>
|
|
<tr class="memdesc:a9a9b090eddcb811ee19b595debfab1df inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Reads the current IRQ status. <a href="class_s_x126x.html#a9a9b090eddcb811ee19b595debfab1df">More...</a><br /></td></tr>
|
|
<tr class="separator:a9a9b090eddcb811ee19b595debfab1df 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. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! <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:a001c4637f01ed6f0216cd6c4d7e10da3 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#a001c4637f01ed6f0216cd6c4d7e10da3">startChannelScan</a> () override</td></tr>
|
|
<tr class="memdesc:a001c4637f01ed6f0216cd6c4d7e10da3 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven channel activity detection method. DIO1 will be activated when LoRa preamble is detected, or upon timeout. Defaults to CAD parameter values recommended by AN1200.48. <a href="class_s_x126x.html#a001c4637f01ed6f0216cd6c4d7e10da3">More...</a><br /></td></tr>
|
|
<tr class="separator:a001c4637f01ed6f0216cd6c4d7e10da3 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff8ec92d828421564322f13fb1c90223 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#aff8ec92d828421564322f13fb1c90223">startChannelScan</a> (uint8_t symbolNum, uint8_t detPeak, uint8_t detMin)</td></tr>
|
|
<tr class="memdesc:aff8ec92d828421564322f13fb1c90223 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven channel activity detection method. DIO1 will be activated when LoRa preamble is detected, or upon timeout. <a href="class_s_x126x.html#aff8ec92d828421564322f13fb1c90223">More...</a><br /></td></tr>
|
|
<tr class="separator:aff8ec92d828421564322f13fb1c90223 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afdd901c5eac2ca8773d0977e2c493317 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#afdd901c5eac2ca8773d0977e2c493317">getChannelScanResult</a> () override</td></tr>
|
|
<tr class="memdesc:afdd901c5eac2ca8773d0977e2c493317 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Read the channel scan result. <a href="class_s_x126x.html#afdd901c5eac2ca8773d0977e2c493317">More...</a><br /></td></tr>
|
|
<tr class="separator:afdd901c5eac2ca8773d0977e2c493317 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 2.5 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:ad6274222ccf534e98e3cd17dfa1520d4 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#ad6274222ccf534e98e3cd17dfa1520d4">setPreambleLength</a> (size_t preambleLength) override</td></tr>
|
|
<tr class="memdesc:ad6274222ccf534e98e3cd17dfa1520d4 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#ad6274222ccf534e98e3cd17dfa1520d4">More...</a><br /></td></tr>
|
|
<tr class="separator:ad6274222ccf534e98e3cd17dfa1520d4 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:ac38a19db6b8b9aff438d6e23051d487d 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#ac38a19db6b8b9aff438d6e23051d487d">setBitRate</a> (float br) override</td></tr>
|
|
<tr class="memdesc:ac38a19db6b8b9aff438d6e23051d487d 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#ac38a19db6b8b9aff438d6e23051d487d">More...</a><br /></td></tr>
|
|
<tr class="separator:ac38a19db6b8b9aff438d6e23051d487d inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af30a581d31feae6f50c0591d1ee113f1 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#af30a581d31feae6f50c0591d1ee113f1">setDataRate</a> (<a class="el" href="union_data_rate__t.html">DataRate_t</a> dr) override</td></tr>
|
|
<tr class="memdesc:af30a581d31feae6f50c0591d1ee113f1 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Set data. <a href="class_s_x126x.html#af30a581d31feae6f50c0591d1ee113f1">More...</a><br /></td></tr>
|
|
<tr class="separator:af30a581d31feae6f50c0591d1ee113f1 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a75c8d32cee712e0c940163446b98e587 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#a75c8d32cee712e0c940163446b98e587">checkDataRate</a> (<a class="el" href="union_data_rate__t.html">DataRate_t</a> dr) override</td></tr>
|
|
<tr class="memdesc:a75c8d32cee712e0c940163446b98e587 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Check the data rate can be configured by this module. <a href="class_s_x126x.html#a75c8d32cee712e0c940163446b98e587">More...</a><br /></td></tr>
|
|
<tr class="separator:a75c8d32cee712e0c940163446b98e587 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:a920aa76ff5f0f579424ef6de92e588c8 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#a920aa76ff5f0f579424ef6de92e588c8">setRxBoostedGainMode</a> (bool rxbgm, bool persist=true)</td></tr>
|
|
<tr class="memdesc:a920aa76ff5f0f579424ef6de92e588c8 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables Rx Boosted Gain mode as described in <a class="el" href="class_s_x126x.html" title="Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...">SX126x</a> datasheet section 9.6 (SX1261/2 v2.1, <a class="el" href="class_s_x1268.html" title="Derived class for SX1268 modules.">SX1268</a> v1.1) <a href="class_s_x126x.html#a920aa76ff5f0f579424ef6de92e588c8">More...</a><br /></td></tr>
|
|
<tr class="separator:a920aa76ff5f0f579424ef6de92e588c8 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:a827a4754ea53388513d263e5d9171395 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#a827a4754ea53388513d263e5d9171395">setSyncWord</a> (uint8_t *syncWord, size_t len) override</td></tr>
|
|
<tr class="memdesc:a827a4754ea53388513d263e5d9171395 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#a827a4754ea53388513d263e5d9171395">More...</a><br /></td></tr>
|
|
<tr class="separator:a827a4754ea53388513d263e5d9171395 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:ae500bad45638a47264b7e5955a93107d 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#ae500bad45638a47264b7e5955a93107d">setWhitening</a> (bool enabled, uint16_t initial=0x01FF)</td></tr>
|
|
<tr class="memdesc:ae500bad45638a47264b7e5955a93107d inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK whitening parameters. <a href="class_s_x126x.html#ae500bad45638a47264b7e5955a93107d">More...</a><br /></td></tr>
|
|
<tr class="separator:ae500bad45638a47264b7e5955a93107d 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:afabefb1b214411198f3537e8afce898f 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#afabefb1b214411198f3537e8afce898f">getRSSI</a> (bool packet=true)</td></tr>
|
|
<tr class="memdesc:afabefb1b214411198f3537e8afce898f inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">GetsRSSI (Recorded Signal Strength Indicator). <a href="class_s_x126x.html#afabefb1b214411198f3537e8afce898f">More...</a><br /></td></tr>
|
|
<tr class="separator:afabefb1b214411198f3537e8afce898f inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59b761a67d15cdbfdccd6a759f464d00 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#a59b761a67d15cdbfdccd6a759f464d00">getSNR</a> () override</td></tr>
|
|
<tr class="memdesc:a59b761a67d15cdbfdccd6a759f464d00 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#a59b761a67d15cdbfdccd6a759f464d00">More...</a><br /></td></tr>
|
|
<tr class="separator:a59b761a67d15cdbfdccd6a759f464d00 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a068d709ffb79ae66d718ffb76ffae997 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#a068d709ffb79ae66d718ffb76ffae997">getFrequencyError</a> ()</td></tr>
|
|
<tr class="memdesc:a068d709ffb79ae66d718ffb76ffae997 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Gets frequency error of the latest received packet. WARNING: This functionality is based on <a class="el" href="class_s_x128x.html" title="Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from thi...">SX128x</a> implementation and not documented on <a class="el" href="class_s_x126x.html" title="Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...">SX126x</a>. While it seems to be working, it should be used with caution! <a href="class_s_x126x.html#a068d709ffb79ae66d718ffb76ffae997">More...</a><br /></td></tr>
|
|
<tr class="separator:a068d709ffb79ae66d718ffb76ffae997 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:abc3a4f9213b2a7052e97c2e3a0bf45a5 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#abc3a4f9213b2a7052e97c2e3a0bf45a5">fixedPacketLengthMode</a> (uint8_t len=RADIOLIB_SX126X_MAX_PACKET_LENGTH)</td></tr>
|
|
<tr class="memdesc:abc3a4f9213b2a7052e97c2e3a0bf45a5 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#abc3a4f9213b2a7052e97c2e3a0bf45a5">More...</a><br /></td></tr>
|
|
<tr class="separator:abc3a4f9213b2a7052e97c2e3a0bf45a5 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92c157efe751b4ae73d22ff44115285d 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#a92c157efe751b4ae73d22ff44115285d">variablePacketLengthMode</a> (uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)</td></tr>
|
|
<tr class="memdesc:a92c157efe751b4ae73d22ff44115285d 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#a92c157efe751b4ae73d22ff44115285d">More...</a><br /></td></tr>
|
|
<tr class="separator:a92c157efe751b4ae73d22ff44115285d inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16eb0bdb051f3cf288db752d18182ae2 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a16eb0bdb051f3cf288db752d18182ae2">getTimeOnAir</a> (size_t len) override</td></tr>
|
|
<tr class="memdesc:a16eb0bdb051f3cf288db752d18182ae2 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#a16eb0bdb051f3cf288db752d18182ae2">More...</a><br /></td></tr>
|
|
<tr class="separator:a16eb0bdb051f3cf288db752d18182ae2 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a19f3c26d7a7959e302fc8174fc88a6d4 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a19f3c26d7a7959e302fc8174fc88a6d4">calculateRxTimeout</a> (<a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> timeoutUs) override</td></tr>
|
|
<tr class="memdesc:a19f3c26d7a7959e302fc8174fc88a6d4 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the timeout value for this specific module / series (in number of symbols or units of time) <a href="class_s_x126x.html#a19f3c26d7a7959e302fc8174fc88a6d4">More...</a><br /></td></tr>
|
|
<tr class="separator:a19f3c26d7a7959e302fc8174fc88a6d4 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab593887ad083a1d5affda7a42656749e 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#ab593887ad083a1d5affda7a42656749e">irqRxDoneRxTimeout</a> (uint32_t &irqFlags, uint32_t &irqMask) override</td></tr>
|
|
<tr class="memdesc:ab593887ad083a1d5affda7a42656749e inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Create the flags that make up RxDone and RxTimeout used for receiving downlinks. <a href="class_s_x126x.html#ab593887ad083a1d5affda7a42656749e">More...</a><br /></td></tr>
|
|
<tr class="separator:ab593887ad083a1d5affda7a42656749e inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a34aea9413d71676c7a60fcf24017694a inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a34aea9413d71676c7a60fcf24017694a">isRxTimeout</a> () override</td></tr>
|
|
<tr class="memdesc:a34aea9413d71676c7a60fcf24017694a inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the IRQ bit for RxTimeout is set. <a href="class_s_x126x.html#a34aea9413d71676c7a60fcf24017694a">More...</a><br /></td></tr>
|
|
<tr class="separator:a34aea9413d71676c7a60fcf24017694a 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:a0a0df468eacc71c1b2a093ac06bfff51 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#a0a0df468eacc71c1b2a093ac06bfff51">setRfSwitchPins</a> (uint32_t rxEn, uint32_t txEn)</td></tr>
|
|
<tr class="memdesc:a0a0df468eacc71c1b2a093ac06bfff51 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over those pins to automatically switch between various modes: When idle both pins will be LOW, during TX the <code>txEn</code> pin will be HIGH, during RX the <code>rxPin</code> will be HIGH. <a href="class_s_x126x.html#a0a0df468eacc71c1b2a093ac06bfff51">More...</a><br /></td></tr>
|
|
<tr class="separator:a0a0df468eacc71c1b2a093ac06bfff51 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2cb5ed645ebcc6f3f17d77e32c2ccdd7 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#a2cb5ed645ebcc6f3f17d77e32c2ccdd7">setRfSwitchTable</a> (const uint32_t(&pins)[<a class="el" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">Module::RFSWITCH_MAX_PINS</a>], const <a class="el" href="struct_module_1_1_rf_switch_mode__t.html">Module::RfSwitchMode_t</a> table[])</td></tr>
|
|
<tr class="memdesc:a2cb5ed645ebcc6f3f17d77e32c2ccdd7 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over those pins to automatically switch between various modes. <a href="class_s_x126x.html#a2cb5ed645ebcc6f3f17d77e32c2ccdd7">More...</a><br /></td></tr>
|
|
<tr class="separator:a2cb5ed645ebcc6f3f17d77e32c2ccdd7 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:a187a616285c5872f9603a86c122deaf2 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#a187a616285c5872f9603a86c122deaf2">randomByte</a> () override</td></tr>
|
|
<tr class="memdesc:a187a616285c5872f9603a86c122deaf2 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#a187a616285c5872f9603a86c122deaf2">More...</a><br /></td></tr>
|
|
<tr class="separator:a187a616285c5872f9603a86c122deaf2 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a269c8e4ae0d21af88e9422ccf9708c1e 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#a269c8e4ae0d21af88e9422ccf9708c1e">invertIQ</a> (bool enable) override</td></tr>
|
|
<tr class="memdesc:a269c8e4ae0d21af88e9422ccf9708c1e inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable inversion of the I and Q signals. <a href="class_s_x126x.html#a269c8e4ae0d21af88e9422ccf9708c1e">More...</a><br /></td></tr>
|
|
<tr class="separator:a269c8e4ae0d21af88e9422ccf9708c1e inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f514b341b8982650526c6d8e20fd1a4 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#a4f514b341b8982650526c6d8e20fd1a4">setDirectAction</a> (void(*func)(void)) override</td></tr>
|
|
<tr class="memdesc:a4f514b341b8982650526c6d8e20fd1a4 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt service routine function to call when data bit is received in direct mode. <a href="class_s_x126x.html#a4f514b341b8982650526c6d8e20fd1a4">More...</a><br /></td></tr>
|
|
<tr class="separator:a4f514b341b8982650526c6d8e20fd1a4 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acb1a1c51f207439880ae537f5ffeb17c 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#acb1a1c51f207439880ae537f5ffeb17c">readBit</a> (uint32_t pin) override</td></tr>
|
|
<tr class="memdesc:acb1a1c51f207439880ae537f5ffeb17c inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Function to read and process data bit in direct reception mode. <a href="class_s_x126x.html#acb1a1c51f207439880ae537f5ffeb17c">More...</a><br /></td></tr>
|
|
<tr class="separator:acb1a1c51f207439880ae537f5ffeb17c inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2af78b744b3e61d3857bed93c3b1bde1 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#a2af78b744b3e61d3857bed93c3b1bde1">uploadPatch</a> (const uint32_t *patch, size_t len, bool nonvolatile=true)</td></tr>
|
|
<tr class="memdesc:a2af78b744b3e61d3857bed93c3b1bde1 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Upload binary patch into the <a class="el" href="class_s_x126x.html" title="Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...">SX126x</a> device RAM. Patch is needed to e.g., enable spectral scan and must be uploaded again on every power cycle. <a href="class_s_x126x.html#a2af78b744b3e61d3857bed93c3b1bde1">More...</a><br /></td></tr>
|
|
<tr class="separator:a2af78b744b3e61d3857bed93c3b1bde1 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8a3ad4e12df862ab18b326d9dba26d66 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#a8a3ad4e12df862ab18b326d9dba26d66">spectralScanStart</a> (uint16_t numSamples, uint8_t window=RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)</td></tr>
|
|
<tr class="memdesc:a8a3ad4e12df862ab18b326d9dba26d66 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Start spectral scan. Requires binary path to be uploaded. <a href="class_s_x126x.html#a8a3ad4e12df862ab18b326d9dba26d66">More...</a><br /></td></tr>
|
|
<tr class="separator:a8a3ad4e12df862ab18b326d9dba26d66 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a865397e1cca38bec2d055c047825ea07 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top"><a id="a865397e1cca38bec2d055c047825ea07"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a865397e1cca38bec2d055c047825ea07">spectralScanAbort</a> ()</td></tr>
|
|
<tr class="memdesc:a865397e1cca38bec2d055c047825ea07 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Abort an ongoing spectral scan. <br /></td></tr>
|
|
<tr class="separator:a865397e1cca38bec2d055c047825ea07 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5595fff99d76d50d711b8cdad98527c4 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#a5595fff99d76d50d711b8cdad98527c4">spectralScanGetStatus</a> ()</td></tr>
|
|
<tr class="memdesc:a5595fff99d76d50d711b8cdad98527c4 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Read the status of spectral scan. <a href="class_s_x126x.html#a5595fff99d76d50d711b8cdad98527c4">More...</a><br /></td></tr>
|
|
<tr class="separator:a5595fff99d76d50d711b8cdad98527c4 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae473773e5bed4b08452e80311bdb26f2 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#ae473773e5bed4b08452e80311bdb26f2">spectralScanGetResult</a> (uint16_t *results)</td></tr>
|
|
<tr class="memdesc:ae473773e5bed4b08452e80311bdb26f2 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Read the result of spectral scan. <a href="class_s_x126x.html#ae473773e5bed4b08452e80311bdb26f2">More...</a><br /></td></tr>
|
|
<tr class="separator:ae473773e5bed4b08452e80311bdb26f2 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1623e7d5450c97ca092913ad79d62208 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#a1623e7d5450c97ca092913ad79d62208">setPaConfig</a> (uint8_t paDutyCycle, uint8_t deviceSel, uint8_t hpMax=RADIOLIB_SX126X_PA_CONFIG_HP_MAX, uint8_t paLut=RADIOLIB_SX126X_PA_CONFIG_PA_LUT)</td></tr>
|
|
<tr class="memdesc:a1623e7d5450c97ca092913ad79d62208 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Set the PA configuration. Allows user to optimize PA for a specific output power and matching network. Any calls to this method must be done after calling begin/beginFSK and/or setOutputPower. WARNING: Use at your own risk! Setting invalid values can and will lead to permanent damage! <a href="class_s_x126x.html#a1623e7d5450c97ca092913ad79d62208">More...</a><br /></td></tr>
|
|
<tr class="separator:a1623e7d5450c97ca092913ad79d62208 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa3c90f19cd141738ff013ae72f78f1bb 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#aa3c90f19cd141738ff013ae72f78f1bb">calibrateImageRejection</a> (float freqMin, float freqMax)</td></tr>
|
|
<tr class="memdesc:aa3c90f19cd141738ff013ae72f78f1bb inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Perform image rejection calibration for the specified frequency band. WARNING: Use at your own risk! Setting incorrect values may lead to decreased performance. <a href="class_s_x126x.html#aa3c90f19cd141738ff013ae72f78f1bb">More...</a><br /></td></tr>
|
|
<tr class="separator:aa3c90f19cd141738ff013ae72f78f1bb inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad90a56cb55c5bb64037a0d412d84a80d 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#ad90a56cb55c5bb64037a0d412d84a80d">setPaRampTime</a> (uint8_t rampTime)</td></tr>
|
|
<tr class="memdesc:ad90a56cb55c5bb64037a0d412d84a80d inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Set PA ramp-up time. Set to 200us by default. <a href="class_s_x126x.html#ad90a56cb55c5bb64037a0d412d84a80d">More...</a><br /></td></tr>
|
|
<tr class="separator:ad90a56cb55c5bb64037a0d412d84a80d inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a492b2d057dd803c3884fa1adc8e22534 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#a492b2d057dd803c3884fa1adc8e22534">transmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">C-string transmit method. <a href="class_s_x126x.html#a492b2d057dd803c3884fa1adc8e22534">More...</a><br /></td></tr>
|
|
<tr class="separator:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3dd42f8d5569487ea74f004ca652a709 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a3dd42f8d5569487ea74f004ca652a709">transmit</a> (uint8_t *data, size_t len, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a3dd42f8d5569487ea74f004ca652a709 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Binary transmit method. Must be implemented in module class. <a href="class_s_x126x.html#a3dd42f8d5569487ea74f004ca652a709">More...</a><br /></td></tr>
|
|
<tr class="separator:a3dd42f8d5569487ea74f004ca652a709 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab82617fa3fa9f21d4cd427314ecc4af8 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ab82617fa3fa9f21d4cd427314ecc4af8">receive</a> (uint8_t *data, size_t len)</td></tr>
|
|
<tr class="memdesc:ab82617fa3fa9f21d4cd427314ecc4af8 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Binary receive method. Must be implemented in module class. <a href="class_s_x126x.html#ab82617fa3fa9f21d4cd427314ecc4af8">More...</a><br /></td></tr>
|
|
<tr class="separator:ab82617fa3fa9f21d4cd427314ecc4af8 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a923654706eff5118ef6e84214e837f27 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#a923654706eff5118ef6e84214e837f27">startTransmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_s_x126x"><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_s_x126x.html#a923654706eff5118ef6e84214e837f27">More...</a><br /></td></tr>
|
|
<tr class="separator:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad59e37ce0606dc8051e40be9d14cfec3 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ad59e37ce0606dc8051e40be9d14cfec3">startTransmit</a> (uint8_t *data, size_t len, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:ad59e37ce0606dc8051e40be9d14cfec3 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven binary transmit method. <a href="class_s_x126x.html#ad59e37ce0606dc8051e40be9d14cfec3">More...</a><br /></td></tr>
|
|
<tr class="separator:ad59e37ce0606dc8051e40be9d14cfec3 inherit pub_methods_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3563453988a83d22dd07d4691543a300 inherit pub_methods_class_s_x126x"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a3563453988a83d22dd07d4691543a300">readData</a> (uint8_t *data, size_t len)</td></tr>
|
|
<tr class="memdesc:a3563453988a83d22dd07d4691543a300 inherit pub_methods_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Reads data that was received after calling startReceive method. <a href="class_s_x126x.html#a3563453988a83d22dd07d4691543a300">More...</a><br /></td></tr>
|
|
<tr class="separator:a3563453988a83d22dd07d4691543a300 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:add63d7d4fa8b14df5e185813794a49d5 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#add63d7d4fa8b14df5e185813794a49d5">PhysicalLayer</a> (float step, size_t maxLen)</td></tr>
|
|
<tr class="memdesc:add63d7d4fa8b14df5e185813794a49d5 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_physical_layer.html#add63d7d4fa8b14df5e185813794a49d5">More...</a><br /></td></tr>
|
|
<tr class="separator:add63d7d4fa8b14df5e185813794a49d5 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:a7d5da4311092e3df6b193ff303a0c5e8 inherit pub_methods_class_physical_layer"><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 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Sets module to a specific standby mode. <a href="class_physical_layer.html#a7d5da4311092e3df6b193ff303a0c5e8">More...</a><br /></td></tr>
|
|
<tr class="separator:a7d5da4311092e3df6b193ff303a0c5e8 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: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:aabc94ab27a9ee6daaafa9b47dde5f75b inherit pub_methods_class_physical_layer"><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 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. <a href="class_physical_layer.html#aabc94ab27a9ee6daaafa9b47dde5f75b">More...</a><br /></td></tr>
|
|
<tr class="separator:aabc94ab27a9ee6daaafa9b47dde5f75b 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>
|
|
<tr class="memitem:a8e378fe136a498ea485a9c10f5e15aab 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#a8e378fe136a498ea485a9c10f5e15aab">setDirectSyncWord</a> (uint32_t syncWord, uint8_t len)</td></tr>
|
|
<tr class="memdesc:a8e378fe136a498ea485a9c10f5e15aab inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Set sync word to be used to determine start of packet in direct reception mode. <a href="class_physical_layer.html#a8e378fe136a498ea485a9c10f5e15aab">More...</a><br /></td></tr>
|
|
<tr class="separator:a8e378fe136a498ea485a9c10f5e15aab inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab57182d32646861ef0d865e2740d6b26 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#ab57182d32646861ef0d865e2740d6b26">available</a> ()</td></tr>
|
|
<tr class="memdesc:ab57182d32646861ef0d865e2740d6b26 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of direct mode bytes currently available in buffer. <a href="class_physical_layer.html#ab57182d32646861ef0d865e2740d6b26">More...</a><br /></td></tr>
|
|
<tr class="separator:ab57182d32646861ef0d865e2740d6b26 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a429796eb2e7ea86781a2e8ca42af43f3 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top"><a id="a429796eb2e7ea86781a2e8ca42af43f3"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a429796eb2e7ea86781a2e8ca42af43f3">dropSync</a> ()</td></tr>
|
|
<tr class="memdesc:a429796eb2e7ea86781a2e8ca42af43f3 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Forcefully drop synchronization. <br /></td></tr>
|
|
<tr class="separator:a429796eb2e7ea86781a2e8ca42af43f3 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d5b30493c8d7fcfb784e128362d596c inherit pub_methods_class_physical_layer"><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 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get data from direct mode buffer. <a href="class_physical_layer.html#a4d5b30493c8d7fcfb784e128362d596c">More...</a><br /></td></tr>
|
|
<tr class="separator:a4d5b30493c8d7fcfb784e128362d596c inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a349e8a22cd28ad89d45460fdeeefc05c inherit pub_methods_class_physical_layer"><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 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Configure DIO pin mapping to get a given signal on a DIO pin (if available). <a href="class_physical_layer.html#a349e8a22cd28ad89d45460fdeeefc05c">More...</a><br /></td></tr>
|
|
<tr class="separator:a349e8a22cd28ad89d45460fdeeefc05c inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pub_attribs_class_s_x126x"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_class_s_x126x')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="class_s_x126x.html">SX126x</a></td></tr>
|
|
<tr class="memitem:ada0fe6c3d31885952b439135cf0c18f1 inherit pub_attribs_class_s_x126x"><td class="memItemLeft" align="right" valign="top"><a id="ada0fe6c3d31885952b439135cf0c18f1"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ada0fe6c3d31885952b439135cf0c18f1">XTAL</a></td></tr>
|
|
<tr class="memdesc:ada0fe6c3d31885952b439135cf0c18f1 inherit pub_attribs_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Whether the module has an XTAL (true) or TCXO (false). Defaults to false. <br /></td></tr>
|
|
<tr class="separator:ada0fe6c3d31885952b439135cf0c18f1 inherit pub_attribs_class_s_x126x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae731568798d03d9722a440fd6a23faf2 inherit pub_attribs_class_s_x126x"><td class="memItemLeft" align="right" valign="top"><a id="ae731568798d03d9722a440fd6a23faf2"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ae731568798d03d9722a440fd6a23faf2">standbyXOSC</a></td></tr>
|
|
<tr class="memdesc:ae731568798d03d9722a440fd6a23faf2 inherit pub_attribs_class_s_x126x"><td class="mdescLeft"> </td><td class="mdescRight">Whether to use XOSC (true) or RC (false) oscillator in standby mode. Defaults to false. <br /></td></tr>
|
|
<tr class="separator:ae731568798d03d9722a440fd6a23faf2 inherit pub_attribs_class_s_x126x"><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 SX1262 modules. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a0da317728ec8ef23c5032d550c9acb8d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0da317728ec8ef23c5032d550c9acb8d">◆ </a></span>SX1262()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">SX1262::SX1262 </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 methods to control the wireless module. Every module class contains o...">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="a9ceab9913d102c2fd657a1a91afaf9cc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9ceab9913d102c2fd657a1a91afaf9cc">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX1262::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>RADIOLIB_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>1-byte LoRa sync word. Defaults to RADIOLIB_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. If you are seeing -706/-707 error codes, it likely means you are using non-0 value for module with XTAL. To use XTAL, either set this value to 0, or set <a class="el" href="class_s_x126x.html#ada0fe6c3d31885952b439135cf0c18f1" title="Whether the module has an XTAL (true) or TCXO (false). Defaults to false.">SX126x::XTAL</a> to true. </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="a36d2c94ff9c3b9126fde23e3c54630f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a36d2c94ff9c3b9126fde23e3c54630f1">◆ </a></span>beginFSK()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX1262::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>4.8</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freqDev</em> = <code>5.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 4.8 kbps. </td></tr>
|
|
<tr><td class="paramname">freqDev</td><td>Frequency deviation from carrier frequency in kHz. Defaults to 5.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>
|
|
<tr><td class="paramname">preambleLength</td><td>FSK preamble length in bits. Defaults to 16 bits. </td></tr>
|
|
<tr><td class="paramname">tcxoVoltage</td><td>TCXO reference voltage to be set on DIO3. Defaults to 1.6 V. If you are seeing -706/-707 error codes, it likely means you are using non-0 value for module with XTAL. To use XTAL, either set this value to 0, or set <a class="el" href="class_s_x126x.html#ada0fe6c3d31885952b439135cf0c18f1" title="Whether the module has an XTAL (true) or TCXO (false). Defaults to false.">SX126x::XTAL</a> to true. </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="a33c304c19634a905c7318d9ca88f4e93"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a33c304c19634a905c7318d9ca88f4e93">◆ </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 SX1262::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">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if output power is configurable. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">power</td><td>Output power in dBm. </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 from <a class="el" href="class_physical_layer.html#a1784cb227d04b3f2846625fda6797536">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2122feee1a3bffaaa20e85b24dc8a899"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2122feee1a3bffaaa20e85b24dc8a899">◆ </a></span>setFrequency() <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 SX1262::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">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets carrier frequency. Allowed values are in range from 150.0 to 960.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>
|
|
</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 from <a class="el" href="class_physical_layer.html#a8a194b0fbb66b1a953288bf3b9478d6e">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1f70b082116b03d1fafe395fc5a288f6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1f70b082116b03d1fafe395fc5a288f6">◆ </a></span>setFrequency() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX1262::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> </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 150.0 to 960.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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa455a7f0e69abdcca55cf35388d9dc52"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa455a7f0e69abdcca55cf35388d9dc52">◆ </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 SX1262::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">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets output power. Allowed values are in range from -9 to 22 dBm. This method is virtual to allow override from the <a class="el" href="class_s_x1261.html" title="Derived class for SX1261 modules.">SX1261</a> class. </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>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#ad2286dc78dbf8e3084f38e9159b99ae5">PhysicalLayer</a>.</p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_s_x1261.html#a3d197bb8a301f3594c7bfa1c9375aef1">SX1261</a>, and <a class="el" href="class_s_t_m32_w_lx.html#a9afbde1c466907598974cc3923784c5b">STM32WLx</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/modules/SX126x/<a class="el" href="_s_x1262_8h_source.html">SX1262.h</a></li>
|
|
<li>src/modules/SX126x/SX1262.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_x1262.html">SX1262</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.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|