forks/RadioLibSmol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Deploying to gh-pages from @ 1c8d2d5cfb 🚀

Browse source
This commit is contained in:
jgromes 2024-01-27 17:50:02 +00:00
parent fc96a39ccc
commit 87ccf0eb34
2 changed files with 11 additions and 11 deletions

8
_lo_ra_w_a_n_8h_source.html
View file

@ -606,7 +606,7 @@ $(document).ready(function(){initNavTree('_lo_ra_w_a_n_8h_source.html',''); init
<div class="line"><a name="l00791"></a><span class="lineno"> 791</span>&#160; <span class="comment">// indicates whether an uplink has MAC commands as payload</span></div>
<div class="line"><a name="l00792"></a><span class="lineno"> 792</span>&#160; <span class="keywordtype">bool</span> isMACPayload = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00793"></a><span class="lineno"> 793</span>&#160; </div>
<div class="line"><a name="l00794"></a><span class="lineno"> 794</span>&#160; <span class="comment">// save the selected subband in case this must be restored in ADR control</span></div>
<div class="line"><a name="l00794"></a><span class="lineno"> 794</span>&#160; <span class="comment">// save the selected sub-band in case this must be restored in ADR control</span></div>
<div class="line"><a name="l00795"></a><span class="lineno"> 795</span>&#160; int8_t subBand = -1;</div>
<div class="line"><a name="l00796"></a><span class="lineno"> 796</span>&#160; </div>
<div class="line"><a name="l00797"></a><span class="lineno"> 797</span>&#160;<span class="preprocessor">#if !defined(RADIOLIB_EEPROM_UNSUPPORTED)</span></div>
@ -635,7 +635,7 @@ $(document).ready(function(){initNavTree('_lo_ra_w_a_n_8h_source.html',''); init
<div class="line"><a name="l00830"></a><span class="lineno"> 830</span>&#160; int16_t setupChannelsDyn(<span class="keywordtype">bool</span> joinRequest = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00831"></a><span class="lineno"> 831</span>&#160; </div>
<div class="line"><a name="l00832"></a><span class="lineno"> 832</span>&#160; <span class="comment">// setup uplink/downlink channel data rates and frequencies</span></div>
<div class="line"><a name="l00833"></a><span class="lineno"> 833</span>&#160; <span class="comment">// for fixed bands, we only allow one subband at a time to be selected</span></div>
<div class="line"><a name="l00833"></a><span class="lineno"> 833</span>&#160; <span class="comment">// for fixed bands, we only allow one sub-band at a time to be selected</span></div>
<div class="line"><a name="l00834"></a><span class="lineno"> 834</span>&#160; int16_t setupChannelsFix(uint8_t subBand);</div>
<div class="line"><a name="l00835"></a><span class="lineno"> 835</span>&#160; </div>
<div class="line"><a name="l00836"></a><span class="lineno"> 836</span>&#160; <span class="comment">// a join-accept can piggy-back a set of channels or channel masks</span></div>
@ -672,7 +672,7 @@ $(document).ready(function(){initNavTree('_lo_ra_w_a_n_8h_source.html',''); init
<div class="line"><a name="l00867"></a><span class="lineno"> 867</span>&#160; <span class="comment">// get the payload length for a specific MAC command</span></div>
<div class="line"><a name="l00868"></a><span class="lineno"> 868</span>&#160; uint8_t getMacPayloadLength(uint8_t cid);</div>
<div class="line"><a name="l00869"></a><span class="lineno"> 869</span>&#160; </div>
<div class="line"><a name="l00870"></a><span class="lineno"> 870</span>&#160; <span class="comment">// Performs CSMA as per LoRa Alliance Technical Reccomendation 13 (TR-013).</span></div>
<div class="line"><a name="l00870"></a><span class="lineno"> 870</span>&#160; <span class="comment">// Performs CSMA as per LoRa Alliance Technical Recommendation 13 (TR-013).</span></div>
<div class="line"><a name="l00871"></a><span class="lineno"> 871</span>&#160; <span class="keywordtype">void</span> performCSMA();</div>
<div class="line"><a name="l00872"></a><span class="lineno"> 872</span>&#160; </div>
<div class="line"><a name="l00873"></a><span class="lineno"> 873</span>&#160; <span class="comment">// perform a single CAD operation for the under SF/CH combination. Returns either busy or otherwise.</span></div>
@ -698,7 +698,7 @@ $(document).ready(function(){initNavTree('_lo_ra_w_a_n_8h_source.html',''); init
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a0e3c2642ebb6e86d6a739ea68d692e6a"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a0e3c2642ebb6e86d6a739ea68d692e6a">LoRaWANNode::uplink</a></div><div class="ttdeci">int16_t uplink(const char *str, uint8_t port, bool isConfirmed=false, LoRaWANEvent_t *event=NULL)</div><div class="ttdoc">Send a message to the server.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:881</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a158f65517fa910ef0cbcd92206dab284"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a158f65517fa910ef0cbcd92206dab284">LoRaWANNode::sendReceive</a></div><div class="ttdeci">int16_t sendReceive(const char *strUp, uint8_t port, uint8_t *dataDown, size_t *lenDown, bool isConfirmed=false, LoRaWANEvent_t *eventUp=NULL, LoRaWANEvent_t *eventDown=NULL)</div><div class="ttdoc">Send a message to the server and wait for a downlink during Rx1 and/or Rx2 window.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1623</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a2264c1d9f8ff0f83dc4000a2c80bc25d"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a2264c1d9f8ff0f83dc4000a2c80bc25d">LoRaWANNode::setTxPower</a></div><div class="ttdeci">int16_t setTxPower(int8_t txPower, bool saveToEeprom=false)</div><div class="ttdoc">Configure TX power of the radio module.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2021</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a3044715beeff759ed47342d532ac3205"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a3044715beeff759ed47342d532ac3205">LoRaWANNode::maxPayloadDwellTime</a></div><div class="ttdeci">uint8_t maxPayloadDwellTime()</div><div class="ttdoc">Returns the maximum payload given the currently present dwelltime limits. WARNING: the addition of MA...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2001</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a3044715beeff759ed47342d532ac3205"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a3044715beeff759ed47342d532ac3205">LoRaWANNode::maxPayloadDwellTime</a></div><div class="ttdeci">uint8_t maxPayloadDwellTime()</div><div class="ttdoc">Returns the maximum payload given the currently present dwell time limits. WARNING: the addition of M...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2001</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a40c5fdba815b26a44be7af68c184fe49"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a40c5fdba815b26a44be7af68c184fe49">LoRaWANNode::setDwellTime</a></div><div class="ttdeci">void setDwellTime(bool enable, uint32_t msPerUplink=0)</div><div class="ttdoc">Toggle adherence to dwellTime limits to on or off.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1992</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a52ae7c2aa61262d7761236f289889020"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a52ae7c2aa61262d7761236f289889020">LoRaWANNode::getFcntUp</a></div><div class="ttdeci">uint32_t getFcntUp()</div><div class="ttdoc">Returns the last uplink's frame counter.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1647</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a5449e301634dff1838a1b024b4067034"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a5449e301634dff1838a1b024b4067034">LoRaWANNode::setDeviceStatus</a></div><div class="ttdeci">void setDeviceStatus(uint8_t battLevel)</div><div class="ttdoc">Set device status.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1643</div></div>

14
class_lo_ra_w_a_n_node.html
View file

@ -179,7 +179,7 @@ uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="
<tr class="separator:a40c5fdba815b26a44be7af68c184fe49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3044715beeff759ed47342d532ac3205"><td class="memItemLeft" align="right" valign="top"><a id="a3044715beeff759ed47342d532ac3205"></a>
uint8_t&#160;</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">&#160;</td><td class="mdescRight">Returns the maximum payload given the currently present dwelltime limits. WARNING: the addition of MAC commands may cause uplink errors; if you want to be sure that your payload fits within dwelltime limits, subtract 16 from the result! <br /></td></tr>
<tr class="memdesc:a3044715beeff759ed47342d532ac3205"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
<tr class="memitem:a2264c1d9f8ff0f83dc4000a2c80bc25d"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lo_ra_w_a_n_node.html#a2264c1d9f8ff0f83dc4000a2c80bc25d">setTxPower</a> (int8_t txPower, bool saveToEeprom=false)</td></tr>
<tr class="memdesc:a2264c1d9f8ff0f83dc4000a2c80bc25d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure TX power of the radio module. <a href="class_lo_ra_w_a_n_node.html#a2264c1d9f8ff0f83dc4000a2c80bc25d">More...</a><br /></td></tr>
@ -188,10 +188,10 @@ uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c
<tr class="memdesc:adfc9cdaa254a27c28403188c90991757"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
<tr class="memitem:adf038f331c1dc954dafc2668e7a31ca0"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</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">&#160;</td><td class="mdescRight">Returns the quality of connectivity after requesting a LinkCheck MAC command. Returns 'true' if a network response was succesfully 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="memdesc:adf038f331c1dc954dafc2668e7a31ca0"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
<tr class="memitem:a9e6e1ce4296364606ff8b10fb5f971de"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</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">&#160;</td><td class="mdescRight">Returns the network time after requesting a DeviceTime MAC command. Returns 'true' if a network response was succesfully 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="memdesc:a9e6e1ce4296364606ff8b10fb5f971de"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
@ -243,7 +243,7 @@ uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>rx1DrOffset</b> =
<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 subband to be used (starting from 1!) </td></tr>
<tr><td class="paramname">subBand</td><td>The sub-band to be used (starting from 1!) </td></tr>
</table>
</dd>
</dl>
@ -457,7 +457,7 @@ uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>rx1DrOffset</b> =
<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 dutycyle (in milliseconds per hour). </td></tr>
<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>
@ -498,7 +498,7 @@ uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>rx1DrOffset</b> =
</table>
</div><div class="memdoc">
<p>Returns the network time after requesting a DeviceTime MAC command. Returns 'true' if a network response was succesfully parsed. Returns 'false' if there was no network response / parsing failed. </p>
<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>
@ -537,7 +537,7 @@ uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>rx1DrOffset</b> =
</table>
</div><div class="memdoc">
<p>Returns the quality of connectivity after requesting a LinkCheck MAC command. Returns 'true' if a network response was succesfully parsed. Returns 'false' if there was no network response / parsing failed. </p>
<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>