|
|
|
@ -575,363 +575,363 @@ $(document).ready(function(){initNavTree('_lo_ra_w_a_n_8h_source.html',''); init
|
|
|
|
|
<div class="line"><a name="l00736"></a><span class="lineno"> 736</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00743"></a><span class="lineno"> 743</span>  <span class="keywordtype">void</span> <a class="code" href="class_lo_ra_w_a_n_node.html#a3d4bbd6d382496838954ab4ac1168b77">setDutyCycle</a>(<span class="keywordtype">bool</span> enable = <span class="keyword">true</span>, <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> msPerHour = 0);</div>
|
|
|
|
|
<div class="line"><a name="l00744"></a><span class="lineno"> 744</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00750"></a><span class="lineno"> 750</span>  <span class="keywordtype">void</span> <a class="code" href="class_lo_ra_w_a_n_node.html#a288a86771bd40ac25f8f064c3a5b7f9d">setDwellTime</a>(<a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> msPerUplink);</div>
|
|
|
|
|
<div class="line"><a name="l00751"></a><span class="lineno"> 751</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00759"></a><span class="lineno"> 759</span>  <span class="keywordtype">void</span> <a class="code" href="class_lo_ra_w_a_n_node.html#a2d9a53560ebfbaf006eefd9761424d80">setCSMA</a>(<span class="keywordtype">bool</span> csmaEnabled, uint8_t maxChanges = 4, uint8_t backoffMax = 0, uint8_t difsSlots = 2);</div>
|
|
|
|
|
<div class="line"><a name="l00760"></a><span class="lineno"> 760</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00766"></a><span class="lineno"> 766</span>  <span class="keywordtype">void</span> <a class="code" href="class_lo_ra_w_a_n_node.html#a5449e301634dff1838a1b024b4067034">setDeviceStatus</a>(uint8_t battLevel);</div>
|
|
|
|
|
<div class="line"><a name="l00767"></a><span class="lineno"> 767</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00775"></a><span class="lineno"> 775</span>  <span class="keywordtype">void</span> <a class="code" href="class_lo_ra_w_a_n_node.html#a16c7ae2edfe324e11498b13aa042665f">scheduleTransmission</a>(<a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> tUplink);</div>
|
|
|
|
|
<div class="line"><a name="l00776"></a><span class="lineno"> 776</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00781"></a><span class="lineno"> 781</span>  uint32_t <a class="code" href="class_lo_ra_w_a_n_node.html#ad3217975ef9959ff83ce79dd80b0d777">getFCntUp</a>();</div>
|
|
|
|
|
<div class="line"><a name="l00782"></a><span class="lineno"> 782</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00787"></a><span class="lineno"> 787</span>  uint32_t <a class="code" href="class_lo_ra_w_a_n_node.html#aa7fabaa6efe9978c3674b1ab187446a1">getNFCntDown</a>();</div>
|
|
|
|
|
<div class="line"><a name="l00788"></a><span class="lineno"> 788</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00793"></a><span class="lineno"> 793</span>  uint32_t <a class="code" href="class_lo_ra_w_a_n_node.html#a6785265f3311ff6bf296f82429c96701">getAFCntDown</a>();</div>
|
|
|
|
|
<div class="line"><a name="l00794"></a><span class="lineno"> 794</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00800"></a><span class="lineno"> 800</span>  <span class="keywordtype">void</span> <a class="code" href="class_lo_ra_w_a_n_node.html#af4b3d07cd9bf4178d627204bae18b648">resetFCntDown</a>();</div>
|
|
|
|
|
<div class="line"><a name="l00801"></a><span class="lineno"> 801</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00806"></a><span class="lineno"> 806</span>  uint32_t <a class="code" href="class_lo_ra_w_a_n_node.html#aee0590cc9123ceac4c822eabed3150c6">getDevAddr</a>();</div>
|
|
|
|
|
<div class="line"><a name="l00807"></a><span class="lineno"> 807</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00812"></a><span class="lineno"> 812</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> <a class="code" href="class_lo_ra_w_a_n_node.html#a683b02b63867bb7de5df45c94d190305">getLastToA</a>();</div>
|
|
|
|
|
<div class="line"><a name="l00813"></a><span class="lineno"> 813</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00821"></a><span class="lineno"> 821</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> <a class="code" href="class_lo_ra_w_a_n_node.html#a5bb50904544f331806fd744ab5b99efa">dutyCycleInterval</a>(<a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> msPerHour, <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> airtime);</div>
|
|
|
|
|
<div class="line"><a name="l00822"></a><span class="lineno"> 822</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00824"></a><span class="lineno"> 824</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> <a class="code" href="class_lo_ra_w_a_n_node.html#a49e690c14858b46692e4ce9aa5a2566a">timeUntilUplink</a>();</div>
|
|
|
|
|
<div class="line"><a name="l00825"></a><span class="lineno"> 825</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00830"></a><span class="lineno"> 830</span>  uint8_t <a class="code" href="class_lo_ra_w_a_n_node.html#ab723160aa317cd84550d0da3a0f52811">getMaxPayloadLen</a>();</div>
|
|
|
|
|
<div class="line"><a name="l00831"></a><span class="lineno"> 831</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00836"></a><span class="lineno"><a class="line" href="class_lo_ra_w_a_n_node.html#a8226f4d0329d15da9ffc706e5781403a"> 836</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_lo_ra_w_a_n_node.html#a8226f4d0329d15da9ffc706e5781403a">TS009</a> = <span class="keyword">false</span>;</div>
|
|
|
|
|
<div class="line"><a name="l00837"></a><span class="lineno"> 837</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00850"></a><span class="lineno"><a class="line" href="class_lo_ra_w_a_n_node.html#a2176aa3d546e6b00e870a7e1e310c403"> 850</a></span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> <a class="code" href="class_lo_ra_w_a_n_node.html#a2176aa3d546e6b00e870a7e1e310c403">scanGuard</a> = 10;</div>
|
|
|
|
|
<div class="line"><a name="l00851"></a><span class="lineno"> 851</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00852"></a><span class="lineno"> 852</span> <span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
|
|
|
|
|
<div class="line"><a name="l00853"></a><span class="lineno"> 853</span>  <span class="keyword">protected</span>:</div>
|
|
|
|
|
<div class="line"><a name="l00854"></a><span class="lineno"> 854</span> <span class="preprocessor">#endif</span></div>
|
|
|
|
|
<div class="line"><a name="l00855"></a><span class="lineno"> 855</span>  <a class="code" href="class_physical_layer.html">PhysicalLayer</a>* phyLayer = NULL;</div>
|
|
|
|
|
<div class="line"><a name="l00856"></a><span class="lineno"> 856</span>  <span class="keyword">const</span> <a class="code" href="struct_lo_ra_w_a_n_band__t.html">LoRaWANBand_t</a>* band = NULL;</div>
|
|
|
|
|
<div class="line"><a name="l00857"></a><span class="lineno"> 857</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00858"></a><span class="lineno"> 858</span>  <span class="comment">// a buffer that holds all LW base parameters that should persist at all times!</span></div>
|
|
|
|
|
<div class="line"><a name="l00859"></a><span class="lineno"> 859</span>  uint8_t bufferNonces[RADIOLIB_LORAWAN_NONCES_BUF_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00860"></a><span class="lineno"> 860</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00861"></a><span class="lineno"> 861</span>  <span class="comment">// a buffer that holds all LW session parameters that preferably persist, but can be afforded to get lost</span></div>
|
|
|
|
|
<div class="line"><a name="l00862"></a><span class="lineno"> 862</span>  uint8_t bufferSession[RADIOLIB_LORAWAN_SESSION_BUF_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00863"></a><span class="lineno"> 863</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00864"></a><span class="lineno"> 864</span>  uint8_t fOptsUp[RADIOLIB_LORAWAN_FHDR_FOPTS_MAX_LEN] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00865"></a><span class="lineno"> 865</span>  uint8_t fOptsDown[RADIOLIB_LORAWAN_FHDR_FOPTS_MAX_LEN] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00866"></a><span class="lineno"> 866</span>  uint8_t fOptsUpLen = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00867"></a><span class="lineno"> 867</span>  uint8_t fOptsDownLen = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00868"></a><span class="lineno"> 868</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00869"></a><span class="lineno"> 869</span>  uint16_t lwMode = RADIOLIB_LORAWAN_MODE_NONE;</div>
|
|
|
|
|
<div class="line"><a name="l00870"></a><span class="lineno"> 870</span>  uint8_t lwClass = RADIOLIB_LORAWAN_CLASS_A;</div>
|
|
|
|
|
<div class="line"><a name="l00871"></a><span class="lineno"> 871</span>  <span class="keywordtype">bool</span> isActive = <span class="keyword">false</span>;</div>
|
|
|
|
|
<div class="line"><a name="l00872"></a><span class="lineno"> 872</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00873"></a><span class="lineno"> 873</span>  uint64_t joinEUI = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00874"></a><span class="lineno"> 874</span>  uint64_t devEUI = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00875"></a><span class="lineno"> 875</span>  uint8_t nwkKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00876"></a><span class="lineno"> 876</span>  uint8_t appKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00877"></a><span class="lineno"> 877</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00878"></a><span class="lineno"> 878</span>  <span class="comment">// the following is either provided by the network server (OTAA)</span></div>
|
|
|
|
|
<div class="line"><a name="l00879"></a><span class="lineno"> 879</span>  <span class="comment">// or directly entered by the user (ABP)</span></div>
|
|
|
|
|
<div class="line"><a name="l00880"></a><span class="lineno"> 880</span>  uint32_t devAddr = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00881"></a><span class="lineno"> 881</span>  uint8_t appSKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00882"></a><span class="lineno"> 882</span>  uint8_t fNwkSIntKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00883"></a><span class="lineno"> 883</span>  uint8_t sNwkSIntKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00884"></a><span class="lineno"> 884</span>  uint8_t nwkSEncKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00885"></a><span class="lineno"> 885</span>  uint8_t jSIntKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00886"></a><span class="lineno"> 886</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00887"></a><span class="lineno"> 887</span>  uint16_t keyCheckSum = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00888"></a><span class="lineno"> 888</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00889"></a><span class="lineno"> 889</span>  <span class="comment">// device-specific parameters, persistent through sessions</span></div>
|
|
|
|
|
<div class="line"><a name="l00890"></a><span class="lineno"> 890</span>  uint16_t devNonce = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00891"></a><span class="lineno"> 891</span>  uint32_t joinNonce = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00892"></a><span class="lineno"> 892</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00893"></a><span class="lineno"> 893</span>  <span class="comment">// session-specific parameters</span></div>
|
|
|
|
|
<div class="line"><a name="l00894"></a><span class="lineno"> 894</span>  uint32_t homeNetId = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00895"></a><span class="lineno"> 895</span>  uint8_t adrLimitExp = RADIOLIB_LORAWAN_ADR_ACK_LIMIT_EXP;</div>
|
|
|
|
|
<div class="line"><a name="l00896"></a><span class="lineno"> 896</span>  uint8_t adrDelayExp = RADIOLIB_LORAWAN_ADR_ACK_DELAY_EXP;</div>
|
|
|
|
|
<div class="line"><a name="l00897"></a><span class="lineno"> 897</span>  uint8_t nbTrans = 1; <span class="comment">// Number of allowed frame retransmissions</span></div>
|
|
|
|
|
<div class="line"><a name="l00898"></a><span class="lineno"> 898</span>  uint8_t txPowerSteps = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00899"></a><span class="lineno"> 899</span>  uint8_t txPowerMax = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00900"></a><span class="lineno"> 900</span>  uint32_t fCntUp = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00901"></a><span class="lineno"> 901</span>  uint32_t aFCntDown = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00902"></a><span class="lineno"> 902</span>  uint32_t nFCntDown = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00903"></a><span class="lineno"> 903</span>  uint32_t confFCntUp = RADIOLIB_LORAWAN_FCNT_NONE;</div>
|
|
|
|
|
<div class="line"><a name="l00904"></a><span class="lineno"> 904</span>  uint32_t confFCntDown = RADIOLIB_LORAWAN_FCNT_NONE;</div>
|
|
|
|
|
<div class="line"><a name="l00905"></a><span class="lineno"> 905</span>  uint32_t adrFCnt = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00906"></a><span class="lineno"> 906</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00907"></a><span class="lineno"> 907</span>  <span class="comment">// ADR is enabled by default</span></div>
|
|
|
|
|
<div class="line"><a name="l00908"></a><span class="lineno"> 908</span>  <span class="keywordtype">bool</span> adrEnabled = <span class="keyword">true</span>;</div>
|
|
|
|
|
<div class="line"><a name="l00909"></a><span class="lineno"> 909</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00910"></a><span class="lineno"> 910</span>  <span class="comment">// duty cycle is set upon initialization and activated in regions that impose this</span></div>
|
|
|
|
|
<div class="line"><a name="l00911"></a><span class="lineno"> 911</span>  <span class="keywordtype">bool</span> dutyCycleEnabled = <span class="keyword">false</span>;</div>
|
|
|
|
|
<div class="line"><a name="l00912"></a><span class="lineno"> 912</span>  uint32_t dutyCycle = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00913"></a><span class="lineno"> 913</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00914"></a><span class="lineno"> 914</span>  <span class="comment">// dwell time is set upon initialization and activated in regions that impose this</span></div>
|
|
|
|
|
<div class="line"><a name="l00915"></a><span class="lineno"> 915</span>  uint16_t dwellTimeUp = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00916"></a><span class="lineno"> 916</span>  uint16_t dwellTimeDn = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00917"></a><span class="lineno"> 917</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00918"></a><span class="lineno"> 918</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> tUplink = 0; <span class="comment">// scheduled uplink transmission time (internal clock)</span></div>
|
|
|
|
|
<div class="line"><a name="l00919"></a><span class="lineno"> 919</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> tDownlink = 0; <span class="comment">// time at end of downlink reception</span></div>
|
|
|
|
|
<div class="line"><a name="l00920"></a><span class="lineno"> 920</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00921"></a><span class="lineno"> 921</span>  <span class="comment">// enable/disable CSMA for LoRaWAN</span></div>
|
|
|
|
|
<div class="line"><a name="l00922"></a><span class="lineno"> 922</span>  <span class="keywordtype">bool</span> csmaEnabled = <span class="keyword">false</span>;</div>
|
|
|
|
|
<div class="line"><a name="l00923"></a><span class="lineno"> 923</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00924"></a><span class="lineno"> 924</span>  <span class="comment">// maximum number of channel hops during CSMA</span></div>
|
|
|
|
|
<div class="line"><a name="l00925"></a><span class="lineno"> 925</span>  uint8_t maxChanges = RADIOLIB_LORAWAN_MAX_CHANGES_DEFAULT;</div>
|
|
|
|
|
<div class="line"><a name="l00926"></a><span class="lineno"> 926</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00927"></a><span class="lineno"> 927</span>  <span class="comment">// number of backoff slots to be checked after DIFS phase.</span></div>
|
|
|
|
|
<div class="line"><a name="l00928"></a><span class="lineno"> 928</span>  <span class="comment">// A random BO avoids collisions in the case where two or more nodes start the CSMA</span></div>
|
|
|
|
|
<div class="line"><a name="l00929"></a><span class="lineno"> 929</span>  <span class="comment">// process at the same time. </span></div>
|
|
|
|
|
<div class="line"><a name="l00930"></a><span class="lineno"> 930</span>  uint8_t backoffMax = RADIOLIB_LORAWAN_BACKOFF_MAX_DEFAULT;</div>
|
|
|
|
|
<div class="line"><a name="l00931"></a><span class="lineno"> 931</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00932"></a><span class="lineno"> 932</span>  <span class="comment">// number of CADs to estimate a clear CH</span></div>
|
|
|
|
|
<div class="line"><a name="l00933"></a><span class="lineno"> 933</span>  uint8_t difsSlots = RADIOLIB_LORAWAN_DIFS_DEFAULT;</div>
|
|
|
|
|
<div class="line"><a name="l00934"></a><span class="lineno"> 934</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00935"></a><span class="lineno"> 935</span>  <span class="comment">// available channel frequencies from list passed during OTA activation</span></div>
|
|
|
|
|
<div class="line"><a name="l00936"></a><span class="lineno"> 936</span>  <a class="code" href="struct_lo_ra_w_a_n_channel__t.html">LoRaWANChannel_t</a> channelPlan[2][RADIOLIB_LORAWAN_NUM_AVAILABLE_CHANNELS];</div>
|
|
|
|
|
<div class="line"><a name="l00937"></a><span class="lineno"> 937</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00938"></a><span class="lineno"> 938</span>  <span class="comment">// currently configured channels for TX, RX1, RX2</span></div>
|
|
|
|
|
<div class="line"><a name="l00939"></a><span class="lineno"> 939</span>  <a class="code" href="struct_lo_ra_w_a_n_channel__t.html">LoRaWANChannel_t</a> channels[3] = { RADIOLIB_LORAWAN_CHANNEL_NONE, RADIOLIB_LORAWAN_CHANNEL_NONE,</div>
|
|
|
|
|
<div class="line"><a name="l00940"></a><span class="lineno"> 940</span>  RADIOLIB_LORAWAN_CHANNEL_NONE };</div>
|
|
|
|
|
<div class="line"><a name="l00941"></a><span class="lineno"> 941</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00942"></a><span class="lineno"> 942</span>  <span class="comment">// delays between the uplink and RX1/2 windows</span></div>
|
|
|
|
|
<div class="line"><a name="l00943"></a><span class="lineno"> 943</span>  <span class="comment">// the first field is meaningless, but is used for offsetting for Rx windows 1 and 2</span></div>
|
|
|
|
|
<div class="line"><a name="l00944"></a><span class="lineno"> 944</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> rxDelays[3] = { 0, RADIOLIB_LORAWAN_RECEIVE_DELAY_1_MS, RADIOLIB_LORAWAN_RECEIVE_DELAY_2_MS };</div>
|
|
|
|
|
<div class="line"><a name="l00945"></a><span class="lineno"> 945</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00946"></a><span class="lineno"> 946</span>  <span class="comment">// offset between TX and RX1 (such that RX1 has equal or lower DR)</span></div>
|
|
|
|
|
<div class="line"><a name="l00947"></a><span class="lineno"> 947</span>  uint8_t rx1DrOffset = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00948"></a><span class="lineno"> 948</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00949"></a><span class="lineno"> 949</span>  <span class="comment">// LoRaWAN revision (1.0 vs 1.1)</span></div>
|
|
|
|
|
<div class="line"><a name="l00950"></a><span class="lineno"> 950</span>  uint8_t rev = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00951"></a><span class="lineno"> 951</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00952"></a><span class="lineno"> 952</span>  <span class="comment">// Time on Air of last uplink</span></div>
|
|
|
|
|
<div class="line"><a name="l00953"></a><span class="lineno"> 953</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> lastToA = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00954"></a><span class="lineno"> 954</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00955"></a><span class="lineno"> 955</span>  <span class="comment">// timestamp to measure the RX1/2 delay (from uplink end)</span></div>
|
|
|
|
|
<div class="line"><a name="l00956"></a><span class="lineno"> 956</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> rxDelayStart = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00957"></a><span class="lineno"> 957</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00958"></a><span class="lineno"> 958</span>  <span class="comment">// timestamp when the Rx1/2 windows were closed (timeout or uplink received)</span></div>
|
|
|
|
|
<div class="line"><a name="l00959"></a><span class="lineno"> 959</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> rxDelayEnd = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00960"></a><span class="lineno"> 960</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00961"></a><span class="lineno"> 961</span>  <span class="comment">// device status - battery level</span></div>
|
|
|
|
|
<div class="line"><a name="l00962"></a><span class="lineno"> 962</span>  uint8_t battLevel = 0xFF;</div>
|
|
|
|
|
<div class="line"><a name="l00963"></a><span class="lineno"> 963</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00964"></a><span class="lineno"> 964</span>  <span class="comment">// indicates whether an uplink has MAC commands as payload</span></div>
|
|
|
|
|
<div class="line"><a name="l00965"></a><span class="lineno"> 965</span>  <span class="keywordtype">bool</span> isMACPayload = <span class="keyword">false</span>;</div>
|
|
|
|
|
<div class="line"><a name="l00966"></a><span class="lineno"> 966</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00967"></a><span class="lineno"> 967</span>  <span class="comment">// save the selected sub-band in case this must be restored in ADR control</span></div>
|
|
|
|
|
<div class="line"><a name="l00968"></a><span class="lineno"> 968</span>  uint8_t subBand = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00969"></a><span class="lineno"> 969</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00970"></a><span class="lineno"> 970</span>  <span class="comment">// allow port 226 for devices implementing TS011</span></div>
|
|
|
|
|
<div class="line"><a name="l00971"></a><span class="lineno"> 971</span>  <span class="keywordtype">bool</span> TS011 = <span class="keyword">false</span>;</div>
|
|
|
|
|
<div class="line"><a name="l00972"></a><span class="lineno"> 972</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00973"></a><span class="lineno"> 973</span>  <span class="comment">// this will reset the device credentials, so the device starts completely new</span></div>
|
|
|
|
|
<div class="line"><a name="l00974"></a><span class="lineno"> 974</span>  <span class="keywordtype">void</span> clearNonces();</div>
|
|
|
|
|
<div class="line"><a name="l00975"></a><span class="lineno"> 975</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00976"></a><span class="lineno"> 976</span>  <span class="comment">// start a fresh session using default parameters</span></div>
|
|
|
|
|
<div class="line"><a name="l00977"></a><span class="lineno"> 977</span>  <span class="keywordtype">void</span> createSession(uint16_t lwMode, uint8_t initialDr);</div>
|
|
|
|
|
<div class="line"><a name="l00978"></a><span class="lineno"> 978</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00979"></a><span class="lineno"> 979</span>  <span class="comment">// setup Join-Request payload</span></div>
|
|
|
|
|
<div class="line"><a name="l00980"></a><span class="lineno"> 980</span>  <span class="keywordtype">void</span> composeJoinRequest(uint8_t* joinRequestMsg);</div>
|
|
|
|
|
<div class="line"><a name="l00981"></a><span class="lineno"> 981</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00982"></a><span class="lineno"> 982</span>  <span class="comment">// extract Join-Accept payload and start a new session</span></div>
|
|
|
|
|
<div class="line"><a name="l00983"></a><span class="lineno"> 983</span>  int16_t processJoinAccept(<a class="code" href="struct_lo_ra_w_a_n_join_event__t.html">LoRaWANJoinEvent_t</a> *joinEvent);</div>
|
|
|
|
|
<div class="line"><a name="l00984"></a><span class="lineno"> 984</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00985"></a><span class="lineno"> 985</span>  <span class="comment">// a join-accept can piggy-back a set of channels or channel masks</span></div>
|
|
|
|
|
<div class="line"><a name="l00986"></a><span class="lineno"> 986</span>  <span class="keywordtype">void</span> processCFList(uint8_t* cfList);</div>
|
|
|
|
|
<div class="line"><a name="l00987"></a><span class="lineno"> 987</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00988"></a><span class="lineno"> 988</span>  <span class="comment">// check whether payload length and fport are allowed</span></div>
|
|
|
|
|
<div class="line"><a name="l00989"></a><span class="lineno"> 989</span>  int16_t isValidUplink(uint8_t* len, uint8_t fPort);</div>
|
|
|
|
|
<div class="line"><a name="l00990"></a><span class="lineno"> 990</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00991"></a><span class="lineno"> 991</span>  <span class="comment">// perform ADR backoff</span></div>
|
|
|
|
|
<div class="line"><a name="l00992"></a><span class="lineno"> 992</span>  <span class="keywordtype">void</span> adrBackoff();</div>
|
|
|
|
|
<div class="line"><a name="l00993"></a><span class="lineno"> 993</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00994"></a><span class="lineno"> 994</span>  <span class="comment">// create an encrypted uplink buffer, composing metadata, user data and MAC data</span></div>
|
|
|
|
|
<div class="line"><a name="l00995"></a><span class="lineno"> 995</span>  <span class="keywordtype">void</span> composeUplink(<span class="keyword">const</span> uint8_t* in, uint8_t lenIn, uint8_t* out, uint8_t fPort, <span class="keywordtype">bool</span> isConfirmed);</div>
|
|
|
|
|
<div class="line"><a name="l00996"></a><span class="lineno"> 996</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00997"></a><span class="lineno"> 997</span>  <span class="comment">// generate and set the MIC of an uplink buffer (depends on selected channels)</span></div>
|
|
|
|
|
<div class="line"><a name="l00998"></a><span class="lineno"> 998</span>  <span class="keywordtype">void</span> micUplink(uint8_t* inOut, uint8_t lenInOut);</div>
|
|
|
|
|
<div class="line"><a name="l00999"></a><span class="lineno"> 999</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01000"></a><span class="lineno"> 1000</span>  <span class="comment">// transmit uplink buffer on a specified channel</span></div>
|
|
|
|
|
<div class="line"><a name="l01001"></a><span class="lineno"> 1001</span>  int16_t transmitUplink(<a class="code" href="struct_lo_ra_w_a_n_channel__t.html">LoRaWANChannel_t</a>* chnl, uint8_t* in, uint8_t len, <span class="keywordtype">bool</span> retrans);</div>
|
|
|
|
|
<div class="line"><a name="l01002"></a><span class="lineno"> 1002</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01003"></a><span class="lineno"> 1003</span>  <span class="comment">// wait for, open and listen during receive windows; only performs listening</span></div>
|
|
|
|
|
<div class="line"><a name="l01004"></a><span class="lineno"> 1004</span>  int16_t receiveCommon(uint8_t dir, <span class="keyword">const</span> <a class="code" href="struct_lo_ra_w_a_n_channel__t.html">LoRaWANChannel_t</a>* dlChannels, <span class="keyword">const</span> <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a>* dlDelays, uint8_t numWindows, <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> tReference);</div>
|
|
|
|
|
<div class="line"><a name="l01005"></a><span class="lineno"> 1005</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01006"></a><span class="lineno"> 1006</span>  <span class="comment">// extract downlink payload and process MAC commands</span></div>
|
|
|
|
|
<div class="line"><a name="l01007"></a><span class="lineno"> 1007</span>  int16_t parseDownlink(uint8_t* data, <span class="keywordtype">size_t</span>* len, <a class="code" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a>* event = NULL);</div>
|
|
|
|
|
<div class="line"><a name="l01008"></a><span class="lineno"> 1008</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01009"></a><span class="lineno"> 1009</span>  <span class="comment">// execute mac command, return the number of processed bytes for sequential processing</span></div>
|
|
|
|
|
<div class="line"><a name="l01010"></a><span class="lineno"> 1010</span>  <span class="keywordtype">bool</span> execMacCommand(uint8_t cid, uint8_t* optIn, uint8_t lenIn);</div>
|
|
|
|
|
<div class="line"><a name="l01011"></a><span class="lineno"> 1011</span>  <span class="keywordtype">bool</span> execMacCommand(uint8_t cid, uint8_t* optIn, uint8_t lenIn, uint8_t* optOut);</div>
|
|
|
|
|
<div class="line"><a name="l01012"></a><span class="lineno"> 1012</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01013"></a><span class="lineno"> 1013</span>  <span class="comment">// possible override for additional MAC commands that are not in the base specification</span></div>
|
|
|
|
|
<div class="line"><a name="l01014"></a><span class="lineno"> 1014</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> derivedMacHandler(uint8_t cid, uint8_t* optIn, uint8_t lenIn, uint8_t* optOut);</div>
|
|
|
|
|
<div class="line"><a name="l01015"></a><span class="lineno"> 1015</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01016"></a><span class="lineno"> 1016</span>  <span class="comment">// pre-process a (set of) LinkAdrReq commands into one super-channel-mask + Tx/Dr/NbTrans fields</span></div>
|
|
|
|
|
<div class="line"><a name="l01017"></a><span class="lineno"> 1017</span>  <span class="keywordtype">void</span> preprocessMacLinkAdr(uint8_t* mPtr, uint8_t cLen, uint8_t* mAdrOpt);</div>
|
|
|
|
|
<div class="line"><a name="l01018"></a><span class="lineno"> 1018</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01019"></a><span class="lineno"> 1019</span>  <span class="comment">// post-process a (set of) LinkAdrAns commands depending on LoRaWAN version</span></div>
|
|
|
|
|
<div class="line"><a name="l01020"></a><span class="lineno"> 1020</span>  <span class="keywordtype">void</span> postprocessMacLinkAdr(uint8_t* ack, uint8_t cLen);</div>
|
|
|
|
|
<div class="line"><a name="l01021"></a><span class="lineno"> 1021</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01022"></a><span class="lineno"> 1022</span>  <span class="comment">// get the properties of a MAC command given a certain command ID</span></div>
|
|
|
|
|
<div class="line"><a name="l01023"></a><span class="lineno"> 1023</span>  int16_t getMacCommand(uint8_t cid, <a class="code" href="struct_lo_ra_w_a_n_mac_command__t.html">LoRaWANMacCommand_t</a>* cmd);</div>
|
|
|
|
|
<div class="line"><a name="l01024"></a><span class="lineno"> 1024</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01025"></a><span class="lineno"> 1025</span>  <span class="comment">// possible override for additional MAC commands that are not in the base specification</span></div>
|
|
|
|
|
<div class="line"><a name="l01026"></a><span class="lineno"> 1026</span>  <span class="keyword">virtual</span> int16_t derivedMacFinder(uint8_t cid, <a class="code" href="struct_lo_ra_w_a_n_mac_command__t.html">LoRaWANMacCommand_t</a>* cmd);</div>
|
|
|
|
|
<div class="line"><a name="l01027"></a><span class="lineno"> 1027</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01028"></a><span class="lineno"> 1028</span>  <span class="comment">// get the length of a certain MAC command in a specific direction (up/down)</span></div>
|
|
|
|
|
<div class="line"><a name="l01029"></a><span class="lineno"> 1029</span>  <span class="comment">// if inclusive is true, add one for the CID byte</span></div>
|
|
|
|
|
<div class="line"><a name="l01030"></a><span class="lineno"> 1030</span>  int16_t getMacLen(uint8_t cid, uint8_t* len, uint8_t dir, <span class="keywordtype">bool</span> inclusive = <span class="keyword">false</span>);</div>
|
|
|
|
|
<div class="line"><a name="l01031"></a><span class="lineno"> 1031</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01032"></a><span class="lineno"> 1032</span>  <span class="comment">// find out of a MAC command should persist destruction</span></div>
|
|
|
|
|
<div class="line"><a name="l01033"></a><span class="lineno"> 1033</span>  <span class="comment">// in uplink direction, some commands must persist if no downlink is received</span></div>
|
|
|
|
|
<div class="line"><a name="l01034"></a><span class="lineno"> 1034</span>  <span class="comment">// in downlink direction, the user-accessible MAC commands remain available for retrieval</span></div>
|
|
|
|
|
<div class="line"><a name="l01035"></a><span class="lineno"> 1035</span>  <span class="keywordtype">bool</span> isPersistentMacCommand(uint8_t cid, uint8_t dir);</div>
|
|
|
|
|
<div class="line"><a name="l01036"></a><span class="lineno"> 1036</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01037"></a><span class="lineno"> 1037</span>  <span class="comment">// push MAC command to queue, done by copy</span></div>
|
|
|
|
|
<div class="line"><a name="l01038"></a><span class="lineno"> 1038</span>  int16_t pushMacCommand(uint8_t cid, uint8_t* cOcts, uint8_t* out, uint8_t* lenOut, uint8_t dir);</div>
|
|
|
|
|
<div class="line"><a name="l01039"></a><span class="lineno"> 1039</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01040"></a><span class="lineno"> 1040</span>  <span class="comment">// retrieve the payload of a certain MAC command, if present in the buffer</span></div>
|
|
|
|
|
<div class="line"><a name="l01041"></a><span class="lineno"> 1041</span>  int16_t getMacPayload(uint8_t cid, uint8_t* in, uint8_t lenIn, uint8_t* out, uint8_t dir);</div>
|
|
|
|
|
<div class="line"><a name="l01042"></a><span class="lineno"> 1042</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01043"></a><span class="lineno"> 1043</span>  <span class="comment">// delete a specific MAC command from queue, indicated by the command ID</span></div>
|
|
|
|
|
<div class="line"><a name="l01044"></a><span class="lineno"> 1044</span>  int16_t deleteMacCommand(uint8_t cid, uint8_t* inOut, uint8_t* lenInOut, uint8_t dir);</div>
|
|
|
|
|
<div class="line"><a name="l01045"></a><span class="lineno"> 1045</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01046"></a><span class="lineno"> 1046</span>  <span class="comment">// clear a MAC buffer, possible retaining persistent MAC commands</span></div>
|
|
|
|
|
<div class="line"><a name="l01047"></a><span class="lineno"> 1047</span>  <span class="keywordtype">void</span> clearMacCommands(uint8_t* inOut, uint8_t* lenInOut, uint8_t dir);</div>
|
|
|
|
|
<div class="line"><a name="l01048"></a><span class="lineno"> 1048</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01049"></a><span class="lineno"> 1049</span>  <span class="comment">// configure the common physical layer properties (frequency, sync word etc.)</span></div>
|
|
|
|
|
<div class="line"><a name="l01050"></a><span class="lineno"> 1050</span>  int16_t setPhyProperties(<span class="keyword">const</span> <a class="code" href="struct_lo_ra_w_a_n_channel__t.html">LoRaWANChannel_t</a>* chnl, uint8_t dir, int8_t pwr, <span class="keywordtype">size_t</span> pre = 0);</div>
|
|
|
|
|
<div class="line"><a name="l01051"></a><span class="lineno"> 1051</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01052"></a><span class="lineno"> 1052</span>  <span class="comment">// Performs CSMA as per LoRa Alliance Technical Recommendation 13 (TR-013).</span></div>
|
|
|
|
|
<div class="line"><a name="l01053"></a><span class="lineno"> 1053</span>  <span class="keywordtype">bool</span> csmaChannelClear(uint8_t difs, uint8_t numBackoff);</div>
|
|
|
|
|
<div class="line"><a name="l01054"></a><span class="lineno"> 1054</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01055"></a><span class="lineno"> 1055</span>  <span class="comment">// perform a single CAD operation for the under SF/CH combination. Returns either busy or otherwise.</span></div>
|
|
|
|
|
<div class="line"><a name="l01056"></a><span class="lineno"> 1056</span>  <span class="keywordtype">bool</span> cadChannelClear();</div>
|
|
|
|
|
<div class="line"><a name="l01057"></a><span class="lineno"> 1057</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01058"></a><span class="lineno"> 1058</span>  <span class="comment">// (dynamic bands:) get or (fixed bands:) create a complete 80-bit channel mask for current configuration</span></div>
|
|
|
|
|
<div class="line"><a name="l01059"></a><span class="lineno"> 1059</span>  <span class="keywordtype">void</span> getChannelPlanMask(uint64_t* chMaskGrp0123, uint32_t* chMaskGrp45);</div>
|
|
|
|
|
<div class="line"><a name="l01060"></a><span class="lineno"> 1060</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01061"></a><span class="lineno"> 1061</span>  <span class="comment">// setup uplink/downlink channel data rates and frequencies</span></div>
|
|
|
|
|
<div class="line"><a name="l01062"></a><span class="lineno"> 1062</span>  <span class="comment">// for dynamic channels, there is a small set of predefined channels</span></div>
|
|
|
|
|
<div class="line"><a name="l01063"></a><span class="lineno"> 1063</span>  <span class="comment">// in case of JoinRequest, add some optional extra frequencies </span></div>
|
|
|
|
|
<div class="line"><a name="l01064"></a><span class="lineno"> 1064</span>  <span class="keywordtype">void</span> selectChannelPlanDyn();</div>
|
|
|
|
|
<div class="line"><a name="l01065"></a><span class="lineno"> 1065</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01066"></a><span class="lineno"> 1066</span>  <span class="comment">// setup uplink/downlink channel data rates and frequencies</span></div>
|
|
|
|
|
<div class="line"><a name="l01067"></a><span class="lineno"> 1067</span>  <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="l01068"></a><span class="lineno"> 1068</span>  <span class="keywordtype">void</span> selectChannelPlanFix();</div>
|
|
|
|
|
<div class="line"><a name="l01069"></a><span class="lineno"> 1069</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01070"></a><span class="lineno"> 1070</span>  <span class="comment">// get the number of available channels,</span></div>
|
|
|
|
|
<div class="line"><a name="l01071"></a><span class="lineno"> 1071</span>  <span class="comment">// along with a 16-bit mask indicating which channels can be used next for uplink/downlink</span></div>
|
|
|
|
|
<div class="line"><a name="l01072"></a><span class="lineno"> 1072</span>  uint8_t getAvailableChannels(uint16_t* mask);</div>
|
|
|
|
|
<div class="line"><a name="l01073"></a><span class="lineno"> 1073</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01074"></a><span class="lineno"> 1074</span>  <span class="comment">// (re)set/restore which channels can be used next for uplink/downlink</span></div>
|
|
|
|
|
<div class="line"><a name="l01075"></a><span class="lineno"> 1075</span>  <span class="keywordtype">void</span> setAvailableChannels(uint16_t mask);</div>
|
|
|
|
|
<div class="line"><a name="l01076"></a><span class="lineno"> 1076</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01077"></a><span class="lineno"> 1077</span>  <span class="comment">// select a set of random TX/RX channels for up- and downlink</span></div>
|
|
|
|
|
<div class="line"><a name="l01078"></a><span class="lineno"> 1078</span>  int16_t selectChannels();</div>
|
|
|
|
|
<div class="line"><a name="l01079"></a><span class="lineno"> 1079</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01080"></a><span class="lineno"> 1080</span>  <span class="comment">// apply a 96-bit channel mask</span></div>
|
|
|
|
|
<div class="line"><a name="l01081"></a><span class="lineno"> 1081</span>  <span class="keywordtype">bool</span> applyChannelMask(uint64_t chMaskGrp0123, uint32_t chMaskGrp45);</div>
|
|
|
|
|
<div class="line"><a name="l01082"></a><span class="lineno"> 1082</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01083"></a><span class="lineno"> 1083</span> <span class="preprocessor">#if RADIOLIB_DEBUG_PROTOCOL</span></div>
|
|
|
|
|
<div class="line"><a name="l01084"></a><span class="lineno"> 1084</span>  <span class="comment">// print the available channels through debug</span></div>
|
|
|
|
|
<div class="line"><a name="l01085"></a><span class="lineno"> 1085</span>  <span class="keywordtype">void</span> printChannels();</div>
|
|
|
|
|
<div class="line"><a name="l01086"></a><span class="lineno"> 1086</span> <span class="preprocessor">#endif</span></div>
|
|
|
|
|
<div class="line"><a name="l01087"></a><span class="lineno"> 1087</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01088"></a><span class="lineno"> 1088</span>  <span class="comment">// method to generate message integrity code</span></div>
|
|
|
|
|
<div class="line"><a name="l01089"></a><span class="lineno"> 1089</span>  uint32_t generateMIC(uint8_t* msg, <span class="keywordtype">size_t</span> len, uint8_t* key);</div>
|
|
|
|
|
<div class="line"><a name="l01090"></a><span class="lineno"> 1090</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01091"></a><span class="lineno"> 1091</span>  <span class="comment">// method to verify message integrity code</span></div>
|
|
|
|
|
<div class="line"><a name="l01092"></a><span class="lineno"> 1092</span>  <span class="comment">// it assumes that the MIC is the last 4 bytes of the message</span></div>
|
|
|
|
|
<div class="line"><a name="l01093"></a><span class="lineno"> 1093</span>  <span class="keywordtype">bool</span> verifyMIC(uint8_t* msg, <span class="keywordtype">size_t</span> len, uint8_t* key);</div>
|
|
|
|
|
<div class="line"><a name="l01094"></a><span class="lineno"> 1094</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01095"></a><span class="lineno"> 1095</span>  <span class="comment">// find the first usable data rate for the given band</span></div>
|
|
|
|
|
<div class="line"><a name="l01096"></a><span class="lineno"> 1096</span>  int16_t findDataRate(uint8_t dr, <a class="code" href="union_data_rate__t.html">DataRate_t</a>* dataRate);</div>
|
|
|
|
|
<div class="line"><a name="l01097"></a><span class="lineno"> 1097</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01098"></a><span class="lineno"> 1098</span>  <span class="comment">// function to encrypt and decrypt payloads (regular uplink/downlink)</span></div>
|
|
|
|
|
<div class="line"><a name="l01099"></a><span class="lineno"> 1099</span>  <span class="keywordtype">void</span> processAES(<span class="keyword">const</span> uint8_t* in, <span class="keywordtype">size_t</span> len, uint8_t* key, uint8_t* out, uint32_t fCnt, uint8_t dir, uint8_t ctrId, <span class="keywordtype">bool</span> counter);</div>
|
|
|
|
|
<div class="line"><a name="l01100"></a><span class="lineno"> 1100</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01101"></a><span class="lineno"> 1101</span>  <span class="comment">// 16-bit checksum method that takes a uint8_t array of even length and calculates the checksum</span></div>
|
|
|
|
|
<div class="line"><a name="l01102"></a><span class="lineno"> 1102</span>  <span class="keyword">static</span> uint16_t checkSum16(<span class="keyword">const</span> uint8_t *key, uint16_t keyLen);</div>
|
|
|
|
|
<div class="line"><a name="l01103"></a><span class="lineno"> 1103</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01104"></a><span class="lineno"> 1104</span>  <span class="comment">// check the integrity of a buffer using a 16-bit checksum located in the last two bytes of the buffer</span></div>
|
|
|
|
|
<div class="line"><a name="l01105"></a><span class="lineno"> 1105</span>  <span class="keyword">static</span> int16_t checkBufferCommon(<span class="keyword">const</span> uint8_t *buffer, uint16_t size);</div>
|
|
|
|
|
<div class="line"><a name="l01106"></a><span class="lineno"> 1106</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01107"></a><span class="lineno"> 1107</span>  <span class="comment">// network-to-host conversion method - takes data from network packet and converts it to the host endians</span></div>
|
|
|
|
|
<div class="line"><a name="l01108"></a><span class="lineno"> 1108</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
|
|
|
<div class="line"><a name="l01109"></a><span class="lineno"> 1109</span>  <span class="keyword">static</span> T ntoh(<span class="keyword">const</span> uint8_t* buff, <span class="keywordtype">size_t</span> size = 0);</div>
|
|
|
|
|
<div class="line"><a name="l01110"></a><span class="lineno"> 1110</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01111"></a><span class="lineno"> 1111</span>  <span class="comment">// host-to-network conversion method - takes data from host variable and and converts it to network packet endians</span></div>
|
|
|
|
|
<div class="line"><a name="l01112"></a><span class="lineno"> 1112</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
|
|
|
<div class="line"><a name="l01113"></a><span class="lineno"> 1113</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> hton(uint8_t* buff, T val, <span class="keywordtype">size_t</span> size = 0);</div>
|
|
|
|
|
<div class="line"><a name="l01114"></a><span class="lineno"> 1114</span> };</div>
|
|
|
|
|
<div class="line"><a name="l01115"></a><span class="lineno"> 1115</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01116"></a><span class="lineno"> 1116</span> <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
|
|
|
<div class="line"><a name="l01117"></a><span class="lineno"> 1117</span> T LoRaWANNode::ntoh(<span class="keyword">const</span> uint8_t* buff, <span class="keywordtype">size_t</span> size) {</div>
|
|
|
|
|
<div class="line"><a name="l01118"></a><span class="lineno"> 1118</span>  <span class="keyword">const</span> uint8_t* buffPtr = buff;</div>
|
|
|
|
|
<div class="line"><a name="l01119"></a><span class="lineno"> 1119</span>  <span class="keywordtype">size_t</span> targetSize = <span class="keyword">sizeof</span>(T);</div>
|
|
|
|
|
<div class="line"><a name="l01120"></a><span class="lineno"> 1120</span>  <span class="keywordflow">if</span>(size != 0) {</div>
|
|
|
|
|
<div class="line"><a name="l01121"></a><span class="lineno"> 1121</span>  targetSize = size;</div>
|
|
|
|
|
<div class="line"><a name="l01122"></a><span class="lineno"> 1122</span>  }</div>
|
|
|
|
|
<div class="line"><a name="l01123"></a><span class="lineno"> 1123</span>  T res = 0;</div>
|
|
|
|
|
<div class="line"><a name="l01124"></a><span class="lineno"> 1124</span>  <span class="keywordflow">for</span>(<span class="keywordtype">size_t</span> i = 0; i < targetSize; i++) {</div>
|
|
|
|
|
<div class="line"><a name="l01125"></a><span class="lineno"> 1125</span>  res |= (uint32_t)(*(buffPtr++)) << 8*i;</div>
|
|
|
|
|
<div class="line"><a name="l01126"></a><span class="lineno"> 1126</span>  }</div>
|
|
|
|
|
<div class="line"><a name="l01127"></a><span class="lineno"> 1127</span>  <span class="keywordflow">return</span>(res);</div>
|
|
|
|
|
<div class="line"><a name="l01128"></a><span class="lineno"> 1128</span> }</div>
|
|
|
|
|
<div class="line"><a name="l01129"></a><span class="lineno"> 1129</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01130"></a><span class="lineno"> 1130</span> <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
|
|
|
<div class="line"><a name="l01131"></a><span class="lineno"> 1131</span> <span class="keywordtype">void</span> LoRaWANNode::hton(uint8_t* buff, T val, <span class="keywordtype">size_t</span> size) {</div>
|
|
|
|
|
<div class="line"><a name="l01132"></a><span class="lineno"> 1132</span>  uint8_t* buffPtr = buff;</div>
|
|
|
|
|
<div class="line"><a name="l01133"></a><span class="lineno"> 1133</span>  <span class="keywordtype">size_t</span> targetSize = <span class="keyword">sizeof</span>(T);</div>
|
|
|
|
|
<div class="line"><a name="l01134"></a><span class="lineno"> 1134</span>  <span class="keywordflow">if</span>(size != 0) {</div>
|
|
|
|
|
<div class="line"><a name="l01135"></a><span class="lineno"> 1135</span>  targetSize = size;</div>
|
|
|
|
|
<div class="line"><a name="l01136"></a><span class="lineno"> 1136</span>  }</div>
|
|
|
|
|
<div class="line"><a name="l01137"></a><span class="lineno"> 1137</span>  <span class="keywordflow">for</span>(<span class="keywordtype">size_t</span> i = 0; i < targetSize; i++) {</div>
|
|
|
|
|
<div class="line"><a name="l01138"></a><span class="lineno"> 1138</span>  *(buffPtr++) = val >> 8*i;</div>
|
|
|
|
|
<div class="line"><a name="l01139"></a><span class="lineno"> 1139</span>  }</div>
|
|
|
|
|
<div class="line"><a name="l01140"></a><span class="lineno"> 1140</span> }</div>
|
|
|
|
|
<div class="line"><a name="l01141"></a><span class="lineno"> 1141</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01142"></a><span class="lineno"> 1142</span> <span class="preprocessor">#endif</span></div>
|
|
|
|
|
<div class="line"><a name="l00751"></a><span class="lineno"> 751</span>  <span class="keywordtype">void</span> <a class="code" href="class_lo_ra_w_a_n_node.html#a62bfe68f6fe63c2e408dccbff6a34a4f">setDwellTime</a>(<span class="keywordtype">bool</span> enable, <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> msPerUplink = 0);</div>
|
|
|
|
|
<div class="line"><a name="l00752"></a><span class="lineno"> 752</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00760"></a><span class="lineno"> 760</span>  <span class="keywordtype">void</span> <a class="code" href="class_lo_ra_w_a_n_node.html#a2d9a53560ebfbaf006eefd9761424d80">setCSMA</a>(<span class="keywordtype">bool</span> csmaEnabled, uint8_t maxChanges = 4, uint8_t backoffMax = 0, uint8_t difsSlots = 2);</div>
|
|
|
|
|
<div class="line"><a name="l00761"></a><span class="lineno"> 761</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00767"></a><span class="lineno"> 767</span>  <span class="keywordtype">void</span> <a class="code" href="class_lo_ra_w_a_n_node.html#a5449e301634dff1838a1b024b4067034">setDeviceStatus</a>(uint8_t battLevel);</div>
|
|
|
|
|
<div class="line"><a name="l00768"></a><span class="lineno"> 768</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00776"></a><span class="lineno"> 776</span>  <span class="keywordtype">void</span> <a class="code" href="class_lo_ra_w_a_n_node.html#a16c7ae2edfe324e11498b13aa042665f">scheduleTransmission</a>(<a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> tUplink);</div>
|
|
|
|
|
<div class="line"><a name="l00777"></a><span class="lineno"> 777</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00782"></a><span class="lineno"> 782</span>  uint32_t <a class="code" href="class_lo_ra_w_a_n_node.html#ad3217975ef9959ff83ce79dd80b0d777">getFCntUp</a>();</div>
|
|
|
|
|
<div class="line"><a name="l00783"></a><span class="lineno"> 783</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00788"></a><span class="lineno"> 788</span>  uint32_t <a class="code" href="class_lo_ra_w_a_n_node.html#aa7fabaa6efe9978c3674b1ab187446a1">getNFCntDown</a>();</div>
|
|
|
|
|
<div class="line"><a name="l00789"></a><span class="lineno"> 789</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00794"></a><span class="lineno"> 794</span>  uint32_t <a class="code" href="class_lo_ra_w_a_n_node.html#a6785265f3311ff6bf296f82429c96701">getAFCntDown</a>();</div>
|
|
|
|
|
<div class="line"><a name="l00795"></a><span class="lineno"> 795</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00801"></a><span class="lineno"> 801</span>  <span class="keywordtype">void</span> <a class="code" href="class_lo_ra_w_a_n_node.html#af4b3d07cd9bf4178d627204bae18b648">resetFCntDown</a>();</div>
|
|
|
|
|
<div class="line"><a name="l00802"></a><span class="lineno"> 802</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00807"></a><span class="lineno"> 807</span>  uint32_t <a class="code" href="class_lo_ra_w_a_n_node.html#aee0590cc9123ceac4c822eabed3150c6">getDevAddr</a>();</div>
|
|
|
|
|
<div class="line"><a name="l00808"></a><span class="lineno"> 808</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00813"></a><span class="lineno"> 813</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> <a class="code" href="class_lo_ra_w_a_n_node.html#a683b02b63867bb7de5df45c94d190305">getLastToA</a>();</div>
|
|
|
|
|
<div class="line"><a name="l00814"></a><span class="lineno"> 814</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00822"></a><span class="lineno"> 822</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> <a class="code" href="class_lo_ra_w_a_n_node.html#a5bb50904544f331806fd744ab5b99efa">dutyCycleInterval</a>(<a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> msPerHour, <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> airtime);</div>
|
|
|
|
|
<div class="line"><a name="l00823"></a><span class="lineno"> 823</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00825"></a><span class="lineno"> 825</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> <a class="code" href="class_lo_ra_w_a_n_node.html#a49e690c14858b46692e4ce9aa5a2566a">timeUntilUplink</a>();</div>
|
|
|
|
|
<div class="line"><a name="l00826"></a><span class="lineno"> 826</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00831"></a><span class="lineno"> 831</span>  uint8_t <a class="code" href="class_lo_ra_w_a_n_node.html#ab723160aa317cd84550d0da3a0f52811">getMaxPayloadLen</a>();</div>
|
|
|
|
|
<div class="line"><a name="l00832"></a><span class="lineno"> 832</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00837"></a><span class="lineno"><a class="line" href="class_lo_ra_w_a_n_node.html#a8226f4d0329d15da9ffc706e5781403a"> 837</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_lo_ra_w_a_n_node.html#a8226f4d0329d15da9ffc706e5781403a">TS009</a> = <span class="keyword">false</span>;</div>
|
|
|
|
|
<div class="line"><a name="l00838"></a><span class="lineno"> 838</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00851"></a><span class="lineno"><a class="line" href="class_lo_ra_w_a_n_node.html#a2176aa3d546e6b00e870a7e1e310c403"> 851</a></span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> <a class="code" href="class_lo_ra_w_a_n_node.html#a2176aa3d546e6b00e870a7e1e310c403">scanGuard</a> = 10;</div>
|
|
|
|
|
<div class="line"><a name="l00852"></a><span class="lineno"> 852</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00853"></a><span class="lineno"> 853</span> <span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
|
|
|
|
|
<div class="line"><a name="l00854"></a><span class="lineno"> 854</span>  <span class="keyword">protected</span>:</div>
|
|
|
|
|
<div class="line"><a name="l00855"></a><span class="lineno"> 855</span> <span class="preprocessor">#endif</span></div>
|
|
|
|
|
<div class="line"><a name="l00856"></a><span class="lineno"> 856</span>  <a class="code" href="class_physical_layer.html">PhysicalLayer</a>* phyLayer = NULL;</div>
|
|
|
|
|
<div class="line"><a name="l00857"></a><span class="lineno"> 857</span>  <span class="keyword">const</span> <a class="code" href="struct_lo_ra_w_a_n_band__t.html">LoRaWANBand_t</a>* band = NULL;</div>
|
|
|
|
|
<div class="line"><a name="l00858"></a><span class="lineno"> 858</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00859"></a><span class="lineno"> 859</span>  <span class="comment">// a buffer that holds all LW base parameters that should persist at all times!</span></div>
|
|
|
|
|
<div class="line"><a name="l00860"></a><span class="lineno"> 860</span>  uint8_t bufferNonces[RADIOLIB_LORAWAN_NONCES_BUF_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00861"></a><span class="lineno"> 861</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00862"></a><span class="lineno"> 862</span>  <span class="comment">// a buffer that holds all LW session parameters that preferably persist, but can be afforded to get lost</span></div>
|
|
|
|
|
<div class="line"><a name="l00863"></a><span class="lineno"> 863</span>  uint8_t bufferSession[RADIOLIB_LORAWAN_SESSION_BUF_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00864"></a><span class="lineno"> 864</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00865"></a><span class="lineno"> 865</span>  uint8_t fOptsUp[RADIOLIB_LORAWAN_FHDR_FOPTS_MAX_LEN] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00866"></a><span class="lineno"> 866</span>  uint8_t fOptsDown[RADIOLIB_LORAWAN_FHDR_FOPTS_MAX_LEN] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00867"></a><span class="lineno"> 867</span>  uint8_t fOptsUpLen = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00868"></a><span class="lineno"> 868</span>  uint8_t fOptsDownLen = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00869"></a><span class="lineno"> 869</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00870"></a><span class="lineno"> 870</span>  uint16_t lwMode = RADIOLIB_LORAWAN_MODE_NONE;</div>
|
|
|
|
|
<div class="line"><a name="l00871"></a><span class="lineno"> 871</span>  uint8_t lwClass = RADIOLIB_LORAWAN_CLASS_A;</div>
|
|
|
|
|
<div class="line"><a name="l00872"></a><span class="lineno"> 872</span>  <span class="keywordtype">bool</span> isActive = <span class="keyword">false</span>;</div>
|
|
|
|
|
<div class="line"><a name="l00873"></a><span class="lineno"> 873</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00874"></a><span class="lineno"> 874</span>  uint64_t joinEUI = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00875"></a><span class="lineno"> 875</span>  uint64_t devEUI = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00876"></a><span class="lineno"> 876</span>  uint8_t nwkKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00877"></a><span class="lineno"> 877</span>  uint8_t appKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00878"></a><span class="lineno"> 878</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00879"></a><span class="lineno"> 879</span>  <span class="comment">// the following is either provided by the network server (OTAA)</span></div>
|
|
|
|
|
<div class="line"><a name="l00880"></a><span class="lineno"> 880</span>  <span class="comment">// or directly entered by the user (ABP)</span></div>
|
|
|
|
|
<div class="line"><a name="l00881"></a><span class="lineno"> 881</span>  uint32_t devAddr = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00882"></a><span class="lineno"> 882</span>  uint8_t appSKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00883"></a><span class="lineno"> 883</span>  uint8_t fNwkSIntKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00884"></a><span class="lineno"> 884</span>  uint8_t sNwkSIntKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00885"></a><span class="lineno"> 885</span>  uint8_t nwkSEncKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00886"></a><span class="lineno"> 886</span>  uint8_t jSIntKey[RADIOLIB_AES128_KEY_SIZE] = { 0 };</div>
|
|
|
|
|
<div class="line"><a name="l00887"></a><span class="lineno"> 887</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00888"></a><span class="lineno"> 888</span>  uint16_t keyCheckSum = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00889"></a><span class="lineno"> 889</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00890"></a><span class="lineno"> 890</span>  <span class="comment">// device-specific parameters, persistent through sessions</span></div>
|
|
|
|
|
<div class="line"><a name="l00891"></a><span class="lineno"> 891</span>  uint16_t devNonce = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00892"></a><span class="lineno"> 892</span>  uint32_t joinNonce = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00893"></a><span class="lineno"> 893</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00894"></a><span class="lineno"> 894</span>  <span class="comment">// session-specific parameters</span></div>
|
|
|
|
|
<div class="line"><a name="l00895"></a><span class="lineno"> 895</span>  uint32_t homeNetId = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00896"></a><span class="lineno"> 896</span>  uint8_t adrLimitExp = RADIOLIB_LORAWAN_ADR_ACK_LIMIT_EXP;</div>
|
|
|
|
|
<div class="line"><a name="l00897"></a><span class="lineno"> 897</span>  uint8_t adrDelayExp = RADIOLIB_LORAWAN_ADR_ACK_DELAY_EXP;</div>
|
|
|
|
|
<div class="line"><a name="l00898"></a><span class="lineno"> 898</span>  uint8_t nbTrans = 1; <span class="comment">// Number of allowed frame retransmissions</span></div>
|
|
|
|
|
<div class="line"><a name="l00899"></a><span class="lineno"> 899</span>  uint8_t txPowerSteps = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00900"></a><span class="lineno"> 900</span>  uint8_t txPowerMax = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00901"></a><span class="lineno"> 901</span>  uint32_t fCntUp = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00902"></a><span class="lineno"> 902</span>  uint32_t aFCntDown = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00903"></a><span class="lineno"> 903</span>  uint32_t nFCntDown = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00904"></a><span class="lineno"> 904</span>  uint32_t confFCntUp = RADIOLIB_LORAWAN_FCNT_NONE;</div>
|
|
|
|
|
<div class="line"><a name="l00905"></a><span class="lineno"> 905</span>  uint32_t confFCntDown = RADIOLIB_LORAWAN_FCNT_NONE;</div>
|
|
|
|
|
<div class="line"><a name="l00906"></a><span class="lineno"> 906</span>  uint32_t adrFCnt = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00907"></a><span class="lineno"> 907</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00908"></a><span class="lineno"> 908</span>  <span class="comment">// ADR is enabled by default</span></div>
|
|
|
|
|
<div class="line"><a name="l00909"></a><span class="lineno"> 909</span>  <span class="keywordtype">bool</span> adrEnabled = <span class="keyword">true</span>;</div>
|
|
|
|
|
<div class="line"><a name="l00910"></a><span class="lineno"> 910</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00911"></a><span class="lineno"> 911</span>  <span class="comment">// duty cycle is set upon initialization and activated in regions that impose this</span></div>
|
|
|
|
|
<div class="line"><a name="l00912"></a><span class="lineno"> 912</span>  <span class="keywordtype">bool</span> dutyCycleEnabled = <span class="keyword">false</span>;</div>
|
|
|
|
|
<div class="line"><a name="l00913"></a><span class="lineno"> 913</span>  uint32_t dutyCycle = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00914"></a><span class="lineno"> 914</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00915"></a><span class="lineno"> 915</span>  <span class="comment">// dwell time is set upon initialization and activated in regions that impose this</span></div>
|
|
|
|
|
<div class="line"><a name="l00916"></a><span class="lineno"> 916</span>  uint16_t dwellTimeUp = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00917"></a><span class="lineno"> 917</span>  uint16_t dwellTimeDn = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00918"></a><span class="lineno"> 918</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00919"></a><span class="lineno"> 919</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> tUplink = 0; <span class="comment">// scheduled uplink transmission time (internal clock)</span></div>
|
|
|
|
|
<div class="line"><a name="l00920"></a><span class="lineno"> 920</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> tDownlink = 0; <span class="comment">// time at end of downlink reception</span></div>
|
|
|
|
|
<div class="line"><a name="l00921"></a><span class="lineno"> 921</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00922"></a><span class="lineno"> 922</span>  <span class="comment">// enable/disable CSMA for LoRaWAN</span></div>
|
|
|
|
|
<div class="line"><a name="l00923"></a><span class="lineno"> 923</span>  <span class="keywordtype">bool</span> csmaEnabled = <span class="keyword">false</span>;</div>
|
|
|
|
|
<div class="line"><a name="l00924"></a><span class="lineno"> 924</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00925"></a><span class="lineno"> 925</span>  <span class="comment">// maximum number of channel hops during CSMA</span></div>
|
|
|
|
|
<div class="line"><a name="l00926"></a><span class="lineno"> 926</span>  uint8_t maxChanges = RADIOLIB_LORAWAN_MAX_CHANGES_DEFAULT;</div>
|
|
|
|
|
<div class="line"><a name="l00927"></a><span class="lineno"> 927</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00928"></a><span class="lineno"> 928</span>  <span class="comment">// number of backoff slots to be checked after DIFS phase.</span></div>
|
|
|
|
|
<div class="line"><a name="l00929"></a><span class="lineno"> 929</span>  <span class="comment">// A random BO avoids collisions in the case where two or more nodes start the CSMA</span></div>
|
|
|
|
|
<div class="line"><a name="l00930"></a><span class="lineno"> 930</span>  <span class="comment">// process at the same time. </span></div>
|
|
|
|
|
<div class="line"><a name="l00931"></a><span class="lineno"> 931</span>  uint8_t backoffMax = RADIOLIB_LORAWAN_BACKOFF_MAX_DEFAULT;</div>
|
|
|
|
|
<div class="line"><a name="l00932"></a><span class="lineno"> 932</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00933"></a><span class="lineno"> 933</span>  <span class="comment">// number of CADs to estimate a clear CH</span></div>
|
|
|
|
|
<div class="line"><a name="l00934"></a><span class="lineno"> 934</span>  uint8_t difsSlots = RADIOLIB_LORAWAN_DIFS_DEFAULT;</div>
|
|
|
|
|
<div class="line"><a name="l00935"></a><span class="lineno"> 935</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00936"></a><span class="lineno"> 936</span>  <span class="comment">// available channel frequencies from list passed during OTA activation</span></div>
|
|
|
|
|
<div class="line"><a name="l00937"></a><span class="lineno"> 937</span>  <a class="code" href="struct_lo_ra_w_a_n_channel__t.html">LoRaWANChannel_t</a> channelPlan[2][RADIOLIB_LORAWAN_NUM_AVAILABLE_CHANNELS];</div>
|
|
|
|
|
<div class="line"><a name="l00938"></a><span class="lineno"> 938</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00939"></a><span class="lineno"> 939</span>  <span class="comment">// currently configured channels for TX, RX1, RX2</span></div>
|
|
|
|
|
<div class="line"><a name="l00940"></a><span class="lineno"> 940</span>  <a class="code" href="struct_lo_ra_w_a_n_channel__t.html">LoRaWANChannel_t</a> channels[3] = { RADIOLIB_LORAWAN_CHANNEL_NONE, RADIOLIB_LORAWAN_CHANNEL_NONE,</div>
|
|
|
|
|
<div class="line"><a name="l00941"></a><span class="lineno"> 941</span>  RADIOLIB_LORAWAN_CHANNEL_NONE };</div>
|
|
|
|
|
<div class="line"><a name="l00942"></a><span class="lineno"> 942</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00943"></a><span class="lineno"> 943</span>  <span class="comment">// delays between the uplink and RX1/2 windows</span></div>
|
|
|
|
|
<div class="line"><a name="l00944"></a><span class="lineno"> 944</span>  <span class="comment">// the first field is meaningless, but is used for offsetting for Rx windows 1 and 2</span></div>
|
|
|
|
|
<div class="line"><a name="l00945"></a><span class="lineno"> 945</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> rxDelays[3] = { 0, RADIOLIB_LORAWAN_RECEIVE_DELAY_1_MS, RADIOLIB_LORAWAN_RECEIVE_DELAY_2_MS };</div>
|
|
|
|
|
<div class="line"><a name="l00946"></a><span class="lineno"> 946</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00947"></a><span class="lineno"> 947</span>  <span class="comment">// offset between TX and RX1 (such that RX1 has equal or lower DR)</span></div>
|
|
|
|
|
<div class="line"><a name="l00948"></a><span class="lineno"> 948</span>  uint8_t rx1DrOffset = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00949"></a><span class="lineno"> 949</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00950"></a><span class="lineno"> 950</span>  <span class="comment">// LoRaWAN revision (1.0 vs 1.1)</span></div>
|
|
|
|
|
<div class="line"><a name="l00951"></a><span class="lineno"> 951</span>  uint8_t rev = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00952"></a><span class="lineno"> 952</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00953"></a><span class="lineno"> 953</span>  <span class="comment">// Time on Air of last uplink</span></div>
|
|
|
|
|
<div class="line"><a name="l00954"></a><span class="lineno"> 954</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> lastToA = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00955"></a><span class="lineno"> 955</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00956"></a><span class="lineno"> 956</span>  <span class="comment">// timestamp to measure the RX1/2 delay (from uplink end)</span></div>
|
|
|
|
|
<div class="line"><a name="l00957"></a><span class="lineno"> 957</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> rxDelayStart = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00958"></a><span class="lineno"> 958</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00959"></a><span class="lineno"> 959</span>  <span class="comment">// timestamp when the Rx1/2 windows were closed (timeout or uplink received)</span></div>
|
|
|
|
|
<div class="line"><a name="l00960"></a><span class="lineno"> 960</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> rxDelayEnd = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00961"></a><span class="lineno"> 961</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00962"></a><span class="lineno"> 962</span>  <span class="comment">// device status - battery level</span></div>
|
|
|
|
|
<div class="line"><a name="l00963"></a><span class="lineno"> 963</span>  uint8_t battLevel = 0xFF;</div>
|
|
|
|
|
<div class="line"><a name="l00964"></a><span class="lineno"> 964</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00965"></a><span class="lineno"> 965</span>  <span class="comment">// indicates whether an uplink has MAC commands as payload</span></div>
|
|
|
|
|
<div class="line"><a name="l00966"></a><span class="lineno"> 966</span>  <span class="keywordtype">bool</span> isMACPayload = <span class="keyword">false</span>;</div>
|
|
|
|
|
<div class="line"><a name="l00967"></a><span class="lineno"> 967</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00968"></a><span class="lineno"> 968</span>  <span class="comment">// save the selected sub-band in case this must be restored in ADR control</span></div>
|
|
|
|
|
<div class="line"><a name="l00969"></a><span class="lineno"> 969</span>  uint8_t subBand = 0;</div>
|
|
|
|
|
<div class="line"><a name="l00970"></a><span class="lineno"> 970</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00971"></a><span class="lineno"> 971</span>  <span class="comment">// allow port 226 for devices implementing TS011</span></div>
|
|
|
|
|
<div class="line"><a name="l00972"></a><span class="lineno"> 972</span>  <span class="keywordtype">bool</span> TS011 = <span class="keyword">false</span>;</div>
|
|
|
|
|
<div class="line"><a name="l00973"></a><span class="lineno"> 973</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00974"></a><span class="lineno"> 974</span>  <span class="comment">// this will reset the device credentials, so the device starts completely new</span></div>
|
|
|
|
|
<div class="line"><a name="l00975"></a><span class="lineno"> 975</span>  <span class="keywordtype">void</span> clearNonces();</div>
|
|
|
|
|
<div class="line"><a name="l00976"></a><span class="lineno"> 976</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00977"></a><span class="lineno"> 977</span>  <span class="comment">// start a fresh session using default parameters</span></div>
|
|
|
|
|
<div class="line"><a name="l00978"></a><span class="lineno"> 978</span>  <span class="keywordtype">void</span> createSession(uint16_t lwMode, uint8_t initialDr);</div>
|
|
|
|
|
<div class="line"><a name="l00979"></a><span class="lineno"> 979</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00980"></a><span class="lineno"> 980</span>  <span class="comment">// setup Join-Request payload</span></div>
|
|
|
|
|
<div class="line"><a name="l00981"></a><span class="lineno"> 981</span>  <span class="keywordtype">void</span> composeJoinRequest(uint8_t* joinRequestMsg);</div>
|
|
|
|
|
<div class="line"><a name="l00982"></a><span class="lineno"> 982</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00983"></a><span class="lineno"> 983</span>  <span class="comment">// extract Join-Accept payload and start a new session</span></div>
|
|
|
|
|
<div class="line"><a name="l00984"></a><span class="lineno"> 984</span>  int16_t processJoinAccept(<a class="code" href="struct_lo_ra_w_a_n_join_event__t.html">LoRaWANJoinEvent_t</a> *joinEvent);</div>
|
|
|
|
|
<div class="line"><a name="l00985"></a><span class="lineno"> 985</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00986"></a><span class="lineno"> 986</span>  <span class="comment">// a join-accept can piggy-back a set of channels or channel masks</span></div>
|
|
|
|
|
<div class="line"><a name="l00987"></a><span class="lineno"> 987</span>  <span class="keywordtype">void</span> processCFList(uint8_t* cfList);</div>
|
|
|
|
|
<div class="line"><a name="l00988"></a><span class="lineno"> 988</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00989"></a><span class="lineno"> 989</span>  <span class="comment">// check whether payload length and fport are allowed</span></div>
|
|
|
|
|
<div class="line"><a name="l00990"></a><span class="lineno"> 990</span>  int16_t isValidUplink(uint8_t* len, uint8_t fPort);</div>
|
|
|
|
|
<div class="line"><a name="l00991"></a><span class="lineno"> 991</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00992"></a><span class="lineno"> 992</span>  <span class="comment">// perform ADR backoff</span></div>
|
|
|
|
|
<div class="line"><a name="l00993"></a><span class="lineno"> 993</span>  <span class="keywordtype">void</span> adrBackoff();</div>
|
|
|
|
|
<div class="line"><a name="l00994"></a><span class="lineno"> 994</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00995"></a><span class="lineno"> 995</span>  <span class="comment">// create an encrypted uplink buffer, composing metadata, user data and MAC data</span></div>
|
|
|
|
|
<div class="line"><a name="l00996"></a><span class="lineno"> 996</span>  <span class="keywordtype">void</span> composeUplink(<span class="keyword">const</span> uint8_t* in, uint8_t lenIn, uint8_t* out, uint8_t fPort, <span class="keywordtype">bool</span> isConfirmed);</div>
|
|
|
|
|
<div class="line"><a name="l00997"></a><span class="lineno"> 997</span>  </div>
|
|
|
|
|
<div class="line"><a name="l00998"></a><span class="lineno"> 998</span>  <span class="comment">// generate and set the MIC of an uplink buffer (depends on selected channels)</span></div>
|
|
|
|
|
<div class="line"><a name="l00999"></a><span class="lineno"> 999</span>  <span class="keywordtype">void</span> micUplink(uint8_t* inOut, uint8_t lenInOut);</div>
|
|
|
|
|
<div class="line"><a name="l01000"></a><span class="lineno"> 1000</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01001"></a><span class="lineno"> 1001</span>  <span class="comment">// transmit uplink buffer on a specified channel</span></div>
|
|
|
|
|
<div class="line"><a name="l01002"></a><span class="lineno"> 1002</span>  int16_t transmitUplink(<a class="code" href="struct_lo_ra_w_a_n_channel__t.html">LoRaWANChannel_t</a>* chnl, uint8_t* in, uint8_t len, <span class="keywordtype">bool</span> retrans);</div>
|
|
|
|
|
<div class="line"><a name="l01003"></a><span class="lineno"> 1003</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01004"></a><span class="lineno"> 1004</span>  <span class="comment">// wait for, open and listen during receive windows; only performs listening</span></div>
|
|
|
|
|
<div class="line"><a name="l01005"></a><span class="lineno"> 1005</span>  int16_t receiveCommon(uint8_t dir, <span class="keyword">const</span> <a class="code" href="struct_lo_ra_w_a_n_channel__t.html">LoRaWANChannel_t</a>* dlChannels, <span class="keyword">const</span> <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a>* dlDelays, uint8_t numWindows, <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> tReference);</div>
|
|
|
|
|
<div class="line"><a name="l01006"></a><span class="lineno"> 1006</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01007"></a><span class="lineno"> 1007</span>  <span class="comment">// extract downlink payload and process MAC commands</span></div>
|
|
|
|
|
<div class="line"><a name="l01008"></a><span class="lineno"> 1008</span>  int16_t parseDownlink(uint8_t* data, <span class="keywordtype">size_t</span>* len, <a class="code" href="struct_lo_ra_w_a_n_event__t.html">LoRaWANEvent_t</a>* event = NULL);</div>
|
|
|
|
|
<div class="line"><a name="l01009"></a><span class="lineno"> 1009</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01010"></a><span class="lineno"> 1010</span>  <span class="comment">// execute mac command, return the number of processed bytes for sequential processing</span></div>
|
|
|
|
|
<div class="line"><a name="l01011"></a><span class="lineno"> 1011</span>  <span class="keywordtype">bool</span> execMacCommand(uint8_t cid, uint8_t* optIn, uint8_t lenIn);</div>
|
|
|
|
|
<div class="line"><a name="l01012"></a><span class="lineno"> 1012</span>  <span class="keywordtype">bool</span> execMacCommand(uint8_t cid, uint8_t* optIn, uint8_t lenIn, uint8_t* optOut);</div>
|
|
|
|
|
<div class="line"><a name="l01013"></a><span class="lineno"> 1013</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01014"></a><span class="lineno"> 1014</span>  <span class="comment">// possible override for additional MAC commands that are not in the base specification</span></div>
|
|
|
|
|
<div class="line"><a name="l01015"></a><span class="lineno"> 1015</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> derivedMacHandler(uint8_t cid, uint8_t* optIn, uint8_t lenIn, uint8_t* optOut);</div>
|
|
|
|
|
<div class="line"><a name="l01016"></a><span class="lineno"> 1016</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01017"></a><span class="lineno"> 1017</span>  <span class="comment">// pre-process a (set of) LinkAdrReq commands into one super-channel-mask + Tx/Dr/NbTrans fields</span></div>
|
|
|
|
|
<div class="line"><a name="l01018"></a><span class="lineno"> 1018</span>  <span class="keywordtype">void</span> preprocessMacLinkAdr(uint8_t* mPtr, uint8_t cLen, uint8_t* mAdrOpt);</div>
|
|
|
|
|
<div class="line"><a name="l01019"></a><span class="lineno"> 1019</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01020"></a><span class="lineno"> 1020</span>  <span class="comment">// post-process a (set of) LinkAdrAns commands depending on LoRaWAN version</span></div>
|
|
|
|
|
<div class="line"><a name="l01021"></a><span class="lineno"> 1021</span>  <span class="keywordtype">void</span> postprocessMacLinkAdr(uint8_t* ack, uint8_t cLen);</div>
|
|
|
|
|
<div class="line"><a name="l01022"></a><span class="lineno"> 1022</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01023"></a><span class="lineno"> 1023</span>  <span class="comment">// get the properties of a MAC command given a certain command ID</span></div>
|
|
|
|
|
<div class="line"><a name="l01024"></a><span class="lineno"> 1024</span>  int16_t getMacCommand(uint8_t cid, <a class="code" href="struct_lo_ra_w_a_n_mac_command__t.html">LoRaWANMacCommand_t</a>* cmd);</div>
|
|
|
|
|
<div class="line"><a name="l01025"></a><span class="lineno"> 1025</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01026"></a><span class="lineno"> 1026</span>  <span class="comment">// possible override for additional MAC commands that are not in the base specification</span></div>
|
|
|
|
|
<div class="line"><a name="l01027"></a><span class="lineno"> 1027</span>  <span class="keyword">virtual</span> int16_t derivedMacFinder(uint8_t cid, <a class="code" href="struct_lo_ra_w_a_n_mac_command__t.html">LoRaWANMacCommand_t</a>* cmd);</div>
|
|
|
|
|
<div class="line"><a name="l01028"></a><span class="lineno"> 1028</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01029"></a><span class="lineno"> 1029</span>  <span class="comment">// get the length of a certain MAC command in a specific direction (up/down)</span></div>
|
|
|
|
|
<div class="line"><a name="l01030"></a><span class="lineno"> 1030</span>  <span class="comment">// if inclusive is true, add one for the CID byte</span></div>
|
|
|
|
|
<div class="line"><a name="l01031"></a><span class="lineno"> 1031</span>  int16_t getMacLen(uint8_t cid, uint8_t* len, uint8_t dir, <span class="keywordtype">bool</span> inclusive = <span class="keyword">false</span>);</div>
|
|
|
|
|
<div class="line"><a name="l01032"></a><span class="lineno"> 1032</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01033"></a><span class="lineno"> 1033</span>  <span class="comment">// find out of a MAC command should persist destruction</span></div>
|
|
|
|
|
<div class="line"><a name="l01034"></a><span class="lineno"> 1034</span>  <span class="comment">// in uplink direction, some commands must persist if no downlink is received</span></div>
|
|
|
|
|
<div class="line"><a name="l01035"></a><span class="lineno"> 1035</span>  <span class="comment">// in downlink direction, the user-accessible MAC commands remain available for retrieval</span></div>
|
|
|
|
|
<div class="line"><a name="l01036"></a><span class="lineno"> 1036</span>  <span class="keywordtype">bool</span> isPersistentMacCommand(uint8_t cid, uint8_t dir);</div>
|
|
|
|
|
<div class="line"><a name="l01037"></a><span class="lineno"> 1037</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01038"></a><span class="lineno"> 1038</span>  <span class="comment">// push MAC command to queue, done by copy</span></div>
|
|
|
|
|
<div class="line"><a name="l01039"></a><span class="lineno"> 1039</span>  int16_t pushMacCommand(uint8_t cid, uint8_t* cOcts, uint8_t* out, uint8_t* lenOut, uint8_t dir);</div>
|
|
|
|
|
<div class="line"><a name="l01040"></a><span class="lineno"> 1040</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01041"></a><span class="lineno"> 1041</span>  <span class="comment">// retrieve the payload of a certain MAC command, if present in the buffer</span></div>
|
|
|
|
|
<div class="line"><a name="l01042"></a><span class="lineno"> 1042</span>  int16_t getMacPayload(uint8_t cid, uint8_t* in, uint8_t lenIn, uint8_t* out, uint8_t dir);</div>
|
|
|
|
|
<div class="line"><a name="l01043"></a><span class="lineno"> 1043</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01044"></a><span class="lineno"> 1044</span>  <span class="comment">// delete a specific MAC command from queue, indicated by the command ID</span></div>
|
|
|
|
|
<div class="line"><a name="l01045"></a><span class="lineno"> 1045</span>  int16_t deleteMacCommand(uint8_t cid, uint8_t* inOut, uint8_t* lenInOut, uint8_t dir);</div>
|
|
|
|
|
<div class="line"><a name="l01046"></a><span class="lineno"> 1046</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01047"></a><span class="lineno"> 1047</span>  <span class="comment">// clear a MAC buffer, possible retaining persistent MAC commands</span></div>
|
|
|
|
|
<div class="line"><a name="l01048"></a><span class="lineno"> 1048</span>  <span class="keywordtype">void</span> clearMacCommands(uint8_t* inOut, uint8_t* lenInOut, uint8_t dir);</div>
|
|
|
|
|
<div class="line"><a name="l01049"></a><span class="lineno"> 1049</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01050"></a><span class="lineno"> 1050</span>  <span class="comment">// configure the common physical layer properties (frequency, sync word etc.)</span></div>
|
|
|
|
|
<div class="line"><a name="l01051"></a><span class="lineno"> 1051</span>  int16_t setPhyProperties(<span class="keyword">const</span> <a class="code" href="struct_lo_ra_w_a_n_channel__t.html">LoRaWANChannel_t</a>* chnl, uint8_t dir, int8_t pwr, <span class="keywordtype">size_t</span> pre = 0);</div>
|
|
|
|
|
<div class="line"><a name="l01052"></a><span class="lineno"> 1052</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01053"></a><span class="lineno"> 1053</span>  <span class="comment">// Performs CSMA as per LoRa Alliance Technical Recommendation 13 (TR-013).</span></div>
|
|
|
|
|
<div class="line"><a name="l01054"></a><span class="lineno"> 1054</span>  <span class="keywordtype">bool</span> csmaChannelClear(uint8_t difs, uint8_t numBackoff);</div>
|
|
|
|
|
<div class="line"><a name="l01055"></a><span class="lineno"> 1055</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01056"></a><span class="lineno"> 1056</span>  <span class="comment">// perform a single CAD operation for the under SF/CH combination. Returns either busy or otherwise.</span></div>
|
|
|
|
|
<div class="line"><a name="l01057"></a><span class="lineno"> 1057</span>  <span class="keywordtype">bool</span> cadChannelClear();</div>
|
|
|
|
|
<div class="line"><a name="l01058"></a><span class="lineno"> 1058</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01059"></a><span class="lineno"> 1059</span>  <span class="comment">// (dynamic bands:) get or (fixed bands:) create a complete 80-bit channel mask for current configuration</span></div>
|
|
|
|
|
<div class="line"><a name="l01060"></a><span class="lineno"> 1060</span>  <span class="keywordtype">void</span> getChannelPlanMask(uint64_t* chMaskGrp0123, uint32_t* chMaskGrp45);</div>
|
|
|
|
|
<div class="line"><a name="l01061"></a><span class="lineno"> 1061</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01062"></a><span class="lineno"> 1062</span>  <span class="comment">// setup uplink/downlink channel data rates and frequencies</span></div>
|
|
|
|
|
<div class="line"><a name="l01063"></a><span class="lineno"> 1063</span>  <span class="comment">// for dynamic channels, there is a small set of predefined channels</span></div>
|
|
|
|
|
<div class="line"><a name="l01064"></a><span class="lineno"> 1064</span>  <span class="comment">// in case of JoinRequest, add some optional extra frequencies </span></div>
|
|
|
|
|
<div class="line"><a name="l01065"></a><span class="lineno"> 1065</span>  <span class="keywordtype">void</span> selectChannelPlanDyn();</div>
|
|
|
|
|
<div class="line"><a name="l01066"></a><span class="lineno"> 1066</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01067"></a><span class="lineno"> 1067</span>  <span class="comment">// setup uplink/downlink channel data rates and frequencies</span></div>
|
|
|
|
|
<div class="line"><a name="l01068"></a><span class="lineno"> 1068</span>  <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="l01069"></a><span class="lineno"> 1069</span>  <span class="keywordtype">void</span> selectChannelPlanFix();</div>
|
|
|
|
|
<div class="line"><a name="l01070"></a><span class="lineno"> 1070</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01071"></a><span class="lineno"> 1071</span>  <span class="comment">// get the number of available channels,</span></div>
|
|
|
|
|
<div class="line"><a name="l01072"></a><span class="lineno"> 1072</span>  <span class="comment">// along with a 16-bit mask indicating which channels can be used next for uplink/downlink</span></div>
|
|
|
|
|
<div class="line"><a name="l01073"></a><span class="lineno"> 1073</span>  uint8_t getAvailableChannels(uint16_t* mask);</div>
|
|
|
|
|
<div class="line"><a name="l01074"></a><span class="lineno"> 1074</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01075"></a><span class="lineno"> 1075</span>  <span class="comment">// (re)set/restore which channels can be used next for uplink/downlink</span></div>
|
|
|
|
|
<div class="line"><a name="l01076"></a><span class="lineno"> 1076</span>  <span class="keywordtype">void</span> setAvailableChannels(uint16_t mask);</div>
|
|
|
|
|
<div class="line"><a name="l01077"></a><span class="lineno"> 1077</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01078"></a><span class="lineno"> 1078</span>  <span class="comment">// select a set of random TX/RX channels for up- and downlink</span></div>
|
|
|
|
|
<div class="line"><a name="l01079"></a><span class="lineno"> 1079</span>  int16_t selectChannels();</div>
|
|
|
|
|
<div class="line"><a name="l01080"></a><span class="lineno"> 1080</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01081"></a><span class="lineno"> 1081</span>  <span class="comment">// apply a 96-bit channel mask</span></div>
|
|
|
|
|
<div class="line"><a name="l01082"></a><span class="lineno"> 1082</span>  <span class="keywordtype">bool</span> applyChannelMask(uint64_t chMaskGrp0123, uint32_t chMaskGrp45);</div>
|
|
|
|
|
<div class="line"><a name="l01083"></a><span class="lineno"> 1083</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01084"></a><span class="lineno"> 1084</span> <span class="preprocessor">#if RADIOLIB_DEBUG_PROTOCOL</span></div>
|
|
|
|
|
<div class="line"><a name="l01085"></a><span class="lineno"> 1085</span>  <span class="comment">// print the available channels through debug</span></div>
|
|
|
|
|
<div class="line"><a name="l01086"></a><span class="lineno"> 1086</span>  <span class="keywordtype">void</span> printChannels();</div>
|
|
|
|
|
<div class="line"><a name="l01087"></a><span class="lineno"> 1087</span> <span class="preprocessor">#endif</span></div>
|
|
|
|
|
<div class="line"><a name="l01088"></a><span class="lineno"> 1088</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01089"></a><span class="lineno"> 1089</span>  <span class="comment">// method to generate message integrity code</span></div>
|
|
|
|
|
<div class="line"><a name="l01090"></a><span class="lineno"> 1090</span>  uint32_t generateMIC(uint8_t* msg, <span class="keywordtype">size_t</span> len, uint8_t* key);</div>
|
|
|
|
|
<div class="line"><a name="l01091"></a><span class="lineno"> 1091</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01092"></a><span class="lineno"> 1092</span>  <span class="comment">// method to verify message integrity code</span></div>
|
|
|
|
|
<div class="line"><a name="l01093"></a><span class="lineno"> 1093</span>  <span class="comment">// it assumes that the MIC is the last 4 bytes of the message</span></div>
|
|
|
|
|
<div class="line"><a name="l01094"></a><span class="lineno"> 1094</span>  <span class="keywordtype">bool</span> verifyMIC(uint8_t* msg, <span class="keywordtype">size_t</span> len, uint8_t* key);</div>
|
|
|
|
|
<div class="line"><a name="l01095"></a><span class="lineno"> 1095</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01096"></a><span class="lineno"> 1096</span>  <span class="comment">// find the first usable data rate for the given band</span></div>
|
|
|
|
|
<div class="line"><a name="l01097"></a><span class="lineno"> 1097</span>  int16_t findDataRate(uint8_t dr, <a class="code" href="union_data_rate__t.html">DataRate_t</a>* dataRate);</div>
|
|
|
|
|
<div class="line"><a name="l01098"></a><span class="lineno"> 1098</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01099"></a><span class="lineno"> 1099</span>  <span class="comment">// function to encrypt and decrypt payloads (regular uplink/downlink)</span></div>
|
|
|
|
|
<div class="line"><a name="l01100"></a><span class="lineno"> 1100</span>  <span class="keywordtype">void</span> processAES(<span class="keyword">const</span> uint8_t* in, <span class="keywordtype">size_t</span> len, uint8_t* key, uint8_t* out, uint32_t fCnt, uint8_t dir, uint8_t ctrId, <span class="keywordtype">bool</span> counter);</div>
|
|
|
|
|
<div class="line"><a name="l01101"></a><span class="lineno"> 1101</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01102"></a><span class="lineno"> 1102</span>  <span class="comment">// 16-bit checksum method that takes a uint8_t array of even length and calculates the checksum</span></div>
|
|
|
|
|
<div class="line"><a name="l01103"></a><span class="lineno"> 1103</span>  <span class="keyword">static</span> uint16_t checkSum16(<span class="keyword">const</span> uint8_t *key, uint16_t keyLen);</div>
|
|
|
|
|
<div class="line"><a name="l01104"></a><span class="lineno"> 1104</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01105"></a><span class="lineno"> 1105</span>  <span class="comment">// check the integrity of a buffer using a 16-bit checksum located in the last two bytes of the buffer</span></div>
|
|
|
|
|
<div class="line"><a name="l01106"></a><span class="lineno"> 1106</span>  <span class="keyword">static</span> int16_t checkBufferCommon(<span class="keyword">const</span> uint8_t *buffer, uint16_t size);</div>
|
|
|
|
|
<div class="line"><a name="l01107"></a><span class="lineno"> 1107</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01108"></a><span class="lineno"> 1108</span>  <span class="comment">// network-to-host conversion method - takes data from network packet and converts it to the host endians</span></div>
|
|
|
|
|
<div class="line"><a name="l01109"></a><span class="lineno"> 1109</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
|
|
|
<div class="line"><a name="l01110"></a><span class="lineno"> 1110</span>  <span class="keyword">static</span> T ntoh(<span class="keyword">const</span> uint8_t* buff, <span class="keywordtype">size_t</span> size = 0);</div>
|
|
|
|
|
<div class="line"><a name="l01111"></a><span class="lineno"> 1111</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01112"></a><span class="lineno"> 1112</span>  <span class="comment">// host-to-network conversion method - takes data from host variable and and converts it to network packet endians</span></div>
|
|
|
|
|
<div class="line"><a name="l01113"></a><span class="lineno"> 1113</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
|
|
|
<div class="line"><a name="l01114"></a><span class="lineno"> 1114</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> hton(uint8_t* buff, T val, <span class="keywordtype">size_t</span> size = 0);</div>
|
|
|
|
|
<div class="line"><a name="l01115"></a><span class="lineno"> 1115</span> };</div>
|
|
|
|
|
<div class="line"><a name="l01116"></a><span class="lineno"> 1116</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01117"></a><span class="lineno"> 1117</span> <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
|
|
|
<div class="line"><a name="l01118"></a><span class="lineno"> 1118</span> T LoRaWANNode::ntoh(<span class="keyword">const</span> uint8_t* buff, <span class="keywordtype">size_t</span> size) {</div>
|
|
|
|
|
<div class="line"><a name="l01119"></a><span class="lineno"> 1119</span>  <span class="keyword">const</span> uint8_t* buffPtr = buff;</div>
|
|
|
|
|
<div class="line"><a name="l01120"></a><span class="lineno"> 1120</span>  <span class="keywordtype">size_t</span> targetSize = <span class="keyword">sizeof</span>(T);</div>
|
|
|
|
|
<div class="line"><a name="l01121"></a><span class="lineno"> 1121</span>  <span class="keywordflow">if</span>(size != 0) {</div>
|
|
|
|
|
<div class="line"><a name="l01122"></a><span class="lineno"> 1122</span>  targetSize = size;</div>
|
|
|
|
|
<div class="line"><a name="l01123"></a><span class="lineno"> 1123</span>  }</div>
|
|
|
|
|
<div class="line"><a name="l01124"></a><span class="lineno"> 1124</span>  T res = 0;</div>
|
|
|
|
|
<div class="line"><a name="l01125"></a><span class="lineno"> 1125</span>  <span class="keywordflow">for</span>(<span class="keywordtype">size_t</span> i = 0; i < targetSize; i++) {</div>
|
|
|
|
|
<div class="line"><a name="l01126"></a><span class="lineno"> 1126</span>  res |= (uint32_t)(*(buffPtr++)) << 8*i;</div>
|
|
|
|
|
<div class="line"><a name="l01127"></a><span class="lineno"> 1127</span>  }</div>
|
|
|
|
|
<div class="line"><a name="l01128"></a><span class="lineno"> 1128</span>  <span class="keywordflow">return</span>(res);</div>
|
|
|
|
|
<div class="line"><a name="l01129"></a><span class="lineno"> 1129</span> }</div>
|
|
|
|
|
<div class="line"><a name="l01130"></a><span class="lineno"> 1130</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01131"></a><span class="lineno"> 1131</span> <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
|
|
|
<div class="line"><a name="l01132"></a><span class="lineno"> 1132</span> <span class="keywordtype">void</span> LoRaWANNode::hton(uint8_t* buff, T val, <span class="keywordtype">size_t</span> size) {</div>
|
|
|
|
|
<div class="line"><a name="l01133"></a><span class="lineno"> 1133</span>  uint8_t* buffPtr = buff;</div>
|
|
|
|
|
<div class="line"><a name="l01134"></a><span class="lineno"> 1134</span>  <span class="keywordtype">size_t</span> targetSize = <span class="keyword">sizeof</span>(T);</div>
|
|
|
|
|
<div class="line"><a name="l01135"></a><span class="lineno"> 1135</span>  <span class="keywordflow">if</span>(size != 0) {</div>
|
|
|
|
|
<div class="line"><a name="l01136"></a><span class="lineno"> 1136</span>  targetSize = size;</div>
|
|
|
|
|
<div class="line"><a name="l01137"></a><span class="lineno"> 1137</span>  }</div>
|
|
|
|
|
<div class="line"><a name="l01138"></a><span class="lineno"> 1138</span>  <span class="keywordflow">for</span>(<span class="keywordtype">size_t</span> i = 0; i < targetSize; i++) {</div>
|
|
|
|
|
<div class="line"><a name="l01139"></a><span class="lineno"> 1139</span>  *(buffPtr++) = val >> 8*i;</div>
|
|
|
|
|
<div class="line"><a name="l01140"></a><span class="lineno"> 1140</span>  }</div>
|
|
|
|
|
<div class="line"><a name="l01141"></a><span class="lineno"> 1141</span> }</div>
|
|
|
|
|
<div class="line"><a name="l01142"></a><span class="lineno"> 1142</span>  </div>
|
|
|
|
|
<div class="line"><a name="l01143"></a><span class="lineno"> 1143</span> <span class="preprocessor">#endif</span></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html">LoRaWANNode</a></div><div class="ttdoc">LoRaWAN-compatible node (class A device).</div><div class="ttdef"><b>Definition:</b> LoRaWAN.h:522</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a0feeaed200d8f94ad94c3ed49f404847"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a0feeaed200d8f94ad94c3ed49f404847">LoRaWANNode::clearSession</a></div><div class="ttdeci">void clearSession()</div><div class="ttdoc">Clear an active session, so that the device will have to rejoin the network.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:278</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a11c2fbe631063da69355f8d74f4bf3b8"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a11c2fbe631063da69355f8d74f4bf3b8">LoRaWANNode::sendReceive</a></div><div class="ttdeci">virtual int16_t sendReceive(const char *strUp, uint8_t fPort, 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:43</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a14e8a8a098df28ff5ee294f235500499"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a14e8a8a098df28ff5ee294f235500499">LoRaWANNode::setDatarate</a></div><div class="ttdeci">int16_t setDatarate(uint8_t drUp)</div><div class="ttdoc">Set uplink datarate. This should not be used when ADR is enabled.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2597</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a16c7ae2edfe324e11498b13aa042665f"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a16c7ae2edfe324e11498b13aa042665f">LoRaWANNode::scheduleTransmission</a></div><div class="ttdeci">void scheduleTransmission(RadioLibTime_t tUplink)</div><div class="ttdoc">Set the exact time a transmission should occur. Note: this is the internal clock time....</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2723</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a2176aa3d546e6b00e870a7e1e310c403"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a2176aa3d546e6b00e870a7e1e310c403">LoRaWANNode::scanGuard</a></div><div class="ttdeci">RadioLibTime_t scanGuard</div><div class="ttdoc">Rx window padding in milliseconds according to the spec, the Rx window must be at least enough time t...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.h:850</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a288a86771bd40ac25f8f064c3a5b7f9d"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a288a86771bd40ac25f8f064c3a5b7f9d">LoRaWANNode::setDwellTime</a></div><div class="ttdeci">void setDwellTime(RadioLibTime_t msPerUplink)</div><div class="ttdoc">Set or disable uplink dwell time limitation; enabled by default if mandatory.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2699</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a2d9a53560ebfbaf006eefd9761424d80"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a2d9a53560ebfbaf006eefd9761424d80">LoRaWANNode::setCSMA</a></div><div class="ttdeci">void setCSMA(bool csmaEnabled, uint8_t maxChanges=4, uint8_t backoffMax=0, uint8_t difsSlots=2)</div><div class="ttdoc">Configures CSMA for LoRaWAN as per TR013, LoRa Alliance.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2705</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a16c7ae2edfe324e11498b13aa042665f"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a16c7ae2edfe324e11498b13aa042665f">LoRaWANNode::scheduleTransmission</a></div><div class="ttdeci">void scheduleTransmission(RadioLibTime_t tUplink)</div><div class="ttdoc">Set the exact time a transmission should occur. Note: this is the internal clock time....</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2730</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a2176aa3d546e6b00e870a7e1e310c403"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a2176aa3d546e6b00e870a7e1e310c403">LoRaWANNode::scanGuard</a></div><div class="ttdeci">RadioLibTime_t scanGuard</div><div class="ttdoc">Rx window padding in milliseconds according to the spec, the Rx window must be at least enough time t...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.h:851</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a2d9a53560ebfbaf006eefd9761424d80"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a2d9a53560ebfbaf006eefd9761424d80">LoRaWANNode::setCSMA</a></div><div class="ttdeci">void setCSMA(bool csmaEnabled, uint8_t maxChanges=4, uint8_t backoffMax=0, uint8_t difsSlots=2)</div><div class="ttdoc">Configures CSMA for LoRaWAN as per TR013, LoRa Alliance.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2712</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a3d4bbd6d382496838954ab4ac1168b77"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a3d4bbd6d382496838954ab4ac1168b77">LoRaWANNode::setDutyCycle</a></div><div class="ttdeci">void setDutyCycle(bool enable=true, RadioLibTime_t msPerHour=0)</div><div class="ttdoc">Toggle adherence to dutyCycle limits to on or off.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2687</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a43b259fd8804ef8d9d4922962e9ecae5"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a43b259fd8804ef8d9d4922962e9ecae5">LoRaWANNode::beginABP</a></div><div class="ttdeci">int16_t beginABP(uint32_t addr, const uint8_t *fNwkSIntKey, const uint8_t *sNwkSIntKey, const uint8_t *nwkSEncKey, const uint8_t *appSKey)</div><div class="ttdoc">Set the device credentials and activation configuration.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:612</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a49e690c14858b46692e4ce9aa5a2566a"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a49e690c14858b46692e4ce9aa5a2566a">LoRaWANNode::timeUntilUplink</a></div><div class="ttdeci">RadioLibTime_t timeUntilUplink()</div><div class="ttdoc">Returns time in milliseconds until next uplink is available under dutyCycle limits.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:3231</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:2719</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a5bb50904544f331806fd744ab5b99efa"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a5bb50904544f331806fd744ab5b99efa">LoRaWANNode::dutyCycleInterval</a></div><div class="ttdeci">RadioLibTime_t dutyCycleInterval(RadioLibTime_t msPerHour, RadioLibTime_t airtime)</div><div class="ttdoc">Calculate the minimum interval to adhere to a certain dutyCycle. This interval is based on the ToA of...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:3221</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a6785265f3311ff6bf296f82429c96701"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a6785265f3311ff6bf296f82429c96701">LoRaWANNode::getAFCntDown</a></div><div class="ttdeci">uint32_t getAFCntDown()</div><div class="ttdoc">Returns the last application downlink's frame counter; also 0 if no application downlink occured yet.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2739</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a683b02b63867bb7de5df45c94d190305"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a683b02b63867bb7de5df45c94d190305">LoRaWANNode::getLastToA</a></div><div class="ttdeci">RadioLibTime_t getLastToA()</div><div class="ttdoc">Get the Time-on-air of the last uplink message (in milliseconds).</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2752</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a49e690c14858b46692e4ce9aa5a2566a"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a49e690c14858b46692e4ce9aa5a2566a">LoRaWANNode::timeUntilUplink</a></div><div class="ttdeci">RadioLibTime_t timeUntilUplink()</div><div class="ttdoc">Returns time in milliseconds until next uplink is available under dutyCycle limits.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:3238</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:2726</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a5bb50904544f331806fd744ab5b99efa"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a5bb50904544f331806fd744ab5b99efa">LoRaWANNode::dutyCycleInterval</a></div><div class="ttdeci">RadioLibTime_t dutyCycleInterval(RadioLibTime_t msPerHour, RadioLibTime_t airtime)</div><div class="ttdoc">Calculate the minimum interval to adhere to a certain dutyCycle. This interval is based on the ToA of...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:3228</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a62bfe68f6fe63c2e408dccbff6a34a4f"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a62bfe68f6fe63c2e408dccbff6a34a4f">LoRaWANNode::setDwellTime</a></div><div class="ttdeci">void setDwellTime(bool enable, RadioLibTime_t msPerUplink=0)</div><div class="ttdoc">Set or disable uplink dwell time limitation; enabled by default if mandatory.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2699</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a6785265f3311ff6bf296f82429c96701"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a6785265f3311ff6bf296f82429c96701">LoRaWANNode::getAFCntDown</a></div><div class="ttdeci">uint32_t getAFCntDown()</div><div class="ttdoc">Returns the last application downlink's frame counter; also 0 if no application downlink occured yet.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2746</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a683b02b63867bb7de5df45c94d190305"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a683b02b63867bb7de5df45c94d190305">LoRaWANNode::getLastToA</a></div><div class="ttdeci">RadioLibTime_t getLastToA()</div><div class="ttdoc">Get the Time-on-air of the last uplink message (in milliseconds).</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2759</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a77483c51548e48a5dff4b707f7770e86"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a77483c51548e48a5dff4b707f7770e86">LoRaWANNode::activateABP</a></div><div class="ttdeci">virtual int16_t activateABP(uint8_t initialDr=RADIOLIB_LORAWAN_DATA_RATE_UNUSED)</div><div class="ttdoc">Join network by restoring ABP session or performing over-the-air activation. In this procedure,...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:957</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a8226f4d0329d15da9ffc706e5781403a"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a8226f4d0329d15da9ffc706e5781403a">LoRaWANNode::TS009</a></div><div class="ttdeci">bool TS009</div><div class="ttdoc">TS009 Protocol Specification Verification switch (allows FPort 224 and cuts off uplink payload instea...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.h:836</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a8226f4d0329d15da9ffc706e5781403a"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a8226f4d0329d15da9ffc706e5781403a">LoRaWANNode::TS009</a></div><div class="ttdeci">bool TS009</div><div class="ttdoc">TS009 Protocol Specification Verification switch (allows FPort 224 and cuts off uplink payload instea...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.h:837</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a84004883006b4a498d4899874952445b"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a84004883006b4a498d4899874952445b">LoRaWANNode::getBufferNonces</a></div><div class="ttdeci">uint8_t * getBufferNonces()</div><div class="ttdoc">Returns the pointer to the internal buffer that holds the LW base parameters.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:227</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a90369a4f2c4da11527872a7bbbf9ab06"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a90369a4f2c4da11527872a7bbbf9ab06">LoRaWANNode::getBufferSession</a></div><div class="ttdeci">uint8_t * getBufferSession()</div><div class="ttdoc">Returns the pointer to the internal buffer that holds the LW session parameters.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:427</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a9a44677a1ef7db1216bc482139d6be8d"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a9a44677a1ef7db1216bc482139d6be8d">LoRaWANNode::isActivated</a></div><div class="ttdeci">bool isActivated()</div><div class="ttdoc">Whether there is an ongoing session active.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1047</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a9af613f7d923e7bdcfdbd020132c6d4b"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a9af613f7d923e7bdcfdbd020132c6d4b">LoRaWANNode::setTxPower</a></div><div class="ttdeci">int16_t setTxPower(int8_t txPower)</div><div class="ttdoc">Configure TX power of the radio module.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2630</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a9e6e1ce4296364606ff8b10fb5f971de"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a9e6e1ce4296364606ff8b10fb5f971de">LoRaWANNode::getMacDeviceTimeAns</a></div><div class="ttdeci">int16_t getMacDeviceTimeAns(uint32_t *gpsEpoch, uint8_t *fraction, bool returnUnix=true)</div><div class="ttdoc">Returns the network time after requesting a DeviceTime MAC command. Returns 'true' if a network respo...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2448</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_aa7fabaa6efe9978c3674b1ab187446a1"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#aa7fabaa6efe9978c3674b1ab187446a1">LoRaWANNode::getNFCntDown</a></div><div class="ttdeci">uint32_t getNFCntDown()</div><div class="ttdoc">Returns the last network downlink's frame counter; also 0 if no network downlink occured yet.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2735</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_aa7fabaa6efe9978c3674b1ab187446a1"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#aa7fabaa6efe9978c3674b1ab187446a1">LoRaWANNode::getNFCntDown</a></div><div class="ttdeci">uint32_t getNFCntDown()</div><div class="ttdoc">Returns the last network downlink's frame counter; also 0 if no network downlink occured yet.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2742</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_aae05de563f765f14fe267e4d65844f76"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#aae05de563f765f14fe267e4d65844f76">LoRaWANNode::LoRaWANNode</a></div><div class="ttdeci">LoRaWANNode(PhysicalLayer *phy, const LoRaWANBand_t *band, uint8_t subBand=0)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:9</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_ab2df20a240812f184786dda5ace171ef"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#ab2df20a240812f184786dda5ace171ef">LoRaWANNode::beginOTAA</a></div><div class="ttdeci">int16_t beginOTAA(uint64_t joinEUI, uint64_t devEUI, const uint8_t *nwkKey, const uint8_t *appKey)</div><div class="ttdoc">Set the device credentials and activation configuration.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:583</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_ab723160aa317cd84550d0da3a0f52811"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#ab723160aa317cd84550d0da3a0f52811">LoRaWANNode::getMaxPayloadLen</a></div><div class="ttdeci">uint8_t getMaxPayloadLen()</div><div class="ttdoc">Returns the maximum allowed uplink payload size given the current MAC state. Most importantly,...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:3240</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_ab723160aa317cd84550d0da3a0f52811"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#ab723160aa317cd84550d0da3a0f52811">LoRaWANNode::getMaxPayloadLen</a></div><div class="ttdeci">uint8_t getMaxPayloadLen()</div><div class="ttdoc">Returns the maximum allowed uplink payload size given the current MAC state. Most importantly,...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:3247</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_abd9e976eec64a3bd1ddf3331f2bc93cd"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#abd9e976eec64a3bd1ddf3331f2bc93cd">LoRaWANNode::activateOTAA</a></div><div class="ttdeci">virtual int16_t activateOTAA(uint8_t initialDr=RADIOLIB_LORAWAN_DATA_RATE_UNUSED, LoRaWANJoinEvent_t *joinEvent=NULL)</div><div class="ttdoc">Join network by restoring OTAA session or performing over-the-air activation. By this procedure,...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:867</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_ad3217975ef9959ff83ce79dd80b0d777"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#ad3217975ef9959ff83ce79dd80b0d777">LoRaWANNode::getFCntUp</a></div><div class="ttdeci">uint32_t getFCntUp()</div><div class="ttdoc">Returns the last uplink's frame counter; also 0 if no uplink occured yet.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2728</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_ad3217975ef9959ff83ce79dd80b0d777"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#ad3217975ef9959ff83ce79dd80b0d777">LoRaWANNode::getFCntUp</a></div><div class="ttdeci">uint32_t getFCntUp()</div><div class="ttdoc">Returns the last uplink's frame counter; also 0 if no uplink occured yet.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2735</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_ad99e2fa4738648a6f3efe72ff785def2"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#ad99e2fa4738648a6f3efe72ff785def2">LoRaWANNode::setBufferNonces</a></div><div class="ttdeci">int16_t setBufferNonces(const uint8_t *persistentBuffer)</div><div class="ttdoc">Fill the internal buffer that holds the LW base parameters with a supplied buffer.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:242</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_addfd8ac3d0bfe5a273e9ba10e51f8025"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#addfd8ac3d0bfe5a273e9ba10e51f8025">LoRaWANNode::setRx2Dr</a></div><div class="ttdeci">int16_t setRx2Dr(uint8_t dr)</div><div class="ttdoc">Configure the Rx2 datarate for ABP mode. This should not be needed for LoRaWAN 1.1 as it is configure...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2656</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_adef05650cf4eb92042ca5e2688c1e164"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#adef05650cf4eb92042ca5e2688c1e164">LoRaWANNode::sendMacCommandReq</a></div><div class="ttdeci">int16_t sendMacCommandReq(uint8_t cid)</div><div class="ttdoc">Add a MAC command to the uplink queue. Only LinkCheck and DeviceTime are available to the user....</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2413</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_adf038f331c1dc954dafc2668e7a31ca0"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#adf038f331c1dc954dafc2668e7a31ca0">LoRaWANNode::getMacLinkCheckAns</a></div><div class="ttdeci">int16_t getMacLinkCheckAns(uint8_t *margin, uint8_t *gwCnt)</div><div class="ttdoc">Returns the quality of connectivity after requesting a LinkCheck MAC command. Returns 'true' if a net...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2437</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_ae222275f807f472083ea6100c23c75ff"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#ae222275f807f472083ea6100c23c75ff">LoRaWANNode::setADR</a></div><div class="ttdeci">void setADR(bool enable=true)</div><div class="ttdoc">Toggle ADR to on or off.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2683</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_aedeb50c9ccb81e8092233d34e039cfa4"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#aedeb50c9ccb81e8092233d34e039cfa4">LoRaWANNode::setBufferSession</a></div><div class="ttdeci">int16_t setBufferSession(const uint8_t *persistentBuffer)</div><div class="ttdoc">Fill the internal buffer that holds the LW session parameters with a supplied buffer.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:459</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_aee0590cc9123ceac4c822eabed3150c6"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#aee0590cc9123ceac4c822eabed3150c6">LoRaWANNode::getDevAddr</a></div><div class="ttdeci">uint32_t getDevAddr()</div><div class="ttdoc">Returns the DevAddr of the device, regardless of OTAA or ABP mode.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2748</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_af4b3d07cd9bf4178d627204bae18b648"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#af4b3d07cd9bf4178d627204bae18b648">LoRaWANNode::resetFCntDown</a></div><div class="ttdeci">void resetFCntDown()</div><div class="ttdoc">Reset the downlink frame counters (application and network) This is unsafe and can possibly allow rep...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2743</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_aee0590cc9123ceac4c822eabed3150c6"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#aee0590cc9123ceac4c822eabed3150c6">LoRaWANNode::getDevAddr</a></div><div class="ttdeci">uint32_t getDevAddr()</div><div class="ttdoc">Returns the DevAddr of the device, regardless of OTAA or ABP mode.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2755</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_af4b3d07cd9bf4178d627204bae18b648"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#af4b3d07cd9bf4178d627204bae18b648">LoRaWANNode::resetFCntDown</a></div><div class="ttdeci">void resetFCntDown()</div><div class="ttdoc">Reset the downlink frame counters (application and network) This is unsafe and can possibly allow rep...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2750</div></div>
|
|
|
|
|
<div class="ttc" id="aclass_physical_layer_html"><div class="ttname"><a href="class_physical_layer.html">PhysicalLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:151</div></div>
|
|
|
|
|
<div class="ttc" id="agroup__typedefs_html_ga210f31dd2bff7fb80563275648a5bbbd"><div class="ttname"><a href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a></div><div class="ttdeci">unsigned long RadioLibTime_t</div><div class="ttdoc">Type used for durations in RadioLib.</div><div class="ttdef"><b>Definition:</b> TypeDef.h:642</div></div>
|
|
|
|
|
<div class="ttc" id="astruct_lo_ra_w_a_n_band__t_html"><div class="ttname"><a href="struct_lo_ra_w_a_n_band__t.html">LoRaWANBand_t</a></div><div class="ttdoc">Structure to save information about LoRaWAN band.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.h:367</div></div>
|
|
|
|
|