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

Deploying to gh-pages from @ f78b3ccc97 🚀

Browse source
This commit is contained in:
jgromes 2024-05-26 14:37:17 +00:00
parent 4a48987b4b
commit f2d3ad8fc3
4 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
_module_8h_source.html
View file

@ -118,7 +118,7 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="class_module.html"> 65</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_module.html">Module</a> {</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c"> 74</a></span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a> = 3;</div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c"> 74</a></span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a> = 5;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="struct_module_1_1_rf_switch_mode__t.html"> 81</a></span>&#160; <span class="keyword">struct </span><a class="code" href="struct_module_1_1_rf_switch_mode__t.html">RfSwitchMode_t</a> {</div>
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="struct_module_1_1_rf_switch_mode__t.html#a2442217bfabfb124a3f46bb128aa7462"> 83</a></span>&#160; uint8_t <a class="code" href="struct_module_1_1_rf_switch_mode__t.html#a2442217bfabfb124a3f46bb128aa7462">mode</a>;</div>
@ -276,7 +276,7 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
<div class="line"><a name="l00546"></a><span class="lineno"> 546</span>&#160; uint32_t gpioPin = RADIOLIB_NC;</div>
<div class="line"><a name="l00547"></a><span class="lineno"> 547</span>&#160; </div>
<div class="line"><a name="l00548"></a><span class="lineno"> 548</span>&#160; <span class="comment">// RF switch pins and table</span></div>
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span>&#160; uint32_t rfSwitchPins[<a class="code" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a>] = { RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC };</div>
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span>&#160; uint32_t rfSwitchPins[<a class="code" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a>] = { RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC };</div>
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span>&#160; <span class="keyword">const</span> RfSwitchMode_t *rfSwitchTable = <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span>&#160; </div>
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span>&#160;<span class="preprocessor"> #if RADIOLIB_INTERRUPT_TIMING</span></div>

8
_s_x126x_8h_source.html
View file

