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

Deploying to gh-pages from @ 2e8d0ae8a3 🚀

Browse source
This commit is contained in:
jgromes 2023-04-17 17:11:42 +00:00
parent 7576ab4dff
commit 336dff3f0d
1 changed files with 24 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
_s_x126x_8h_source.html
View file

@ -704,7 +704,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
<div class="line"><a name="l01156"></a><span class="lineno"> 1156</span>&#160; int16_t setTxParams(uint8_t power, uint8_t rampTime = RADIOLIB_SX126X_PA_RAMP_200U);</div>
<div class="line"><a name="l01157"></a><span class="lineno"> 1157</span>&#160; int16_t setModulationParams(uint8_t sf, uint8_t bw, uint8_t cr, uint8_t ldro);</div>
<div class="line"><a name="l01158"></a><span class="lineno"> 1158</span>&#160; int16_t setModulationParamsFSK(uint32_t br, uint8_t pulseShape, uint8_t rxBw, uint32_t freqDev);</div>
<div class="line"><a name="l01159"></a><span class="lineno"> 1159</span>&#160; int16_t setPacketParams(uint16_t preambleLength, uint8_t crcType, uint8_t payloadLength, uint8_t headerType, uint8_t <a class="code" href="class_s_x126x.html#adab04cbc1125170c6ea16ca5143f3ea5">invertIQ</a> = RADIOLIB_SX126X_LORA_IQ_STANDARD);</div>
<div class="line"><a name="l01159"></a><span class="lineno"> 1159</span>&#160; int16_t setPacketParams(uint16_t preambleLength, uint8_t crcType, uint8_t payloadLength, uint8_t headerType, uint8_t <a class="code" href="class_s_x126x.html#adab04cbc1125170c6ea16ca5143f3ea5">invertIQ</a>);</div>
<div class="line"><a name="l01160"></a><span class="lineno"> 1160</span>&#160; int16_t setPacketParamsFSK(uint16_t preambleLength, uint8_t crcType, uint8_t syncWordLength, uint8_t addrComp, uint8_t whitening, uint8_t packetType = RADIOLIB_SX126X_GFSK_PACKET_VARIABLE, uint8_t payloadLength = 0xFF, uint8_t preambleDetectorLength = RADIOLIB_SX126X_GFSK_PREAMBLE_DETECT_16);</div>
<div class="line"><a name="l01161"></a><span class="lineno"> 1161</span>&#160; int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);</div>
<div class="line"><a name="l01162"></a><span class="lineno"> 1162</span>&#160; int16_t setRegulatorMode(uint8_t mode);</div>
@ -753,18 +753,19 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
<div class="line"><a name="l01205"></a><span class="lineno"> 1205</span>&#160; uint32_t _tcxoDelay = 0;</div>
<div class="line"><a name="l01206"></a><span class="lineno"> 1206</span>&#160; </div>
<div class="line"><a name="l01207"></a><span class="lineno"> 1207</span>&#160; <span class="keywordtype">size_t</span> _implicitLen = 0;</div>
<div class="line"><a name="l01208"></a><span class="lineno"> 1208</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* _chipType;</div>
<div class="line"><a name="l01209"></a><span class="lineno"> 1209</span>&#160; </div>
<div class="line"><a name="l01210"></a><span class="lineno"> 1210</span>&#160; <span class="comment">// Allow subclasses to define different TX modes</span></div>
<div class="line"><a name="l01211"></a><span class="lineno"> 1211</span>&#160; uint8_t _tx_mode = <a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571">Module::MODE_TX</a>;</div>
<div class="line"><a name="l01212"></a><span class="lineno"> 1212</span>&#160; </div>
<div class="line"><a name="l01213"></a><span class="lineno"> 1213</span>&#160; int16_t config(uint8_t modem);</div>
<div class="line"><a name="l01214"></a><span class="lineno"> 1214</span>&#160; <span class="keywordtype">bool</span> findChip(<span class="keyword">const</span> <span class="keywordtype">char</span>* verStr);</div>
<div class="line"><a name="l01215"></a><span class="lineno"> 1215</span>&#160;};</div>
<div class="line"><a name="l01216"></a><span class="lineno"> 1216</span>&#160; </div>
<div class="line"><a name="l01217"></a><span class="lineno"> 1217</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l01218"></a><span class="lineno"> 1218</span>&#160; </div>
<div class="line"><a name="l01219"></a><span class="lineno"> 1219</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l01208"></a><span class="lineno"> 1208</span>&#160; uint8_t _invertIQ = RADIOLIB_SX126X_LORA_IQ_STANDARD;</div>
<div class="line"><a name="l01209"></a><span class="lineno"> 1209</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* _chipType;</div>
<div class="line"><a name="l01210"></a><span class="lineno"> 1210</span>&#160; </div>
<div class="line"><a name="l01211"></a><span class="lineno"> 1211</span>&#160; <span class="comment">// Allow subclasses to define different TX modes</span></div>
<div class="line"><a name="l01212"></a><span class="lineno"> 1212</span>&#160; uint8_t _tx_mode = <a class="code" href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571">Module::MODE_TX</a>;</div>
<div class="line"><a name="l01213"></a><span class="lineno"> 1213</span>&#160; </div>
<div class="line"><a name="l01214"></a><span class="lineno"> 1214</span>&#160; int16_t config(uint8_t modem);</div>
<div class="line"><a name="l01215"></a><span class="lineno"> 1215</span>&#160; <span class="keywordtype">bool</span> findChip(<span class="keyword">const</span> <span class="keywordtype">char</span>* verStr);</div>
<div class="line"><a name="l01216"></a><span class="lineno"> 1216</span>&#160;};</div>
<div class="line"><a name="l01217"></a><span class="lineno"> 1217</span>&#160; </div>
<div class="line"><a name="l01218"></a><span class="lineno"> 1218</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l01219"></a><span class="lineno"> 1219</span>&#160; </div>
<div class="line"><a name="l01220"></a><span class="lineno"> 1220</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level methods to control the wireless module. Every module class contains o...</div><div class="ttdef"><b>Definition:</b> Module.h:28</div></div>
<div class="ttc" id="aclass_module_html_a0c11551e12579bbabf57b19e12555b3c"><div class="ttname"><a href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">Module::RFSWITCH_MAX_PINS</a></div><div class="ttdeci">static const size_t RFSWITCH_MAX_PINS</div><div class="ttdoc">The maximum number of pins supported by the RF switch code.</div><div class="ttdef"><b>Definition:</b> Module.h:39</div></div>
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571">Module::MODE_TX</a></div><div class="ttdeci">@ MODE_TX</div><div class="ttdef"><b>Definition:</b> Module.h:68</div></div>
@ -784,7 +785,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
<div class="ttc" id="aclass_s_x126x_html_a1d8f4deb555844b24c2426dd86e69676"><div class="ttname"><a href="class_s_x126x.html#a1d8f4deb555844b24c2426dd86e69676">SX126x::setDataShaping</a></div><div class="ttdeci">int16_t setDataShaping(uint8_t sh) override</div><div class="ttdoc">Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPI...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:996</div></div>
<div class="ttc" id="aclass_s_x126x_html_a21c263ce1a339faa74c568d9afb81cd2"><div class="ttname"><a href="class_s_x126x.html#a21c263ce1a339faa74c568d9afb81cd2">SX126x::setRegulatorLDO</a></div><div class="ttdeci">int16_t setRegulatorLDO()</div><div class="ttdoc">Set regulator mode to LDO.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1348</div></div>
<div class="ttc" id="aclass_s_x126x_html_a288257242e483cb3eb6944333179dd26"><div class="ttname"><a href="class_s_x126x.html#a288257242e483cb3eb6944333179dd26">SX126x::setRfSwitchPins</a></div><div class="ttdeci">void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE 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:1360</div></div>
<div class="ttc" id="aclass_s_x126x_html_a2af78b744b3e61d3857bed93c3b1bde1"><div class="ttname"><a href="class_s_x126x.html#a2af78b744b3e61d3857bed93c3b1bde1">SX126x::uploadPatch</a></div><div class="ttdeci">int16_t uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)</div><div class="ttdoc">Upload binary patch into the SX126x device RAM. Patch is needed to e.g., enable spectral scan and mus...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1441</div></div>
<div class="ttc" id="aclass_s_x126x_html_a2af78b744b3e61d3857bed93c3b1bde1"><div class="ttname"><a href="class_s_x126x.html#a2af78b744b3e61d3857bed93c3b1bde1">SX126x::uploadPatch</a></div><div class="ttdeci">int16_t uploadPatch(const uint32_t *patch, size_t len, bool nonvolatile=true)</div><div class="ttdoc">Upload binary patch into the SX126x device RAM. Patch is needed to e.g., enable spectral scan and mus...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1442</div></div>
<div class="ttc" id="aclass_s_x126x_html_a2b3eb51117558c58384b03de4b7bfe60"><div class="ttname"><a href="class_s_x126x.html#a2b3eb51117558c58384b03de4b7bfe60">SX126x::setEncoding</a></div><div class="ttdeci">int16_t setEncoding(uint8_t encoding) override</div><div class="ttdoc">Sets transmission encoding. Available in FSK mode only. Serves only as alias for PhysicalLayer compat...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1356</div></div>
<div class="ttc" id="aclass_s_x126x_html_a2e500e5b6044ccab8f6b19af4ffa917c"><div class="ttname"><a href="class_s_x126x.html#a2e500e5b6044ccab8f6b19af4ffa917c">SX126x::beginFSK</a></div><div class="ttdeci">int16_t beginFSK(float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)</div><div class="ttdoc">Initialization method for FSK modem.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:95</div></div>
<div class="ttc" id="aclass_s_x126x_html_a2f60df59c80241d98ce078c0417a7f08"><div class="ttname"><a href="class_s_x126x.html#a2f60df59c80241d98ce078c0417a7f08">SX126x::setBandwidth</a></div><div class="ttdeci">int16_t setBandwidth(float bw)</div><div class="ttdoc">Sets LoRa bandwidth. Allowed values are 7.8, 10.4, 15.6, 20.8, 31.25, 41.7, 62.5, 125....</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:731</div></div>
@ -793,8 +794,8 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
<div class="ttc" id="aclass_s_x126x_html_a420c23bb1861646e29f44c0f4c646ee8"><div class="ttname"><a href="class_s_x126x.html#a420c23bb1861646e29f44c0f4c646ee8">SX126x::forceLDRO</a></div><div class="ttdeci">int16_t forceLDRO(bool enable)</div><div class="ttdoc">Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method,...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1368</div></div>
<div class="ttc" id="aclass_s_x126x_html_a492b2d057dd803c3884fa1adc8e22534"><div class="ttname"><a href="class_s_x126x.html#a492b2d057dd803c3884fa1adc8e22534">SX126x::transmit</a></div><div class="ttdeci">int16_t transmit(const char *str, uint8_t addr=0)</div><div class="ttdoc">C-string transmit method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:51</div></div>
<div class="ttc" id="aclass_s_x126x_html_a514cabe74bbe3434d7e4f244c4077752"><div class="ttname"><a href="class_s_x126x.html#a514cabe74bbe3434d7e4f244c4077752">SX126x::setNodeAddress</a></div><div class="ttdeci">int16_t setNodeAddress(uint8_t nodeAddr)</div><div class="ttdoc">Sets node address. Calling this method will also enable address filtering for node address only.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1076</div></div>
<div class="ttc" id="aclass_s_x126x_html_a5595fff99d76d50d711b8cdad98527c4"><div class="ttname"><a href="class_s_x126x.html#a5595fff99d76d50d711b8cdad98527c4">SX126x::spectralScanGetStatus</a></div><div class="ttdeci">int16_t spectralScanGetStatus()</div><div class="ttdoc">Read the status of spectral scan.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1508</div></div>
<div class="ttc" id="aclass_s_x126x_html_a57bee6f4b3a3b7ec646ac8de347ee0d6"><div class="ttname"><a href="class_s_x126x.html#a57bee6f4b3a3b7ec646ac8de347ee0d6">SX126x::setTCXO</a></div><div class="ttdeci">int16_t setTCXO(float voltage, uint32_t delay=5000)</div><div class="ttdoc">Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1528</div></div>
<div class="ttc" id="aclass_s_x126x_html_a5595fff99d76d50d711b8cdad98527c4"><div class="ttname"><a href="class_s_x126x.html#a5595fff99d76d50d711b8cdad98527c4">SX126x::spectralScanGetStatus</a></div><div class="ttdeci">int16_t spectralScanGetStatus()</div><div class="ttdoc">Read the status of spectral scan.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1509</div></div>
<div class="ttc" id="aclass_s_x126x_html_a57bee6f4b3a3b7ec646ac8de347ee0d6"><div class="ttname"><a href="class_s_x126x.html#a57bee6f4b3a3b7ec646ac8de347ee0d6">SX126x::setTCXO</a></div><div class="ttdeci">int16_t setTCXO(float voltage, uint32_t delay=5000)</div><div class="ttdoc">Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1529</div></div>
<div class="ttc" id="aclass_s_x126x_html_a59d443c02d4620cda32c63a00c6bcc22"><div class="ttname"><a href="class_s_x126x.html#a59d443c02d4620cda32c63a00c6bcc22">SX126x::setRxBandwidth</a></div><div class="ttdeci">int16_t setRxBandwidth(float rxBw)</div><div class="ttdoc">Sets FSK receiver bandwidth. Allowed values are 4.8, 5.8, 7.3, 9.7, 11.7, 14.6, 19....</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:896</div></div>
<div class="ttc" id="aclass_s_x126x_html_a5ae69309ca0cf5f13c60f2d162916ff8"><div class="ttname"><a href="class_s_x126x.html#a5ae69309ca0cf5f13c60f2d162916ff8">SX126x::setRegulatorDCDC</a></div><div class="ttdeci">int16_t setRegulatorDCDC()</div><div class="ttdoc">Set regulator mode to DC-DC.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1352</div></div>
<div class="ttc" id="aclass_s_x126x_html_a5b4f8a41b593436b8c7a2a2d46ac387e"><div class="ttname"><a href="class_s_x126x.html#a5b4f8a41b593436b8c7a2a2d46ac387e">SX126x::startReceiveDutyCycle</a></div><div class="ttdeci">int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod, uint16_t irqFlags=RADIOLIB_SX126X_IRQ_RX_DEFAULT, uint16_t irqMask=RADIOLIB_SX126X_IRQ_RX_DONE)</div><div class="ttdoc">Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen....</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:549</div></div>
@ -806,9 +807,9 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
<div class="ttc" id="aclass_s_x126x_html_a7deeef45d7f64a4018a3e56aaea4eb0e"><div class="ttname"><a href="class_s_x126x.html#a7deeef45d7f64a4018a3e56aaea4eb0e">SX126x::setBitRate</a></div><div class="ttdeci">int16_t setBitRate(float br)</div><div class="ttdoc">Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:878</div></div>
<div class="ttc" id="aclass_s_x126x_html_a7e342ddbef84cf845bef8f4448b8da10"><div class="ttname"><a href="class_s_x126x.html#a7e342ddbef84cf845bef8f4448b8da10">SX126x::getTimeOnAir</a></div><div class="ttdeci">uint32_t getTimeOnAir(size_t len)</div><div class="ttdoc">Get expected time-on-air for a given size of payload.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1305</div></div>
<div class="ttc" id="aclass_s_x126x_html_a819bb3ced0f184a63cbfbef408a68561"><div class="ttname"><a href="class_s_x126x.html#a819bb3ced0f184a63cbfbef408a68561">SX126x::randomByte</a></div><div class="ttdeci">uint8_t randomByte()</div><div class="ttdoc">Get one truly random byte from RSSI noise.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1389</div></div>
<div class="ttc" id="aclass_s_x126x_html_a865397e1cca38bec2d055c047825ea07"><div class="ttname"><a href="class_s_x126x.html#a865397e1cca38bec2d055c047825ea07">SX126x::spectralScanAbort</a></div><div class="ttdeci">void spectralScanAbort()</div><div class="ttdoc">Abort an ongoing spectral scan.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1504</div></div>
<div class="ttc" id="aclass_s_x126x_html_a865397e1cca38bec2d055c047825ea07"><div class="ttname"><a href="class_s_x126x.html#a865397e1cca38bec2d055c047825ea07">SX126x::spectralScanAbort</a></div><div class="ttdeci">void spectralScanAbort()</div><div class="ttdoc">Abort an ongoing spectral scan.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1505</div></div>
<div class="ttc" id="aclass_s_x126x_html_a8a18aee2bf05793aa29b5cf6b47bb435"><div class="ttname"><a href="class_s_x126x.html#a8a18aee2bf05793aa29b5cf6b47bb435">SX126x::receiveDirect</a></div><div class="ttdeci">int16_t receiveDirect() override</div><div class="ttdoc">Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:342</div></div>
<div class="ttc" id="aclass_s_x126x_html_a8a3ad4e12df862ab18b326d9dba26d66"><div class="ttname"><a href="class_s_x126x.html#a8a3ad4e12df862ab18b326d9dba26d66">SX126x::spectralScanStart</a></div><div class="ttdeci">int16_t spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)</div><div class="ttdoc">Start spectral scan. Requires binary path to be uploaded.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1488</div></div>
<div class="ttc" id="aclass_s_x126x_html_a8a3ad4e12df862ab18b326d9dba26d66"><div class="ttname"><a href="class_s_x126x.html#a8a3ad4e12df862ab18b326d9dba26d66">SX126x::spectralScanStart</a></div><div class="ttdeci">int16_t spectralScanStart(uint16_t numSamples, uint8_t window=RADIOLIB_SX126X_SPECTRAL_SCAN_WINDOW_DEFAULT, uint8_t interval=RADIOLIB_SX126X_SCAN_INTERVAL_8_20_US)</div><div class="ttdoc">Start spectral scan. Requires binary path to be uploaded.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1489</div></div>
<div class="ttc" id="aclass_s_x126x_html_a8e22d67b64953c8b4da779d87d563f3e"><div class="ttname"><a href="class_s_x126x.html#a8e22d67b64953c8b4da779d87d563f3e">SX126x::finishTransmit</a></div><div class="ttdeci">int16_t finishTransmit() override</div><div class="ttdoc">Clean up after transmission is done.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:527</div></div>
<div class="ttc" id="aclass_s_x126x_html_a8f971dca834be7e0470a9a9f0c01854e"><div class="ttname"><a href="class_s_x126x.html#a8f971dca834be7e0470a9a9f0c01854e">SX126x::setCurrentLimit</a></div><div class="ttdeci">int16_t setCurrentLimit(float currentLimit)</div><div class="ttdoc">Sets current protection limit. Can be set in 2.5 mA steps.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:819</div></div>
<div class="ttc" id="aclass_s_x126x_html_a920aa76ff5f0f579424ef6de92e588c8"><div class="ttname"><a href="class_s_x126x.html#a920aa76ff5f0f579424ef6de92e588c8">SX126x::setRxBoostedGainMode</a></div><div class="ttdeci">int16_t setRxBoostedGainMode(bool rxbgm, bool persist=true)</div><div class="ttdoc">Enables or disables Rx Boosted Gain mode as described in SX126x datasheet section 9....</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:959</div></div>
@ -817,7 +818,7 @@ $(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:1301</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:13</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:1121</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:1684</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:1685</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:189</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:808</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:832</div></div>
@ -825,7 +826,7 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
<div class="ttc" id="aclass_s_x126x_html_ab00f765bbfbfaa8c693532ea3a90c29b"><div class="ttname"><a href="class_s_x126x.html#ab00f765bbfbfaa8c693532ea3a90c29b">SX126x::setPreambleLength</a></div><div class="ttdeci">int16_t setPreambleLength(uint16_t preambleLength)</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:841</div></div>
<div class="ttc" id="aclass_s_x126x_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_s_x126x.html#ab82617fa3fa9f21d4cd427314ecc4af8">SX126x::receive</a></div><div class="ttdeci">virtual int16_t receive(uint8_t *data, size_t len)</div><div class="ttdoc">Binary receive method. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:111</div></div>
<div class="ttc" id="aclass_s_x126x_html_ab9ce38cfeaa36ddcc2d82b2974d7088c"><div class="ttname"><a href="class_s_x126x.html#ab9ce38cfeaa36ddcc2d82b2974d7088c">SX126x::autoLDRO</a></div><div class="ttdeci">int16_t autoLDRO()</div><div class="ttdoc">Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method,...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1380</div></div>
<div class="ttc" id="aclass_s_x126x_html_abbf8b4623da8c2caa83a8c3d35a44d0a"><div class="ttname"><a href="class_s_x126x.html#abbf8b4623da8c2caa83a8c3d35a44d0a">SX126x::setDirectAction</a></div><div class="ttdeci">void setDirectAction(void(*func)(void))</div><div class="ttdoc">Set interrupt service routine function to call when data bit is receveid in direct mode.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1432</div></div>
<div class="ttc" id="aclass_s_x126x_html_abbf8b4623da8c2caa83a8c3d35a44d0a"><div class="ttname"><a href="class_s_x126x.html#abbf8b4623da8c2caa83a8c3d35a44d0a">SX126x::setDirectAction</a></div><div class="ttdeci">void setDirectAction(void(*func)(void))</div><div class="ttdoc">Set interrupt service routine function to call when data bit is receveid in direct mode.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1433</div></div>
<div class="ttc" id="aclass_s_x126x_html_abc3a4f9213b2a7052e97c2e3a0bf45a5"><div class="ttname"><a href="class_s_x126x.html#abc3a4f9213b2a7052e97c2e3a0bf45a5">SX126x::fixedPacketLengthMode</a></div><div class="ttdeci">int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SX126X_MAX_PACKET_LENGTH)</div><div class="ttdoc">Set modem in fixed packet length mode. Available in FSK mode only.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1297</div></div>
<div class="ttc" id="aclass_s_x126x_html_abd8eea7e468db3d6064c19d4934d5034"><div class="ttname"><a href="class_s_x126x.html#abd8eea7e468db3d6064c19d4934d5034">SX126x::setBroadcastAddress</a></div><div class="ttdeci">int16_t setBroadcastAddress(uint8_t broadAddr)</div><div class="ttdoc">Sets broadcast address. Calling this method will also enable address filtering for node and broadcast...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1093</div></div>
<div class="ttc" id="aclass_s_x126x_html_abf1c3d6fa419a1e3ef11db63d3f46f8f"><div class="ttname"><a href="class_s_x126x.html#abf1c3d6fa419a1e3ef11db63d3f46f8f">SX126x::getChannelScanResult</a></div><div class="ttdeci">int16_t getChannelScanResult()</div><div class="ttdoc">Read the channel scan result.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:710</div></div>
@ -837,12 +838,12 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
<div class="ttc" id="aclass_s_x126x_html_adab04cbc1125170c6ea16ca5143f3ea5"><div class="ttname"><a href="class_s_x126x.html#adab04cbc1125170c6ea16ca5143f3ea5">SX126x::invertIQ</a></div><div class="ttdeci">int16_t invertIQ(bool invertIQ)</div><div class="ttdoc">Enable/disable inversion of the I and Q signals.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1418</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:1340</div></div>
<div class="ttc" id="aclass_s_x126x_html_ae36823d3539667bdf7d2f073bd4fa1ca"><div class="ttname"><a href="class_s_x126x.html#ae36823d3539667bdf7d2f073bd4fa1ca">SX126x::getSNR</a></div><div class="ttdeci">float getSNR()</div><div class="ttdoc">Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1235</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:1581</div></div>
<div class="ttc" id="aclass_s_x126x_html_ae473773e5bed4b08452e80311bdb26f2"><div class="ttname"><a href="class_s_x126x.html#ae473773e5bed4b08452e80311bdb26f2">SX126x::spectralScanGetResult</a></div><div class="ttdeci">int16_t spectralScanGetResult(uint16_t *results)</div><div class="ttdoc">Read the result of spectral scan.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1516</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:1582</div></div>
<div class="ttc" id="aclass_s_x126x_html_ae473773e5bed4b08452e80311bdb26f2"><div class="ttname"><a href="class_s_x126x.html#ae473773e5bed4b08452e80311bdb26f2">SX126x::spectralScanGetResult</a></div><div class="ttdeci">int16_t spectralScanGetResult(uint16_t *results)</div><div class="ttdoc">Read the result of spectral scan.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1517</div></div>
<div class="ttc" id="aclass_s_x126x_html_ae5993359ace652fbdc862eb23fdd263d"><div class="ttname"><a href="class_s_x126x.html#ae5993359ace652fbdc862eb23fdd263d">SX126x::setSpreadingFactor</a></div><div class="ttdeci">int16_t setSpreadingFactor(uint8_t sf)</div><div class="ttdoc">Sets LoRa spreading factor. Allowed values range from 5 to 12.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:782</div></div>
<div class="ttc" id="aclass_s_x126x_html_afc3a7a42c401b6c44e00cb6c5b9696f2"><div class="ttname"><a href="class_s_x126x.html#afc3a7a42c401b6c44e00cb6c5b9696f2">SX126x::disableAddressFiltering</a></div><div class="ttdeci">int16_t disableAddressFiltering()</div><div class="ttdoc">Disables address filtering. Calling this method will also erase previously set addresses.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1110</div></div>
<div class="ttc" id="aclass_s_x126x_html_afd3113858966e878e9c67a1e710bd586"><div class="ttname"><a href="class_s_x126x.html#afd3113858966e878e9c67a1e710bd586">SX126x::setCodingRate</a></div><div class="ttdeci">int16_t setCodingRate(uint8_t cr)</div><div class="ttdoc">Sets LoRa coding rate denominator. Allowed values range from 5 to 8.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:795</div></div>
<div class="ttc" id="aclass_s_x126x_html_aff80db65e546934980feac7e6c81dd80"><div class="ttname"><a href="class_s_x126x.html#aff80db65e546934980feac7e6c81dd80">SX126x::readBit</a></div><div class="ttdeci">void readBit(RADIOLIB_PIN_TYPE pin)</div><div class="ttdoc">Function to read and process data bit in direct reception mode.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1436</div></div>
<div class="ttc" id="aclass_s_x126x_html_aff80db65e546934980feac7e6c81dd80"><div class="ttname"><a href="class_s_x126x.html#aff80db65e546934980feac7e6c81dd80">SX126x::readBit</a></div><div class="ttdeci">void readBit(RADIOLIB_PIN_TYPE pin)</div><div class="ttdoc">Function to read and process data bit in direct reception mode.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1437</div></div>
<div class="ttc" id="astruct_module_1_1_rf_switch_mode__t_html"><div class="ttname"><a href="struct_module_1_1_rf_switch_mode__t.html">Module::RfSwitchMode_t</a></div><div class="ttdef"><b>Definition:</b> Module.h:46</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->