1346 lines
75 KiB
HTML
1346 lines
75 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: LoRaWANNode 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_lo_ra_w_a_n_node.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_lo_ra_w_a_n_node-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">LoRaWANNode Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>LoRaWAN-compatible node (class A device).
|
|
<a href="class_lo_ra_w_a_n_node.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_lo_ra_w_a_n_8h_source.html">LoRaWAN.h</a>></code></p>
|
|
<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:aae05de563f765f14fe267e4d65844f76"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#aae05de563f765f14fe267e4d65844f76">LoRaWANNode</a> (<a class="el" href="class_physical_layer.html">PhysicalLayer</a> *phy, const <a class="el" href="struct_lo_ra_w_a_n_band__t.html">LoRaWANBand_t</a> *band, uint8_t subBand=0)</td></tr>
|
|
<tr class="memdesc:aae05de563f765f14fe267e4d65844f76"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_lo_ra_w_a_n_node.html#aae05de563f765f14fe267e4d65844f76">More...</a><br /></td></tr>
|
|
<tr class="separator:aae05de563f765f14fe267e4d65844f76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0feeaed200d8f94ad94c3ed49f404847"><td class="memItemLeft" align="right" valign="top"><a id="a0feeaed200d8f94ad94c3ed49f404847"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a0feeaed200d8f94ad94c3ed49f404847">clearSession</a> ()</td></tr>
|
|
<tr class="memdesc:a0feeaed200d8f94ad94c3ed49f404847"><td class="mdescLeft"> </td><td class="mdescRight">Clear an active session, so that the device will have to rejoin the network. <br /></td></tr>
|
|
<tr class="separator:a0feeaed200d8f94ad94c3ed49f404847"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a84004883006b4a498d4899874952445b"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a84004883006b4a498d4899874952445b">getBufferNonces</a> ()</td></tr>
|
|
<tr class="memdesc:a84004883006b4a498d4899874952445b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the pointer to the internal buffer that holds the LW base parameters. <a href="class_lo_ra_w_a_n_node.html#a84004883006b4a498d4899874952445b">More...</a><br /></td></tr>
|
|
<tr class="separator:a84004883006b4a498d4899874952445b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a11701081ac6bd39a8a2b4bdbc248fac2"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a11701081ac6bd39a8a2b4bdbc248fac2">setBufferNonces</a> (uint8_t *persistentBuffer)</td></tr>
|
|
<tr class="memdesc:a11701081ac6bd39a8a2b4bdbc248fac2"><td class="mdescLeft"> </td><td class="mdescRight">Fill the internal buffer that holds the LW base parameters with a supplied buffer. <a href="class_lo_ra_w_a_n_node.html#a11701081ac6bd39a8a2b4bdbc248fac2">More...</a><br /></td></tr>
|
|
<tr class="separator:a11701081ac6bd39a8a2b4bdbc248fac2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a90369a4f2c4da11527872a7bbbf9ab06"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a90369a4f2c4da11527872a7bbbf9ab06">getBufferSession</a> ()</td></tr>
|
|
<tr class="memdesc:a90369a4f2c4da11527872a7bbbf9ab06"><td class="mdescLeft"> </td><td class="mdescRight">Returns the pointer to the internal buffer that holds the LW session parameters. <a href="class_lo_ra_w_a_n_node.html#a90369a4f2c4da11527872a7bbbf9ab06">More...</a><br /></td></tr>
|
|
<tr class="separator:a90369a4f2c4da11527872a7bbbf9ab06"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aadebe7a412aec8043aa2f8f57a202f49"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#aadebe7a412aec8043aa2f8f57a202f49">setBufferSession</a> (uint8_t *persistentBuffer)</td></tr>
|
|
<tr class="memdesc:aadebe7a412aec8043aa2f8f57a202f49"><td class="mdescLeft"> </td><td class="mdescRight">Fill the internal buffer that holds the LW session parameters with a supplied buffer. <a href="class_lo_ra_w_a_n_node.html#aadebe7a412aec8043aa2f8f57a202f49">More...</a><br /></td></tr>
|
|
<tr class="separator:aadebe7a412aec8043aa2f8f57a202f49"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2303cbbfc9c18e267c074284a4f1bf68"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a2303cbbfc9c18e267c074284a4f1bf68">beginOTAA</a> (uint64_t joinEUI, uint64_t devEUI, uint8_t *nwkKey, uint8_t *appKey)</td></tr>
|
|
<tr class="memdesc:a2303cbbfc9c18e267c074284a4f1bf68"><td class="mdescLeft"> </td><td class="mdescRight">Set the device credentials and activation configuration. <a href="class_lo_ra_w_a_n_node.html#a2303cbbfc9c18e267c074284a4f1bf68">More...</a><br /></td></tr>
|
|
<tr class="separator:a2303cbbfc9c18e267c074284a4f1bf68"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd9e976eec64a3bd1ddf3331f2bc93cd"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#abd9e976eec64a3bd1ddf3331f2bc93cd">activateOTAA</a> (uint8_t initialDr=RADIOLIB_LORAWAN_DATA_RATE_UNUSED, <a class="el" href="struct_lo_ra_w_a_n_join_event__t.html">LoRaWANJoinEvent_t</a> *joinEvent=NULL)</td></tr>
|
|
<tr class="memdesc:abd9e976eec64a3bd1ddf3331f2bc93cd"><td class="mdescLeft"> </td><td class="mdescRight">Join network by restoring OTAA session or performing over-the-air activation. By this procedure, the device will perform an exchange with the network server and set all necessary configuration. <a href="class_lo_ra_w_a_n_node.html#abd9e976eec64a3bd1ddf3331f2bc93cd">More...</a><br /></td></tr>
|
|
<tr class="separator:abd9e976eec64a3bd1ddf3331f2bc93cd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92c59b540dee631e7bd8153479328611"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a92c59b540dee631e7bd8153479328611">beginABP</a> (uint32_t addr, uint8_t *fNwkSIntKey, uint8_t *sNwkSIntKey, uint8_t *nwkSEncKey, uint8_t *appSKey)</td></tr>
|
|
<tr class="memdesc:a92c59b540dee631e7bd8153479328611"><td class="mdescLeft"> </td><td class="mdescRight">Set the device credentials and activation configuration. <a href="class_lo_ra_w_a_n_node.html#a92c59b540dee631e7bd8153479328611">More...</a><br /></td></tr>
|
|
<tr class="separator:a92c59b540dee631e7bd8153479328611"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a77483c51548e48a5dff4b707f7770e86"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a77483c51548e48a5dff4b707f7770e86">activateABP</a> (uint8_t initialDr=RADIOLIB_LORAWAN_DATA_RATE_UNUSED)</td></tr>
|
|
<tr class="memdesc:a77483c51548e48a5dff4b707f7770e86"><td class="mdescLeft"> </td><td class="mdescRight">Join network by restoring ABP session or performing over-the-air activation. In this procedure, all necessary configuration must be provided by the user. <a href="class_lo_ra_w_a_n_node.html#a77483c51548e48a5dff4b707f7770e86">More...</a><br /></td></tr>
|
|
<tr class="separator:a77483c51548e48a5dff4b707f7770e86"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a44677a1ef7db1216bc482139d6be8d"><td class="memItemLeft" align="right" valign="top"><a id="a9a44677a1ef7db1216bc482139d6be8d"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a9a44677a1ef7db1216bc482139d6be8d">isActivated</a> ()</td></tr>
|
|
<tr class="memdesc:a9a44677a1ef7db1216bc482139d6be8d"><td class="mdescLeft"> </td><td class="mdescRight">Whether there is an ongoing session active. <br /></td></tr>
|
|
<tr class="separator:a9a44677a1ef7db1216bc482139d6be8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:addfd8ac3d0bfe5a273e9ba10e51f8025"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#addfd8ac3d0bfe5a273e9ba10e51f8025">setRx2Dr</a> (uint8_t dr)</td></tr>
|
|
<tr class="memdesc:addfd8ac3d0bfe5a273e9ba10e51f8025"><td class="mdescLeft"> </td><td class="mdescRight">Configure the Rx2 datarate for ABP mode. This should not be needed for LoRaWAN 1.1 as it is configured through the first downlink. <a href="class_lo_ra_w_a_n_node.html#addfd8ac3d0bfe5a273e9ba10e51f8025">More...</a><br /></td></tr>
|
|
<tr class="separator:addfd8ac3d0bfe5a273e9ba10e51f8025"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adef05650cf4eb92042ca5e2688c1e164"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#adef05650cf4eb92042ca5e2688c1e164">sendMacCommandReq</a> (uint8_t cid)</td></tr>
|
|
<tr class="memdesc:adef05650cf4eb92042ca5e2688c1e164"><td class="mdescLeft"> </td><td class="mdescRight">Add a MAC command to the uplink queue. Only LinkCheck and DeviceTime are available to the user. Other commands are ignored; duplicate MAC commands are discarded. <a href="class_lo_ra_w_a_n_node.html#adef05650cf4eb92042ca5e2688c1e164">More...</a><br /></td></tr>
|
|
<tr class="separator:adef05650cf4eb92042ca5e2688c1e164"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1fa484970865e476311bf25969968fff"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a1fa484970865e476311bf25969968fff">uplink</a> (const char *str, uint8_t fPort, bool isConfirmed=false, <a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> *event=NULL)</td></tr>
|
|
<tr class="memdesc:a1fa484970865e476311bf25969968fff"><td class="mdescLeft"> </td><td class="mdescRight">Send a message to the server. <a href="class_lo_ra_w_a_n_node.html#a1fa484970865e476311bf25969968fff">More...</a><br /></td></tr>
|
|
<tr class="separator:a1fa484970865e476311bf25969968fff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66c170a6055e66915d3e94ce43a63e58"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a66c170a6055e66915d3e94ce43a63e58">uplink</a> (uint8_t *data, size_t len, uint8_t fPort, bool isConfirmed=false, <a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> *event=NULL)</td></tr>
|
|
<tr class="memdesc:a66c170a6055e66915d3e94ce43a63e58"><td class="mdescLeft"> </td><td class="mdescRight">Send a message to the server. <a href="class_lo_ra_w_a_n_node.html#a66c170a6055e66915d3e94ce43a63e58">More...</a><br /></td></tr>
|
|
<tr class="separator:a66c170a6055e66915d3e94ce43a63e58"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aabced307f6662998608f01fab25e4226"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#aabced307f6662998608f01fab25e4226">downlink</a> (uint8_t *data, size_t *len, <a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> *event=NULL)</td></tr>
|
|
<tr class="memdesc:aabced307f6662998608f01fab25e4226"><td class="mdescLeft"> </td><td class="mdescRight">Wait for downlink from the server in either RX1 or RX2 window. <a href="class_lo_ra_w_a_n_node.html#aabced307f6662998608f01fab25e4226">More...</a><br /></td></tr>
|
|
<tr class="separator:aabced307f6662998608f01fab25e4226"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae532e739ada04ea7463494a426f60b4d"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#ae532e739ada04ea7463494a426f60b4d">downlink</a> (<a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> *event=NULL)</td></tr>
|
|
<tr class="memdesc:ae532e739ada04ea7463494a426f60b4d"><td class="mdescLeft"> </td><td class="mdescRight">Wait for downlink, simplified to allow for simpler sendReceive. <a href="class_lo_ra_w_a_n_node.html#ae532e739ada04ea7463494a426f60b4d">More...</a><br /></td></tr>
|
|
<tr class="separator:ae532e739ada04ea7463494a426f60b4d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85cf006ffd97ece3b2d2974b715540cb"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a85cf006ffd97ece3b2d2974b715540cb">sendReceive</a> (const char *strUp, uint8_t fPort, uint8_t *dataDown, size_t *lenDown, bool isConfirmed=false, <a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> *eventUp=NULL, <a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> *eventDown=NULL)</td></tr>
|
|
<tr class="memdesc:a85cf006ffd97ece3b2d2974b715540cb"><td class="mdescLeft"> </td><td class="mdescRight">Send a message to the server and wait for a downlink during Rx1 and/or Rx2 window. <a href="class_lo_ra_w_a_n_node.html#a85cf006ffd97ece3b2d2974b715540cb">More...</a><br /></td></tr>
|
|
<tr class="separator:a85cf006ffd97ece3b2d2974b715540cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07ab107de181bde59c2731a5a64a1e2e"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a07ab107de181bde59c2731a5a64a1e2e">sendReceive</a> (uint8_t *dataUp, size_t lenUp, uint8_t fPort, uint8_t *dataDown, size_t *lenDown, bool isConfirmed=false, <a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> *eventUp=NULL, <a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> *eventDown=NULL)</td></tr>
|
|
<tr class="memdesc:a07ab107de181bde59c2731a5a64a1e2e"><td class="mdescLeft"> </td><td class="mdescRight">Send a message to the server and wait for a downlink during Rx1 and/or Rx2 window. <a href="class_lo_ra_w_a_n_node.html#a07ab107de181bde59c2731a5a64a1e2e">More...</a><br /></td></tr>
|
|
<tr class="separator:a07ab107de181bde59c2731a5a64a1e2e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7123f9a907df9224b9b01282c12af459"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a7123f9a907df9224b9b01282c12af459">sendReceive</a> (uint8_t *dataUp, size_t lenUp, uint8_t fPort=1, bool isConfirmed=false, <a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> *eventUp=NULL, <a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> *eventDown=NULL)</td></tr>
|
|
<tr class="memdesc:a7123f9a907df9224b9b01282c12af459"><td class="mdescLeft"> </td><td class="mdescRight">Send a message to the server and wait for a downlink but don't bother the user with downlink contents. <a href="class_lo_ra_w_a_n_node.html#a7123f9a907df9224b9b01282c12af459">More...</a><br /></td></tr>
|
|
<tr class="separator:a7123f9a907df9224b9b01282c12af459"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5449e301634dff1838a1b024b4067034"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a5449e301634dff1838a1b024b4067034">setDeviceStatus</a> (uint8_t battLevel)</td></tr>
|
|
<tr class="memdesc:a5449e301634dff1838a1b024b4067034"><td class="mdescLeft"> </td><td class="mdescRight">Set device status. <a href="class_lo_ra_w_a_n_node.html#a5449e301634dff1838a1b024b4067034">More...</a><br /></td></tr>
|
|
<tr class="separator:a5449e301634dff1838a1b024b4067034"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3217975ef9959ff83ce79dd80b0d777"><td class="memItemLeft" align="right" valign="top"><a id="ad3217975ef9959ff83ce79dd80b0d777"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#ad3217975ef9959ff83ce79dd80b0d777">getFCntUp</a> ()</td></tr>
|
|
<tr class="memdesc:ad3217975ef9959ff83ce79dd80b0d777"><td class="mdescLeft"> </td><td class="mdescRight">Returns the last uplink's frame counter; also 0 if no uplink occured yet. <br /></td></tr>
|
|
<tr class="separator:ad3217975ef9959ff83ce79dd80b0d777"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa7fabaa6efe9978c3674b1ab187446a1"><td class="memItemLeft" align="right" valign="top"><a id="aa7fabaa6efe9978c3674b1ab187446a1"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#aa7fabaa6efe9978c3674b1ab187446a1">getNFCntDown</a> ()</td></tr>
|
|
<tr class="memdesc:aa7fabaa6efe9978c3674b1ab187446a1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the last network downlink's frame counter; also 0 if no network downlink occured yet. <br /></td></tr>
|
|
<tr class="separator:aa7fabaa6efe9978c3674b1ab187446a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6785265f3311ff6bf296f82429c96701"><td class="memItemLeft" align="right" valign="top"><a id="a6785265f3311ff6bf296f82429c96701"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a6785265f3311ff6bf296f82429c96701">getAFCntDown</a> ()</td></tr>
|
|
<tr class="memdesc:a6785265f3311ff6bf296f82429c96701"><td class="mdescLeft"> </td><td class="mdescRight">Returns the last application downlink's frame counter; also 0 if no application downlink occured yet. <br /></td></tr>
|
|
<tr class="separator:a6785265f3311ff6bf296f82429c96701"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af4b3d07cd9bf4178d627204bae18b648"><td class="memItemLeft" align="right" valign="top"><a id="af4b3d07cd9bf4178d627204bae18b648"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#af4b3d07cd9bf4178d627204bae18b648">resetFCntDown</a> ()</td></tr>
|
|
<tr class="memdesc:af4b3d07cd9bf4178d627204bae18b648"><td class="mdescLeft"> </td><td class="mdescRight">Reset the downlink frame counters (application and network) This is unsafe and can possibly allow replay attacks using downlinks. It mainly exists as part of the TS009 Specification Verification protocol. <br /></td></tr>
|
|
<tr class="separator:af4b3d07cd9bf4178d627204bae18b648"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a14e8a8a098df28ff5ee294f235500499"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a14e8a8a098df28ff5ee294f235500499">setDatarate</a> (uint8_t drUp)</td></tr>
|
|
<tr class="memdesc:a14e8a8a098df28ff5ee294f235500499"><td class="mdescLeft"> </td><td class="mdescRight">Set uplink datarate. This should not be used when ADR is enabled. <a href="class_lo_ra_w_a_n_node.html#a14e8a8a098df28ff5ee294f235500499">More...</a><br /></td></tr>
|
|
<tr class="separator:a14e8a8a098df28ff5ee294f235500499"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae222275f807f472083ea6100c23c75ff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#ae222275f807f472083ea6100c23c75ff">setADR</a> (bool enable=true)</td></tr>
|
|
<tr class="memdesc:ae222275f807f472083ea6100c23c75ff"><td class="mdescLeft"> </td><td class="mdescRight">Toggle ADR to on or off. <a href="class_lo_ra_w_a_n_node.html#ae222275f807f472083ea6100c23c75ff">More...</a><br /></td></tr>
|
|
<tr class="separator:ae222275f807f472083ea6100c23c75ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d4bbd6d382496838954ab4ac1168b77"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a3d4bbd6d382496838954ab4ac1168b77">setDutyCycle</a> (bool enable=true, <a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> msPerHour=0)</td></tr>
|
|
<tr class="memdesc:a3d4bbd6d382496838954ab4ac1168b77"><td class="mdescLeft"> </td><td class="mdescRight">Toggle adherence to dutyCycle limits to on or off. <a href="class_lo_ra_w_a_n_node.html#a3d4bbd6d382496838954ab4ac1168b77">More...</a><br /></td></tr>
|
|
<tr class="separator:a3d4bbd6d382496838954ab4ac1168b77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5bb50904544f331806fd744ab5b99efa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a5bb50904544f331806fd744ab5b99efa">dutyCycleInterval</a> (<a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> msPerHour, <a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> airtime)</td></tr>
|
|
<tr class="memdesc:a5bb50904544f331806fd744ab5b99efa"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the minimum interval to adhere to a certain dutyCycle. This interval is based on the ToA of one uplink and does not actually keep track of total airtime. <a href="class_lo_ra_w_a_n_node.html#a5bb50904544f331806fd744ab5b99efa">More...</a><br /></td></tr>
|
|
<tr class="separator:a5bb50904544f331806fd744ab5b99efa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49e690c14858b46692e4ce9aa5a2566a"><td class="memItemLeft" align="right" valign="top"><a id="a49e690c14858b46692e4ce9aa5a2566a"></a>
|
|
<a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a49e690c14858b46692e4ce9aa5a2566a">timeUntilUplink</a> ()</td></tr>
|
|
<tr class="memdesc:a49e690c14858b46692e4ce9aa5a2566a"><td class="mdescLeft"> </td><td class="mdescRight">Returns time in milliseconds until next uplink is available under dutyCycle limits. <br /></td></tr>
|
|
<tr class="separator:a49e690c14858b46692e4ce9aa5a2566a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a62bfe68f6fe63c2e408dccbff6a34a4f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a62bfe68f6fe63c2e408dccbff6a34a4f">setDwellTime</a> (bool enable, <a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> msPerUplink=0)</td></tr>
|
|
<tr class="memdesc:a62bfe68f6fe63c2e408dccbff6a34a4f"><td class="mdescLeft"> </td><td class="mdescRight">Toggle adherence to dwellTime limits to on or off. <a href="class_lo_ra_w_a_n_node.html#a62bfe68f6fe63c2e408dccbff6a34a4f">More...</a><br /></td></tr>
|
|
<tr class="separator:a62bfe68f6fe63c2e408dccbff6a34a4f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3044715beeff759ed47342d532ac3205"><td class="memItemLeft" align="right" valign="top"><a id="a3044715beeff759ed47342d532ac3205"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a3044715beeff759ed47342d532ac3205">maxPayloadDwellTime</a> ()</td></tr>
|
|
<tr class="memdesc:a3044715beeff759ed47342d532ac3205"><td class="mdescLeft"> </td><td class="mdescRight">Returns the maximum payload given the currently present dwell time limits. WARNING: the addition of MAC commands may cause uplink errors; if you want to be sure that your payload fits within dwell time limits, subtract 16 from the result! <br /></td></tr>
|
|
<tr class="separator:a3044715beeff759ed47342d532ac3205"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9af613f7d923e7bdcfdbd020132c6d4b"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a9af613f7d923e7bdcfdbd020132c6d4b">setTxPower</a> (int8_t txPower)</td></tr>
|
|
<tr class="memdesc:a9af613f7d923e7bdcfdbd020132c6d4b"><td class="mdescLeft"> </td><td class="mdescRight">Configure TX power of the radio module. <a href="class_lo_ra_w_a_n_node.html#a9af613f7d923e7bdcfdbd020132c6d4b">More...</a><br /></td></tr>
|
|
<tr class="separator:a9af613f7d923e7bdcfdbd020132c6d4b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf038f331c1dc954dafc2668e7a31ca0"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#adf038f331c1dc954dafc2668e7a31ca0">getMacLinkCheckAns</a> (uint8_t *margin, uint8_t *gwCnt)</td></tr>
|
|
<tr class="memdesc:adf038f331c1dc954dafc2668e7a31ca0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the quality of connectivity after requesting a LinkCheck MAC command. Returns 'true' if a network response was successfully parsed. Returns 'false' if there was no network response / parsing failed. <a href="class_lo_ra_w_a_n_node.html#adf038f331c1dc954dafc2668e7a31ca0">More...</a><br /></td></tr>
|
|
<tr class="separator:adf038f331c1dc954dafc2668e7a31ca0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9e6e1ce4296364606ff8b10fb5f971de"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a9e6e1ce4296364606ff8b10fb5f971de">getMacDeviceTimeAns</a> (uint32_t *gpsEpoch, uint8_t *fraction, bool returnUnix=true)</td></tr>
|
|
<tr class="memdesc:a9e6e1ce4296364606ff8b10fb5f971de"><td class="mdescLeft"> </td><td class="mdescRight">Returns the network time after requesting a DeviceTime MAC command. Returns 'true' if a network response was successfully parsed. Returns 'false' if there was no network response / parsing failed. <a href="class_lo_ra_w_a_n_node.html#a9e6e1ce4296364606ff8b10fb5f971de">More...</a><br /></td></tr>
|
|
<tr class="separator:a9e6e1ce4296364606ff8b10fb5f971de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa97378ad7b669718fbef529649d03452"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#aa97378ad7b669718fbef529649d03452">getDevAddr</a> ()</td></tr>
|
|
<tr class="memdesc:aa97378ad7b669718fbef529649d03452"><td class="mdescLeft"> </td><td class="mdescRight">Returns the DevAddr of the device, regardless of OTAA or ABP mode. <a href="class_lo_ra_w_a_n_node.html#aa97378ad7b669718fbef529649d03452">More...</a><br /></td></tr>
|
|
<tr class="separator:aa97378ad7b669718fbef529649d03452"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a683b02b63867bb7de5df45c94d190305"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a683b02b63867bb7de5df45c94d190305">getLastToA</a> ()</td></tr>
|
|
<tr class="memdesc:a683b02b63867bb7de5df45c94d190305"><td class="mdescLeft"> </td><td class="mdescRight">Get the Time-on-air of the last uplink message. <a href="class_lo_ra_w_a_n_node.html#a683b02b63867bb7de5df45c94d190305">More...</a><br /></td></tr>
|
|
<tr class="separator:a683b02b63867bb7de5df45c94d190305"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>LoRaWAN-compatible node (class A device). </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="aae05de563f765f14fe267e4d65844f76"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aae05de563f765f14fe267e4d65844f76">◆ </a></span>LoRaWANNode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LoRaWANNode::LoRaWANNode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_physical_layer.html">PhysicalLayer</a> * </td>
|
|
<td class="paramname"><em>phy</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="struct_lo_ra_w_a_n_band__t.html">LoRaWANBand_t</a> * </td>
|
|
<td class="paramname"><em>band</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>subBand</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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">phy</td><td>Pointer to the <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> radio module. </td></tr>
|
|
<tr><td class="paramname">band</td><td>Pointer to the LoRaWAN band to use. </td></tr>
|
|
<tr><td class="paramname">subBand</td><td>The sub-band to be used (starting from 1!) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a77483c51548e48a5dff4b707f7770e86"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a77483c51548e48a5dff4b707f7770e86">◆ </a></span>activateABP()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::activateABP </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>initialDr</em> = <code>RADIOLIB_LORAWAN_DATA_RATE_UNUSED</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Join network by restoring ABP session or performing over-the-air activation. In this procedure, all necessary configuration must be provided by the user. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">initialDr</td><td>The datarate at which to send the first uplink and any subsequent uplinks (unless ADR is enabled). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abd9e976eec64a3bd1ddf3331f2bc93cd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd9e976eec64a3bd1ddf3331f2bc93cd">◆ </a></span>activateOTAA()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::activateOTAA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>initialDr</em> = <code>RADIOLIB_LORAWAN_DATA_RATE_UNUSED</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_lo_ra_w_a_n_join_event__t.html">LoRaWANJoinEvent_t</a> * </td>
|
|
<td class="paramname"><em>joinEvent</em> = <code>NULL</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Join network by restoring OTAA session or performing over-the-air activation. By this procedure, the device will perform an exchange with the network server and set all necessary configuration. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">joinDr</td><td>The datarate at which to send the join-request and any subsequent uplinks (unless ADR is enabled) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a92c59b540dee631e7bd8153479328611"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a92c59b540dee631e7bd8153479328611">◆ </a></span>beginABP()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LoRaWANNode::beginABP </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>addr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>fNwkSIntKey</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>sNwkSIntKey</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>nwkSEncKey</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>appSKey</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the device credentials and activation configuration. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">addr</td><td>Device address. </td></tr>
|
|
<tr><td class="paramname">fNwkSIntKey</td><td>Pointer to the Forwarding network session (LoRaWAN 1.1), NULL for LoRaWAN 1.0. </td></tr>
|
|
<tr><td class="paramname">sNwkSIntKey</td><td>Pointer to the Serving network session (LoRaWAN 1.1), NULL for LoRaWAN 1.0. </td></tr>
|
|
<tr><td class="paramname">nwkSEncKey</td><td>Pointer to the MAC command network session key <a href="LoRaWAN 1.1">NwkSEncKey</a> or network session AES-128 key <a href="LoRaWAN 1.0">NwkSKey</a>. </td></tr>
|
|
<tr><td class="paramname">appSKey</td><td>Pointer to the application session AES-128 key. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2303cbbfc9c18e267c074284a4f1bf68"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2303cbbfc9c18e267c074284a4f1bf68">◆ </a></span>beginOTAA()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LoRaWANNode::beginOTAA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>joinEUI</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>devEUI</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>nwkKey</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>appKey</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the device credentials and activation configuration. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">joinEUI</td><td>8-byte application identifier. </td></tr>
|
|
<tr><td class="paramname">devEUI</td><td>8-byte device identifier. </td></tr>
|
|
<tr><td class="paramname">nwkKey</td><td>Pointer to the network AES-128 key. </td></tr>
|
|
<tr><td class="paramname">appKey</td><td>Pointer to the application AES-128 key. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae532e739ada04ea7463494a426f60b4d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae532e739ada04ea7463494a426f60b4d">◆ </a></span>downlink() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::downlink </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> * </td>
|
|
<td class="paramname"><em>event</em> = <code>NULL</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Wait for downlink, simplified to allow for simpler sendReceive. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">event</td><td>Pointer to a structure to store extra information about the event (fPort, frame counter, etc.). If set to NULL, no extra information will be passed to the user. </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="aabced307f6662998608f01fab25e4226"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aabced307f6662998608f01fab25e4226">◆ </a></span>downlink() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::downlink </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"><a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> * </td>
|
|
<td class="paramname"><em>event</em> = <code>NULL</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Wait for downlink from the server in either RX1 or RX2 window. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Buffer to save received data into. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Pointer to variable that will be used to save the number of received bytes. </td></tr>
|
|
<tr><td class="paramname">event</td><td>Pointer to a structure to store extra information about the event (fPort, frame counter, etc.). If set to NULL, no extra information will be passed to the user. </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="a5bb50904544f331806fd744ab5b99efa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5bb50904544f331806fd744ab5b99efa">◆ </a></span>dutyCycleInterval()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> LoRaWANNode::dutyCycleInterval </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td>
|
|
<td class="paramname"><em>msPerHour</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td>
|
|
<td class="paramname"><em>airtime</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Calculate the minimum interval to adhere to a certain dutyCycle. This interval is based on the ToA of one uplink and does not actually keep track of total airtime. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msPerHour</td><td>The maximum allowed duty cycle (in milliseconds per hour). </td></tr>
|
|
<tr><td class="paramname">airtime</td><td>The airtime of the uplink. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Required interval (delay) in milliseconds between consecutive uplinks. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a84004883006b4a498d4899874952445b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a84004883006b4a498d4899874952445b">◆ </a></span>getBufferNonces()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t * LoRaWANNode::getBufferNonces </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the pointer to the internal buffer that holds the LW base parameters. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pointer to uint8_t array of size RADIOLIB_LORAWAN_NONCES_BUF_SIZE </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a90369a4f2c4da11527872a7bbbf9ab06"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a90369a4f2c4da11527872a7bbbf9ab06">◆ </a></span>getBufferSession()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t * LoRaWANNode::getBufferSession </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the pointer to the internal buffer that holds the LW session parameters. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pointer to uint8_t array of size RADIOLIB_LORAWAN_SESSION_BUF_SIZE </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa97378ad7b669718fbef529649d03452"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa97378ad7b669718fbef529649d03452">◆ </a></span>getDevAddr()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint64_t LoRaWANNode::getDevAddr </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the DevAddr of the device, regardless of OTAA or ABP mode. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>8-byte DevAddr </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a683b02b63867bb7de5df45c94d190305"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a683b02b63867bb7de5df45c94d190305">◆ </a></span>getLastToA()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> LoRaWANNode::getLastToA </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the Time-on-air of the last uplink message. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>(RadioLibTime_t) time-on-air (ToA) of last uplink message </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9e6e1ce4296364606ff8b10fb5f971de"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9e6e1ce4296364606ff8b10fb5f971de">◆ </a></span>getMacDeviceTimeAns()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::getMacDeviceTimeAns </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>gpsEpoch</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>fraction</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>returnUnix</em> = <code>true</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the network time after requesting a DeviceTime MAC command. Returns 'true' if a network response was successfully parsed. Returns 'false' if there was no network response / parsing failed. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">gpsEpoch</td><td>Number of seconds since GPS epoch (Jan. 6th 1980) </td></tr>
|
|
<tr><td class="paramname">fraction</td><td>Fractional-second, in 1/256-second steps </td></tr>
|
|
<tr><td class="paramname">returnUnix</td><td>If true, returns Unix timestamp instead of GPS (default true) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adf038f331c1dc954dafc2668e7a31ca0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adf038f331c1dc954dafc2668e7a31ca0">◆ </a></span>getMacLinkCheckAns()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::getMacLinkCheckAns </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>margin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>gwCnt</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the quality of connectivity after requesting a LinkCheck MAC command. Returns 'true' if a network response was successfully parsed. Returns 'false' if there was no network response / parsing failed. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">margin</td><td>Link margin in dB of LinkCheckReq demodulation at gateway side. </td></tr>
|
|
<tr><td class="paramname">gwCnt</td><td>Number of gateways that received the LinkCheckReq. </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="adef05650cf4eb92042ca5e2688c1e164"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adef05650cf4eb92042ca5e2688c1e164">◆ </a></span>sendMacCommandReq()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::sendMacCommandReq </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>cid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add a MAC command to the uplink queue. Only LinkCheck and DeviceTime are available to the user. Other commands are ignored; duplicate MAC commands are discarded. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cid</td><td>ID of the MAC command </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="a85cf006ffd97ece3b2d2974b715540cb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a85cf006ffd97ece3b2d2974b715540cb">◆ </a></span>sendReceive() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::sendReceive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>strUp</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>fPort</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>dataDown</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>lenDown</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>isConfirmed</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> * </td>
|
|
<td class="paramname"><em>eventUp</em> = <code>NULL</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> * </td>
|
|
<td class="paramname"><em>eventDown</em> = <code>NULL</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send a message to the server and wait for a downlink during Rx1 and/or Rx2 window. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">strUp</td><td>C-string that will be transmitted. </td></tr>
|
|
<tr><td class="paramname">fPort</td><td>Port number to send the message to. </td></tr>
|
|
<tr><td class="paramname">dataDown</td><td>Buffer to save received data into. </td></tr>
|
|
<tr><td class="paramname">lenDown</td><td>Pointer to variable that will be used to save the number of received bytes. </td></tr>
|
|
<tr><td class="paramname">isConfirmed</td><td>Whether to send a confirmed uplink or not. </td></tr>
|
|
<tr><td class="paramname">eventUp</td><td>Pointer to a structure to store extra information about the uplink event (fPort, frame counter, etc.). If set to NULL, no extra information will be passed to the user. </td></tr>
|
|
<tr><td class="paramname">eventDown</td><td>Pointer to a structure to store extra information about the downlink event (fPort, frame counter, etc.). If set to NULL, no extra information will be passed to the user. </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="a07ab107de181bde59c2731a5a64a1e2e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a07ab107de181bde59c2731a5a64a1e2e">◆ </a></span>sendReceive() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::sendReceive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>dataUp</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>lenUp</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>fPort</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>dataDown</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>lenDown</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>isConfirmed</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> * </td>
|
|
<td class="paramname"><em>eventUp</em> = <code>NULL</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> * </td>
|
|
<td class="paramname"><em>eventDown</em> = <code>NULL</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send a message to the server and wait for a downlink during Rx1 and/or Rx2 window. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dataUp</td><td>Data to send. </td></tr>
|
|
<tr><td class="paramname">lenUp</td><td>Length of the data. </td></tr>
|
|
<tr><td class="paramname">fPort</td><td>Port number to send the message to. </td></tr>
|
|
<tr><td class="paramname">dataDown</td><td>Buffer to save received data into. </td></tr>
|
|
<tr><td class="paramname">lenDown</td><td>Pointer to variable that will be used to save the number of received bytes. </td></tr>
|
|
<tr><td class="paramname">isConfirmed</td><td>Whether to send a confirmed uplink or not. </td></tr>
|
|
<tr><td class="paramname">eventUp</td><td>Pointer to a structure to store extra information about the uplink event (fPort, frame counter, etc.). If set to NULL, no extra information will be passed to the user. </td></tr>
|
|
<tr><td class="paramname">eventDown</td><td>Pointer to a structure to store extra information about the downlink event (fPort, frame counter, etc.). If set to NULL, no extra information will be passed to the user. </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="a7123f9a907df9224b9b01282c12af459"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7123f9a907df9224b9b01282c12af459">◆ </a></span>sendReceive() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::sendReceive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>dataUp</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>lenUp</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>fPort</em> = <code>1</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>isConfirmed</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> * </td>
|
|
<td class="paramname"><em>eventUp</em> = <code>NULL</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> * </td>
|
|
<td class="paramname"><em>eventDown</em> = <code>NULL</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send a message to the server and wait for a downlink but don't bother the user with downlink contents. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dataUp</td><td>Data to send. </td></tr>
|
|
<tr><td class="paramname">lenUp</td><td>Length of the data. </td></tr>
|
|
<tr><td class="paramname">fPort</td><td>Port number to send the message to. </td></tr>
|
|
<tr><td class="paramname">isConfirmed</td><td>Whether to send a confirmed uplink or not. </td></tr>
|
|
<tr><td class="paramname">eventUp</td><td>Pointer to a structure to store extra information about the uplink event (fPort, frame counter, etc.). If set to NULL, no extra information will be passed to the user. </td></tr>
|
|
<tr><td class="paramname">eventDown</td><td>Pointer to a structure to store extra information about the downlink event (fPort, frame counter, etc.). If set to NULL, no extra information will be passed to the user. </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="ae222275f807f472083ea6100c23c75ff"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae222275f807f472083ea6100c23c75ff">◆ </a></span>setADR()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LoRaWANNode::setADR </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>Toggle ADR to on or off. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>Whether to disable ADR or not. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a11701081ac6bd39a8a2b4bdbc248fac2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a11701081ac6bd39a8a2b4bdbc248fac2">◆ </a></span>setBufferNonces()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::setBufferNonces </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>persistentBuffer</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Fill the internal buffer that holds the LW base parameters with a supplied buffer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">persistentBuffer</td><td>Buffer that should match the internal format (previously extracted using getBufferNonces) </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="aadebe7a412aec8043aa2f8f57a202f49"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aadebe7a412aec8043aa2f8f57a202f49">◆ </a></span>setBufferSession()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::setBufferSession </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>persistentBuffer</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Fill the internal buffer that holds the LW session parameters with a supplied buffer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">persistentBuffer</td><td>Buffer that should match the internal format (previously extracted using getBufferSession) </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="a14e8a8a098df28ff5ee294f235500499"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a14e8a8a098df28ff5ee294f235500499">◆ </a></span>setDatarate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::setDatarate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>drUp</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set uplink datarate. This should not be used when ADR is enabled. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">drUp</td><td>Datarate to use for uplinks. </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="a5449e301634dff1838a1b024b4067034"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5449e301634dff1838a1b024b4067034">◆ </a></span>setDeviceStatus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LoRaWANNode::setDeviceStatus </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>battLevel</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set device status. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">battLevel</td><td>Battery level to set. 0 for external power source, 1 for lowest battery, 254 for highest battery, 255 for unable to measure. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3d4bbd6d382496838954ab4ac1168b77"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3d4bbd6d382496838954ab4ac1168b77">◆ </a></span>setDutyCycle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LoRaWANNode::setDutyCycle </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em> = <code>true</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td>
|
|
<td class="paramname"><em>msPerHour</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Toggle adherence to dutyCycle limits to on or off. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>Whether to adhere to dutyCycle limits or not (default true). </td></tr>
|
|
<tr><td class="paramname">msPerHour</td><td>The maximum allowed Time-on-Air per hour in milliseconds (default 0 = maximum allowed for configured band). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a62bfe68f6fe63c2e408dccbff6a34a4f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a62bfe68f6fe63c2e408dccbff6a34a4f">◆ </a></span>setDwellTime()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LoRaWANNode::setDwellTime </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> </td>
|
|
<td class="paramname"><em>msPerUplink</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Toggle adherence to dwellTime limits to on or off. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enable</td><td>Whether to adhere to dwellTime limits or not (default true). </td></tr>
|
|
<tr><td class="paramname">msPerUplink</td><td>The maximum allowed Time-on-Air per uplink in milliseconds (default 0 = maximum allowed for configured band). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="addfd8ac3d0bfe5a273e9ba10e51f8025"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#addfd8ac3d0bfe5a273e9ba10e51f8025">◆ </a></span>setRx2Dr()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::setRx2Dr </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>dr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configure the Rx2 datarate for ABP mode. This should not be needed for LoRaWAN 1.1 as it is configured through the first downlink. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dr</td><td>The datarate to be used for listening for downlinks in Rx2. </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="a9af613f7d923e7bdcfdbd020132c6d4b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9af613f7d923e7bdcfdbd020132c6d4b">◆ </a></span>setTxPower()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::setTxPower </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int8_t </td>
|
|
<td class="paramname"><em>txPower</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configure TX power of the radio module. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">txPower</td><td>Output power during TX mode to be set in dBm. </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="a1fa484970865e476311bf25969968fff"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1fa484970865e476311bf25969968fff">◆ </a></span>uplink() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::uplink </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>str</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>fPort</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>isConfirmed</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> * </td>
|
|
<td class="paramname"><em>event</em> = <code>NULL</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send a message to the server. </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">fPort</td><td>Port number to send the message to. </td></tr>
|
|
<tr><td class="paramname">isConfirmed</td><td>Whether to send a confirmed uplink or not. </td></tr>
|
|
<tr><td class="paramname">event</td><td>Pointer to a structure to store extra information about the event (fPort, frame counter, etc.). If set to NULL, no extra information will be passed to the user. </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="a66c170a6055e66915d3e94ce43a63e58"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a66c170a6055e66915d3e94ce43a63e58">◆ </a></span>uplink() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::uplink </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>fPort</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>isConfirmed</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a> * </td>
|
|
<td class="paramname"><em>event</em> = <code>NULL</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send a message to the server. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Data to send. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Length of the data. </td></tr>
|
|
<tr><td class="paramname">fPort</td><td>Port number to send the message to. </td></tr>
|
|
<tr><td class="paramname">isConfirmed</td><td>Whether to send a confirmed uplink or not. </td></tr>
|
|
<tr><td class="paramname">event</td><td>Pointer to a structure to store extra information about the event (fPort, frame counter, etc.). If set to NULL, no extra information will be passed to the user. </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/protocols/LoRaWAN/<a class="el" href="_lo_ra_w_a_n_8h_source.html">LoRaWAN.h</a></li>
|
|
<li>src/protocols/LoRaWAN/LoRaWAN.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_lo_ra_w_a_n_node.html">LoRaWANNode</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>
|