@ -826,7 +826,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
<div class="ttc" id="aclass_s_x126x_html_a077f180905ce4818cbdacad0cd9fe841"><div class="ttname"><a href="class_s_x126x.html#a077f180905ce4818cbdacad0cd9fe841">SX126x::startReceiveDutyCycleAuto</a></div><div class="ttdeci">int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)</div><div class="ttdoc">Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:630</div></div>
<div class="ttc" id="aclass_s_x126x_html_a0a0df468eacc71c1b2a093ac06bfff51"><div class="ttname"><a href="class_s_x126x.html#a0a0df468eacc71c1b2a093ac06bfff51">SX126x::setRfSwitchPins</a></div><div class="ttdeci">void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)</div><div class="ttdoc">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1488</div></div>
<div class="ttc" id="aclass_s_x126x_html_a0da667fe702d7b4aafaa4bf7e69ea40d"><div class="ttname"><a href="class_s_x126x.html#a0da667fe702d7b4aafaa4bf7e69ea40d">SX126x::setDio1Action</a></div><div class="ttdeci">void setDio1Action(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when DIO1 activates.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:483</div></div>
<div class="ttc" id="aclass_s_x126x_html_a1623e7d5450c97ca092913ad79d62208"><div class="ttname"><a href="class_s_x126x.html#a1623e7d5450c97ca092913ad79d62208">SX126x::setPaConfig</a></div><div class="ttdeci">int16_t setPaConfig(uint8_t paDutyCycle, uint8_t deviceSel, uint8_t hpMax=RADIOLIB_SX126X_PA_CONFIG_HP_MAX, uint8_t paLut=RADIOLIB_SX126X_PA_CONFIG_PA_LUT)</div><div class="ttdoc">Set the PA configuration. Allows user to optimize PA for a specific output power and matching network...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1795</div></div>
<div class="ttc" id="aclass_s_x126x_html_a1623e7d5450c97ca092913ad79d62208"><div class="ttname"><a href="class_s_x126x.html#a1623e7d5450c97ca092913ad79d62208">SX126x::setPaConfig</a></div><div class="ttdeci">int16_t setPaConfig(uint8_t paDutyCycle, uint8_t deviceSel, uint8_t hpMax=RADIOLIB_SX126X_PA_CONFIG_HP_MAX, uint8_t paLut=RADIOLIB_SX126X_PA_CONFIG_PA_LUT)</div><div class="ttdoc">Set the PA configuration. Allows user to optimize PA for a specific output power and matching network...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1799</div></div>
<div class="ttc" id="aclass_s_x126x_html_a16eb0bdb051f3cf288db752d18182ae2"><div class="ttname"><a href="class_s_x126x.html#a16eb0bdb051f3cf288db752d18182ae2">SX126x::getTimeOnAir</a></div><div class="ttdeci">RadioLibTime_t getTimeOnAir(size_t len) override</div><div class="ttdoc">Get expected time-on-air for a given size of payload.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1414</div></div>
<div class="ttc" id="aclass_s_x126x_html_a187a616285c5872f9603a86c122deaf2"><div class="ttname"><a href="class_s_x126x.html#a187a616285c5872f9603a86c122deaf2">SX126x::randomByte</a></div><div class="ttdeci">uint8_t randomByte() override</div><div class="ttdoc">Get one truly random byte from RSSI noise.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1517</div></div>
<div class="ttc" id="aclass_s_x126x_html_a19f3c26d7a7959e302fc8174fc88a6d4"><div class="ttname"><a href="class_s_x126x.html#a19f3c26d7a7959e302fc8174fc88a6d4">SX126x::calculateRxTimeout</a></div><div class="ttdeci">RadioLibTime_t calculateRxTimeout(RadioLibTime_t timeoutUs) override</div><div class="ttdoc">Calculate the timeout value for this specific module / series (in number of symbols or units of time)</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1449</div></div>
@ -871,10 +871,10 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
<div class="ttc" id="aclass_s_x126x_html_a92c157efe751b4ae73d22ff44115285d"><div class="ttname"><a href="class_s_x126x.html#a92c157efe751b4ae73d22ff44115285d">SX126x::variablePacketLengthMode</a></div><div class="ttdeci">int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)</div><div class="ttdoc">Set modem in variable packet length mode. Available in FSK mode only.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1410</div></div>
<div class="ttc" id="aclass_s_x126x_html_a936a40038e05740a528f2b53f8e17010"><div class="ttname"><a href="class_s_x126x.html#a936a40038e05740a528f2b53f8e17010">SX126x::begin</a></div><div class="ttdeci">int16_t begin(uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)</div><div class="ttdoc">Initialization method for LoRa modem.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:12</div></div>
<div class="ttc" id="aclass_s_x126x_html_a95007639c2648a1dbb614493224606f1"><div class="ttname"><a href="class_s_x126x.html#a95007639c2648a1dbb614493224606f1">SX126x::setCRC</a></div><div class="ttdeci">int16_t setCRC(uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)</div><div class="ttdoc">Sets CRC configuration.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1230</div></div>
<div class="ttc" id="aclass_s_x126x_html_a9a9b090eddcb811ee19b595debfab1df"><div class="ttname"><a href="class_s_x126x.html#a9a9b090eddcb811ee19b595debfab1df">SX126x::getIrqStatus</a></div><div class="ttdeci">uint16_t getIrqStatus()</div><div class="ttdoc">Reads the current IRQ status.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1832</div></div>
<div class="ttc" id="aclass_s_x126x_html_a9a9b090eddcb811ee19b595debfab1df"><div class="ttname"><a href="class_s_x126x.html#a9a9b090eddcb811ee19b595debfab1df">SX126x::getIrqStatus</a></div><div class="ttdeci">uint16_t getIrqStatus()</div><div class="ttdoc">Reads the current IRQ status.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1836</div></div>
<div class="ttc" id="aclass_s_x126x_html_a9aa6dd05dd32ef717a06cc8ba28ff71f"><div class="ttname"><a href="class_s_x126x.html#a9aa6dd05dd32ef717a06cc8ba28ff71f">SX126x::reset</a></div><div class="ttdeci">int16_t reset(bool verify=true)</div><div class="ttdoc">Reset method. Will reset the chip to the default state using RST pin.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:198</div></div>
<div class="ttc" id="aclass_s_x126x_html_a9d92dce566f8aefa836fe8f332e9560f"><div class="ttname"><a href="class_s_x126x.html#a9d92dce566f8aefa836fe8f332e9560f">SX126x::setSyncWord</a></div><div class="ttdeci">int16_t setSyncWord(uint8_t syncWord, uint8_t controlBits=0x44)</div><div class="ttdoc">Sets LoRa sync word.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:864</div></div>
<div class="ttc" id="aclass_s_x126x_html_aa3c90f19cd141738ff013ae72f78f1bb"><div class="ttname"><a href="class_s_x126x.html#aa3c90f19cd141738ff013ae72f78f1bb">SX126x::calibrateImageRejection</a></div><div class="ttdeci">int16_t calibrateImageRejection(float freqMin, float freqMax)</div><div class="ttdoc">Perform image rejection calibration for the specified frequency band. WARNING: Use at your own risk!...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1848</div></div>
<div class="ttc" id="aclass_s_x126x_html_aa3c90f19cd141738ff013ae72f78f1bb"><div class="ttname"><a href="class_s_x126x.html#aa3c90f19cd141738ff013ae72f78f1bb">SX126x::calibrateImageRejection</a></div><div class="ttdeci">int16_t calibrateImageRejection(float freqMin, float freqMax)</div><div class="ttdoc">Perform image rejection calibration for the specified frequency band. WARNING: Use at your own risk!...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1852</div></div>
<div class="ttc" id="aclass_s_x126x_html_aa668babb0bd129b2facee9fd280525ab"><div class="ttname"><a href="class_s_x126x.html#aa668babb0bd129b2facee9fd280525ab">SX126x::getCurrentLimit</a></div><div class="ttdeci">float getCurrentLimit()</div><div class="ttdoc">Reads current protection limit.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:888</div></div>
<div class="ttc" id="aclass_s_x126x_html_aaca5a8fa8a3e634dd1b5b4c2bb5058d8"><div class="ttname"><a href="class_s_x126x.html#aaca5a8fa8a3e634dd1b5b4c2bb5058d8">SX126x::SX126x</a></div><div class="ttdeci">SX126x(Module *mod)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:6</div></div>
<div class="ttc" id="aclass_s_x126x_html_ab593887ad083a1d5affda7a42656749e"><div class="ttname"><a href="class_s_x126x.html#ab593887ad083a1d5affda7a42656749e">SX126x::irqRxDoneRxTimeout</a></div><div class="ttdeci">int16_t irqRxDoneRxTimeout(uint32_t &amp;irqFlags, uint32_t &amp;irqMask) override</div><div class="ttdoc">Create the flags that make up RxDone and RxTimeout used for receiving downlinks.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1456</div></div>
@ -890,7 +890,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
<div class="ttc" id="aclass_s_x126x_html_acb8611a9c3862dd1bfa73ef47b8f9b20"><div class="ttname"><a href="class_s_x126x.html#acb8611a9c3862dd1bfa73ef47b8f9b20">SX126x::scanChannel</a></div><div class="ttdeci">int16_t scanChannel() override</div><div class="ttdoc">Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:427</div></div>
<div class="ttc" id="aclass_s_x126x_html_acbe2d75b1e2df8bcc58c4fd9d8e6e4f9"><div class="ttname"><a href="class_s_x126x.html#acbe2d75b1e2df8bcc58c4fd9d8e6e4f9">SX126x::getDataRate</a></div><div class="ttdeci">float getDataRate() const</div><div class="ttdoc">Gets effective data rate for the last transmitted packet. The value is calculated only for payload by...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1326</div></div>
<div class="ttc" id="aclass_s_x126x_html_ad6274222ccf534e98e3cd17dfa1520d4"><div class="ttname"><a href="class_s_x126x.html#ad6274222ccf534e98e3cd17dfa1520d4">SX126x::setPreambleLength</a></div><div class="ttdeci">int16_t setPreambleLength(size_t preambleLength) override</div><div class="ttdoc">Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:897</div></div>
<div class="ttc" id="aclass_s_x126x_html_ad90a56cb55c5bb64037a0d412d84a80d"><div class="ttname"><a href="class_s_x126x.html#ad90a56cb55c5bb64037a0d412d84a80d">SX126x::setPaRampTime</a></div><div class="ttdeci">int16_t setPaRampTime(uint8_t rampTime)</div><div class="ttdoc">Set PA ramp-up time. Set to 200us by default.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1856</div></div>
<div class="ttc" id="aclass_s_x126x_html_ad90a56cb55c5bb64037a0d412d84a80d"><div class="ttname"><a href="class_s_x126x.html#ad90a56cb55c5bb64037a0d412d84a80d">SX126x::setPaRampTime</a></div><div class="ttdeci">int16_t setPaRampTime(uint8_t rampTime)</div><div class="ttdoc">Set PA ramp-up time. Set to 200us by default.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1860</div></div>
<div class="ttc" id="aclass_s_x126x_html_ada0fe6c3d31885952b439135cf0c18f1"><div class="ttname"><a href="class_s_x126x.html#ada0fe6c3d31885952b439135cf0c18f1">SX126x::XTAL</a></div><div class="ttdeci">bool XTAL</div><div class="ttdoc">Whether the module has an XTAL (true) or TCXO (false). Defaults to false.</div><div class="ttdef"><b>Definition:</b> SX126x.h:460</div></div>
<div class="ttc" id="aclass_s_x126x_html_adec09cba71494bd927ad1da786606ca6"><div class="ttname"><a href="class_s_x126x.html#adec09cba71494bd927ad1da786606ca6">SX126x::implicitHeader</a></div><div class="ttdeci">int16_t implicitHeader(size_t len)</div><div class="ttdoc">Set implicit header mode for future reception/transmission.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1468</div></div>
<div class="ttc" id="aclass_s_x126x_html_ae46e08d579f4acbad029b4cd4f4fffaf"><div class="ttname"><a href="class_s_x126x.html#ae46e08d579f4acbad029b4cd4f4fffaf">SX126x::setDio2AsRfSwitch</a></div><div class="ttdeci">int16_t setDio2AsRfSwitch(bool enable=true)</div><div class="ttdoc">Set DIO2 to function as RF switch (default in Semtech example designs).</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1710</div></div>

