406 lines
72 KiB
HTML
406 lines
72 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: SX1281 Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">RadioLib
|
|
</div>
|
|
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('class_s_x1281.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_s_x1281-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">SX1281 Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Derived class for SX1281 modules.
|
|
<a href="class_s_x1281.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_s_x1281_8h_source.html">SX1281.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for SX1281:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_s_x1281.png" usemap="#SX1281_map" alt=""/>
|
|
<map id="SX1281_map" name="SX1281_map">
|
|
<area href="class_s_x128x.html" title="Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from thi..." alt="SX128x" 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"/>
|
|
<area href="class_s_x1280.html" title="Derived class for SX1280 modules." alt="SX1280" shape="rect" coords="0,168,93,192"/>
|
|
<area href="class_s_x1282.html" title="Derived class for SX1282 modules." alt="SX1282" shape="rect" coords="0,224,93,248"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a0dd7678cdf7fad9ecfc9139c5092f998"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x1281.html#a0dd7678cdf7fad9ecfc9139c5092f998">SX1281</a> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
|
<tr class="memdesc:a0dd7678cdf7fad9ecfc9139c5092f998"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_s_x1281.html#a0dd7678cdf7fad9ecfc9139c5092f998">More...</a><br /></td></tr>
|
|
<tr class="separator:a0dd7678cdf7fad9ecfc9139c5092f998"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_s_x128x"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_s_x128x')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_s_x128x.html">SX128x</a></td></tr>
|
|
<tr class="memitem:a9ccbf51f8304f1041c8eef182be547a7 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a9ccbf51f8304f1041c8eef182be547a7">SX128x</a> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
|
<tr class="memdesc:a9ccbf51f8304f1041c8eef182be547a7 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_s_x128x.html#a9ccbf51f8304f1041c8eef182be547a7">More...</a><br /></td></tr>
|
|
<tr class="separator:a9ccbf51f8304f1041c8eef182be547a7 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a69ee7379f4b79abf626df186b2db6441 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top"><a id="a69ee7379f4b79abf626df186b2db6441"></a>
|
|
<a class="el" href="class_module.html">Module</a> * </td><td class="memItemRight" valign="bottom"><b>getMod</b> ()</td></tr>
|
|
<tr class="separator:a69ee7379f4b79abf626df186b2db6441 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acbd0d1a48051ccd35f4a89c9b8d05bdf inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#acbd0d1a48051ccd35f4a89c9b8d05bdf">begin</a> (float freq=2400.0, float bw=812.5, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX128X_SYNC_WORD_PRIVATE, int8_t power=10, uint16_t preambleLength=12)</td></tr>
|
|
<tr class="memdesc:acbd0d1a48051ccd35f4a89c9b8d05bdf inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for LoRa modem. <a href="class_s_x128x.html#acbd0d1a48051ccd35f4a89c9b8d05bdf">More...</a><br /></td></tr>
|
|
<tr class="separator:acbd0d1a48051ccd35f4a89c9b8d05bdf inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8dd8ce38bc9d0d8dbd711b373e864e93 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a8dd8ce38bc9d0d8dbd711b373e864e93">beginGFSK</a> (float freq=2400.0, uint16_t br=800, float freqDev=400.0, int8_t power=10, uint16_t preambleLength=16)</td></tr>
|
|
<tr class="memdesc:a8dd8ce38bc9d0d8dbd711b373e864e93 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for GFSK modem. <a href="class_s_x128x.html#a8dd8ce38bc9d0d8dbd711b373e864e93">More...</a><br /></td></tr>
|
|
<tr class="separator:a8dd8ce38bc9d0d8dbd711b373e864e93 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a316340d7ba2a6e7cb5742e3ff21e728c inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a316340d7ba2a6e7cb5742e3ff21e728c">beginBLE</a> (float freq=2400.0, uint16_t br=800, float freqDev=400.0, int8_t power=10, uint8_t dataShaping=<a class="el" href="group__config__shaping.html#gaa778d14c29d21fe329137a28a3f54a5d">RADIOLIB_SHAPING_0_5</a>)</td></tr>
|
|
<tr class="memdesc:a316340d7ba2a6e7cb5742e3ff21e728c inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for BLE modem. <a href="class_s_x128x.html#a316340d7ba2a6e7cb5742e3ff21e728c">More...</a><br /></td></tr>
|
|
<tr class="separator:a316340d7ba2a6e7cb5742e3ff21e728c inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7df67afbb0b1a88daf5ec50f3d65660 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#ac7df67afbb0b1a88daf5ec50f3d65660">beginFLRC</a> (float freq=2400.0, uint16_t br=650, uint8_t cr=3, int8_t power=10, uint16_t preambleLength=16, uint8_t dataShaping=<a class="el" href="group__config__shaping.html#gaa778d14c29d21fe329137a28a3f54a5d">RADIOLIB_SHAPING_0_5</a>)</td></tr>
|
|
<tr class="memdesc:ac7df67afbb0b1a88daf5ec50f3d65660 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for FLRC modem. <a href="class_s_x128x.html#ac7df67afbb0b1a88daf5ec50f3d65660">More...</a><br /></td></tr>
|
|
<tr class="separator:ac7df67afbb0b1a88daf5ec50f3d65660 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2643ce22176293631fea2169f5e68e66 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a2643ce22176293631fea2169f5e68e66">reset</a> (bool verify=true)</td></tr>
|
|
<tr class="memdesc:a2643ce22176293631fea2169f5e68e66 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Reset method. Will reset the chip to the default state using RST pin. <a href="class_s_x128x.html#a2643ce22176293631fea2169f5e68e66">More...</a><br /></td></tr>
|
|
<tr class="separator:a2643ce22176293631fea2169f5e68e66 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af253e1e45361de74aefd01a7c73c28f5 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#af253e1e45361de74aefd01a7c73c28f5">transmit</a> (uint8_t *data, size_t len, uint8_t addr=0) override</td></tr>
|
|
<tr class="memdesc:af253e1e45361de74aefd01a7c73c28f5 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Blocking binary transmit method. Overloads for string-based transmissions are implemented in <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a>. <a href="class_s_x128x.html#af253e1e45361de74aefd01a7c73c28f5">More...</a><br /></td></tr>
|
|
<tr class="separator:af253e1e45361de74aefd01a7c73c28f5 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a32b7b674d63c36f15b7f58a2cb837a99 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a32b7b674d63c36f15b7f58a2cb837a99">receive</a> (uint8_t *data, size_t len) override</td></tr>
|
|
<tr class="memdesc:a32b7b674d63c36f15b7f58a2cb837a99 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Blocking binary receive method. Overloads for string-based transmissions are implemented in <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a>. <a href="class_s_x128x.html#a32b7b674d63c36f15b7f58a2cb837a99">More...</a><br /></td></tr>
|
|
<tr class="separator:a32b7b674d63c36f15b7f58a2cb837a99 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a53892566b0259d348158efe3c3c3601a inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a53892566b0259d348158efe3c3c3601a">transmitDirect</a> (uint32_t frf=0) override</td></tr>
|
|
<tr class="memdesc:a53892566b0259d348158efe3c3c3601a inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Starts direct mode transmission. <a href="class_s_x128x.html#a53892566b0259d348158efe3c3c3601a">More...</a><br /></td></tr>
|
|
<tr class="separator:a53892566b0259d348158efe3c3c3601a inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff7d86352c98771595375e17d19a2a97 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#aff7d86352c98771595375e17d19a2a97">receiveDirect</a> () override</td></tr>
|
|
<tr class="memdesc:aff7d86352c98771595375e17d19a2a97 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Starts direct mode reception. Only implemented for <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a> compatibility, as SX128x series does not support direct mode reception. Will always return RADIOLIB_ERR_UNKNOWN. <a href="class_s_x128x.html#aff7d86352c98771595375e17d19a2a97">More...</a><br /></td></tr>
|
|
<tr class="separator:aff7d86352c98771595375e17d19a2a97 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a89cc916f5cd5cdfbd331bb15f8a3d5cb inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a89cc916f5cd5cdfbd331bb15f8a3d5cb">scanChannel</a> ()</td></tr>
|
|
<tr class="memdesc:a89cc916f5cd5cdfbd331bb15f8a3d5cb inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. <a href="class_s_x128x.html#a89cc916f5cd5cdfbd331bb15f8a3d5cb">More...</a><br /></td></tr>
|
|
<tr class="separator:a89cc916f5cd5cdfbd331bb15f8a3d5cb inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d15e13e15b060ddbbe84257d5fcb66f inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a1d15e13e15b060ddbbe84257d5fcb66f">sleep</a> (bool retainConfig=true)</td></tr>
|
|
<tr class="memdesc:a1d15e13e15b060ddbbe84257d5fcb66f inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets the module to sleep mode. <a href="class_s_x128x.html#a1d15e13e15b060ddbbe84257d5fcb66f">More...</a><br /></td></tr>
|
|
<tr class="separator:a1d15e13e15b060ddbbe84257d5fcb66f inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2be8cc6c3b61b59cb6a6ca4f6a030b45 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a2be8cc6c3b61b59cb6a6ca4f6a030b45">standby</a> () override</td></tr>
|
|
<tr class="memdesc:a2be8cc6c3b61b59cb6a6ca4f6a030b45 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets the module to standby mode (overload for <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a> compatibility, uses 13 MHz RC oscillator). <a href="class_s_x128x.html#a2be8cc6c3b61b59cb6a6ca4f6a030b45">More...</a><br /></td></tr>
|
|
<tr class="separator:a2be8cc6c3b61b59cb6a6ca4f6a030b45 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa11ba80f0cebb3e6927c775ad5f96b4e inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#aa11ba80f0cebb3e6927c775ad5f96b4e">standby</a> (uint8_t mode)</td></tr>
|
|
<tr class="memdesc:aa11ba80f0cebb3e6927c775ad5f96b4e inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets the module to standby mode. <a href="class_s_x128x.html#aa11ba80f0cebb3e6927c775ad5f96b4e">More...</a><br /></td></tr>
|
|
<tr class="separator:aa11ba80f0cebb3e6927c775ad5f96b4e inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0759fb31b3ce5bf1c832259c9c2245ed inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a0759fb31b3ce5bf1c832259c9c2245ed">setDio1Action</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:a0759fb31b3ce5bf1c832259c9c2245ed inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when DIO1 activates. <a href="class_s_x128x.html#a0759fb31b3ce5bf1c832259c9c2245ed">More...</a><br /></td></tr>
|
|
<tr class="separator:a0759fb31b3ce5bf1c832259c9c2245ed inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab8a3fe8e2843fa039ef369668f1a423f inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top"><a id="ab8a3fe8e2843fa039ef369668f1a423f"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#ab8a3fe8e2843fa039ef369668f1a423f">clearDio1Action</a> ()</td></tr>
|
|
<tr class="memdesc:ab8a3fe8e2843fa039ef369668f1a423f inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when DIO1 activates. <br /></td></tr>
|
|
<tr class="separator:ab8a3fe8e2843fa039ef369668f1a423f inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aef221e7d463c5228ce00ed6934512848 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#aef221e7d463c5228ce00ed6934512848">startTransmit</a> (uint8_t *data, size_t len, uint8_t addr=0) override</td></tr>
|
|
<tr class="memdesc:aef221e7d463c5228ce00ed6934512848 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven binary transmit method. Overloads for string-based transmissions are implemented in <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a>. <a href="class_s_x128x.html#aef221e7d463c5228ce00ed6934512848">More...</a><br /></td></tr>
|
|
<tr class="separator:aef221e7d463c5228ce00ed6934512848 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4587409a9b96a0c496cf12b3acac20c4 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a4587409a9b96a0c496cf12b3acac20c4">finishTransmit</a> () override</td></tr>
|
|
<tr class="memdesc:a4587409a9b96a0c496cf12b3acac20c4 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Clean up after transmission is done. <a href="class_s_x128x.html#a4587409a9b96a0c496cf12b3acac20c4">More...</a><br /></td></tr>
|
|
<tr class="separator:a4587409a9b96a0c496cf12b3acac20c4 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8530aaeacc4c12736ce5aa5b5460ee19 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a8530aaeacc4c12736ce5aa5b5460ee19">startReceive</a> (uint16_t timeout=RADIOLIB_SX128X_RX_TIMEOUT_INF, uint16_t irqFlags=RADIOLIB_SX128X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX128X_IRQ_RX_DONE, size_t len=0)</td></tr>
|
|
<tr class="memdesc:a8530aaeacc4c12736ce5aa5b5460ee19 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven receive method. DIO1 will be activated when full packet is received. <a href="class_s_x128x.html#a8530aaeacc4c12736ce5aa5b5460ee19">More...</a><br /></td></tr>
|
|
<tr class="separator:a8530aaeacc4c12736ce5aa5b5460ee19 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1f933f767161cc59fdaca816ab93e22 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#ae1f933f767161cc59fdaca816ab93e22">getIrqStatus</a> ()</td></tr>
|
|
<tr class="memdesc:ae1f933f767161cc59fdaca816ab93e22 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Reads the current IRQ status. <a href="class_s_x128x.html#ae1f933f767161cc59fdaca816ab93e22">More...</a><br /></td></tr>
|
|
<tr class="separator:ae1f933f767161cc59fdaca816ab93e22 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94bca43258b09217fb476a2d8db784bb inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a94bca43258b09217fb476a2d8db784bb">readData</a> (uint8_t *data, size_t len) override</td></tr>
|
|
<tr class="memdesc:a94bca43258b09217fb476a2d8db784bb inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Reads data received after calling startReceive method. <a href="class_s_x128x.html#a94bca43258b09217fb476a2d8db784bb">More...</a><br /></td></tr>
|
|
<tr class="separator:a94bca43258b09217fb476a2d8db784bb inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2043ef7bb806968b9d9dcb64561ca371 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a2043ef7bb806968b9d9dcb64561ca371">setFrequency</a> (float freq)</td></tr>
|
|
<tr class="memdesc:a2043ef7bb806968b9d9dcb64561ca371 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets carrier frequency. Allowed values are in range from 2400.0 to 2500.0 MHz. <a href="class_s_x128x.html#a2043ef7bb806968b9d9dcb64561ca371">More...</a><br /></td></tr>
|
|
<tr class="separator:a2043ef7bb806968b9d9dcb64561ca371 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae93c99c85deb950fe9bc7101142b5f6a inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#ae93c99c85deb950fe9bc7101142b5f6a">setBandwidth</a> (float bw)</td></tr>
|
|
<tr class="memdesc:ae93c99c85deb950fe9bc7101142b5f6a inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets LoRa bandwidth. Allowed values are 203.125, 406.25, 812.5 and 1625.0 kHz. <a href="class_s_x128x.html#ae93c99c85deb950fe9bc7101142b5f6a">More...</a><br /></td></tr>
|
|
<tr class="separator:ae93c99c85deb950fe9bc7101142b5f6a inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae435f57132f76f4283abb870176acf54 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#ae435f57132f76f4283abb870176acf54">setSpreadingFactor</a> (uint8_t sf)</td></tr>
|
|
<tr class="memdesc:ae435f57132f76f4283abb870176acf54 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets LoRa spreading factor. Allowed values range from 5 to 12. <a href="class_s_x128x.html#ae435f57132f76f4283abb870176acf54">More...</a><br /></td></tr>
|
|
<tr class="separator:ae435f57132f76f4283abb870176acf54 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9da544e4a6120f73a078b46c6138505a inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a9da544e4a6120f73a078b46c6138505a">setCodingRate</a> (uint8_t cr, bool longInterleaving=false)</td></tr>
|
|
<tr class="memdesc:a9da544e4a6120f73a078b46c6138505a inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets LoRa coding rate denominator. Allowed values range from 5 to 8. <a href="class_s_x128x.html#a9da544e4a6120f73a078b46c6138505a">More...</a><br /></td></tr>
|
|
<tr class="separator:a9da544e4a6120f73a078b46c6138505a inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6e2b46c317a8d8512cf0380025147a9 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#ad6e2b46c317a8d8512cf0380025147a9">setOutputPower</a> (int8_t power)</td></tr>
|
|
<tr class="memdesc:ad6e2b46c317a8d8512cf0380025147a9 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets output power. Allowed values are in range from -18 to 13 dBm. <a href="class_s_x128x.html#ad6e2b46c317a8d8512cf0380025147a9">More...</a><br /></td></tr>
|
|
<tr class="separator:ad6e2b46c317a8d8512cf0380025147a9 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1984a405262f155f16a4759c5f6b0133 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a1984a405262f155f16a4759c5f6b0133">setPreambleLength</a> (uint32_t preambleLength)</td></tr>
|
|
<tr class="memdesc:a1984a405262f155f16a4759c5f6b0133 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets preamble length for currently active modem. Allowed values range from 1 to 65535. <a href="class_s_x128x.html#a1984a405262f155f16a4759c5f6b0133">More...</a><br /></td></tr>
|
|
<tr class="separator:a1984a405262f155f16a4759c5f6b0133 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a465ac114dbe6844069b5cb989f87c3ee inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a465ac114dbe6844069b5cb989f87c3ee">setBitRate</a> (float br)</td></tr>
|
|
<tr class="memdesc:a465ac114dbe6844069b5cb989f87c3ee inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK or FLRC bit rate. Allowed values are 125, 250, 400, 500, 800, 1000, 1600 and 2000 kbps (for FSK modem) or 260, 325, 520, 650, 1000 and 1300 (for FLRC modem). <a href="class_s_x128x.html#a465ac114dbe6844069b5cb989f87c3ee">More...</a><br /></td></tr>
|
|
<tr class="separator:a465ac114dbe6844069b5cb989f87c3ee inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a26d0d02e5e53a3172df9208fa343a3f1 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a26d0d02e5e53a3172df9208fa343a3f1">setFrequencyDeviation</a> (float freqDev) override</td></tr>
|
|
<tr class="memdesc:a26d0d02e5e53a3172df9208fa343a3f1 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK frequency deviation. Allowed values range from 0.0 to 3200.0 kHz. <a href="class_s_x128x.html#a26d0d02e5e53a3172df9208fa343a3f1">More...</a><br /></td></tr>
|
|
<tr class="separator:a26d0d02e5e53a3172df9208fa343a3f1 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99491c705e88dddc820f884b778f1660 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a99491c705e88dddc820f884b778f1660">setDataShaping</a> (uint8_t sh) override</td></tr>
|
|
<tr class="memdesc:a99491c705e88dddc820f884b778f1660 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPING_0_5 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping. <a href="class_s_x128x.html#a99491c705e88dddc820f884b778f1660">More...</a><br /></td></tr>
|
|
<tr class="separator:a99491c705e88dddc820f884b778f1660 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0efa595867624a54153d693d16f9f731 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a0efa595867624a54153d693d16f9f731">setSyncWord</a> (uint8_t *syncWord, uint8_t len)</td></tr>
|
|
<tr class="memdesc:a0efa595867624a54153d693d16f9f731 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets FSK/FLRC sync word in the form of array of up to 5 bytes (FSK). For FLRC modem, the sync word must be exactly 4 bytes long. <a href="class_s_x128x.html#a0efa595867624a54153d693d16f9f731">More...</a><br /></td></tr>
|
|
<tr class="separator:a0efa595867624a54153d693d16f9f731 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1bef6b6f3058be6b1681c78334342bc1 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a1bef6b6f3058be6b1681c78334342bc1">setSyncWord</a> (uint8_t syncWord, uint8_t controlBits=0x44)</td></tr>
|
|
<tr class="memdesc:a1bef6b6f3058be6b1681c78334342bc1 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets LoRa sync word. <a href="class_s_x128x.html#a1bef6b6f3058be6b1681c78334342bc1">More...</a><br /></td></tr>
|
|
<tr class="separator:a1bef6b6f3058be6b1681c78334342bc1 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4b1e0b96347011522e053f30202c0fe inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#aa4b1e0b96347011522e053f30202c0fe">setCRC</a> (uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)</td></tr>
|
|
<tr class="memdesc:aa4b1e0b96347011522e053f30202c0fe inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets CRC configuration. <a href="class_s_x128x.html#aa4b1e0b96347011522e053f30202c0fe">More...</a><br /></td></tr>
|
|
<tr class="separator:aa4b1e0b96347011522e053f30202c0fe inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b3eea268f21bf911b6eaf37c5eb0b5f inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a8b3eea268f21bf911b6eaf37c5eb0b5f">setWhitening</a> (bool enabled)</td></tr>
|
|
<tr class="memdesc:a8b3eea268f21bf911b6eaf37c5eb0b5f inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets whitening parameters, not available for LoRa or FLRC modem. <a href="class_s_x128x.html#a8b3eea268f21bf911b6eaf37c5eb0b5f">More...</a><br /></td></tr>
|
|
<tr class="separator:a8b3eea268f21bf911b6eaf37c5eb0b5f inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9346490a6c56edcff2e12ae0369a8df5 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a9346490a6c56edcff2e12ae0369a8df5">setAccessAddress</a> (uint32_t addr)</td></tr>
|
|
<tr class="memdesc:a9346490a6c56edcff2e12ae0369a8df5 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets BLE access address. <a href="class_s_x128x.html#a9346490a6c56edcff2e12ae0369a8df5">More...</a><br /></td></tr>
|
|
<tr class="separator:a9346490a6c56edcff2e12ae0369a8df5 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a73e3655e92bca9a06e2d0abbf1a4bed4 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a73e3655e92bca9a06e2d0abbf1a4bed4">setHighSensitivityMode</a> (bool hsm=false)</td></tr>
|
|
<tr class="memdesc:a73e3655e92bca9a06e2d0abbf1a4bed4 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables receiver high sensitivity mode. <a href="class_s_x128x.html#a73e3655e92bca9a06e2d0abbf1a4bed4">More...</a><br /></td></tr>
|
|
<tr class="separator:a73e3655e92bca9a06e2d0abbf1a4bed4 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3837662441a9eb3f0a71f4f667db9e91 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a3837662441a9eb3f0a71f4f667db9e91">setGainControl</a> (uint8_t gain=0)</td></tr>
|
|
<tr class="memdesc:a3837662441a9eb3f0a71f4f667db9e91 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables receiver manual gain control. <a href="class_s_x128x.html#a3837662441a9eb3f0a71f4f667db9e91">More...</a><br /></td></tr>
|
|
<tr class="separator:a3837662441a9eb3f0a71f4f667db9e91 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94d3003277925e2dc3372548b3311008 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a94d3003277925e2dc3372548b3311008">getRSSI</a> ()</td></tr>
|
|
<tr class="memdesc:a94d3003277925e2dc3372548b3311008 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. <a href="class_s_x128x.html#a94d3003277925e2dc3372548b3311008">More...</a><br /></td></tr>
|
|
<tr class="separator:a94d3003277925e2dc3372548b3311008 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a89ebf1f4f227cd35c0799c06d5d9c1d2 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a89ebf1f4f227cd35c0799c06d5d9c1d2">getSNR</a> ()</td></tr>
|
|
<tr class="memdesc:a89ebf1f4f227cd35c0799c06d5d9c1d2 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa or ranging modem. <a href="class_s_x128x.html#a89ebf1f4f227cd35c0799c06d5d9c1d2">More...</a><br /></td></tr>
|
|
<tr class="separator:a89ebf1f4f227cd35c0799c06d5d9c1d2 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b424000856a9dc212f571d0e8890635 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a2b424000856a9dc212f571d0e8890635">getFrequencyError</a> ()</td></tr>
|
|
<tr class="memdesc:a2b424000856a9dc212f571d0e8890635 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Gets frequency error of the latest received packet. <a href="class_s_x128x.html#a2b424000856a9dc212f571d0e8890635">More...</a><br /></td></tr>
|
|
<tr class="separator:a2b424000856a9dc212f571d0e8890635 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a390fd0749b316eed67da7b54f4f24735 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a390fd0749b316eed67da7b54f4f24735">getPacketLength</a> (bool update=true) override</td></tr>
|
|
<tr class="memdesc:a390fd0749b316eed67da7b54f4f24735 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Query modem for the packet length of received payload. <a href="class_s_x128x.html#a390fd0749b316eed67da7b54f4f24735">More...</a><br /></td></tr>
|
|
<tr class="separator:a390fd0749b316eed67da7b54f4f24735 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2361a94f2e12ebc93e750a027d633232 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a2361a94f2e12ebc93e750a027d633232">getTimeOnAir</a> (size_t len)</td></tr>
|
|
<tr class="memdesc:a2361a94f2e12ebc93e750a027d633232 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Get expected time-on-air for a given size of payload. <a href="class_s_x128x.html#a2361a94f2e12ebc93e750a027d633232">More...</a><br /></td></tr>
|
|
<tr class="separator:a2361a94f2e12ebc93e750a027d633232 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac69cc622020419cb3393eac5cc88915b inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#ac69cc622020419cb3393eac5cc88915b">implicitHeader</a> (size_t len)</td></tr>
|
|
<tr class="memdesc:ac69cc622020419cb3393eac5cc88915b inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Set implicit header mode for future reception/transmission. <a href="class_s_x128x.html#ac69cc622020419cb3393eac5cc88915b">More...</a><br /></td></tr>
|
|
<tr class="separator:ac69cc622020419cb3393eac5cc88915b inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94b7fb26cc99385d30b0c98b76d8188d inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a94b7fb26cc99385d30b0c98b76d8188d">explicitHeader</a> ()</td></tr>
|
|
<tr class="memdesc:a94b7fb26cc99385d30b0c98b76d8188d inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Set explicit header mode for future reception/transmission. <a href="class_s_x128x.html#a94b7fb26cc99385d30b0c98b76d8188d">More...</a><br /></td></tr>
|
|
<tr class="separator:a94b7fb26cc99385d30b0c98b76d8188d inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8720a388d2cd10fac3112b89f4a80947 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a8720a388d2cd10fac3112b89f4a80947">setEncoding</a> (uint8_t encoding) override</td></tr>
|
|
<tr class="memdesc:a8720a388d2cd10fac3112b89f4a80947 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Sets transmission encoding. Serves only as alias for <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a> compatibility. <a href="class_s_x128x.html#a8720a388d2cd10fac3112b89f4a80947">More...</a><br /></td></tr>
|
|
<tr class="separator:a8720a388d2cd10fac3112b89f4a80947 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f11803b3430bc059321b443f407e78b inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a5f11803b3430bc059321b443f407e78b">setRfSwitchPins</a> (RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)</td></tr>
|
|
<tr class="memdesc:a5f11803b3430bc059321b443f407e78b inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over those pins to automatically switch between various modes: When idle both pins will be LOW, during TX the <code>txEn</code> pin will be HIGH, during RX the <code>rxPin</code> will be HIGH. <a href="class_s_x128x.html#a5f11803b3430bc059321b443f407e78b">More...</a><br /></td></tr>
|
|
<tr class="separator:a5f11803b3430bc059321b443f407e78b inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae14ea0c263fba51ec39d146c5877f0a3 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#ae14ea0c263fba51ec39d146c5877f0a3">setRfSwitchTable</a> (const RADIOLIB_PIN_TYPE(&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:ae14ea0c263fba51ec39d146c5877f0a3 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over those pins to automatically switch between various modes. <a href="class_s_x128x.html#ae14ea0c263fba51ec39d146c5877f0a3">More...</a><br /></td></tr>
|
|
<tr class="separator:ae14ea0c263fba51ec39d146c5877f0a3 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a95637e8addc48b0e1c30c2cf6f54354a inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a95637e8addc48b0e1c30c2cf6f54354a">randomByte</a> ()</td></tr>
|
|
<tr class="memdesc:a95637e8addc48b0e1c30c2cf6f54354a inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Dummy random method, to ensure <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a> compatibility. <a href="class_s_x128x.html#a95637e8addc48b0e1c30c2cf6f54354a">More...</a><br /></td></tr>
|
|
<tr class="separator:a95637e8addc48b0e1c30c2cf6f54354a inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff1b549077b9d752f53bf9dfc6840236 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#aff1b549077b9d752f53bf9dfc6840236">setDirectAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:aff1b549077b9d752f53bf9dfc6840236 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Dummy method, to ensure <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a> compatibility. <a href="class_s_x128x.html#aff1b549077b9d752f53bf9dfc6840236">More...</a><br /></td></tr>
|
|
<tr class="separator:aff1b549077b9d752f53bf9dfc6840236 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2dd0ecae9f54cf6943cf702ae15f5039 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a2dd0ecae9f54cf6943cf702ae15f5039">readBit</a> (RADIOLIB_PIN_TYPE pin)</td></tr>
|
|
<tr class="memdesc:a2dd0ecae9f54cf6943cf702ae15f5039 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Dummy method, to ensure <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a> compatibility. <a href="class_s_x128x.html#a2dd0ecae9f54cf6943cf702ae15f5039">More...</a><br /></td></tr>
|
|
<tr class="separator:a2dd0ecae9f54cf6943cf702ae15f5039 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab139a34e03a6fd5a781cd54da21d308f inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#ab139a34e03a6fd5a781cd54da21d308f">transmit</a> (__FlashStringHelper *fstr, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:ab139a34e03a6fd5a781cd54da21d308f inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Arduino Flash String transmit method. <a href="class_s_x128x.html#ab139a34e03a6fd5a781cd54da21d308f">More...</a><br /></td></tr>
|
|
<tr class="separator:ab139a34e03a6fd5a781cd54da21d308f inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb62c5a521aafc1e0525c58e9364482b inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#aeb62c5a521aafc1e0525c58e9364482b">transmit</a> (String &str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:aeb62c5a521aafc1e0525c58e9364482b inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Arduino String transmit method. <a href="class_s_x128x.html#aeb62c5a521aafc1e0525c58e9364482b">More...</a><br /></td></tr>
|
|
<tr class="separator:aeb62c5a521aafc1e0525c58e9364482b inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a492b2d057dd803c3884fa1adc8e22534">transmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">C-string transmit method. <a href="class_s_x128x.html#a492b2d057dd803c3884fa1adc8e22534">More...</a><br /></td></tr>
|
|
<tr class="separator:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3dd42f8d5569487ea74f004ca652a709 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a3dd42f8d5569487ea74f004ca652a709">transmit</a> (uint8_t *data, size_t len, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a3dd42f8d5569487ea74f004ca652a709 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Binary transmit method. Must be implemented in module class. <a href="class_s_x128x.html#a3dd42f8d5569487ea74f004ca652a709">More...</a><br /></td></tr>
|
|
<tr class="separator:a3dd42f8d5569487ea74f004ca652a709 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb1b090348d9091bfa3a0b5ba3d85b36 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#afb1b090348d9091bfa3a0b5ba3d85b36">receive</a> (String &str, size_t len=0)</td></tr>
|
|
<tr class="memdesc:afb1b090348d9091bfa3a0b5ba3d85b36 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Arduino String receive method. <a href="class_s_x128x.html#afb1b090348d9091bfa3a0b5ba3d85b36">More...</a><br /></td></tr>
|
|
<tr class="separator:afb1b090348d9091bfa3a0b5ba3d85b36 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab82617fa3fa9f21d4cd427314ecc4af8 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#ab82617fa3fa9f21d4cd427314ecc4af8">receive</a> (uint8_t *data, size_t len)</td></tr>
|
|
<tr class="memdesc:ab82617fa3fa9f21d4cd427314ecc4af8 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Binary receive method. Must be implemented in module class. <a href="class_s_x128x.html#ab82617fa3fa9f21d4cd427314ecc4af8">More...</a><br /></td></tr>
|
|
<tr class="separator:ab82617fa3fa9f21d4cd427314ecc4af8 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af068e6e862c99e39d0261a7971dd56db inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#af068e6e862c99e39d0261a7971dd56db">startTransmit</a> (String &str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:af068e6e862c99e39d0261a7971dd56db inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. <a href="class_s_x128x.html#af068e6e862c99e39d0261a7971dd56db">More...</a><br /></td></tr>
|
|
<tr class="separator:af068e6e862c99e39d0261a7971dd56db inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a923654706eff5118ef6e84214e837f27">startTransmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. <a href="class_s_x128x.html#a923654706eff5118ef6e84214e837f27">More...</a><br /></td></tr>
|
|
<tr class="separator:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad59e37ce0606dc8051e40be9d14cfec3 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#ad59e37ce0606dc8051e40be9d14cfec3">startTransmit</a> (uint8_t *data, size_t len, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:ad59e37ce0606dc8051e40be9d14cfec3 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven binary transmit method. <a href="class_s_x128x.html#ad59e37ce0606dc8051e40be9d14cfec3">More...</a><br /></td></tr>
|
|
<tr class="separator:ad59e37ce0606dc8051e40be9d14cfec3 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8eed0e888a7c8742e89d2b850977de2 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#ae8eed0e888a7c8742e89d2b850977de2">readData</a> (String &str, size_t len=0)</td></tr>
|
|
<tr class="memdesc:ae8eed0e888a7c8742e89d2b850977de2 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Reads data that was received after calling startReceive method. <a href="class_s_x128x.html#ae8eed0e888a7c8742e89d2b850977de2">More...</a><br /></td></tr>
|
|
<tr class="separator:ae8eed0e888a7c8742e89d2b850977de2 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3563453988a83d22dd07d4691543a300 inherit pub_methods_class_s_x128x"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_x128x.html#a3563453988a83d22dd07d4691543a300">readData</a> (uint8_t *data, size_t len)</td></tr>
|
|
<tr class="memdesc:a3563453988a83d22dd07d4691543a300 inherit pub_methods_class_s_x128x"><td class="mdescLeft"> </td><td class="mdescRight">Reads data that was received after calling startReceive method. <a href="class_s_x128x.html#a3563453988a83d22dd07d4691543a300">More...</a><br /></td></tr>
|
|
<tr class="separator:a3563453988a83d22dd07d4691543a300 inherit pub_methods_class_s_x128x"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_physical_layer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_physical_layer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_physical_layer.html">PhysicalLayer</a></td></tr>
|
|
<tr class="memitem:a5e02457f1d519cf81b1590a182321c62 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a5e02457f1d519cf81b1590a182321c62">PhysicalLayer</a> (float freqStep, size_t maxPacketLength)</td></tr>
|
|
<tr class="memdesc:a5e02457f1d519cf81b1590a182321c62 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_physical_layer.html#a5e02457f1d519cf81b1590a182321c62">More...</a><br /></td></tr>
|
|
<tr class="separator:a5e02457f1d519cf81b1590a182321c62 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab139a34e03a6fd5a781cd54da21d308f inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">transmit</a> (__FlashStringHelper *fstr, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:ab139a34e03a6fd5a781cd54da21d308f inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Arduino Flash String transmit method. <a href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">More...</a><br /></td></tr>
|
|
<tr class="separator:ab139a34e03a6fd5a781cd54da21d308f inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb62c5a521aafc1e0525c58e9364482b inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#aeb62c5a521aafc1e0525c58e9364482b">transmit</a> (String &str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:aeb62c5a521aafc1e0525c58e9364482b inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Arduino String transmit method. <a href="class_physical_layer.html#aeb62c5a521aafc1e0525c58e9364482b">More...</a><br /></td></tr>
|
|
<tr class="separator:aeb62c5a521aafc1e0525c58e9364482b inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">transmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">C-string transmit method. <a href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">More...</a><br /></td></tr>
|
|
<tr class="separator:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb1b090348d9091bfa3a0b5ba3d85b36 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">receive</a> (String &str, size_t len=0)</td></tr>
|
|
<tr class="memdesc:afb1b090348d9091bfa3a0b5ba3d85b36 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Arduino String receive method. <a href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">More...</a><br /></td></tr>
|
|
<tr class="separator:afb1b090348d9091bfa3a0b5ba3d85b36 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af1bb9a5da26da8829795ebb72e9c666e inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#af1bb9a5da26da8829795ebb72e9c666e">sleep</a> ()</td></tr>
|
|
<tr class="memdesc:af1bb9a5da26da8829795ebb72e9c666e inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Sets module to sleep. <a href="class_physical_layer.html#af1bb9a5da26da8829795ebb72e9c666e">More...</a><br /></td></tr>
|
|
<tr class="separator:af1bb9a5da26da8829795ebb72e9c666e inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a13dbafeeb9dd9ede72cc4d907738ac48 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a13dbafeeb9dd9ede72cc4d907738ac48">startReceive</a> (uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)</td></tr>
|
|
<tr class="memdesc:a13dbafeeb9dd9ede72cc4d907738ac48 inherit pub_methods_class_physical_layer"><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. <a href="class_physical_layer.html#a13dbafeeb9dd9ede72cc4d907738ac48">More...</a><br /></td></tr>
|
|
<tr class="separator:a13dbafeeb9dd9ede72cc4d907738ac48 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af068e6e862c99e39d0261a7971dd56db inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">startTransmit</a> (String &str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:af068e6e862c99e39d0261a7971dd56db inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. <a href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">More...</a><br /></td></tr>
|
|
<tr class="separator:af068e6e862c99e39d0261a7971dd56db inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">startTransmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. <a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">More...</a><br /></td></tr>
|
|
<tr class="separator:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8eed0e888a7c8742e89d2b850977de2 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">readData</a> (String &str, size_t len=0)</td></tr>
|
|
<tr class="memdesc:ae8eed0e888a7c8742e89d2b850977de2 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Reads data that was received after calling startReceive method. <a href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">More...</a><br /></td></tr>
|
|
<tr class="separator:ae8eed0e888a7c8742e89d2b850977de2 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a977e5236693960bb1c79090a201e9e1c inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a977e5236693960bb1c79090a201e9e1c">getFreqStep</a> () const</td></tr>
|
|
<tr class="memdesc:a977e5236693960bb1c79090a201e9e1c inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Gets the module frequency step size that was set in constructor. <a href="class_physical_layer.html#a977e5236693960bb1c79090a201e9e1c">More...</a><br /></td></tr>
|
|
<tr class="separator:a977e5236693960bb1c79090a201e9e1c inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd9171bd71aa80fb86113b612c42de53 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">random</a> (int32_t max)</td></tr>
|
|
<tr class="memdesc:acd9171bd71aa80fb86113b612c42de53 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get truly random number in range 0 - max. <a href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">More...</a><br /></td></tr>
|
|
<tr class="separator:acd9171bd71aa80fb86113b612c42de53 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a76113e10481743094a1cd0280692b0a9 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a76113e10481743094a1cd0280692b0a9">random</a> (int32_t min, int32_t max)</td></tr>
|
|
<tr class="memdesc:a76113e10481743094a1cd0280692b0a9 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get truly random number in range min - max. <a href="class_physical_layer.html#a76113e10481743094a1cd0280692b0a9">More...</a><br /></td></tr>
|
|
<tr class="separator:a76113e10481743094a1cd0280692b0a9 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88a10657bd2215a11a2331f937414b55 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a88a10657bd2215a11a2331f937414b55">startDirect</a> ()</td></tr>
|
|
<tr class="memdesc:a88a10657bd2215a11a2331f937414b55 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Configure module parameters for direct modes. Must be called prior to "ham" modes like RTTY or AX.25. Only available in FSK mode. <a href="class_physical_layer.html#a88a10657bd2215a11a2331f937414b55">More...</a><br /></td></tr>
|
|
<tr class="separator:a88a10657bd2215a11a2331f937414b55 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8e378fe136a498ea485a9c10f5e15aab inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a8e378fe136a498ea485a9c10f5e15aab">setDirectSyncWord</a> (uint32_t syncWord, uint8_t len)</td></tr>
|
|
<tr class="memdesc:a8e378fe136a498ea485a9c10f5e15aab inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Set sync word to be used to determine start of packet in direct reception mode. <a href="class_physical_layer.html#a8e378fe136a498ea485a9c10f5e15aab">More...</a><br /></td></tr>
|
|
<tr class="separator:a8e378fe136a498ea485a9c10f5e15aab inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab57182d32646861ef0d865e2740d6b26 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ab57182d32646861ef0d865e2740d6b26">available</a> ()</td></tr>
|
|
<tr class="memdesc:ab57182d32646861ef0d865e2740d6b26 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of direct mode bytes currently available in buffer. <a href="class_physical_layer.html#ab57182d32646861ef0d865e2740d6b26">More...</a><br /></td></tr>
|
|
<tr class="separator:ab57182d32646861ef0d865e2740d6b26 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a429796eb2e7ea86781a2e8ca42af43f3 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top"><a id="a429796eb2e7ea86781a2e8ca42af43f3"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a429796eb2e7ea86781a2e8ca42af43f3">dropSync</a> ()</td></tr>
|
|
<tr class="memdesc:a429796eb2e7ea86781a2e8ca42af43f3 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Forcefully drop synchronization. <br /></td></tr>
|
|
<tr class="separator:a429796eb2e7ea86781a2e8ca42af43f3 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d5b30493c8d7fcfb784e128362d596c inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a4d5b30493c8d7fcfb784e128362d596c">read</a> (bool drop=true)</td></tr>
|
|
<tr class="memdesc:a4d5b30493c8d7fcfb784e128362d596c inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get data from direct mode buffer. <a href="class_physical_layer.html#a4d5b30493c8d7fcfb784e128362d596c">More...</a><br /></td></tr>
|
|
<tr class="separator:a4d5b30493c8d7fcfb784e128362d596c inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47c1d94d2ad2fd7eb5d11480b44cc368 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a47c1d94d2ad2fd7eb5d11480b44cc368">setDIOMapping</a> (RADIOLIB_PIN_TYPE pin, uint8_t value)</td></tr>
|
|
<tr class="memdesc:a47c1d94d2ad2fd7eb5d11480b44cc368 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Configure DIO pin mapping to get a given signal on a DIO pin (if available). <a href="class_physical_layer.html#a47c1d94d2ad2fd7eb5d11480b44cc368">More...</a><br /></td></tr>
|
|
<tr class="separator:a47c1d94d2ad2fd7eb5d11480b44cc368 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Derived class for SX1281 modules. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a0dd7678cdf7fad9ecfc9139c5092f998"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0dd7678cdf7fad9ecfc9139c5092f998">◆ </a></span>SX1281()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">SX1281::SX1281 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_module.html">Module</a> * </td>
|
|
<td class="paramname"><em>mod</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mod</td><td>Instance of <a class="el" href="class_module.html" title="Implements all common low-level methods to control the wireless module. Every module class contains o...">Module</a> that will be used to communicate with the radio. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/modules/SX128x/<a class="el" href="_s_x1281_8h_source.html">SX1281.h</a></li>
|
|
<li>src/modules/SX128x/SX1281.cpp</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="class_s_x1281.html">SX1281</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|