kopia lustrzana https://github.com/jgromes/RadioLib
2713 wiersze
164 KiB
HTML
2713 wiersze
164 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: RF69 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_r_f69.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_r_f69-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">RF69 Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Control class for RF69 module. Also serves as base class for <a class="el" href="class_s_x1231.html" title="Control class for SX1231 module. Overrides some methods from RF69 due to different register values.">SX1231</a>.
|
|
<a href="class_r_f69.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_r_f69_8h_source.html">RF69.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for RF69:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_r_f69.png" usemap="#RF69_map" alt=""/>
|
|
<map id="RF69_map" name="RF69_map">
|
|
<area href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN...." alt="PhysicalLayer" shape="rect" coords="0,0,93,24"/>
|
|
<area href="class_s_x1231.html" title="Control class for SX1231 module. Overrides some methods from RF69 due to different register values." alt="SX1231" shape="rect" coords="0,112,93,136"/>
|
|
<area href="class_s_x1233.html" title="Control class for SX1233 module. Overrides some methods from SX1231/RF69 due to different register va..." alt="SX1233" shape="rect" coords="0,168,93,192"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:afbc84d4f91502bcbe12ddda2fde51448"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#afbc84d4f91502bcbe12ddda2fde51448">RF69</a> (<a class="el" href="class_module.html">Module</a> *module)</td></tr>
|
|
<tr class="memdesc:afbc84d4f91502bcbe12ddda2fde51448"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_r_f69.html#afbc84d4f91502bcbe12ddda2fde51448">More...</a><br /></td></tr>
|
|
<tr class="separator:afbc84d4f91502bcbe12ddda2fde51448"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a637ea5386066f5608bcbb4266e5c1bd6"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a637ea5386066f5608bcbb4266e5c1bd6">begin</a> (float freq=RADIOLIB_RF69_DEFAULT_FREQ, float br=RADIOLIB_RF69_DEFAULT_BR, float freqDev=RADIOLIB_RF69_DEFAULT_FREQDEV, float rxBw=RADIOLIB_RF69_DEFAULT_RXBW, int8_t pwr=RADIOLIB_RF69_DEFAULT_POWER, uint8_t preambleLen=RADIOLIB_RF69_DEFAULT_PREAMBLELEN)</td></tr>
|
|
<tr class="memdesc:a637ea5386066f5608bcbb4266e5c1bd6"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. <a href="class_r_f69.html#a637ea5386066f5608bcbb4266e5c1bd6">More...</a><br /></td></tr>
|
|
<tr class="separator:a637ea5386066f5608bcbb4266e5c1bd6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af953ee17aca5392f1e62ea4fe690550a"><td class="memItemLeft" align="right" valign="top"><a id="af953ee17aca5392f1e62ea4fe690550a"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#af953ee17aca5392f1e62ea4fe690550a">reset</a> ()</td></tr>
|
|
<tr class="memdesc:af953ee17aca5392f1e62ea4fe690550a"><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:af953ee17aca5392f1e62ea4fe690550a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a09ba80f60ee7974011a4b4f6c18c6847"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a09ba80f60ee7974011a4b4f6c18c6847">transmit</a> (uint8_t *data, size_t len, uint8_t addr=0) override</td></tr>
|
|
<tr class="memdesc:a09ba80f60ee7974011a4b4f6c18c6847"><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_r_f69.html#a09ba80f60ee7974011a4b4f6c18c6847">More...</a><br /></td></tr>
|
|
<tr class="separator:a09ba80f60ee7974011a4b4f6c18c6847"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae36e8e6042245621a182b29526fe2245"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ae36e8e6042245621a182b29526fe2245">receive</a> (uint8_t *data, size_t len) override</td></tr>
|
|
<tr class="memdesc:ae36e8e6042245621a182b29526fe2245"><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_r_f69.html#ae36e8e6042245621a182b29526fe2245">More...</a><br /></td></tr>
|
|
<tr class="separator:ae36e8e6042245621a182b29526fe2245"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a472a04041551cb38d2223fb34f71d8eb"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a472a04041551cb38d2223fb34f71d8eb">sleep</a> ()</td></tr>
|
|
<tr class="memdesc:a472a04041551cb38d2223fb34f71d8eb"><td class="mdescLeft"> </td><td class="mdescRight">Sets the module to sleep mode. <a href="class_r_f69.html#a472a04041551cb38d2223fb34f71d8eb">More...</a><br /></td></tr>
|
|
<tr class="separator:a472a04041551cb38d2223fb34f71d8eb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a20242499eb926ff7b7da6e3f74a9ece1"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a20242499eb926ff7b7da6e3f74a9ece1">standby</a> () override</td></tr>
|
|
<tr class="memdesc:a20242499eb926ff7b7da6e3f74a9ece1"><td class="mdescLeft"> </td><td class="mdescRight">Sets the module to standby mode. <a href="class_r_f69.html#a20242499eb926ff7b7da6e3f74a9ece1">More...</a><br /></td></tr>
|
|
<tr class="separator:a20242499eb926ff7b7da6e3f74a9ece1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6e3002ab0c58e2087a7d101eda7afa82"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a6e3002ab0c58e2087a7d101eda7afa82">standby</a> (uint8_t mode) override</td></tr>
|
|
<tr class="memdesc:a6e3002ab0c58e2087a7d101eda7afa82"><td class="mdescLeft"> </td><td class="mdescRight">Sets the module to standby. <a href="class_r_f69.html#a6e3002ab0c58e2087a7d101eda7afa82">More...</a><br /></td></tr>
|
|
<tr class="separator:a6e3002ab0c58e2087a7d101eda7afa82"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a222682569338abb49d6952430b6eebdd"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a222682569338abb49d6952430b6eebdd">transmitDirect</a> (uint32_t frf=0) override</td></tr>
|
|
<tr class="memdesc:a222682569338abb49d6952430b6eebdd"><td class="mdescLeft"> </td><td class="mdescRight">Starts direct mode transmission. <a href="class_r_f69.html#a222682569338abb49d6952430b6eebdd">More...</a><br /></td></tr>
|
|
<tr class="separator:a222682569338abb49d6952430b6eebdd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd556b0f455f9510213b17588a4baf1b"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#abd556b0f455f9510213b17588a4baf1b">receiveDirect</a> () override</td></tr>
|
|
<tr class="memdesc:abd556b0f455f9510213b17588a4baf1b"><td class="mdescLeft"> </td><td class="mdescRight">Starts direct mode reception. <a href="class_r_f69.html#abd556b0f455f9510213b17588a4baf1b">More...</a><br /></td></tr>
|
|
<tr class="separator:abd556b0f455f9510213b17588a4baf1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a67dd698b3cc6afcaf18c3710ad5f0f"><td class="memItemLeft" align="right" valign="top"><a id="a6a67dd698b3cc6afcaf18c3710ad5f0f"></a>
|
|
int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a6a67dd698b3cc6afcaf18c3710ad5f0f">packetMode</a> ()</td></tr>
|
|
<tr class="memdesc:a6a67dd698b3cc6afcaf18c3710ad5f0f"><td class="mdescLeft"> </td><td class="mdescRight">Stops direct mode. It is required to call this method to switch from direct transmissions to packet-based transmissions. <br /></td></tr>
|
|
<tr class="separator:a6a67dd698b3cc6afcaf18c3710ad5f0f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe5b378d7cc274fd8b75881e7d604bf3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#abe5b378d7cc274fd8b75881e7d604bf3">setAESKey</a> (uint8_t *key)</td></tr>
|
|
<tr class="memdesc:abe5b378d7cc274fd8b75881e7d604bf3"><td class="mdescLeft"> </td><td class="mdescRight">Sets AES key. <a href="class_r_f69.html#abe5b378d7cc274fd8b75881e7d604bf3">More...</a><br /></td></tr>
|
|
<tr class="separator:abe5b378d7cc274fd8b75881e7d604bf3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1fd4609f419d8b0213ee39b05dd40b69"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a1fd4609f419d8b0213ee39b05dd40b69">enableAES</a> ()</td></tr>
|
|
<tr class="memdesc:a1fd4609f419d8b0213ee39b05dd40b69"><td class="mdescLeft"> </td><td class="mdescRight">Enables AES encryption. <a href="class_r_f69.html#a1fd4609f419d8b0213ee39b05dd40b69">More...</a><br /></td></tr>
|
|
<tr class="separator:a1fd4609f419d8b0213ee39b05dd40b69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a15fafb6c24a8b5721623be447628bbaa"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a15fafb6c24a8b5721623be447628bbaa">disableAES</a> ()</td></tr>
|
|
<tr class="memdesc:a15fafb6c24a8b5721623be447628bbaa"><td class="mdescLeft"> </td><td class="mdescRight">Disables AES encryption. <a href="class_r_f69.html#a15fafb6c24a8b5721623be447628bbaa">More...</a><br /></td></tr>
|
|
<tr class="separator:a15fafb6c24a8b5721623be447628bbaa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9e50a1183d13ff9984f8438a7e9e4a77"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a9e50a1183d13ff9984f8438a7e9e4a77">setDio0Action</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:a9e50a1183d13ff9984f8438a7e9e4a77"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when DIO0 activates. <a href="class_r_f69.html#a9e50a1183d13ff9984f8438a7e9e4a77">More...</a><br /></td></tr>
|
|
<tr class="separator:a9e50a1183d13ff9984f8438a7e9e4a77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9721d2a3ed9fa8dd878575d71d5a4942"><td class="memItemLeft" align="right" valign="top"><a id="a9721d2a3ed9fa8dd878575d71d5a4942"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a9721d2a3ed9fa8dd878575d71d5a4942">clearDio0Action</a> ()</td></tr>
|
|
<tr class="memdesc:a9721d2a3ed9fa8dd878575d71d5a4942"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when DIO0 activates. <br /></td></tr>
|
|
<tr class="separator:a9721d2a3ed9fa8dd878575d71d5a4942"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa72ad2ac5238bd87886684064b7494cf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#aa72ad2ac5238bd87886684064b7494cf">setDio1Action</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:aa72ad2ac5238bd87886684064b7494cf"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when DIO1 activates. <a href="class_r_f69.html#aa72ad2ac5238bd87886684064b7494cf">More...</a><br /></td></tr>
|
|
<tr class="separator:aa72ad2ac5238bd87886684064b7494cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade1f9a7a603d712c480ed5e9a8d1bf51"><td class="memItemLeft" align="right" valign="top"><a id="ade1f9a7a603d712c480ed5e9a8d1bf51"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ade1f9a7a603d712c480ed5e9a8d1bf51">clearDio1Action</a> ()</td></tr>
|
|
<tr class="memdesc:ade1f9a7a603d712c480ed5e9a8d1bf51"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when DIO1 activates. <br /></td></tr>
|
|
<tr class="separator:ade1f9a7a603d712c480ed5e9a8d1bf51"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac8bff26070735a733a24146d414c3c5f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ac8bff26070735a733a24146d414c3c5f">setPacketReceivedAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:ac8bff26070735a733a24146d414c3c5f"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a packet is received. <a href="class_r_f69.html#ac8bff26070735a733a24146d414c3c5f">More...</a><br /></td></tr>
|
|
<tr class="separator:ac8bff26070735a733a24146d414c3c5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac302d3524dc802467a7ce91b2223db90"><td class="memItemLeft" align="right" valign="top"><a id="ac302d3524dc802467a7ce91b2223db90"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ac302d3524dc802467a7ce91b2223db90">clearPacketReceivedAction</a> ()</td></tr>
|
|
<tr class="memdesc:ac302d3524dc802467a7ce91b2223db90"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a packet is received. <br /></td></tr>
|
|
<tr class="separator:ac302d3524dc802467a7ce91b2223db90"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27fad7a67c4239c19bd94d1ccfb493ca"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a27fad7a67c4239c19bd94d1ccfb493ca">setPacketSentAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:a27fad7a67c4239c19bd94d1ccfb493ca"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a packet is sent. <a href="class_r_f69.html#a27fad7a67c4239c19bd94d1ccfb493ca">More...</a><br /></td></tr>
|
|
<tr class="separator:a27fad7a67c4239c19bd94d1ccfb493ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3a8be5bcc37d3e4f5ac2d0310c8bac12"><td class="memItemLeft" align="right" valign="top"><a id="a3a8be5bcc37d3e4f5ac2d0310c8bac12"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a3a8be5bcc37d3e4f5ac2d0310c8bac12">clearPacketSentAction</a> ()</td></tr>
|
|
<tr class="memdesc:a3a8be5bcc37d3e4f5ac2d0310c8bac12"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a packet is sent. <br /></td></tr>
|
|
<tr class="separator:a3a8be5bcc37d3e4f5ac2d0310c8bac12"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a788023a0de9d6b43cb4079d12ca90b8d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a788023a0de9d6b43cb4079d12ca90b8d">setFifoEmptyAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:a788023a0de9d6b43cb4079d12ca90b8d"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt service routine function to call when FIFO is empty. <a href="class_r_f69.html#a788023a0de9d6b43cb4079d12ca90b8d">More...</a><br /></td></tr>
|
|
<tr class="separator:a788023a0de9d6b43cb4079d12ca90b8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0d7b67499462777f7909860405ca6b62"><td class="memItemLeft" align="right" valign="top"><a id="a0d7b67499462777f7909860405ca6b62"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a0d7b67499462777f7909860405ca6b62">clearFifoEmptyAction</a> ()</td></tr>
|
|
<tr class="memdesc:a0d7b67499462777f7909860405ca6b62"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when FIFO is empty. <br /></td></tr>
|
|
<tr class="separator:a0d7b67499462777f7909860405ca6b62"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a6ecb5fcc42c49bc3d9032e9c5db07b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a1a6ecb5fcc42c49bc3d9032e9c5db07b">setFifoFullAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:a1a6ecb5fcc42c49bc3d9032e9c5db07b"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt service routine function to call when FIFO is full. <a href="class_r_f69.html#a1a6ecb5fcc42c49bc3d9032e9c5db07b">More...</a><br /></td></tr>
|
|
<tr class="separator:a1a6ecb5fcc42c49bc3d9032e9c5db07b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9accbe3e66f24d5158891a96fb582f3"><td class="memItemLeft" align="right" valign="top"><a id="ae9accbe3e66f24d5158891a96fb582f3"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ae9accbe3e66f24d5158891a96fb582f3">clearFifoFullAction</a> ()</td></tr>
|
|
<tr class="memdesc:ae9accbe3e66f24d5158891a96fb582f3"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when FIFO is full. <br /></td></tr>
|
|
<tr class="separator:ae9accbe3e66f24d5158891a96fb582f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab6d98f3f2d964d1833e20da246a5be89"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ab6d98f3f2d964d1833e20da246a5be89">fifoAdd</a> (uint8_t *data, int totalLen, int *remLen)</td></tr>
|
|
<tr class="memdesc:ab6d98f3f2d964d1833e20da246a5be89"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt service routine function to call when FIFO is empty. <a href="class_r_f69.html#ab6d98f3f2d964d1833e20da246a5be89">More...</a><br /></td></tr>
|
|
<tr class="separator:ab6d98f3f2d964d1833e20da246a5be89"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa6886410230c654400c76ec7710d623c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#aa6886410230c654400c76ec7710d623c">fifoGet</a> (volatile uint8_t *data, int totalLen, volatile int *rcvLen)</td></tr>
|
|
<tr class="memdesc:aa6886410230c654400c76ec7710d623c"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt service routine function to call when FIFO is sufficiently full to read. <a href="class_r_f69.html#aa6886410230c654400c76ec7710d623c">More...</a><br /></td></tr>
|
|
<tr class="separator:aa6886410230c654400c76ec7710d623c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a855dc194947b095b821ec1524ba6814c"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a855dc194947b095b821ec1524ba6814c">startTransmit</a> (uint8_t *data, size_t len, uint8_t addr=0) override</td></tr>
|
|
<tr class="memdesc:a855dc194947b095b821ec1524ba6814c"><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_r_f69.html#a855dc194947b095b821ec1524ba6814c">More...</a><br /></td></tr>
|
|
<tr class="separator:a855dc194947b095b821ec1524ba6814c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3e449fa06c9e76cf69585bfbeed1c46b"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a3e449fa06c9e76cf69585bfbeed1c46b">finishTransmit</a> () override</td></tr>
|
|
<tr class="memdesc:a3e449fa06c9e76cf69585bfbeed1c46b"><td class="mdescLeft"> </td><td class="mdescRight">Clean up after transmission is done. <a href="class_r_f69.html#a3e449fa06c9e76cf69585bfbeed1c46b">More...</a><br /></td></tr>
|
|
<tr class="separator:a3e449fa06c9e76cf69585bfbeed1c46b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afae38fa64242043de34096bf497725f1"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#afae38fa64242043de34096bf497725f1">startReceive</a> ()</td></tr>
|
|
<tr class="memdesc:afae38fa64242043de34096bf497725f1"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven receive method. GDO0 will be activated when full packet is received. <a href="class_r_f69.html#afae38fa64242043de34096bf497725f1">More...</a><br /></td></tr>
|
|
<tr class="separator:afae38fa64242043de34096bf497725f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8b6f87d4b798dc8fcda07bfa5af5a66"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ae8b6f87d4b798dc8fcda07bfa5af5a66">startReceive</a> (uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)</td></tr>
|
|
<tr class="memdesc:ae8b6f87d4b798dc8fcda07bfa5af5a66"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven receive method, implemented for compatibility with <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a>. <a href="class_r_f69.html#ae8b6f87d4b798dc8fcda07bfa5af5a66">More...</a><br /></td></tr>
|
|
<tr class="separator:ae8b6f87d4b798dc8fcda07bfa5af5a66"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3983b66c83818b4082805bcafc712f00"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a3983b66c83818b4082805bcafc712f00">readData</a> (uint8_t *data, size_t len) override</td></tr>
|
|
<tr class="memdesc:a3983b66c83818b4082805bcafc712f00"><td class="mdescLeft"> </td><td class="mdescRight">Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! <a href="class_r_f69.html#a3983b66c83818b4082805bcafc712f00">More...</a><br /></td></tr>
|
|
<tr class="separator:a3983b66c83818b4082805bcafc712f00"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab467f0fc318e651d0cdfbc0399d4c34b"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ab467f0fc318e651d0cdfbc0399d4c34b">setFrequency</a> (float freq)</td></tr>
|
|
<tr class="memdesc:ab467f0fc318e651d0cdfbc0399d4c34b"><td class="mdescLeft"> </td><td class="mdescRight">Sets carrier frequency. Allowed values are in bands 290.0 to 340.0 MHz, 431.0 to 510.0 MHz and 862.0 to 1020.0 MHz. <a href="class_r_f69.html#ab467f0fc318e651d0cdfbc0399d4c34b">More...</a><br /></td></tr>
|
|
<tr class="separator:ab467f0fc318e651d0cdfbc0399d4c34b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2391eb6e07db3795e993b59b3a85cfed"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a2391eb6e07db3795e993b59b3a85cfed">getFrequency</a> (float *freq)</td></tr>
|
|
<tr class="memdesc:a2391eb6e07db3795e993b59b3a85cfed"><td class="mdescLeft"> </td><td class="mdescRight">Gets carrier frequency. <a href="class_r_f69.html#a2391eb6e07db3795e993b59b3a85cfed">More...</a><br /></td></tr>
|
|
<tr class="separator:a2391eb6e07db3795e993b59b3a85cfed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7f8132912a5dbf38c5cf676ac167d13"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ad7f8132912a5dbf38c5cf676ac167d13">setBitRate</a> (float br)</td></tr>
|
|
<tr class="memdesc:ad7f8132912a5dbf38c5cf676ac167d13"><td class="mdescLeft"> </td><td class="mdescRight">Sets bit rate. Allowed values range from 0.5 to 300.0 kbps. <a href="class_r_f69.html#ad7f8132912a5dbf38c5cf676ac167d13">More...</a><br /></td></tr>
|
|
<tr class="separator:ad7f8132912a5dbf38c5cf676ac167d13"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a735d8f22095a7e69471d73ca021b9d1a"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a735d8f22095a7e69471d73ca021b9d1a">setRxBandwidth</a> (float rxBw)</td></tr>
|
|
<tr class="memdesc:a735d8f22095a7e69471d73ca021b9d1a"><td class="mdescLeft"> </td><td class="mdescRight">Sets receiver bandwidth. Allowed values are 2.6, 3.1, 3.9, 5.2, 6.3, 7.8, 10.4, 12.5, 15.6, 20.8, 25.0, 31.3, 41.7, 50.0, 62.5, 83.3, 100.0, 125.0, 166.7, 200.0, 250.0, 333.3, 400.0 and 500.0 kHz. <a href="class_r_f69.html#a735d8f22095a7e69471d73ca021b9d1a">More...</a><br /></td></tr>
|
|
<tr class="separator:a735d8f22095a7e69471d73ca021b9d1a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb9fbfedf95f34ac537815870b98a9be"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#adb9fbfedf95f34ac537815870b98a9be">setFrequencyDeviation</a> (float freqDev) override</td></tr>
|
|
<tr class="memdesc:adb9fbfedf95f34ac537815870b98a9be"><td class="mdescLeft"> </td><td class="mdescRight">Sets frequency deviation. <a href="class_r_f69.html#adb9fbfedf95f34ac537815870b98a9be">More...</a><br /></td></tr>
|
|
<tr class="separator:adb9fbfedf95f34ac537815870b98a9be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bf0d5e045ccfecf9510773148cdd2c9"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a2bf0d5e045ccfecf9510773148cdd2c9">getFrequencyDeviation</a> (float *freqDev)</td></tr>
|
|
<tr class="memdesc:a2bf0d5e045ccfecf9510773148cdd2c9"><td class="mdescLeft"> </td><td class="mdescRight">Gets frequency deviation. <a href="class_r_f69.html#a2bf0d5e045ccfecf9510773148cdd2c9">More...</a><br /></td></tr>
|
|
<tr class="separator:a2bf0d5e045ccfecf9510773148cdd2c9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a721094611fa375e73bd0332ab2d7d113"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a721094611fa375e73bd0332ab2d7d113">setOutputPower</a> (int8_t pwr, bool highPower=false)</td></tr>
|
|
<tr class="memdesc:a721094611fa375e73bd0332ab2d7d113"><td class="mdescLeft"> </td><td class="mdescRight">Sets output power. Allowed values range from -18 to 13 dBm for low power modules (RF69C/CW) or -2 to 20 dBm (RF69H/HC/HCW). <a href="class_r_f69.html#a721094611fa375e73bd0332ab2d7d113">More...</a><br /></td></tr>
|
|
<tr class="separator:a721094611fa375e73bd0332ab2d7d113"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a26667d50ec845c28e17236c69c886561"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a26667d50ec845c28e17236c69c886561">setSyncWord</a> (uint8_t *syncWord, size_t len, uint8_t maxErrBits=0)</td></tr>
|
|
<tr class="memdesc:a26667d50ec845c28e17236c69c886561"><td class="mdescLeft"> </td><td class="mdescRight">Sets sync word. Up to 8 bytes can be set as sync word. <a href="class_r_f69.html#a26667d50ec845c28e17236c69c886561">More...</a><br /></td></tr>
|
|
<tr class="separator:a26667d50ec845c28e17236c69c886561"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7c84b3f881cad6e05b0f4f68c24496d9"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a7c84b3f881cad6e05b0f4f68c24496d9">setPreambleLength</a> (uint8_t preambleLen)</td></tr>
|
|
<tr class="memdesc:a7c84b3f881cad6e05b0f4f68c24496d9"><td class="mdescLeft"> </td><td class="mdescRight">Sets preamble length. <a href="class_r_f69.html#a7c84b3f881cad6e05b0f4f68c24496d9">More...</a><br /></td></tr>
|
|
<tr class="separator:a7c84b3f881cad6e05b0f4f68c24496d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9c217d5ece259950780a05c6e41f75c"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ab9c217d5ece259950780a05c6e41f75c">setNodeAddress</a> (uint8_t nodeAddr)</td></tr>
|
|
<tr class="memdesc:ab9c217d5ece259950780a05c6e41f75c"><td class="mdescLeft"> </td><td class="mdescRight">Sets node address. Calling this method will also enable address filtering for node address only. <a href="class_r_f69.html#ab9c217d5ece259950780a05c6e41f75c">More...</a><br /></td></tr>
|
|
<tr class="separator:ab9c217d5ece259950780a05c6e41f75c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b7598b87ffaabdbe733c47317fa91d8"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a1b7598b87ffaabdbe733c47317fa91d8">setBroadcastAddress</a> (uint8_t broadAddr)</td></tr>
|
|
<tr class="memdesc:a1b7598b87ffaabdbe733c47317fa91d8"><td class="mdescLeft"> </td><td class="mdescRight">Sets broadcast address. Calling this method will also enable address filtering for node and broadcast address. <a href="class_r_f69.html#a1b7598b87ffaabdbe733c47317fa91d8">More...</a><br /></td></tr>
|
|
<tr class="separator:a1b7598b87ffaabdbe733c47317fa91d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5996fc1751e7542baafa0d6c0a6c78ee"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a5996fc1751e7542baafa0d6c0a6c78ee">disableAddressFiltering</a> ()</td></tr>
|
|
<tr class="memdesc:a5996fc1751e7542baafa0d6c0a6c78ee"><td class="mdescLeft"> </td><td class="mdescRight">Disables address filtering. Calling this method will also erase previously set addresses. <a href="class_r_f69.html#a5996fc1751e7542baafa0d6c0a6c78ee">More...</a><br /></td></tr>
|
|
<tr class="separator:a5996fc1751e7542baafa0d6c0a6c78ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac37d9ddee2adcc8876a182b8ebc3e703"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ac37d9ddee2adcc8876a182b8ebc3e703">setAmbientTemperature</a> (int16_t tempAmbient)</td></tr>
|
|
<tr class="memdesc:ac37d9ddee2adcc8876a182b8ebc3e703"><td class="mdescLeft"> </td><td class="mdescRight">Sets ambient temperature. Required to correct values from on-board temperature sensor. <a href="class_r_f69.html#ac37d9ddee2adcc8876a182b8ebc3e703">More...</a><br /></td></tr>
|
|
<tr class="separator:ac37d9ddee2adcc8876a182b8ebc3e703"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0526ce6ea3722fd258f96d9677a60853"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a0526ce6ea3722fd258f96d9677a60853">getTemperature</a> ()</td></tr>
|
|
<tr class="memdesc:a0526ce6ea3722fd258f96d9677a60853"><td class="mdescLeft"> </td><td class="mdescRight">Measures temperature. <a href="class_r_f69.html#a0526ce6ea3722fd258f96d9677a60853">More...</a><br /></td></tr>
|
|
<tr class="separator:a0526ce6ea3722fd258f96d9677a60853"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a86a080086c0228d23e2cb77d2b1915c1"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a86a080086c0228d23e2cb77d2b1915c1">getPacketLength</a> (bool update=true) override</td></tr>
|
|
<tr class="memdesc:a86a080086c0228d23e2cb77d2b1915c1"><td class="mdescLeft"> </td><td class="mdescRight">Query modem for the packet length of received payload. <a href="class_r_f69.html#a86a080086c0228d23e2cb77d2b1915c1">More...</a><br /></td></tr>
|
|
<tr class="separator:a86a080086c0228d23e2cb77d2b1915c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a465df5a2e1f924f6d3ba4eae765847b7"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a465df5a2e1f924f6d3ba4eae765847b7">setOOK</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:a465df5a2e1f924f6d3ba4eae765847b7"><td class="mdescLeft"> </td><td class="mdescRight">Enables/disables OOK modulation instead of FSK. Note: This function calls setRxBandwidth again, since register values differ based on OOK mode being enabled/disabled. <a href="class_r_f69.html#a465df5a2e1f924f6d3ba4eae765847b7">More...</a><br /></td></tr>
|
|
<tr class="separator:a465df5a2e1f924f6d3ba4eae765847b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a219a046c10ddcc0a787ad19346ecad6a"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a219a046c10ddcc0a787ad19346ecad6a">setOokThresholdType</a> (uint8_t type)</td></tr>
|
|
<tr class="memdesc:a219a046c10ddcc0a787ad19346ecad6a"><td class="mdescLeft"> </td><td class="mdescRight">Selects the type of threshold in the OOK data slicer. <a href="class_r_f69.html#a219a046c10ddcc0a787ad19346ecad6a">More...</a><br /></td></tr>
|
|
<tr class="separator:a219a046c10ddcc0a787ad19346ecad6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f5852cf0757e38b56b6208760d9a459"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a2f5852cf0757e38b56b6208760d9a459">setOokFixedThreshold</a> (uint8_t value)</td></tr>
|
|
<tr class="memdesc:a2f5852cf0757e38b56b6208760d9a459"><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. <a href="class_r_f69.html#a2f5852cf0757e38b56b6208760d9a459">More...</a><br /></td></tr>
|
|
<tr class="separator:a2f5852cf0757e38b56b6208760d9a459"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a434420f2def6c383608223105469fda1"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a434420f2def6c383608223105469fda1">setOokPeakThresholdDecrement</a> (uint8_t value)</td></tr>
|
|
<tr class="memdesc:a434420f2def6c383608223105469fda1"><td class="mdescLeft"> </td><td class="mdescRight">Period of decrement of the RSSI threshold in the OOK demodulator. <a href="class_r_f69.html#a434420f2def6c383608223105469fda1">More...</a><br /></td></tr>
|
|
<tr class="separator:a434420f2def6c383608223105469fda1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0de2a07f264839cda945faebf7319e0e"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a0de2a07f264839cda945faebf7319e0e">fixedPacketLengthMode</a> (uint8_t len=RADIOLIB_RF69_MAX_PACKET_LENGTH)</td></tr>
|
|
<tr class="memdesc:a0de2a07f264839cda945faebf7319e0e"><td class="mdescLeft"> </td><td class="mdescRight">Set modem in fixed packet length mode. <a href="class_r_f69.html#a0de2a07f264839cda945faebf7319e0e">More...</a><br /></td></tr>
|
|
<tr class="separator:a0de2a07f264839cda945faebf7319e0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af434c67aabe02258ee6696a59973617b"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#af434c67aabe02258ee6696a59973617b">variablePacketLengthMode</a> (uint8_t maxLen=RADIOLIB_RF69_MAX_PACKET_LENGTH)</td></tr>
|
|
<tr class="memdesc:af434c67aabe02258ee6696a59973617b"><td class="mdescLeft"> </td><td class="mdescRight">Set modem in variable packet length mode. <a href="class_r_f69.html#af434c67aabe02258ee6696a59973617b">More...</a><br /></td></tr>
|
|
<tr class="separator:af434c67aabe02258ee6696a59973617b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a643a711bcb4b7771a7ab1f457e61a417"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a643a711bcb4b7771a7ab1f457e61a417">enableSyncWordFiltering</a> (uint8_t maxErrBits=0)</td></tr>
|
|
<tr class="memdesc:a643a711bcb4b7771a7ab1f457e61a417"><td class="mdescLeft"> </td><td class="mdescRight">Enable sync word filtering and generation. <a href="class_r_f69.html#a643a711bcb4b7771a7ab1f457e61a417">More...</a><br /></td></tr>
|
|
<tr class="separator:a643a711bcb4b7771a7ab1f457e61a417"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a400bb57d2353b57c29cf41a6d9497c80"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a400bb57d2353b57c29cf41a6d9497c80">disableSyncWordFiltering</a> ()</td></tr>
|
|
<tr class="memdesc:a400bb57d2353b57c29cf41a6d9497c80"><td class="mdescLeft"> </td><td class="mdescRight">Disable preamble and sync word filtering and generation. <a href="class_r_f69.html#a400bb57d2353b57c29cf41a6d9497c80">More...</a><br /></td></tr>
|
|
<tr class="separator:a400bb57d2353b57c29cf41a6d9497c80"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7e2201b5bc389a68765400b70439f3f0"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a7e2201b5bc389a68765400b70439f3f0">enableContinuousModeBitSync</a> ()</td></tr>
|
|
<tr class="memdesc:a7e2201b5bc389a68765400b70439f3f0"><td class="mdescLeft"> </td><td class="mdescRight">Enable Bit synchronization in continuous mode. <a href="class_r_f69.html#a7e2201b5bc389a68765400b70439f3f0">More...</a><br /></td></tr>
|
|
<tr class="separator:a7e2201b5bc389a68765400b70439f3f0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a97d3570f4f898dde47e3daf8043e7bad"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a97d3570f4f898dde47e3daf8043e7bad">disableContinuousModeBitSync</a> ()</td></tr>
|
|
<tr class="memdesc:a97d3570f4f898dde47e3daf8043e7bad"><td class="mdescLeft"> </td><td class="mdescRight">Disable Bit synchronization in continuous mode. <a href="class_r_f69.html#a97d3570f4f898dde47e3daf8043e7bad">More...</a><br /></td></tr>
|
|
<tr class="separator:a97d3570f4f898dde47e3daf8043e7bad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac205bc487833dc4eae4bb0069c0c4d1e"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ac205bc487833dc4eae4bb0069c0c4d1e">setCrcFiltering</a> (bool crcOn=true)</td></tr>
|
|
<tr class="memdesc:ac205bc487833dc4eae4bb0069c0c4d1e"><td class="mdescLeft"> </td><td class="mdescRight">Enable CRC filtering and generation. <a href="class_r_f69.html#ac205bc487833dc4eae4bb0069c0c4d1e">More...</a><br /></td></tr>
|
|
<tr class="separator:ac205bc487833dc4eae4bb0069c0c4d1e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae004326d663a9d6a9c30e792aa368b49"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ae004326d663a9d6a9c30e792aa368b49">setPromiscuousMode</a> (bool enable=true)</td></tr>
|
|
<tr class="memdesc:ae004326d663a9d6a9c30e792aa368b49"><td class="mdescLeft"> </td><td class="mdescRight">Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address, CRC). <a href="class_r_f69.html#ae004326d663a9d6a9c30e792aa368b49">More...</a><br /></td></tr>
|
|
<tr class="separator:ae004326d663a9d6a9c30e792aa368b49"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a42b99e437454e92c6932c3b7acc1fc4a"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a42b99e437454e92c6932c3b7acc1fc4a">setDataShaping</a> (uint8_t sh) override</td></tr>
|
|
<tr class="memdesc:a42b99e437454e92c6932c3b7acc1fc4a"><td class="mdescLeft"> </td><td class="mdescRight">Sets Gaussian filter bandwidth-time product that will be used for data shaping. 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. <a href="class_r_f69.html#a42b99e437454e92c6932c3b7acc1fc4a">More...</a><br /></td></tr>
|
|
<tr class="separator:a42b99e437454e92c6932c3b7acc1fc4a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae828ce8dda16da4e54d2f18b1fb8af2"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#aae828ce8dda16da4e54d2f18b1fb8af2">setEncoding</a> (uint8_t encoding) override</td></tr>
|
|
<tr class="memdesc:aae828ce8dda16da4e54d2f18b1fb8af2"><td class="mdescLeft"> </td><td class="mdescRight">Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER and RADIOLIB_ENCODING_WHITENING. <a href="class_r_f69.html#aae828ce8dda16da4e54d2f18b1fb8af2">More...</a><br /></td></tr>
|
|
<tr class="separator:aae828ce8dda16da4e54d2f18b1fb8af2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa14dbfd82cd75b9759d4d78bdb05c194"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#aa14dbfd82cd75b9759d4d78bdb05c194">setLnaTestBoost</a> (bool value)</td></tr>
|
|
<tr class="memdesc:aa14dbfd82cd75b9759d4d78bdb05c194"><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable LNA Boost mode (disabled by default). <a href="class_r_f69.html#aa14dbfd82cd75b9759d4d78bdb05c194">More...</a><br /></td></tr>
|
|
<tr class="separator:aa14dbfd82cd75b9759d4d78bdb05c194"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac4fc3f2b178ef08caec3a9f548f44cd7"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ac4fc3f2b178ef08caec3a9f548f44cd7">getRSSI</a> ()</td></tr>
|
|
<tr class="memdesc:ac4fc3f2b178ef08caec3a9f548f44cd7"><td class="mdescLeft"> </td><td class="mdescRight">Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. <a href="class_r_f69.html#ac4fc3f2b178ef08caec3a9f548f44cd7">More...</a><br /></td></tr>
|
|
<tr class="separator:ac4fc3f2b178ef08caec3a9f548f44cd7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afcb723ae58d6519e5b95d017d2beb78a"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#afcb723ae58d6519e5b95d017d2beb78a">setRSSIThreshold</a> (float dbm)</td></tr>
|
|
<tr class="memdesc:afcb723ae58d6519e5b95d017d2beb78a"><td class="mdescLeft"> </td><td class="mdescRight">Sets the RSSI value above which the RSSI interrupt is signaled. <a href="class_r_f69.html#afcb723ae58d6519e5b95d017d2beb78a">More...</a><br /></td></tr>
|
|
<tr class="separator:afcb723ae58d6519e5b95d017d2beb78a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac341945538a84430c61f80f610a94411"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ac341945538a84430c61f80f610a94411">setRfSwitchPins</a> (uint32_t rxEn, uint32_t txEn)</td></tr>
|
|
<tr class="memdesc:ac341945538a84430c61f80f610a94411"><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_r_f69.html#ac341945538a84430c61f80f610a94411">More...</a><br /></td></tr>
|
|
<tr class="separator:ac341945538a84430c61f80f610a94411"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afff64ceef5f496ce035ff6d12d6bcc3c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#afff64ceef5f496ce035ff6d12d6bcc3c">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:afff64ceef5f496ce035ff6d12d6bcc3c"><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_r_f69.html#afff64ceef5f496ce035ff6d12d6bcc3c">More...</a><br /></td></tr>
|
|
<tr class="separator:afff64ceef5f496ce035ff6d12d6bcc3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2023f0f22aad00a702bdf598c2154043"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a2023f0f22aad00a702bdf598c2154043">randomByte</a> ()</td></tr>
|
|
<tr class="memdesc:a2023f0f22aad00a702bdf598c2154043"><td class="mdescLeft"> </td><td class="mdescRight">Get one truly random byte from RSSI noise. <a href="class_r_f69.html#a2023f0f22aad00a702bdf598c2154043">More...</a><br /></td></tr>
|
|
<tr class="separator:a2023f0f22aad00a702bdf598c2154043"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c30202b2d52eb32f43066bc0f938638"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a0c30202b2d52eb32f43066bc0f938638">getChipVersion</a> ()</td></tr>
|
|
<tr class="memdesc:a0c30202b2d52eb32f43066bc0f938638"><td class="mdescLeft"> </td><td class="mdescRight">Read version SPI register. Should return RF69_CHIP_VERSION (0x24) 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. <a href="class_r_f69.html#a0c30202b2d52eb32f43066bc0f938638">More...</a><br /></td></tr>
|
|
<tr class="separator:a0c30202b2d52eb32f43066bc0f938638"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7fd34332bec08828080b1b4a0f8c6e28"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a7fd34332bec08828080b1b4a0f8c6e28">setDirectAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:a7fd34332bec08828080b1b4a0f8c6e28"><td class="mdescLeft"> </td><td class="mdescRight">Set interrupt service routine function to call when data bit is received in direct mode. <a href="class_r_f69.html#a7fd34332bec08828080b1b4a0f8c6e28">More...</a><br /></td></tr>
|
|
<tr class="separator:a7fd34332bec08828080b1b4a0f8c6e28"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab797840275fbccc40162225c32f5ffc3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ab797840275fbccc40162225c32f5ffc3">readBit</a> (uint32_t pin)</td></tr>
|
|
<tr class="memdesc:ab797840275fbccc40162225c32f5ffc3"><td class="mdescLeft"> </td><td class="mdescRight">Function to read and process data bit in direct reception mode. <a href="class_r_f69.html#ab797840275fbccc40162225c32f5ffc3">More...</a><br /></td></tr>
|
|
<tr class="separator:ab797840275fbccc40162225c32f5ffc3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0d7720672c0aa0cf4464d544540cbada"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a0d7720672c0aa0cf4464d544540cbada">setDIOMapping</a> (uint32_t pin, uint32_t value)</td></tr>
|
|
<tr class="memdesc:a0d7720672c0aa0cf4464d544540cbada"><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_r_f69.html#a0d7720672c0aa0cf4464d544540cbada">More...</a><br /></td></tr>
|
|
<tr class="separator:a0d7720672c0aa0cf4464d544540cbada"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a492b2d057dd803c3884fa1adc8e22534"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a492b2d057dd803c3884fa1adc8e22534">transmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a492b2d057dd803c3884fa1adc8e22534"><td class="mdescLeft"> </td><td class="mdescRight">C-string transmit method. <a href="class_r_f69.html#a492b2d057dd803c3884fa1adc8e22534">More...</a><br /></td></tr>
|
|
<tr class="separator:a492b2d057dd803c3884fa1adc8e22534"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3dd42f8d5569487ea74f004ca652a709"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a3dd42f8d5569487ea74f004ca652a709">transmit</a> (uint8_t *data, size_t len, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a3dd42f8d5569487ea74f004ca652a709"><td class="mdescLeft"> </td><td class="mdescRight">Binary transmit method. Must be implemented in module class. <a href="class_r_f69.html#a3dd42f8d5569487ea74f004ca652a709">More...</a><br /></td></tr>
|
|
<tr class="separator:a3dd42f8d5569487ea74f004ca652a709"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab82617fa3fa9f21d4cd427314ecc4af8"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ab82617fa3fa9f21d4cd427314ecc4af8">receive</a> (uint8_t *data, size_t len)</td></tr>
|
|
<tr class="memdesc:ab82617fa3fa9f21d4cd427314ecc4af8"><td class="mdescLeft"> </td><td class="mdescRight">Binary receive method. Must be implemented in module class. <a href="class_r_f69.html#ab82617fa3fa9f21d4cd427314ecc4af8">More...</a><br /></td></tr>
|
|
<tr class="separator:ab82617fa3fa9f21d4cd427314ecc4af8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a923654706eff5118ef6e84214e837f27"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a923654706eff5118ef6e84214e837f27">startTransmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a923654706eff5118ef6e84214e837f27"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. <a href="class_r_f69.html#a923654706eff5118ef6e84214e837f27">More...</a><br /></td></tr>
|
|
<tr class="separator:a923654706eff5118ef6e84214e837f27"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad59e37ce0606dc8051e40be9d14cfec3"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#ad59e37ce0606dc8051e40be9d14cfec3">startTransmit</a> (uint8_t *data, size_t len, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:ad59e37ce0606dc8051e40be9d14cfec3"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven binary transmit method. <a href="class_r_f69.html#ad59e37ce0606dc8051e40be9d14cfec3">More...</a><br /></td></tr>
|
|
<tr class="separator:ad59e37ce0606dc8051e40be9d14cfec3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3563453988a83d22dd07d4691543a300"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a3563453988a83d22dd07d4691543a300">readData</a> (uint8_t *data, size_t len)</td></tr>
|
|
<tr class="memdesc:a3563453988a83d22dd07d4691543a300"><td class="mdescLeft"> </td><td class="mdescRight">Reads data that was received after calling startReceive method. <a href="class_r_f69.html#a3563453988a83d22dd07d4691543a300">More...</a><br /></td></tr>
|
|
<tr class="separator:a3563453988a83d22dd07d4691543a300"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_physical_layer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_physical_layer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_physical_layer.html">PhysicalLayer</a></td></tr>
|
|
<tr class="memitem:add63d7d4fa8b14df5e185813794a49d5 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#add63d7d4fa8b14df5e185813794a49d5">PhysicalLayer</a> (float step, size_t maxLen)</td></tr>
|
|
<tr class="memdesc:add63d7d4fa8b14df5e185813794a49d5 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_physical_layer.html#add63d7d4fa8b14df5e185813794a49d5">More...</a><br /></td></tr>
|
|
<tr class="separator:add63d7d4fa8b14df5e185813794a49d5 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">transmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">C-string transmit method. <a href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">More...</a><br /></td></tr>
|
|
<tr class="separator:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem: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:a11b4c6d0bf3ae7b9ca04e9434180feab 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#a11b4c6d0bf3ae7b9ca04e9434180feab">invertIQ</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:a11b4c6d0bf3ae7b9ca04e9434180feab inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Set IQ inversion. Must be implemented in module class if the module supports it. <a href="class_physical_layer.html#a11b4c6d0bf3ae7b9ca04e9434180feab">More...</a><br /></td></tr>
|
|
<tr class="separator:a11b4c6d0bf3ae7b9ca04e9434180feab inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2286dc78dbf8e3084f38e9159b99ae5 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ad2286dc78dbf8e3084f38e9159b99ae5">setOutputPower</a> (int8_t power)</td></tr>
|
|
<tr class="memdesc:ad2286dc78dbf8e3084f38e9159b99ae5 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Set output power. Must be implemented in module class if the module supports it. <a href="class_physical_layer.html#ad2286dc78dbf8e3084f38e9159b99ae5">More...</a><br /></td></tr>
|
|
<tr class="separator:ad2286dc78dbf8e3084f38e9159b99ae5 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c71cdc1238e1368274670758431a977 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#a6c71cdc1238e1368274670758431a977">setSyncWord</a> (uint8_t *sync, size_t len)</td></tr>
|
|
<tr class="memdesc:a6c71cdc1238e1368274670758431a977 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Set sync word. Must be implemented in module class if the module supports it. <a href="class_physical_layer.html#a6c71cdc1238e1368274670758431a977">More...</a><br /></td></tr>
|
|
<tr class="separator:a6c71cdc1238e1368274670758431a977 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85db1ff64e6c56e054f276c511194633 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#a85db1ff64e6c56e054f276c511194633">setPreambleLength</a> (size_t len)</td></tr>
|
|
<tr class="memdesc:a85db1ff64e6c56e054f276c511194633 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Set preamble length. Must be implemented in module class if the module supports it. <a href="class_physical_layer.html#a85db1ff64e6c56e054f276c511194633">More...</a><br /></td></tr>
|
|
<tr class="separator:a85db1ff64e6c56e054f276c511194633 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ee1fed6bbb8d3571974153ac6f26751 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#a6ee1fed6bbb8d3571974153ac6f26751">setDataRate</a> (<a class="el" href="union_data_rate__t.html">DataRate_t</a> dr)</td></tr>
|
|
<tr class="memdesc:a6ee1fed6bbb8d3571974153ac6f26751 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Set data. Must be implemented in module class if the module supports it. <a href="class_physical_layer.html#a6ee1fed6bbb8d3571974153ac6f26751">More...</a><br /></td></tr>
|
|
<tr class="separator:a6ee1fed6bbb8d3571974153ac6f26751 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a58d54eeb40fb586013ba48e15318abba 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#a58d54eeb40fb586013ba48e15318abba">checkDataRate</a> (<a class="el" href="union_data_rate__t.html">DataRate_t</a> dr)</td></tr>
|
|
<tr class="memdesc:a58d54eeb40fb586013ba48e15318abba inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Check the data rate can be configured by this module. Must be implemented in module class if the module supports it. <a href="class_physical_layer.html#a58d54eeb40fb586013ba48e15318abba">More...</a><br /></td></tr>
|
|
<tr class="separator:a58d54eeb40fb586013ba48e15318abba 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:aedddaf9460941b90e43e9005035faa0f inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#aedddaf9460941b90e43e9005035faa0f">getSNR</a> ()</td></tr>
|
|
<tr class="memdesc:aedddaf9460941b90e43e9005035faa0f inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. <a href="class_physical_layer.html#aedddaf9460941b90e43e9005035faa0f">More...</a><br /></td></tr>
|
|
<tr class="separator:aedddaf9460941b90e43e9005035faa0f inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50e730a894f60b58034507ad7730dd3c inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a50e730a894f60b58034507ad7730dd3c">getTimeOnAir</a> (size_t len)</td></tr>
|
|
<tr class="memdesc:a50e730a894f60b58034507ad7730dd3c inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get expected time-on-air for a given size of payload. <a href="class_physical_layer.html#a50e730a894f60b58034507ad7730dd3c">More...</a><br /></td></tr>
|
|
<tr class="separator:a50e730a894f60b58034507ad7730dd3c inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f8d12a90158864a8ebc471b0ec89dc9 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a7f8d12a90158864a8ebc471b0ec89dc9">calculateRxTimeout</a> (<a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> timeoutUs)</td></tr>
|
|
<tr class="memdesc:a7f8d12a90158864a8ebc471b0ec89dc9 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the timeout value for this specific module / series (in number of symbols or units of time) <a href="class_physical_layer.html#a7f8d12a90158864a8ebc471b0ec89dc9">More...</a><br /></td></tr>
|
|
<tr class="separator:a7f8d12a90158864a8ebc471b0ec89dc9 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d1fe00d107bbc23b0315fd442bc3292 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#a1d1fe00d107bbc23b0315fd442bc3292">irqRxDoneRxTimeout</a> (uint16_t &irqFlags, uint16_t &irqMask)</td></tr>
|
|
<tr class="memdesc:a1d1fe00d107bbc23b0315fd442bc3292 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Create the flags that make up RxDone and RxTimeout used for receiving downlinks. <a href="class_physical_layer.html#a1d1fe00d107bbc23b0315fd442bc3292">More...</a><br /></td></tr>
|
|
<tr class="separator:a1d1fe00d107bbc23b0315fd442bc3292 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acb8d8182a32439fe91f2806d73e629f4 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#acb8d8182a32439fe91f2806d73e629f4">isRxTimeout</a> ()</td></tr>
|
|
<tr class="memdesc:acb8d8182a32439fe91f2806d73e629f4 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the IRQ bit for RxTimeout is set. <a href="class_physical_layer.html#acb8d8182a32439fe91f2806d73e629f4">More...</a><br /></td></tr>
|
|
<tr class="separator:acb8d8182a32439fe91f2806d73e629f4 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae30dfbb5445bb674898fc54f5f90b2f9 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#ae30dfbb5445bb674898fc54f5f90b2f9">startChannelScan</a> ()</td></tr>
|
|
<tr class="memdesc:ae30dfbb5445bb674898fc54f5f90b2f9 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. <a href="class_physical_layer.html#ae30dfbb5445bb674898fc54f5f90b2f9">More...</a><br /></td></tr>
|
|
<tr class="separator:ae30dfbb5445bb674898fc54f5f90b2f9 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a63979795a7b53557560bb95b65480906 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#a63979795a7b53557560bb95b65480906">getChannelScanResult</a> ()</td></tr>
|
|
<tr class="memdesc:a63979795a7b53557560bb95b65480906 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Read the channel scan result. <a href="class_physical_layer.html#a63979795a7b53557560bb95b65480906">More...</a><br /></td></tr>
|
|
<tr class="separator:a63979795a7b53557560bb95b65480906 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd9e39cc745acbf084cfa0d3f4d10718 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#abd9e39cc745acbf084cfa0d3f4d10718">scanChannel</a> ()</td></tr>
|
|
<tr class="memdesc:abd9e39cc745acbf084cfa0d3f4d10718 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. <a href="class_physical_layer.html#abd9e39cc745acbf084cfa0d3f4d10718">More...</a><br /></td></tr>
|
|
<tr class="separator:abd9e39cc745acbf084cfa0d3f4d10718 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:ae11c191a7edf3116bf468b9153237260 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ae11c191a7edf3116bf468b9153237260">setChannelScanAction</a> (void(*func)(void))</td></tr>
|
|
<tr class="memdesc:ae11c191a7edf3116bf468b9153237260 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Sets interrupt service routine to call when a channel scan is finished. <a href="class_physical_layer.html#ae11c191a7edf3116bf468b9153237260">More...</a><br /></td></tr>
|
|
<tr class="separator:ae11c191a7edf3116bf468b9153237260 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a169a4d04c5c50d3336e274d70930d9f6 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top"><a id="a169a4d04c5c50d3336e274d70930d9f6"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a169a4d04c5c50d3336e274d70930d9f6">clearChannelScanAction</a> ()</td></tr>
|
|
<tr class="memdesc:a169a4d04c5c50d3336e274d70930d9f6 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Clears interrupt service routine to call when a channel scan is finished. <br /></td></tr>
|
|
<tr class="separator:a169a4d04c5c50d3336e274d70930d9f6 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Control class for RF69 module. Also serves as base class for <a class="el" href="class_s_x1231.html" title="Control class for SX1231 module. Overrides some methods from RF69 due to different register values.">SX1231</a>. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="afbc84d4f91502bcbe12ddda2fde51448"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afbc84d4f91502bcbe12ddda2fde51448">◆ </a></span>RF69()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">RF69::RF69 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_module.html">Module</a> * </td>
|
|
<td class="paramname"><em>module</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">module</td><td>Instance of <a class="el" href="class_module.html" title="Implements all common low-level methods to control the wireless module. Every module class contains o...">Module</a> that will be used to communicate with the radio. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a637ea5386066f5608bcbb4266e5c1bd6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a637ea5386066f5608bcbb4266e5c1bd6">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freq</em> = <code>RADIOLIB_RF69_DEFAULT_FREQ</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>br</em> = <code>RADIOLIB_RF69_DEFAULT_BR</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freqDev</em> = <code>RADIOLIB_RF69_DEFAULT_FREQDEV</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>rxBw</em> = <code>RADIOLIB_RF69_DEFAULT_RXBW</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int8_t </td>
|
|
<td class="paramname"><em>pwr</em> = <code>RADIOLIB_RF69_DEFAULT_POWER</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>preambleLen</em> = <code>RADIOLIB_RF69_DEFAULT_PREAMBLELEN</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialization method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">freq</td><td>Carrier frequency in MHz. Defaults to 434.0 MHz. </td></tr>
|
|
<tr><td class="paramname">br</td><td>Bit rate to be used in kbps. Defaults to 4.8 kbps. </td></tr>
|
|
<tr><td class="paramname">freqDev</td><td>Frequency deviation from carrier frequency in kHz Defaults to 5.0 kHz. </td></tr>
|
|
<tr><td class="paramname">rxBw</td><td>Receiver bandwidth in kHz. Defaults to 125.0 kHz. </td></tr>
|
|
<tr><td class="paramname">pwr</td><td>Output power in dBm. Defaults to 10 dBm. </td></tr>
|
|
<tr><td class="paramname">preambleLen</td><td>Preamble Length in bits. Defaults to 16 bits. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5996fc1751e7542baafa0d6c0a6c78ee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5996fc1751e7542baafa0d6c0a6c78ee">◆ </a></span>disableAddressFiltering()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::disableAddressFiltering </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Disables address filtering. Calling this method will also erase previously set addresses. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a15fafb6c24a8b5721623be447628bbaa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a15fafb6c24a8b5721623be447628bbaa">◆ </a></span>disableAES()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::disableAES </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Disables AES encryption. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a97d3570f4f898dde47e3daf8043e7bad"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a97d3570f4f898dde47e3daf8043e7bad">◆ </a></span>disableContinuousModeBitSync()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::disableContinuousModeBitSync </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Disable Bit synchronization in continuous mode. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a400bb57d2353b57c29cf41a6d9497c80"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a400bb57d2353b57c29cf41a6d9497c80">◆ </a></span>disableSyncWordFiltering()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::disableSyncWordFiltering </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Disable preamble and sync word filtering and generation. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1fd4609f419d8b0213ee39b05dd40b69"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1fd4609f419d8b0213ee39b05dd40b69">◆ </a></span>enableAES()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::enableAES </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enables AES encryption. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7e2201b5bc389a68765400b70439f3f0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7e2201b5bc389a68765400b70439f3f0">◆ </a></span>enableContinuousModeBitSync()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::enableContinuousModeBitSync </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable Bit synchronization in continuous mode. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a643a711bcb4b7771a7ab1f457e61a417"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a643a711bcb4b7771a7ab1f457e61a417">◆ </a></span>enableSyncWordFiltering()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::enableSyncWordFiltering </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>maxErrBits</em> = <code>0</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable sync word filtering and generation. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">maxErrBits</td><td>Maximum allowed number of error bits in sync word. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab6d98f3f2d964d1833e20da246a5be89"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab6d98f3f2d964d1833e20da246a5be89">◆ </a></span>fifoAdd()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool RF69::fifoAdd </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>totalLen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int * </td>
|
|
<td class="paramname"><em>remLen</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set interrupt service routine function to call when FIFO is empty. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to the transmission buffer. </td></tr>
|
|
<tr><td class="paramname">totalLen</td><td>Total number of bytes to transmit. </td></tr>
|
|
<tr><td class="paramname">remLen</td><td>Pointer to a counter holding the number of bytes that have been transmitted so far. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True when a complete packet is sent, false if more data is needed. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa6886410230c654400c76ec7710d623c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa6886410230c654400c76ec7710d623c">◆ </a></span>fifoGet()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool RF69::fifoGet </td>
|
|
<td>(</td>
|
|
<td class="paramtype">volatile uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>totalLen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">volatile int * </td>
|
|
<td class="paramname"><em>rcvLen</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set interrupt service routine function to call when FIFO is sufficiently full to read. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to a buffer that stores the receive data. </td></tr>
|
|
<tr><td class="paramname">totalLen</td><td>Total number of bytes to receive. </td></tr>
|
|
<tr><td class="paramname">rcvLen</td><td>Pointer to a counter holding the number of bytes that have been received so far. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True when a complete packet is received, false if more data is needed. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3e449fa06c9e76cf69585bfbeed1c46b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3e449fa06c9e76cf69585bfbeed1c46b">◆ </a></span>finishTransmit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::finishTransmit </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clean up after transmission is done. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a1de26f68b939f5af79ec29cc34c7be18">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0de2a07f264839cda945faebf7319e0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0de2a07f264839cda945faebf7319e0e">◆ </a></span>fixedPacketLengthMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::fixedPacketLengthMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>len</em> = <code>RADIOLIB_RF69_MAX_PACKET_LENGTH</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set modem in fixed packet length mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">len</td><td>Packet length. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c30202b2d52eb32f43066bc0f938638"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c30202b2d52eb32f43066bc0f938638">◆ </a></span>getChipVersion()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::getChipVersion </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read version SPI register. Should return RF69_CHIP_VERSION (0x24) 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. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Version register contents or <a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2391eb6e07db3795e993b59b3a85cfed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2391eb6e07db3795e993b59b3a85cfed">◆ </a></span>getFrequency()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::getFrequency </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>freq</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets carrier frequency. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">freq</td><td>Variable to write carrier frequency currently set, in MHz. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2bf0d5e045ccfecf9510773148cdd2c9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2bf0d5e045ccfecf9510773148cdd2c9">◆ </a></span>getFrequencyDeviation()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::getFrequencyDeviation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>freqDev</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets frequency deviation. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">freqDev</td><td>Where to write the frequency deviation currently set, in kHz. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a86a080086c0228d23e2cb77d2b1915c1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a86a080086c0228d23e2cb77d2b1915c1">◆ </a></span>getPacketLength()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t RF69::getPacketLength </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>update</em> = <code>true</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Query modem for the packet length of received payload. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">update</td><td>Update received packet length. Will return cached value when set to false. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Length of last received packet in bytes. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a2fe95169b5cdc8cabe1f2af66cad6ef6">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac4fc3f2b178ef08caec3a9f548f44cd7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac4fc3f2b178ef08caec3a9f548f44cd7">◆ </a></span>getRSSI()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float RF69::getRSSI </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Last packet RSSI in dBm. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#aabc94ab27a9ee6daaafa9b47dde5f75b">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0526ce6ea3722fd258f96d9677a60853"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0526ce6ea3722fd258f96d9677a60853">◆ </a></span>getTemperature()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::getTemperature </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Measures temperature. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Measured temperature in degrees Celsius. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2023f0f22aad00a702bdf598c2154043"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2023f0f22aad00a702bdf598c2154043">◆ </a></span>randomByte()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t RF69::randomByte </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get one truly random byte from RSSI noise. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>TRNG byte. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a1a5985308904261dd431f373d47ddee4">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab797840275fbccc40162225c32f5ffc3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab797840275fbccc40162225c32f5ffc3">◆ </a></span>readBit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RF69::readBit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>pin</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Function to read and process data bit in direct reception mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin on which to read. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#acda61fc99cfa373153c50c78380ed885">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3563453988a83d22dd07d4691543a300"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3563453988a83d22dd07d4691543a300">◆ </a></span>readData() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::readData</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads data that was received after calling startReceive method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to array to save the received binary data. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes that will be read. When set to 0, the packet length will be retrieved automatically. When more bytes than received are requested, only the number of bytes requested will be returned. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3983b66c83818b4082805bcafc712f00"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3983b66c83818b4082805bcafc712f00">◆ </a></span>readData() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::readData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads data received after calling startReceive method. When the packet length is not known in advance, getPacketLength method must be called BEFORE calling readData! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to array to save the received binary data. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes that will be read. When set to 0, the packet length will be retrieved automatically. When more bytes than received are requested, only the number of bytes requested will be returned. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab82617fa3fa9f21d4cd427314ecc4af8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab82617fa3fa9f21d4cd427314ecc4af8">◆ </a></span>receive() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::receive</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Binary receive method. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to array to save the received binary data. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes that will be received. Must be known in advance for binary transmissions. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae36e8e6042245621a182b29526fe2245"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae36e8e6042245621a182b29526fe2245">◆ </a></span>receive() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::receive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Blocking binary receive method. Overloads for string-based transmissions are implemented in <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Binary data to be sent. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes to send. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abd556b0f455f9510213b17588a4baf1b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd556b0f455f9510213b17588a4baf1b">◆ </a></span>receiveDirect()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::receiveDirect </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Starts direct mode reception. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#ad9d1dbb2041e87af5a80e12f125a60e6">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abe5b378d7cc274fd8b75881e7d604bf3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abe5b378d7cc274fd8b75881e7d604bf3">◆ </a></span>setAESKey()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RF69::setAESKey </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets AES key. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td>Key to be used for AES encryption. Must be exactly 16 bytes long. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac37d9ddee2adcc8876a182b8ebc3e703"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac37d9ddee2adcc8876a182b8ebc3e703">◆ </a></span>setAmbientTemperature()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RF69::setAmbientTemperature </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int16_t </td>
|
|
<td class="paramname"><em>tempAmbient</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets ambient temperature. Required to correct values from on-board temperature sensor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">tempAmbient</td><td>Ambient temperature in degrees Celsius. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad7f8132912a5dbf38c5cf676ac167d13"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad7f8132912a5dbf38c5cf676ac167d13">◆ </a></span>setBitRate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setBitRate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>br</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets bit rate. Allowed values range from 0.5 to 300.0 kbps. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">br</td><td>Bit rate to be set in kbps. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#aedd39ad84b45c6392087b12d59192d8c">PhysicalLayer</a>.</p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_s_x1233.html#af245e451dca502ee8975c7ecd291a859">SX1233</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1b7598b87ffaabdbe733c47317fa91d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1b7598b87ffaabdbe733c47317fa91d8">◆ </a></span>setBroadcastAddress()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setBroadcastAddress </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>broadAddr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets broadcast address. Calling this method will also enable address filtering for node and broadcast address. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">broadAddr</td><td>Node address to be set. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac205bc487833dc4eae4bb0069c0c4d1e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac205bc487833dc4eae4bb0069c0c4d1e">◆ </a></span>setCrcFiltering()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setCrcFiltering </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>crcOn</em> = <code>true</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable CRC filtering and generation. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">crcOn</td><td>Set or unset CRC filtering. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a42b99e437454e92c6932c3b7acc1fc4a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a42b99e437454e92c6932c3b7acc1fc4a">◆ </a></span>setDataShaping()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setDataShaping </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>sh</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets Gaussian filter bandwidth-time product that will be used for data shaping. 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. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sh</td><td>Gaussian shaping bandwidth-time product that will be used for data shaping </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#aeba04366a0cf05ff3d8227c4f7c8e1e9">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9e50a1183d13ff9984f8438a7e9e4a77"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9e50a1183d13ff9984f8438a7e9e4a77">◆ </a></span>setDio0Action()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RF69::setDio0Action </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets interrupt service routine to call when DIO0 activates. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>ISR to call. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa72ad2ac5238bd87886684064b7494cf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa72ad2ac5238bd87886684064b7494cf">◆ </a></span>setDio1Action()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RF69::setDio1Action </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets interrupt service routine to call when DIO1 activates. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>ISR to call. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0d7720672c0aa0cf4464d544540cbada"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0d7720672c0aa0cf4464d544540cbada">◆ </a></span>setDIOMapping()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setDIOMapping </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>pin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configure DIO pin mapping to get a given signal on a DIO pin (if available). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>Pin number onto which a signal is to be placed. </td></tr>
|
|
<tr><td class="paramname">value</td><td>The value that indicates which function to place on that pin. See chip datasheet for details. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a349e8a22cd28ad89d45460fdeeefc05c">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7fd34332bec08828080b1b4a0f8c6e28"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7fd34332bec08828080b1b4a0f8c6e28">◆ </a></span>setDirectAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RF69::setDirectAction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set interrupt service routine function to call when data bit is received in direct mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>Pointer to interrupt service routine. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#abf96cf4f3cb4c82d44be581dbe615966">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aae828ce8dda16da4e54d2f18b1fb8af2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aae828ce8dda16da4e54d2f18b1fb8af2">◆ </a></span>setEncoding()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setEncoding </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>encoding</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER and RADIOLIB_ENCODING_WHITENING. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">encoding</td><td>Encoding to be used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#acb45b2342400a03a914a91d2ac7fb488">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a788023a0de9d6b43cb4079d12ca90b8d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a788023a0de9d6b43cb4079d12ca90b8d">◆ </a></span>setFifoEmptyAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RF69::setFifoEmptyAction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set interrupt service routine function to call when FIFO is empty. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>Pointer to interrupt service routine. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1a6ecb5fcc42c49bc3d9032e9c5db07b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1a6ecb5fcc42c49bc3d9032e9c5db07b">◆ </a></span>setFifoFullAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RF69::setFifoFullAction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set interrupt service routine function to call when FIFO is full. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>Pointer to interrupt service routine. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab467f0fc318e651d0cdfbc0399d4c34b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab467f0fc318e651d0cdfbc0399d4c34b">◆ </a></span>setFrequency()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setFrequency </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freq</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets carrier frequency. Allowed values are in bands 290.0 to 340.0 MHz, 431.0 to 510.0 MHz and 862.0 to 1020.0 MHz. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">freq</td><td>Carrier frequency to be set in MHz. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a8a194b0fbb66b1a953288bf3b9478d6e">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adb9fbfedf95f34ac537815870b98a9be"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adb9fbfedf95f34ac537815870b98a9be">◆ </a></span>setFrequencyDeviation()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setFrequencyDeviation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freqDev</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets frequency deviation. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">freqDev</td><td>Frequency deviation to be set in kHz. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a2f4f9b428d9ea9af886ca85e5088ed7b">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa14dbfd82cd75b9759d4d78bdb05c194"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa14dbfd82cd75b9759d4d78bdb05c194">◆ </a></span>setLnaTestBoost()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setLnaTestBoost </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable/disable LNA Boost mode (disabled by default). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">value</td><td>True to enable, false to disable. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab9c217d5ece259950780a05c6e41f75c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab9c217d5ece259950780a05c6e41f75c">◆ </a></span>setNodeAddress()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setNodeAddress </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>nodeAddr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets node address. Calling this method will also enable address filtering for node address only. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">nodeAddr</td><td>Node address to be set. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a465df5a2e1f924f6d3ba4eae765847b7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a465df5a2e1f924f6d3ba4eae765847b7">◆ </a></span>setOOK()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setOOK </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enables/disables OOK modulation instead of FSK. Note: This function calls setRxBandwidth again, since register values differ based on OOK mode being enabled/disabled. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>Enable (true) or disable (false) OOK. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2f5852cf0757e38b56b6208760d9a459"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2f5852cf0757e38b56b6208760d9a459">◆ </a></span>setOokFixedThreshold()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setOokFixedThreshold </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Fixed threshold for the Data Slicer in OOK mode or floor threshold for the Data Slicer in OOK when Peak mode is used. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">value</td><td>Fixed threshold value (in dB) in the OOK demodulator. Used when OokThresType = RADIOLIB_RF69_OOK_THRESH_FIXED. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a434420f2def6c383608223105469fda1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a434420f2def6c383608223105469fda1">◆ </a></span>setOokPeakThresholdDecrement()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setOokPeakThresholdDecrement </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Period of decrement of the RSSI threshold in the OOK demodulator. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">value</td><td>Use defines RADIOLIB_RF69_OOK_PEAK_THRESH_DEC_X_X_CHIP </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a219a046c10ddcc0a787ad19346ecad6a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a219a046c10ddcc0a787ad19346ecad6a">◆ </a></span>setOokThresholdType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setOokThresholdType </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>type</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Selects the type of threshold in the OOK data slicer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">type</td><td>Threshold type: RADIOLIB_RF69_OOK_THRESH_PEAK(default), RADIOLIB_RF69_OOK_THRESH_FIXED or RADIOLIB_RF69_OOK_THRESH_AVERAGE </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a721094611fa375e73bd0332ab2d7d113"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a721094611fa375e73bd0332ab2d7d113">◆ </a></span>setOutputPower()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setOutputPower </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int8_t </td>
|
|
<td class="paramname"><em>pwr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>highPower</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets output power. Allowed values range from -18 to 13 dBm for low power modules (RF69C/CW) or -2 to 20 dBm (RF69H/HC/HCW). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pwr</td><td>Output power to be set in dBm. </td></tr>
|
|
<tr><td class="paramname">highPower</td><td>Set to true when using modules high power port (RF69H/HC/HCW). Defaults to false (models without high power port - RF69C/CW). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac8bff26070735a733a24146d414c3c5f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac8bff26070735a733a24146d414c3c5f">◆ </a></span>setPacketReceivedAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RF69::setPacketReceivedAction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets interrupt service routine to call when a packet is received. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>ISR to call. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#aec928bb26f65752aa20cd236fbabb95c">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a27fad7a67c4239c19bd94d1ccfb493ca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a27fad7a67c4239c19bd94d1ccfb493ca">◆ </a></span>setPacketSentAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RF69::setPacketSentAction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>func</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets interrupt service routine to call when a packet is sent. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>ISR to call. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a32b512b34f6575b2109ae3c3f35d1369">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7c84b3f881cad6e05b0f4f68c24496d9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7c84b3f881cad6e05b0f4f68c24496d9">◆ </a></span>setPreambleLength()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setPreambleLength </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>preambleLen</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets preamble length. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">preambleLen</td><td>Preamble length to be set (in bits), allowed values: 16, 24, 32, 48, 64, 96, 128 and 192. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae004326d663a9d6a9c30e792aa368b49"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae004326d663a9d6a9c30e792aa368b49">◆ </a></span>setPromiscuousMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setPromiscuousMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em> = <code>true</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address, CRC). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>Set or unset promiscuous mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac341945538a84430c61f80f610a94411"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac341945538a84430c61f80f610a94411">◆ </a></span>setRfSwitchPins()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RF69::setRfSwitchPins </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>rxEn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>txEn</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Some modules contain external RF switch controlled by pins. This function gives RadioLib control over those pins to automatically switch between various modes: When idle both pins will be LOW, during TX the <code>txEn</code> pin will be HIGH, during RX the <code>rxPin</code> will be HIGH. </p>
|
|
<p>Radiolib will automatically set the pin mode and value of these pins, so do not control them from the sketch.</p>
|
|
<p>When more than two pins or more control over the output values are needed, use the <a class="el" href="class_r_f69.html#afff64ceef5f496ce035ff6d12d6bcc3c" title="Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...">setRfSwitchTable()</a> function.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">rxEn</td><td>RX enable pin. </td></tr>
|
|
<tr><td class="paramname">txEn</td><td>TX enable pin. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afff64ceef5f496ce035ff6d12d6bcc3c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afff64ceef5f496ce035ff6d12d6bcc3c">◆ </a></span>setRfSwitchTable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RF69::setRfSwitchTable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint32_t(&) </td>
|
|
<td class="paramname"><em>pins</em>[Module::RFSWITCH_MAX_PINS], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="struct_module_1_1_rf_switch_mode__t.html">Module::RfSwitchMode_t</a> </td>
|
|
<td class="paramname"><em>table</em>[] </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Some modules contain external RF switch controlled by pins. This function gives RadioLib control over those pins to automatically switch between various modes. </p>
|
|
<p>Radiolib will automatically set the pin mode and value of these pins, so do not control them from the sketch.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pins</td><td>A reference to an array of pins to control. This should always be an array of 3 elements. If you need less pins, use RADIOLIB_NC for the unused elements.</td></tr>
|
|
<tr><td class="paramname">table</td><td>A reference to an array of pin values to use for each supported mode. Each element is an RfSwitchMode_T struct that lists the mode for which it applies and the values for each of the pins passed in the pins argument respectively.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The <code>pins</code> array will be copied into the <a class="el" href="class_module.html" title="Implements all common low-level methods to control the wireless module. Every module class contains o...">Module</a> object, so the original array can be deallocated after this call. However, a reference to the <code>table</code> array will be stored, so that array must remain valid as long RadioLib is being used.</p>
|
|
<p>The <code>mode</code> field in each table row should normally use any of the <code>MODE_*</code> constants from the <a class="el" href="class_module.html#a5a67b3a63420d762ecba9448671c99bf" title="Constants to use in a mode table set be setRfSwitchTable. These constants work for most radios,...">Module::OpMode_t</a> enum. However, some radios support additional modes and will define their own OpMode_t enum.</p>
|
|
<p>The length of the table is variable (to support radios that add additional modes), so the table must always be terminated with the special END_OF_MODE_TABLE value.</p>
|
|
<p>Normally all modes should be listed in the table, but for some radios, modes can be omitted to indicate they are not supported (e.g. when a radio has a high power and low power TX mode but external circuitry only supports low power). If applicable, this is documented in the radio class itself.</p>
|
|
<h4>Example</h4>
|
|
<p>For example, on a board that has an RF switch with an enable pin connected to PA0 and a TX/RX select pin connected to PA1:</p>
|
|
<div class="fragment"><div class="line"><span class="comment">// In global scope, define the pin array and mode table</span></div>
|
|
<div class="line"><span class="keyword">static</span> <span class="keyword">const</span> uint32_t rfswitch_pins[] =</div>
|
|
<div class="line"> {PA0, PA1, RADIOLIB_NC};</div>
|
|
<div class="line"><span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="struct_module_1_1_rf_switch_mode__t.html">Module::RfSwitchMode_t</a> rfswitch_table[] = {</div>
|
|
<div class="line"> {<a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671">Module::MODE_IDLE</a>, {LOW, LOW}},</div>
|
|
<div class="line"> {<a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f">Module::MODE_RX</a>, {HIGH, LOW}},</div>
|
|
<div class="line"> {<a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571">Module::MODE_TX</a>, {HIGH, HIGH}},</div>
|
|
<div class="line"> Module::END_OF_MODE_TABLE,</div>
|
|
<div class="line">};</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="keywordtype">void</span> setup() {</div>
|
|
<div class="line"> ...</div>
|
|
<div class="line"> <span class="comment">// Then somewhere in setup, pass them to radiolib</span></div>
|
|
<div class="line"> radio.setRfSwitchTable(rfswitch_pins, rfswitch_table);</div>
|
|
<div class="line"> ...</div>
|
|
<div class="line">}</div>
|
|
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571">Module::MODE_TX</a></div><div class="ttdeci">@ MODE_TX</div><div class="ttdoc">Transmission mode.</div><div class="ttdef"><b>Definition:</b> Module.h:114</div></div>
|
|
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671">Module::MODE_IDLE</a></div><div class="ttdeci">@ MODE_IDLE</div><div class="ttdoc">Idle mode.</div><div class="ttdef"><b>Definition:</b> Module.h:108</div></div>
|
|
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f">Module::MODE_RX</a></div><div class="ttdeci">@ MODE_RX</div><div class="ttdoc">Receive mode.</div><div class="ttdef"><b>Definition:</b> Module.h:111</div></div>
|
|
<div class="ttc" id="astruct_module_1_1_rf_switch_mode__t_html"><div class="ttname"><a href="struct_module_1_1_rf_switch_mode__t.html">Module::RfSwitchMode_t</a></div><div class="ttdoc">Description of RF switch pin states for a single mode. See setRfSwitchTable for details.</div><div class="ttdef"><b>Definition:</b> Module.h:84</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="afcb723ae58d6519e5b95d017d2beb78a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afcb723ae58d6519e5b95d017d2beb78a">◆ </a></span>setRSSIThreshold()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setRSSIThreshold </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>dbm</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the RSSI value above which the RSSI interrupt is signaled. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dbm</td><td>A dBm value between -127.5 and 0 inclusive </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a735d8f22095a7e69471d73ca021b9d1a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a735d8f22095a7e69471d73ca021b9d1a">◆ </a></span>setRxBandwidth()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setRxBandwidth </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>rxBw</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets receiver bandwidth. Allowed values are 2.6, 3.1, 3.9, 5.2, 6.3, 7.8, 10.4, 12.5, 15.6, 20.8, 25.0, 31.3, 41.7, 50.0, 62.5, 83.3, 100.0, 125.0, 166.7, 200.0, 250.0, 333.3, 400.0 and 500.0 kHz. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">rxBw</td><td>Receiver bandwidth to be set in kHz. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a26667d50ec845c28e17236c69c886561"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a26667d50ec845c28e17236c69c886561">◆ </a></span>setSyncWord()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::setSyncWord </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>syncWord</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>maxErrBits</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets sync word. Up to 8 bytes can be set as sync word. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">syncWord</td><td>Pointer to the array of sync word bytes. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Sync word length in bytes. </td></tr>
|
|
<tr><td class="paramname">maxErrBits</td><td>Maximum allowed number of bit errors in received sync word. Defaults to 0. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a472a04041551cb38d2223fb34f71d8eb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a472a04041551cb38d2223fb34f71d8eb">◆ </a></span>sleep()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::sleep </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the module to sleep mode. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#af1bb9a5da26da8829795ebb72e9c666e">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a20242499eb926ff7b7da6e3f74a9ece1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a20242499eb926ff7b7da6e3f74a9ece1">◆ </a></span>standby() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::standby </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the module to standby mode. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#acbcaf6aefcb77a354797e66222fe5018">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6e3002ab0c58e2087a7d101eda7afa82"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6e3002ab0c58e2087a7d101eda7afa82">◆ </a></span>standby() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::standby </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>mode</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 the module to standby. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mode</td><td>Standby mode to be used. No effect, implemented only for <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a> compatibility. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a7d5da4311092e3df6b193ff303a0c5e8">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afae38fa64242043de34096bf497725f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afae38fa64242043de34096bf497725f1">◆ </a></span>startReceive() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::startReceive </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven receive method. GDO0 will be activated when full packet is received. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a18664ad615c5507ff1690baaca90b094">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae8b6f87d4b798dc8fcda07bfa5af5a66"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae8b6f87d4b798dc8fcda07bfa5af5a66">◆ </a></span>startReceive() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::startReceive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>timeout</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>irqFlags</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>irqMask</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven receive method, implemented for compatibility with <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">timeout</td><td>Ignored. </td></tr>
|
|
<tr><td class="paramname">irqFlags</td><td>Ignored. </td></tr>
|
|
<tr><td class="paramname">irqMask</td><td>Ignored. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Ignored. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a13dbafeeb9dd9ede72cc4d907738ac48">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a923654706eff5118ef6e84214e837f27"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a923654706eff5118ef6e84214e837f27">◆ </a></span>startTransmit() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::startTransmit</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">str</td><td>C-string that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. Only used in FSK mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad59e37ce0606dc8051e40be9d14cfec3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad59e37ce0606dc8051e40be9d14cfec3">◆ </a></span>startTransmit() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::startTransmit</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven binary transmit method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Binary data that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of binary data to transmit (in bytes). </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. Only used in FSK mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a855dc194947b095b821ec1524ba6814c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a855dc194947b095b821ec1524ba6814c">◆ </a></span>startTransmit() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::startTransmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>addr</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interrupt-driven binary transmit method. Overloads for string-based transmissions are implemented in <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Binary data to be sent. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes to send. </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Address to send the data to. Will only be added if address filtering was enabled. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#ad59e37ce0606dc8051e40be9d14cfec3">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a492b2d057dd803c3884fa1adc8e22534"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a492b2d057dd803c3884fa1adc8e22534">◆ </a></span>transmit() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::transmit</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>C-string transmit method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">str</td><td>C-string that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. Only used in FSK mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3dd42f8d5569487ea74f004ca652a709"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3dd42f8d5569487ea74f004ca652a709">◆ </a></span>transmit() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t PhysicalLayer::transmit</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Binary transmit method. Must be implemented in module class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Binary data that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of binary data to transmit (in bytes). </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Node address to transmit the packet to. Only used in FSK mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a09ba80f60ee7974011a4b4f6c18c6847"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a09ba80f60ee7974011a4b4f6c18c6847">◆ </a></span>transmit() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::transmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>addr</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Blocking binary transmit method. Overloads for string-based transmissions are implemented in <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Binary data to be sent. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Number of bytes to send. </td></tr>
|
|
<tr><td class="paramname">addr</td><td>Address to send the data to. Will only be added if address filtering was enabled. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#a3dd42f8d5569487ea74f004ca652a709">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a222682569338abb49d6952430b6eebdd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a222682569338abb49d6952430b6eebdd">◆ </a></span>transmitDirect()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::transmitDirect </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>frf</em> = <code>0</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Starts direct mode transmission. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">frf</td><td>Raw RF frequency value. Defaults to 0, required for quick frequency shifts in RTTY. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_physical_layer.html#aa4c99ac794ee653c2061be4201724b65">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af434c67aabe02258ee6696a59973617b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af434c67aabe02258ee6696a59973617b">◆ </a></span>variablePacketLengthMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::variablePacketLengthMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>maxLen</em> = <code>RADIOLIB_RF69_MAX_PACKET_LENGTH</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set modem in variable packet length mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">maxLen</td><td>Maximum packet length. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/modules/RF69/<a class="el" href="_r_f69_8h_source.html">RF69.h</a></li>
|
|
<li>src/modules/RF69/RF69.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_r_f69.html">RF69</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>
|