4118 lines
239 KiB
HTML
4118 lines
239 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: LR11x0 Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">RadioLib
|
|
</div>
|
|
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('class_l_r11x0.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="class_l_r11x0-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">LR11x0 Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Base class for LR11x0 series. All derived classes for LR11x0 (e.g. <a class="el" href="class_l_r1110.html" title="Derived class for LR1110 modules.">LR1110</a> or <a class="el" href="class_l_r1120.html" title="Derived class for LR1120 modules.">LR1120</a>) inherit from this base class. This class should not be instantiated directly from user code, only from its derived classes.
|
|
<a href="class_l_r11x0.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_l_r11x0_8h_source.html">LR11x0.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for LR11x0:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_l_r11x0.png" usemap="#LR11x0_map" alt=""/>
|
|
<map id="LR11x0_map" name="LR11x0_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="51,0,144,24"/>
|
|
<area href="class_l_r1110.html" title="Derived class for LR1110 modules." alt="LR1110" shape="rect" coords="0,112,93,136"/>
|
|
<area href="class_l_r1120.html" title="Derived class for LR1120 modules." alt="LR1120" shape="rect" coords="103,112,196,136"/>
|
|
<area href="class_l_r1121.html" title="Derived class for LR1121 modules." alt="LR1121" shape="rect" coords="103,168,196,192"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a2985d66f47882ab46291a4d89f686ca7" id="r_a2985d66f47882ab46291a4d89f686ca7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a2985d66f47882ab46291a4d89f686ca7">OpMode_t</a> { <br />
|
|
  <a class="el" href="class_l_r11x0.html#a2985d66f47882ab46291a4d89f686ca7a2398f9003962c8dc6d199e69ba850917">MODE_END_OF_TABLE</a> = Module::MODE_END_OF_TABLE
|
|
, <a class="el" href="class_l_r11x0.html#a2985d66f47882ab46291a4d89f686ca7ab223e6d6104d722d61e1d2aa22231012">MODE_STBY</a> = Module::MODE_IDLE
|
|
, <a class="el" href="class_l_r11x0.html#a2985d66f47882ab46291a4d89f686ca7a98f8232e13745eec261cd755c457c034">MODE_RX</a> = Module::MODE_RX
|
|
, <a class="el" href="class_l_r11x0.html#a2985d66f47882ab46291a4d89f686ca7a71c6230a03a213d3e19185691c6db551">MODE_TX</a> = Module::MODE_TX
|
|
, <br />
|
|
  <a class="el" href="class_l_r11x0.html#a2985d66f47882ab46291a4d89f686ca7a005b9c110df839cd001f82f4660762fd">MODE_TX_HP</a>
|
|
, <a class="el" href="class_l_r11x0.html#a2985d66f47882ab46291a4d89f686ca7acbbc5768e10e22bfdf776faffbfced46">MODE_TX_HF</a>
|
|
, <a class="el" href="class_l_r11x0.html#a2985d66f47882ab46291a4d89f686ca7a5f126b8030f06bb14b1659ccce645bad">MODE_GNSS</a>
|
|
, <a class="el" href="class_l_r11x0.html#a2985d66f47882ab46291a4d89f686ca7a3bee9db01eab3ac70ff178c95fe8f8ab">MODE_WIFI</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a2985d66f47882ab46291a4d89f686ca7"><td class="mdescLeft"> </td><td class="mdescRight">Custom operation modes for <a class="el" href="class_l_r11x0.html" title="Base class for LR11x0 series. All derived classes for LR11x0 (e.g. LR1110 or LR1120) inherit from thi...">LR11x0</a>. Needed because <a class="el" href="class_l_r11x0.html" title="Base class for LR11x0 series. All derived classes for LR11x0 (e.g. LR1110 or LR1120) inherit from thi...">LR11x0</a> has several modems (sub-GHz, 2.4 GHz etc.) in one package. <a href="class_l_r11x0.html#a2985d66f47882ab46291a4d89f686ca7">More...</a><br /></td></tr>
|
|
<tr class="separator:a2985d66f47882ab46291a4d89f686ca7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a562f34a054e3374b812556df3b6eb421" id="r_a562f34a054e3374b812556df3b6eb421"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a562f34a054e3374b812556df3b6eb421">LR11x0</a> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
|
<tr class="memdesc:a562f34a054e3374b812556df3b6eb421"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a562f34a054e3374b812556df3b6eb421"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa2b69f68ff6171b11a1141c8615240fd" id="r_aa2b69f68ff6171b11a1141c8615240fd"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#aa2b69f68ff6171b11a1141c8615240fd">begin</a> (float bw, uint8_t sf, uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage, bool high=false)</td></tr>
|
|
<tr class="memdesc:aa2b69f68ff6171b11a1141c8615240fd"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for LoRa modem. <br /></td></tr>
|
|
<tr class="separator:aa2b69f68ff6171b11a1141c8615240fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abcc4c776d1a09bb002226ac95574766d" id="r_abcc4c776d1a09bb002226ac95574766d"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#abcc4c776d1a09bb002226ac95574766d">beginGFSK</a> (float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage)</td></tr>
|
|
<tr class="memdesc:abcc4c776d1a09bb002226ac95574766d"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for FSK modem. <br /></td></tr>
|
|
<tr class="separator:abcc4c776d1a09bb002226ac95574766d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a244ee48075d44c7064b454eb9c4afdb8" id="r_a244ee48075d44c7064b454eb9c4afdb8"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a244ee48075d44c7064b454eb9c4afdb8">beginLRFHSS</a> (uint8_t bw, uint8_t cr, bool narrowGrid, float tcxoVoltage)</td></tr>
|
|
<tr class="memdesc:a244ee48075d44c7064b454eb9c4afdb8"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for LR-FHSS modem. <br /></td></tr>
|
|
<tr class="separator:a244ee48075d44c7064b454eb9c4afdb8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7f31060cbab41ad53ee6fa7126cd17b" id="r_ad7f31060cbab41ad53ee6fa7126cd17b"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ad7f31060cbab41ad53ee6fa7126cd17b">beginGNSS</a> (uint8_t constellations=RADIOLIB_LR11X0_GNSS_CONSTELLATION_GPS|RADIOLIB_LR11X0_GNSS_CONSTELLATION_BEIDOU, float tcxoVoltage=1.6)</td></tr>
|
|
<tr class="memdesc:ad7f31060cbab41ad53ee6fa7126cd17b"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for GNSS scanning. <br /></td></tr>
|
|
<tr class="separator:ad7f31060cbab41ad53ee6fa7126cd17b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a288bcc309d3676bc0bbe620b7d89d994" id="r_a288bcc309d3676bc0bbe620b7d89d994"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a288bcc309d3676bc0bbe620b7d89d994">reset</a> ()</td></tr>
|
|
<tr class="memdesc:a288bcc309d3676bc0bbe620b7d89d994"><td class="mdescLeft"> </td><td class="mdescRight">Reset method. Will reset the chip to the default state using RST pin. <br /></td></tr>
|
|
<tr class="separator:a288bcc309d3676bc0bbe620b7d89d994"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a21e865665318dece7d95336a275dd973" id="r_a21e865665318dece7d95336a275dd973"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a21e865665318dece7d95336a275dd973">transmit</a> (const uint8_t *data, size_t len, uint8_t addr=0) override</td></tr>
|
|
<tr class="memdesc:a21e865665318dece7d95336a275dd973"><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>. <br /></td></tr>
|
|
<tr class="separator:a21e865665318dece7d95336a275dd973"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a377c287f18c939c2b4da3241d8329e58" id="r_a377c287f18c939c2b4da3241d8329e58"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a377c287f18c939c2b4da3241d8329e58">receive</a> (uint8_t *data, size_t len) override</td></tr>
|
|
<tr class="memdesc:a377c287f18c939c2b4da3241d8329e58"><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>. <br /></td></tr>
|
|
<tr class="separator:a377c287f18c939c2b4da3241d8329e58"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae077957969f6274a53f63b314b6f1359" id="r_ae077957969f6274a53f63b314b6f1359"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ae077957969f6274a53f63b314b6f1359">transmitDirect</a> (uint32_t frf=0) override</td></tr>
|
|
<tr class="memdesc:ae077957969f6274a53f63b314b6f1359"><td class="mdescLeft"> </td><td class="mdescRight">Starts direct mode transmission. <br /></td></tr>
|
|
<tr class="separator:ae077957969f6274a53f63b314b6f1359"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1a8e8eda78113c47f1a865e63051bb5" id="r_ae1a8e8eda78113c47f1a865e63051bb5"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ae1a8e8eda78113c47f1a865e63051bb5">receiveDirect</a> () override</td></tr>
|
|
<tr class="memdesc:ae1a8e8eda78113c47f1a865e63051bb5"><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. <br /></td></tr>
|
|
<tr class="separator:ae1a8e8eda78113c47f1a865e63051bb5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a3034c91f5bce70c853ab1620725b3c" id="r_a6a3034c91f5bce70c853ab1620725b3c"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a6a3034c91f5bce70c853ab1620725b3c">scanChannel</a> () override</td></tr>
|
|
<tr class="memdesc:a6a3034c91f5bce70c853ab1620725b3c"><td class="mdescLeft"> </td><td class="mdescRight">Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. <br /></td></tr>
|
|
<tr class="separator:a6a3034c91f5bce70c853ab1620725b3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5e8f21878bdab1439805aea1e9da168d" id="r_a5e8f21878bdab1439805aea1e9da168d"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a5e8f21878bdab1439805aea1e9da168d">scanChannel</a> (const <a class="el" href="union_channel_scan_config__t.html">ChannelScanConfig_t</a> &config) override</td></tr>
|
|
<tr class="memdesc:a5e8f21878bdab1439805aea1e9da168d"><td class="mdescLeft"> </td><td class="mdescRight">Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. <br /></td></tr>
|
|
<tr class="separator:a5e8f21878bdab1439805aea1e9da168d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74c3f3f8409f1fd0f41347b7d3c7dc24" id="r_a74c3f3f8409f1fd0f41347b7d3c7dc24"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a74c3f3f8409f1fd0f41347b7d3c7dc24">standby</a> () override</td></tr>
|
|
<tr class="memdesc:a74c3f3f8409f1fd0f41347b7d3c7dc24"><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). <br /></td></tr>
|
|
<tr class="separator:a74c3f3f8409f1fd0f41347b7d3c7dc24"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d682ec2ca0ddf4da41a93dd8e728665" id="r_a2d682ec2ca0ddf4da41a93dd8e728665"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a2d682ec2ca0ddf4da41a93dd8e728665">standby</a> (uint8_t mode, bool wakeup=true)</td></tr>
|
|
<tr class="memdesc:a2d682ec2ca0ddf4da41a93dd8e728665"><td class="mdescLeft"> </td><td class="mdescRight">Sets the module to standby mode. <br /></td></tr>
|
|
<tr class="separator:a2d682ec2ca0ddf4da41a93dd8e728665"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad5dde79f751bbd7ea277872e237f2a69" id="r_ad5dde79f751bbd7ea277872e237f2a69"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ad5dde79f751bbd7ea277872e237f2a69">sleep</a> () override</td></tr>
|
|
<tr class="memdesc:ad5dde79f751bbd7ea277872e237f2a69"><td class="mdescLeft"> </td><td class="mdescRight">Sets the module to sleep mode. To wake the device up, call <a class="el" href="class_l_r11x0.html#a74c3f3f8409f1fd0f41347b7d3c7dc24" title="Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...">standby()</a>. Overload with warm start enabled for <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a> compatibility. <br /></td></tr>
|
|
<tr class="separator:ad5dde79f751bbd7ea277872e237f2a69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2786a2f17af5769c772ebc73df88e1f" id="r_ad2786a2f17af5769c772ebc73df88e1f"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ad2786a2f17af5769c772ebc73df88e1f">sleep</a> (bool retainConfig, uint32_t sleepTime)</td></tr>
|
|
<tr class="memdesc:ad2786a2f17af5769c772ebc73df88e1f"><td class="mdescLeft"> </td><td class="mdescRight">Sets the module to sleep mode. To wake the device up, call <a class="el" href="class_l_r11x0.html#a74c3f3f8409f1fd0f41347b7d3c7dc24" title="Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...">standby()</a>. <br /></td></tr>
|
|
<tr class="separator:ad2786a2f17af5769c772ebc73df88e1f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49116d006b60128fe6f73a6a868a6d18" id="r_a49116d006b60128fe6f73a6a868a6d18"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a49116d006b60128fe6f73a6a868a6d18">setIrqAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:a49116d006b60128fe6f73a6a868a6d18"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when IRQ1 activates. <br /></td></tr>
|
|
<tr class="separator:a49116d006b60128fe6f73a6a868a6d18"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab167c4dc14e80d19f8b33d68c3f90d98" id="r_ab167c4dc14e80d19f8b33d68c3f90d98"><td class="memItemLeft" align="right" valign="top"><a id="ab167c4dc14e80d19f8b33d68c3f90d98" name="ab167c4dc14e80d19f8b33d68c3f90d98"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>clearIrqAction</b> ()</td></tr>
|
|
<tr class="memdesc:ab167c4dc14e80d19f8b33d68c3f90d98"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when IRQ1 activates. <br /></td></tr>
|
|
<tr class="separator:ab167c4dc14e80d19f8b33d68c3f90d98"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2a8ece736198c966e3870dac09f4e87" id="r_ac2a8ece736198c966e3870dac09f4e87"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ac2a8ece736198c966e3870dac09f4e87">setPacketReceivedAction</a> (void(*func)(void)) override</td></tr>
|
|
<tr class="memdesc:ac2a8ece736198c966e3870dac09f4e87"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a packet is received. <br /></td></tr>
|
|
<tr class="separator:ac2a8ece736198c966e3870dac09f4e87"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a96e4a220bbd3487423acfd217b479fe3" id="r_a96e4a220bbd3487423acfd217b479fe3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a96e4a220bbd3487423acfd217b479fe3">clearPacketReceivedAction</a> () override</td></tr>
|
|
<tr class="memdesc:a96e4a220bbd3487423acfd217b479fe3"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a packet is received. <br /></td></tr>
|
|
<tr class="separator:a96e4a220bbd3487423acfd217b479fe3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92299e41f839590008b4e344776838a1" id="r_a92299e41f839590008b4e344776838a1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a92299e41f839590008b4e344776838a1">setPacketSentAction</a> (void(*func)(void)) override</td></tr>
|
|
<tr class="memdesc:a92299e41f839590008b4e344776838a1"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a packet is sent. <br /></td></tr>
|
|
<tr class="separator:a92299e41f839590008b4e344776838a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a95ddec84ae2fb19989c333d42d4dc5fa" id="r_a95ddec84ae2fb19989c333d42d4dc5fa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a95ddec84ae2fb19989c333d42d4dc5fa">clearPacketSentAction</a> () override</td></tr>
|
|
<tr class="memdesc:a95ddec84ae2fb19989c333d42d4dc5fa"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a packet is sent. <br /></td></tr>
|
|
<tr class="separator:a95ddec84ae2fb19989c333d42d4dc5fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaff9a5b9b7636693c98bd1c93a5863e5" id="r_aaff9a5b9b7636693c98bd1c93a5863e5"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#aaff9a5b9b7636693c98bd1c93a5863e5">finishTransmit</a> () override</td></tr>
|
|
<tr class="memdesc:aaff9a5b9b7636693c98bd1c93a5863e5"><td class="mdescLeft"> </td><td class="mdescRight">Clean up after transmission is done. <br /></td></tr>
|
|
<tr class="separator:aaff9a5b9b7636693c98bd1c93a5863e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa6ce285cc1b76ce028db6442a421ed8d" id="r_aa6ce285cc1b76ce028db6442a421ed8d"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#aa6ce285cc1b76ce028db6442a421ed8d">startReceive</a> () override</td></tr>
|
|
<tr class="memdesc:aa6ce285cc1b76ce028db6442a421ed8d"><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>. <br /></td></tr>
|
|
<tr class="separator:aa6ce285cc1b76ce028db6442a421ed8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0309154558a0d88e2e8957e4dbf6a2f8" id="r_a0309154558a0d88e2e8957e4dbf6a2f8"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a0309154558a0d88e2e8957e4dbf6a2f8">getIrqStatus</a> ()</td></tr>
|
|
<tr class="memdesc:a0309154558a0d88e2e8957e4dbf6a2f8"><td class="mdescLeft"> </td><td class="mdescRight">Reads the current IRQ status. <br /></td></tr>
|
|
<tr class="separator:a0309154558a0d88e2e8957e4dbf6a2f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a20279f1b267e936991f47fd703924833" id="r_a20279f1b267e936991f47fd703924833"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a20279f1b267e936991f47fd703924833">readData</a> (uint8_t *data, size_t len) override</td></tr>
|
|
<tr class="memdesc:a20279f1b267e936991f47fd703924833"><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! <br /></td></tr>
|
|
<tr class="separator:a20279f1b267e936991f47fd703924833"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f3bc362530b85dd643669705f03998d" id="r_a4f3bc362530b85dd643669705f03998d"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a4f3bc362530b85dd643669705f03998d">startChannelScan</a> () override</td></tr>
|
|
<tr class="memdesc:a4f3bc362530b85dd643669705f03998d"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven channel activity detection method. IRQ1 will be activated when LoRa preamble is detected, or upon timeout. Defaults to CAD parameter values recommended by AN1200.48. <br /></td></tr>
|
|
<tr class="separator:a4f3bc362530b85dd643669705f03998d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab073ade3f6b9bbb383e388904812f575" id="r_ab073ade3f6b9bbb383e388904812f575"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ab073ade3f6b9bbb383e388904812f575">startChannelScan</a> (const <a class="el" href="union_channel_scan_config__t.html">ChannelScanConfig_t</a> &config) override</td></tr>
|
|
<tr class="memdesc:ab073ade3f6b9bbb383e388904812f575"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven channel activity detection method. IRQ pin will be activated when LoRa preamble is detected, or upon timeout. <br /></td></tr>
|
|
<tr class="separator:ab073ade3f6b9bbb383e388904812f575"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ae2cddeb7671d9b71e9c83bf020820f" id="r_a1ae2cddeb7671d9b71e9c83bf020820f"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a1ae2cddeb7671d9b71e9c83bf020820f">getChannelScanResult</a> () override</td></tr>
|
|
<tr class="memdesc:a1ae2cddeb7671d9b71e9c83bf020820f"><td class="mdescLeft"> </td><td class="mdescRight">Read the channel scan result. <br /></td></tr>
|
|
<tr class="separator:a1ae2cddeb7671d9b71e9c83bf020820f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a70d9849eb8e5ce2090e4e332252753d7" id="r_a70d9849eb8e5ce2090e4e332252753d7"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a70d9849eb8e5ce2090e4e332252753d7">setBandwidth</a> (float bw, bool high=false)</td></tr>
|
|
<tr class="memdesc:a70d9849eb8e5ce2090e4e332252753d7"><td class="mdescLeft"> </td><td class="mdescRight">Sets LoRa bandwidth. Allowed values are 62.5, 125.0, 250.0 and 500.0 kHz. (default, high = false) <br /></td></tr>
|
|
<tr class="separator:a70d9849eb8e5ce2090e4e332252753d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf6895cbf7af7e00ea06c5b2b5040cb4" id="r_adf6895cbf7af7e00ea06c5b2b5040cb4"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#adf6895cbf7af7e00ea06c5b2b5040cb4">setSpreadingFactor</a> (uint8_t sf, bool legacy=false)</td></tr>
|
|
<tr class="memdesc:adf6895cbf7af7e00ea06c5b2b5040cb4"><td class="mdescLeft"> </td><td class="mdescRight">Sets LoRa spreading factor. Allowed values range from 5 to 12. <br /></td></tr>
|
|
<tr class="separator:adf6895cbf7af7e00ea06c5b2b5040cb4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a583f2d5ed601a98c609dbf0d57f2f541" id="r_a583f2d5ed601a98c609dbf0d57f2f541"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a583f2d5ed601a98c609dbf0d57f2f541">setCodingRate</a> (uint8_t cr, bool longInterleave=false)</td></tr>
|
|
<tr class="memdesc:a583f2d5ed601a98c609dbf0d57f2f541"><td class="mdescLeft"> </td><td class="mdescRight">Sets LoRa coding rate denominator. Allowed values range from 5 to 8. <br /></td></tr>
|
|
<tr class="separator:a583f2d5ed601a98c609dbf0d57f2f541"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee7dbdbd76f4639395af4a0db17025a7" id="r_aee7dbdbd76f4639395af4a0db17025a7"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#aee7dbdbd76f4639395af4a0db17025a7">setSyncWord</a> (uint8_t syncWord)</td></tr>
|
|
<tr class="memdesc:aee7dbdbd76f4639395af4a0db17025a7"><td class="mdescLeft"> </td><td class="mdescRight">Sets LoRa sync word. <br /></td></tr>
|
|
<tr class="separator:aee7dbdbd76f4639395af4a0db17025a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab1954e4733a7fbea4129d9a2de2285d9" id="r_ab1954e4733a7fbea4129d9a2de2285d9"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ab1954e4733a7fbea4129d9a2de2285d9">setBitRate</a> (float br) override</td></tr>
|
|
<tr class="memdesc:ab1954e4733a7fbea4129d9a2de2285d9"><td class="mdescLeft"> </td><td class="mdescRight">Sets GFSK bit rate. Allowed values range from 0.6 to 300.0 kbps. <br /></td></tr>
|
|
<tr class="separator:ab1954e4733a7fbea4129d9a2de2285d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac003cfe3a4dbd9bad1f01fd0147031d1" id="r_ac003cfe3a4dbd9bad1f01fd0147031d1"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ac003cfe3a4dbd9bad1f01fd0147031d1">setFrequencyDeviation</a> (float freqDev) override</td></tr>
|
|
<tr class="memdesc:ac003cfe3a4dbd9bad1f01fd0147031d1"><td class="mdescLeft"> </td><td class="mdescRight">Sets GFSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz. <br /></td></tr>
|
|
<tr class="separator:ac003cfe3a4dbd9bad1f01fd0147031d1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25f5ee68b3c2638ae613c87ed1c3fc64" id="r_a25f5ee68b3c2638ae613c87ed1c3fc64"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a25f5ee68b3c2638ae613c87ed1c3fc64">setRxBandwidth</a> (float rxBw)</td></tr>
|
|
<tr class="memdesc:a25f5ee68b3c2638ae613c87ed1c3fc64"><td class="mdescLeft"> </td><td class="mdescRight">Sets GFSK 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. <br /></td></tr>
|
|
<tr class="separator:a25f5ee68b3c2638ae613c87ed1c3fc64"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab8c54b1b105605ffe0908c5ff9362932" id="r_ab8c54b1b105605ffe0908c5ff9362932"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ab8c54b1b105605ffe0908c5ff9362932">setSyncWord</a> (uint8_t *syncWord, size_t len) override</td></tr>
|
|
<tr class="memdesc:ab8c54b1b105605ffe0908c5ff9362932"><td class="mdescLeft"> </td><td class="mdescRight">Sets GFSK sync word in the form of array of up to 8 bytes. <br /></td></tr>
|
|
<tr class="separator:ab8c54b1b105605ffe0908c5ff9362932"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6501ef362df1a5b71927cfe4e43c202d" id="r_a6501ef362df1a5b71927cfe4e43c202d"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a6501ef362df1a5b71927cfe4e43c202d">setSyncBits</a> (uint8_t *syncWord, uint8_t bitsLen)</td></tr>
|
|
<tr class="memdesc:a6501ef362df1a5b71927cfe4e43c202d"><td class="mdescLeft"> </td><td class="mdescRight">Sets GFSK sync word in the form of array of up to 8 bytes. <br /></td></tr>
|
|
<tr class="separator:a6501ef362df1a5b71927cfe4e43c202d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a605f5c74ce523abad256866abe133d2e" id="r_a605f5c74ce523abad256866abe133d2e"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a605f5c74ce523abad256866abe133d2e">setNodeAddress</a> (uint8_t nodeAddr)</td></tr>
|
|
<tr class="memdesc:a605f5c74ce523abad256866abe133d2e"><td class="mdescLeft"> </td><td class="mdescRight">Sets node address. Calling this method will also enable address filtering for node address only. <br /></td></tr>
|
|
<tr class="separator:a605f5c74ce523abad256866abe133d2e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af24ba794f71c4e37cd13d2f4dbec5bf7" id="r_af24ba794f71c4e37cd13d2f4dbec5bf7"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#af24ba794f71c4e37cd13d2f4dbec5bf7">setBroadcastAddress</a> (uint8_t broadAddr)</td></tr>
|
|
<tr class="memdesc:af24ba794f71c4e37cd13d2f4dbec5bf7"><td class="mdescLeft"> </td><td class="mdescRight">Sets broadcast address. Calling this method will also enable address filtering for node and broadcast address. <br /></td></tr>
|
|
<tr class="separator:af24ba794f71c4e37cd13d2f4dbec5bf7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae565dc2423ca7df13bf7ae48cce9ac8b" id="r_ae565dc2423ca7df13bf7ae48cce9ac8b"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ae565dc2423ca7df13bf7ae48cce9ac8b">disableAddressFiltering</a> ()</td></tr>
|
|
<tr class="memdesc:ae565dc2423ca7df13bf7ae48cce9ac8b"><td class="mdescLeft"> </td><td class="mdescRight">Disables address filtering. Calling this method will also erase previously set addresses. <br /></td></tr>
|
|
<tr class="separator:ae565dc2423ca7df13bf7ae48cce9ac8b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a33df702da3f5b010e07d5e6fac7aa6" id="r_a5a33df702da3f5b010e07d5e6fac7aa6"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a5a33df702da3f5b010e07d5e6fac7aa6">setDataShaping</a> (uint8_t sh) override</td></tr>
|
|
<tr class="memdesc:a5a33df702da3f5b010e07d5e6fac7aa6"><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. <br /></td></tr>
|
|
<tr class="separator:a5a33df702da3f5b010e07d5e6fac7aa6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8ae178a17f6e41b545b79cfffd3e2864" id="r_a8ae178a17f6e41b545b79cfffd3e2864"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a8ae178a17f6e41b545b79cfffd3e2864">setEncoding</a> (uint8_t encoding) override</td></tr>
|
|
<tr class="memdesc:a8ae178a17f6e41b545b79cfffd3e2864"><td class="mdescLeft"> </td><td class="mdescRight">Sets transmission encoding. Available in GFSK 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. <br /></td></tr>
|
|
<tr class="separator:a8ae178a17f6e41b545b79cfffd3e2864"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5df4c1ed45bf59aa25bc400bcb5dc1ba" id="r_a5df4c1ed45bf59aa25bc400bcb5dc1ba"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a5df4c1ed45bf59aa25bc400bcb5dc1ba">fixedPacketLengthMode</a> (uint8_t len=RADIOLIB_LR11X0_MAX_PACKET_LENGTH)</td></tr>
|
|
<tr class="memdesc:a5df4c1ed45bf59aa25bc400bcb5dc1ba"><td class="mdescLeft"> </td><td class="mdescRight">Set modem in fixed packet length mode. Available in GFSK mode only. <br /></td></tr>
|
|
<tr class="separator:a5df4c1ed45bf59aa25bc400bcb5dc1ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adcd56cf63e91449b6cd03782a69c3451" id="r_adcd56cf63e91449b6cd03782a69c3451"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#adcd56cf63e91449b6cd03782a69c3451">variablePacketLengthMode</a> (uint8_t maxLen=RADIOLIB_LR11X0_MAX_PACKET_LENGTH)</td></tr>
|
|
<tr class="memdesc:adcd56cf63e91449b6cd03782a69c3451"><td class="mdescLeft"> </td><td class="mdescRight">Set modem in variable packet length mode. Available in GFSK mode only. <br /></td></tr>
|
|
<tr class="separator:adcd56cf63e91449b6cd03782a69c3451"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adcde55b8660c24cf5783942a4132786d" id="r_adcde55b8660c24cf5783942a4132786d"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#adcde55b8660c24cf5783942a4132786d">setWhitening</a> (bool enabled, uint16_t initial=0x01FF)</td></tr>
|
|
<tr class="memdesc:adcde55b8660c24cf5783942a4132786d"><td class="mdescLeft"> </td><td class="mdescRight">Sets GFSK whitening parameters. <br /></td></tr>
|
|
<tr class="separator:adcde55b8660c24cf5783942a4132786d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a056e65c58ff8fb18bd84917512790ee6" id="r_a056e65c58ff8fb18bd84917512790ee6"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a056e65c58ff8fb18bd84917512790ee6">setDataRate</a> (<a class="el" href="union_data_rate__t.html">DataRate_t</a> dr) override</td></tr>
|
|
<tr class="memdesc:a056e65c58ff8fb18bd84917512790ee6"><td class="mdescLeft"> </td><td class="mdescRight">Set data. <br /></td></tr>
|
|
<tr class="separator:a056e65c58ff8fb18bd84917512790ee6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d18ad719be79c083f2b0ce77bbaa448" id="r_a4d18ad719be79c083f2b0ce77bbaa448"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a4d18ad719be79c083f2b0ce77bbaa448">checkDataRate</a> (<a class="el" href="union_data_rate__t.html">DataRate_t</a> dr) override</td></tr>
|
|
<tr class="memdesc:a4d18ad719be79c083f2b0ce77bbaa448"><td class="mdescLeft"> </td><td class="mdescRight">Check the data rate can be configured by this module. <br /></td></tr>
|
|
<tr class="separator:a4d18ad719be79c083f2b0ce77bbaa448"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa5d7ae65666f8f9abcb7e9b169884a4a" id="r_aa5d7ae65666f8f9abcb7e9b169884a4a"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#aa5d7ae65666f8f9abcb7e9b169884a4a">setPreambleLength</a> (size_t preambleLength) override</td></tr>
|
|
<tr class="memdesc:aa5d7ae65666f8f9abcb7e9b169884a4a"><td class="mdescLeft"> </td><td class="mdescRight">Sets preamble length for LoRa or GFSK modem. Allowed values range from 1 to 65535. <br /></td></tr>
|
|
<tr class="separator:aa5d7ae65666f8f9abcb7e9b169884a4a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a971b4ccd1d5479e9d72aa9649e8fef55" id="r_a971b4ccd1d5479e9d72aa9649e8fef55"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a971b4ccd1d5479e9d72aa9649e8fef55">setTCXO</a> (float voltage, uint32_t delay=5000)</td></tr>
|
|
<tr class="memdesc:a971b4ccd1d5479e9d72aa9649e8fef55"><td class="mdescLeft"> </td><td class="mdescRight">Sets TCXO (Temperature Compensated Crystal Oscillator) configuration. <br /></td></tr>
|
|
<tr class="separator:a971b4ccd1d5479e9d72aa9649e8fef55"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a551b82787288b0b14e4d3124e6744dc3" id="r_a551b82787288b0b14e4d3124e6744dc3"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a551b82787288b0b14e4d3124e6744dc3">setCRC</a> (uint8_t len, uint32_t initial=0x00001D0FUL, uint32_t polynomial=0x00001021UL, bool inverted=true)</td></tr>
|
|
<tr class="memdesc:a551b82787288b0b14e4d3124e6744dc3"><td class="mdescLeft"> </td><td class="mdescRight">Sets CRC configuration. <br /></td></tr>
|
|
<tr class="separator:a551b82787288b0b14e4d3124e6744dc3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af85c16956c2250dbf338a298c074d28c" id="r_af85c16956c2250dbf338a298c074d28c"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#af85c16956c2250dbf338a298c074d28c">invertIQ</a> (bool enable) override</td></tr>
|
|
<tr class="memdesc:af85c16956c2250dbf338a298c074d28c"><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable inversion of the I and Q signals. <br /></td></tr>
|
|
<tr class="separator:af85c16956c2250dbf338a298c074d28c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6cd2b2363501b2de064c9d1f32fabaa3" id="r_a6cd2b2363501b2de064c9d1f32fabaa3"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a6cd2b2363501b2de064c9d1f32fabaa3">getRSSI</a> () override</td></tr>
|
|
<tr class="memdesc:a6cd2b2363501b2de064c9d1f32fabaa3"><td class="mdescLeft"> </td><td class="mdescRight">Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. Only available for LoRa or GFSK modem. <br /></td></tr>
|
|
<tr class="separator:a6cd2b2363501b2de064c9d1f32fabaa3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a004782e6e5c6ad213c3b0c677bb8642d" id="r_a004782e6e5c6ad213c3b0c677bb8642d"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a004782e6e5c6ad213c3b0c677bb8642d">getSNR</a> () override</td></tr>
|
|
<tr class="memdesc:a004782e6e5c6ad213c3b0c677bb8642d"><td class="mdescLeft"> </td><td class="mdescRight">Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. <br /></td></tr>
|
|
<tr class="separator:a004782e6e5c6ad213c3b0c677bb8642d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9046bccdb4ef60718e2e8ed2bd7f036" id="r_ad9046bccdb4ef60718e2e8ed2bd7f036"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ad9046bccdb4ef60718e2e8ed2bd7f036">getFrequencyError</a> ()</td></tr>
|
|
<tr class="memdesc:ad9046bccdb4ef60718e2e8ed2bd7f036"><td class="mdescLeft"> </td><td class="mdescRight">Gets frequency error of the latest received packet. <br /></td></tr>
|
|
<tr class="separator:ad9046bccdb4ef60718e2e8ed2bd7f036"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac1f541bdee1d983126ceae47940b8f9d" id="r_ac1f541bdee1d983126ceae47940b8f9d"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ac1f541bdee1d983126ceae47940b8f9d">getPacketLength</a> (bool update=true) override</td></tr>
|
|
<tr class="memdesc:ac1f541bdee1d983126ceae47940b8f9d"><td class="mdescLeft"> </td><td class="mdescRight">Query modem for the packet length of received payload. <br /></td></tr>
|
|
<tr class="separator:ac1f541bdee1d983126ceae47940b8f9d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af96883b2ca7a36a8921ee1cd222adebf" id="r_af96883b2ca7a36a8921ee1cd222adebf"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#af96883b2ca7a36a8921ee1cd222adebf">getPacketLength</a> (bool update, uint8_t *offset)</td></tr>
|
|
<tr class="memdesc:af96883b2ca7a36a8921ee1cd222adebf"><td class="mdescLeft"> </td><td class="mdescRight">Query modem for the packet length of received payload. <br /></td></tr>
|
|
<tr class="separator:af96883b2ca7a36a8921ee1cd222adebf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abccf5dc80aab71090a5f19bfffa0201d" id="r_abccf5dc80aab71090a5f19bfffa0201d"><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_l_r11x0.html#abccf5dc80aab71090a5f19bfffa0201d">getTimeOnAir</a> (size_t len) override</td></tr>
|
|
<tr class="memdesc:abccf5dc80aab71090a5f19bfffa0201d"><td class="mdescLeft"> </td><td class="mdescRight">Get expected time-on-air for a given size of payload. <br /></td></tr>
|
|
<tr class="separator:abccf5dc80aab71090a5f19bfffa0201d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a260c7f4ee4739e532ddb465a276205d3" id="r_a260c7f4ee4739e532ddb465a276205d3"><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_l_r11x0.html#a260c7f4ee4739e532ddb465a276205d3">calculateRxTimeout</a> (<a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> timeoutUs) override</td></tr>
|
|
<tr class="memdesc:a260c7f4ee4739e532ddb465a276205d3"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the timeout value for this specific module / series (in number of symbols or units of time) <br /></td></tr>
|
|
<tr class="separator:a260c7f4ee4739e532ddb465a276205d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a205364e65d54f3f87b9b8f5972cdcb99" id="r_a205364e65d54f3f87b9b8f5972cdcb99"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a205364e65d54f3f87b9b8f5972cdcb99">getIrqFlags</a> () override</td></tr>
|
|
<tr class="memdesc:a205364e65d54f3f87b9b8f5972cdcb99"><td class="mdescLeft"> </td><td class="mdescRight">Read currently active IRQ flags. <br /></td></tr>
|
|
<tr class="separator:a205364e65d54f3f87b9b8f5972cdcb99"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a62c715ab18ea8a2e08a2791d3e764ee9" id="r_a62c715ab18ea8a2e08a2791d3e764ee9"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a62c715ab18ea8a2e08a2791d3e764ee9">setIrqFlags</a> (uint32_t irq) override</td></tr>
|
|
<tr class="memdesc:a62c715ab18ea8a2e08a2791d3e764ee9"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt on IRQ pin to be sent on a specific IRQ bit (e.g. RxTimeout, CadDone). <br /></td></tr>
|
|
<tr class="separator:a62c715ab18ea8a2e08a2791d3e764ee9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa524b0be7b8d125c24319072d6178e74" id="r_aa524b0be7b8d125c24319072d6178e74"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#aa524b0be7b8d125c24319072d6178e74">clearIrqFlags</a> (uint32_t irq) override</td></tr>
|
|
<tr class="memdesc:aa524b0be7b8d125c24319072d6178e74"><td class="mdescLeft"> </td><td class="mdescRight">Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone). <br /></td></tr>
|
|
<tr class="separator:aa524b0be7b8d125c24319072d6178e74"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a89b16d2231f588b67dc3aab0c0a467f4" id="r_a89b16d2231f588b67dc3aab0c0a467f4"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a89b16d2231f588b67dc3aab0c0a467f4">randomByte</a> () override</td></tr>
|
|
<tr class="memdesc:a89b16d2231f588b67dc3aab0c0a467f4"><td class="mdescLeft"> </td><td class="mdescRight">Get one truly random byte from RSSI noise. <br /></td></tr>
|
|
<tr class="separator:a89b16d2231f588b67dc3aab0c0a467f4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba13921d2cf29cc1bc8a648e1f330aa9" id="r_aba13921d2cf29cc1bc8a648e1f330aa9"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#aba13921d2cf29cc1bc8a648e1f330aa9">implicitHeader</a> (size_t len)</td></tr>
|
|
<tr class="memdesc:aba13921d2cf29cc1bc8a648e1f330aa9"><td class="mdescLeft"> </td><td class="mdescRight">Set implicit header mode for future reception/transmission. <br /></td></tr>
|
|
<tr class="separator:aba13921d2cf29cc1bc8a648e1f330aa9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3693359e5d106d6f57c23247c528cdd5" id="r_a3693359e5d106d6f57c23247c528cdd5"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a3693359e5d106d6f57c23247c528cdd5">explicitHeader</a> ()</td></tr>
|
|
<tr class="memdesc:a3693359e5d106d6f57c23247c528cdd5"><td class="mdescLeft"> </td><td class="mdescRight">Set explicit header mode for future reception/transmission. <br /></td></tr>
|
|
<tr class="separator:a3693359e5d106d6f57c23247c528cdd5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ec81f3625fdc8a3ef6c54a3804c3aa9" id="r_a1ec81f3625fdc8a3ef6c54a3804c3aa9"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a1ec81f3625fdc8a3ef6c54a3804c3aa9">getDataRate</a> () const</td></tr>
|
|
<tr class="memdesc:a1ec81f3625fdc8a3ef6c54a3804c3aa9"><td class="mdescLeft"> </td><td class="mdescRight">Gets effective data rate for the last transmitted packet. The value is calculated only for payload bytes. <br /></td></tr>
|
|
<tr class="separator:a1ec81f3625fdc8a3ef6c54a3804c3aa9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92ae10630cc327f441809ac1406737fd" id="r_a92ae10630cc327f441809ac1406737fd"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a92ae10630cc327f441809ac1406737fd">setRegulatorLDO</a> ()</td></tr>
|
|
<tr class="memdesc:a92ae10630cc327f441809ac1406737fd"><td class="mdescLeft"> </td><td class="mdescRight">Set regulator mode to LDO. <br /></td></tr>
|
|
<tr class="separator:a92ae10630cc327f441809ac1406737fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ad485f14a333f06b642f2d60aacf76c" id="r_a1ad485f14a333f06b642f2d60aacf76c"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a1ad485f14a333f06b642f2d60aacf76c">setRegulatorDCDC</a> ()</td></tr>
|
|
<tr class="memdesc:a1ad485f14a333f06b642f2d60aacf76c"><td class="mdescLeft"> </td><td class="mdescRight">Set regulator mode to DC-DC. <br /></td></tr>
|
|
<tr class="separator:a1ad485f14a333f06b642f2d60aacf76c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab0cf34cc0b67484fbf0f258bff7e9a9a" id="r_ab0cf34cc0b67484fbf0f258bff7e9a9a"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ab0cf34cc0b67484fbf0f258bff7e9a9a">setRxBoostedGainMode</a> (bool en)</td></tr>
|
|
<tr class="memdesc:ab0cf34cc0b67484fbf0f258bff7e9a9a"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables Rx Boosted Gain mode (additional Rx gain for increased power consumption). <br /></td></tr>
|
|
<tr class="separator:ab0cf34cc0b67484fbf0f258bff7e9a9a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1981f0dfceca2b6175a69530ea13d643" id="r_a1981f0dfceca2b6175a69530ea13d643"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a1981f0dfceca2b6175a69530ea13d643">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:a1981f0dfceca2b6175a69530ea13d643"><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. <br /></td></tr>
|
|
<tr class="separator:a1981f0dfceca2b6175a69530ea13d643"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0a47e772fe24c7b3f3d3288c4cd0941" id="r_ae0a47e772fe24c7b3f3d3288c4cd0941"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ae0a47e772fe24c7b3f3d3288c4cd0941">forceLDRO</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:ae0a47e772fe24c7b3f3d3288c4cd0941"><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_l_r11x0.html#aa9a8db401189ba0ce5117512b5db6a58" title="Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...">LR11x0::autoLDRO()</a> <br /></td></tr>
|
|
<tr class="separator:ae0a47e772fe24c7b3f3d3288c4cd0941"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa9a8db401189ba0ce5117512b5db6a58" id="r_aa9a8db401189ba0ce5117512b5db6a58"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#aa9a8db401189ba0ce5117512b5db6a58">autoLDRO</a> ()</td></tr>
|
|
<tr class="memdesc:aa9a8db401189ba0ce5117512b5db6a58"><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. <br /></td></tr>
|
|
<tr class="separator:aa9a8db401189ba0ce5117512b5db6a58"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c1def9a01021a52f5bb82c119a9ad35" id="r_a8c1def9a01021a52f5bb82c119a9ad35"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a8c1def9a01021a52f5bb82c119a9ad35">setLrFhssConfig</a> (uint8_t bw, uint8_t cr, uint8_t hdrCount=3, uint16_t hopSeed=0x13A)</td></tr>
|
|
<tr class="memdesc:a8c1def9a01021a52f5bb82c119a9ad35"><td class="mdescLeft"> </td><td class="mdescRight">Sets LR-FHSS configuration. <br /></td></tr>
|
|
<tr class="separator:a8c1def9a01021a52f5bb82c119a9ad35"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3498e0e621f341e415145879989e0948" id="r_a3498e0e621f341e415145879989e0948"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a3498e0e621f341e415145879989e0948">startWifiScan</a> (char wifiType, uint8_t mode=RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON, uint16_t chanMask=RADIOLIB_LR11X0_WIFI_ALL_CHANNELS, uint8_t numScans=16, uint16_t timeout=100)</td></tr>
|
|
<tr class="memdesc:a3498e0e621f341e415145879989e0948"><td class="mdescLeft"> </td><td class="mdescRight">Start passive WiFi scan. BUSY pin will be de-activated when the scan is finished. <br /></td></tr>
|
|
<tr class="separator:a3498e0e621f341e415145879989e0948"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff6060e116701c60e078d3d930723b4b" id="r_aff6060e116701c60e078d3d930723b4b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#aff6060e116701c60e078d3d930723b4b">setWiFiScanAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:aff6060e116701c60e078d3d930723b4b"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a WiFi scan is completed. <br /></td></tr>
|
|
<tr class="separator:aff6060e116701c60e078d3d930723b4b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad5876b44020a0bd59f73186a912dbb60" id="r_ad5876b44020a0bd59f73186a912dbb60"><td class="memItemLeft" align="right" valign="top"><a id="ad5876b44020a0bd59f73186a912dbb60" name="ad5876b44020a0bd59f73186a912dbb60"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>clearWiFiScanAction</b> ()</td></tr>
|
|
<tr class="memdesc:ad5876b44020a0bd59f73186a912dbb60"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a WiFi scan is completed. <br /></td></tr>
|
|
<tr class="separator:ad5876b44020a0bd59f73186a912dbb60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ef83caa291e2d310d260a8ea140bc8e" id="r_a5ef83caa291e2d310d260a8ea140bc8e"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a5ef83caa291e2d310d260a8ea140bc8e">getWifiScanResultsCount</a> (uint8_t *count)</td></tr>
|
|
<tr class="memdesc:a5ef83caa291e2d310d260a8ea140bc8e"><td class="mdescLeft"> </td><td class="mdescRight">Get number of WiFi scan results after the scan is finished. <br /></td></tr>
|
|
<tr class="separator:a5ef83caa291e2d310d260a8ea140bc8e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a457f5dfe25385a329127f07abc4631a6" id="r_a457f5dfe25385a329127f07abc4631a6"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a457f5dfe25385a329127f07abc4631a6">getWifiScanResult</a> (<a class="el" href="struct_l_r11x0_wifi_result__t.html">LR11x0WifiResult_t</a> *result, uint8_t index, bool brief=false)</td></tr>
|
|
<tr class="memdesc:a457f5dfe25385a329127f07abc4631a6"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve passive WiFi scan result. <br /></td></tr>
|
|
<tr class="separator:a457f5dfe25385a329127f07abc4631a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade5478296ebc7e02281c95609d5d75ab" id="r_ade5478296ebc7e02281c95609d5d75ab"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ade5478296ebc7e02281c95609d5d75ab">wifiScan</a> (uint8_t wifiType, uint8_t *count, uint8_t mode=RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON, uint16_t chanMask=RADIOLIB_LR11X0_WIFI_ALL_CHANNELS, uint8_t numScans=16, uint16_t timeout=100)</td></tr>
|
|
<tr class="memdesc:ade5478296ebc7e02281c95609d5d75ab"><td class="mdescLeft"> </td><td class="mdescRight">Blocking WiFi scan method. Performs a full passive WiFi scan. This method may block for several seconds! <br /></td></tr>
|
|
<tr class="separator:ade5478296ebc7e02281c95609d5d75ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac6b6b460ba12cd92a08df16e1fe33779" id="r_ac6b6b460ba12cd92a08df16e1fe33779"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ac6b6b460ba12cd92a08df16e1fe33779">getVersionInfo</a> (<a class="el" href="struct_l_r11x0_version_info__t.html">LR11x0VersionInfo_t</a> *info)</td></tr>
|
|
<tr class="memdesc:ac6b6b460ba12cd92a08df16e1fe33779"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve <a class="el" href="class_l_r11x0.html" title="Base class for LR11x0 series. All derived classes for LR11x0 (e.g. LR1110 or LR1120) inherit from thi...">LR11x0</a> hardware, device and firmware version information. <br /></td></tr>
|
|
<tr class="separator:ac6b6b460ba12cd92a08df16e1fe33779"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2820cc2b740d6d42a079bbd8bd45b85" id="r_ab2820cc2b740d6d42a079bbd8bd45b85"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ab2820cc2b740d6d42a079bbd8bd45b85">updateFirmware</a> (const uint32_t *image, size_t size, bool nonvolatile=true)</td></tr>
|
|
<tr class="memdesc:ab2820cc2b740d6d42a079bbd8bd45b85"><td class="mdescLeft"> </td><td class="mdescRight">Method to upload new firmware image to the device. The device will be automatically erased, a new firmware will be uploaded, written to flash and executed. <br /></td></tr>
|
|
<tr class="separator:ab2820cc2b740d6d42a079bbd8bd45b85"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a79818dae19d69d33a5a1facbb91c3774" id="r_a79818dae19d69d33a5a1facbb91c3774"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a79818dae19d69d33a5a1facbb91c3774">isGnssScanCapable</a> ()</td></tr>
|
|
<tr class="memdesc:a79818dae19d69d33a5a1facbb91c3774"><td class="mdescLeft"> </td><td class="mdescRight">Method to check whether the device is capable of performing a GNSS scan. <br /></td></tr>
|
|
<tr class="separator:a79818dae19d69d33a5a1facbb91c3774"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9bfaf0bdd7045f5d41f18f3f953c294" id="r_ad9bfaf0bdd7045f5d41f18f3f953c294"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ad9bfaf0bdd7045f5d41f18f3f953c294">gnssScan</a> (<a class="el" href="struct_l_r11x0_gnss_result__t.html">LR11x0GnssResult_t</a> *res=NULL)</td></tr>
|
|
<tr class="memdesc:ad9bfaf0bdd7045f5d41f18f3f953c294"><td class="mdescLeft"> </td><td class="mdescRight">Performs GNSS scan. <br /></td></tr>
|
|
<tr class="separator:ad9bfaf0bdd7045f5d41f18f3f953c294"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a748d30cb7a0b419066f6361a966b306f" id="r_a748d30cb7a0b419066f6361a966b306f"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a748d30cb7a0b419066f6361a966b306f">getGnssAlmanacStatus</a> (<a class="el" href="struct_l_r11x0_gnss_almanac_status__t.html">LR11x0GnssAlmanacStatus_t</a> *stat)</td></tr>
|
|
<tr class="memdesc:a748d30cb7a0b419066f6361a966b306f"><td class="mdescLeft"> </td><td class="mdescRight">Read information about the almanac. <br /></td></tr>
|
|
<tr class="separator:a748d30cb7a0b419066f6361a966b306f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2dbab0fe3433e914c19a8d03fe32358" id="r_ab2dbab0fe3433e914c19a8d03fe32358"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ab2dbab0fe3433e914c19a8d03fe32358">gnssDelayUntilSubframe</a> (<a class="el" href="struct_l_r11x0_gnss_almanac_status__t.html">LR11x0GnssAlmanacStatus_t</a> *stat, uint8_t constellation)</td></tr>
|
|
<tr class="memdesc:ab2dbab0fe3433e914c19a8d03fe32358"><td class="mdescLeft"> </td><td class="mdescRight">Blocking wait until the next subframe with almanac data is available. Used to control timing during almanac update from satellite. <br /></td></tr>
|
|
<tr class="separator:ab2dbab0fe3433e914c19a8d03fe32358"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a96aa9566399e46fc03f2b73b44058e3f" id="r_a96aa9566399e46fc03f2b73b44058e3f"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a96aa9566399e46fc03f2b73b44058e3f">updateGnssAlmanac</a> (uint8_t constellation)</td></tr>
|
|
<tr class="memdesc:a96aa9566399e46fc03f2b73b44058e3f"><td class="mdescLeft"> </td><td class="mdescRight">Perform almanac update. Must be called immediately after gnssDelayUntilSubframe. <br /></td></tr>
|
|
<tr class="separator:a96aa9566399e46fc03f2b73b44058e3f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a19a4b4a138dbd0e5c8f980de0f6419e4" id="r_a19a4b4a138dbd0e5c8f980de0f6419e4"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a19a4b4a138dbd0e5c8f980de0f6419e4">getGnssPosition</a> (<a class="el" href="struct_l_r11x0_gnss_position__t.html">LR11x0GnssPosition_t</a> *pos, bool filtered=true)</td></tr>
|
|
<tr class="memdesc:a19a4b4a138dbd0e5c8f980de0f6419e4"><td class="mdescLeft"> </td><td class="mdescRight">Get GNSS position. Called after gnssScan to retrieve the position calculated by the internal solver. <br /></td></tr>
|
|
<tr class="separator:a19a4b4a138dbd0e5c8f980de0f6419e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a97a3f23b796257135a9afd33c28e8ed5" id="r_a97a3f23b796257135a9afd33c28e8ed5"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a97a3f23b796257135a9afd33c28e8ed5">getGnssSatellites</a> (<a class="el" href="struct_l_r11x0_gnss_satellite__t.html">LR11x0GnssSatellite_t</a> *sats, uint8_t numSats)</td></tr>
|
|
<tr class="memdesc:a97a3f23b796257135a9afd33c28e8ed5"><td class="mdescLeft"> </td><td class="mdescRight">Get GNSS satellites found during the last scan. <br /></td></tr>
|
|
<tr class="separator:a97a3f23b796257135a9afd33c28e8ed5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afe8684b336a8137cde591283297a869c" id="r_afe8684b336a8137cde591283297a869c"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#afe8684b336a8137cde591283297a869c">getModem</a> (ModemType_t *modem) override</td></tr>
|
|
<tr class="memdesc:afe8684b336a8137cde591283297a869c"><td class="mdescLeft"> </td><td class="mdescRight">Get modem currently in use by the radio. <br /></td></tr>
|
|
<tr class="separator:afe8684b336a8137cde591283297a869c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adc8fbcfff7cd3b801dcee22e87bc2598" id="r_adc8fbcfff7cd3b801dcee22e87bc2598"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#adc8fbcfff7cd3b801dcee22e87bc2598">calibrateImageRejection</a> (float freqMin, float freqMax)</td></tr>
|
|
<tr class="memdesc:adc8fbcfff7cd3b801dcee22e87bc2598"><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. <br /></td></tr>
|
|
<tr class="separator:adc8fbcfff7cd3b801dcee22e87bc2598"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66af76a767045af7ef248868ab6a6c28" id="r_a66af76a767045af7ef248868ab6a6c28"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a66af76a767045af7ef248868ab6a6c28">stageMode</a> (RadioModeType_t mode, <a class="el" href="union_radio_mode_config__t.html">RadioModeConfig_t</a> *cfg) override</td></tr>
|
|
<tr class="memdesc:a66af76a767045af7ef248868ab6a6c28"><td class="mdescLeft"> </td><td class="mdescRight">Stage mode of the radio to be launched later using launchMode. <br /></td></tr>
|
|
<tr class="separator:a66af76a767045af7ef248868ab6a6c28"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaeae4664f6b20a8a88f625b71245480d" id="r_aaeae4664f6b20a8a88f625b71245480d"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#aaeae4664f6b20a8a88f625b71245480d">launchMode</a> () override</td></tr>
|
|
<tr class="memdesc:aaeae4664f6b20a8a88f625b71245480d"><td class="mdescLeft"> </td><td class="mdescRight">Launch previously staged mode. <br /></td></tr>
|
|
<tr class="separator:aaeae4664f6b20a8a88f625b71245480d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a492b2d057dd803c3884fa1adc8e22534" id="r_a492b2d057dd803c3884fa1adc8e22534"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a492b2d057dd803c3884fa1adc8e22534">transmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a492b2d057dd803c3884fa1adc8e22534"><td class="mdescLeft"> </td><td class="mdescRight">C-string transmit method. <br /></td></tr>
|
|
<tr class="separator:a492b2d057dd803c3884fa1adc8e22534"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ada508497ee2e70170da3afe078e2fe0e" id="r_ada508497ee2e70170da3afe078e2fe0e"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ada508497ee2e70170da3afe078e2fe0e">transmit</a> (const uint8_t *data, size_t len, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:ada508497ee2e70170da3afe078e2fe0e"><td class="mdescLeft"> </td><td class="mdescRight">Binary transmit method. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:ada508497ee2e70170da3afe078e2fe0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab82617fa3fa9f21d4cd427314ecc4af8" id="r_ab82617fa3fa9f21d4cd427314ecc4af8"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ab82617fa3fa9f21d4cd427314ecc4af8">receive</a> (uint8_t *data, size_t len)</td></tr>
|
|
<tr class="memdesc:ab82617fa3fa9f21d4cd427314ecc4af8"><td class="mdescLeft"> </td><td class="mdescRight">Binary receive method. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:ab82617fa3fa9f21d4cd427314ecc4af8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a923654706eff5118ef6e84214e837f27" id="r_a923654706eff5118ef6e84214e837f27"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a923654706eff5118ef6e84214e837f27">startTransmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a923654706eff5118ef6e84214e837f27"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. <br /></td></tr>
|
|
<tr class="separator:a923654706eff5118ef6e84214e837f27"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af79757dbbd62e080c1bad2e608ab940c" id="r_af79757dbbd62e080c1bad2e608ab940c"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#af79757dbbd62e080c1bad2e608ab940c">startTransmit</a> (const uint8_t *data, size_t len, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:af79757dbbd62e080c1bad2e608ab940c"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven binary transmit method. <br /></td></tr>
|
|
<tr class="separator:af79757dbbd62e080c1bad2e608ab940c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a18664ad615c5507ff1690baaca90b094" id="r_a18664ad615c5507ff1690baaca90b094"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a18664ad615c5507ff1690baaca90b094">startReceive</a> ()</td></tr>
|
|
<tr class="memdesc:a18664ad615c5507ff1690baaca90b094"><td class="mdescLeft"> </td><td class="mdescRight">Sets module to received mode using its default configuration. <br /></td></tr>
|
|
<tr class="separator:a18664ad615c5507ff1690baaca90b094"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae93500dfbcfd39837e04c0f3eaa40d97" id="r_ae93500dfbcfd39837e04c0f3eaa40d97"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#ae93500dfbcfd39837e04c0f3eaa40d97">startReceive</a> (uint32_t timeout, <a class="el" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> irqFlags=RADIOLIB_IRQ_RX_DEFAULT_FLAGS, <a class="el" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> irqMask=RADIOLIB_IRQ_RX_DEFAULT_MASK, size_t len=0)</td></tr>
|
|
<tr class="memdesc:ae93500dfbcfd39837e04c0f3eaa40d97"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven receive method. A DIO pin will be activated when full packet is received. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:ae93500dfbcfd39837e04c0f3eaa40d97"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3563453988a83d22dd07d4691543a300" id="r_a3563453988a83d22dd07d4691543a300"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r11x0.html#a3563453988a83d22dd07d4691543a300">readData</a> (uint8_t *data, size_t len)</td></tr>
|
|
<tr class="memdesc:a3563453988a83d22dd07d4691543a300"><td class="mdescLeft"> </td><td class="mdescRight">Reads data that was received after calling startReceive method. <br /></td></tr>
|
|
<tr class="separator:a3563453988a83d22dd07d4691543a300"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="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:afc972a84153977d6ccd9e116b6181ad4 inherit pub_methods_class_physical_layer" id="r_afc972a84153977d6ccd9e116b6181ad4"><td class="memItemLeft" align="right" valign="top">
|
|
 </td><td class="memItemRight" valign="bottom"><b>PhysicalLayer</b> ()</td></tr>
|
|
<tr class="memdesc:afc972a84153977d6ccd9e116b6181ad4 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:afc972a84153977d6ccd9e116b6181ad4 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_physical_layer" id="r_a492b2d057dd803c3884fa1adc8e22534"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">transmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">C-string transmit method. <br /></td></tr>
|
|
<tr class="separator:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d5da4311092e3df6b193ff303a0c5e8 inherit pub_methods_class_physical_layer" id="r_a7d5da4311092e3df6b193ff303a0c5e8"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a7d5da4311092e3df6b193ff303a0c5e8">standby</a> (uint8_t mode)</td></tr>
|
|
<tr class="memdesc:a7d5da4311092e3df6b193ff303a0c5e8 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Sets module to a specific standby mode. <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" id="r_a923654706eff5118ef6e84214e837f27"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">startTransmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a923654706eff5118ef6e84214e837f27 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. <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" id="r_a8a194b0fbb66b1a953288bf3b9478d6e"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a8a194b0fbb66b1a953288bf3b9478d6e">setFrequency</a> (float freq)</td></tr>
|
|
<tr class="memdesc:a8a194b0fbb66b1a953288bf3b9478d6e inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Sets carrier frequency. Must be implemented in module class. <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" id="r_ad2286dc78dbf8e3084f38e9159b99ae5"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ad2286dc78dbf8e3084f38e9159b99ae5">setOutputPower</a> (int8_t power)</td></tr>
|
|
<tr class="memdesc:ad2286dc78dbf8e3084f38e9159b99ae5 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. <br /></td></tr>
|
|
<tr class="separator:ad2286dc78dbf8e3084f38e9159b99ae5 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1784cb227d04b3f2846625fda6797536 inherit pub_methods_class_physical_layer" id="r_a1784cb227d04b3f2846625fda6797536"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a1784cb227d04b3f2846625fda6797536">checkOutputPower</a> (int8_t power, int8_t *clipped)</td></tr>
|
|
<tr class="memdesc:a1784cb227d04b3f2846625fda6797536 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Check if output power is configurable. Must be implemented in module class if the module supports it. <br /></td></tr>
|
|
<tr class="separator:a1784cb227d04b3f2846625fda6797536 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae602ebd46d60da8670c9f353cef695d9 inherit pub_methods_class_physical_layer" id="r_ae602ebd46d60da8670c9f353cef695d9"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ae602ebd46d60da8670c9f353cef695d9">getIrqMapped</a> (<a class="el" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> irq)</td></tr>
|
|
<tr class="memdesc:ae602ebd46d60da8670c9f353cef695d9 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Convert from radio-agnostic IRQ flags to radio-specific flags. <br /></td></tr>
|
|
<tr class="separator:ae602ebd46d60da8670c9f353cef695d9 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c7dd4704e3df353265010710bd26e83 inherit pub_methods_class_physical_layer" id="r_a2c7dd4704e3df353265010710bd26e83"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a2c7dd4704e3df353265010710bd26e83">checkIrq</a> (RadioLibIrqType_t irq)</td></tr>
|
|
<tr class="memdesc:a2c7dd4704e3df353265010710bd26e83 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Check whether a specific IRQ bit is set (e.g. RxTimeout, CadDone). <br /></td></tr>
|
|
<tr class="separator:a2c7dd4704e3df353265010710bd26e83 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8564f9834a0247e93e7620c23559ceb8 inherit pub_methods_class_physical_layer" id="r_a8564f9834a0247e93e7620c23559ceb8"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a8564f9834a0247e93e7620c23559ceb8">setIrq</a> (<a class="el" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> irq)</td></tr>
|
|
<tr class="memdesc:a8564f9834a0247e93e7620c23559ceb8 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt on specific IRQ bit(s) (e.g. RxTimeout, CadDone). Keep in mind that not all radio modules support all RADIOLIB_IRQ_ flags! <br /></td></tr>
|
|
<tr class="separator:a8564f9834a0247e93e7620c23559ceb8 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af9a7e739e39705a72ffa8b63ec09bb15 inherit pub_methods_class_physical_layer" id="r_af9a7e739e39705a72ffa8b63ec09bb15"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#af9a7e739e39705a72ffa8b63ec09bb15">clearIrq</a> (<a class="el" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> irq)</td></tr>
|
|
<tr class="memdesc:af9a7e739e39705a72ffa8b63ec09bb15 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone). Keep in mind that not all radio modules support all RADIOLIB_IRQ_ flags! <br /></td></tr>
|
|
<tr class="separator:af9a7e739e39705a72ffa8b63ec09bb15 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd9171bd71aa80fb86113b612c42de53 inherit pub_methods_class_physical_layer" id="r_acd9171bd71aa80fb86113b612c42de53"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">random</a> (int32_t max)</td></tr>
|
|
<tr class="memdesc:acd9171bd71aa80fb86113b612c42de53 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get truly random number in range 0 - max. <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" id="r_a76113e10481743094a1cd0280692b0a9"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a76113e10481743094a1cd0280692b0a9">random</a> (int32_t min, int32_t max)</td></tr>
|
|
<tr class="memdesc:a76113e10481743094a1cd0280692b0a9 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get truly random number in range min - max. <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" id="r_a88a10657bd2215a11a2331f937414b55"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a88a10657bd2215a11a2331f937414b55">startDirect</a> ()</td></tr>
|
|
<tr class="memdesc:a88a10657bd2215a11a2331f937414b55 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. <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" id="r_a8e378fe136a498ea485a9c10f5e15aab"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a8e378fe136a498ea485a9c10f5e15aab">setDirectSyncWord</a> (uint32_t syncWord, uint8_t len)</td></tr>
|
|
<tr class="memdesc:a8e378fe136a498ea485a9c10f5e15aab 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. <br /></td></tr>
|
|
<tr class="separator:a8e378fe136a498ea485a9c10f5e15aab inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf96cf4f3cb4c82d44be581dbe615966 inherit pub_methods_class_physical_layer" id="r_abf96cf4f3cb4c82d44be581dbe615966"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#abf96cf4f3cb4c82d44be581dbe615966">setDirectAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:abf96cf4f3cb4c82d44be581dbe615966 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt service routine function to call when data bit is received in direct mode. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:abf96cf4f3cb4c82d44be581dbe615966 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acda61fc99cfa373153c50c78380ed885 inherit pub_methods_class_physical_layer" id="r_acda61fc99cfa373153c50c78380ed885"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#acda61fc99cfa373153c50c78380ed885">readBit</a> (uint32_t pin)</td></tr>
|
|
<tr class="memdesc:acda61fc99cfa373153c50c78380ed885 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Function to read and process data bit in direct reception mode. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:acda61fc99cfa373153c50c78380ed885 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab57182d32646861ef0d865e2740d6b26 inherit pub_methods_class_physical_layer" id="r_ab57182d32646861ef0d865e2740d6b26"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ab57182d32646861ef0d865e2740d6b26">available</a> ()</td></tr>
|
|
<tr class="memdesc:ab57182d32646861ef0d865e2740d6b26 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of direct mode bytes currently available in buffer. <br /></td></tr>
|
|
<tr class="separator:ab57182d32646861ef0d865e2740d6b26 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a429796eb2e7ea86781a2e8ca42af43f3 inherit pub_methods_class_physical_layer" id="r_a429796eb2e7ea86781a2e8ca42af43f3"><td class="memItemLeft" align="right" valign="top">
|
|
void </td><td class="memItemRight" valign="bottom"><b>dropSync</b> ()</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" id="r_a4d5b30493c8d7fcfb784e128362d596c"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a4d5b30493c8d7fcfb784e128362d596c">read</a> (bool drop=true)</td></tr>
|
|
<tr class="memdesc:a4d5b30493c8d7fcfb784e128362d596c inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get data from direct mode buffer. <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" id="r_a349e8a22cd28ad89d45460fdeeefc05c"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a349e8a22cd28ad89d45460fdeeefc05c">setDIOMapping</a> (uint32_t pin, uint32_t value)</td></tr>
|
|
<tr class="memdesc:a349e8a22cd28ad89d45460fdeeefc05c 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). <br /></td></tr>
|
|
<tr class="separator:a349e8a22cd28ad89d45460fdeeefc05c inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae11c191a7edf3116bf468b9153237260 inherit pub_methods_class_physical_layer" id="r_ae11c191a7edf3116bf468b9153237260"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ae11c191a7edf3116bf468b9153237260">setChannelScanAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:ae11c191a7edf3116bf468b9153237260 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a channel scan is finished. <br /></td></tr>
|
|
<tr class="separator:ae11c191a7edf3116bf468b9153237260 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a169a4d04c5c50d3336e274d70930d9f6 inherit pub_methods_class_physical_layer" id="r_a169a4d04c5c50d3336e274d70930d9f6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a169a4d04c5c50d3336e274d70930d9f6">clearChannelScanAction</a> ()</td></tr>
|
|
<tr class="memdesc:a169a4d04c5c50d3336e274d70930d9f6 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a channel scan is finished. <br /></td></tr>
|
|
<tr class="separator:a169a4d04c5c50d3336e274d70930d9f6 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a77415bf4ed34be18c92c0cf4b2de7149 inherit pub_methods_class_physical_layer" id="r_a77415bf4ed34be18c92c0cf4b2de7149"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a77415bf4ed34be18c92c0cf4b2de7149">setModem</a> (ModemType_t modem)</td></tr>
|
|
<tr class="memdesc:a77415bf4ed34be18c92c0cf4b2de7149 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Set modem for the radio to use. Will perform full reset and reconfigure the radio using its default parameters. <br /></td></tr>
|
|
<tr class="separator:a77415bf4ed34be18c92c0cf4b2de7149 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 id="pub-attribs" name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a3ccfd35d26960457214d2a0192d6b312" id="r_a3ccfd35d26960457214d2a0192d6b312"><td class="memItemLeft" align="right" valign="top"><a id="a3ccfd35d26960457214d2a0192d6b312" name="a3ccfd35d26960457214d2a0192d6b312"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>XTAL</b></td></tr>
|
|
<tr class="memdesc:a3ccfd35d26960457214d2a0192d6b312"><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:a3ccfd35d26960457214d2a0192d6b312"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_attribs_class_physical_layer"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_class_physical_layer')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="class_physical_layer.html">PhysicalLayer</a></td></tr>
|
|
<tr class="memitem:aa949616080a463a82bb6ad5075a9e16e inherit pub_attribs_class_physical_layer" id="r_aa949616080a463a82bb6ad5075a9e16e"><td class="memItemLeft" align="right" valign="top">
|
|
float </td><td class="memItemRight" valign="bottom"><b>freqStep</b></td></tr>
|
|
<tr class="memdesc:aa949616080a463a82bb6ad5075a9e16e inherit pub_attribs_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Frequency step of the synthesizer in Hz. <br /></td></tr>
|
|
<tr class="separator:aa949616080a463a82bb6ad5075a9e16e inherit pub_attribs_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1c04f8fba5eef96e59972004e8abc623 inherit pub_attribs_class_physical_layer" id="r_a1c04f8fba5eef96e59972004e8abc623"><td class="memItemLeft" align="right" valign="top">
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>maxPacketLength</b></td></tr>
|
|
<tr class="memdesc:a1c04f8fba5eef96e59972004e8abc623 inherit pub_attribs_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Maximum length of packet that can be received by the module. <br /></td></tr>
|
|
<tr class="separator:a1c04f8fba5eef96e59972004e8abc623 inherit pub_attribs_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Base class for LR11x0 series. All derived classes for LR11x0 (e.g. <a class="el" href="class_l_r1110.html" title="Derived class for LR1110 modules.">LR1110</a> or <a class="el" href="class_l_r1120.html" title="Derived class for LR1120 modules.">LR1120</a>) inherit from this base class. This class should not be instantiated directly from user code, only from its derived classes. </p>
|
|
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
|
|
<a id="a2985d66f47882ab46291a4d89f686ca7" name="a2985d66f47882ab46291a4d89f686ca7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2985d66f47882ab46291a4d89f686ca7">◆ </a></span>OpMode_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="class_l_r11x0.html#a2985d66f47882ab46291a4d89f686ca7">LR11x0::OpMode_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Custom operation modes for <a class="el" href="class_l_r11x0.html" title="Base class for LR11x0 series. All derived classes for LR11x0 (e.g. LR1110 or LR1120) inherit from thi...">LR11x0</a>. Needed because <a class="el" href="class_l_r11x0.html" title="Base class for LR11x0 series. All derived classes for LR11x0 (e.g. LR1110 or LR1120) inherit from thi...">LR11x0</a> has several modems (sub-GHz, 2.4 GHz etc.) in one package. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a2985d66f47882ab46291a4d89f686ca7a2398f9003962c8dc6d199e69ba850917" name="a2985d66f47882ab46291a4d89f686ca7a2398f9003962c8dc6d199e69ba850917"></a>MODE_END_OF_TABLE </td><td class="fielddoc"><p>End of table marker, use END_OF_MODE_TABLE constant instead </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a2985d66f47882ab46291a4d89f686ca7ab223e6d6104d722d61e1d2aa22231012" name="a2985d66f47882ab46291a4d89f686ca7ab223e6d6104d722d61e1d2aa22231012"></a>MODE_STBY </td><td class="fielddoc"><p>Standby/idle mode </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a2985d66f47882ab46291a4d89f686ca7a98f8232e13745eec261cd755c457c034" name="a2985d66f47882ab46291a4d89f686ca7a98f8232e13745eec261cd755c457c034"></a>MODE_RX </td><td class="fielddoc"><p>Receive mode </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a2985d66f47882ab46291a4d89f686ca7a71c6230a03a213d3e19185691c6db551" name="a2985d66f47882ab46291a4d89f686ca7a71c6230a03a213d3e19185691c6db551"></a>MODE_TX </td><td class="fielddoc"><p>Low power transmission mode </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a2985d66f47882ab46291a4d89f686ca7a005b9c110df839cd001f82f4660762fd" name="a2985d66f47882ab46291a4d89f686ca7a005b9c110df839cd001f82f4660762fd"></a>MODE_TX_HP </td><td class="fielddoc"><p>High power transmission mode </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a2985d66f47882ab46291a4d89f686ca7acbbc5768e10e22bfdf776faffbfced46" name="a2985d66f47882ab46291a4d89f686ca7acbbc5768e10e22bfdf776faffbfced46"></a>MODE_TX_HF </td><td class="fielddoc"><p>High frequency transmission mode </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a2985d66f47882ab46291a4d89f686ca7a5f126b8030f06bb14b1659ccce645bad" name="a2985d66f47882ab46291a4d89f686ca7a5f126b8030f06bb14b1659ccce645bad"></a>MODE_GNSS </td><td class="fielddoc"><p>GNSS scanning mode </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a2985d66f47882ab46291a4d89f686ca7a3bee9db01eab3ac70ff178c95fe8f8ab" name="a2985d66f47882ab46291a4d89f686ca7a3bee9db01eab3ac70ff178c95fe8f8ab"></a>MODE_WIFI </td><td class="fielddoc"><p>WiFi scanning mode </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a562f34a054e3374b812556df3b6eb421" name="a562f34a054e3374b812556df3b6eb421"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a562f34a054e3374b812556df3b6eb421">◆ </a></span>LR11x0()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LR11x0::LR11x0 </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>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </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="aa9a8db401189ba0ce5117512b5db6a58" name="aa9a8db401189ba0ce5117512b5db6a58"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa9a8db401189ba0ce5117512b5db6a58">◆ </a></span>autoLDRO()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::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="aa2b69f68ff6171b11a1141c8615240fd" name="aa2b69f68ff6171b11a1141c8615240fd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa2b69f68ff6171b11a1141c8615240fd">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>bw</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>sf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></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>high</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">bw</td><td>LoRa bandwidth in kHz. </td></tr>
|
|
<tr><td class="paramname">sf</td><td>LoRa spreading factor. </td></tr>
|
|
<tr><td class="paramname">cr</td><td>LoRa coding rate denominator. </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 </td></tr>
|
|
<tr><td class="paramname">tcxoVoltage</td><td>TCXO reference voltage to be set. </td></tr>
|
|
<tr><td class="paramname">high</td><td>defaults to false for Sub-GHz band, true for frequencies above 1GHz </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="abcc4c776d1a09bb002226ac95574766d" name="abcc4c776d1a09bb002226ac95574766d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abcc4c776d1a09bb002226ac95574766d">◆ </a></span>beginGFSK()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::beginGFSK </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></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. </td></tr>
|
|
<tr><td class="paramname">freqDev</td><td>Frequency deviation from carrier frequency in kHz. </td></tr>
|
|
<tr><td class="paramname">rxBw</td><td>Receiver bandwidth in kHz. </td></tr>
|
|
<tr><td class="paramname">preambleLength</td><td>FSK preamble length in bits. </td></tr>
|
|
<tr><td class="paramname">tcxoVoltage</td><td>TCXO reference voltage 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="ad7f31060cbab41ad53ee6fa7126cd17b" name="ad7f31060cbab41ad53ee6fa7126cd17b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad7f31060cbab41ad53ee6fa7126cd17b">◆ </a></span>beginGNSS()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::beginGNSS </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>constellations</em> = <code>RADIOLIB_LR11X0_GNSS_CONSTELLATION_GPS | RADIOLIB_LR11X0_GNSS_CONSTELLATION_BEIDOU</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>tcxoVoltage</em> = <code>1.6</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialization method for GNSS scanning. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">constellations</td><td>GNSS constellations to use (GPS, BeiDou or both). Defaults to both. </td></tr>
|
|
<tr><td class="paramname">tcxoVoltage</td><td>TCXO reference voltage 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="a244ee48075d44c7064b454eb9c4afdb8" name="a244ee48075d44c7064b454eb9c4afdb8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a244ee48075d44c7064b454eb9c4afdb8">◆ </a></span>beginLRFHSS()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::beginLRFHSS </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>bw</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></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">bool </td>
|
|
<td class="paramname"><em>narrowGrid</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></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialization method for LR-FHSS modem. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">bw</td><td>LR-FHSS bandwidth, one of RADIOLIB_LR11X0_LR_FHSS_BW_* values. </td></tr>
|
|
<tr><td class="paramname">cr</td><td>LR-FHSS coding rate, one of RADIOLIB_LR11X0_LR_FHSS_CR_* values. </td></tr>
|
|
<tr><td class="paramname">narrowGrid</td><td>Whether to use narrow (3.9 kHz) or wide (25.39 kHz) grid spacing. </td></tr>
|
|
<tr><td class="paramname">tcxoVoltage</td><td>TCXO reference voltage 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="a260c7f4ee4739e532ddb465a276205d3" name="a260c7f4ee4739e532ddb465a276205d3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a260c7f4ee4739e532ddb465a276205d3">◆ </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> LR11x0::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">override</span><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="adc8fbcfff7cd3b801dcee22e87bc2598" name="adc8fbcfff7cd3b801dcee22e87bc2598"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adc8fbcfff7cd3b801dcee22e87bc2598">◆ </a></span>calibrateImageRejection()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::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="a4d18ad719be79c083f2b0ce77bbaa448" name="a4d18ad719be79c083f2b0ce77bbaa448"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d18ad719be79c083f2b0ce77bbaa448">◆ </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 LR11x0::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 (GFSK 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="aa524b0be7b8d125c24319072d6178e74" name="aa524b0be7b8d125c24319072d6178e74"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa524b0be7b8d125c24319072d6178e74">◆ </a></span>clearIrqFlags()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::clearIrqFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>irq</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">irq</td><td>Module-specific IRQ flags. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#ac282bb78da4f4da4661dce191cbd6d87">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a96e4a220bbd3487423acfd217b479fe3" name="a96e4a220bbd3487423acfd217b479fe3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a96e4a220bbd3487423acfd217b479fe3">◆ </a></span>clearPacketReceivedAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LR11x0::clearPacketReceivedAction </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clears interrupt service routine to call when a packet is received. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a7edf27f03600b96f72f011fc82fa4ef9">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a95ddec84ae2fb19989c333d42d4dc5fa" name="a95ddec84ae2fb19989c333d42d4dc5fa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a95ddec84ae2fb19989c333d42d4dc5fa">◆ </a></span>clearPacketSentAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LR11x0::clearPacketSentAction </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clears interrupt service routine to call when a packet is sent. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a67ee4ec36f352d06dda0102260f6bfce">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae565dc2423ca7df13bf7ae48cce9ac8b" name="ae565dc2423ca7df13bf7ae48cce9ac8b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae565dc2423ca7df13bf7ae48cce9ac8b">◆ </a></span>disableAddressFiltering()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::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="a3693359e5d106d6f57c23247c528cdd5" name="a3693359e5d106d6f57c23247c528cdd5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3693359e5d106d6f57c23247c528cdd5">◆ </a></span>explicitHeader()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::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="aaff9a5b9b7636693c98bd1c93a5863e5" name="aaff9a5b9b7636693c98bd1c93a5863e5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaff9a5b9b7636693c98bd1c93a5863e5">◆ </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 LR11x0::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="a5df4c1ed45bf59aa25bc400bcb5dc1ba" name="a5df4c1ed45bf59aa25bc400bcb5dc1ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5df4c1ed45bf59aa25bc400bcb5dc1ba">◆ </a></span>fixedPacketLengthMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::fixedPacketLengthMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>len</em> = <code>RADIOLIB_LR11X0_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 GFSK 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="ae0a47e772fe24c7b3f3d3288c4cd0941" name="ae0a47e772fe24c7b3f3d3288c4cd0941"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae0a47e772fe24c7b3f3d3288c4cd0941">◆ </a></span>forceLDRO()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::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_l_r11x0.html#aa9a8db401189ba0ce5117512b5db6a58" title="Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...">LR11x0::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="a1ae2cddeb7671d9b71e9c83bf020820f" name="a1ae2cddeb7671d9b71e9c83bf020820f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1ae2cddeb7671d9b71e9c83bf020820f">◆ </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 LR11x0::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="a1ec81f3625fdc8a3ef6c54a3804c3aa9" name="a1ec81f3625fdc8a3ef6c54a3804c3aa9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1ec81f3625fdc8a3ef6c54a3804c3aa9">◆ </a></span>getDataRate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float LR11x0::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="ad9046bccdb4ef60718e2e8ed2bd7f036" name="ad9046bccdb4ef60718e2e8ed2bd7f036"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad9046bccdb4ef60718e2e8ed2bd7f036">◆ </a></span>getFrequencyError()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float LR11x0::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. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Frequency error in Hz. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a748d30cb7a0b419066f6361a966b306f" name="a748d30cb7a0b419066f6361a966b306f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a748d30cb7a0b419066f6361a966b306f">◆ </a></span>getGnssAlmanacStatus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::getGnssAlmanacStatus </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_l_r11x0_gnss_almanac_status__t.html">LR11x0GnssAlmanacStatus_t</a> * </td>
|
|
<td class="paramname"><em>stat</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read information about the almanac. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">stat</td><td>Pointer to structure to save the almanac status into. This is not the actual almanac, just a structure providing information about it. </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="a19a4b4a138dbd0e5c8f980de0f6419e4" name="a19a4b4a138dbd0e5c8f980de0f6419e4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a19a4b4a138dbd0e5c8f980de0f6419e4">◆ </a></span>getGnssPosition()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::getGnssPosition </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_l_r11x0_gnss_position__t.html">LR11x0GnssPosition_t</a> * </td>
|
|
<td class="paramname"><em>pos</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>filtered</em> = <code>true</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get GNSS position. Called after gnssScan to retrieve the position calculated by the internal solver. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pos</td><td>Pointer to <a class="el" href="struct_l_r11x0_gnss_position__t.html" title="Structure to report position from LR11x0 internal solver.">LR11x0GnssPosition_t</a> structure to populate. </td></tr>
|
|
<tr><td class="paramname">filtered</td><td>Whether to save the filtered, or unfiltered values. Defaults to true (filtered). </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="a97a3f23b796257135a9afd33c28e8ed5" name="a97a3f23b796257135a9afd33c28e8ed5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a97a3f23b796257135a9afd33c28e8ed5">◆ </a></span>getGnssSatellites()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::getGnssSatellites </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_l_r11x0_gnss_satellite__t.html">LR11x0GnssSatellite_t</a> * </td>
|
|
<td class="paramname"><em>sats</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>numSats</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get GNSS satellites found during the last scan. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sats</td><td>Pointer to array of <a class="el" href="struct_l_r11x0_gnss_satellite__t.html" title="Structure to save information about a satellite found during GNSS scan.">LR11x0GnssSatellite_t</a> structures to populate. </td></tr>
|
|
<tr><td class="paramname">numSats</td><td>Number of satellites to read. Can be retrieved from <a class="el" href="struct_l_r11x0_gnss_result__t.html" title="Structure to report information results of a GNSS scan.">LR11x0GnssResult_t</a> passed to gnssScan. </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="a205364e65d54f3f87b9b8f5972cdcb99" name="a205364e65d54f3f87b9b8f5972cdcb99"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a205364e65d54f3f87b9b8f5972cdcb99">◆ </a></span>getIrqFlags()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t LR11x0::getIrqFlags </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read currently active IRQ flags. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>IRQ flags. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#af1caeed34b2e2ff0355467507106a1a2">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0309154558a0d88e2e8957e4dbf6a2f8" name="a0309154558a0d88e2e8957e4dbf6a2f8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0309154558a0d88e2e8957e4dbf6a2f8">◆ </a></span>getIrqStatus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t LR11x0::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="afe8684b336a8137cde591283297a869c" name="afe8684b336a8137cde591283297a869c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afe8684b336a8137cde591283297a869c">◆ </a></span>getModem()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::getModem </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ModemType_t * </td>
|
|
<td class="paramname"><em>modem</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get modem currently in use by the radio. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">modem</td><td>Pointer to a variable to save the retrieved configuration into. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#af061879bf694735297593c048d04a196">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af96883b2ca7a36a8921ee1cd222adebf" name="af96883b2ca7a36a8921ee1cd222adebf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af96883b2ca7a36a8921ee1cd222adebf">◆ </a></span>getPacketLength() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t LR11x0::getPacketLength </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>update</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>offset</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac1f541bdee1d983126ceae47940b8f9d" name="ac1f541bdee1d983126ceae47940b8f9d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac1f541bdee1d983126ceae47940b8f9d">◆ </a></span>getPacketLength() <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">size_t LR11x0::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="a6cd2b2363501b2de064c9d1f32fabaa3" name="a6cd2b2363501b2de064c9d1f32fabaa3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6cd2b2363501b2de064c9d1f32fabaa3">◆ </a></span>getRSSI()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float LR11x0::getRSSI </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. Only available for LoRa or GFSK modem. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>RSSI of the last received packet in dBm. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#aabc94ab27a9ee6daaafa9b47dde5f75b">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a004782e6e5c6ad213c3b0c677bb8642d" name="a004782e6e5c6ad213c3b0c677bb8642d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a004782e6e5c6ad213c3b0c677bb8642d">◆ </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 LR11x0::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">override</span><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="abccf5dc80aab71090a5f19bfffa0201d" name="abccf5dc80aab71090a5f19bfffa0201d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abccf5dc80aab71090a5f19bfffa0201d">◆ </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> LR11x0::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>
|
|
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>implement this mess - <a class="el" href="class_s_x1280.html" title="Derived class for SX1280 modules.">SX1280</a> datasheet v3.0 section 7.4.4.2 </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a50e730a894f60b58034507ad7730dd3c">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac6b6b460ba12cd92a08df16e1fe33779" name="ac6b6b460ba12cd92a08df16e1fe33779"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac6b6b460ba12cd92a08df16e1fe33779">◆ </a></span>getVersionInfo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::getVersionInfo </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_l_r11x0_version_info__t.html">LR11x0VersionInfo_t</a> * </td>
|
|
<td class="paramname"><em>info</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieve <a class="el" href="class_l_r11x0.html" title="Base class for LR11x0 series. All derived classes for LR11x0 (e.g. LR1110 or LR1120) inherit from thi...">LR11x0</a> hardware, device and firmware version information. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">info</td><td>Pointer to <a class="el" href="struct_l_r11x0_version_info__t.html" title="Structure to report information about versions of the LR11x0 hardware and firmware.">LR11x0VersionInfo_t</a> structure to populate. </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="a457f5dfe25385a329127f07abc4631a6" name="a457f5dfe25385a329127f07abc4631a6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a457f5dfe25385a329127f07abc4631a6">◆ </a></span>getWifiScanResult()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::getWifiScanResult </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_l_r11x0_wifi_result__t.html">LR11x0WifiResult_t</a> * </td>
|
|
<td class="paramname"><em>result</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>index</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>brief</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieve passive WiFi scan result. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">result</td><td>Pointer to structure to hold the result data. </td></tr>
|
|
<tr><td class="paramname">index</td><td>Result index, starting from 0. The number of scan results can be retrieved by calling getWifiScanResultsCount. </td></tr>
|
|
<tr><td class="paramname">brief</td><td>Whether to only retrieve the results in brief format. If set to false, only information in <a class="el" href="struct_l_r11x0_wifi_result__t.html" title="Structure to save result of passive WiFi scan. This result only saves the basic information.">LR11x0WifiResult_t</a> will be retrieved. If set to true, information in <a class="el" href="struct_l_r11x0_wifi_result_full__t.html" title="Structure to save result of passive WiFi scan. This result saves additional information alongside tha...">LR11x0WifiResultFull_t</a> will be retrieved. In addition, if WiFi scan mode was set to RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON, all information in <a class="el" href="struct_l_r11x0_wifi_result_extended__t.html" title="Structure to save result of passive WiFi scan. This result saves additional information alongside tha...">LR11x0WifiResultExtended_t</a> will be retrieved. </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="a5ef83caa291e2d310d260a8ea140bc8e" name="a5ef83caa291e2d310d260a8ea140bc8e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5ef83caa291e2d310d260a8ea140bc8e">◆ </a></span>getWifiScanResultsCount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::getWifiScanResultsCount </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>count</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get number of WiFi scan results after the scan is finished. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">count</td><td>Pointer to a variable that will hold the number of scan results. </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="ab2dbab0fe3433e914c19a8d03fe32358" name="ab2dbab0fe3433e914c19a8d03fe32358"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab2dbab0fe3433e914c19a8d03fe32358">◆ </a></span>gnssDelayUntilSubframe()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::gnssDelayUntilSubframe </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_l_r11x0_gnss_almanac_status__t.html">LR11x0GnssAlmanacStatus_t</a> * </td>
|
|
<td class="paramname"><em>stat</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>constellation</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Blocking wait until the next subframe with almanac data is available. Used to control timing during almanac update from satellite. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">stat</td><td>Pointer to structure containing the almanac status read by getGnssAlmanacStatus. This is not the actual almanac, just a structure providing information about it. </td></tr>
|
|
<tr><td class="paramname">constellation</td><td>Constellation to wait for, one of RADIOLIB_LR11X0_GNSS_CONSTELLATION_*. Constellations cannot be updated at the same time, but rather must be updated sequentially! </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="ad9bfaf0bdd7045f5d41f18f3f953c294" name="ad9bfaf0bdd7045f5d41f18f3f953c294"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad9bfaf0bdd7045f5d41f18f3f953c294">◆ </a></span>gnssScan()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::gnssScan </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_l_r11x0_gnss_result__t.html">LR11x0GnssResult_t</a> * </td>
|
|
<td class="paramname"><em>res</em> = <code>NULL</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Performs GNSS scan. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">res</td><td>Pointer to <a class="el" href="struct_l_r11x0_gnss_position__t.html" title="Structure to report position from LR11x0 internal solver.">LR11x0GnssPosition_t</a> structure to populate. Will not be saved if set to NULL, defaults to NULL. </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="aba13921d2cf29cc1bc8a648e1f330aa9" name="aba13921d2cf29cc1bc8a648e1f330aa9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aba13921d2cf29cc1bc8a648e1f330aa9">◆ </a></span>implicitHeader()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::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="af85c16956c2250dbf338a298c074d28c" name="af85c16956c2250dbf338a298c074d28c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af85c16956c2250dbf338a298c074d28c">◆ </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 LR11x0::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="a79818dae19d69d33a5a1facbb91c3774" name="a79818dae19d69d33a5a1facbb91c3774"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a79818dae19d69d33a5a1facbb91c3774">◆ </a></span>isGnssScanCapable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::isGnssScanCapable </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to check whether the device is capable of performing a GNSS 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="aaeae4664f6b20a8a88f625b71245480d" name="aaeae4664f6b20a8a88f625b71245480d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaeae4664f6b20a8a88f625b71245480d">◆ </a></span>launchMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::launchMode </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Launch previously staged mode. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a5c5977bc9f54f21665b022a99e6c87cc">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a89b16d2231f588b67dc3aab0c0a467f4" name="a89b16d2231f588b67dc3aab0c0a467f4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a89b16d2231f588b67dc3aab0c0a467f4">◆ </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 LR11x0::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">override</span><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="a3563453988a83d22dd07d4691543a300" name="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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::readData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads data that was received after calling startReceive method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to array to save the received binary data. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes that will be read. When set to 0, the packet length will be retrieved automatically. When more bytes than received are requested, only the number of bytes requested will be returned. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a20279f1b267e936991f47fd703924833" name="a20279f1b267e936991f47fd703924833"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a20279f1b267e936991f47fd703924833">◆ </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 LR11x0::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" name="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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::receive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Binary receive method. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to array to save the received binary data. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Packet length, needed for some modules under special circumstances (e.g. LoRa implicit header mode). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a377c287f18c939c2b4da3241d8329e58" name="a377c287f18c939c2b4da3241d8329e58"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a377c287f18c939c2b4da3241d8329e58">◆ </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 LR11x0::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="ae1a8e8eda78113c47f1a865e63051bb5" name="ae1a8e8eda78113c47f1a865e63051bb5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae1a8e8eda78113c47f1a865e63051bb5">◆ </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 LR11x0::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="a288bcc309d3676bc0bbe620b7d89d994" name="a288bcc309d3676bc0bbe620b7d89d994"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a288bcc309d3676bc0bbe620b7d89d994">◆ </a></span>reset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::reset </td>
|
|
<td>(</td>
|
|
<td class="paramname"></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="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6a3034c91f5bce70c853ab1620725b3c" name="a6a3034c91f5bce70c853ab1620725b3c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6a3034c91f5bce70c853ab1620725b3c">◆ </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 LR11x0::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="a5e8f21878bdab1439805aea1e9da168d" name="a5e8f21878bdab1439805aea1e9da168d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5e8f21878bdab1439805aea1e9da168d">◆ </a></span>scanChannel() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::scanChannel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="union_channel_scan_config__t.html">ChannelScanConfig_t</a> & </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">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="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>CAD configuration structure. </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#af788cf83ceb0222cd0fa4a1323b9041b">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a70d9849eb8e5ce2090e4e332252753d7" name="a70d9849eb8e5ce2090e4e332252753d7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a70d9849eb8e5ce2090e4e332252753d7">◆ </a></span>setBandwidth()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::setBandwidth </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>bw</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>high</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets LoRa bandwidth. Allowed values are 62.5, 125.0, 250.0 and 500.0 kHz. (default, high = false) </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>
|
|
<tr><td class="paramname">high</td><td>if set to true, allowed bandwidth is 203.125, 406.25 and 812.5 kHz, frequency must be above 1GHz </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="ab1954e4733a7fbea4129d9a2de2285d9" name="ab1954e4733a7fbea4129d9a2de2285d9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab1954e4733a7fbea4129d9a2de2285d9">◆ </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 LR11x0::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">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets GFSK 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="af24ba794f71c4e37cd13d2f4dbec5bf7" name="af24ba794f71c4e37cd13d2f4dbec5bf7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af24ba794f71c4e37cd13d2f4dbec5bf7">◆ </a></span>setBroadcastAddress()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::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="a583f2d5ed601a98c609dbf0d57f2f541" name="a583f2d5ed601a98c609dbf0d57f2f541"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a583f2d5ed601a98c609dbf0d57f2f541">◆ </a></span>setCodingRate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::setCodingRate </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">bool </td>
|
|
<td class="paramname"><em>longInterleave</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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>
|
|
<tr><td class="paramname">longInterleave</td><td>Enable long interleaver when set to true. Note that CR 4/7 is not possible with long interleaver 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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a551b82787288b0b14e4d3124e6744dc3" name="a551b82787288b0b14e4d3124e6744dc3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a551b82787288b0b14e4d3124e6744dc3">◆ </a></span>setCRC()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::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">uint32_t </td>
|
|
<td class="paramname"><em>initial</em> = <code>0x00001D0FUL</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>polynomial</em> = <code>0x00001021UL</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. GFSK only. Defaults to 0x1D0F (CCIT CRC). </td></tr>
|
|
<tr><td class="paramname">polynomial</td><td>Polynomial for CRC calculation. GFSK only. Defaults to 0x1021 (CCIT CRC). </td></tr>
|
|
<tr><td class="paramname">inverted</td><td>Invert CRC bytes. GFSK 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="a056e65c58ff8fb18bd84917512790ee6" name="a056e65c58ff8fb18bd84917512790ee6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a056e65c58ff8fb18bd84917512790ee6">◆ </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 LR11x0::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 (GFSK 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="a5a33df702da3f5b010e07d5e6fac7aa6" name="a5a33df702da3f5b010e07d5e6fac7aa6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5a33df702da3f5b010e07d5e6fac7aa6">◆ </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 LR11x0::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="a8ae178a17f6e41b545b79cfffd3e2864" name="a8ae178a17f6e41b545b79cfffd3e2864"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8ae178a17f6e41b545b79cfffd3e2864">◆ </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 LR11x0::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 GFSK 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="ac003cfe3a4dbd9bad1f01fd0147031d1" name="ac003cfe3a4dbd9bad1f01fd0147031d1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac003cfe3a4dbd9bad1f01fd0147031d1">◆ </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 LR11x0::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 GFSK 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>GFSK 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="a49116d006b60128fe6f73a6a868a6d18" name="a49116d006b60128fe6f73a6a868a6d18"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a49116d006b60128fe6f73a6a868a6d18">◆ </a></span>setIrqAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LR11x0::setIrqAction </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 IRQ1 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="a62c715ab18ea8a2e08a2791d3e764ee9" name="a62c715ab18ea8a2e08a2791d3e764ee9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a62c715ab18ea8a2e08a2791d3e764ee9">◆ </a></span>setIrqFlags()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::setIrqFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>irq</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set interrupt on IRQ pin to be sent on a specific IRQ bit (e.g. RxTimeout, CadDone). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">irq</td><td>Module-specific IRQ flags. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#af88dcb54dc8e9a1edaf9f1c3e5ee2b74">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8c1def9a01021a52f5bb82c119a9ad35" name="a8c1def9a01021a52f5bb82c119a9ad35"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8c1def9a01021a52f5bb82c119a9ad35">◆ </a></span>setLrFhssConfig()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::setLrFhssConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>bw</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></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>hdrCount</em> = <code>3</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>hopSeed</em> = <code>0x13A</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets LR-FHSS configuration. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">bw</td><td>LR-FHSS bandwidth, one of RADIOLIB_LR11X0_LR_FHSS_BW_* values. </td></tr>
|
|
<tr><td class="paramname">cr</td><td>LR-FHSS coding rate, one of RADIOLIB_LR11X0_LR_FHSS_CR_* values. </td></tr>
|
|
<tr><td class="paramname">hdrCount</td><td>Header packet count, 1 - 4. Defaults to 3. </td></tr>
|
|
<tr><td class="paramname">hopSeed</td><td>9-bit seed number for PRNG generation of the hopping sequence. Defaults to 0x13A. </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="a605f5c74ce523abad256866abe133d2e" name="a605f5c74ce523abad256866abe133d2e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a605f5c74ce523abad256866abe133d2e">◆ </a></span>setNodeAddress()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::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="ac2a8ece736198c966e3870dac09f4e87" name="ac2a8ece736198c966e3870dac09f4e87"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac2a8ece736198c966e3870dac09f4e87">◆ </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 LR11x0::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">override</span><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="a92299e41f839590008b4e344776838a1" name="a92299e41f839590008b4e344776838a1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a92299e41f839590008b4e344776838a1">◆ </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 LR11x0::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">override</span><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="aa5d7ae65666f8f9abcb7e9b169884a4a" name="aa5d7ae65666f8f9abcb7e9b169884a4a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa5d7ae65666f8f9abcb7e9b169884a4a">◆ </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 LR11x0::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 GFSK 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 (GFSK). </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="a1ad485f14a333f06b642f2d60aacf76c" name="a1ad485f14a333f06b642f2d60aacf76c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1ad485f14a333f06b642f2d60aacf76c">◆ </a></span>setRegulatorDCDC()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::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="a92ae10630cc327f441809ac1406737fd" name="a92ae10630cc327f441809ac1406737fd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a92ae10630cc327f441809ac1406737fd">◆ </a></span>setRegulatorLDO()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::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="a1981f0dfceca2b6175a69530ea13d643" name="a1981f0dfceca2b6175a69530ea13d643"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1981f0dfceca2b6175a69530ea13d643">◆ </a></span>setRfSwitchTable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LR11x0::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 hl_struct" href="struct_module_1_1_rf_switch_mode__t.html">Module::RfSwitchMode_t</a> rfswitch_table[] = {</div>
|
|
<div class="line"> {<a class="code hl_enumvalue" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671">Module::MODE_IDLE</a>, {LOW, LOW}},</div>
|
|
<div class="line"> {<a class="code hl_enumvalue" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f">Module::MODE_RX</a>, {HIGH, LOW}},</div>
|
|
<div class="line"> {<a class="code hl_enumvalue" 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:119</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:113</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:116</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:89</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a25f5ee68b3c2638ae613c87ed1c3fc64" name="a25f5ee68b3c2638ae613c87ed1c3fc64"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a25f5ee68b3c2638ae613c87ed1c3fc64">◆ </a></span>setRxBandwidth()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::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 GFSK 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>GFSK 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="ab0cf34cc0b67484fbf0f258bff7e9a9a" name="ab0cf34cc0b67484fbf0f258bff7e9a9a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab0cf34cc0b67484fbf0f258bff7e9a9a">◆ </a></span>setRxBoostedGainMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::setRxBoostedGainMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>en</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enables or disables Rx Boosted Gain mode (additional Rx gain for increased power consumption). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">en</td><td>True for Rx Boosted Gain, false for Rx Power Saving Gain </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="adf6895cbf7af7e00ea06c5b2b5040cb4" name="adf6895cbf7af7e00ea06c5b2b5040cb4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adf6895cbf7af7e00ea06c5b2b5040cb4">◆ </a></span>setSpreadingFactor()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::setSpreadingFactor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>sf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>legacy</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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>
|
|
<tr><td class="paramname">legacy</td><td>Enable legacy mode for SF6 - this allows to communicate 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> at SF6. </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="a6501ef362df1a5b71927cfe4e43c202d" name="a6501ef362df1a5b71927cfe4e43c202d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6501ef362df1a5b71927cfe4e43c202d">◆ </a></span>setSyncBits()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::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 GFSK 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>GFSK sync word to be set. </td></tr>
|
|
<tr><td class="paramname">bitsLen</td><td>GFSK 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="ab8c54b1b105605ffe0908c5ff9362932" name="ab8c54b1b105605ffe0908c5ff9362932"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab8c54b1b105605ffe0908c5ff9362932">◆ </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 LR11x0::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 GFSK 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>GFSK sync word to be set. </td></tr>
|
|
<tr><td class="paramname">len</td><td>GFSK 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="aee7dbdbd76f4639395af4a0db17025a7" name="aee7dbdbd76f4639395af4a0db17025a7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aee7dbdbd76f4639395af4a0db17025a7">◆ </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 LR11x0::setSyncWord </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>syncWord</em></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>
|
|
</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="a971b4ccd1d5479e9d72aa9649e8fef55" name="a971b4ccd1d5479e9d72aa9649e8fef55"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a971b4ccd1d5479e9d72aa9649e8fef55">◆ </a></span>setTCXO()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::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="adcde55b8660c24cf5783942a4132786d" name="adcde55b8660c24cf5783942a4132786d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adcde55b8660c24cf5783942a4132786d">◆ </a></span>setWhitening()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::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 GFSK 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 GFSK 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="aff6060e116701c60e078d3d930723b4b" name="aff6060e116701c60e078d3d930723b4b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aff6060e116701c60e078d3d930723b4b">◆ </a></span>setWiFiScanAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LR11x0::setWiFiScanAction </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 a WiFi scan is completed. </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="ad5dde79f751bbd7ea277872e237f2a69" name="ad5dde79f751bbd7ea277872e237f2a69"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad5dde79f751bbd7ea277872e237f2a69">◆ </a></span>sleep() <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 LR11x0::sleep </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </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_l_r11x0.html#a74c3f3f8409f1fd0f41347b7d3c7dc24" title="Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...">standby()</a>. Overload with warm start enabled for <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a> compatibility. </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#af1bb9a5da26da8829795ebb72e9c666e">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad2786a2f17af5769c772ebc73df88e1f" name="ad2786a2f17af5769c772ebc73df88e1f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad2786a2f17af5769c772ebc73df88e1f">◆ </a></span>sleep() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::sleep </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>retainConfig</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>sleepTime</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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_l_r11x0.html#a74c3f3f8409f1fd0f41347b7d3c7dc24" 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>
|
|
<tr><td class="paramname">sleepTime</td><td>Sleep duration (enables automatic wakeup), in multiples of 30.52 us. Ignored if set to 0. </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="a66af76a767045af7ef248868ab6a6c28" name="a66af76a767045af7ef248868ab6a6c28"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a66af76a767045af7ef248868ab6a6c28">◆ </a></span>stageMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::stageMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RadioModeType_t </td>
|
|
<td class="paramname"><em>mode</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="union_radio_mode_config__t.html">RadioModeConfig_t</a> * </td>
|
|
<td class="paramname"><em>cfg</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Stage mode of the radio to be launched later using launchMode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mode</td><td>Radio mode to prepare. </td></tr>
|
|
<tr><td class="paramname">cfg</td><td>Configuration of this mode (mode-dependent). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a06fa3b844c6028a78e29b7dff58c7c79">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a74c3f3f8409f1fd0f41347b7d3c7dc24" name="a74c3f3f8409f1fd0f41347b7d3c7dc24"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a74c3f3f8409f1fd0f41347b7d3c7dc24">◆ </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 LR11x0::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="a2d682ec2ca0ddf4da41a93dd8e728665" name="a2d682ec2ca0ddf4da41a93dd8e728665"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2d682ec2ca0ddf4da41a93dd8e728665">◆ </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 LR11x0::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_LR11X0_STANDBY_RC (13 MHz RC oscillator) or RADIOLIB_LR11X0_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="a4f3bc362530b85dd643669705f03998d" name="a4f3bc362530b85dd643669705f03998d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4f3bc362530b85dd643669705f03998d">◆ </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 LR11x0::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. IRQ1 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="ab073ade3f6b9bbb383e388904812f575" name="ab073ade3f6b9bbb383e388904812f575"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab073ade3f6b9bbb383e388904812f575">◆ </a></span>startChannelScan() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::startChannelScan </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="union_channel_scan_config__t.html">ChannelScanConfig_t</a> & </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven channel activity detection method. IRQ pin 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">config</td><td>CAD configuration structure. </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#a82a52062d9259c2c546d7bf8072b7a72">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a18664ad615c5507ff1690baaca90b094" name="a18664ad615c5507ff1690baaca90b094"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a18664ad615c5507ff1690baaca90b094">◆ </a></span>startReceive() <span class="overload">[1/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 PhysicalLayer::startReceive </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets module to received mode using its default configuration. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a18664ad615c5507ff1690baaca90b094">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa6ce285cc1b76ce028db6442a421ed8d" name="aa6ce285cc1b76ce028db6442a421ed8d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa6ce285cc1b76ce028db6442a421ed8d">◆ </a></span>startReceive() <span class="overload">[2/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 LR11x0::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">override</span><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="ae93500dfbcfd39837e04c0f3eaa40d97" name="ae93500dfbcfd39837e04c0f3eaa40d97"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae93500dfbcfd39837e04c0f3eaa40d97">◆ </a></span>startReceive() <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 PhysicalLayer::startReceive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>timeout</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> </td>
|
|
<td class="paramname"><em>irqFlags</em> = <code>RADIOLIB_IRQ_RX_DEFAULT_FLAGS</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__typedefs.html#gafaf66becf1112a55ba8ad7402b802b77">RadioLibIrqFlags_t</a> </td>
|
|
<td class="paramname"><em>irqMask</em> = <code>RADIOLIB_IRQ_RX_DEFAULT_MASK</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven receive method. A DIO pin will be activated when full packet is received. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">timeout</td><td>Raw timeout value. Some modules use this argument to specify operation mode (single vs. continuous receive). </td></tr>
|
|
<tr><td class="paramname">irqFlags</td><td>Sets the IRQ flags. </td></tr>
|
|
<tr><td class="paramname">irqMask</td><td>Sets the mask of IRQ flags that will trigger the radio interrupt pin. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Packet length, needed for some modules under special circumstances (e.g. LoRa implicit header mode). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#ae93500dfbcfd39837e04c0f3eaa40d97">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a923654706eff5118ef6e84214e837f27" name="a923654706eff5118ef6e84214e837f27"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a923654706eff5118ef6e84214e837f27">◆ </a></span>startTransmit() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::startTransmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>str</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>addr</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">str</td><td>C-string that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. Only used in FSK mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af79757dbbd62e080c1bad2e608ab940c" name="af79757dbbd62e080c1bad2e608ab940c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af79757dbbd62e080c1bad2e608ab940c">◆ </a></span>startTransmit() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::startTransmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>addr</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven binary transmit method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Binary data that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of binary data to transmit (in bytes). </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. Only used in FSK mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#af79757dbbd62e080c1bad2e608ab940c">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3498e0e621f341e415145879989e0948" name="a3498e0e621f341e415145879989e0948"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3498e0e621f341e415145879989e0948">◆ </a></span>startWifiScan()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::startWifiScan </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char </td>
|
|
<td class="paramname"><em>wifiType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>mode</em> = <code>RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>chanMask</em> = <code>RADIOLIB_LR11X0_WIFI_ALL_CHANNELS</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>numScans</em> = <code>16</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>timeout</em> = <code>100</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Start passive WiFi scan. BUSY pin will be de-activated when the scan is finished. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">wifiType</td><td>Type of WiFi (802.11) signals to scan, 'b', 'n', 'g' or '*' for all signals. </td></tr>
|
|
<tr><td class="paramname">mode</td><td>Scan acquisition mode, one of RADIOLIB_LR11X0_WIFI_ACQ_MODE_*. The type of results available after the scan depends on this mode. Defaults to RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON, which provides the most information. </td></tr>
|
|
<tr><td class="paramname">chanMask</td><td>Bit mask of WiFi channels to scan, defaults to all channels. More channels leads to longer overall scan duration. </td></tr>
|
|
<tr><td class="paramname">numScans</td><td>Number of scans to perform per each enabled channel. Defaults to 16 scans. More scans leads to longer overall scan duration. </td></tr>
|
|
<tr><td class="paramname">timeout</td><td>Timeout of each scan in milliseconds. Defaults to 100 ms Longer timeout leads to longer overall scan duration. </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="a492b2d057dd803c3884fa1adc8e22534" name="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>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>str</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>addr</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>C-string transmit method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">str</td><td>C-string that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. Only used in FSK mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ada508497ee2e70170da3afe078e2fe0e" name="ada508497ee2e70170da3afe078e2fe0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ada508497ee2e70170da3afe078e2fe0e">◆ </a></span>transmit() <span class="overload">[2/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 PhysicalLayer::transmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>addr</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Binary transmit method. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Binary data that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of binary data to transmit (in bytes). </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. Only used in FSK mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#ada508497ee2e70170da3afe078e2fe0e">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a21e865665318dece7d95336a275dd973" name="a21e865665318dece7d95336a275dd973"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a21e865665318dece7d95336a275dd973">◆ </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 LR11x0::transmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>addr</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">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#ada508497ee2e70170da3afe078e2fe0e">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae077957969f6274a53f63b314b6f1359" name="ae077957969f6274a53f63b314b6f1359"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae077957969f6274a53f63b314b6f1359">◆ </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 LR11x0::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="ab2820cc2b740d6d42a079bbd8bd45b85" name="ab2820cc2b740d6d42a079bbd8bd45b85"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab2820cc2b740d6d42a079bbd8bd45b85">◆ </a></span>updateFirmware()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::updateFirmware </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint32_t * </td>
|
|
<td class="paramname"><em>image</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</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>Method to upload new firmware image to the device. The device will be automatically erased, a new firmware will be uploaded, written to flash and executed. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">image</td><td>Pointer to the image to upload. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Size of the image in 32-bit words. </td></tr>
|
|
<tr><td class="paramname">nonvolatile</td><td>Set to true when the image is saved in non-volatile memory of the host processor, or to false when the patch is in its RAM. 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="a96aa9566399e46fc03f2b73b44058e3f" name="a96aa9566399e46fc03f2b73b44058e3f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a96aa9566399e46fc03f2b73b44058e3f">◆ </a></span>updateGnssAlmanac()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::updateGnssAlmanac </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>constellation</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Perform almanac update. Must be called immediately after gnssDelayUntilSubframe. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">constellation</td><td>Constellation to update, one of RADIOLIB_LR11X0_GNSS_CONSTELLATION_*. Constellations cannot be updated at the same time, but rather must be updated sequentially! </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="adcd56cf63e91449b6cd03782a69c3451" name="adcd56cf63e91449b6cd03782a69c3451"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adcd56cf63e91449b6cd03782a69c3451">◆ </a></span>variablePacketLengthMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::variablePacketLengthMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>maxLen</em> = <code>RADIOLIB_LR11X0_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 GFSK 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>
|
|
<a id="ade5478296ebc7e02281c95609d5d75ab" name="ade5478296ebc7e02281c95609d5d75ab"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ade5478296ebc7e02281c95609d5d75ab">◆ </a></span>wifiScan()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LR11x0::wifiScan </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>wifiType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>count</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>mode</em> = <code>RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>chanMask</em> = <code>RADIOLIB_LR11X0_WIFI_ALL_CHANNELS</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>numScans</em> = <code>16</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>timeout</em> = <code>100</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Blocking WiFi scan method. Performs a full passive WiFi scan. This method may block for several seconds! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">wifiType</td><td>Type of WiFi (802.11) signals to scan, 'b', 'n', 'g' or '*' for all signals. </td></tr>
|
|
<tr><td class="paramname">count</td><td>Pointer to a variable that will hold the number of scan results. </td></tr>
|
|
<tr><td class="paramname">mode</td><td>Scan acquisition mode, one of RADIOLIB_LR11X0_WIFI_ACQ_MODE_*. The type of results available after the scan depends on this mode. Defaults to RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON, which provides the most information. </td></tr>
|
|
<tr><td class="paramname">chanMask</td><td>Bit mask of WiFi channels to scan, defaults to all channels. More channels leads to longer overall scan duration. </td></tr>
|
|
<tr><td class="paramname">numScans</td><td>Number of scans to perform per each enabled channel. Defaults to 16 scans. More scans leads to longer overall scan duration. </td></tr>
|
|
<tr><td class="paramname">timeout</td><td>Timeout of each scan in milliseconds. Defaults to 100 ms Longer timeout leads to longer overall scan duration. </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/LR11x0/<a class="el" href="_l_r11x0_8h_source.html">LR11x0.h</a></li>
|
|
<li>src/modules/LR11x0/<b>LR11x0.cpp</b></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="class_l_r11x0.html">LR11x0</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|