849 lines
127 KiB
HTML
849 lines
127 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: SX1273 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_s_x1273.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_s_x1273-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">SX1273 Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Derived class for SX1273 modules. Overrides some methods from <a class="el" href="class_s_x1272.html" title="Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic...">SX1272</a> due to different parameter ranges.
|
|
<a href="class_s_x1273.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_s_x1273_8h_source.html">SX1273.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for SX1273:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_s_x1273.png" usemap="#SX1273_map" alt=""/>
|
|
<map id="SX1273_map" name="SX1273_map">
|
|
<area href="class_s_x1272.html" title="Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic..." alt="SX1272" shape="rect" coords="0,112,93,136"/>
|
|
<area href="class_s_x127x.html" title="Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from thi..." alt="SX127x" shape="rect" coords="0,56,93,80"/>
|
|
<area href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN...." alt="PhysicalLayer" shape="rect" coords="0,0,93,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ad0387b22d6dcc876bc5f85174714149b" id="r_ad0387b22d6dcc876bc5f85174714149b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1273.html#ad0387b22d6dcc876bc5f85174714149b">SX1273</a> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
|
<tr class="memdesc:ad0387b22d6dcc876bc5f85174714149b"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. Called from Arduino sketch when creating new LoRa instance. <br /></td></tr>
|
|
<tr class="separator:ad0387b22d6dcc876bc5f85174714149b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a61844a7f08f7aadac00cf6617f991191" id="r_a61844a7f08f7aadac00cf6617f991191"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1273.html#a61844a7f08f7aadac00cf6617f991191">begin</a> (float freq=915.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX127X_SYNC_WORD, int8_t power=10, uint16_t preambleLength=8, uint8_t gain=0) override</td></tr>
|
|
<tr class="memdesc:a61844a7f08f7aadac00cf6617f991191"><td class="mdescLeft"> </td><td class="mdescRight">LoRa modem initialization method. Must be called at least once from Arduino sketch to initialize the module. <br /></td></tr>
|
|
<tr class="separator:a61844a7f08f7aadac00cf6617f991191"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac714448cb245ec57fa6f2395f1c8a1f7" id="r_ac714448cb245ec57fa6f2395f1c8a1f7"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1273.html#ac714448cb245ec57fa6f2395f1c8a1f7">setSpreadingFactor</a> (uint8_t sf) override</td></tr>
|
|
<tr class="memdesc:ac714448cb245ec57fa6f2395f1c8a1f7"><td class="mdescLeft"> </td><td class="mdescRight">Sets LoRa link spreading factor. Allowed values range from 6 to 9. Only available in LoRa mode. <br /></td></tr>
|
|
<tr class="separator:ac714448cb245ec57fa6f2395f1c8a1f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acaffc772f70e7db371cbe736dc4a19ab" id="r_acaffc772f70e7db371cbe736dc4a19ab"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1273.html#acaffc772f70e7db371cbe736dc4a19ab">setDataRate</a> (<a class="el" href="union_data_rate__t.html">DataRate_t</a> dr) override</td></tr>
|
|
<tr class="memdesc:acaffc772f70e7db371cbe736dc4a19ab"><td class="mdescLeft"> </td><td class="mdescRight">Set data. <br /></td></tr>
|
|
<tr class="separator:acaffc772f70e7db371cbe736dc4a19ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5eae1e82596f3a6c4c926c381c2737a7" id="r_a5eae1e82596f3a6c4c926c381c2737a7"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1273.html#a5eae1e82596f3a6c4c926c381c2737a7">checkDataRate</a> (<a class="el" href="union_data_rate__t.html">DataRate_t</a> dr) override</td></tr>
|
|
<tr class="memdesc:a5eae1e82596f3a6c4c926c381c2737a7"><td class="mdescLeft"> </td><td class="mdescRight">Check the data rate can be configured by this module. <br /></td></tr>
|
|
<tr class="separator:a5eae1e82596f3a6c4c926c381c2737a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af9f0969764fde3e12b6b05409718fa83" id="r_af9f0969764fde3e12b6b05409718fa83"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1273.html#af9f0969764fde3e12b6b05409718fa83">setModem</a> (ModemType_t modem) override</td></tr>
|
|
<tr class="memdesc:af9f0969764fde3e12b6b05409718fa83"><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:af9f0969764fde3e12b6b05409718fa83"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_s_x1272"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_s_x1272')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_s_x1272.html">SX1272</a></td></tr>
|
|
<tr class="memitem:a9ffe467a6baaeaa079e02c3f1f43f626 inherit pub_methods_class_s_x1272" id="r_a9ffe467a6baaeaa079e02c3f1f43f626"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#a9ffe467a6baaeaa079e02c3f1f43f626">SX1272</a> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
|
<tr class="memdesc:a9ffe467a6baaeaa079e02c3f1f43f626 inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. Called from Arduino sketch when creating new LoRa instance. <br /></td></tr>
|
|
<tr class="separator:a9ffe467a6baaeaa079e02c3f1f43f626 inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a83b80377ec3b7a4a4dd663409f2f6260 inherit pub_methods_class_s_x1272" id="r_a83b80377ec3b7a4a4dd663409f2f6260"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#a83b80377ec3b7a4a4dd663409f2f6260">beginFSK</a> (float freq=915.0, float br=4.8, float freqDev=5.0, float rxBw=125.0, int8_t power=10, uint16_t preambleLength=16, bool enableOOK=false)</td></tr>
|
|
<tr class="memdesc:a83b80377ec3b7a4a4dd663409f2f6260 inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">FSK modem initialization method. Must be called at least once from Arduino sketch to initialize the module. <br /></td></tr>
|
|
<tr class="separator:a83b80377ec3b7a4a4dd663409f2f6260 inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0978cc9ecbb7b9d3a017c133506e57ac inherit pub_methods_class_s_x1272" id="r_a0978cc9ecbb7b9d3a017c133506e57ac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#a0978cc9ecbb7b9d3a017c133506e57ac">reset</a> () override</td></tr>
|
|
<tr class="memdesc:a0978cc9ecbb7b9d3a017c133506e57ac inherit pub_methods_class_s_x1272"><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:a0978cc9ecbb7b9d3a017c133506e57ac inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac1467a23e1f1bfdbd02f6d30654ed850 inherit pub_methods_class_s_x1272" id="r_ac1467a23e1f1bfdbd02f6d30654ed850"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#ac1467a23e1f1bfdbd02f6d30654ed850">setFrequency</a> (float freq) override</td></tr>
|
|
<tr class="memdesc:ac1467a23e1f1bfdbd02f6d30654ed850 inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Sets carrier frequency. Allowed values range from 860.0 MHz to 1020.0 MHz. <br /></td></tr>
|
|
<tr class="separator:ac1467a23e1f1bfdbd02f6d30654ed850 inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0cc8eeb00241031796fc73b08711469b inherit pub_methods_class_s_x1272" id="r_a0cc8eeb00241031796fc73b08711469b"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#a0cc8eeb00241031796fc73b08711469b">setBandwidth</a> (float bw)</td></tr>
|
|
<tr class="memdesc:a0cc8eeb00241031796fc73b08711469b inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Sets LoRa link bandwidth. Allowed values are 125, 250 and 500 kHz. Only available in LoRa mode. <br /></td></tr>
|
|
<tr class="separator:a0cc8eeb00241031796fc73b08711469b inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a960913438feccad4c1913a9222384a5f inherit pub_methods_class_s_x1272" id="r_a960913438feccad4c1913a9222384a5f"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#a960913438feccad4c1913a9222384a5f">setCodingRate</a> (uint8_t cr)</td></tr>
|
|
<tr class="memdesc:a960913438feccad4c1913a9222384a5f inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Sets LoRa link coding rate denominator. Allowed values range from 5 to 8. Only available in LoRa mode. <br /></td></tr>
|
|
<tr class="separator:a960913438feccad4c1913a9222384a5f inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab5c9a79d72996c3d793cee812b0aded5 inherit pub_methods_class_s_x1272" id="r_ab5c9a79d72996c3d793cee812b0aded5"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#ab5c9a79d72996c3d793cee812b0aded5">setBitRate</a> (float br) override</td></tr>
|
|
<tr class="memdesc:ab5c9a79d72996c3d793cee812b0aded5 inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK bit rate. Allowed values range from 0.5 to 300 kbps. Only available in FSK mode. <br /></td></tr>
|
|
<tr class="separator:ab5c9a79d72996c3d793cee812b0aded5 inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aec51f08c0902145ff5f11e27e7cab638 inherit pub_methods_class_s_x1272" id="r_aec51f08c0902145ff5f11e27e7cab638"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#aec51f08c0902145ff5f11e27e7cab638">setOutputPower</a> (int8_t power) override</td></tr>
|
|
<tr class="memdesc:aec51f08c0902145ff5f11e27e7cab638 inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Sets transmission output power. Allowed values range from -1 to 14 dBm (RFO pin) or +2 to +20 dBm (PA_BOOST pin). High power +20 dBm operation is also supported, on the PA_BOOST pin. Defaults to PA_BOOST. <br /></td></tr>
|
|
<tr class="separator:aec51f08c0902145ff5f11e27e7cab638 inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac001c32a61d4eec0a49c472cac9ebc6 inherit pub_methods_class_s_x1272" id="r_aac001c32a61d4eec0a49c472cac9ebc6"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#aac001c32a61d4eec0a49c472cac9ebc6">setOutputPower</a> (int8_t power, bool forceRfo)</td></tr>
|
|
<tr class="memdesc:aac001c32a61d4eec0a49c472cac9ebc6 inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Sets transmission output power. Allowed values range from -1 to 14 dBm (RFO pin) or +2 to +20 dBm (PA_BOOST pin). <br /></td></tr>
|
|
<tr class="separator:aac001c32a61d4eec0a49c472cac9ebc6 inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2510072152c936d9f62557f46a4248d0 inherit pub_methods_class_s_x1272" id="r_a2510072152c936d9f62557f46a4248d0"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#a2510072152c936d9f62557f46a4248d0">checkOutputPower</a> (int8_t power, int8_t *clipped) override</td></tr>
|
|
<tr class="memdesc:a2510072152c936d9f62557f46a4248d0 inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Check if output power is configurable. This method is needed for compatibility with <a class="el" href="class_physical_layer.html#a1784cb227d04b3f2846625fda6797536" title="Check if output power is configurable. Must be implemented in module class if the module supports it.">PhysicalLayer::checkOutputPower</a>. <br /></td></tr>
|
|
<tr class="separator:a2510072152c936d9f62557f46a4248d0 inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1e39e8e3b228ca9a805f41a9bbf86c64 inherit pub_methods_class_s_x1272" id="r_a1e39e8e3b228ca9a805f41a9bbf86c64"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#a1e39e8e3b228ca9a805f41a9bbf86c64">checkOutputPower</a> (int8_t power, int8_t *clipped, bool useRfo)</td></tr>
|
|
<tr class="memdesc:a1e39e8e3b228ca9a805f41a9bbf86c64 inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Check if output power is configurable. <br /></td></tr>
|
|
<tr class="separator:a1e39e8e3b228ca9a805f41a9bbf86c64 inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1c57ad5e8496dc28cd3ba9852809852 inherit pub_methods_class_s_x1272" id="r_ae1c57ad5e8496dc28cd3ba9852809852"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#ae1c57ad5e8496dc28cd3ba9852809852">setGain</a> (uint8_t gain)</td></tr>
|
|
<tr class="memdesc:ae1c57ad5e8496dc28cd3ba9852809852 inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Sets gain of receiver LNA (low-noise amplifier). Can be set to any integer in range 1 to 6 where 1 is the highest gain. Set to 0 to enable automatic gain control (recommended). <br /></td></tr>
|
|
<tr class="separator:ae1c57ad5e8496dc28cd3ba9852809852 inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a91aca64124321c07a67f26b3c6934aea inherit pub_methods_class_s_x1272" id="r_a91aca64124321c07a67f26b3c6934aea"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#a91aca64124321c07a67f26b3c6934aea">setDataShaping</a> (uint8_t sh) override</td></tr>
|
|
<tr class="memdesc:a91aca64124321c07a67f26b3c6934aea inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK mode with FSK modulation. Allowed values are RADIOLIB_SHAPING_0_3, RADIOLIB_SHAPING_0_5 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping. <br /></td></tr>
|
|
<tr class="separator:a91aca64124321c07a67f26b3c6934aea inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3a377445cb4b8fd41781a3210a819a47 inherit pub_methods_class_s_x1272" id="r_a3a377445cb4b8fd41781a3210a819a47"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#a3a377445cb4b8fd41781a3210a819a47">setDataShapingOOK</a> (uint8_t sh)</td></tr>
|
|
<tr class="memdesc:a3a377445cb4b8fd41781a3210a819a47 inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Sets filter cutoff frequency that will be used for data shaping. Allowed values are 1 for frequency equal to bit rate and 2 for frequency equal to 2x bit rate. Set to 0 to disable data shaping. Only available in FSK mode with OOK modulation. <br /></td></tr>
|
|
<tr class="separator:a3a377445cb4b8fd41781a3210a819a47 inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a54a4b070d6899bd1edae6ae4a17c7d90 inherit pub_methods_class_s_x1272" id="r_a54a4b070d6899bd1edae6ae4a17c7d90"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#a54a4b070d6899bd1edae6ae4a17c7d90">getRSSI</a> () override</td></tr>
|
|
<tr class="memdesc:a54a4b070d6899bd1edae6ae4a17c7d90 inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Gets recorded signal strength indicator. Overload with packet mode 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:a54a4b070d6899bd1edae6ae4a17c7d90 inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a171656d12a9909bbb04fc81be86ec2a6 inherit pub_methods_class_s_x1272" id="r_a171656d12a9909bbb04fc81be86ec2a6"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#a171656d12a9909bbb04fc81be86ec2a6">getRSSI</a> (bool packet, bool skipReceive=false)</td></tr>
|
|
<tr class="memdesc:a171656d12a9909bbb04fc81be86ec2a6 inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Gets recorded signal strength indicator. <br /></td></tr>
|
|
<tr class="separator:a171656d12a9909bbb04fc81be86ec2a6 inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd912314a977f92c464d36d862329ffc inherit pub_methods_class_s_x1272" id="r_abd912314a977f92c464d36d862329ffc"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#abd912314a977f92c464d36d862329ffc">setCRC</a> (bool enable, bool mode=false)</td></tr>
|
|
<tr class="memdesc:abd912314a977f92c464d36d862329ffc inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Enables/disables CRC check of received packets. <br /></td></tr>
|
|
<tr class="separator:abd912314a977f92c464d36d862329ffc inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4aaf9d61310fa7b4fce413ae53d30ac0 inherit pub_methods_class_s_x1272" id="r_a4aaf9d61310fa7b4fce413ae53d30ac0"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#a4aaf9d61310fa7b4fce413ae53d30ac0">forceLDRO</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:a4aaf9d61310fa7b4fce413ae53d30ac0 inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method, LDRO will always be set to the provided value, regardless of symbol length. To re-enable automatic LDRO configuration, call <a class="el" href="class_s_x1278.html#ae02adcde8c2978c0d1b157729dd5df1e" title="Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...">SX1278::autoLDRO()</a> <br /></td></tr>
|
|
<tr class="separator:a4aaf9d61310fa7b4fce413ae53d30ac0 inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb4bbfe8acc6026c833d267d78417b63 inherit pub_methods_class_s_x1272" id="r_abb4bbfe8acc6026c833d267d78417b63"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#abb4bbfe8acc6026c833d267d78417b63">autoLDRO</a> ()</td></tr>
|
|
<tr class="memdesc:abb4bbfe8acc6026c833d267d78417b63 inherit pub_methods_class_s_x1272"><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:abb4bbfe8acc6026c833d267d78417b63 inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ee36122f8aca42b27a8412e0c362dd3 inherit pub_methods_class_s_x1272" id="r_a4ee36122f8aca42b27a8412e0c362dd3"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#a4ee36122f8aca42b27a8412e0c362dd3">implicitHeader</a> (size_t len)</td></tr>
|
|
<tr class="memdesc:a4ee36122f8aca42b27a8412e0c362dd3 inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Set implicit header mode for future reception/transmission. Required for spreading factor 6. <br /></td></tr>
|
|
<tr class="separator:a4ee36122f8aca42b27a8412e0c362dd3 inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3c9704cb58232f696b5f90f69c115f7 inherit pub_methods_class_s_x1272" id="r_ae3c9704cb58232f696b5f90f69c115f7"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1272.html#ae3c9704cb58232f696b5f90f69c115f7">explicitHeader</a> ()</td></tr>
|
|
<tr class="memdesc:ae3c9704cb58232f696b5f90f69c115f7 inherit pub_methods_class_s_x1272"><td class="mdescLeft"> </td><td class="mdescRight">Set explicit header mode for future reception/transmission. <br /></td></tr>
|
|
<tr class="separator:ae3c9704cb58232f696b5f90f69c115f7 inherit pub_methods_class_s_x1272"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_s_x127x"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_s_x127x')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_s_x127x.html">SX127x</a></td></tr>
|
|
<tr class="memitem:ac74c5914ca429a3892c66b9d98e3ea6c inherit pub_methods_class_s_x127x" id="r_ac74c5914ca429a3892c66b9d98e3ea6c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#ac74c5914ca429a3892c66b9d98e3ea6c">SX127x</a> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
|
<tr class="memdesc:ac74c5914ca429a3892c66b9d98e3ea6c inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. Called internally when creating new LoRa instance. <br /></td></tr>
|
|
<tr class="separator:ac74c5914ca429a3892c66b9d98e3ea6c inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7ddbde7fd8eb06d38abfb658eee29bc1 inherit pub_methods_class_s_x127x" id="r_a7ddbde7fd8eb06d38abfb658eee29bc1"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a7ddbde7fd8eb06d38abfb658eee29bc1">begin</a> (const uint8_t *chipVersions, uint8_t numVersions, uint8_t syncWord, uint16_t preambleLength)</td></tr>
|
|
<tr class="memdesc:a7ddbde7fd8eb06d38abfb658eee29bc1 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. Will be called with appropriate parameters when calling initialization method from derived class. <br /></td></tr>
|
|
<tr class="separator:a7ddbde7fd8eb06d38abfb658eee29bc1 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66fe001474583d490df1d0b38260bf8e inherit pub_methods_class_s_x127x" id="r_a66fe001474583d490df1d0b38260bf8e"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a66fe001474583d490df1d0b38260bf8e">beginFSK</a> (const uint8_t *chipVersions, uint8_t numVersions, float freqDev, float rxBw, uint16_t preambleLength, bool enableOOK)</td></tr>
|
|
<tr class="memdesc:a66fe001474583d490df1d0b38260bf8e inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for FSK modem. Will be called with appropriate parameters when calling FSK initialization method from derived class. <br /></td></tr>
|
|
<tr class="separator:a66fe001474583d490df1d0b38260bf8e inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a75cb0d8810a5ce025d3bf5b51ca263d6 inherit pub_methods_class_s_x127x" id="r_a75cb0d8810a5ce025d3bf5b51ca263d6"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a75cb0d8810a5ce025d3bf5b51ca263d6">transmit</a> (const uint8_t *data, size_t len, uint8_t addr=0) override</td></tr>
|
|
<tr class="memdesc:a75cb0d8810a5ce025d3bf5b51ca263d6 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Binary transmit method. Will transmit arbitrary binary data up to 255 bytes long using LoRa or up to 63 bytes using FSK modem. For overloads to transmit Arduino String or C-string, see <a class="el" href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534" title="C-string transmit method.">PhysicalLayer::transmit</a>. <br /></td></tr>
|
|
<tr class="separator:a75cb0d8810a5ce025d3bf5b51ca263d6 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfe0d3f033a23ec2f3c2a407285d357c inherit pub_methods_class_s_x127x" id="r_adfe0d3f033a23ec2f3c2a407285d357c"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#adfe0d3f033a23ec2f3c2a407285d357c">receive</a> (uint8_t *data, size_t len) override</td></tr>
|
|
<tr class="memdesc:adfe0d3f033a23ec2f3c2a407285d357c inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Binary receive method. Will attempt to receive arbitrary binary data up to 255 bytes long using LoRa or up to 63 bytes using FSK modem. For overloads to receive Arduino String, see <a class="el" href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8" title="Binary receive method. Must be implemented in module class.">PhysicalLayer::receive</a>. <br /></td></tr>
|
|
<tr class="separator:adfe0d3f033a23ec2f3c2a407285d357c inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a13ae97e18744dc617bc9326cfbaad3a3 inherit pub_methods_class_s_x127x" id="r_a13ae97e18744dc617bc9326cfbaad3a3"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a13ae97e18744dc617bc9326cfbaad3a3">scanChannel</a> () override</td></tr>
|
|
<tr class="memdesc:a13ae97e18744dc617bc9326cfbaad3a3 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Performs scan for valid LoRa preamble in the current channel. <br /></td></tr>
|
|
<tr class="separator:a13ae97e18744dc617bc9326cfbaad3a3 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ff85ee7979da08b4e66316f1ba2c6a9 inherit pub_methods_class_s_x127x" id="r_a1ff85ee7979da08b4e66316f1ba2c6a9"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a1ff85ee7979da08b4e66316f1ba2c6a9">sleep</a> () override</td></tr>
|
|
<tr class="memdesc:a1ff85ee7979da08b4e66316f1ba2c6a9 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets the LoRa module to sleep to save power. Module will not be able to transmit or receive any data while in sleep mode. Module will wake up automatically when methods like transmit or receive are called. <br /></td></tr>
|
|
<tr class="separator:a1ff85ee7979da08b4e66316f1ba2c6a9 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a760b8c5103128f122fbe489c6529ce41 inherit pub_methods_class_s_x127x" id="r_a760b8c5103128f122fbe489c6529ce41"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a760b8c5103128f122fbe489c6529ce41">standby</a> () override</td></tr>
|
|
<tr class="memdesc:a760b8c5103128f122fbe489c6529ce41 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets the LoRa module to standby. <br /></td></tr>
|
|
<tr class="separator:a760b8c5103128f122fbe489c6529ce41 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa565bbff460e487672953dc05d335cb0 inherit pub_methods_class_s_x127x" id="r_aa565bbff460e487672953dc05d335cb0"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#aa565bbff460e487672953dc05d335cb0">standby</a> (uint8_t mode) override</td></tr>
|
|
<tr class="memdesc:aa565bbff460e487672953dc05d335cb0 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets the LoRa module to standby. <br /></td></tr>
|
|
<tr class="separator:aa565bbff460e487672953dc05d335cb0 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aefeeb9f7192e11a75b5dfb1ab8488e84 inherit pub_methods_class_s_x127x" id="r_aefeeb9f7192e11a75b5dfb1ab8488e84"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#aefeeb9f7192e11a75b5dfb1ab8488e84">transmitDirect</a> (uint32_t frf=0) override</td></tr>
|
|
<tr class="memdesc:aefeeb9f7192e11a75b5dfb1ab8488e84 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). While in direct mode, the module will not be able to transmit or receive packets. Can only be activated in FSK mode. <br /></td></tr>
|
|
<tr class="separator:aefeeb9f7192e11a75b5dfb1ab8488e84 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa7ac558d537c6364c4bc82c8f33e398f inherit pub_methods_class_s_x127x" id="r_aa7ac558d537c6364c4bc82c8f33e398f"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#aa7ac558d537c6364c4bc82c8f33e398f">receiveDirect</a> () override</td></tr>
|
|
<tr class="memdesc:aa7ac558d537c6364c4bc82c8f33e398f inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). While in direct mode, the module will not be able to transmit or receive packets. Can only be activated in FSK mode. <br /></td></tr>
|
|
<tr class="separator:aa7ac558d537c6364c4bc82c8f33e398f inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0995088d37689a3c240a1af791df6cf1 inherit pub_methods_class_s_x127x" id="r_a0995088d37689a3c240a1af791df6cf1"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a0995088d37689a3c240a1af791df6cf1">packetMode</a> ()</td></tr>
|
|
<tr class="memdesc:a0995088d37689a3c240a1af791df6cf1 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Disables direct mode and enables packet mode, allowing the module to receive packets. Can only be activated in FSK mode. <br /></td></tr>
|
|
<tr class="separator:a0995088d37689a3c240a1af791df6cf1 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae75bc48cc74a407370cd9f4bf95e9e30 inherit pub_methods_class_s_x127x" id="r_ae75bc48cc74a407370cd9f4bf95e9e30"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#ae75bc48cc74a407370cd9f4bf95e9e30">setDio0Action</a> (void(*func)(void), uint32_t dir)</td></tr>
|
|
<tr class="memdesc:ae75bc48cc74a407370cd9f4bf95e9e30 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt service routine function to call when DIO0 activates. <br /></td></tr>
|
|
<tr class="separator:ae75bc48cc74a407370cd9f4bf95e9e30 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a729b4f3f36096b5b15bae19c7876e823 inherit pub_methods_class_s_x127x" id="r_a729b4f3f36096b5b15bae19c7876e823"><td class="memItemLeft" align="right" valign="top">
|
|
void </td><td class="memItemRight" valign="bottom"><b>clearDio0Action</b> ()</td></tr>
|
|
<tr class="memdesc:a729b4f3f36096b5b15bae19c7876e823 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when DIO0 activates. <br /></td></tr>
|
|
<tr class="separator:a729b4f3f36096b5b15bae19c7876e823 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b4bce81839b105c464ebf922602e58b inherit pub_methods_class_s_x127x" id="r_a7b4bce81839b105c464ebf922602e58b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a7b4bce81839b105c464ebf922602e58b">setDio1Action</a> (void(*func)(void), uint32_t dir)</td></tr>
|
|
<tr class="memdesc:a7b4bce81839b105c464ebf922602e58b inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt service routine function to call when DIO1 activates. <br /></td></tr>
|
|
<tr class="separator:a7b4bce81839b105c464ebf922602e58b inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b6532a25e1730973ac08146008adca5 inherit pub_methods_class_s_x127x" id="r_a9b6532a25e1730973ac08146008adca5"><td class="memItemLeft" align="right" valign="top">
|
|
void </td><td class="memItemRight" valign="bottom"><b>clearDio1Action</b> ()</td></tr>
|
|
<tr class="memdesc:a9b6532a25e1730973ac08146008adca5 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when DIO1 activates. <br /></td></tr>
|
|
<tr class="separator:a9b6532a25e1730973ac08146008adca5 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae236a467095fb5364d0fc4a98d85f96e inherit pub_methods_class_s_x127x" id="r_ae236a467095fb5364d0fc4a98d85f96e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#ae236a467095fb5364d0fc4a98d85f96e">setPacketReceivedAction</a> (void(*func)(void)) override</td></tr>
|
|
<tr class="memdesc:ae236a467095fb5364d0fc4a98d85f96e inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a packet is received. <br /></td></tr>
|
|
<tr class="separator:ae236a467095fb5364d0fc4a98d85f96e inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6cbc4c256d37f9cdabf9e5f2ef16aa92 inherit pub_methods_class_s_x127x" id="r_a6cbc4c256d37f9cdabf9e5f2ef16aa92"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a6cbc4c256d37f9cdabf9e5f2ef16aa92">clearPacketReceivedAction</a> () override</td></tr>
|
|
<tr class="memdesc:a6cbc4c256d37f9cdabf9e5f2ef16aa92 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a packet is received. <br /></td></tr>
|
|
<tr class="separator:a6cbc4c256d37f9cdabf9e5f2ef16aa92 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3530e8e19cfe4d96fe49ca4e6386b099 inherit pub_methods_class_s_x127x" id="r_a3530e8e19cfe4d96fe49ca4e6386b099"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a3530e8e19cfe4d96fe49ca4e6386b099">setPacketSentAction</a> (void(*func)(void)) override</td></tr>
|
|
<tr class="memdesc:a3530e8e19cfe4d96fe49ca4e6386b099 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a packet is sent. <br /></td></tr>
|
|
<tr class="separator:a3530e8e19cfe4d96fe49ca4e6386b099 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ec32a52b13752d75f3076a5868c312d inherit pub_methods_class_s_x127x" id="r_a2ec32a52b13752d75f3076a5868c312d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a2ec32a52b13752d75f3076a5868c312d">clearPacketSentAction</a> () override</td></tr>
|
|
<tr class="memdesc:a2ec32a52b13752d75f3076a5868c312d inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a packet is sent. <br /></td></tr>
|
|
<tr class="separator:a2ec32a52b13752d75f3076a5868c312d inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac23c2b384ae8611d59e10ef6a14fe7e4 inherit pub_methods_class_s_x127x" id="r_ac23c2b384ae8611d59e10ef6a14fe7e4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#ac23c2b384ae8611d59e10ef6a14fe7e4">setChannelScanAction</a> (void(*func)(void)) override</td></tr>
|
|
<tr class="memdesc:ac23c2b384ae8611d59e10ef6a14fe7e4 inherit pub_methods_class_s_x127x"><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:ac23c2b384ae8611d59e10ef6a14fe7e4 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ce9beca21406e3556b3518370947ee2 inherit pub_methods_class_s_x127x" id="r_a0ce9beca21406e3556b3518370947ee2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a0ce9beca21406e3556b3518370947ee2">clearChannelScanAction</a> () override</td></tr>
|
|
<tr class="memdesc:a0ce9beca21406e3556b3518370947ee2 inherit pub_methods_class_s_x127x"><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:a0ce9beca21406e3556b3518370947ee2 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6fbdfd8e2a2ad1eb7e59a73385847acb inherit pub_methods_class_s_x127x" id="r_a6fbdfd8e2a2ad1eb7e59a73385847acb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a6fbdfd8e2a2ad1eb7e59a73385847acb">setFifoEmptyAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:a6fbdfd8e2a2ad1eb7e59a73385847acb inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt service routine function to call when FIFO is empty. <br /></td></tr>
|
|
<tr class="separator:a6fbdfd8e2a2ad1eb7e59a73385847acb inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaa6eb4363badc1c3450ad7a4d11af4b1 inherit pub_methods_class_s_x127x" id="r_aaa6eb4363badc1c3450ad7a4d11af4b1"><td class="memItemLeft" align="right" valign="top">
|
|
void </td><td class="memItemRight" valign="bottom"><b>clearFifoEmptyAction</b> ()</td></tr>
|
|
<tr class="memdesc:aaa6eb4363badc1c3450ad7a4d11af4b1 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when FIFO is empty. <br /></td></tr>
|
|
<tr class="separator:aaa6eb4363badc1c3450ad7a4d11af4b1 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b9529ac87f62c32c9c5fac3dc6e08a9 inherit pub_methods_class_s_x127x" id="r_a7b9529ac87f62c32c9c5fac3dc6e08a9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a7b9529ac87f62c32c9c5fac3dc6e08a9">setFifoThreshold</a> (uint8_t threshold)</td></tr>
|
|
<tr class="memdesc:a7b9529ac87f62c32c9c5fac3dc6e08a9 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Set FIFO threshold level. Be aware that threshold is also set in setFifoFullAction method. setFifoThreshold method must be called AFTER calling setFifoFullAction! <br /></td></tr>
|
|
<tr class="separator:a7b9529ac87f62c32c9c5fac3dc6e08a9 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a201c31366f32c41b801724fb662265c1 inherit pub_methods_class_s_x127x" id="r_a201c31366f32c41b801724fb662265c1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a201c31366f32c41b801724fb662265c1">setFifoFullAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:a201c31366f32c41b801724fb662265c1 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt service routine function to call when FIFO is full. <br /></td></tr>
|
|
<tr class="separator:a201c31366f32c41b801724fb662265c1 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f041e91ab2fbb6f05eef56b5addac71 inherit pub_methods_class_s_x127x" id="r_a0f041e91ab2fbb6f05eef56b5addac71"><td class="memItemLeft" align="right" valign="top">
|
|
void </td><td class="memItemRight" valign="bottom"><b>clearFifoFullAction</b> ()</td></tr>
|
|
<tr class="memdesc:a0f041e91ab2fbb6f05eef56b5addac71 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when FIFO is full. <br /></td></tr>
|
|
<tr class="separator:a0f041e91ab2fbb6f05eef56b5addac71 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36dbd1697a415c6db3b47cd620c8c02e inherit pub_methods_class_s_x127x" id="r_a36dbd1697a415c6db3b47cd620c8c02e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a36dbd1697a415c6db3b47cd620c8c02e">fifoAdd</a> (uint8_t *data, int totalLen, int *remLen)</td></tr>
|
|
<tr class="memdesc:a36dbd1697a415c6db3b47cd620c8c02e inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt service routine function to call when FIFO is empty. <br /></td></tr>
|
|
<tr class="separator:a36dbd1697a415c6db3b47cd620c8c02e inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25b193b71ddb6015d25b0a161809d75a inherit pub_methods_class_s_x127x" id="r_a25b193b71ddb6015d25b0a161809d75a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a25b193b71ddb6015d25b0a161809d75a">fifoGet</a> (volatile uint8_t *data, int totalLen, volatile int *rcvLen)</td></tr>
|
|
<tr class="memdesc:a25b193b71ddb6015d25b0a161809d75a inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt service routine function to call when FIFO is sufficiently full to read. <br /></td></tr>
|
|
<tr class="separator:a25b193b71ddb6015d25b0a161809d75a inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7fd9cec52b7fbd0c69cbd861dc17549f inherit pub_methods_class_s_x127x" id="r_a7fd9cec52b7fbd0c69cbd861dc17549f"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a7fd9cec52b7fbd0c69cbd861dc17549f">finishTransmit</a> () override</td></tr>
|
|
<tr class="memdesc:a7fd9cec52b7fbd0c69cbd861dc17549f inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Clean up after transmission is done. <br /></td></tr>
|
|
<tr class="separator:a7fd9cec52b7fbd0c69cbd861dc17549f inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abbe1076252a366c3c4aa323fdff7d40c inherit pub_methods_class_s_x127x" id="r_abbe1076252a366c3c4aa323fdff7d40c"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#abbe1076252a366c3c4aa323fdff7d40c">startReceive</a> () override</td></tr>
|
|
<tr class="memdesc:abbe1076252a366c3c4aa323fdff7d40c inherit pub_methods_class_s_x127x"><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:abbe1076252a366c3c4aa323fdff7d40c inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abfc840e8d6fe5e222f0143be17876745 inherit pub_methods_class_s_x127x" id="r_abfc840e8d6fe5e222f0143be17876745"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#abfc840e8d6fe5e222f0143be17876745">readData</a> (uint8_t *data, size_t len) override</td></tr>
|
|
<tr class="memdesc:abfc840e8d6fe5e222f0143be17876745 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Reads data that was 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:abfc840e8d6fe5e222f0143be17876745 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6fa5723724393576ed597509200e17d1 inherit pub_methods_class_s_x127x" id="r_a6fa5723724393576ed597509200e17d1"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a6fa5723724393576ed597509200e17d1">startChannelScan</a> () override</td></tr>
|
|
<tr class="memdesc:a6fa5723724393576ed597509200e17d1 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected. DIO1 will be activated if there's no preamble detected before timeout. <br /></td></tr>
|
|
<tr class="separator:a6fa5723724393576ed597509200e17d1 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a81189ce77541d78fc8feb99c2a3f35b2 inherit pub_methods_class_s_x127x" id="r_a81189ce77541d78fc8feb99c2a3f35b2"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a81189ce77541d78fc8feb99c2a3f35b2">getChannelScanResult</a> () override</td></tr>
|
|
<tr class="memdesc:a81189ce77541d78fc8feb99c2a3f35b2 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Read the channel scan result. <br /></td></tr>
|
|
<tr class="separator:a81189ce77541d78fc8feb99c2a3f35b2 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac5c7f4584352a12390594395d9c29bde inherit pub_methods_class_s_x127x" id="r_ac5c7f4584352a12390594395d9c29bde"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#ac5c7f4584352a12390594395d9c29bde">setSyncWord</a> (uint8_t syncWord)</td></tr>
|
|
<tr class="memdesc:ac5c7f4584352a12390594395d9c29bde inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets LoRa sync word. Only available in LoRa mode. <br /></td></tr>
|
|
<tr class="separator:ac5c7f4584352a12390594395d9c29bde inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a400575e3d83977bd250c5cb382fc7002 inherit pub_methods_class_s_x127x" id="r_a400575e3d83977bd250c5cb382fc7002"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a400575e3d83977bd250c5cb382fc7002">setCurrentLimit</a> (uint8_t currentLimit)</td></tr>
|
|
<tr class="memdesc:a400575e3d83977bd250c5cb382fc7002 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets current limit for over current protection at transmitter amplifier. Allowed values range from 45 to 120 mA in 5 mA steps and 120 to 240 mA in 10 mA steps. <br /></td></tr>
|
|
<tr class="separator:a400575e3d83977bd250c5cb382fc7002 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a844499bace6ae001446d71bee2877656 inherit pub_methods_class_s_x127x" id="r_a844499bace6ae001446d71bee2877656"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a844499bace6ae001446d71bee2877656">setPreambleLength</a> (size_t preambleLength) override</td></tr>
|
|
<tr class="memdesc:a844499bace6ae001446d71bee2877656 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets LoRa or FSK preamble length. Allowed values range from 6 to 65535 in LoRa mode or 0 to 65535 in FSK mode. <br /></td></tr>
|
|
<tr class="separator:a844499bace6ae001446d71bee2877656 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b79dae55315cdf25e530db77eeb140f inherit pub_methods_class_s_x127x" id="r_a5b79dae55315cdf25e530db77eeb140f"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a5b79dae55315cdf25e530db77eeb140f">invertPreamble</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:a5b79dae55315cdf25e530db77eeb140f inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Invert FSK preamble polarity. The default (non-inverted) is 0x55, the inverted is 0xAA. <br /></td></tr>
|
|
<tr class="separator:a5b79dae55315cdf25e530db77eeb140f inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af6aa854a2668d70f4d3a374a49440362 inherit pub_methods_class_s_x127x" id="r_af6aa854a2668d70f4d3a374a49440362"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#af6aa854a2668d70f4d3a374a49440362">getFrequencyError</a> (bool autoCorrect=false)</td></tr>
|
|
<tr class="memdesc:af6aa854a2668d70f4d3a374a49440362 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Gets frequency error of the latest received packet. <br /></td></tr>
|
|
<tr class="separator:af6aa854a2668d70f4d3a374a49440362 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5094ba2d9268340b7aba99afe5da0544 inherit pub_methods_class_s_x127x" id="r_a5094ba2d9268340b7aba99afe5da0544"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a5094ba2d9268340b7aba99afe5da0544">getAFCError</a> ()</td></tr>
|
|
<tr class="memdesc:a5094ba2d9268340b7aba99afe5da0544 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Gets current AFC error. <br /></td></tr>
|
|
<tr class="separator:a5094ba2d9268340b7aba99afe5da0544 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47b3f7464303085d34191dd334c1976f inherit pub_methods_class_s_x127x" id="r_a47b3f7464303085d34191dd334c1976f"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a47b3f7464303085d34191dd334c1976f">getSNR</a> () override</td></tr>
|
|
<tr class="memdesc:a47b3f7464303085d34191dd334c1976f inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode. <br /></td></tr>
|
|
<tr class="separator:a47b3f7464303085d34191dd334c1976f inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adc25b685de0859b799488bf7729350b6 inherit pub_methods_class_s_x127x" id="r_adc25b685de0859b799488bf7729350b6"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#adc25b685de0859b799488bf7729350b6">getDataRate</a> () const</td></tr>
|
|
<tr class="memdesc:adc25b685de0859b799488bf7729350b6 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Get data rate of the latest transmitted packet. <br /></td></tr>
|
|
<tr class="separator:adc25b685de0859b799488bf7729350b6 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a448ea8a6a6011a9cdddd4e09bd6c9679 inherit pub_methods_class_s_x127x" id="r_a448ea8a6a6011a9cdddd4e09bd6c9679"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a448ea8a6a6011a9cdddd4e09bd6c9679">setFrequencyDeviation</a> (float freqDev) override</td></tr>
|
|
<tr class="memdesc:a448ea8a6a6011a9cdddd4e09bd6c9679 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK frequency deviation from carrier frequency. Allowed values depend on bit rate setting and must be lower than 200 kHz. Only available in FSK mode. <br /></td></tr>
|
|
<tr class="separator:a448ea8a6a6011a9cdddd4e09bd6c9679 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2cc53b9f9d90647c5709cb974779cf53 inherit pub_methods_class_s_x127x" id="r_a2cc53b9f9d90647c5709cb974779cf53"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a2cc53b9f9d90647c5709cb974779cf53">setRxBandwidth</a> (float rxBw)</td></tr>
|
|
<tr class="memdesc:a2cc53b9f9d90647c5709cb974779cf53 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK receiver bandwidth. Allowed values range from 2.6 to 250 kHz. Only available in FSK mode. <br /></td></tr>
|
|
<tr class="separator:a2cc53b9f9d90647c5709cb974779cf53 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a63e00b1ecf1b0dcb6d8a91fc9b8ea5ef inherit pub_methods_class_s_x127x" id="r_a63e00b1ecf1b0dcb6d8a91fc9b8ea5ef"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a63e00b1ecf1b0dcb6d8a91fc9b8ea5ef">setAFCBandwidth</a> (float afcBw)</td></tr>
|
|
<tr class="memdesc:a63e00b1ecf1b0dcb6d8a91fc9b8ea5ef inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK automatic frequency correction bandwidth. Allowed values range from 2.6 to 250 kHz. Only available in FSK mode. <br /></td></tr>
|
|
<tr class="separator:a63e00b1ecf1b0dcb6d8a91fc9b8ea5ef inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41f8cfcc2cdeb25a8e5a03f1ba4edd1e inherit pub_methods_class_s_x127x" id="r_a41f8cfcc2cdeb25a8e5a03f1ba4edd1e"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a41f8cfcc2cdeb25a8e5a03f1ba4edd1e">setAFC</a> (bool isEnabled)</td></tr>
|
|
<tr class="memdesc:a41f8cfcc2cdeb25a8e5a03f1ba4edd1e inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables FSK automatic frequency correction(AFC) <br /></td></tr>
|
|
<tr class="separator:a41f8cfcc2cdeb25a8e5a03f1ba4edd1e inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab0f67330124cefc07a462e77922453d0 inherit pub_methods_class_s_x127x" id="r_ab0f67330124cefc07a462e77922453d0"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#ab0f67330124cefc07a462e77922453d0">setAFCAGCTrigger</a> (uint8_t trigger)</td></tr>
|
|
<tr class="memdesc:ab0f67330124cefc07a462e77922453d0 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Controls trigger of AFC and AGC. <br /></td></tr>
|
|
<tr class="separator:ab0f67330124cefc07a462e77922453d0 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf400f33e17c1679c0b55cd70bef90b0 inherit pub_methods_class_s_x127x" id="r_aaf400f33e17c1679c0b55cd70bef90b0"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#aaf400f33e17c1679c0b55cd70bef90b0">setSyncWord</a> (uint8_t *syncWord, size_t len) override</td></tr>
|
|
<tr class="memdesc:aaf400f33e17c1679c0b55cd70bef90b0 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK sync word. Allowed sync words are up to 8 bytes long and can not contain null bytes. Only available in FSK mode. <br /></td></tr>
|
|
<tr class="separator:aaf400f33e17c1679c0b55cd70bef90b0 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab99630d50672b43fc7162ba8f3293f95 inherit pub_methods_class_s_x127x" id="r_ab99630d50672b43fc7162ba8f3293f95"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#ab99630d50672b43fc7162ba8f3293f95">setNodeAddress</a> (uint8_t nodeAddr)</td></tr>
|
|
<tr class="memdesc:ab99630d50672b43fc7162ba8f3293f95 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK node address. Calling this method will enable address filtering. Only available in FSK mode. <br /></td></tr>
|
|
<tr class="separator:ab99630d50672b43fc7162ba8f3293f95 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abc51ce6718153e4963128f25bb5aab40 inherit pub_methods_class_s_x127x" id="r_abc51ce6718153e4963128f25bb5aab40"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#abc51ce6718153e4963128f25bb5aab40">setBroadcastAddress</a> (uint8_t broadAddr)</td></tr>
|
|
<tr class="memdesc:abc51ce6718153e4963128f25bb5aab40 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK broadcast address. Calling this method will enable address filtering. Only available in FSK mode. <br /></td></tr>
|
|
<tr class="separator:abc51ce6718153e4963128f25bb5aab40 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afe6e9bbfd75f9cad26f9f72c34c4ada5 inherit pub_methods_class_s_x127x" id="r_afe6e9bbfd75f9cad26f9f72c34c4ada5"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#afe6e9bbfd75f9cad26f9f72c34c4ada5">disableAddressFiltering</a> ()</td></tr>
|
|
<tr class="memdesc:afe6e9bbfd75f9cad26f9f72c34c4ada5 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Disables FSK address filtering. <br /></td></tr>
|
|
<tr class="separator:afe6e9bbfd75f9cad26f9f72c34c4ada5 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a24ef0af19a6b8954f956a3c3ad4286ee inherit pub_methods_class_s_x127x" id="r_a24ef0af19a6b8954f956a3c3ad4286ee"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a24ef0af19a6b8954f956a3c3ad4286ee">setOOK</a> (bool enableOOK)</td></tr>
|
|
<tr class="memdesc:a24ef0af19a6b8954f956a3c3ad4286ee inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Enables/disables OOK modulation instead of FSK. <br /></td></tr>
|
|
<tr class="separator:a24ef0af19a6b8954f956a3c3ad4286ee inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b93142202167270db109d18b743c744 inherit pub_methods_class_s_x127x" id="r_a8b93142202167270db109d18b743c744"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a8b93142202167270db109d18b743c744">setOokThresholdType</a> (uint8_t type)</td></tr>
|
|
<tr class="memdesc:a8b93142202167270db109d18b743c744 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Selects the type of threshold in the OOK data slicer. <br /></td></tr>
|
|
<tr class="separator:a8b93142202167270db109d18b743c744 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac2f43d70b5f94e49e09b4c9f082f46d inherit pub_methods_class_s_x127x" id="r_aac2f43d70b5f94e49e09b4c9f082f46d"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#aac2f43d70b5f94e49e09b4c9f082f46d">setOokPeakThresholdDecrement</a> (uint8_t value)</td></tr>
|
|
<tr class="memdesc:aac2f43d70b5f94e49e09b4c9f082f46d inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Period of decrement of the RSSI threshold in the OOK demodulator. <br /></td></tr>
|
|
<tr class="separator:aac2f43d70b5f94e49e09b4c9f082f46d inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a17ff4e4e0afaebed727648e1400be538 inherit pub_methods_class_s_x127x" id="r_a17ff4e4e0afaebed727648e1400be538"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a17ff4e4e0afaebed727648e1400be538">setOokFixedOrFloorThreshold</a> (uint8_t value)</td></tr>
|
|
<tr class="memdesc:a17ff4e4e0afaebed727648e1400be538 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Fixed threshold for the Data Slicer in OOK mode or floor threshold for the Data Slicer in OOK when Peak mode is used. <br /></td></tr>
|
|
<tr class="separator:a17ff4e4e0afaebed727648e1400be538 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48ca43e6aad02815fa1507f0f0831c54 inherit pub_methods_class_s_x127x" id="r_a48ca43e6aad02815fa1507f0f0831c54"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a48ca43e6aad02815fa1507f0f0831c54">setOokPeakThresholdStep</a> (uint8_t value)</td></tr>
|
|
<tr class="memdesc:a48ca43e6aad02815fa1507f0f0831c54 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Size of each decrement of the RSSI threshold in the OOK demodulator. <br /></td></tr>
|
|
<tr class="separator:a48ca43e6aad02815fa1507f0f0831c54 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1921e1d9fc1d888d2e73bb732e7db7aa inherit pub_methods_class_s_x127x" id="r_a1921e1d9fc1d888d2e73bb732e7db7aa"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a1921e1d9fc1d888d2e73bb732e7db7aa">enableBitSync</a> ()</td></tr>
|
|
<tr class="memdesc:a1921e1d9fc1d888d2e73bb732e7db7aa inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Enable Bit synchronizer. <br /></td></tr>
|
|
<tr class="separator:a1921e1d9fc1d888d2e73bb732e7db7aa inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8025b05b8f4f2f2abb4cd803b06e2ebd inherit pub_methods_class_s_x127x" id="r_a8025b05b8f4f2f2abb4cd803b06e2ebd"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a8025b05b8f4f2f2abb4cd803b06e2ebd">disableBitSync</a> ()</td></tr>
|
|
<tr class="memdesc:a8025b05b8f4f2f2abb4cd803b06e2ebd inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Disable Bit synchronizer (not allowed in Packet mode). <br /></td></tr>
|
|
<tr class="separator:a8025b05b8f4f2f2abb4cd803b06e2ebd inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a462fa74275e67c296328a01f361892d5 inherit pub_methods_class_s_x127x" id="r_a462fa74275e67c296328a01f361892d5"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a462fa74275e67c296328a01f361892d5">getPacketLength</a> (bool update=true) override</td></tr>
|
|
<tr class="memdesc:a462fa74275e67c296328a01f361892d5 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Query modem for the packet length of received payload. <br /></td></tr>
|
|
<tr class="separator:a462fa74275e67c296328a01f361892d5 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6fb42d9cd518e9f6408a40753c0be359 inherit pub_methods_class_s_x127x" id="r_a6fb42d9cd518e9f6408a40753c0be359"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a6fb42d9cd518e9f6408a40753c0be359">fixedPacketLengthMode</a> (uint8_t len=RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK)</td></tr>
|
|
<tr class="memdesc:a6fb42d9cd518e9f6408a40753c0be359 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Set modem in fixed packet length mode. Available in FSK mode only. <br /></td></tr>
|
|
<tr class="separator:a6fb42d9cd518e9f6408a40753c0be359 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d39296b40e7282ef44d8f376065e92c inherit pub_methods_class_s_x127x" id="r_a1d39296b40e7282ef44d8f376065e92c"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a1d39296b40e7282ef44d8f376065e92c">variablePacketLengthMode</a> (uint8_t maxLen=RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK)</td></tr>
|
|
<tr class="memdesc:a1d39296b40e7282ef44d8f376065e92c inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Set modem in variable packet length mode. Available in FSK mode only. <br /></td></tr>
|
|
<tr class="separator:a1d39296b40e7282ef44d8f376065e92c inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abcc10ab36404aaaee3fe7a1be6841511 inherit pub_methods_class_s_x127x" id="r_abcc10ab36404aaaee3fe7a1be6841511"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#abcc10ab36404aaaee3fe7a1be6841511">getNumSymbols</a> (size_t len)</td></tr>
|
|
<tr class="memdesc:abcc10ab36404aaaee3fe7a1be6841511 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Convert from bytes to LoRa symbols. <br /></td></tr>
|
|
<tr class="separator:abcc10ab36404aaaee3fe7a1be6841511 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9e7ecbc92c9d70f93211d21399d237d0 inherit pub_methods_class_s_x127x" id="r_a9e7ecbc92c9d70f93211d21399d237d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a9e7ecbc92c9d70f93211d21399d237d0">getTimeOnAir</a> (size_t len) override</td></tr>
|
|
<tr class="memdesc:a9e7ecbc92c9d70f93211d21399d237d0 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Get expected time-on-air for a given size of payload. <br /></td></tr>
|
|
<tr class="separator:a9e7ecbc92c9d70f93211d21399d237d0 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adbc4021380dc557114625dc51262cf90 inherit pub_methods_class_s_x127x" id="r_adbc4021380dc557114625dc51262cf90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#adbc4021380dc557114625dc51262cf90">calculateRxTimeout</a> (<a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> timeoutUs) override</td></tr>
|
|
<tr class="memdesc:adbc4021380dc557114625dc51262cf90 inherit pub_methods_class_s_x127x"><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:adbc4021380dc557114625dc51262cf90 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a22de05835dda9ed287ec48f60ef91f55 inherit pub_methods_class_s_x127x" id="r_a22de05835dda9ed287ec48f60ef91f55"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a22de05835dda9ed287ec48f60ef91f55">getIrqFlags</a> () override</td></tr>
|
|
<tr class="memdesc:a22de05835dda9ed287ec48f60ef91f55 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Read currently active IRQ flags. <br /></td></tr>
|
|
<tr class="separator:a22de05835dda9ed287ec48f60ef91f55 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae42b94ab2ecf729f29f101222e97666 inherit pub_methods_class_s_x127x" id="r_aae42b94ab2ecf729f29f101222e97666"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#aae42b94ab2ecf729f29f101222e97666">setIrqFlags</a> (uint32_t irq) override</td></tr>
|
|
<tr class="memdesc:aae42b94ab2ecf729f29f101222e97666 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt on DIO1 to be sent on a specific IRQ bit (e.g. RxTimeout, CadDone). NOTE: Unlike other modules that support IRQ abstraction (<a class="el" href="class_s_x126x.html" title="Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...">SX126x</a>, <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>, etc.), <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> cannot configure multiple IRQs to signal using the same DIOx pin. This method tries to configure IRQs in a "best effort" approach, and will skip conflicting flags. RADIOLIB_ERR_INVALID_IRQ will be returned in this case. <br /></td></tr>
|
|
<tr class="separator:aae42b94ab2ecf729f29f101222e97666 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa3eae13a7f0558c1bc881abebd958242 inherit pub_methods_class_s_x127x" id="r_aa3eae13a7f0558c1bc881abebd958242"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#aa3eae13a7f0558c1bc881abebd958242">clearIrqFlags</a> (uint32_t irq) override</td></tr>
|
|
<tr class="memdesc:aa3eae13a7f0558c1bc881abebd958242 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone). <br /></td></tr>
|
|
<tr class="separator:aa3eae13a7f0558c1bc881abebd958242 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab531ad461b250a060e92d9c744e79070 inherit pub_methods_class_s_x127x" id="r_ab531ad461b250a060e92d9c744e79070"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#ab531ad461b250a060e92d9c744e79070">setCrcFiltering</a> (bool enable=true)</td></tr>
|
|
<tr class="memdesc:ab531ad461b250a060e92d9c744e79070 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Enable CRC filtering and generation. <br /></td></tr>
|
|
<tr class="separator:ab531ad461b250a060e92d9c744e79070 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3955f85f456edae772a51025a19029b inherit pub_methods_class_s_x127x" id="r_ad3955f85f456edae772a51025a19029b"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#ad3955f85f456edae772a51025a19029b">setRSSIConfig</a> (uint8_t smoothingSamples, int8_t offset=0)</td></tr>
|
|
<tr class="memdesc:ad3955f85f456edae772a51025a19029b inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets RSSI measurement configuration in FSK mode. <br /></td></tr>
|
|
<tr class="separator:ad3955f85f456edae772a51025a19029b inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abad2d455012bd28d304589c8164390eb inherit pub_methods_class_s_x127x" id="r_abad2d455012bd28d304589c8164390eb"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#abad2d455012bd28d304589c8164390eb">setEncoding</a> (uint8_t encoding) override</td></tr>
|
|
<tr class="memdesc:abad2d455012bd28d304589c8164390eb inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER and RADIOLIB_ENCODING_WHITENING. <br /></td></tr>
|
|
<tr class="separator:abad2d455012bd28d304589c8164390eb inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac5d2ddb517e474a699b4539653b3754d inherit pub_methods_class_s_x127x" id="r_ac5d2ddb517e474a699b4539653b3754d"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#ac5d2ddb517e474a699b4539653b3754d">getIRQFlags</a> ()</td></tr>
|
|
<tr class="memdesc:ac5d2ddb517e474a699b4539653b3754d inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Reads currently active IRQ flags, can be used to check which event caused an interrupt. In LoRa mode, this is the content of SX127X_REG_IRQ_FLAGS register. In FSK mode, this is the contents of SX127X_REG_IRQ_FLAGS_2 (MSB) and SX127X_REG_IRQ_FLAGS_1 (LSB) registers. <br /></td></tr>
|
|
<tr class="separator:ac5d2ddb517e474a699b4539653b3754d inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2cf6a5bd8f3257f98ee4f250cbdf8bdc inherit pub_methods_class_s_x127x" id="r_a2cf6a5bd8f3257f98ee4f250cbdf8bdc"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a2cf6a5bd8f3257f98ee4f250cbdf8bdc">getModemStatus</a> ()</td></tr>
|
|
<tr class="memdesc:a2cf6a5bd8f3257f98ee4f250cbdf8bdc inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Reads modem status. Only available in LoRa mode. <br /></td></tr>
|
|
<tr class="separator:a2cf6a5bd8f3257f98ee4f250cbdf8bdc inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a95bc32a555675879ad9e2a9e399dc6c1 inherit pub_methods_class_s_x127x" id="r_a95bc32a555675879ad9e2a9e399dc6c1"><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a95bc32a555675879ad9e2a9e399dc6c1">getTempRaw</a> ()</td></tr>
|
|
<tr class="memdesc:a95bc32a555675879ad9e2a9e399dc6c1 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Reads uncalibrated temperature value. This function will change operating mode and should not be called during Tx, Rx or CAD. <br /></td></tr>
|
|
<tr class="separator:a95bc32a555675879ad9e2a9e399dc6c1 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8ca9edcae05060cce3ff7ee58faeb4e2 inherit pub_methods_class_s_x127x" id="r_a8ca9edcae05060cce3ff7ee58faeb4e2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a8ca9edcae05060cce3ff7ee58faeb4e2">setRfSwitchPins</a> (uint32_t rxEn, uint32_t txEn)</td></tr>
|
|
<tr class="memdesc:a8ca9edcae05060cce3ff7ee58faeb4e2 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over those pins to automatically switch between various modes: When idle both pins will be LOW, during TX the <code>txEn</code> pin will be HIGH, during RX the <code>rxPin</code> will be HIGH. <br /></td></tr>
|
|
<tr class="separator:a8ca9edcae05060cce3ff7ee58faeb4e2 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9625a5246a45112267ce441ac2de254 inherit pub_methods_class_s_x127x" id="r_ab9625a5246a45112267ce441ac2de254"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#ab9625a5246a45112267ce441ac2de254">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:ab9625a5246a45112267ce441ac2de254 inherit pub_methods_class_s_x127x"><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:ab9625a5246a45112267ce441ac2de254 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9877550ed7881be06d00ea190f230fb9 inherit pub_methods_class_s_x127x" id="r_a9877550ed7881be06d00ea190f230fb9"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a9877550ed7881be06d00ea190f230fb9">randomByte</a> () override</td></tr>
|
|
<tr class="memdesc:a9877550ed7881be06d00ea190f230fb9 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Get one truly random byte from RSSI noise. <br /></td></tr>
|
|
<tr class="separator:a9877550ed7881be06d00ea190f230fb9 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee5324d7d854e7a2f6768221d4f362cd inherit pub_methods_class_s_x127x" id="r_aee5324d7d854e7a2f6768221d4f362cd"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#aee5324d7d854e7a2f6768221d4f362cd">getChipVersion</a> ()</td></tr>
|
|
<tr class="memdesc:aee5324d7d854e7a2f6768221d4f362cd inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Read version SPI register. Should return SX1278_CHIP_VERSION (0x12) or SX1272_CHIP_VERSION (0x22) if <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> is connected and working. <br /></td></tr>
|
|
<tr class="separator:aee5324d7d854e7a2f6768221d4f362cd inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a363a436978ba990e1bf7d73f648ad7e9 inherit pub_methods_class_s_x127x" id="r_a363a436978ba990e1bf7d73f648ad7e9"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a363a436978ba990e1bf7d73f648ad7e9">invertIQ</a> (bool enable) override</td></tr>
|
|
<tr class="memdesc:a363a436978ba990e1bf7d73f648ad7e9 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable inversion of the I and Q signals. <br /></td></tr>
|
|
<tr class="separator:a363a436978ba990e1bf7d73f648ad7e9 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a333a9004cc05ff8aba2e9610db31109d inherit pub_methods_class_s_x127x" id="r_a333a9004cc05ff8aba2e9610db31109d"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a333a9004cc05ff8aba2e9610db31109d">getModem</a> (ModemType_t *modem) override</td></tr>
|
|
<tr class="memdesc:a333a9004cc05ff8aba2e9610db31109d inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Get modem currently in use by the radio. <br /></td></tr>
|
|
<tr class="separator:a333a9004cc05ff8aba2e9610db31109d inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3bd7fb49a3b27707aff6636ff6dee550 inherit pub_methods_class_s_x127x" id="r_a3bd7fb49a3b27707aff6636ff6dee550"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a3bd7fb49a3b27707aff6636ff6dee550">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:a3bd7fb49a3b27707aff6636ff6dee550 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Stage mode of the radio to be launched later using launchMode. <br /></td></tr>
|
|
<tr class="separator:a3bd7fb49a3b27707aff6636ff6dee550 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a538b43314081e8b3eda95e0011d1e5b9 inherit pub_methods_class_s_x127x" id="r_a538b43314081e8b3eda95e0011d1e5b9"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a538b43314081e8b3eda95e0011d1e5b9">launchMode</a> () override</td></tr>
|
|
<tr class="memdesc:a538b43314081e8b3eda95e0011d1e5b9 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Launch previously staged mode. <br /></td></tr>
|
|
<tr class="separator:a538b43314081e8b3eda95e0011d1e5b9 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae4b99d1bc67ac2c81eeb11dd6793a8c5 inherit pub_methods_class_s_x127x" id="r_ae4b99d1bc67ac2c81eeb11dd6793a8c5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#ae4b99d1bc67ac2c81eeb11dd6793a8c5">setDirectAction</a> (void(*func)(void)) override</td></tr>
|
|
<tr class="memdesc:ae4b99d1bc67ac2c81eeb11dd6793a8c5 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt service routine function to call when data bit is received in direct mode. <br /></td></tr>
|
|
<tr class="separator:ae4b99d1bc67ac2c81eeb11dd6793a8c5 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e149fac59b3accbc9550bf605d6bbf0 inherit pub_methods_class_s_x127x" id="r_a0e149fac59b3accbc9550bf605d6bbf0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a0e149fac59b3accbc9550bf605d6bbf0">readBit</a> (uint32_t pin) override</td></tr>
|
|
<tr class="memdesc:a0e149fac59b3accbc9550bf605d6bbf0 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Function to read and process data bit in direct reception mode. <br /></td></tr>
|
|
<tr class="separator:a0e149fac59b3accbc9550bf605d6bbf0 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f04a7e883057908df18f06c7f74c7e1 inherit pub_methods_class_s_x127x" id="r_a7f04a7e883057908df18f06c7f74c7e1"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a7f04a7e883057908df18f06c7f74c7e1">setFHSSHoppingPeriod</a> (uint8_t freqHoppingPeriod)</td></tr>
|
|
<tr class="memdesc:a7f04a7e883057908df18f06c7f74c7e1 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets the hopping period and enables FHSS. <br /></td></tr>
|
|
<tr class="separator:a7f04a7e883057908df18f06c7f74c7e1 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7600b8b0aac4d8a5e962d631145b617 inherit pub_methods_class_s_x127x" id="r_ad7600b8b0aac4d8a5e962d631145b617"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#ad7600b8b0aac4d8a5e962d631145b617">getFHSSHoppingPeriod</a> (void)</td></tr>
|
|
<tr class="memdesc:ad7600b8b0aac4d8a5e962d631145b617 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Gets FHSS hopping period. <br /></td></tr>
|
|
<tr class="separator:ad7600b8b0aac4d8a5e962d631145b617 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a56340d1bdc69b3efc64636be39445a9c inherit pub_methods_class_s_x127x" id="r_a56340d1bdc69b3efc64636be39445a9c"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a56340d1bdc69b3efc64636be39445a9c">getFHSSChannel</a> (void)</td></tr>
|
|
<tr class="memdesc:a56340d1bdc69b3efc64636be39445a9c inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Gets the FHSS channel in use. <br /></td></tr>
|
|
<tr class="separator:a56340d1bdc69b3efc64636be39445a9c inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41089d9e5b45217d3e31ac22b5326b66 inherit pub_methods_class_s_x127x" id="r_a41089d9e5b45217d3e31ac22b5326b66"><td class="memItemLeft" align="right" valign="top">
|
|
void </td><td class="memItemRight" valign="bottom"><b>clearFHSSInt</b> (void)</td></tr>
|
|
<tr class="memdesc:a41089d9e5b45217d3e31ac22b5326b66 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Clear the FHSS interrupt. <br /></td></tr>
|
|
<tr class="separator:a41089d9e5b45217d3e31ac22b5326b66 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7d373bc93e99790912cebe8d5ae6403 inherit pub_methods_class_s_x127x" id="r_af7d373bc93e99790912cebe8d5ae6403"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#af7d373bc93e99790912cebe8d5ae6403">setDIOMapping</a> (uint32_t pin, uint32_t value) override</td></tr>
|
|
<tr class="memdesc:af7d373bc93e99790912cebe8d5ae6403 inherit pub_methods_class_s_x127x"><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:af7d373bc93e99790912cebe8d5ae6403 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b85344084b800966a46ace59dcb5277 inherit pub_methods_class_s_x127x" id="r_a7b85344084b800966a46ace59dcb5277"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a7b85344084b800966a46ace59dcb5277">setDIOPreambleDetect</a> (bool usePreambleDetect)</td></tr>
|
|
<tr class="memdesc:a7b85344084b800966a46ace59dcb5277 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Configure DIO mapping to use RSSI or Preamble Detect for pins that support it. <br /></td></tr>
|
|
<tr class="separator:a7b85344084b800966a46ace59dcb5277 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5094d0f471aaa428167816d1ac30bb76 inherit pub_methods_class_s_x127x" id="r_a5094d0f471aaa428167816d1ac30bb76"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a5094d0f471aaa428167816d1ac30bb76">setRSSIThreshold</a> (float dbm)</td></tr>
|
|
<tr class="memdesc:a5094d0f471aaa428167816d1ac30bb76 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets the RSSI value above which the RSSI interrupt is signaled. <br /></td></tr>
|
|
<tr class="separator:a5094d0f471aaa428167816d1ac30bb76 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ca9aa18e13e8390ec437e249e1d2472 inherit pub_methods_class_s_x127x" id="r_a9ca9aa18e13e8390ec437e249e1d2472"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a9ca9aa18e13e8390ec437e249e1d2472">setLowBatteryThreshold</a> (int8_t level, uint32_t pin=RADIOLIB_NC)</td></tr>
|
|
<tr class="memdesc:a9ca9aa18e13e8390ec437e249e1d2472 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Set low battery indicator threshold. <br /></td></tr>
|
|
<tr class="separator:a9ca9aa18e13e8390ec437e249e1d2472 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_s_x127x" id="r_a492b2d057dd803c3884fa1adc8e22534"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a492b2d057dd803c3884fa1adc8e22534">transmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">C-string transmit method. <br /></td></tr>
|
|
<tr class="separator:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ada508497ee2e70170da3afe078e2fe0e inherit pub_methods_class_s_x127x" id="r_ada508497ee2e70170da3afe078e2fe0e"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#ada508497ee2e70170da3afe078e2fe0e">transmit</a> (const uint8_t *data, size_t len, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:ada508497ee2e70170da3afe078e2fe0e inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Binary transmit method. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:ada508497ee2e70170da3afe078e2fe0e inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab82617fa3fa9f21d4cd427314ecc4af8 inherit pub_methods_class_s_x127x" id="r_ab82617fa3fa9f21d4cd427314ecc4af8"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#ab82617fa3fa9f21d4cd427314ecc4af8">receive</a> (uint8_t *data, size_t len)</td></tr>
|
|
<tr class="memdesc:ab82617fa3fa9f21d4cd427314ecc4af8 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Binary receive method. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:ab82617fa3fa9f21d4cd427314ecc4af8 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_s_x127x" id="r_a923654706eff5118ef6e84214e837f27"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a923654706eff5118ef6e84214e837f27">startTransmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_s_x127x"><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_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af79757dbbd62e080c1bad2e608ab940c inherit pub_methods_class_s_x127x" id="r_af79757dbbd62e080c1bad2e608ab940c"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#af79757dbbd62e080c1bad2e608ab940c">startTransmit</a> (const uint8_t *data, size_t len, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:af79757dbbd62e080c1bad2e608ab940c inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven binary transmit method. <br /></td></tr>
|
|
<tr class="separator:af79757dbbd62e080c1bad2e608ab940c inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a18664ad615c5507ff1690baaca90b094 inherit pub_methods_class_s_x127x" id="r_a18664ad615c5507ff1690baaca90b094"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a18664ad615c5507ff1690baaca90b094">startReceive</a> ()</td></tr>
|
|
<tr class="memdesc:a18664ad615c5507ff1690baaca90b094 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Sets module to received mode using its default configuration. <br /></td></tr>
|
|
<tr class="separator:a18664ad615c5507ff1690baaca90b094 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae93500dfbcfd39837e04c0f3eaa40d97 inherit pub_methods_class_s_x127x" id="r_ae93500dfbcfd39837e04c0f3eaa40d97"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.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 inherit pub_methods_class_s_x127x"><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 inherit pub_methods_class_s_x127x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3563453988a83d22dd07d4691543a300 inherit pub_methods_class_s_x127x" id="r_a3563453988a83d22dd07d4691543a300"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x127x.html#a3563453988a83d22dd07d4691543a300">readData</a> (uint8_t *data, size_t len)</td></tr>
|
|
<tr class="memdesc:a3563453988a83d22dd07d4691543a300 inherit pub_methods_class_s_x127x"><td class="mdescLeft"> </td><td class="mdescRight">Reads data that was received after calling startReceive method. <br /></td></tr>
|
|
<tr class="separator:a3563453988a83d22dd07d4691543a300 inherit pub_methods_class_s_x127x"><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: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: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:a82a52062d9259c2c546d7bf8072b7a72 inherit pub_methods_class_physical_layer" id="r_a82a52062d9259c2c546d7bf8072b7a72"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a82a52062d9259c2c546d7bf8072b7a72">startChannelScan</a> (const <a class="el" href="union_channel_scan_config__t.html">ChannelScanConfig_t</a> &config)</td></tr>
|
|
<tr class="memdesc:a82a52062d9259c2c546d7bf8072b7a72 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven channel activity detection method. interrupt will be activated when packet is detected. Must be implemented in module class. <br /></td></tr>
|
|
<tr class="separator:a82a52062d9259c2c546d7bf8072b7a72 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af788cf83ceb0222cd0fa4a1323b9041b inherit pub_methods_class_physical_layer" id="r_af788cf83ceb0222cd0fa4a1323b9041b"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#af788cf83ceb0222cd0fa4a1323b9041b">scanChannel</a> (const <a class="el" href="union_channel_scan_config__t.html">ChannelScanConfig_t</a> &config)</td></tr>
|
|
<tr class="memdesc:af788cf83ceb0222cd0fa4a1323b9041b inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules, or RSSI measurement for FSK modules. <br /></td></tr>
|
|
<tr class="separator:af788cf83ceb0222cd0fa4a1323b9041b 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: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>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
|
|
Additional Inherited Members</h2></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>Derived class for SX1273 modules. Overrides some methods from <a class="el" href="class_s_x1272.html" title="Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic...">SX1272</a> due to different parameter ranges. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="ad0387b22d6dcc876bc5f85174714149b" name="ad0387b22d6dcc876bc5f85174714149b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad0387b22d6dcc876bc5f85174714149b">◆ </a></span>SX1273()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">SX1273::SX1273 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_module.html">Module</a> * </td>
|
|
<td class="paramname"><em>mod</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. Called from Arduino sketch when creating new LoRa instance. </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 LoRa chip. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a61844a7f08f7aadac00cf6617f991191" name="a61844a7f08f7aadac00cf6617f991191"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a61844a7f08f7aadac00cf6617f991191">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX1273::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freq</em> = <code>915.0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>bw</em> = <code>125.0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>sf</em> = <code>9</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>cr</em> = <code>7</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>syncWord</em> = <code>RADIOLIB_SX127X_SYNC_WORD</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int8_t </td>
|
|
<td class="paramname"><em>power</em> = <code>10</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>preambleLength</em> = <code>8</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>gain</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>LoRa modem initialization method. Must be called at least once from Arduino sketch to initialize the module. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">freq</td><td>Carrier frequency in MHz. Allowed values range from 860.0 MHz to 1020.0 MHz. </td></tr>
|
|
<tr><td class="paramname">bw</td><td>LoRa link bandwidth in kHz. Allowed values are 125, 250 and 500 kHz. </td></tr>
|
|
<tr><td class="paramname">sf</td><td>LoRa link spreading factor. Allowed values range from 6 to 9. </td></tr>
|
|
<tr><td class="paramname">cr</td><td>LoRa link coding rate denominator. Allowed values range from 5 to 8. </td></tr>
|
|
<tr><td class="paramname">syncWord</td><td>LoRa sync word. Can be used to distinguish different networks. Note that value 0x34 is reserved for LoRaWAN networks. </td></tr>
|
|
<tr><td class="paramname">power</td><td>Transmission output power in dBm. Allowed values range from 2 to 17 dBm. </td></tr>
|
|
<tr><td class="paramname">preambleLength</td><td>Length of LoRa transmission preamble in symbols. The actual preamble length is 4.25 symbols longer than the set number. Allowed values range from 6 to 65535. </td></tr>
|
|
<tr><td class="paramname">gain</td><td>Gain of receiver LNA (low-noise amplifier). Can be set to any integer in range 1 to 6 where 1 is the highest gain. Set to 0 to enable automatic gain control (recommended). </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_s_x1272.html#ae7562fe74e7d97bf9cc52b5d63f608f9">SX1272</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5eae1e82596f3a6c4c926c381c2737a7" name="a5eae1e82596f3a6c4c926c381c2737a7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5eae1e82596f3a6c4c926c381c2737a7">◆ </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 SX1273::checkDataRate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="union_data_rate__t.html">DataRate_t</a> </td>
|
|
<td class="paramname"><em>dr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check the data rate can be configured by this module. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dr</td><td>Data rate struct. Interpretation depends on currently active modem (FSK or LoRa). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_s_x1272.html#a2a36487740f15731c6e508428e4b11f0">SX1272</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acaffc772f70e7db371cbe736dc4a19ab" name="acaffc772f70e7db371cbe736dc4a19ab"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acaffc772f70e7db371cbe736dc4a19ab">◆ </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 SX1273::setDataRate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="union_data_rate__t.html">DataRate_t</a> </td>
|
|
<td class="paramname"><em>dr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set data. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dr</td><td>Data rate struct. Interpretation depends on currently active modem (FSK or LoRa). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_s_x1272.html#a5b79b7cd20c4c3cd1f486f777b3457d1">SX1272</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af9f0969764fde3e12b6b05409718fa83" name="af9f0969764fde3e12b6b05409718fa83"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af9f0969764fde3e12b6b05409718fa83">◆ </a></span>setModem()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX1273::setModem </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ModemType_t </td>
|
|
<td class="paramname"><em>modem</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set modem for the radio to use. Will perform full reset and reconfigure the radio using its default parameters. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">modem</td><td>Modem type to set - FSK or LoRa. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_s_x1272.html#a2c99afea2bb3bbb1146c8a4536b4843c">SX1272</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac714448cb245ec57fa6f2395f1c8a1f7" name="ac714448cb245ec57fa6f2395f1c8a1f7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac714448cb245ec57fa6f2395f1c8a1f7">◆ </a></span>setSpreadingFactor()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t SX1273::setSpreadingFactor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>sf</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 LoRa link spreading factor. Allowed values range from 6 to 9. Only available in LoRa mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sf</td><td>LoRa link spreading factor to be set. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_s_x1272.html#a82084ac58502c83d2ada998410307490">SX1272</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/modules/SX127x/<a class="el" href="_s_x1273_8h_source.html">SX1273.h</a></li>
|
|
<li>src/modules/SX127x/<b>SX1273.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_s_x1273.html">SX1273</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>
|