kopia lustrzana https://github.com/jgromes/RadioLib
1382 wiersze
76 KiB
HTML
1382 wiersze
76 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="#pub-attribs">Public Attributes</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:a9613998d071bcf401be9ad57ff8591ea"><td class="memItemLeft" align="right" valign="top"><a id="a9613998d071bcf401be9ad57ff8591ea"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a9613998d071bcf401be9ad57ff8591ea">wipe</a> ()</td></tr>
|
|
<tr class="memdesc:a9613998d071bcf401be9ad57ff8591ea"><td class="mdescLeft"> </td><td class="mdescRight">Wipe internal persistent parameters. This will reset all counters and saved variables, so the device will have to rejoin the network. <br /></td></tr>
|
|
<tr class="separator:a9613998d071bcf401be9ad57ff8591ea"><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:a6c0e89befd10c6977031669fd62f127b"><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#a6c0e89befd10c6977031669fd62f127b">restore</a> (uint16_t checkSum, uint16_t lwMode, uint8_t lwClass, uint8_t freqPlan)</td></tr>
|
|
<tr class="memdesc:a6c0e89befd10c6977031669fd62f127b"><td class="mdescLeft"> </td><td class="mdescRight">Restore session by loading information from persistent storage. <a href="class_lo_ra_w_a_n_node.html#a6c0e89befd10c6977031669fd62f127b">More...</a><br /></td></tr>
|
|
<tr class="separator:a6c0e89befd10c6977031669fd62f127b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27bbbb946a1676a084841d293499ea87"><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#a27bbbb946a1676a084841d293499ea87">beginOTAA</a> (uint64_t joinEUI, uint64_t devEUI, uint8_t *nwkKey, uint8_t *appKey, bool force=false, uint8_t joinDr=RADIOLIB_LORAWAN_DATA_RATE_UNUSED)</td></tr>
|
|
<tr class="memdesc:a27bbbb946a1676a084841d293499ea87"><td class="mdescLeft"> </td><td class="mdescRight">Join network by 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#a27bbbb946a1676a084841d293499ea87">More...</a><br /></td></tr>
|
|
<tr class="separator:a27bbbb946a1676a084841d293499ea87"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a54c23c4676905aa17119d5a5dd5fa8a8"><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#a54c23c4676905aa17119d5a5dd5fa8a8">beginABP</a> (uint32_t addr, uint8_t *nwkSKey, uint8_t *appSKey, uint8_t *fNwkSIntKey=NULL, uint8_t *sNwkSIntKey=NULL, bool force=false, uint8_t initialDr=RADIOLIB_LORAWAN_DATA_RATE_UNUSED)</td></tr>
|
|
<tr class="memdesc:a54c23c4676905aa17119d5a5dd5fa8a8"><td class="mdescLeft"> </td><td class="mdescRight">Join network by performing activation by personalization. In this procedure, all necessary configuration must be provided by the user. <a href="class_lo_ra_w_a_n_node.html#a54c23c4676905aa17119d5a5dd5fa8a8">More...</a><br /></td></tr>
|
|
<tr class="separator:a54c23c4676905aa17119d5a5dd5fa8a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7a8ae58391e00b5fcb99f01832cc4fc"><td class="memItemLeft" align="right" valign="top"><a id="af7a8ae58391e00b5fcb99f01832cc4fc"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#af7a8ae58391e00b5fcb99f01832cc4fc">isJoined</a> ()</td></tr>
|
|
<tr class="memdesc:af7a8ae58391e00b5fcb99f01832cc4fc"><td class="mdescLeft"> </td><td class="mdescRight">Whether there is an ongoing session active. <br /></td></tr>
|
|
<tr class="separator:af7a8ae58391e00b5fcb99f01832cc4fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7078a3f1657a2a022bb43f2bd34c93e3"><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#a7078a3f1657a2a022bb43f2bd34c93e3">saveSession</a> ()</td></tr>
|
|
<tr class="memdesc:a7078a3f1657a2a022bb43f2bd34c93e3"><td class="mdescLeft"> </td><td class="mdescRight">Save the current state of the session to the session buffer. <a href="class_lo_ra_w_a_n_node.html#a7078a3f1657a2a022bb43f2bd34c93e3">More...</a><br /></td></tr>
|
|
<tr class="separator:a7078a3f1657a2a022bb43f2bd34c93e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ff678f9cb57b97eb63886953aca1ba9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a6ff678f9cb57b97eb63886953aca1ba9">sendMacCommandReq</a> (uint8_t cid)</td></tr>
|
|
<tr class="memdesc:a6ff678f9cb57b97eb63886953aca1ba9"><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#a6ff678f9cb57b97eb63886953aca1ba9">More...</a><br /></td></tr>
|
|
<tr class="separator:a6ff678f9cb57b97eb63886953aca1ba9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e3c2642ebb6e86d6a739ea68d692e6a"><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#a0e3c2642ebb6e86d6a739ea68d692e6a">uplink</a> (const char *str, uint8_t port, 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:a0e3c2642ebb6e86d6a739ea68d692e6a"><td class="mdescLeft"> </td><td class="mdescRight">Send a message to the server. <a href="class_lo_ra_w_a_n_node.html#a0e3c2642ebb6e86d6a739ea68d692e6a">More...</a><br /></td></tr>
|
|
<tr class="separator:a0e3c2642ebb6e86d6a739ea68d692e6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b919dc97479294a32b2d0c9dde49be8"><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#a1b919dc97479294a32b2d0c9dde49be8">uplink</a> (uint8_t *data, size_t len, uint8_t port, 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:a1b919dc97479294a32b2d0c9dde49be8"><td class="mdescLeft"> </td><td class="mdescRight">Send a message to the server. <a href="class_lo_ra_w_a_n_node.html#a1b919dc97479294a32b2d0c9dde49be8">More...</a><br /></td></tr>
|
|
<tr class="separator:a1b919dc97479294a32b2d0c9dde49be8"><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:a158f65517fa910ef0cbcd92206dab284"><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#a158f65517fa910ef0cbcd92206dab284">sendReceive</a> (const char *strUp, uint8_t port, 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:a158f65517fa910ef0cbcd92206dab284"><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#a158f65517fa910ef0cbcd92206dab284">More...</a><br /></td></tr>
|
|
<tr class="separator:a158f65517fa910ef0cbcd92206dab284"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7bd48e0ef0dfc6b05014e3a2f55cb51c"><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#a7bd48e0ef0dfc6b05014e3a2f55cb51c">sendReceive</a> (uint8_t *dataUp, size_t lenUp, uint8_t port, 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:a7bd48e0ef0dfc6b05014e3a2f55cb51c"><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#a7bd48e0ef0dfc6b05014e3a2f55cb51c">More...</a><br /></td></tr>
|
|
<tr class="separator:a7bd48e0ef0dfc6b05014e3a2f55cb51c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af0eba2805fa72c8d69d8f73118b49431"><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#af0eba2805fa72c8d69d8f73118b49431">sendReceive</a> (uint8_t *dataUp, size_t lenUp, uint8_t port=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:af0eba2805fa72c8d69d8f73118b49431"><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#af0eba2805fa72c8d69d8f73118b49431">More...</a><br /></td></tr>
|
|
<tr class="separator:af0eba2805fa72c8d69d8f73118b49431"><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:a52ae7c2aa61262d7761236f289889020"><td class="memItemLeft" align="right" valign="top"><a id="a52ae7c2aa61262d7761236f289889020"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a52ae7c2aa61262d7761236f289889020">getFcntUp</a> ()</td></tr>
|
|
<tr class="memdesc:a52ae7c2aa61262d7761236f289889020"><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:a52ae7c2aa61262d7761236f289889020"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8ac61997732b3f6d5f33b6568e23be11"><td class="memItemLeft" align="right" valign="top"><a id="a8ac61997732b3f6d5f33b6568e23be11"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a8ac61997732b3f6d5f33b6568e23be11">getNFcntDown</a> ()</td></tr>
|
|
<tr class="memdesc:a8ac61997732b3f6d5f33b6568e23be11"><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:a8ac61997732b3f6d5f33b6568e23be11"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8b647b639d1c7f1a2a81397b41c01dd8"><td class="memItemLeft" align="right" valign="top"><a id="a8b647b639d1c7f1a2a81397b41c01dd8"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a8b647b639d1c7f1a2a81397b41c01dd8">getAFcntDown</a> ()</td></tr>
|
|
<tr class="memdesc:a8b647b639d1c7f1a2a81397b41c01dd8"><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:a8b647b639d1c7f1a2a81397b41c01dd8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5693065bbb6d1c6c45efbe010d86f417"><td class="memItemLeft" align="right" valign="top"><a id="a5693065bbb6d1c6c45efbe010d86f417"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a5693065bbb6d1c6c45efbe010d86f417">resetFcntDown</a> ()</td></tr>
|
|
<tr class="memdesc:a5693065bbb6d1c6c45efbe010d86f417"><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:a5693065bbb6d1c6c45efbe010d86f417"><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:ab16e85446e0a843001d1dabad5223956"><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#ab16e85446e0a843001d1dabad5223956">setDutyCycle</a> (bool enable=true, uint32_t msPerHour=0)</td></tr>
|
|
<tr class="memdesc:ab16e85446e0a843001d1dabad5223956"><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#ab16e85446e0a843001d1dabad5223956">More...</a><br /></td></tr>
|
|
<tr class="separator:ab16e85446e0a843001d1dabad5223956"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a564386d9c15ad71a1a8703809c8a9741"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a564386d9c15ad71a1a8703809c8a9741">dutyCycleInterval</a> (uint32_t msPerHour, uint32_t airtime)</td></tr>
|
|
<tr class="memdesc:a564386d9c15ad71a1a8703809c8a9741"><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#a564386d9c15ad71a1a8703809c8a9741">More...</a><br /></td></tr>
|
|
<tr class="separator:a564386d9c15ad71a1a8703809c8a9741"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac5571bebeebbece3a6357e1c9868cb8b"><td class="memItemLeft" align="right" valign="top"><a id="ac5571bebeebbece3a6357e1c9868cb8b"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#ac5571bebeebbece3a6357e1c9868cb8b">timeUntilUplink</a> ()</td></tr>
|
|
<tr class="memdesc:ac5571bebeebbece3a6357e1c9868cb8b"><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:ac5571bebeebbece3a6357e1c9868cb8b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a40c5fdba815b26a44be7af68c184fe49"><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#a40c5fdba815b26a44be7af68c184fe49">setDwellTime</a> (bool enable, uint32_t msPerUplink=0)</td></tr>
|
|
<tr class="memdesc:a40c5fdba815b26a44be7af68c184fe49"><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#a40c5fdba815b26a44be7af68c184fe49">More...</a><br /></td></tr>
|
|
<tr class="separator:a40c5fdba815b26a44be7af68c184fe49"><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:adfc9cdaa254a27c28403188c90991757"><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#adfc9cdaa254a27c28403188c90991757">setCSMA</a> (uint8_t backoffMax, uint8_t difsSlots, bool enableCSMA=false)</td></tr>
|
|
<tr class="memdesc:adfc9cdaa254a27c28403188c90991757"><td class="mdescLeft"> </td><td class="mdescRight">Configures CSMA for LoRaWAN as per TR-13, LoRa Alliance. <a href="class_lo_ra_w_a_n_node.html#adfc9cdaa254a27c28403188c90991757">More...</a><br /></td></tr>
|
|
<tr class="separator:adfc9cdaa254a27c28403188c90991757"><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>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:acd37dd26f6040754b4a9c942b3fb4339"><td class="memItemLeft" align="right" valign="top"><a id="acd37dd26f6040754b4a9c942b3fb4339"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#acd37dd26f6040754b4a9c942b3fb4339">rx1DrOffset</a> = 0</td></tr>
|
|
<tr class="memdesc:acd37dd26f6040754b4a9c942b3fb4339"><td class="mdescLeft"> </td><td class="mdescRight">Offset between TX and RX1 (such that RX1 has equal or lower DR) <br /></td></tr>
|
|
<tr class="separator:acd37dd26f6040754b4a9c942b3fb4339"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae68e77ca38d22867798517d233c0fbc4"><td class="memItemLeft" align="right" valign="top"><a id="ae68e77ca38d22867798517d233c0fbc4"></a>
|
|
<a class="el" href="struct_lo_ra_w_a_n_channel__t.html">LoRaWANChannel_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#ae68e77ca38d22867798517d233c0fbc4">rx2</a></td></tr>
|
|
<tr class="memdesc:ae68e77ca38d22867798517d233c0fbc4"><td class="mdescLeft"> </td><td class="mdescRight">RX2 channel properties - may be changed by MAC command. <br /></td></tr>
|
|
<tr class="separator:ae68e77ca38d22867798517d233c0fbc4"><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="a54c23c4676905aa17119d5a5dd5fa8a8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a54c23c4676905aa17119d5a5dd5fa8a8">◆ </a></span>beginABP()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t 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>nwkSKey</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 class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>fNwkSIntKey</em> = <code>NULL</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>sNwkSIntKey</em> = <code>NULL</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>force</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></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></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Join network by performing activation by personalization. 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">addr</td><td>Device address. </td></tr>
|
|
<tr><td class="paramname">nwkSKey</td><td>Pointer to the network session AES-128 key (LoRaWAN 1.0) or MAC command network session key (LoRaWAN 1.1). </td></tr>
|
|
<tr><td class="paramname">appSKey</td><td>Pointer to the application session AES-128 key. </td></tr>
|
|
<tr><td class="paramname">fNwkSIntKey</td><td>Pointer to the Forwarding network session (LoRaWAN 1.1), unused for LoRaWAN 1.0. </td></tr>
|
|
<tr><td class="paramname">sNwkSIntKey</td><td>Pointer to the Serving network session (LoRaWAN 1.1), unused for LoRaWAN 1.0. </td></tr>
|
|
<tr><td class="paramname">force</td><td>Set to true to force a new session, even if one exists. </td></tr>
|
|
<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="a27bbbb946a1676a084841d293499ea87"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a27bbbb946a1676a084841d293499ea87">◆ </a></span>beginOTAA()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t 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 class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>force</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>joinDr</em> = <code>RADIOLIB_LORAWAN_DATA_RATE_UNUSED</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Join network by 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">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>
|
|
<tr><td class="paramname">force</td><td>Set to true to force joining even if previously joined. </td></tr>
|
|
<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="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 (port, 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 (port, 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="a564386d9c15ad71a1a8703809c8a9741"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a564386d9c15ad71a1a8703809c8a9741">◆ </a></span>dutyCycleInterval()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t LoRaWANNode::dutyCycleInterval </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>msPerHour</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </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="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="a6c0e89befd10c6977031669fd62f127b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6c0e89befd10c6977031669fd62f127b">◆ </a></span>restore()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::restore </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>checkSum</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>lwMode</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>lwClass</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>freqPlan</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Restore session by loading information from persistent storage. </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="a7078a3f1657a2a022bb43f2bd34c93e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7078a3f1657a2a022bb43f2bd34c93e3">◆ </a></span>saveSession()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::saveSession </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Save the current state of the session to the session buffer. </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="a6ff678f9cb57b97eb63886953aca1ba9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6ff678f9cb57b97eb63886953aca1ba9">◆ </a></span>sendMacCommandReq()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool 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>Whether or not the MAC command was added to the queue. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a158f65517fa910ef0cbcd92206dab284"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a158f65517fa910ef0cbcd92206dab284">◆ </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>port</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">port</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 (port, 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 (port, 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="a7bd48e0ef0dfc6b05014e3a2f55cb51c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7bd48e0ef0dfc6b05014e3a2f55cb51c">◆ </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>port</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">port</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 (port, 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 (port, 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="af0eba2805fa72c8d69d8f73118b49431"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af0eba2805fa72c8d69d8f73118b49431">◆ </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>port</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">port</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 (port, 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 (port, 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="adfc9cdaa254a27c28403188c90991757"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adfc9cdaa254a27c28403188c90991757">◆ </a></span>setCSMA()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LoRaWANNode::setCSMA </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>backoffMax</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>difsSlots</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enableCSMA</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configures CSMA for LoRaWAN as per TR-13, LoRa Alliance. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">backoffMax</td><td>Num of BO slots to be decremented after DIFS phase. 0 to disable BO. </td></tr>
|
|
<tr><td class="paramname">difsSlots</td><td>Num of CADs to estimate a clear CH. </td></tr>
|
|
<tr><td class="paramname">enableCSMA</td><td>enable/disable CSMA for LoRaWAN. </td></tr>
|
|
</table>
|
|
</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="ab16e85446e0a843001d1dabad5223956"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab16e85446e0a843001d1dabad5223956">◆ </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">uint32_t </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="a40c5fdba815b26a44be7af68c184fe49"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a40c5fdba815b26a44be7af68c184fe49">◆ </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">uint32_t </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="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="a0e3c2642ebb6e86d6a739ea68d692e6a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0e3c2642ebb6e86d6a739ea68d692e6a">◆ </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>port</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">port</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 (port, 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="a1b919dc97479294a32b2d0c9dde49be8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1b919dc97479294a32b2d0c9dde49be8">◆ </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>port</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">port</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 (port, 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>
|