Deploying to gh-pages from @ 7945ffb996 🚀

This commit is contained in:
jgromes 2024-02-02 15:58:14 +00:00
parent 014ecc577b
commit 52360f35f8
2 changed files with 34 additions and 34 deletions

View file

@ -695,33 +695,33 @@ $(document).ready(function(){initNavTree('_lo_ra_w_a_n_8h_source.html',''); init
<div class="line"><a name="l00890"></a><span class="lineno"> 890</span>&#160; </div>
<div class="line"><a name="l00891"></a><span class="lineno"> 891</span>&#160;<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:398</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a0e3c2642ebb6e86d6a739ea68d692e6a"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a0e3c2642ebb6e86d6a739ea68d692e6a">LoRaWANNode::uplink</a></div><div class="ttdeci">int16_t uplink(const char *str, uint8_t port, bool isConfirmed=false, LoRaWANEvent_t *event=NULL)</div><div class="ttdoc">Send a message to the server.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:881</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a158f65517fa910ef0cbcd92206dab284"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a158f65517fa910ef0cbcd92206dab284">LoRaWANNode::sendReceive</a></div><div class="ttdeci">int16_t sendReceive(const char *strUp, uint8_t port, uint8_t *dataDown, size_t *lenDown, bool isConfirmed=false, LoRaWANEvent_t *eventUp=NULL, LoRaWANEvent_t *eventDown=NULL)</div><div class="ttdoc">Send a message to the server and wait for a downlink during Rx1 and/or Rx2 window.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1623</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a2264c1d9f8ff0f83dc4000a2c80bc25d"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a2264c1d9f8ff0f83dc4000a2c80bc25d">LoRaWANNode::setTxPower</a></div><div class="ttdeci">int16_t setTxPower(int8_t txPower, bool saveToEeprom=false)</div><div class="ttdoc">Configure TX power of the radio module.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2021</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a3044715beeff759ed47342d532ac3205"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a3044715beeff759ed47342d532ac3205">LoRaWANNode::maxPayloadDwellTime</a></div><div class="ttdeci">uint8_t maxPayloadDwellTime()</div><div class="ttdoc">Returns the maximum payload given the currently present dwell time limits. WARNING: the addition of M...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2001</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a40c5fdba815b26a44be7af68c184fe49"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a40c5fdba815b26a44be7af68c184fe49">LoRaWANNode::setDwellTime</a></div><div class="ttdeci">void setDwellTime(bool enable, uint32_t msPerUplink=0)</div><div class="ttdoc">Toggle adherence to dwellTime limits to on or off.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1992</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a52ae7c2aa61262d7761236f289889020"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a52ae7c2aa61262d7761236f289889020">LoRaWANNode::getFcntUp</a></div><div class="ttdeci">uint32_t getFcntUp()</div><div class="ttdoc">Returns the last uplink's frame counter.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1647</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a5449e301634dff1838a1b024b4067034"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a5449e301634dff1838a1b024b4067034">LoRaWANNode::setDeviceStatus</a></div><div class="ttdeci">void setDeviceStatus(uint8_t battLevel)</div><div class="ttdoc">Set device status.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1643</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a564386d9c15ad71a1a8703809c8a9741"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a564386d9c15ad71a1a8703809c8a9741">LoRaWANNode::dutyCycleInterval</a></div><div class="ttdeci">uint32_t dutyCycleInterval(uint32_t msPerHour, uint32_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:1973</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a5693065bbb6d1c6c45efbe010d86f417"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a5693065bbb6d1c6c45efbe010d86f417">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:1659</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a6ff678f9cb57b97eb63886953aca1ba9"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a6ff678f9cb57b97eb63886953aca1ba9">LoRaWANNode::sendMacCommandReq</a></div><div class="ttdeci">bool 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:2111</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a7078a3f1657a2a022bb43f2bd34c93e3"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a7078a3f1657a2a022bb43f2bd34c93e3">LoRaWANNode::saveSession</a></div><div class="ttdeci">int16_t saveSession()</div><div class="ttdoc">Save the current state of the session. All variables are compared to what is saved and only the diffe...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:777</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a70ae5e359bb228f09b7dc2048ee4a1c5"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a70ae5e359bb228f09b7dc2048ee4a1c5">LoRaWANNode::setDatarate</a></div><div class="ttdeci">int16_t setDatarate(uint8_t drUp, bool saveToEeprom=false)</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:1921</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a8ac61997732b3f6d5f33b6568e23be11"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a8ac61997732b3f6d5f33b6568e23be11">LoRaWANNode::getNFcntDown</a></div><div class="ttdeci">uint32_t getNFcntDown()</div><div class="ttdoc">Returns the last network downlink's frame counter.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1651</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a8b647b639d1c7f1a2a81397b41c01dd8"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a8b647b639d1c7f1a2a81397b41c01dd8">LoRaWANNode::getAFcntDown</a></div><div class="ttdeci">uint32_t getAFcntDown()</div><div class="ttdoc">Returns the last application downlink's frame counter.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1655</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a9613998d071bcf401be9ad57ff8591ea"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a9613998d071bcf401be9ad57ff8591ea">LoRaWANNode::wipe</a></div><div class="ttdeci">void wipe()</div><div class="ttdoc">Wipe internal persistent parameters. This will reset all counters and saved variables,...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:49</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a9a757f52c10a904a81b54fed70921ed5"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a9a757f52c10a904a81b54fed70921ed5">LoRaWANNode::beginABP</a></div><div class="ttdeci">int16_t beginABP(uint32_t addr, uint8_t *nwkSKey, uint8_t *appSKey, uint8_t *fNwkSIntKey=NULL, uint8_t *sNwkSIntKey=NULL, bool force=false)</div><div class="ttdoc">Join network by performing activation by personalization. In this procedure, all necessary configurat...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:684</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:2849</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_aabced307f6662998608f01fab25e4226"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#aabced307f6662998608f01fab25e4226">LoRaWANNode::downlink</a></div><div class="ttdeci">int16_t downlink(uint8_t *data, size_t *len, LoRaWANEvent_t *event=NULL)</div><div class="ttdoc">Wait for downlink from the server in either RX1 or RX2 window.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1288</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:31</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_ab16e85446e0a843001d1dabad5223956"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#ab16e85446e0a843001d1dabad5223956">LoRaWANNode::setDutyCycle</a></div><div class="ttdeci">void setDutyCycle(bool enable=true, uint32_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:1962</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_ac5571bebeebbece3a6357e1c9868cb8b"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#ac5571bebeebbece3a6357e1c9868cb8b">LoRaWANNode::timeUntilUplink</a></div><div class="ttdeci">uint32_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:1983</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:2838</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_adfc9cdaa254a27c28403188c90991757"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#adfc9cdaa254a27c28403188c90991757">LoRaWANNode::setCSMA</a></div><div class="ttdeci">void setCSMA(uint8_t backoffMax, uint8_t difsSlots, bool enableCSMA=false)</div><div class="ttdoc">Configures CSMA for LoRaWAN as per TR-13, LoRa Alliance.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:42</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:1958</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_ae9e0dc5118e68b8b766b7d205bd4c784"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#ae9e0dc5118e68b8b766b7d205bd4c784">LoRaWANNode::restore</a></div><div class="ttdeci">int16_t restore()</div><div class="ttdoc">Restore session by loading information from persistent storage.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:54</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_af4bdc96a5b4016b6b15d23d32bb5f28d"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#af4bdc96a5b4016b6b15d23d32bb5f28d">LoRaWANNode::beginOTAA</a></div><div class="ttdeci">int16_t beginOTAA(uint64_t joinEUI, uint64_t devEUI, uint8_t *nwkKey, uint8_t *appKey, uint8_t joinDr=RADIOLIB_LORAWAN_DATA_RATE_UNUSED, bool force=false)</div><div class="ttdoc">Join network by performing over-the-air activation. By this procedure, the device will perform an exc...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:389</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_af7a8ae58391e00b5fcb99f01832cc4fc"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#af7a8ae58391e00b5fcb99f01832cc4fc">LoRaWANNode::isJoined</a></div><div class="ttdeci">bool isJoined()</div><div class="ttdoc">Whether there is an ongoing session active.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:772</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a0e3c2642ebb6e86d6a739ea68d692e6a"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a0e3c2642ebb6e86d6a739ea68d692e6a">LoRaWANNode::uplink</a></div><div class="ttdeci">int16_t uplink(const char *str, uint8_t port, bool isConfirmed=false, LoRaWANEvent_t *event=NULL)</div><div class="ttdoc">Send a message to the server.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:884</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a158f65517fa910ef0cbcd92206dab284"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a158f65517fa910ef0cbcd92206dab284">LoRaWANNode::sendReceive</a></div><div class="ttdeci">int16_t sendReceive(const char *strUp, uint8_t port, uint8_t *dataDown, size_t *lenDown, bool isConfirmed=false, LoRaWANEvent_t *eventUp=NULL, LoRaWANEvent_t *eventDown=NULL)</div><div class="ttdoc">Send a message to the server and wait for a downlink during Rx1 and/or Rx2 window.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1626</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a2264c1d9f8ff0f83dc4000a2c80bc25d"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a2264c1d9f8ff0f83dc4000a2c80bc25d">LoRaWANNode::setTxPower</a></div><div class="ttdeci">int16_t setTxPower(int8_t txPower, bool saveToEeprom=false)</div><div class="ttdoc">Configure TX power of the radio module.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2024</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a3044715beeff759ed47342d532ac3205"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a3044715beeff759ed47342d532ac3205">LoRaWANNode::maxPayloadDwellTime</a></div><div class="ttdeci">uint8_t maxPayloadDwellTime()</div><div class="ttdoc">Returns the maximum payload given the currently present dwell time limits. WARNING: the addition of M...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:2004</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a40c5fdba815b26a44be7af68c184fe49"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a40c5fdba815b26a44be7af68c184fe49">LoRaWANNode::setDwellTime</a></div><div class="ttdeci">void setDwellTime(bool enable, uint32_t msPerUplink=0)</div><div class="ttdoc">Toggle adherence to dwellTime limits to on or off.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1995</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a52ae7c2aa61262d7761236f289889020"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a52ae7c2aa61262d7761236f289889020">LoRaWANNode::getFcntUp</a></div><div class="ttdeci">uint32_t getFcntUp()</div><div class="ttdoc">Returns the last uplink's frame counter.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1650</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:1646</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a564386d9c15ad71a1a8703809c8a9741"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a564386d9c15ad71a1a8703809c8a9741">LoRaWANNode::dutyCycleInterval</a></div><div class="ttdeci">uint32_t dutyCycleInterval(uint32_t msPerHour, uint32_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:1976</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a5693065bbb6d1c6c45efbe010d86f417"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a5693065bbb6d1c6c45efbe010d86f417">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:1662</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a6ff678f9cb57b97eb63886953aca1ba9"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a6ff678f9cb57b97eb63886953aca1ba9">LoRaWANNode::sendMacCommandReq</a></div><div class="ttdeci">bool 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:2114</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a7078a3f1657a2a022bb43f2bd34c93e3"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a7078a3f1657a2a022bb43f2bd34c93e3">LoRaWANNode::saveSession</a></div><div class="ttdeci">int16_t saveSession()</div><div class="ttdoc">Save the current state of the session. All variables are compared to what is saved and only the diffe...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:780</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a70ae5e359bb228f09b7dc2048ee4a1c5"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a70ae5e359bb228f09b7dc2048ee4a1c5">LoRaWANNode::setDatarate</a></div><div class="ttdeci">int16_t setDatarate(uint8_t drUp, bool saveToEeprom=false)</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:1924</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a8ac61997732b3f6d5f33b6568e23be11"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a8ac61997732b3f6d5f33b6568e23be11">LoRaWANNode::getNFcntDown</a></div><div class="ttdeci">uint32_t getNFcntDown()</div><div class="ttdoc">Returns the last network downlink's frame counter.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1654</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a8b647b639d1c7f1a2a81397b41c01dd8"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a8b647b639d1c7f1a2a81397b41c01dd8">LoRaWANNode::getAFcntDown</a></div><div class="ttdeci">uint32_t getAFcntDown()</div><div class="ttdoc">Returns the last application downlink's frame counter.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1658</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a9613998d071bcf401be9ad57ff8591ea"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a9613998d071bcf401be9ad57ff8591ea">LoRaWANNode::wipe</a></div><div class="ttdeci">void wipe()</div><div class="ttdoc">Wipe internal persistent parameters. This will reset all counters and saved variables,...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:52</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_a9a757f52c10a904a81b54fed70921ed5"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#a9a757f52c10a904a81b54fed70921ed5">LoRaWANNode::beginABP</a></div><div class="ttdeci">int16_t beginABP(uint32_t addr, uint8_t *nwkSKey, uint8_t *appSKey, uint8_t *fNwkSIntKey=NULL, uint8_t *sNwkSIntKey=NULL, bool force=false)</div><div class="ttdoc">Join network by performing activation by personalization. In this procedure, all necessary configurat...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:687</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:2852</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_aabced307f6662998608f01fab25e4226"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#aabced307f6662998608f01fab25e4226">LoRaWANNode::downlink</a></div><div class="ttdeci">int16_t downlink(uint8_t *data, size_t *len, LoRaWANEvent_t *event=NULL)</div><div class="ttdoc">Wait for downlink from the server in either RX1 or RX2 window.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:1291</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:34</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_ab16e85446e0a843001d1dabad5223956"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#ab16e85446e0a843001d1dabad5223956">LoRaWANNode::setDutyCycle</a></div><div class="ttdeci">void setDutyCycle(bool enable=true, uint32_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:1965</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_ac5571bebeebbece3a6357e1c9868cb8b"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#ac5571bebeebbece3a6357e1c9868cb8b">LoRaWANNode::timeUntilUplink</a></div><div class="ttdeci">uint32_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:1986</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:2841</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_adfc9cdaa254a27c28403188c90991757"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#adfc9cdaa254a27c28403188c90991757">LoRaWANNode::setCSMA</a></div><div class="ttdeci">void setCSMA(uint8_t backoffMax, uint8_t difsSlots, bool enableCSMA=false)</div><div class="ttdoc">Configures CSMA for LoRaWAN as per TR-13, LoRa Alliance.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:45</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:1961</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_ae9e0dc5118e68b8b766b7d205bd4c784"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#ae9e0dc5118e68b8b766b7d205bd4c784">LoRaWANNode::restore</a></div><div class="ttdeci">int16_t restore()</div><div class="ttdoc">Restore session by loading information from persistent storage.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:57</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_af4bdc96a5b4016b6b15d23d32bb5f28d"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#af4bdc96a5b4016b6b15d23d32bb5f28d">LoRaWANNode::beginOTAA</a></div><div class="ttdeci">int16_t beginOTAA(uint64_t joinEUI, uint64_t devEUI, uint8_t *nwkKey, uint8_t *appKey, uint8_t joinDr=RADIOLIB_LORAWAN_DATA_RATE_UNUSED, bool force=false)</div><div class="ttdoc">Join network by performing over-the-air activation. By this procedure, the device will perform an exc...</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:392</div></div>
<div class="ttc" id="aclass_lo_ra_w_a_n_node_html_af7a8ae58391e00b5fcb99f01832cc4fc"><div class="ttname"><a href="class_lo_ra_w_a_n_node.html#af7a8ae58391e00b5fcb99f01832cc4fc">LoRaWANNode::isJoined</a></div><div class="ttdeci">bool isJoined()</div><div class="ttdoc">Whether there is an ongoing session active.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.cpp:775</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:34</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:283</div></div>
<div class="ttc" id="astruct_lo_ra_w_a_n_band__t_html_a097bc6dc35cf0ba5ba04fd7f88dbaca9"><div class="ttname"><a href="struct_lo_ra_w_a_n_band__t.html#a097bc6dc35cf0ba5ba04fd7f88dbaca9">LoRaWANBand_t::dwellTimeUp</a></div><div class="ttdeci">uint32_t dwellTimeUp</div><div class="ttdoc">Maximum dwell time per message in milliseconds.</div><div class="ttdef"><b>Definition:</b> LoRaWAN.h:300</div></div>

View file

@ -201,13 +201,13 @@ $(document).ready(function(){initNavTree('_pager_8h_source.html',''); initResiza
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; </div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_pager_client_html"><div class="ttname"><a href="class_pager_client.html">PagerClient</a></div><div class="ttdoc">Client for Pager communication.</div><div class="ttdef"><b>Definition:</b> Pager.h:62</div></div>
<div class="ttc" id="aclass_pager_client_html_a1a1dc569f9b60b0ddd6ead7af5a8244f"><div class="ttname"><a href="class_pager_client.html#a1a1dc569f9b60b0ddd6ead7af5a8244f">PagerClient::begin</a></div><div class="ttdeci">int16_t begin(float base, uint16_t speed, bool invert=false, uint16_t shift=RADIOLIB_PAGER_FREQ_SHIFT_HZ)</div><div class="ttdoc">Initialization method.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:29</div></div>
<div class="ttc" id="aclass_pager_client_html_a8f9af4c0a5c2e9de7cdfa1a907479111"><div class="ttname"><a href="class_pager_client.html#a8f9af4c0a5c2e9de7cdfa1a907479111">PagerClient::sendTone</a></div><div class="ttdeci">int16_t sendTone(uint32_t addr)</div><div class="ttdoc">Method to send a tone-only alert to a destination pager.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:53</div></div>
<div class="ttc" id="aclass_pager_client_html_a9f978120467b13104fb356e9b7d855ec"><div class="ttname"><a href="class_pager_client.html#a9f978120467b13104fb356e9b7d855ec">PagerClient::PagerClient</a></div><div class="ttdeci">PagerClient(PhysicalLayer *phy)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:22</div></div>
<div class="ttc" id="aclass_pager_client_html_ac232570ac012ff315a1971ab0422fed3"><div class="ttname"><a href="class_pager_client.html#ac232570ac012ff315a1971ab0422fed3">PagerClient::startReceive</a></div><div class="ttdeci">int16_t startReceive(uint32_t pin, uint32_t addr, uint32_t mask=0xFFFFF)</div><div class="ttdoc">Start reception of POCSAG packets.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:239</div></div>
<div class="ttc" id="aclass_pager_client_html_ad2c6132819a84712b929c0bb22ba172b"><div class="ttname"><a href="class_pager_client.html#ad2c6132819a84712b929c0bb22ba172b">PagerClient::readData</a></div><div class="ttdeci">int16_t readData(uint8_t *data, size_t *len, uint32_t *addr=NULL)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:327</div></div>
<div class="ttc" id="aclass_pager_client_html_adbab4e162a5719bd4407a42a85d26ff6"><div class="ttname"><a href="class_pager_client.html#adbab4e162a5719bd4407a42a85d26ff6">PagerClient::transmit</a></div><div class="ttdeci">int16_t transmit(const char *str, uint32_t addr, uint8_t encoding=RADIOLIB_PAGER_BCD, uint8_t function=RADIOLIB_PAGER_FUNC_AUTO)</div><div class="ttdoc">C-string transmit method.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:63</div></div>
<div class="ttc" id="aclass_pager_client_html_aec073fa9e5adcff9730482d9583715e9"><div class="ttname"><a href="class_pager_client.html#aec073fa9e5adcff9730482d9583715e9">PagerClient::available</a></div><div class="ttdeci">size_t available()</div><div class="ttdoc">Get the number of POCSAG batches available in buffer. Limited by the size of direct mode buffer!</div><div class="ttdef"><b>Definition:</b> Pager.cpp:276</div></div>
<div class="ttc" id="aclass_pager_client_html_a1a1dc569f9b60b0ddd6ead7af5a8244f"><div class="ttname"><a href="class_pager_client.html#a1a1dc569f9b60b0ddd6ead7af5a8244f">PagerClient::begin</a></div><div class="ttdeci">int16_t begin(float base, uint16_t speed, bool invert=false, uint16_t shift=RADIOLIB_PAGER_FREQ_SHIFT_HZ)</div><div class="ttdoc">Initialization method.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:33</div></div>
<div class="ttc" id="aclass_pager_client_html_a8f9af4c0a5c2e9de7cdfa1a907479111"><div class="ttname"><a href="class_pager_client.html#a8f9af4c0a5c2e9de7cdfa1a907479111">PagerClient::sendTone</a></div><div class="ttdeci">int16_t sendTone(uint32_t addr)</div><div class="ttdoc">Method to send a tone-only alert to a destination pager.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:57</div></div>
<div class="ttc" id="aclass_pager_client_html_a9f978120467b13104fb356e9b7d855ec"><div class="ttname"><a href="class_pager_client.html#a9f978120467b13104fb356e9b7d855ec">PagerClient::PagerClient</a></div><div class="ttdeci">PagerClient(PhysicalLayer *phy)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:26</div></div>
<div class="ttc" id="aclass_pager_client_html_ac232570ac012ff315a1971ab0422fed3"><div class="ttname"><a href="class_pager_client.html#ac232570ac012ff315a1971ab0422fed3">PagerClient::startReceive</a></div><div class="ttdeci">int16_t startReceive(uint32_t pin, uint32_t addr, uint32_t mask=0xFFFFF)</div><div class="ttdoc">Start reception of POCSAG packets.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:243</div></div>
<div class="ttc" id="aclass_pager_client_html_ad2c6132819a84712b929c0bb22ba172b"><div class="ttname"><a href="class_pager_client.html#ad2c6132819a84712b929c0bb22ba172b">PagerClient::readData</a></div><div class="ttdeci">int16_t readData(uint8_t *data, size_t *len, uint32_t *addr=NULL)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:331</div></div>
<div class="ttc" id="aclass_pager_client_html_adbab4e162a5719bd4407a42a85d26ff6"><div class="ttname"><a href="class_pager_client.html#adbab4e162a5719bd4407a42a85d26ff6">PagerClient::transmit</a></div><div class="ttdeci">int16_t transmit(const char *str, uint32_t addr, uint8_t encoding=RADIOLIB_PAGER_BCD, uint8_t function=RADIOLIB_PAGER_FUNC_AUTO)</div><div class="ttdoc">C-string transmit method.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:67</div></div>
<div class="ttc" id="aclass_pager_client_html_aec073fa9e5adcff9730482d9583715e9"><div class="ttname"><a href="class_pager_client.html#aec073fa9e5adcff9730482d9583715e9">PagerClient::available</a></div><div class="ttdeci">size_t available()</div><div class="ttdoc">Get the number of POCSAG batches available in buffer. Limited by the size of direct mode buffer!</div><div class="ttdef"><b>Definition:</b> Pager.cpp:280</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:34</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->