RadioLibSmol/struct_lo_ra_w_a_n_band__t.html
2023-07-16 14:35:37 +00:00

156 lines
11 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: LoRaWANBand_t Struct 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&amp;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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('struct_lo_ra_w_a_n_band__t.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-attribs">Public Attributes</a> &#124;
<a href="struct_lo_ra_w_a_n_band__t-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LoRaWANBand_t Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Structure to save information about LoRaWAN band.
<a href="struct_lo_ra_w_a_n_band__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_lo_ra_w_a_n_8h_source.html">LoRaWAN.h</a>&gt;</code></p>
<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:a43a53c935e0ac482027a22e9c58ed8ed"><td class="memItemLeft" align="right" valign="top"><a id="a43a53c935e0ac482027a22e9c58ed8ed"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_lo_ra_w_a_n_band__t.html#a43a53c935e0ac482027a22e9c58ed8ed">downlinkDataRateBase</a></td></tr>
<tr class="memdesc:a43a53c935e0ac482027a22e9c58ed8ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">The base downlink data rate. Used to calculate data rate changes for adaptive data rate. <br /></td></tr>
<tr class="separator:a43a53c935e0ac482027a22e9c58ed8ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac885c9beda28b2fcacac002ebfeaf358"><td class="memItemLeft" align="right" valign="top"><a id="ac885c9beda28b2fcacac002ebfeaf358"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_lo_ra_w_a_n_band__t.html#ac885c9beda28b2fcacac002ebfeaf358">downlinkDataRateMin</a></td></tr>
<tr class="memdesc:ac885c9beda28b2fcacac002ebfeaf358"><td class="mdescLeft">&#160;</td><td class="mdescRight">The minimum allowed downlink data rate. Used to calculate data rate changes for adaptive data rate. <br /></td></tr>
<tr class="separator:ac885c9beda28b2fcacac002ebfeaf358"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b8143ac9bbf3ed45e7cc80fc71ce055"><td class="memItemLeft" align="right" valign="top"><a id="a9b8143ac9bbf3ed45e7cc80fc71ce055"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_lo_ra_w_a_n_band__t.html#a9b8143ac9bbf3ed45e7cc80fc71ce055">payloadLenMax</a> [RADIOLIB_LORAWAN_CHANNEL_NUM_DATARATES]</td></tr>
<tr class="memdesc:a9b8143ac9bbf3ed45e7cc80fc71ce055"><td class="mdescLeft">&#160;</td><td class="mdescRight">Array of allowed maximum payload lengths for each data rate. <br /></td></tr>
<tr class="separator:a9b8143ac9bbf3ed45e7cc80fc71ce055"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43fdafd540c93348f9b4a8958e021a4c"><td class="memItemLeft" align="right" valign="top"><a id="a43fdafd540c93348f9b4a8958e021a4c"></a>
int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_lo_ra_w_a_n_band__t.html#a43fdafd540c93348f9b4a8958e021a4c">powerMax</a></td></tr>
<tr class="memdesc:a43fdafd540c93348f9b4a8958e021a4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum allowed output power in this band in dBm. <br /></td></tr>
<tr class="separator:a43fdafd540c93348f9b4a8958e021a4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa22d7d7670846b36d3104439d18e5f15"><td class="memItemLeft" align="right" valign="top"><a id="aa22d7d7670846b36d3104439d18e5f15"></a>
int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_lo_ra_w_a_n_band__t.html#aa22d7d7670846b36d3104439d18e5f15">powerNumSteps</a></td></tr>
<tr class="memdesc:aa22d7d7670846b36d3104439d18e5f15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of power steps in this band. <br /></td></tr>
<tr class="separator:aa22d7d7670846b36d3104439d18e5f15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0eec1eadd79d66bd5db12d92c3642423"><td class="memItemLeft" align="right" valign="top"><a id="a0eec1eadd79d66bd5db12d92c3642423"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_lo_ra_w_a_n_band__t.html#a0eec1eadd79d66bd5db12d92c3642423">cfListType</a></td></tr>
<tr class="memdesc:a0eec1eadd79d66bd5db12d92c3642423"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the optional channels are defined as list of frequencies or bit mask. <br /></td></tr>
<tr class="separator:a0eec1eadd79d66bd5db12d92c3642423"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe8ccbc940eae22ed5d9f6e7cc929e74"><td class="memItemLeft" align="right" valign="top"><a id="abe8ccbc940eae22ed5d9f6e7cc929e74"></a>
float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_lo_ra_w_a_n_band__t.html#abe8ccbc940eae22ed5d9f6e7cc929e74">fskFreq</a></td></tr>
<tr class="memdesc:abe8ccbc940eae22ed5d9f6e7cc929e74"><td class="mdescLeft">&#160;</td><td class="mdescRight">FSK channel frequency. <br /></td></tr>
<tr class="separator:abe8ccbc940eae22ed5d9f6e7cc929e74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac469294eedf3ff6f621b9adef382a0c3"><td class="memItemLeft" align="right" valign="top"><a id="ac469294eedf3ff6f621b9adef382a0c3"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_lo_ra_w_a_n_band__t.html#ac469294eedf3ff6f621b9adef382a0c3">numChannelSpans</a></td></tr>
<tr class="memdesc:ac469294eedf3ff6f621b9adef382a0c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of channel spans in the band. <br /></td></tr>
<tr class="separator:ac469294eedf3ff6f621b9adef382a0c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9435bba595e2139c09fd46fd619390a9"><td class="memItemLeft" align="right" valign="top"><a id="a9435bba595e2139c09fd46fd619390a9"></a>
<a class="el" href="struct_lo_ra_w_a_n_channel_span__t.html">LoRaWANChannelSpan_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_lo_ra_w_a_n_band__t.html#a9435bba595e2139c09fd46fd619390a9">defaultChannels</a> [3]</td></tr>
<tr class="memdesc:a9435bba595e2139c09fd46fd619390a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default uplink (TX/RX1) channels defined by LoRaWAN Regional Parameters. <br /></td></tr>
<tr class="separator:a9435bba595e2139c09fd46fd619390a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3918faa9973af7255449d42e9d759746"><td class="memItemLeft" align="right" valign="top"><a id="a3918faa9973af7255449d42e9d759746"></a>
<a class="el" href="struct_lo_ra_w_a_n_channel_span__t.html">LoRaWANChannelSpan_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_lo_ra_w_a_n_band__t.html#a3918faa9973af7255449d42e9d759746">backupChannel</a></td></tr>
<tr class="memdesc:a3918faa9973af7255449d42e9d759746"><td class="mdescLeft">&#160;</td><td class="mdescRight">Backup downlink (RX2) channel - just a single channel, but using the same structure for convenience. <br /></td></tr>
<tr class="separator:a3918faa9973af7255449d42e9d759746"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Structure to save information about LoRaWAN band. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/protocols/LoRaWAN/<a class="el" href="_lo_ra_w_a_n_8h_source.html">LoRaWAN.h</a></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="struct_lo_ra_w_a_n_band__t.html">LoRaWANBand_t</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>