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

Deploying to gh-pages from @ 2125dfe276 🚀

Browse source
This commit is contained in:
jgromes 2021-09-26 15:46:19 +00:00
parent eadc58f9ee
commit 1fd795341b
3 changed files with 50 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
_physical_layer_8h_source.html
View file

@ -174,11 +174,12 @@ $(document).ready(function(){initNavTree('_physical_layer_8h_source.html',''); i
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>&#160; uint8_t _buffer[RADIOLIB_STATIC_ARRAY_SIZE];</div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span>&#160; uint32_t _syncBuffer;</div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160; uint32_t _directSyncWord;</div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160; uint32_t _directSyncWordMask;</div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span>&#160; <span class="keywordtype">bool</span> _gotSync;</div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span>&#160;};</div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span>&#160; </div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160; uint8_t _directSyncWordLen;</div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span>&#160; uint32_t _directSyncWordMask;</div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span>&#160; <span class="keywordtype">bool</span> _gotSync;</div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span>&#160;};</div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160; </div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclass_physical_layer_html_ab139a34e03a6fd5a781cd54da21d308f"><div class="ttname"><a href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">PhysicalLayer::transmit</a></div><div class="ttdeci">int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)</div><div class="ttdoc">Arduino Flash String transmit method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:10</div></div>
@ -199,7 +200,7 @@ $(document).ready(function(){initNavTree('_physical_layer_8h_source.html',''); i
<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:14</div></div>
<div class="ttc" id="aclass_physical_layer_html_afb1b090348d9091bfa3a0b5ba3d85b36"><div class="ttname"><a href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">PhysicalLayer::receive</a></div><div class="ttdeci">int16_t receive(String &amp;str, size_t len=0)</div><div class="ttdoc">Arduino String receive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:100</div></div>
<div class="ttc" id="aclass_physical_layer_html_a0bd6046e068ef63e3f2b6bead48e02a7"><div class="ttname"><a href="class_physical_layer.html#a0bd6046e068ef63e3f2b6bead48e02a7">PhysicalLayer::getPacketLength</a></div><div class="ttdeci">virtual size_t getPacketLength(bool update=true)=0</div><div class="ttdoc">Query modem for the packet length of received payload. Must be implemented in module class.</div></div>
<div class="ttc" id="aclass_physical_layer_html_a8e378fe136a498ea485a9c10f5e15aab"><div class="ttname"><a href="class_physical_layer.html#a8e378fe136a498ea485a9c10f5e15aab">PhysicalLayer::setDirectSyncWord</a></div><div class="ttdeci">int16_t setDirectSyncWord(uint32_t syncWord, uint8_t len)</div><div class="ttdoc">Set sync word to be used to determine start of packet in direct reception mode.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:202</div></div>
<div class="ttc" id="aclass_physical_layer_html_a8e378fe136a498ea485a9c10f5e15aab"><div class="ttname"><a href="class_physical_layer.html#a8e378fe136a498ea485a9c10f5e15aab">PhysicalLayer::setDirectSyncWord</a></div><div class="ttdeci">int16_t setDirectSyncWord(uint32_t syncWord, uint8_t len)</div><div class="ttdoc">Set sync word to be used to determine start of packet in direct reception mode.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:204</div></div>
<div class="ttc" id="aclass_physical_layer_html_a977e5236693960bb1c79090a201e9e1c"><div class="ttname"><a href="class_physical_layer.html#a977e5236693960bb1c79090a201e9e1c">PhysicalLayer::getFreqStep</a></div><div class="ttdeci">float getFreqStep() const</div><div class="ttdoc">Gets the module frequency step size that was set in constructor.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:145</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab643a814dce48f71a13bf6ea23f44cbd"><div class="ttname"><a href="class_physical_layer.html#ab643a814dce48f71a13bf6ea23f44cbd">PhysicalLayer::setDataShaping</a></div><div class="ttdeci">virtual int16_t setDataShaping(uint8_t sh)=0</div><div class="ttdoc">Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class.</div></div>
<div class="ttc" id="aclass_physical_layer_html_af068e6e862c99e39d0261a7971dd56db"><div class="ttname"><a href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(String &amp;str, uint8_t addr=0)</div><div class="ttdoc">Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:51</div></div>

84
_s_x127x_8h_source.html
View file

@ -799,64 +799,64 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclass_physical_layer_html_ab139a34e03a6fd5a781cd54da21d308f"><div class="ttname"><a href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">PhysicalLayer::transmit</a></div><div class="ttdeci">int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)</div><div class="ttdoc">Arduino Flash String transmit method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:10</div></div>
<div class="ttc" id="aclass_s_x127x_html_ab99630d50672b43fc7162ba8f3293f95"><div class="ttname"><a href="class_s_x127x.html#ab99630d50672b43fc7162ba8f3293f95">SX127x::setNodeAddress</a></div><div class="ttdeci">int16_t setNodeAddress(uint8_t nodeAddr)</div><div class="ttdoc">Sets FSK node address. Calling this method will enable address filtering. Only available in FSK mode.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:862</div></div>
<div class="ttc" id="aclass_s_x127x_html_a95bc32a555675879ad9e2a9e399dc6c1"><div class="ttname"><a href="class_s_x127x.html#a95bc32a555675879ad9e2a9e399dc6c1">SX127x::getTempRaw</a></div><div class="ttdeci">int8_t getTempRaw()</div><div class="ttdoc">Reads uncalibrated temperature value. This function will change operating mode and should not be call...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1102</div></div>
<div class="ttc" id="aclass_s_x127x_html_a9f753c0857e7b8b4b9f7f6e91c77f0fd"><div class="ttname"><a href="class_s_x127x.html#a9f753c0857e7b8b4b9f7f6e91c77f0fd">SX127x::variablePacketLengthMode</a></div><div class="ttdeci">int16_t variablePacketLengthMode(uint8_t maxLen=SX127X_MAX_PACKET_LENGTH_FSK)</div><div class="ttdoc">Set modem in variable packet length mode. Available in FSK mode only.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:998</div></div>
<div class="ttc" id="aclass_s_x127x_html_a1f6c61b16a39a2bbb5b94b3685caae04"><div class="ttname"><a href="class_s_x127x.html#a1f6c61b16a39a2bbb5b94b3685caae04">SX127x::invertIQ</a></div><div class="ttdeci">int16_t invertIQ(bool invertIQ)</div><div class="ttdoc">Enables/disables Invert the LoRa I and Q signals.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1291</div></div>
<div class="ttc" id="aclass_s_x127x_html_ab0f67330124cefc07a462e77922453d0"><div class="ttname"><a href="class_s_x127x.html#ab0f67330124cefc07a462e77922453d0">SX127x::setAFCAGCTrigger</a></div><div class="ttdeci">int16_t setAFCAGCTrigger(uint8_t trigger)</div><div class="ttdoc">Controls trigger of AFC and AGC.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:828</div></div>
<div class="ttc" id="aclass_s_x127x_html_abad2d455012bd28d304589c8164390eb"><div class="ttname"><a href="class_s_x127x.html#abad2d455012bd28d304589c8164390eb">SX127x::setEncoding</a></div><div class="ttdeci">int16_t setEncoding(uint8_t encoding) override</div><div class="ttdoc">Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ,...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1025</div></div>
<div class="ttc" id="aclass_s_x127x_html_afc844f7f3530f4076c8ea5f684c1b123"><div class="ttname"><a href="class_s_x127x.html#afc844f7f3530f4076c8ea5f684c1b123">SX127x::setDio1Action</a></div><div class="ttdeci">void setDio1Action(void(*func)(void))</div><div class="ttdoc">Set interrupt service routine function to call when DIO1 activates.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:430</div></div>
<div class="ttc" id="aclass_s_x127x_html_a071442611a32154e8b3db7981f242a53"><div class="ttname"><a href="class_s_x127x.html#a071442611a32154e8b3db7981f242a53">SX127x::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> SX127x.cpp:1315</div></div>
<div class="ttc" id="aclass_s_x127x_html_aa3f409359eafa5988e8e4c2948735238"><div class="ttname"><a href="class_s_x127x.html#aa3f409359eafa5988e8e4c2948735238">SX127x::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> SX127x.cpp:1311</div></div>
<div class="ttc" id="aclass_s_x127x_html_ab99630d50672b43fc7162ba8f3293f95"><div class="ttname"><a href="class_s_x127x.html#ab99630d50672b43fc7162ba8f3293f95">SX127x::setNodeAddress</a></div><div class="ttdeci">int16_t setNodeAddress(uint8_t nodeAddr)</div><div class="ttdoc">Sets FSK node address. Calling this method will enable address filtering. Only available in FSK mode.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:866</div></div>
<div class="ttc" id="aclass_s_x127x_html_a95bc32a555675879ad9e2a9e399dc6c1"><div class="ttname"><a href="class_s_x127x.html#a95bc32a555675879ad9e2a9e399dc6c1">SX127x::getTempRaw</a></div><div class="ttdeci">int8_t getTempRaw()</div><div class="ttdoc">Reads uncalibrated temperature value. This function will change operating mode and should not be call...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1106</div></div>
<div class="ttc" id="aclass_s_x127x_html_a9f753c0857e7b8b4b9f7f6e91c77f0fd"><div class="ttname"><a href="class_s_x127x.html#a9f753c0857e7b8b4b9f7f6e91c77f0fd">SX127x::variablePacketLengthMode</a></div><div class="ttdeci">int16_t variablePacketLengthMode(uint8_t maxLen=SX127X_MAX_PACKET_LENGTH_FSK)</div><div class="ttdoc">Set modem in variable packet length mode. Available in FSK mode only.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1002</div></div>
<div class="ttc" id="aclass_s_x127x_html_a1f6c61b16a39a2bbb5b94b3685caae04"><div class="ttname"><a href="class_s_x127x.html#a1f6c61b16a39a2bbb5b94b3685caae04">SX127x::invertIQ</a></div><div class="ttdeci">int16_t invertIQ(bool invertIQ)</div><div class="ttdoc">Enables/disables Invert the LoRa I and Q signals.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1295</div></div>
<div class="ttc" id="aclass_s_x127x_html_ab0f67330124cefc07a462e77922453d0"><div class="ttname"><a href="class_s_x127x.html#ab0f67330124cefc07a462e77922453d0">SX127x::setAFCAGCTrigger</a></div><div class="ttdeci">int16_t setAFCAGCTrigger(uint8_t trigger)</div><div class="ttdoc">Controls trigger of AFC and AGC.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:832</div></div>
<div class="ttc" id="aclass_s_x127x_html_abad2d455012bd28d304589c8164390eb"><div class="ttname"><a href="class_s_x127x.html#abad2d455012bd28d304589c8164390eb">SX127x::setEncoding</a></div><div class="ttdeci">int16_t setEncoding(uint8_t encoding) override</div><div class="ttdoc">Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ,...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1029</div></div>
<div class="ttc" id="aclass_s_x127x_html_afc844f7f3530f4076c8ea5f684c1b123"><div class="ttname"><a href="class_s_x127x.html#afc844f7f3530f4076c8ea5f684c1b123">SX127x::setDio1Action</a></div><div class="ttdeci">void setDio1Action(void(*func)(void))</div><div class="ttdoc">Set interrupt service routine function to call when DIO1 activates.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:434</div></div>
<div class="ttc" id="aclass_s_x127x_html_a071442611a32154e8b3db7981f242a53"><div class="ttname"><a href="class_s_x127x.html#a071442611a32154e8b3db7981f242a53">SX127x::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> SX127x.cpp:1319</div></div>
<div class="ttc" id="aclass_s_x127x_html_aa3f409359eafa5988e8e4c2948735238"><div class="ttname"><a href="class_s_x127x.html#aa3f409359eafa5988e8e4c2948735238">SX127x::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> SX127x.cpp:1315</div></div>
<div class="ttc" id="aclass_s_x127x_html_a44501ec8f8ac6084467b94516b1337df"><div class="ttname"><a href="class_s_x127x.html#a44501ec8f8ac6084467b94516b1337df">SX127x::sleep</a></div><div class="ttdeci">int16_t sleep()</div><div class="ttdoc">Sets the LoRa module to sleep to save power. Module will not be able to transmit or receive any data ...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:288</div></div>
<div class="ttc" id="aclass_s_x127x_html_afe8456d0f9abbce4d743f256f3e1e6c6"><div class="ttname"><a href="class_s_x127x.html#afe8456d0f9abbce4d743f256f3e1e6c6">SX127x::startReceive</a></div><div class="ttdeci">int16_t startReceive(uint8_t len=0, uint8_t mode=SX127X_RXCONTINUOUS)</div><div class="ttdoc">Interrupt-driven receive method. DIO0 will be activated when full valid packet is received.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:375</div></div>
<div class="ttc" id="aclass_s_x127x_html_abfc840e8d6fe5e222f0143be17876745"><div class="ttname"><a href="class_s_x127x.html#abfc840e8d6fe5e222f0143be17876745">SX127x::readData</a></div><div class="ttdeci">int16_t readData(uint8_t *data, size_t len) override</div><div class="ttdoc">Reads data that was received after calling startReceive method. This method reads len characters.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:508</div></div>
<div class="ttc" id="aclass_s_x127x_html_a41f8cfcc2cdeb25a8e5a03f1ba4edd1e"><div class="ttname"><a href="class_s_x127x.html#a41f8cfcc2cdeb25a8e5a03f1ba4edd1e">SX127x::setAFC</a></div><div class="ttdeci">int16_t setAFC(bool isEnabled)</div><div class="ttdoc">Enables or disables FSK automatic frequency correction(AFC)</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:818</div></div>
<div class="ttc" id="aclass_s_x127x_html_a9b6532a25e1730973ac08146008adca5"><div class="ttname"><a href="class_s_x127x.html#a9b6532a25e1730973ac08146008adca5">SX127x::clearDio1Action</a></div><div class="ttdeci">void clearDio1Action()</div><div class="ttdoc">Clears interrupt service routine to call when DIO1 activates.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:437</div></div>
<div class="ttc" id="aclass_s_x127x_html_ac5c7f4584352a12390594395d9c29bde"><div class="ttname"><a href="class_s_x127x.html#ac5c7f4584352a12390594395d9c29bde">SX127x::setSyncWord</a></div><div class="ttdeci">int16_t setSyncWord(uint8_t syncWord)</div><div class="ttdoc">Sets LoRa sync word. Only available in LoRa mode.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:565</div></div>
<div class="ttc" id="aclass_s_x127x_html_afe8456d0f9abbce4d743f256f3e1e6c6"><div class="ttname"><a href="class_s_x127x.html#afe8456d0f9abbce4d743f256f3e1e6c6">SX127x::startReceive</a></div><div class="ttdeci">int16_t startReceive(uint8_t len=0, uint8_t mode=SX127X_RXCONTINUOUS)</div><div class="ttdoc">Interrupt-driven receive method. DIO0 will be activated when full valid packet is received.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:379</div></div>
<div class="ttc" id="aclass_s_x127x_html_abfc840e8d6fe5e222f0143be17876745"><div class="ttname"><a href="class_s_x127x.html#abfc840e8d6fe5e222f0143be17876745">SX127x::readData</a></div><div class="ttdeci">int16_t readData(uint8_t *data, size_t len) override</div><div class="ttdoc">Reads data that was received after calling startReceive method. This method reads len characters.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:512</div></div>
<div class="ttc" id="aclass_s_x127x_html_a41f8cfcc2cdeb25a8e5a03f1ba4edd1e"><div class="ttname"><a href="class_s_x127x.html#a41f8cfcc2cdeb25a8e5a03f1ba4edd1e">SX127x::setAFC</a></div><div class="ttdeci">int16_t setAFC(bool isEnabled)</div><div class="ttdoc">Enables or disables FSK automatic frequency correction(AFC)</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:822</div></div>
<div class="ttc" id="aclass_s_x127x_html_a9b6532a25e1730973ac08146008adca5"><div class="ttname"><a href="class_s_x127x.html#a9b6532a25e1730973ac08146008adca5">SX127x::clearDio1Action</a></div><div class="ttdeci">void clearDio1Action()</div><div class="ttdoc">Clears interrupt service routine to call when DIO1 activates.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:441</div></div>
<div class="ttc" id="aclass_s_x127x_html_ac5c7f4584352a12390594395d9c29bde"><div class="ttname"><a href="class_s_x127x.html#ac5c7f4584352a12390594395d9c29bde">SX127x::setSyncWord</a></div><div class="ttdeci">int16_t setSyncWord(uint8_t syncWord)</div><div class="ttdoc">Sets LoRa sync word. Only available in LoRa mode.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:569</div></div>
<div class="ttc" id="aclass_physical_layer_html_ae8eed0e888a7c8742e89d2b850977de2"><div class="ttname"><a href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">PhysicalLayer::readData</a></div><div class="ttdeci">int16_t readData(String &amp;str, size_t len=0)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:59</div></div>
<div class="ttc" id="aclass_s_x127x_html_add78edb65673d9e88931a55b0672a9f3"><div class="ttname"><a href="class_s_x127x.html#add78edb65673d9e88931a55b0672a9f3">SX127x::beginFSK</a></div><div class="ttdeci">int16_t beginFSK(uint8_t chipVersion, float br, float freqDev, float rxBw, uint16_t preambleLength, bool enableOOK)</div><div class="ttdoc">Initialization method for FSK modem. Will be called with appropriate parameters when calling FSK init...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:55</div></div>
<div class="ttc" id="aclass_s_x127x_html_aa7ac558d537c6364c4bc82c8f33e398f"><div class="ttname"><a href="class_s_x127x.html#aa7ac558d537c6364c4bc82c8f33e398f">SX127x::receiveDirect</a></div><div class="ttdeci">int16_t receiveDirect() override</div><div class="ttdoc">Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). While in direct mode,...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:333</div></div>
<div class="ttc" id="aclass_s_x127x_html_ada53419d65f207f352124da7747c5960"><div class="ttname"><a href="class_s_x127x.html#ada53419d65f207f352124da7747c5960">SX127x::setDio0Action</a></div><div class="ttdeci">void setDio0Action(void(*func)(void))</div><div class="ttdoc">Set interrupt service routine function to call when DIO0 activates.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:422</div></div>
<div class="ttc" id="aclass_s_x127x_html_a448ea8a6a6011a9cdddd4e09bd6c9679"><div class="ttname"><a href="class_s_x127x.html#a448ea8a6a6011a9cdddd4e09bd6c9679">SX127x::setFrequencyDeviation</a></div><div class="ttdeci">int16_t setFrequencyDeviation(float freqDev) override</div><div class="ttdoc">Sets FSK frequency deviation from carrier frequency. Allowed values depend on bit rate setting and mu...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:744</div></div>
<div class="ttc" id="aclass_s_x127x_html_adc25b685de0859b799488bf7729350b6"><div class="ttname"><a href="class_s_x127x.html#adc25b685de0859b799488bf7729350b6">SX127x::getDataRate</a></div><div class="ttdeci">float getDataRate() const</div><div class="ttdoc">Get data rate of the latest transmitted packet.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:711</div></div>
<div class="ttc" id="aclass_s_x127x_html_ada53419d65f207f352124da7747c5960"><div class="ttname"><a href="class_s_x127x.html#ada53419d65f207f352124da7747c5960">SX127x::setDio0Action</a></div><div class="ttdeci">void setDio0Action(void(*func)(void))</div><div class="ttdoc">Set interrupt service routine function to call when DIO0 activates.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:426</div></div>
<div class="ttc" id="aclass_s_x127x_html_a448ea8a6a6011a9cdddd4e09bd6c9679"><div class="ttname"><a href="class_s_x127x.html#a448ea8a6a6011a9cdddd4e09bd6c9679">SX127x::setFrequencyDeviation</a></div><div class="ttdeci">int16_t setFrequencyDeviation(float freqDev) override</div><div class="ttdoc">Sets FSK frequency deviation from carrier frequency. Allowed values depend on bit rate setting and mu...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:748</div></div>
<div class="ttc" id="aclass_s_x127x_html_adc25b685de0859b799488bf7729350b6"><div class="ttname"><a href="class_s_x127x.html#adc25b685de0859b799488bf7729350b6">SX127x::getDataRate</a></div><div class="ttdeci">float getDataRate() const</div><div class="ttdoc">Get data rate of the latest transmitted packet.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:715</div></div>
<div class="ttc" id="aclass_s_x127x_html_a9c4ea3285922bf01cebd2c8a706d9a29"><div class="ttname"><a href="class_s_x127x.html#a9c4ea3285922bf01cebd2c8a706d9a29">SX127x::transmit</a></div><div class="ttdeci">int16_t transmit(uint8_t *data, size_t len, uint8_t addr=0) override</div><div class="ttdoc">Binary transmit method. Will transmit arbitrary binary data up to 255 bytes long using LoRa or up to ...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:137</div></div>
<div class="ttc" id="aclass_s_x127x_html_aaf8ce9f09d0f46a76a5e251786b6de7f"><div class="ttname"><a href="class_s_x127x.html#aaf8ce9f09d0f46a76a5e251786b6de7f">SX127x::fixedPacketLengthMode</a></div><div class="ttdeci">int16_t fixedPacketLengthMode(uint8_t len=SX127X_MAX_PACKET_LENGTH_FSK)</div><div class="ttdoc">Set modem in fixed packet length mode. Available in FSK mode only.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:994</div></div>
<div class="ttc" id="aclass_s_x127x_html_a17ff4e4e0afaebed727648e1400be538"><div class="ttname"><a href="class_s_x127x.html#a17ff4e4e0afaebed727648e1400be538">SX127x::setOokFixedOrFloorThreshold</a></div><div class="ttdeci">int16_t setOokFixedOrFloorThreshold(uint8_t value)</div><div class="ttdoc">Fixed threshold for the Data Slicer in OOK mode or floor threshold for the Data Slicer in OOK when Pe...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:916</div></div>
<div class="ttc" id="aclass_s_x127x_html_ae9781180418c1ec9c365b74acbc98d8a"><div class="ttname"><a href="class_s_x127x.html#ae9781180418c1ec9c365b74acbc98d8a">SX127x::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 two pins. This function gives RadioLib control ...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1069</div></div>
<div class="ttc" id="aclass_s_x127x_html_afe6e9bbfd75f9cad26f9f72c34c4ada5"><div class="ttname"><a href="class_s_x127x.html#afe6e9bbfd75f9cad26f9f72c34c4ada5">SX127x::disableAddressFiltering</a></div><div class="ttdeci">int16_t disableAddressFiltering()</div><div class="ttdoc">Disables FSK address filtering.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:890</div></div>
<div class="ttc" id="aclass_s_x127x_html_aaf8ce9f09d0f46a76a5e251786b6de7f"><div class="ttname"><a href="class_s_x127x.html#aaf8ce9f09d0f46a76a5e251786b6de7f">SX127x::fixedPacketLengthMode</a></div><div class="ttdeci">int16_t fixedPacketLengthMode(uint8_t len=SX127X_MAX_PACKET_LENGTH_FSK)</div><div class="ttdoc">Set modem in fixed packet length mode. Available in FSK mode only.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:998</div></div>
<div class="ttc" id="aclass_s_x127x_html_a17ff4e4e0afaebed727648e1400be538"><div class="ttname"><a href="class_s_x127x.html#a17ff4e4e0afaebed727648e1400be538">SX127x::setOokFixedOrFloorThreshold</a></div><div class="ttdeci">int16_t setOokFixedOrFloorThreshold(uint8_t value)</div><div class="ttdoc">Fixed threshold for the Data Slicer in OOK mode or floor threshold for the Data Slicer in OOK when Pe...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:920</div></div>
<div class="ttc" id="aclass_s_x127x_html_ae9781180418c1ec9c365b74acbc98d8a"><div class="ttname"><a href="class_s_x127x.html#ae9781180418c1ec9c365b74acbc98d8a">SX127x::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 two pins. This function gives RadioLib control ...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1073</div></div>
<div class="ttc" id="aclass_s_x127x_html_afe6e9bbfd75f9cad26f9f72c34c4ada5"><div class="ttname"><a href="class_s_x127x.html#afe6e9bbfd75f9cad26f9f72c34c4ada5">SX127x::disableAddressFiltering</a></div><div class="ttdeci">int16_t disableAddressFiltering()</div><div class="ttdoc">Disables FSK address filtering.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:894</div></div>
<div class="ttc" id="aclass_s_x127x_html_aefeeb9f7192e11a75b5dfb1ab8488e84"><div class="ttname"><a href="class_s_x127x.html#aefeeb9f7192e11a75b5dfb1ab8488e84">SX127x::transmitDirect</a></div><div class="ttdeci">int16_t transmitDirect(uint32_t frf=0) override</div><div class="ttdoc">Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). While in direct mode,...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:304</div></div>
<div class="ttc" id="aclass_s_x127x_html_adc2f1379573b7a7b5ee8125ea3752083"><div class="ttname"><a href="class_s_x127x.html#adc2f1379573b7a7b5ee8125ea3752083">SX127x::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override</div><div class="ttdoc">Interrupt-driven binary transmit method. Will start transmitting arbitrary binary data up to 255 byte...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:444</div></div>
<div class="ttc" id="aclass_s_x127x_html_abc51ce6718153e4963128f25bb5aab40"><div class="ttname"><a href="class_s_x127x.html#abc51ce6718153e4963128f25bb5aab40">SX127x::setBroadcastAddress</a></div><div class="ttdeci">int16_t setBroadcastAddress(uint8_t broadAddr)</div><div class="ttdoc">Sets FSK broadcast address. Calling this method will enable address filtering. Only available in FSK ...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:876</div></div>
<div class="ttc" id="aclass_s_x127x_html_a5094ba2d9268340b7aba99afe5da0544"><div class="ttname"><a href="class_s_x127x.html#a5094ba2d9268340b7aba99afe5da0544">SX127x::getAFCError</a></div><div class="ttdeci">float getAFCError()</div><div class="ttdoc">Gets current AFC error.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:684</div></div>
<div class="ttc" id="aclass_s_x127x_html_a2cf6a5bd8f3257f98ee4f250cbdf8bdc"><div class="ttname"><a href="class_s_x127x.html#a2cf6a5bd8f3257f98ee4f250cbdf8bdc">SX127x::getModemStatus</a></div><div class="ttdeci">uint8_t getModemStatus()</div><div class="ttdoc">Reads modem status. Only available in LoRa mode.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1059</div></div>
<div class="ttc" id="aclass_s_x127x_html_a68cba1ff1e6bfd9b3034c97f3932e450"><div class="ttname"><a href="class_s_x127x.html#a68cba1ff1e6bfd9b3034c97f3932e450">SX127x::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> SX127x.cpp:1073</div></div>
<div class="ttc" id="aclass_s_x127x_html_adc2f1379573b7a7b5ee8125ea3752083"><div class="ttname"><a href="class_s_x127x.html#adc2f1379573b7a7b5ee8125ea3752083">SX127x::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override</div><div class="ttdoc">Interrupt-driven binary transmit method. Will start transmitting arbitrary binary data up to 255 byte...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:448</div></div>
<div class="ttc" id="aclass_s_x127x_html_abc51ce6718153e4963128f25bb5aab40"><div class="ttname"><a href="class_s_x127x.html#abc51ce6718153e4963128f25bb5aab40">SX127x::setBroadcastAddress</a></div><div class="ttdeci">int16_t setBroadcastAddress(uint8_t broadAddr)</div><div class="ttdoc">Sets FSK broadcast address. Calling this method will enable address filtering. Only available in FSK ...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:880</div></div>
<div class="ttc" id="aclass_s_x127x_html_a5094ba2d9268340b7aba99afe5da0544"><div class="ttname"><a href="class_s_x127x.html#a5094ba2d9268340b7aba99afe5da0544">SX127x::getAFCError</a></div><div class="ttdeci">float getAFCError()</div><div class="ttdoc">Gets current AFC error.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:688</div></div>
<div class="ttc" id="aclass_s_x127x_html_a2cf6a5bd8f3257f98ee4f250cbdf8bdc"><div class="ttname"><a href="class_s_x127x.html#a2cf6a5bd8f3257f98ee4f250cbdf8bdc">SX127x::getModemStatus</a></div><div class="ttdeci">uint8_t getModemStatus()</div><div class="ttdoc">Reads modem status. Only available in LoRa mode.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1063</div></div>
<div class="ttc" id="aclass_s_x127x_html_a68cba1ff1e6bfd9b3034c97f3932e450"><div class="ttname"><a href="class_s_x127x.html#a68cba1ff1e6bfd9b3034c97f3932e450">SX127x::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> SX127x.cpp:1077</div></div>
<div class="ttc" id="aclass_s_x127x_html_a760b8c5103128f122fbe489c6529ce41"><div class="ttname"><a href="class_s_x127x.html#a760b8c5103128f122fbe489c6529ce41">SX127x::standby</a></div><div class="ttdeci">int16_t standby() override</div><div class="ttdoc">Sets the LoRa module to standby.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:296</div></div>
<div class="ttc" id="aclass_s_x127x_html"><div class="ttname"><a href="class_s_x127x.html">SX127x</a></div><div class="ttdoc">Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from thi...</div><div class="ttdef"><b>Definition:</b> SX127x.h:547</div></div>
<div class="ttc" id="aclass_s_x127x_html_abc5069b39dc31b637ee561d5745e1deb"><div class="ttname"><a href="class_s_x127x.html#abc5069b39dc31b637ee561d5745e1deb">SX127x::getSNR</a></div><div class="ttdeci">float getSNR()</div><div class="ttdoc">Gets signal-to-noise ratio of the latest received packet.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:700</div></div>
<div class="ttc" id="aclass_s_x127x_html_abc5069b39dc31b637ee561d5745e1deb"><div class="ttname"><a href="class_s_x127x.html#abc5069b39dc31b637ee561d5745e1deb">SX127x::getSNR</a></div><div class="ttdeci">float getSNR()</div><div class="ttdoc">Gets signal-to-noise ratio of the latest received packet.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:704</div></div>
<div class="ttc" id="aclass_s_x127x_html_a3321ac4a7f65e73004202486db9b1d68"><div class="ttname"><a href="class_s_x127x.html#a3321ac4a7f65e73004202486db9b1d68">SX127x::reset</a></div><div class="ttdeci">virtual void reset()=0</div><div class="ttdoc">Reset method. Will reset the chip to the default state using RST pin. Declared pure virtual since SX1...</div></div>
<div class="ttc" id="aclass_s_x127x_html_a5da8218f69e3bf52df389a0480f8b430"><div class="ttname"><a href="class_s_x127x.html#a5da8218f69e3bf52df389a0480f8b430">SX127x::begin</a></div><div class="ttdeci">int16_t begin(uint8_t chipVersion, uint8_t syncWord, uint16_t preambleLength)</div><div class="ttdoc">Initialization method. Will be called with appropriate parameters when calling initialization method ...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:8</div></div>
<div class="ttc" id="aclass_s_x127x_html_ab608c45e0dcc44280df29580dc0a31ed"><div class="ttname"><a href="class_s_x127x.html#ab608c45e0dcc44280df29580dc0a31ed">SX127x::setPreambleLength</a></div><div class="ttdeci">int16_t setPreambleLength(uint16_t preambleLength)</div><div class="ttdoc">Sets LoRa or FSK preamble length. Allowed values range from 6 to 65535 in LoRa mode or 0 to 65535 in ...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:602</div></div>
<div class="ttc" id="aclass_s_x127x_html_a606d839b3a992c681ac9ad7ca6020022"><div class="ttname"><a href="class_s_x127x.html#a606d839b3a992c681ac9ad7ca6020022">SX127x::setBitRate</a></div><div class="ttdeci">int16_t setBitRate(float br)</div><div class="ttdoc">Sets FSK bit rate. Allowed values range from 1.2 to 300 kbps. Only available in FSK mode.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:715</div></div>
<div class="ttc" id="aclass_s_x127x_html_ab608c45e0dcc44280df29580dc0a31ed"><div class="ttname"><a href="class_s_x127x.html#ab608c45e0dcc44280df29580dc0a31ed">SX127x::setPreambleLength</a></div><div class="ttdeci">int16_t setPreambleLength(uint16_t preambleLength)</div><div class="ttdoc">Sets LoRa or FSK preamble length. Allowed values range from 6 to 65535 in LoRa mode or 0 to 65535 in ...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:606</div></div>
<div class="ttc" id="aclass_s_x127x_html_a606d839b3a992c681ac9ad7ca6020022"><div class="ttname"><a href="class_s_x127x.html#a606d839b3a992c681ac9ad7ca6020022">SX127x::setBitRate</a></div><div class="ttdeci">int16_t setBitRate(float br)</div><div class="ttdoc">Sets FSK bit rate. Allowed values range from 1.2 to 300 kbps. Only available in FSK mode.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:719</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:14</div></div>
<div class="ttc" id="aclass_physical_layer_html_afb1b090348d9091bfa3a0b5ba3d85b36"><div class="ttname"><a href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">PhysicalLayer::receive</a></div><div class="ttdeci">int16_t receive(String &amp;str, size_t len=0)</div><div class="ttdoc">Arduino String receive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:100</div></div>
<div class="ttc" id="aclass_s_x127x_html_a729b4f3f36096b5b15bae19c7876e823"><div class="ttname"><a href="class_s_x127x.html#a729b4f3f36096b5b15bae19c7876e823">SX127x::clearDio0Action</a></div><div class="ttdeci">void clearDio0Action()</div><div class="ttdoc">Clears interrupt service routine to call when DIO0 activates.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:426</div></div>
<div class="ttc" id="aclass_s_x127x_html_ac5d2ddb517e474a699b4539653b3754d"><div class="ttname"><a href="class_s_x127x.html#ac5d2ddb517e474a699b4539653b3754d">SX127x::getIRQFlags</a></div><div class="ttdeci">uint16_t getIRQFlags()</div><div class="ttdoc">Reads currently active IRQ flags, can be used to check which event caused an interrupt....</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1044</div></div>
<div class="ttc" id="aclass_s_x127x_html_aac2f43d70b5f94e49e09b4c9f082f46d"><div class="ttname"><a href="class_s_x127x.html#aac2f43d70b5f94e49e09b4c9f082f46d">SX127x::setOokPeakThresholdDecrement</a></div><div class="ttdeci">int16_t setOokPeakThresholdDecrement(uint8_t value)</div><div class="ttdoc">Period of decrement of the RSSI threshold in the OOK demodulator.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:924</div></div>
<div class="ttc" id="aclass_s_x127x_html_ad3955f85f456edae772a51025a19029b"><div class="ttname"><a href="class_s_x127x.html#ad3955f85f456edae772a51025a19029b">SX127x::setRSSIConfig</a></div><div class="ttdeci">int16_t setRSSIConfig(uint8_t smoothingSamples, int8_t offset=0)</div><div class="ttdoc">Sets RSSI measurement configuration in FSK mode.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1002</div></div>
<div class="ttc" id="aclass_s_x127x_html_a8b93142202167270db109d18b743c744"><div class="ttname"><a href="class_s_x127x.html#a8b93142202167270db109d18b743c744">SX127x::setOokThresholdType</a></div><div class="ttdeci">int16_t setOokThresholdType(uint8_t type)</div><div class="ttdoc">Selects the type of threshold in the OOK data slicer.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:908</div></div>
<div class="ttc" id="aclass_s_x127x_html_a63e00b1ecf1b0dcb6d8a91fc9b8ea5ef"><div class="ttname"><a href="class_s_x127x.html#a63e00b1ecf1b0dcb6d8a91fc9b8ea5ef">SX127x::setAFCBandwidth</a></div><div class="ttdeci">int16_t setAFCBandwidth(float afcBw)</div><div class="ttdoc">Sets FSK automatic frequency correction bandwidth. Allowed values range from 2.6 to 250 kHz....</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:802</div></div>
<div class="ttc" id="aclass_s_x127x_html_a24ef0af19a6b8954f956a3c3ad4286ee"><div class="ttname"><a href="class_s_x127x.html#a24ef0af19a6b8954f956a3c3ad4286ee">SX127x::setOOK</a></div><div class="ttdeci">int16_t setOOK(bool enableOOK)</div><div class="ttdoc">Enables/disables OOK modulation instead of FSK.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:932</div></div>
<div class="ttc" id="aclass_s_x127x_html_a2cc53b9f9d90647c5709cb974779cf53"><div class="ttname"><a href="class_s_x127x.html#a2cc53b9f9d90647c5709cb974779cf53">SX127x::setRxBandwidth</a></div><div class="ttdeci">int16_t setRxBandwidth(float rxBw)</div><div class="ttdoc">Sets FSK receiver bandwidth. Allowed values range from 2.6 to 250 kHz. Only available in FSK mode.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:786</div></div>
<div class="ttc" id="aclass_s_x127x_html_a729b4f3f36096b5b15bae19c7876e823"><div class="ttname"><a href="class_s_x127x.html#a729b4f3f36096b5b15bae19c7876e823">SX127x::clearDio0Action</a></div><div class="ttdeci">void clearDio0Action()</div><div class="ttdoc">Clears interrupt service routine to call when DIO0 activates.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:430</div></div>
<div class="ttc" id="aclass_s_x127x_html_ac5d2ddb517e474a699b4539653b3754d"><div class="ttname"><a href="class_s_x127x.html#ac5d2ddb517e474a699b4539653b3754d">SX127x::getIRQFlags</a></div><div class="ttdeci">uint16_t getIRQFlags()</div><div class="ttdoc">Reads currently active IRQ flags, can be used to check which event caused an interrupt....</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1048</div></div>
<div class="ttc" id="aclass_s_x127x_html_aac2f43d70b5f94e49e09b4c9f082f46d"><div class="ttname"><a href="class_s_x127x.html#aac2f43d70b5f94e49e09b4c9f082f46d">SX127x::setOokPeakThresholdDecrement</a></div><div class="ttdeci">int16_t setOokPeakThresholdDecrement(uint8_t value)</div><div class="ttdoc">Period of decrement of the RSSI threshold in the OOK demodulator.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:928</div></div>
<div class="ttc" id="aclass_s_x127x_html_ad3955f85f456edae772a51025a19029b"><div class="ttname"><a href="class_s_x127x.html#ad3955f85f456edae772a51025a19029b">SX127x::setRSSIConfig</a></div><div class="ttdeci">int16_t setRSSIConfig(uint8_t smoothingSamples, int8_t offset=0)</div><div class="ttdoc">Sets RSSI measurement configuration in FSK mode.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1006</div></div>
<div class="ttc" id="aclass_s_x127x_html_a8b93142202167270db109d18b743c744"><div class="ttname"><a href="class_s_x127x.html#a8b93142202167270db109d18b743c744">SX127x::setOokThresholdType</a></div><div class="ttdeci">int16_t setOokThresholdType(uint8_t type)</div><div class="ttdoc">Selects the type of threshold in the OOK data slicer.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:912</div></div>
<div class="ttc" id="aclass_s_x127x_html_a63e00b1ecf1b0dcb6d8a91fc9b8ea5ef"><div class="ttname"><a href="class_s_x127x.html#a63e00b1ecf1b0dcb6d8a91fc9b8ea5ef">SX127x::setAFCBandwidth</a></div><div class="ttdeci">int16_t setAFCBandwidth(float afcBw)</div><div class="ttdoc">Sets FSK automatic frequency correction bandwidth. Allowed values range from 2.6 to 250 kHz....</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:806</div></div>
<div class="ttc" id="aclass_s_x127x_html_a24ef0af19a6b8954f956a3c3ad4286ee"><div class="ttname"><a href="class_s_x127x.html#a24ef0af19a6b8954f956a3c3ad4286ee">SX127x::setOOK</a></div><div class="ttdeci">int16_t setOOK(bool enableOOK)</div><div class="ttdoc">Enables/disables OOK modulation instead of FSK.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:936</div></div>
<div class="ttc" id="aclass_s_x127x_html_a2cc53b9f9d90647c5709cb974779cf53"><div class="ttname"><a href="class_s_x127x.html#a2cc53b9f9d90647c5709cb974779cf53">SX127x::setRxBandwidth</a></div><div class="ttdeci">int16_t setRxBandwidth(float rxBw)</div><div class="ttdoc">Sets FSK receiver bandwidth. Allowed values range from 2.6 to 250 kHz. Only available in FSK mode.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:790</div></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 SPI/UART methods to control the wireless module. Every module class c...</div><div class="ttdef"><b>Definition:</b> Module.h:17</div></div>
<div class="ttc" id="aclass_s_x127x_html_ada007b90821258fe8c6ca7f8ae3efed5"><div class="ttname"><a href="class_s_x127x.html#ada007b90821258fe8c6ca7f8ae3efed5">SX127x::scanChannel</a></div><div class="ttdeci">int16_t scanChannel()</div><div class="ttdoc">Performs scan for valid LoRa preamble in the current channel.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:249</div></div>
<div class="ttc" id="aclass_s_x127x_html_adfe0d3f033a23ec2f3c2a407285d357c"><div class="ttname"><a href="class_s_x127x.html#adfe0d3f033a23ec2f3c2a407285d357c">SX127x::receive</a></div><div class="ttdeci">int16_t receive(uint8_t *data, size_t len) override</div><div class="ttdoc">Binary receive method. Will attempt to receive arbitrary binary data up to 255 bytes long using LoRa ...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:204</div></div>
<div class="ttc" id="aclass_s_x127x_html_aee5324d7d854e7a2f6768221d4f362cd"><div class="ttname"><a href="class_s_x127x.html#aee5324d7d854e7a2f6768221d4f362cd">SX127x::getChipVersion</a></div><div class="ttdeci">int16_t getChipVersion()</div><div class="ttdoc">Read version SPI register. Should return SX1278_CHIP_VERSION (0x12) or SX1272_CHIP_VERSION (0x22) if ...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1098</div></div>
<div class="ttc" id="aclass_s_x127x_html_a462fa74275e67c296328a01f361892d5"><div class="ttname"><a href="class_s_x127x.html#a462fa74275e67c296328a01f361892d5">SX127x::getPacketLength</a></div><div class="ttdeci">size_t getPacketLength(bool update=true) override</div><div class="ttdoc">Query modem for the packet length of received payload.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:966</div></div>
<div class="ttc" id="aclass_s_x127x_html_aee5324d7d854e7a2f6768221d4f362cd"><div class="ttname"><a href="class_s_x127x.html#aee5324d7d854e7a2f6768221d4f362cd">SX127x::getChipVersion</a></div><div class="ttdeci">int16_t getChipVersion()</div><div class="ttdoc">Read version SPI register. Should return SX1278_CHIP_VERSION (0x12) or SX1272_CHIP_VERSION (0x22) if ...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1102</div></div>
<div class="ttc" id="aclass_s_x127x_html_a462fa74275e67c296328a01f361892d5"><div class="ttname"><a href="class_s_x127x.html#a462fa74275e67c296328a01f361892d5">SX127x::getPacketLength</a></div><div class="ttdeci">size_t getPacketLength(bool update=true) override</div><div class="ttdoc">Query modem for the packet length of received payload.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:970</div></div>
<div class="ttc" id="aclass_s_x127x_html_ac74c5914ca429a3892c66b9d98e3ea6c"><div class="ttname"><a href="class_s_x127x.html#ac74c5914ca429a3892c66b9d98e3ea6c">SX127x::SX127x</a></div><div class="ttdeci">SX127x(Module *mod)</div><div class="ttdoc">Default constructor. Called internally when creating new LoRa instance.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:4</div></div>
<div class="ttc" id="aclass_s_x127x_html_a0995088d37689a3c240a1af791df6cf1"><div class="ttname"><a href="class_s_x127x.html#a0995088d37689a3c240a1af791df6cf1">SX127x::packetMode</a></div><div class="ttdeci">int16_t packetMode()</div><div class="ttdoc">Disables direct mode and enables packet mode, allowing the module to receive packets....</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:366</div></div>
<div class="ttc" id="aclass_s_x127x_html_a400575e3d83977bd250c5cb382fc7002"><div class="ttname"><a href="class_s_x127x.html#a400575e3d83977bd250c5cb382fc7002">SX127x::setCurrentLimit</a></div><div class="ttdeci">int16_t setCurrentLimit(uint8_t currentLimit)</div><div class="ttdoc">Sets current limit for over current protection at transmitter amplifier. Allowed values range from 45...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:578</div></div>
<div class="ttc" id="aclass_s_x127x_html_af6aa854a2668d70f4d3a374a49440362"><div class="ttname"><a href="class_s_x127x.html#af6aa854a2668d70f4d3a374a49440362">SX127x::getFrequencyError</a></div><div class="ttdeci">float getFrequencyError(bool autoCorrect=false)</div><div class="ttdoc">Gets frequency error of the latest received packet.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:631</div></div>
<div class="ttc" id="aclass_s_x127x_html_a0995088d37689a3c240a1af791df6cf1"><div class="ttname"><a href="class_s_x127x.html#a0995088d37689a3c240a1af791df6cf1">SX127x::packetMode</a></div><div class="ttdeci">int16_t packetMode()</div><div class="ttdoc">Disables direct mode and enables packet mode, allowing the module to receive packets....</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:370</div></div>
<div class="ttc" id="aclass_s_x127x_html_a400575e3d83977bd250c5cb382fc7002"><div class="ttname"><a href="class_s_x127x.html#a400575e3d83977bd250c5cb382fc7002">SX127x::setCurrentLimit</a></div><div class="ttdeci">int16_t setCurrentLimit(uint8_t currentLimit)</div><div class="ttdoc">Sets current limit for over current protection at transmitter amplifier. Allowed values range from 45...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:582</div></div>
<div class="ttc" id="aclass_s_x127x_html_af6aa854a2668d70f4d3a374a49440362"><div class="ttname"><a href="class_s_x127x.html#af6aa854a2668d70f4d3a374a49440362">SX127x::getFrequencyError</a></div><div class="ttdeci">float getFrequencyError(bool autoCorrect=false)</div><div class="ttdoc">Gets frequency error of the latest received packet.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:635</div></div>
<div class="ttc" id="aclass_physical_layer_html_af068e6e862c99e39d0261a7971dd56db"><div class="ttname"><a href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(String &amp;str, uint8_t addr=0)</div><div class="ttdoc">Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:51</div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->

2
class_physical_layer.html
View file

@ -792,7 +792,7 @@ Public Member Functions</h2></td></tr>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">syncWord</td><td>Sync word bits.</td></tr>
<tr><td class="paramname">len</td><td>Sync word length in bits.</td></tr>
<tr><td class="paramname">len</td><td>Sync word length in bits. Set to zero to disable sync word matching.</td></tr>
</table>
</dd>
</dl>