485 lines
25 KiB
HTML
485 lines
25 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:adc52e15b50e39f03c937b2289ad18463"><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#adc52e15b50e39f03c937b2289ad18463">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)</td></tr>
|
|
<tr class="memdesc:adc52e15b50e39f03c937b2289ad18463"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_lo_ra_w_a_n_node.html#adc52e15b50e39f03c937b2289ad18463">More...</a><br /></td></tr>
|
|
<tr class="separator:adc52e15b50e39f03c937b2289ad18463"><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:acb9a128c5d2d252ff057cb0a0b1da00c"><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#acb9a128c5d2d252ff057cb0a0b1da00c">restoreOTAA</a> ()</td></tr>
|
|
<tr class="memdesc:acb9a128c5d2d252ff057cb0a0b1da00c"><td class="mdescLeft"> </td><td class="mdescRight">Restore OTAA session by loading information from persistent storage. <a href="class_lo_ra_w_a_n_node.html#acb9a128c5d2d252ff057cb0a0b1da00c">More...</a><br /></td></tr>
|
|
<tr class="separator:acb9a128c5d2d252ff057cb0a0b1da00c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1c51588ea3b3ca82e2742c7cc9bc2a72"><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#a1c51588ea3b3ca82e2742c7cc9bc2a72">beginOTAA</a> (uint64_t joinEUI, uint64_t devEUI, uint8_t *nwkKey, uint8_t *appKey, bool force=false)</td></tr>
|
|
<tr class="memdesc:a1c51588ea3b3ca82e2742c7cc9bc2a72"><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#a1c51588ea3b3ca82e2742c7cc9bc2a72">More...</a><br /></td></tr>
|
|
<tr class="separator:a1c51588ea3b3ca82e2742c7cc9bc2a72"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acbf3beb97c42072f13d46e06f1d4709b"><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#acbf3beb97c42072f13d46e06f1d4709b">beginABP</a> (uint32_t addr, uint8_t *nwkSKey, uint8_t *appSKey, uint8_t *fNwkSIntKey=NULL, uint8_t *sNwkSIntKey=NULL)</td></tr>
|
|
<tr class="memdesc:acbf3beb97c42072f13d46e06f1d4709b"><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#acbf3beb97c42072f13d46e06f1d4709b">More...</a><br /></td></tr>
|
|
<tr class="separator:acbf3beb97c42072f13d46e06f1d4709b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afa61477a27d020ccdf0c7eef1c4d00a9"><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#afa61477a27d020ccdf0c7eef1c4d00a9">uplink</a> (const char *str, uint8_t port)</td></tr>
|
|
<tr class="memdesc:afa61477a27d020ccdf0c7eef1c4d00a9"><td class="mdescLeft"> </td><td class="mdescRight">Send a message to the server. <a href="class_lo_ra_w_a_n_node.html#afa61477a27d020ccdf0c7eef1c4d00a9">More...</a><br /></td></tr>
|
|
<tr class="separator:afa61477a27d020ccdf0c7eef1c4d00a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa5e6ccffe7a9d633dce21e20760cbe31"><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#aa5e6ccffe7a9d633dce21e20760cbe31">uplink</a> (uint8_t *data, size_t len, uint8_t port)</td></tr>
|
|
<tr class="memdesc:aa5e6ccffe7a9d633dce21e20760cbe31"><td class="mdescLeft"> </td><td class="mdescRight">Send a message to the server. <a href="class_lo_ra_w_a_n_node.html#aa5e6ccffe7a9d633dce21e20760cbe31">More...</a><br /></td></tr>
|
|
<tr class="separator:aa5e6ccffe7a9d633dce21e20760cbe31"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55156cbc6b09da6d4ba7337d1a4136fe"><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#a55156cbc6b09da6d4ba7337d1a4136fe">downlink</a> (uint8_t *data, size_t *len)</td></tr>
|
|
<tr class="memdesc:a55156cbc6b09da6d4ba7337d1a4136fe"><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#a55156cbc6b09da6d4ba7337d1a4136fe">More...</a><br /></td></tr>
|
|
<tr class="separator:a55156cbc6b09da6d4ba7337d1a4136fe"><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>
|
|
</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:a2335294022dff4bfed27491f7d61e645"><td class="memItemLeft" align="right" valign="top"><a id="a2335294022dff4bfed27491f7d61e645"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a2335294022dff4bfed27491f7d61e645">FSK</a></td></tr>
|
|
<tr class="memdesc:a2335294022dff4bfed27491f7d61e645"><td class="mdescLeft"> </td><td class="mdescRight">Set to true to force the node to only use FSK channels. Set to false by default. <br /></td></tr>
|
|
<tr class="separator:a2335294022dff4bfed27491f7d61e645"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:accc2a98737dba4de0fabb904f053efe3"><td class="memItemLeft" align="right" valign="top"><a id="accc2a98737dba4de0fabb904f053efe3"></a>
|
|
int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#accc2a98737dba4de0fabb904f053efe3">startChannel</a></td></tr>
|
|
<tr class="memdesc:accc2a98737dba4de0fabb904f053efe3"><td class="mdescLeft"> </td><td class="mdescRight">Starting channel offset. Some band plans only support a subset of available channels. Set to a positive value to set the first channel that will be used (e.g. 8 for US915 FSB2 used by TTN). By default -1 (no channel offset). <br /></td></tr>
|
|
<tr class="separator:accc2a98737dba4de0fabb904f053efe3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a814a0ef01d5a989479631f13ce737754"><td class="memItemLeft" align="right" valign="top"><a id="a814a0ef01d5a989479631f13ce737754"></a>
|
|
int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a814a0ef01d5a989479631f13ce737754">numChannels</a></td></tr>
|
|
<tr class="memdesc:a814a0ef01d5a989479631f13ce737754"><td class="mdescLeft"> </td><td class="mdescRight">Number of supported channels. Some band plans only support a subset of available channels. Set to a positive value to set the number of channels that will be used (e.g. 8 for US915 FSB2 used by TTN). By default -1 (no channel offset). <br /></td></tr>
|
|
<tr class="separator:a814a0ef01d5a989479631f13ce737754"><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="adc52e15b50e39f03c937b2289ad18463"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adc52e15b50e39f03c937b2289ad18463">◆ </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></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>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="acbf3beb97c42072f13d46e06f1d4709b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acbf3beb97c42072f13d46e06f1d4709b">◆ </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></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 network session F key (LoRaWAN 1.1), unused for LoRaWAN 1.0. </td></tr>
|
|
<tr><td class="paramname">sNwkSIntKey</td><td>Pointer to the network session S key (LoRaWAN 1.1), unused for LoRaWAN 1.0. </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="a1c51588ea3b3ca82e2742c7cc9bc2a72"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1c51588ea3b3ca82e2742c7cc9bc2a72">◆ </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></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>
|
|
</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="a55156cbc6b09da6d4ba7337d1a4136fe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a55156cbc6b09da6d4ba7337d1a4136fe">◆ </a></span>downlink()</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></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>
|
|
</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="acb9a128c5d2d252ff057cb0a0b1da00c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acb9a128c5d2d252ff057cb0a0b1da00c">◆ </a></span>restoreOTAA()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t LoRaWANNode::restoreOTAA </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Restore OTAA 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="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="afa61477a27d020ccdf0c7eef1c4d00a9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afa61477a27d020ccdf0c7eef1c4d00a9">◆ </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></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>
|
|
</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="aa5e6ccffe7a9d633dce21e20760cbe31"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa5e6ccffe7a9d633dce21e20760cbe31">◆ </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></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>
|
|
</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>
|