kopia lustrzana https://github.com/jgromes/RadioLib
3498 wiersze
204 KiB
HTML
3498 wiersze
204 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: SX126x 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_x126x.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="#pub-attribs">Public Attributes</a> |
|
|
<a href="class_s_x126x-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">SX126x Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Base class for SX126x series. All derived classes for SX126x (e.g. <a class="el" href="class_s_x1262.html" title="Derived class for SX1262 modules.">SX1262</a> or <a class="el" href="class_s_x1268.html" title="Derived class for SX1268 modules.">SX1268</a>) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes.
|
|
<a href="class_s_x126x.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_s_x126x_8h_source.html">SX126x.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for SX126x:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_s_x126x.png" usemap="#SX126x_map" alt=""/>
|
|
<map id="SX126x_map" name="SX126x_map">
|
|
<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="154,0,247,24"/>
|
|
<area href="class_s_x1262.html" title="Derived class for SX1262 modules." alt="SX1262" shape="rect" coords="103,112,196,136"/>
|
|
<area href="class_s_x1268.html" title="Derived class for SX1268 modules." alt="SX1268" shape="rect" coords="206,112,299,136"/>
|
|
<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:aaca5a8fa8a3e634dd1b5b4c2bb5058d8"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a936a40038e05740a528f2b53f8e17010"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2e500e5b6044ccab8f6b19af4ffa917c"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9aa6dd05dd32ef717a06cc8ba28ff71f"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aab18364237ddac0c56aeaf63f08cf009"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3db6b29c482d94eef8a43cd8b5751c0"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a921aa8afb8d33b2660731c1f8d67664b"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8a18aee2bf05793aa29b5cf6b47bb435"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acb8611a9c3862dd1bfa73ef47b8f9b20"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4bbc29f5dc7253b7743599c68137df48"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb5509f0705cdd971065251ed6b2fb4e"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#afb5509f0705cdd971065251ed6b2fb4e">sleep</a> (bool retainConfig=true)</td></tr>
|
|
<tr class="memdesc:afb5509f0705cdd971065251ed6b2fb4e"><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#afb5509f0705cdd971065251ed6b2fb4e">More...</a><br /></td></tr>
|
|
<tr class="separator:afb5509f0705cdd971065251ed6b2fb4e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a1579e2557c36a4a34b09039c0d0c71"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2fa0384a529746811e2dcb2eeb4188ec"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0da667fe702d7b4aafaa4bf7e69ea40d"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6848afe4c16a47edb3e0b342a86ecdfd"><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"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when DIO1 activates. <br /></td></tr>
|
|
<tr class="separator:a6848afe4c16a47edb3e0b342a86ecdfd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2bc2016783a3fcad3ad4e6518ee7fc8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ad2bc2016783a3fcad3ad4e6518ee7fc8">setPacketReceivedAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:ad2bc2016783a3fcad3ad4e6518ee7fc8"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a packet is received. <a href="class_s_x126x.html#ad2bc2016783a3fcad3ad4e6518ee7fc8">More...</a><br /></td></tr>
|
|
<tr class="separator:ad2bc2016783a3fcad3ad4e6518ee7fc8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd0306b28b4ce36bab5fc0199aef90f2"><td class="memItemLeft" align="right" valign="top"><a id="acd0306b28b4ce36bab5fc0199aef90f2"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#acd0306b28b4ce36bab5fc0199aef90f2">clearPacketReceivedAction</a> ()</td></tr>
|
|
<tr class="memdesc:acd0306b28b4ce36bab5fc0199aef90f2"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a packet is received. <br /></td></tr>
|
|
<tr class="separator:acd0306b28b4ce36bab5fc0199aef90f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0417720a61b2d587e5633360cbecb33c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a0417720a61b2d587e5633360cbecb33c">setPacketSentAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:a0417720a61b2d587e5633360cbecb33c"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a packet is sent. <a href="class_s_x126x.html#a0417720a61b2d587e5633360cbecb33c">More...</a><br /></td></tr>
|
|
<tr class="separator:a0417720a61b2d587e5633360cbecb33c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ffc659019932dbf1fda881710054cfb"><td class="memItemLeft" align="right" valign="top"><a id="a0ffc659019932dbf1fda881710054cfb"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a0ffc659019932dbf1fda881710054cfb">clearPacketSentAction</a> ()</td></tr>
|
|
<tr class="memdesc:a0ffc659019932dbf1fda881710054cfb"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a packet is sent. <br /></td></tr>
|
|
<tr class="separator:a0ffc659019932dbf1fda881710054cfb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1fc6360740d80b664a5042ecc9d8b4fa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a1fc6360740d80b664a5042ecc9d8b4fa">setChannelScanAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:a1fc6360740d80b664a5042ecc9d8b4fa"><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#a1fc6360740d80b664a5042ecc9d8b4fa">More...</a><br /></td></tr>
|
|
<tr class="separator:a1fc6360740d80b664a5042ecc9d8b4fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7fe0afde9d35c1f860bfc6bf63e8f11e"><td class="memItemLeft" align="right" valign="top"><a id="a7fe0afde9d35c1f860bfc6bf63e8f11e"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a7fe0afde9d35c1f860bfc6bf63e8f11e">clearChannelScanAction</a> ()</td></tr>
|
|
<tr class="memdesc:a7fe0afde9d35c1f860bfc6bf63e8f11e"><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:a7fe0afde9d35c1f860bfc6bf63e8f11e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab843614658a79db7aa24e48d5b6e84f1"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8e22d67b64953c8b4da779d87d563f3e"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16e8b271dc5e9af3015dd2901153cbde"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a16e8b271dc5e9af3015dd2901153cbde">startReceive</a> ()</td></tr>
|
|
<tr class="memdesc:a16e8b271dc5e9af3015dd2901153cbde"><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#a16e8b271dc5e9af3015dd2901153cbde">More...</a><br /></td></tr>
|
|
<tr class="separator:a16e8b271dc5e9af3015dd2901153cbde"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0d5ce0a8d2a5b275676d9d98124312ce"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a0d5ce0a8d2a5b275676d9d98124312ce">startReceive</a> (uint32_t timeout, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE, size_t len=0)</td></tr>
|
|
<tr class="memdesc:a0d5ce0a8d2a5b275676d9d98124312ce"><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#a0d5ce0a8d2a5b275676d9d98124312ce">More...</a><br /></td></tr>
|
|
<tr class="separator:a0d5ce0a8d2a5b275676d9d98124312ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b4f8a41b593436b8c7a2a2d46ac387e"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a077f180905ce4818cbdacad0cd9fe841"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a9b090eddcb811ee19b595debfab1df"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3350cbfab628956c1a456383ac7bb2b2"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a001c4637f01ed6f0216cd6c4d7e10da3"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff8ec92d828421564322f13fb1c90223"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afdd901c5eac2ca8773d0977e2c493317"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f60df59c80241d98ce078c0417a7f08"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae5993359ace652fbdc862eb23fdd263d"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afd3113858966e878e9c67a1e710bd586"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d92dce566f8aefa836fe8f332e9560f"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8f971dca834be7e0470a9a9f0c01854e"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa668babb0bd129b2facee9fd280525ab"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6274222ccf534e98e3cd17dfa1520d4"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7cd95a5f2e39ae8fb1a3040e77fa21a3"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7deeef45d7f64a4018a3e56aaea4eb0e"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a7deeef45d7f64a4018a3e56aaea4eb0e">setBitRate</a> (float br)</td></tr>
|
|
<tr class="memdesc:a7deeef45d7f64a4018a3e56aaea4eb0e"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps. <a href="class_s_x126x.html#a7deeef45d7f64a4018a3e56aaea4eb0e">More...</a><br /></td></tr>
|
|
<tr class="separator:a7deeef45d7f64a4018a3e56aaea4eb0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af30a581d31feae6f50c0591d1ee113f1"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a75c8d32cee712e0c940163446b98e587"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59d443c02d4620cda32c63a00c6bcc22"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a920aa76ff5f0f579424ef6de92e588c8"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d8f4deb555844b24c2426dd86e69676"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a827a4754ea53388513d263e5d9171395"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac594fbb30c5010658c970a64654c7162"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a514cabe74bbe3434d7e4f244c4077752"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd8eea7e468db3d6064c19d4934d5034"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc3a7a42c401b6c44e00cb6c5b9696f2"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a95007639c2648a1dbb614493224606f1"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae500bad45638a47264b7e5955a93107d"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a57bee6f4b3a3b7ec646ac8de347ee0d6"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae46e08d579f4acbad029b4cd4f4fffaf"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acbe2d75b1e2df8bcc58c4fd9d8e6e4f9"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afabefb1b214411198f3537e8afce898f"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae36823d3539667bdf7d2f073bd4fa1ca"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#ae36823d3539667bdf7d2f073bd4fa1ca">getSNR</a> ()</td></tr>
|
|
<tr class="memdesc:ae36823d3539667bdf7d2f073bd4fa1ca"><td class="mdescLeft"> </td><td class="mdescRight">Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. <a href="class_s_x126x.html#ae36823d3539667bdf7d2f073bd4fa1ca">More...</a><br /></td></tr>
|
|
<tr class="separator:ae36823d3539667bdf7d2f073bd4fa1ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a068d709ffb79ae66d718ffb76ffae997"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac4ef8c8751a3c09d64e431684840c987"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abc3a4f9213b2a7052e97c2e3a0bf45a5"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92c157efe751b4ae73d22ff44115285d"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16eb0bdb051f3cf288db752d18182ae2"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba074a439b326bf413da8e3ad2bcf256"><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#aba074a439b326bf413da8e3ad2bcf256">calculateRxTimeout</a> (<a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> timeoutUs)</td></tr>
|
|
<tr class="memdesc:aba074a439b326bf413da8e3ad2bcf256"><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#aba074a439b326bf413da8e3ad2bcf256">More...</a><br /></td></tr>
|
|
<tr class="separator:aba074a439b326bf413da8e3ad2bcf256"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16a4433b9bebac0aa867e31a74dc258a"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a16a4433b9bebac0aa867e31a74dc258a">irqRxDoneRxTimeout</a> (uint16_t &irqFlags, uint16_t &irqMask)</td></tr>
|
|
<tr class="memdesc:a16a4433b9bebac0aa867e31a74dc258a"><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#a16a4433b9bebac0aa867e31a74dc258a">More...</a><br /></td></tr>
|
|
<tr class="separator:a16a4433b9bebac0aa867e31a74dc258a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4fc7d4fc9da64e5cd2517d3432ee6ffe"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a4fc7d4fc9da64e5cd2517d3432ee6ffe">isRxTimeout</a> ()</td></tr>
|
|
<tr class="memdesc:a4fc7d4fc9da64e5cd2517d3432ee6ffe"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the IRQ bit for RxTimeout is set. <a href="class_s_x126x.html#a4fc7d4fc9da64e5cd2517d3432ee6ffe">More...</a><br /></td></tr>
|
|
<tr class="separator:a4fc7d4fc9da64e5cd2517d3432ee6ffe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adec09cba71494bd927ad1da786606ca6"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3765f534418d4e0540c179621c019138"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a21c263ce1a339faa74c568d9afb81cd2"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ae69309ca0cf5f13c60f2d162916ff8"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b3eb51117558c58384b03de4b7bfe60"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0a0df468eacc71c1b2a093ac06bfff51"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2cb5ed645ebcc6f3f17d77e32c2ccdd7"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a420c23bb1861646e29f44c0f4c646ee8"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9ce38cfeaa36ddcc2d82b2974d7088c"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a819bb3ced0f184a63cbfbef408a68561"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a819bb3ced0f184a63cbfbef408a68561">randomByte</a> ()</td></tr>
|
|
<tr class="memdesc:a819bb3ced0f184a63cbfbef408a68561"><td class="mdescLeft"> </td><td class="mdescRight">Get one truly random byte from RSSI noise. <a href="class_s_x126x.html#a819bb3ced0f184a63cbfbef408a68561">More...</a><br /></td></tr>
|
|
<tr class="separator:a819bb3ced0f184a63cbfbef408a68561"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a269c8e4ae0d21af88e9422ccf9708c1e"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abbf8b4623da8c2caa83a8c3d35a44d0a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#abbf8b4623da8c2caa83a8c3d35a44d0a">setDirectAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:abbf8b4623da8c2caa83a8c3d35a44d0a"><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#abbf8b4623da8c2caa83a8c3d35a44d0a">More...</a><br /></td></tr>
|
|
<tr class="separator:abbf8b4623da8c2caa83a8c3d35a44d0a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8cdc4f25d4193dc75f9442874131eab3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x126x.html#a8cdc4f25d4193dc75f9442874131eab3">readBit</a> (uint32_t pin)</td></tr>
|
|
<tr class="memdesc:a8cdc4f25d4193dc75f9442874131eab3"><td class="mdescLeft"> </td><td class="mdescRight">Function to read and process data bit in direct reception mode. <a href="class_s_x126x.html#a8cdc4f25d4193dc75f9442874131eab3">More...</a><br /></td></tr>
|
|
<tr class="separator:a8cdc4f25d4193dc75f9442874131eab3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2af78b744b3e61d3857bed93c3b1bde1"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8a3ad4e12df862ab18b326d9dba26d66"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a865397e1cca38bec2d055c047825ea07"><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"><td class="mdescLeft"> </td><td class="mdescRight">Abort an ongoing spectral scan. <br /></td></tr>
|
|
<tr class="separator:a865397e1cca38bec2d055c047825ea07"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5595fff99d76d50d711b8cdad98527c4"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae473773e5bed4b08452e80311bdb26f2"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1623e7d5450c97ca092913ad79d62208"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa3c90f19cd141738ff013ae72f78f1bb"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad90a56cb55c5bb64037a0d412d84a80d"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a492b2d057dd803c3884fa1adc8e22534"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3dd42f8d5569487ea74f004ca652a709"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab82617fa3fa9f21d4cd427314ecc4af8"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a923654706eff5118ef6e84214e837f27"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad59e37ce0606dc8051e40be9d14cfec3"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3563453988a83d22dd07d4691543a300"><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"><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"><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:af1bb9a5da26da8829795ebb72e9c666e 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#af1bb9a5da26da8829795ebb72e9c666e">sleep</a> ()</td></tr>
|
|
<tr class="memdesc:af1bb9a5da26da8829795ebb72e9c666e inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Sets module to sleep. <a href="class_physical_layer.html#af1bb9a5da26da8829795ebb72e9c666e">More...</a><br /></td></tr>
|
|
<tr class="separator:af1bb9a5da26da8829795ebb72e9c666e 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:a8a194b0fbb66b1a953288bf3b9478d6e 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#a8a194b0fbb66b1a953288bf3b9478d6e">setFrequency</a> (float freq)</td></tr>
|
|
<tr class="memdesc:a8a194b0fbb66b1a953288bf3b9478d6e inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Sets carrier frequency. Must be implemented in module class. <a href="class_physical_layer.html#a8a194b0fbb66b1a953288bf3b9478d6e">More...</a><br /></td></tr>
|
|
<tr class="separator:a8a194b0fbb66b1a953288bf3b9478d6e inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2286dc78dbf8e3084f38e9159b99ae5 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#ad2286dc78dbf8e3084f38e9159b99ae5">setOutputPower</a> (int8_t power)</td></tr>
|
|
<tr class="memdesc:ad2286dc78dbf8e3084f38e9159b99ae5 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Set output power. Must be implemented in module class if the module supports it. <a href="class_physical_layer.html#ad2286dc78dbf8e3084f38e9159b99ae5">More...</a><br /></td></tr>
|
|
<tr class="separator:ad2286dc78dbf8e3084f38e9159b99ae5 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="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:ada0fe6c3d31885952b439135cf0c18f1"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae731568798d03d9722a440fd6a23faf2"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Base class for SX126x series. All derived classes for SX126x (e.g. <a class="el" href="class_s_x1262.html" title="Derived class for SX1262 modules.">SX1262</a> or <a class="el" href="class_s_x1268.html" title="Derived class for SX1268 modules.">SX1268</a>) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="aaca5a8fa8a3e634dd1b5b4c2bb5058d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaca5a8fa8a3e634dd1b5b4c2bb5058d8">◆ </a></span>SX126x()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">SX126x::SX126x </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="ab9ce38cfeaa36ddcc2d82b2974d7088c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab9ce38cfeaa36ddcc2d82b2974d7088c">◆ </a></span>autoLDRO()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::autoLDRO </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a936a40038e05740a528f2b53f8e17010"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a936a40038e05740a528f2b53f8e17010">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>cr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>syncWord</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>preambleLength</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>tcxoVoltage</em>, </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">cr</td><td>LoRa coding rate denominator. Allowed values range from 5 to 8. </td></tr>
|
|
<tr><td class="paramname">syncWord</td><td>1-byte LoRa sync word. </td></tr>
|
|
<tr><td class="paramname">preambleLength</td><td>LoRa preamble length in symbols. Allowed values range from 1 to 65535. </td></tr>
|
|
<tr><td class="paramname">tcxoVoltage</td><td>TCXO reference voltage to be set on DIO3. Defaults to 1.6 V, set to 0 to skip. </td></tr>
|
|
<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="a2e500e5b6044ccab8f6b19af4ffa917c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2e500e5b6044ccab8f6b19af4ffa917c">◆ </a></span>beginFSK()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::beginFSK </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>br</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freqDev</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>rxBw</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>preambleLength</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>tcxoVoltage</em>, </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">br</td><td>FSK bit rate in kbps. Allowed values range from 0.6 to 300.0 kbps. </td></tr>
|
|
<tr><td class="paramname">freqDev</td><td>Frequency deviation from carrier frequency in kHz. Allowed values range from 0.0 to 200.0 kHz. </td></tr>
|
|
<tr><td class="paramname">rxBw</td><td>Receiver bandwidth in kHz. 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. </td></tr>
|
|
<tr><td class="paramname">preambleLength</td><td>FSK preamble length in bits. Allowed values range from 0 to 65535. </td></tr>
|
|
<tr><td class="paramname">tcxoVoltage</td><td>TCXO reference voltage to be set on DIO3. Defaults to 1.6 V, set to 0 to skip. </td></tr>
|
|
<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="aba074a439b326bf413da8e3ad2bcf256"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aba074a439b326bf413da8e3ad2bcf256">◆ </a></span>calculateRxTimeout()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> SX126x::calculateRxTimeout </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td>
|
|
<td class="paramname"><em>timeoutUs</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Calculate the timeout value for this specific module / series (in number of symbols or units of time) </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">timeoutUs</td><td>Timeout in microseconds to listen for </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Timeout value in a unit that is specific for the used module </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a7f8d12a90158864a8ebc471b0ec89dc9">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa3c90f19cd141738ff013ae72f78f1bb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa3c90f19cd141738ff013ae72f78f1bb">◆ </a></span>calibrateImageRejection()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::calibrateImageRejection </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freqMin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freqMax</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Perform image rejection calibration for the specified frequency band. WARNING: Use at your own risk! Setting incorrect values may lead to decreased performance. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">freqMin</td><td>Frequency band lower bound. </td></tr>
|
|
<tr><td class="paramname">freqMax</td><td>Frequency band upper bound. </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="a75c8d32cee712e0c940163446b98e587"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a75c8d32cee712e0c940163446b98e587">◆ </a></span>checkDataRate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::checkDataRate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="union_data_rate__t.html">DataRate_t</a> </td>
|
|
<td class="paramname"><em>dr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check the data rate can be configured by this module. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dr</td><td>Data rate struct. Interpretation depends on currently active modem (FSK or LoRa). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a58d54eeb40fb586013ba48e15318abba">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afc3a7a42c401b6c44e00cb6c5b9696f2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afc3a7a42c401b6c44e00cb6c5b9696f2">◆ </a></span>disableAddressFiltering()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::disableAddressFiltering </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Disables address filtering. Calling this method will also erase previously set addresses. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3765f534418d4e0540c179621c019138"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3765f534418d4e0540c179621c019138">◆ </a></span>explicitHeader()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::explicitHeader </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set explicit header mode for future reception/transmission. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8e22d67b64953c8b4da779d87d563f3e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8e22d67b64953c8b4da779d87d563f3e">◆ </a></span>finishTransmit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::finishTransmit </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clean up after transmission is done. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a1de26f68b939f5af79ec29cc34c7be18">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abc3a4f9213b2a7052e97c2e3a0bf45a5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abc3a4f9213b2a7052e97c2e3a0bf45a5">◆ </a></span>fixedPacketLengthMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::fixedPacketLengthMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>len</em> = <code>RADIOLIB_SX126X_MAX_PACKET_LENGTH</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set modem in fixed packet length mode. Available in FSK mode only. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">len</td><td>Packet length. </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="a420c23bb1861646e29f44c0f4c646ee8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a420c23bb1861646e29f44c0f4c646ee8">◆ </a></span>forceLDRO()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::forceLDRO </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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> </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>Force LDRO to be always enabled (true) or disabled (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="afdd901c5eac2ca8773d0977e2c493317"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afdd901c5eac2ca8773d0977e2c493317">◆ </a></span>getChannelScanResult()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::getChannelScanResult </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read the channel scan result. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a63979795a7b53557560bb95b65480906">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa668babb0bd129b2facee9fd280525ab"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa668babb0bd129b2facee9fd280525ab">◆ </a></span>getCurrentLimit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float SX126x::getCurrentLimit </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads current protection limit. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Currently configured overcurrent protection limit in mA. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acbe2d75b1e2df8bcc58c4fd9d8e6e4f9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acbe2d75b1e2df8bcc58c4fd9d8e6e4f9">◆ </a></span>getDataRate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float SX126x::getDataRate </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets effective data rate for the last transmitted packet. The value is calculated only for payload bytes. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Effective data rate in bps. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a068d709ffb79ae66d718ffb76ffae997"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a068d709ffb79ae66d718ffb76ffae997">◆ </a></span>getFrequencyError()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float SX126x::getFrequencyError </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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! </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Frequency error in Hz. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9a9b090eddcb811ee19b595debfab1df"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9a9b090eddcb811ee19b595debfab1df">◆ </a></span>getIrqStatus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t SX126x::getIrqStatus </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads the current IRQ status. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>IRQ status bits </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac4ef8c8751a3c09d64e431684840c987"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac4ef8c8751a3c09d64e431684840c987">◆ </a></span>getPacketLength()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t SX126x::getPacketLength </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>update</em> = <code>true</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Query modem for the packet length of received payload. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">update</td><td>Update received packet length. Will return cached value when set to false. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Length of last received packet in bytes. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a2fe95169b5cdc8cabe1f2af66cad6ef6">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afabefb1b214411198f3537e8afce898f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afabefb1b214411198f3537e8afce898f">◆ </a></span>getRSSI()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float SX126x::getRSSI </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>packet</em> = <code>true</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>GetsRSSI (Recorded Signal Strength Indicator). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">packet</td><td>Whether to read last packet RSSI, or the current value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>RSSI value in dBm. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae36823d3539667bdf7d2f073bd4fa1ca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae36823d3539667bdf7d2f073bd4fa1ca">◆ </a></span>getSNR()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float SX126x::getSNR </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>SNR of the last received packet in dB. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#aedddaf9460941b90e43e9005035faa0f">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a16eb0bdb051f3cf288db752d18182ae2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a16eb0bdb051f3cf288db752d18182ae2">◆ </a></span>getTimeOnAir()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> SX126x::getTimeOnAir </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get expected time-on-air for a given size of payload. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">len</td><td>Payload length in bytes. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Expected time-on-air in microseconds. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a50e730a894f60b58034507ad7730dd3c">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adec09cba71494bd927ad1da786606ca6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adec09cba71494bd927ad1da786606ca6">◆ </a></span>implicitHeader()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::implicitHeader </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set implicit header mode for future reception/transmission. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">len</td><td>Payload length in bytes. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a269c8e4ae0d21af88e9422ccf9708c1e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a269c8e4ae0d21af88e9422ccf9708c1e">◆ </a></span>invertIQ()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::invertIQ </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable/disable inversion of the I and Q signals. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>QI inversion enabled (true) or disabled (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>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a11b4c6d0bf3ae7b9ca04e9434180feab">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a16a4433b9bebac0aa867e31a74dc258a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a16a4433b9bebac0aa867e31a74dc258a">◆ </a></span>irqRxDoneRxTimeout()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::irqRxDoneRxTimeout </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t & </td>
|
|
<td class="paramname"><em>irqFlags</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t & </td>
|
|
<td class="paramname"><em>irqMask</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create the flags that make up RxDone and RxTimeout used for receiving downlinks. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">irqFlags</td><td>The flags for which IRQs must be triggered </td></tr>
|
|
<tr><td class="paramname">irqMask</td><td>Mask indicating which IRQ triggers a DIO </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#a1d1fe00d107bbc23b0315fd442bc3292">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4fc7d4fc9da64e5cd2517d3432ee6ffe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4fc7d4fc9da64e5cd2517d3432ee6ffe">◆ </a></span>isRxTimeout()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool SX126x::isRxTimeout </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check whether the IRQ bit for RxTimeout is set. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Whether RxTimeout IRQ is set </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#acb8d8182a32439fe91f2806d73e629f4">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a819bb3ced0f184a63cbfbef408a68561"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a819bb3ced0f184a63cbfbef408a68561">◆ </a></span>randomByte()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t SX126x::randomByte </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get one truly random byte from RSSI noise. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>TRNG byte. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a1a5985308904261dd431f373d47ddee4">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8cdc4f25d4193dc75f9442874131eab3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8cdc4f25d4193dc75f9442874131eab3">◆ </a></span>readBit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SX126x::readBit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>pin</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Function to read and process data bit in direct reception mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin on which to read. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#acda61fc99cfa373153c50c78380ed885">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3563453988a83d22dd07d4691543a300"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3563453988a83d22dd07d4691543a300">◆ </a></span>readData() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::readData</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads data that was received after calling startReceive method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to array to save the received binary data. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes that will be read. When set to 0, the packet length will be retrieved automatically. When more bytes than received are requested, only the number of bytes requested will be returned. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3350cbfab628956c1a456383ac7bb2b2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3350cbfab628956c1a456383ac7bb2b2">◆ </a></span>readData() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::readData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to array to save the received binary data. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes that will be read. When set to 0, the packet length will be retrieved automatically. When more bytes than received are requested, only the number of bytes requested will be returned. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab82617fa3fa9f21d4cd427314ecc4af8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab82617fa3fa9f21d4cd427314ecc4af8">◆ </a></span>receive() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::receive</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Binary receive method. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to array to save the received binary data. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes that will be received. Must be known in advance for binary transmissions. </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="ae3db6b29c482d94eef8a43cd8b5751c0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae3db6b29c482d94eef8a43cd8b5751c0">◆ </a></span>receive() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::receive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Binary data to be sent. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes to send. </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#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8a18aee2bf05793aa29b5cf6b47bb435"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8a18aee2bf05793aa29b5cf6b47bb435">◆ </a></span>receiveDirect()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::receiveDirect </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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. </p>
|
|
<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#ad9d1dbb2041e87af5a80e12f125a60e6">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9aa6dd05dd32ef717a06cc8ba28ff71f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9aa6dd05dd32ef717a06cc8ba28ff71f">◆ </a></span>reset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::reset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>verify</em> = <code>true</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reset method. Will reset the chip to the default state using RST pin. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">verify</td><td>Whether correct module startup should be verified. When set to true, RadioLib will attempt to verify the module has started correctly by repeatedly issuing setStandby command. Enabled by default. </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="acb8611a9c3862dd1bfa73ef47b8f9b20"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acb8611a9c3862dd1bfa73ef47b8f9b20">◆ </a></span>scanChannel() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::scanChannel </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. </p>
|
|
<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#abd9e39cc745acbf084cfa0d3f4d10718">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4bbc29f5dc7253b7743599c68137df48"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4bbc29f5dc7253b7743599c68137df48">◆ </a></span>scanChannel() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::scanChannel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>symbolNum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>detPeak</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>detMin</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">symbolNum</td><td>Number of symbols for CAD detection. Defaults to the value recommended by AN1200.48. </td></tr>
|
|
<tr><td class="paramname">detPeak</td><td>Peak value for CAD detection. Defaults to the value recommended by AN1200.48. </td></tr>
|
|
<tr><td class="paramname">detMin</td><td>Minimum value for CAD detection. Defaults to the value recommended by AN1200.48. </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="a2f60df59c80241d98ce078c0417a7f08"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2f60df59c80241d98ce078c0417a7f08">◆ </a></span>setBandwidth()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setBandwidth </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>bw</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">bw</td><td>LoRa bandwidth to be set in kHz. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7deeef45d7f64a4018a3e56aaea4eb0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7deeef45d7f64a4018a3e56aaea4eb0e">◆ </a></span>setBitRate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setBitRate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>br</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">br</td><td>FSK bit rate to be set in kbps. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#aedd39ad84b45c6392087b12d59192d8c">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abd8eea7e468db3d6064c19d4934d5034"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd8eea7e468db3d6064c19d4934d5034">◆ </a></span>setBroadcastAddress()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setBroadcastAddress </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>broadAddr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets broadcast address. Calling this method will also enable address filtering for node and broadcast address. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">broadAddr</td><td>Node address to be set. </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="a1fc6360740d80b664a5042ecc9d8b4fa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1fc6360740d80b664a5042ecc9d8b4fa">◆ </a></span>setChannelScanAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SX126x::setChannelScanAction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets interrupt service routine to call when a channel scan is finished. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>ISR to call. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#ae11c191a7edf3116bf468b9153237260">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afd3113858966e878e9c67a1e710bd586"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afd3113858966e878e9c67a1e710bd586">◆ </a></span>setCodingRate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setCodingRate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>cr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets LoRa coding rate denominator. Allowed values range from 5 to 8. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cr</td><td>LoRa coding rate denominator to be set. </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="a95007639c2648a1dbb614493224606f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a95007639c2648a1dbb614493224606f1">◆ </a></span>setCRC()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setCRC </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>initial</em> = <code>0x1D0F</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>polynomial</em> = <code>0x1021</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>inverted</em> = <code>true</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets CRC configuration. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">len</td><td>CRC length in bytes, Allowed values are 1 or 2, set to 0 to disable CRC. </td></tr>
|
|
<tr><td class="paramname">initial</td><td>Initial CRC value. FSK only. Defaults to 0x1D0F (CCIT CRC). </td></tr>
|
|
<tr><td class="paramname">polynomial</td><td>Polynomial for CRC calculation. FSK only. Defaults to 0x1021 (CCIT CRC). </td></tr>
|
|
<tr><td class="paramname">inverted</td><td>Invert CRC bytes. FSK only. Defaults to true (CCIT CRC). </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="a8f971dca834be7e0470a9a9f0c01854e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8f971dca834be7e0470a9a9f0c01854e">◆ </a></span>setCurrentLimit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setCurrentLimit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>currentLimit</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets current protection limit. Can be set in 2.5 mA steps. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">currentLimit</td><td>current protection limit to be set in mA. Allowed values range from 0 to 140. </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="af30a581d31feae6f50c0591d1ee113f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af30a581d31feae6f50c0591d1ee113f1">◆ </a></span>setDataRate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setDataRate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="union_data_rate__t.html">DataRate_t</a> </td>
|
|
<td class="paramname"><em>dr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set data. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dr</td><td>Data rate struct. Interpretation depends on currently active modem (FSK or LoRa). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a6ee1fed6bbb8d3571974153ac6f26751">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1d8f4deb555844b24c2426dd86e69676"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1d8f4deb555844b24c2426dd86e69676">◆ </a></span>setDataShaping()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setDataShaping </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>sh</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sh</td><td>Time-bandwidth product of Gaussian filter to be set. </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#aeba04366a0cf05ff3d8227c4f7c8e1e9">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0da667fe702d7b4aafaa4bf7e69ea40d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0da667fe702d7b4aafaa4bf7e69ea40d">◆ </a></span>setDio1Action()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SX126x::setDio1Action </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets interrupt service routine to call when DIO1 activates. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>ISR to call. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae46e08d579f4acbad029b4cd4f4fffaf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae46e08d579f4acbad029b4cd4f4fffaf">◆ </a></span>setDio2AsRfSwitch()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setDio2AsRfSwitch </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em> = <code>true</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set DIO2 to function as RF switch (default in Semtech example designs). </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abbf8b4623da8c2caa83a8c3d35a44d0a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abbf8b4623da8c2caa83a8c3d35a44d0a">◆ </a></span>setDirectAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SX126x::setDirectAction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set interrupt service routine function to call when data bit is received in direct mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>Pointer to interrupt service routine. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#abf96cf4f3cb4c82d44be581dbe615966">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2b3eb51117558c58384b03de4b7bfe60"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2b3eb51117558c58384b03de4b7bfe60">◆ </a></span>setEncoding()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setEncoding </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>encoding</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">encoding</td><td>Encoding to be used. Set to 0 for NRZ, and 2 for whitening. </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#acb45b2342400a03a914a91d2ac7fb488">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7cd95a5f2e39ae8fb1a3040e77fa21a3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7cd95a5f2e39ae8fb1a3040e77fa21a3">◆ </a></span>setFrequencyDeviation()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setFrequencyDeviation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freqDev</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets FSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">freqDev</td><td>FSK frequency deviation to be set in kHz. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a2f4f9b428d9ea9af886ca85e5088ed7b">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a514cabe74bbe3434d7e4f244c4077752"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a514cabe74bbe3434d7e4f244c4077752">◆ </a></span>setNodeAddress()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setNodeAddress </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>nodeAddr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets node address. Calling this method will also enable address filtering for node address only. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">nodeAddr</td><td>Node address to be set. </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="ad2bc2016783a3fcad3ad4e6518ee7fc8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad2bc2016783a3fcad3ad4e6518ee7fc8">◆ </a></span>setPacketReceivedAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SX126x::setPacketReceivedAction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets interrupt service routine to call when a packet is received. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>ISR to call. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#aec928bb26f65752aa20cd236fbabb95c">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0417720a61b2d587e5633360cbecb33c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0417720a61b2d587e5633360cbecb33c">◆ </a></span>setPacketSentAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SX126x::setPacketSentAction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets interrupt service routine to call when a packet is sent. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>ISR to call. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a32b512b34f6575b2109ae3c3f35d1369">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1623e7d5450c97ca092913ad79d62208"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1623e7d5450c97ca092913ad79d62208">◆ </a></span>setPaConfig()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setPaConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>paDutyCycle</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>deviceSel</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>hpMax</em> = <code>RADIOLIB_SX126X_PA_CONFIG_HP_MAX</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>paLut</em> = <code>RADIOLIB_SX126X_PA_CONFIG_PA_LUT</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">paDutyCycle</td><td>PA duty cycle raw value. </td></tr>
|
|
<tr><td class="paramname">deviceSel</td><td>Device select, usually RADIOLIB_SX126X_PA_CONFIG_SX1261, RADIOLIB_SX126X_PA_CONFIG_SX1262 or RADIOLIB_SX126X_PA_CONFIG_SX1268. </td></tr>
|
|
<tr><td class="paramname">hpMax</td><td>hpMax raw value. </td></tr>
|
|
<tr><td class="paramname">paLut</td><td>paLut PA lookup table raw value. </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="ad90a56cb55c5bb64037a0d412d84a80d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad90a56cb55c5bb64037a0d412d84a80d">◆ </a></span>setPaRampTime()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setPaRampTime </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>rampTime</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set PA ramp-up time. Set to 200us by default. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad6274222ccf534e98e3cd17dfa1520d4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad6274222ccf534e98e3cd17dfa1520d4">◆ </a></span>setPreambleLength()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setPreambleLength </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>preambleLength</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 preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">preambleLength</td><td>Preamble length to be set in symbols (LoRa) or bits (FSK). </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#a85db1ff64e6c56e054f276c511194633">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5ae69309ca0cf5f13c60f2d162916ff8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5ae69309ca0cf5f13c60f2d162916ff8">◆ </a></span>setRegulatorDCDC()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setRegulatorDCDC </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set regulator mode to DC-DC. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a21c263ce1a339faa74c568d9afb81cd2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a21c263ce1a339faa74c568d9afb81cd2">◆ </a></span>setRegulatorLDO()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setRegulatorLDO </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set regulator mode to LDO. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0a0df468eacc71c1b2a093ac06bfff51"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0a0df468eacc71c1b2a093ac06bfff51">◆ </a></span>setRfSwitchPins()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SX126x::setRfSwitchPins </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>rxEn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>txEn</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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. </p>
|
|
<p>Radiolib will automatically set the pin mode and value of these pins, so do not control them from the sketch.</p>
|
|
<p>When more than two pins or more control over the output values are needed, use the <a class="el" href="class_s_x126x.html#a2cb5ed645ebcc6f3f17d77e32c2ccdd7" title="Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...">setRfSwitchTable()</a> function.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">rxEn</td><td>RX enable pin. </td></tr>
|
|
<tr><td class="paramname">txEn</td><td>TX enable pin. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2cb5ed645ebcc6f3f17d77e32c2ccdd7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2cb5ed645ebcc6f3f17d77e32c2ccdd7">◆ </a></span>setRfSwitchTable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SX126x::setRfSwitchTable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint32_t(&) </td>
|
|
<td class="paramname"><em>pins</em>[Module::RFSWITCH_MAX_PINS], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="struct_module_1_1_rf_switch_mode__t.html">Module::RfSwitchMode_t</a> </td>
|
|
<td class="paramname"><em>table</em>[] </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Some modules contain external RF switch controlled by pins. This function gives RadioLib control over those pins to automatically switch between various modes. </p>
|
|
<p>Radiolib will automatically set the pin mode and value of these pins, so do not control them from the sketch.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pins</td><td>A reference to an array of pins to control. This should always be an array of 3 elements. If you need less pins, use RADIOLIB_NC for the unused elements.</td></tr>
|
|
<tr><td class="paramname">table</td><td>A reference to an array of pin values to use for each supported mode. Each element is an RfSwitchMode_T struct that lists the mode for which it applies and the values for each of the pins passed in the pins argument respectively.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The <code>pins</code> array will be copied into the <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> object, so the original array can be deallocated after this call. However, a reference to the <code>table</code> array will be stored, so that array must remain valid as long RadioLib is being used.</p>
|
|
<p>The <code>mode</code> field in each table row should normally use any of the <code>MODE_*</code> constants from the <a class="el" href="class_module.html#a5a67b3a63420d762ecba9448671c99bf" title="Constants to use in a mode table set be setRfSwitchTable. These constants work for most radios,...">Module::OpMode_t</a> enum. However, some radios support additional modes and will define their own OpMode_t enum.</p>
|
|
<p>The length of the table is variable (to support radios that add additional modes), so the table must always be terminated with the special END_OF_MODE_TABLE value.</p>
|
|
<p>Normally all modes should be listed in the table, but for some radios, modes can be omitted to indicate they are not supported (e.g. when a radio has a high power and low power TX mode but external circuitry only supports low power). If applicable, this is documented in the radio class itself.</p>
|
|
<h4>Example</h4>
|
|
<p>For example, on a board that has an RF switch with an enable pin connected to PA0 and a TX/RX select pin connected to PA1:</p>
|
|
<div class="fragment"><div class="line"><span class="comment">// In global scope, define the pin array and mode table</span></div>
|
|
<div class="line"><span class="keyword">static</span> <span class="keyword">const</span> uint32_t rfswitch_pins[] =</div>
|
|
<div class="line"> {PA0, PA1, RADIOLIB_NC};</div>
|
|
<div class="line"><span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="struct_module_1_1_rf_switch_mode__t.html">Module::RfSwitchMode_t</a> rfswitch_table[] = {</div>
|
|
<div class="line"> {<a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671">Module::MODE_IDLE</a>, {LOW, LOW}},</div>
|
|
<div class="line"> {<a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f">Module::MODE_RX</a>, {HIGH, LOW}},</div>
|
|
<div class="line"> {<a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571">Module::MODE_TX</a>, {HIGH, HIGH}},</div>
|
|
<div class="line"> Module::END_OF_MODE_TABLE,</div>
|
|
<div class="line">};</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="keywordtype">void</span> setup() {</div>
|
|
<div class="line"> ...</div>
|
|
<div class="line"> <span class="comment">// Then somewhere in setup, pass them to radiolib</span></div>
|
|
<div class="line"> radio.setRfSwitchTable(rfswitch_pins, rfswitch_table);</div>
|
|
<div class="line"> ...</div>
|
|
<div class="line">}</div>
|
|
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571">Module::MODE_TX</a></div><div class="ttdeci">@ MODE_TX</div><div class="ttdoc">Transmission mode.</div><div class="ttdef"><b>Definition:</b> Module.h:114</div></div>
|
|
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671">Module::MODE_IDLE</a></div><div class="ttdeci">@ MODE_IDLE</div><div class="ttdoc">Idle mode.</div><div class="ttdef"><b>Definition:</b> Module.h:108</div></div>
|
|
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f">Module::MODE_RX</a></div><div class="ttdeci">@ MODE_RX</div><div class="ttdoc">Receive mode.</div><div class="ttdef"><b>Definition:</b> Module.h:111</div></div>
|
|
<div class="ttc" id="astruct_module_1_1_rf_switch_mode__t_html"><div class="ttname"><a href="struct_module_1_1_rf_switch_mode__t.html">Module::RfSwitchMode_t</a></div><div class="ttdoc">Description of RF switch pin states for a single mode. See setRfSwitchTable for details.</div><div class="ttdef"><b>Definition:</b> Module.h:84</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a59d443c02d4620cda32c63a00c6bcc22"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a59d443c02d4620cda32c63a00c6bcc22">◆ </a></span>setRxBandwidth()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setRxBandwidth </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>rxBw</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">rxBw</td><td>FSK receiver bandwidth to be set in kHz. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a920aa76ff5f0f579424ef6de92e588c8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a920aa76ff5f0f579424ef6de92e588c8">◆ </a></span>setRxBoostedGainMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setRxBoostedGainMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>rxbgm</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>persist</em> = <code>true</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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) </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">rxbgm</td><td>True for Rx Boosted Gain, false for Rx Power Saving Gain </td></tr>
|
|
<tr><td class="paramname">persist</td><td>True to persist Rx gain setting when waking up from warm-start mode (e.g. when using Rx duty cycle mode). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae5993359ace652fbdc862eb23fdd263d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae5993359ace652fbdc862eb23fdd263d">◆ </a></span>setSpreadingFactor()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setSpreadingFactor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>sf</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets LoRa spreading factor. Allowed values range from 5 to 12. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sf</td><td>LoRa spreading factor to be set. </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="ac594fbb30c5010658c970a64654c7162"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac594fbb30c5010658c970a64654c7162">◆ </a></span>setSyncBits()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setSyncBits </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>syncWord</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>bitsLen</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets FSK sync word in the form of array of up to 8 bytes. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">syncWord</td><td>FSK sync word to be set. </td></tr>
|
|
<tr><td class="paramname">bitsLen</td><td>FSK sync word length in bits. If length is not divisible by 8, least significant bits of syncWord will be ignored. </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="a827a4754ea53388513d263e5d9171395"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a827a4754ea53388513d263e5d9171395">◆ </a></span>setSyncWord() <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 SX126x::setSyncWord </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>syncWord</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets FSK sync word in the form of array of up to 8 bytes. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">syncWord</td><td>FSK sync word to be set. </td></tr>
|
|
<tr><td class="paramname">len</td><td>FSK sync word length in bytes. </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#a6c71cdc1238e1368274670758431a977">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9d92dce566f8aefa836fe8f332e9560f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9d92dce566f8aefa836fe8f332e9560f">◆ </a></span>setSyncWord() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setSyncWord </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>syncWord</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>controlBits</em> = <code>0x44</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets LoRa sync word. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">syncWord</td><td>LoRa sync word to be set. </td></tr>
|
|
<tr><td class="paramname">controlBits</td><td>Undocumented control bits, required for compatibility purposes. </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="a57bee6f4b3a3b7ec646ac8de347ee0d6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a57bee6f4b3a3b7ec646ac8de347ee0d6">◆ </a></span>setTCXO()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setTCXO </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>voltage</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>delay</em> = <code>5000</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets TCXO (Temperature Compensated Crystal Oscillator) configuration. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">voltage</td><td>TCXO reference voltage in volts. Allowed values are 1.6, 1.7, 1.8, 2.2. 2.4, 2.7, 3.0 and 3.3 V. Set to 0 to disable TCXO. NOTE: After setting this parameter to 0, the module will be reset (since there's no other way to disable TCXO).</td></tr>
|
|
<tr><td class="paramname">delay</td><td>TCXO timeout in us. Defaults to 5000 us. </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="ae500bad45638a47264b7e5955a93107d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae500bad45638a47264b7e5955a93107d">◆ </a></span>setWhitening()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::setWhitening </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enabled</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>initial</em> = <code>0x01FF</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets FSK whitening parameters. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enabled</td><td>True = Whitening enabled </td></tr>
|
|
<tr><td class="paramname">initial</td><td>Initial value used for the whitening LFSR in FSK mode. By default set to 0x01FF for compatibility with <a class="el" href="class_s_x127x.html" title="Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from thi...">SX127x</a> and LoRaWAN. </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="afb5509f0705cdd971065251ed6b2fb4e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afb5509f0705cdd971065251ed6b2fb4e">◆ </a></span>sleep()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::sleep </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>retainConfig</em> = <code>true</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">retainConfig</td><td>Set to true to retain configuration of the currently active modem ("warm start") or to false to discard current configuration ("cold start"). Defaults to true. </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="ae473773e5bed4b08452e80311bdb26f2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae473773e5bed4b08452e80311bdb26f2">◆ </a></span>spectralScanGetResult()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::spectralScanGetResult </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t * </td>
|
|
<td class="paramname"><em>results</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read the result of spectral scan. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">results</td><td>Array to which the results will be saved, must be RADIOLIB_SX126X_SPECTRAL_SCAN_RES_SIZE long. </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="a5595fff99d76d50d711b8cdad98527c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5595fff99d76d50d711b8cdad98527c4">◆ </a></span>spectralScanGetStatus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::spectralScanGetStatus </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read the status of spectral scan. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8a3ad4e12df862ab18b326d9dba26d66"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8a3ad4e12df862ab18b326d9dba26d66">◆ </a></span>spectralScanStart()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::spectralScanStart </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>numSamples</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>window</em> = <code>RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>interval</em> = <code>RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Start spectral scan. Requires binary path to be uploaded. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">numSamples</td><td>Number of samples for each scan. Fewer samples = better temporal resolution. </td></tr>
|
|
<tr><td class="paramname">window</td><td>RSSI averaging window size. </td></tr>
|
|
<tr><td class="paramname">interval</td><td>Scan interval length, one of RADIOLIB_SX126X_SCAN_INTERVAL_* macros. </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="a7a1579e2557c36a4a34b09039c0d0c71"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7a1579e2557c36a4a34b09039c0d0c71">◆ </a></span>standby() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::standby </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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). </p>
|
|
<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#acbcaf6aefcb77a354797e66222fe5018">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2fa0384a529746811e2dcb2eeb4188ec"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2fa0384a529746811e2dcb2eeb4188ec">◆ </a></span>standby() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::standby </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>mode</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>wakeup</em> = <code>true</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the module to standby mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mode</td><td>Oscillator to be used in standby mode. Can be set to RADIOLIB_SX126X_STANDBY_RC (13 MHz RC oscillator) or RADIOLIB_SX126X_STANDBY_XOSC (32 MHz external crystal oscillator). </td></tr>
|
|
<tr><td class="paramname">wakeup</td><td>Whether to force the module to wake up. Setting to true will immediately attempt to wake up the module. </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="a001c4637f01ed6f0216cd6c4d7e10da3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a001c4637f01ed6f0216cd6c4d7e10da3">◆ </a></span>startChannelScan() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::startChannelScan </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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. </p>
|
|
<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#ae30dfbb5445bb674898fc54f5f90b2f9">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aff8ec92d828421564322f13fb1c90223"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aff8ec92d828421564322f13fb1c90223">◆ </a></span>startChannelScan() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::startChannelScan </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>symbolNum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>detPeak</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>detMin</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven channel activity detection method. DIO1 will be activated when LoRa preamble is detected, or upon timeout. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">symbolNum</td><td>Number of symbols for CAD detection. </td></tr>
|
|
<tr><td class="paramname">detPeak</td><td>Peak value for CAD detection. </td></tr>
|
|
<tr><td class="paramname">detMin</td><td>Minimum value for CAD detection. </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="a16e8b271dc5e9af3015dd2901153cbde"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a16e8b271dc5e9af3015dd2901153cbde">◆ </a></span>startReceive() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::startReceive </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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>. </p>
|
|
<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#a18664ad615c5507ff1690baaca90b094">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0d5ce0a8d2a5b275676d9d98124312ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0d5ce0a8d2a5b275676d9d98124312ce">◆ </a></span>startReceive() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::startReceive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>timeout</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>irqFlags</em> = <code>RADIOLIB_SX126X_IRQ_RX_DEFAULT</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>irqMask</em> = <code>RADIOLIB_SX126X_IRQ_RX_DONE</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven receive method. DIO1 will be activated when full packet is received. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">timeout</td><td>Receive mode type and/or raw timeout value, expressed as multiples of 15.625 us. When set to RADIOLIB_SX126X_RX_TIMEOUT_INF, the timeout will be infinite and the device will remain in Rx mode until explicitly commanded to stop (Rx continuous mode). When set to RADIOLIB_SX126X_RX_TIMEOUT_NONE, there will be no timeout and the device will return to standby when a packet is received (Rx single mode). For any other value, timeout will be applied and signal will be generated on DIO1 for conditions defined by irqFlags and irqMask.</td></tr>
|
|
<tr><td class="paramname">irqFlags</td><td>Sets the IRQ flags, defaults to RADIOLIB_SX126X_IRQ_RX_DEFAULT. </td></tr>
|
|
<tr><td class="paramname">irqMask</td><td>Sets the mask of IRQ flags that will trigger DIO1, defaults to RADIOLIB_SX126X_IRQ_RX_DONE. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Only 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, not used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a13dbafeeb9dd9ede72cc4d907738ac48">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5b4f8a41b593436b8c7a2a2d46ac387e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5b4f8a41b593436b8c7a2a2d46ac387e">◆ </a></span>startReceiveDutyCycle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::startReceiveDutyCycle </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>rxPeriod</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>sleepPeriod</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>irqFlags</em> = <code>RADIOLIB_SX126X_IRQ_RX_DEFAULT</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>irqMask</em> = <code>RADIOLIB_SX126X_IRQ_RX_DONE</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">rxPeriod</td><td>The duration the receiver will be in Rx mode, in microseconds. </td></tr>
|
|
<tr><td class="paramname">sleepPeriod</td><td>The duration the receiver will not be in Rx mode, in microseconds. </td></tr>
|
|
<tr><td class="paramname">irqFlags</td><td>Sets the IRQ flags, defaults to RADIOLIB_SX126X_IRQ_RX_DEFAULT. </td></tr>
|
|
<tr><td class="paramname">irqMask</td><td>Sets the mask of IRQ flags that will trigger DIO1, defaults to RADIOLIB_SX126X_IRQ_RX_DONE. </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="a077f180905ce4818cbdacad0cd9fe841"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a077f180905ce4818cbdacad0cd9fe841">◆ </a></span>startReceiveDutyCycleAuto()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::startReceiveDutyCycleAuto </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>senderPreambleLength</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>minSymbols</em> = <code>8</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>irqFlags</em> = <code>RADIOLIB_SX126X_IRQ_RX_DEFAULT</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>irqMask</em> = <code>RADIOLIB_SX126X_IRQ_RX_DONE</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">senderPreambleLength</td><td>Expected preamble length of the messages to receive. If set to zero, the currently configured preamble length will be used. Defaults to zero.</td></tr>
|
|
<tr><td class="paramname">minSymbols</td><td>Parameters will be chosen to ensure that the unit will catch at least this many symbols of any preamble of the specified length. Defaults to 8. According to Semtech, receiver requires 8 symbols to reliably latch a preamble. This makes this method redundant when transmitter preamble length is less than 17 (2*minSymbols + 1).</td></tr>
|
|
<tr><td class="paramname">irqFlags</td><td>Sets the IRQ flags, defaults to RADIOLIB_SX126X_IRQ_RX_DEFAULT. </td></tr>
|
|
<tr><td class="paramname">irqMask</td><td>Sets the mask of IRQ flags that will trigger DIO1, defaults to RADIOLIB_SX126X_IRQ_RX_DONE. </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="a923654706eff5118ef6e84214e837f27"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a923654706eff5118ef6e84214e837f27">◆ </a></span>startTransmit() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::startTransmit</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">str</td><td>C-string that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. Only used in FSK mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad59e37ce0606dc8051e40be9d14cfec3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad59e37ce0606dc8051e40be9d14cfec3">◆ </a></span>startTransmit() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::startTransmit</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven binary transmit method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Binary data that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of binary data to transmit (in bytes). </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. Only used in FSK mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab843614658a79db7aa24e48d5b6e84f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab843614658a79db7aa24e48d5b6e84f1">◆ </a></span>startTransmit() <span class="overload">[3/3]</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 SX126x::startTransmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>addr</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Binary data to be sent. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes to send. </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Address to send the data to. Will only be added if address filtering was enabled. </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#ad59e37ce0606dc8051e40be9d14cfec3">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a492b2d057dd803c3884fa1adc8e22534"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a492b2d057dd803c3884fa1adc8e22534">◆ </a></span>transmit() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::transmit</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>C-string transmit method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">str</td><td>C-string that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. Only used in FSK mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3dd42f8d5569487ea74f004ca652a709"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3dd42f8d5569487ea74f004ca652a709">◆ </a></span>transmit() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::transmit</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Binary transmit method. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Binary data that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of binary data to transmit (in bytes). </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. Only used in FSK mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aab18364237ddac0c56aeaf63f08cf009"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aab18364237ddac0c56aeaf63f08cf009">◆ </a></span>transmit() <span class="overload">[3/3]</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 SX126x::transmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>addr</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Binary data to be sent. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes to send. </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Address to send the data to. Will only be added if address filtering was enabled. </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#a3dd42f8d5569487ea74f004ca652a709">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a921aa8afb8d33b2660731c1f8d67664b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a921aa8afb8d33b2660731c1f8d67664b">◆ </a></span>transmitDirect()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::transmitDirect </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>frf</em> = <code>0</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Starts direct mode transmission. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">frf</td><td>Raw RF frequency value. Defaults to 0, required for quick frequency shifts in RTTY. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#aa4c99ac794ee653c2061be4201724b65">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2af78b744b3e61d3857bed93c3b1bde1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2af78b744b3e61d3857bed93c3b1bde1">◆ </a></span>uploadPatch()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::uploadPatch </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint32_t * </td>
|
|
<td class="paramname"><em>patch</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>nonvolatile</em> = <code>true</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">patch</td><td>Binary patch to upload. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of the binary patch in 4-byte words. </td></tr>
|
|
<tr><td class="paramname">nonvolatile</td><td>Set to true when the patch is saved in non-volatile memory of the host processor, or to false when the patch is in its RAM. </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="a92c157efe751b4ae73d22ff44115285d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a92c157efe751b4ae73d22ff44115285d">◆ </a></span>variablePacketLengthMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX126x::variablePacketLengthMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>maxLen</em> = <code>RADIOLIB_SX126X_MAX_PACKET_LENGTH</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set modem in variable packet length mode. Available in FSK mode only. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">maxLen</td><td>Maximum packet length. </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>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/modules/SX126x/<a class="el" href="_s_x126x_8h_source.html">SX126x.h</a></li>
|
|
<li>src/modules/SX126x/SX126x.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_x126x.html">SX126x</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>
|