1552 lines
86 KiB
HTML
1552 lines
86 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.13"/>
|
|
<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>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
</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.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</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">
|
|
$(document).ready(function(){initNavTree('class_r_f69.html','');});
|
|
</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"/>
|
|
</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="#afbc84d4f91502bcbe12ddda2fde51448">More...</a><br /></td></tr>
|
|
<tr class="separator:afbc84d4f91502bcbe12ddda2fde51448"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d0dea965aba1017a660c9478ec57560"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a4d0dea965aba1017a660c9478ec57560">begin</a> (float freq=434.0, float br=48.0, float freqDev=50.0, float rxBw=125.0, int8_t power=10, uint8_t preambleLen=16)</td></tr>
|
|
<tr class="memdesc:a4d0dea965aba1017a660c9478ec57560"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. <a href="#a4d0dea965aba1017a660c9478ec57560">More...</a><br /></td></tr>
|
|
<tr class="separator:a4d0dea965aba1017a660c9478ec57560"><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="#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="#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="#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="#a20242499eb926ff7b7da6e3f74a9ece1">More...</a><br /></td></tr>
|
|
<tr class="separator:a20242499eb926ff7b7da6e3f74a9ece1"><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="#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="#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="#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="#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="#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="#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="#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: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="#a855dc194947b095b821ec1524ba6814c">More...</a><br /></td></tr>
|
|
<tr class="separator:a855dc194947b095b821ec1524ba6814c"><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="#afae38fa64242043de34096bf497725f1">More...</a><br /></td></tr>
|
|
<tr class="separator:afae38fa64242043de34096bf497725f1"><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. <a href="#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="#ab467f0fc318e651d0cdfbc0399d4c34b">More...</a><br /></td></tr>
|
|
<tr class="separator:ab467f0fc318e651d0cdfbc0399d4c34b"><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 1.2 to 300.0 kbps. <a href="#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="#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="#adb9fbfedf95f34ac537815870b98a9be">More...</a><br /></td></tr>
|
|
<tr class="separator:adb9fbfedf95f34ac537815870b98a9be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a998ddd21fc152d835c6f1b8d31b02fcc"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a998ddd21fc152d835c6f1b8d31b02fcc">setOutputPower</a> (int8_t power, bool highPower=false)</td></tr>
|
|
<tr class="memdesc:a998ddd21fc152d835c6f1b8d31b02fcc"><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="#a998ddd21fc152d835c6f1b8d31b02fcc">More...</a><br /></td></tr>
|
|
<tr class="separator:a998ddd21fc152d835c6f1b8d31b02fcc"><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="#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="#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="#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="#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="#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="#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="#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="#a86a080086c0228d23e2cb77d2b1915c1">More...</a><br /></td></tr>
|
|
<tr class="separator:a86a080086c0228d23e2cb77d2b1915c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c9dcbd7e44bc5e46d9f10ae276a0c5f"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a4c9dcbd7e44bc5e46d9f10ae276a0c5f">fixedPacketLengthMode</a> (uint8_t len=RF69_MAX_PACKET_LENGTH)</td></tr>
|
|
<tr class="memdesc:a4c9dcbd7e44bc5e46d9f10ae276a0c5f"><td class="mdescLeft"> </td><td class="mdescRight">Set modem in fixed packet length mode. <a href="#a4c9dcbd7e44bc5e46d9f10ae276a0c5f">More...</a><br /></td></tr>
|
|
<tr class="separator:a4c9dcbd7e44bc5e46d9f10ae276a0c5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af62ebde1ea34a394b9781a21ae348c39"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#af62ebde1ea34a394b9781a21ae348c39">variablePacketLengthMode</a> (uint8_t maxLen=RF69_MAX_PACKET_LENGTH)</td></tr>
|
|
<tr class="memdesc:af62ebde1ea34a394b9781a21ae348c39"><td class="mdescLeft"> </td><td class="mdescRight">Set modem in variable packet length mode. <a href="#af62ebde1ea34a394b9781a21ae348c39">More...</a><br /></td></tr>
|
|
<tr class="separator:af62ebde1ea34a394b9781a21ae348c39"><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="#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="#a400bb57d2353b57c29cf41a6d9497c80">More...</a><br /></td></tr>
|
|
<tr class="separator:a400bb57d2353b57c29cf41a6d9497c80"><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="#ac205bc487833dc4eae4bb0069c0c4d1e">More...</a><br /></td></tr>
|
|
<tr class="separator:ac205bc487833dc4eae4bb0069c0c4d1e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6d90ad1d455de045c53c5758babd876c"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a6d90ad1d455de045c53c5758babd876c">setPromiscuousMode</a> (bool promiscuous=true)</td></tr>
|
|
<tr class="memdesc:a6d90ad1d455de045c53c5758babd876c"><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="#a6d90ad1d455de045c53c5758babd876c">More...</a><br /></td></tr>
|
|
<tr class="separator:a6d90ad1d455de045c53c5758babd876c"><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="#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="#aae828ce8dda16da4e54d2f18b1fb8af2">More...</a><br /></td></tr>
|
|
<tr class="separator:aae828ce8dda16da4e54d2f18b1fb8af2"><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="#ac4fc3f2b178ef08caec3a9f548f44cd7">More...</a><br /></td></tr>
|
|
<tr class="separator:ac4fc3f2b178ef08caec3a9f548f44cd7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aada7c48828b950cdfd260594d502b03d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#aada7c48828b950cdfd260594d502b03d">setRfSwitchPins</a> (RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)</td></tr>
|
|
<tr class="memdesc:aada7c48828b950cdfd260594d502b03d"><td class="mdescLeft"> </td><td class="mdescRight">Some modules contain external RF switch controlled by two pins. This function gives RadioLib control over those two pins to automatically switch Rx and Tx state. When using automatic RF switch control, DO NOT change the pin mode of rxEn or txEn from Arduino sketch! <a href="#aada7c48828b950cdfd260594d502b03d">More...</a><br /></td></tr>
|
|
<tr class="separator:aada7c48828b950cdfd260594d502b03d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a54cd7be92e166659b50bd6ed4433db4c"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_f69.html#a54cd7be92e166659b50bd6ed4433db4c">random</a> ()</td></tr>
|
|
<tr class="memdesc:a54cd7be92e166659b50bd6ed4433db4c"><td class="mdescLeft"> </td><td class="mdescRight">Get one truly random byte from RSSI noise. <a href="#a54cd7be92e166659b50bd6ed4433db4c">More...</a><br /></td></tr>
|
|
<tr class="separator:a54cd7be92e166659b50bd6ed4433db4c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_physical_layer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_physical_layer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_physical_layer.html">PhysicalLayer</a></td></tr>
|
|
<tr class="memitem:a5e02457f1d519cf81b1590a182321c62 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a5e02457f1d519cf81b1590a182321c62">PhysicalLayer</a> (float freqStep, size_t maxPacketLength)</td></tr>
|
|
<tr class="memdesc:a5e02457f1d519cf81b1590a182321c62 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_physical_layer.html#a5e02457f1d519cf81b1590a182321c62">More...</a><br /></td></tr>
|
|
<tr class="separator:a5e02457f1d519cf81b1590a182321c62 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab139a34e03a6fd5a781cd54da21d308f inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">transmit</a> (__FlashStringHelper *fstr, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:ab139a34e03a6fd5a781cd54da21d308f inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Arduino Flash String transmit method. <a href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">More...</a><br /></td></tr>
|
|
<tr class="separator:ab139a34e03a6fd5a781cd54da21d308f inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb62c5a521aafc1e0525c58e9364482b inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#aeb62c5a521aafc1e0525c58e9364482b">transmit</a> (String &str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:aeb62c5a521aafc1e0525c58e9364482b inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Arduino String transmit method. <a href="class_physical_layer.html#aeb62c5a521aafc1e0525c58e9364482b">More...</a><br /></td></tr>
|
|
<tr class="separator:aeb62c5a521aafc1e0525c58e9364482b inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">transmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">C-string transmit method. <a href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">More...</a><br /></td></tr>
|
|
<tr class="separator:a492b2d057dd803c3884fa1adc8e22534 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb1b090348d9091bfa3a0b5ba3d85b36 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">receive</a> (String &str, size_t len=0)</td></tr>
|
|
<tr class="memdesc:afb1b090348d9091bfa3a0b5ba3d85b36 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Arduino String receive method. <a href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">More...</a><br /></td></tr>
|
|
<tr class="separator:afb1b090348d9091bfa3a0b5ba3d85b36 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af068e6e862c99e39d0261a7971dd56db inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">startTransmit</a> (String &str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:af068e6e862c99e39d0261a7971dd56db inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. <a href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">More...</a><br /></td></tr>
|
|
<tr class="separator:af068e6e862c99e39d0261a7971dd56db inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">startTransmit</a> (const char *str, uint8_t addr=0)</td></tr>
|
|
<tr class="memdesc:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. <a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">More...</a><br /></td></tr>
|
|
<tr class="separator:a923654706eff5118ef6e84214e837f27 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8eed0e888a7c8742e89d2b850977de2 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">readData</a> (String &str, size_t len=0)</td></tr>
|
|
<tr class="memdesc:ae8eed0e888a7c8742e89d2b850977de2 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Reads data that was received after calling startReceive method. <a href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">More...</a><br /></td></tr>
|
|
<tr class="separator:ae8eed0e888a7c8742e89d2b850977de2 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a977e5236693960bb1c79090a201e9e1c inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a977e5236693960bb1c79090a201e9e1c">getFreqStep</a> () const</td></tr>
|
|
<tr class="memdesc:a977e5236693960bb1c79090a201e9e1c inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Gets the module frequency step size that was set in constructor. <a href="class_physical_layer.html#a977e5236693960bb1c79090a201e9e1c">More...</a><br /></td></tr>
|
|
<tr class="separator:a977e5236693960bb1c79090a201e9e1c inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd9171bd71aa80fb86113b612c42de53 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">random</a> (int32_t max)</td></tr>
|
|
<tr class="memdesc:acd9171bd71aa80fb86113b612c42de53 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get truly random number in range 0 - max. <a href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">More...</a><br /></td></tr>
|
|
<tr class="separator:acd9171bd71aa80fb86113b612c42de53 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a76113e10481743094a1cd0280692b0a9 inherit pub_methods_class_physical_layer"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_physical_layer.html#a76113e10481743094a1cd0280692b0a9">random</a> (int32_t min, int32_t max)</td></tr>
|
|
<tr class="memdesc:a76113e10481743094a1cd0280692b0a9 inherit pub_methods_class_physical_layer"><td class="mdescLeft"> </td><td class="mdescRight">Get truly random number in range min - max. <a href="class_physical_layer.html#a76113e10481743094a1cd0280692b0a9">More...</a><br /></td></tr>
|
|
<tr class="separator:a76113e10481743094a1cd0280692b0a9 inherit pub_methods_class_physical_layer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</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">mod</td><td>Instance of <a class="el" href="class_module.html" title="Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class. ">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="a4d0dea965aba1017a660c9478ec57560"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d0dea965aba1017a660c9478ec57560">◆ </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>434.0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>br</em> = <code>48.0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>freqDev</em> = <code>50.0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>rxBw</em> = <code>125.0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int8_t </td>
|
|
<td class="paramname"><em>power</em> = <code>10</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>preambleLen</em> = <code>16</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 48.0 kbps.</td></tr>
|
|
<tr><td class="paramname">freqDev</td><td>Frequency deviation from carrier frequency in kHz Defaults to 50.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">power</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="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="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">numBits</td><td>Sync word length in 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="a4c9dcbd7e44bc5e46d9f10ae276a0c5f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4c9dcbd7e44bc5e46d9f10ae276a0c5f">◆ </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>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="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>Implements <a class="el" href="class_physical_layer.html#a0bd6046e068ef63e3f2b6bead48e02a7">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="memname">
|
|
<tr>
|
|
<td class="memname">float RF69::getRSSI </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></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>
|
|
|
|
</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="a54cd7be92e166659b50bd6ed4433db4c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a54cd7be92e166659b50bd6ed4433db4c">◆ </a></span>random()</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::random </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>Implements <a class="el" href="class_physical_layer.html#a5bf5bac5b015aa9312025255ca503d4f">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3983b66c83818b4082805bcafc712f00"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3983b66c83818b4082805bcafc712f00">◆ </a></span>readData()</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. </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>
|
|
|
|
<p>Implements <a class="el" href="class_physical_layer.html#ae8b6c756eb4b92855433ca389d73c632">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae36e8e6042245621a182b29526fe2245"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae36e8e6042245621a182b29526fe2245">◆ </a></span>receive()</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>Implements <a class="el" href="class_physical_layer.html#a2ad4c6a8ac267f8ac590260414ffcda3">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>Implements <a class="el" href="class_physical_layer.html#a46b22145b33e97cf6065ed826799b6b4">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>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="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>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets bit rate. Allowed values range from 1.2 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>
|
|
|
|
</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 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="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>Implements <a class="el" href="class_physical_layer.html#ab643a814dce48f71a13bf6ea23f44cbd">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="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>Implements <a class="el" href="class_physical_layer.html#a7d3419227d201d6912b77784636d437d">PhysicalLayer</a>.</p>
|
|
|
|
</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="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>
|
|
</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>
|
|
|
|
</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>Implements <a class="el" href="class_physical_layer.html#ab9060e8ab7a2da192b3bf53b3501553b">PhysicalLayer</a>.</p>
|
|
|
|
</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="a998ddd21fc152d835c6f1b8d31b02fcc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a998ddd21fc152d835c6f1b8d31b02fcc">◆ </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>power</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">power</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="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="a6d90ad1d455de045c53c5758babd876c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6d90ad1d455de045c53c5758babd876c">◆ </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>promiscuous</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">promiscuous</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="aada7c48828b950cdfd260594d502b03d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aada7c48828b950cdfd260594d502b03d">◆ </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">RADIOLIB_PIN_TYPE </td>
|
|
<td class="paramname"><em>rxEn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">RADIOLIB_PIN_TYPE </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 two pins. This function gives RadioLib control over those two pins to automatically switch Rx and Tx state. When using automatic RF switch control, DO NOT change the pin mode of rxEn or txEn from Arduino sketch! </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="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="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::sleep </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a20242499eb926ff7b7da6e3f74a9ece1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a20242499eb926ff7b7da6e3f74a9ece1">◆ </a></span>standby()</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>Implements <a class="el" href="class_physical_layer.html#a0e77da761a2cbb5c9535df0bdea993f9">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afae38fa64242043de34096bf497725f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afae38fa64242043de34096bf497725f1">◆ </a></span>startReceive()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t RF69::startReceive </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a855dc194947b095b821ec1524ba6814c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a855dc194947b095b821ec1524ba6814c">◆ </a></span>startTransmit()</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>Implements <a class="el" href="class_physical_layer.html#a41a1de0ebffe7b65de6fd8cceb9a5123">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a09ba80f60ee7974011a4b4f6c18c6847"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a09ba80f60ee7974011a4b4f6c18c6847">◆ </a></span>transmit()</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>Implements <a class="el" href="class_physical_layer.html#af81565ee82ef9a7de9c5663c745f4ef7">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>Implements <a class="el" href="class_physical_layer.html#a4b04eb6155b06d8ef400131c647d54e7">PhysicalLayer</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af62ebde1ea34a394b9781a21ae348c39"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af62ebde1ea34a394b9781a21ae348c39">◆ </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>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">len</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="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|