2
class_module.html
View file

@ -247,7 +247,7 @@ Public Attributes</h2></td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a0c11551e12579bbabf57b19e12555b3c"><td class="memItemLeft" align="right" valign="top"><a id="a0c11551e12579bbabf57b19e12555b3c"></a>
static const size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a> = 3</td></tr>
static const size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a> = 5</td></tr>
<tr class="memdesc:a0c11551e12579bbabf57b19e12555b3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum number of pins supported by the RF switch code. Note: It is not recommended to use this constant in your sketch when defining a rfswitch pins array, to prevent issues when this value is ever increased and such an array gets extra zero elements (that will be interpreted as pin 0). <br /></td></tr>
<tr class="separator:a0c11551e12579bbabf57b19e12555b3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>

2
class_s_t_m32_w_lx___module.html
View file

@ -222,7 +222,7 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<tr class="separator:a3a4fc4101fb3f134152b458c447b8ecb inherit pub_attribs_class_module"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_static_attribs_class_module"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_class_module')"><img src="closed.png" alt="-"/>&#160;Static Public Attributes inherited from <a class="el" href="class_module.html">Module</a></td></tr>
<tr class="memitem:a0c11551e12579bbabf57b19e12555b3c inherit pub_static_attribs_class_module"><td class="memItemLeft" align="right" valign="top"><a id="a0c11551e12579bbabf57b19e12555b3c"></a>
static const size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a> = 3</td></tr>
static const size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">RFSWITCH_MAX_PINS</a> = 5</td></tr>
<tr class="memdesc:a0c11551e12579bbabf57b19e12555b3c inherit pub_static_attribs_class_module"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum number of pins supported by the RF switch code. Note: It is not recommended to use this constant in your sketch when defining a rfswitch pins array, to prevent issues when this value is ever increased and such an array gets extra zero elements (that will be interpreted as pin 0). <br /></td></tr>
<tr class="separator:a0c11551e12579bbabf57b19e12555b3c inherit pub_static_attribs_class_module"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>