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

Deploying to gh-pages from @ 709fbdb13a 🚀

Browse source
This commit is contained in:
jgromes 2024-10-26 16:08:15 +00:00
parent 0d70b07038
commit a50578203c
12 changed files with 207 additions and 208 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
_build_opt_8h_source.html
View file

@ -632,36 +632,38 @@ $(document).ready(function(){initNavTree('_build_opt_8h_source.html',''); initRe
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span>&#160; </div>
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span>&#160;<span class="preprocessor">#if RADIOLIB_VERBOSE_ASSERT</span></div>
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span>&#160;<span class="preprocessor">#define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != RADIOLIB_ERR_NONE) { RADIOLIB_DEBUG_BASIC_PRINTLN(&quot;%d at %s:%d&quot;</span>, STATEVAR, __FILE__, __LINE__); return(STATEVAR); } }</div>
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span>&#160;<span class="preprocessor">#define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != RADIOLIB_ERR_NONE) { return(STATEVAR); } }</span></div>
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span>&#160; </div>
<div class="line"><a name="l00559"></a><span class="lineno"> 559</span>&#160;<span class="preprocessor">#if RADIOLIB_CHECK_PARAMS</span></div>
<div class="line"><a name="l00560"></a><span class="lineno"> 560</span>&#160;<span class="preprocessor"> #define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) { if(!(((VAR) &gt;= (MIN)) &amp;&amp; ((VAR) &lt;= (MAX)))) { return(ERR); } }</span></div>
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span>&#160;<span class="preprocessor"> #define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) {}</span></div>
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span>&#160; </div>
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span>&#160;<span class="preprocessor">#if RADIOLIB_FIX_ERRATA_SX127X</span></div>
<div class="line"><a name="l00566"></a><span class="lineno"> 566</span>&#160;<span class="preprocessor"> #define RADIOLIB_ERRATA_SX127X(...) { errataFix(__VA_ARGS__); }</span></div>
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span>&#160;<span class="preprocessor"> #define RADIOLIB_ERRATA_SX127X(...) {}</span></div>
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span>&#160; </div>
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span>&#160;<span class="comment">// these macros are usually defined by Arduino, but some platforms undef them, so its safer to use our own</span></div>
<div class="line"><a name="l00572"></a><span class="lineno"> 572</span>&#160;<span class="preprocessor">#define RADIOLIB_MIN(a,b) ((a)&lt;(b)?(a):(b))</span></div>
<div class="line"><a name="l00573"></a><span class="lineno"> 573</span>&#160;<span class="preprocessor">#define RADIOLIB_MAX(a,b) ((a)&gt;(b)?(a):(b))</span></div>
<div class="line"><a name="l00574"></a><span class="lineno"> 574</span>&#160;<span class="preprocessor">#define RADIOLIB_ABS(x) ((x)&gt;0?(x):-(x))</span></div>
<div class="line"><a name="l00575"></a><span class="lineno"> 575</span>&#160; </div>
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span>&#160;<span class="comment">// version definitions</span></div>
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span>&#160;<span class="preprocessor">#define RADIOLIB_VERSION_MAJOR 7</span></div>
<div class="line"><a name="l00578"></a><span class="lineno"> 578</span>&#160;<span class="preprocessor">#define RADIOLIB_VERSION_MINOR 0</span></div>
<div class="line"><a name="l00579"></a><span class="lineno"> 579</span>&#160;<span class="preprocessor">#define RADIOLIB_VERSION_PATCH 2</span></div>
<div class="line"><a name="l00580"></a><span class="lineno"> 580</span>&#160;<span class="preprocessor">#define RADIOLIB_VERSION_EXTRA 0</span></div>
<div class="line"><a name="l00581"></a><span class="lineno"> 581</span>&#160; </div>
<div class="line"><a name="l00582"></a><span class="lineno"> 582</span>&#160;<span class="preprocessor">#define RADIOLIB_VERSION (((RADIOLIB_VERSION_MAJOR) &lt;&lt; 24) | ((RADIOLIB_VERSION_MINOR) &lt;&lt; 16) | ((RADIOLIB_VERSION_PATCH) &lt;&lt; 8) | (RADIOLIB_VERSION_EXTRA))</span></div>
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span>&#160;<span class="preprocessor">#define RADIOLIB_ASSERT_PTR(PTR) { if((PTR) == NULL) { RADIOLIB_DEBUG_BASIC_PRINTLN(&quot;NULL at %s:%d&quot;</span>, __FILE__, __LINE__); return(RADIOLIB_ERR_MEMORY_ALLOCATION_FAILED); } }</div>
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span>&#160;<span class="preprocessor">#define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != RADIOLIB_ERR_NONE) { return(STATEVAR); } }</span></div>
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span>&#160;<span class="preprocessor">#define RADIOLIB_ASSERT_PTR(PTR) { if((PTR) == NULL) { return(RADIOLIB_ERR_MEMORY_ALLOCATION_FAILED); } }</span></div>
<div class="line"><a name="l00556"></a><span class="lineno"> 556</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00557"></a><span class="lineno"> 557</span>&#160; </div>
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span>&#160;<span class="preprocessor">#if RADIOLIB_CHECK_PARAMS</span></div>
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span>&#160;<span class="preprocessor"> #define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) { if(!(((VAR) &gt;= (MIN)) &amp;&amp; ((VAR) &lt;= (MAX)))) { return(ERR); } }</span></div>
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span>&#160;<span class="preprocessor"> #define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) {}</span></div>
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00566"></a><span class="lineno"> 566</span>&#160; </div>
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span>&#160;<span class="preprocessor">#if RADIOLIB_FIX_ERRATA_SX127X</span></div>
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span>&#160;<span class="preprocessor"> #define RADIOLIB_ERRATA_SX127X(...) { errataFix(__VA_ARGS__); }</span></div>
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span>&#160;<span class="preprocessor"> #define RADIOLIB_ERRATA_SX127X(...) {}</span></div>
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00572"></a><span class="lineno"> 572</span>&#160; </div>
<div class="line"><a name="l00573"></a><span class="lineno"> 573</span>&#160;<span class="comment">// these macros are usually defined by Arduino, but some platforms undef them, so its safer to use our own</span></div>
<div class="line"><a name="l00574"></a><span class="lineno"> 574</span>&#160;<span class="preprocessor">#define RADIOLIB_MIN(a,b) ((a)&lt;(b)?(a):(b))</span></div>
<div class="line"><a name="l00575"></a><span class="lineno"> 575</span>&#160;<span class="preprocessor">#define RADIOLIB_MAX(a,b) ((a)&gt;(b)?(a):(b))</span></div>
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span>&#160;<span class="preprocessor">#define RADIOLIB_ABS(x) ((x)&gt;0?(x):-(x))</span></div>
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span>&#160; </div>
<div class="line"><a name="l00578"></a><span class="lineno"> 578</span>&#160;<span class="comment">// version definitions</span></div>
<div class="line"><a name="l00579"></a><span class="lineno"> 579</span>&#160;<span class="preprocessor">#define RADIOLIB_VERSION_MAJOR 7</span></div>
<div class="line"><a name="l00580"></a><span class="lineno"> 580</span>&#160;<span class="preprocessor">#define RADIOLIB_VERSION_MINOR 0</span></div>
<div class="line"><a name="l00581"></a><span class="lineno"> 581</span>&#160;<span class="preprocessor">#define RADIOLIB_VERSION_PATCH 2</span></div>
<div class="line"><a name="l00582"></a><span class="lineno"> 582</span>&#160;<span class="preprocessor">#define RADIOLIB_VERSION_EXTRA 0</span></div>
<div class="line"><a name="l00583"></a><span class="lineno"> 583</span>&#160; </div>
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span>&#160;<span class="preprocessor">#define RADIOLIB_VERSION (((RADIOLIB_VERSION_MAJOR) &lt;&lt; 24) | ((RADIOLIB_VERSION_MINOR) &lt;&lt; 16) | ((RADIOLIB_VERSION_PATCH) &lt;&lt; 8) | (RADIOLIB_VERSION_EXTRA))</span></div>
<div class="line"><a name="l00585"></a><span class="lineno"> 585</span>&#160; </div>
<div class="line"><a name="l00586"></a><span class="lineno"> 586</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="agroup__typedefs_html_ga210f31dd2bff7fb80563275648a5bbbd"><div class="ttname"><a href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a></div><div class="ttdeci">unsigned long RadioLibTime_t</div><div class="ttdoc">Type used for durations in RadioLib.</div><div class="ttdef"><b>Definition:</b> TypeDef.h:642</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->

12
_c_c1101_8h_source.html
View file

@ -812,7 +812,7 @@ $(document).ready(function(){initNavTree('_c_c1101_8h_source.html',''); initResi
<div class="ttc" id="aclass_c_c1101_html_a29a16e8ed85432c6fae8d9e45399de6e"><div class="ttname"><a href="class_c_c1101.html#a29a16e8ed85432c6fae8d9e45399de6e">CC1101::setPacketReceivedAction</a></div><div class="ttdeci">void setPacketReceivedAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> CC1101.cpp:265</div></div>
<div class="ttc" id="aclass_c_c1101_html_a2a4c6e622dffd2788d8ac52d708b0705"><div class="ttname"><a href="class_c_c1101.html#a2a4c6e622dffd2788d8ac52d708b0705">CC1101::getChipVersion</a></div><div class="ttdeci">int16_t getChipVersion()</div><div class="ttdoc">Read version SPI register. Should return CC1101_VERSION_LEGACY (0x04) or CC1101_VERSION_CURRENT (0x14...</div><div class="ttdef"><b>Definition:</b> CC1101.cpp:987</div></div>
<div class="ttc" id="aclass_c_c1101_html_a336999da23e554073a9fa628131883f5"><div class="ttname"><a href="class_c_c1101.html#a336999da23e554073a9fa628131883f5">CC1101::setPacketSentAction</a></div><div class="ttdeci">void setPacketSentAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> CC1101.cpp:273</div></div>
<div class="ttc" id="aclass_c_c1101_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_c_c1101.html#a3563453988a83d22dd07d4691543a300">CC1101::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:210</div></div>
<div class="ttc" id="aclass_c_c1101_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_c_c1101.html#a3563453988a83d22dd07d4691543a300">CC1101::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:206</div></div>
<div class="ttc" id="aclass_c_c1101_html_a381d0059d7a0ccd8a2f54d7d3376f9b6"><div class="ttname"><a href="class_c_c1101.html#a381d0059d7a0ccd8a2f54d7d3376f9b6">CC1101::setRxBandwidth</a></div><div class="ttdeci">int16_t setRxBandwidth(float rxBw)</div><div class="ttdoc">Sets receiver bandwidth. Allowed values are 58, 68, 81, 102, 116, 135, 162, 203, 232,...</div><div class="ttdef"><b>Definition:</b> CC1101.cpp:486</div></div>
<div class="ttc" id="aclass_c_c1101_html_a38f6978c757b0dd73e3ef98164a735a2"><div class="ttname"><a href="class_c_c1101.html#a38f6978c757b0dd73e3ef98164a735a2">CC1101::packetMode</a></div><div class="ttdeci">int16_t packetMode()</div><div class="ttdoc">Stops direct mode. It is required to call this method to switch from direct transmissions to packet-b...</div><div class="ttdef"><b>Definition:</b> CC1101.cpp:250</div></div>
<div class="ttc" id="aclass_c_c1101_html_a433f1a40b33be6c84d3665a1b4cd57d6"><div class="ttname"><a href="class_c_c1101.html#a433f1a40b33be6c84d3665a1b4cd57d6">CC1101::setSyncWord</a></div><div class="ttdeci">int16_t setSyncWord(uint8_t syncH, uint8_t syncL, uint8_t maxErrBits=0, bool requireCarrierSense=false)</div><div class="ttdoc">Sets 16-bit sync word as a two byte value.</div><div class="ttdef"><b>Definition:</b> CC1101.cpp:693</div></div>
@ -831,7 +831,7 @@ $(document).ready(function(){initNavTree('_c_c1101_8h_source.html',''); initResi
<div class="ttc" id="aclass_c_c1101_html_a6fe55d0217bf5218865198ef8d6fdab4"><div class="ttname"><a href="class_c_c1101.html#a6fe55d0217bf5218865198ef8d6fdab4">CC1101::enableSyncWordFiltering</a></div><div class="ttdeci">int16_t enableSyncWordFiltering(uint8_t maxErrBits=0, bool requireCarrierSense=false)</div><div class="ttdoc">Enable sync word filtering and generation.</div><div class="ttdef"><b>Definition:</b> CC1101.cpp:842</div></div>
<div class="ttc" id="aclass_c_c1101_html_a7612bf81e48086004c62548de2682266"><div class="ttname"><a href="class_c_c1101.html#a7612bf81e48086004c62548de2682266">CC1101::standby</a></div><div class="ttdeci">int16_t standby() override</div><div class="ttdoc">Sets the module to standby mode.</div><div class="ttdef"><b>Definition:</b> CC1101.cpp:170</div></div>
<div class="ttc" id="aclass_c_c1101_html_a7b401995be4bc136063a035ce1820634"><div class="ttname"><a href="class_c_c1101.html#a7b401995be4bc136063a035ce1820634">CC1101::setRfSwitchTable</a></div><div class="ttdeci">void setRfSwitchTable(const uint32_t(&amp;pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])</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> CC1101.cpp:964</div></div>
<div class="ttc" id="aclass_c_c1101_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_c_c1101.html#a923654706eff5118ef6e84214e837f27">CC1101::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:150</div></div>
<div class="ttc" id="aclass_c_c1101_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_c_c1101.html#a923654706eff5118ef6e84214e837f27">CC1101::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:148</div></div>
<div class="ttc" id="aclass_c_c1101_html_a9aee5df428d30b9c80b8a8700609a883"><div class="ttname"><a href="class_c_c1101.html#a9aee5df428d30b9c80b8a8700609a883">CC1101::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> CC1101.cpp:751</div></div>
<div class="ttc" id="aclass_c_c1101_html_a9bee13612cf4da067faeb57d18ee2eb7"><div class="ttname"><a href="class_c_c1101.html#a9bee13612cf4da067faeb57d18ee2eb7">CC1101::setGdo0Action</a></div><div class="ttdeci">void setGdo0Action(void(*func)(void), uint32_t dir)</div><div class="ttdoc">Sets interrupt service routine to call when GDO0 activates.</div><div class="ttdef"><b>Definition:</b> CC1101.cpp:257</div></div>
<div class="ttc" id="aclass_c_c1101_html_a9ec1ff1312d2caaae7e3e0389268fca2"><div class="ttname"><a href="class_c_c1101.html#a9ec1ff1312d2caaae7e3e0389268fca2">CC1101::receiveDirectAsync</a></div><div class="ttdeci">int16_t receiveDirectAsync()</div><div class="ttdoc">Starts asynchronous direct mode reception.</div><div class="ttdef"><b>Definition:</b> CC1101.cpp:229</div></div>
@ -840,7 +840,7 @@ $(document).ready(function(){initNavTree('_c_c1101_8h_source.html',''); initResi
<div class="ttc" id="aclass_c_c1101_html_ab500e75fcf63f123eb3945925f361bd0"><div class="ttname"><a href="class_c_c1101.html#ab500e75fcf63f123eb3945925f361bd0">CC1101::checkOutputPower</a></div><div class="ttdeci">int16_t checkOutputPower(int8_t power, int8_t *clipped) override</div><div class="ttdoc">Check if output power is configurable. This method is needed for compatibility with PhysicalLayer::ch...</div><div class="ttdef"><b>Definition:</b> CC1101.cpp:602</div></div>
<div class="ttc" id="aclass_c_c1101_html_ab5e6b3745f80cf61e1ced33303311df8"><div class="ttname"><a href="class_c_c1101.html#ab5e6b3745f80cf61e1ced33303311df8">CC1101::clearGdo0Action</a></div><div class="ttdeci">void clearGdo0Action()</div><div class="ttdoc">Clears interrupt service routine to call when GDO0 activates.</div><div class="ttdef"><b>Definition:</b> CC1101.cpp:261</div></div>
<div class="ttc" id="aclass_c_c1101_html_ab80835be83e5a43010afe4e8185114eb"><div class="ttname"><a href="class_c_c1101.html#ab80835be83e5a43010afe4e8185114eb">CC1101::getRSSI</a></div><div class="ttdeci">float getRSSI() override</div><div class="ttdoc">Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. In direct or asynchronous...</div><div class="ttdef"><b>Definition:</b> CC1101.cpp:790</div></div>
<div class="ttc" id="aclass_c_c1101_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_c_c1101.html#ab82617fa3fa9f21d4cd427314ecc4af8">CC1101::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:113</div></div>
<div class="ttc" id="aclass_c_c1101_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_c_c1101.html#ab82617fa3fa9f21d4cd427314ecc4af8">CC1101::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_c_c1101_html_abe26fa310e973bf2b14750b9eae02124"><div class="ttname"><a href="class_c_c1101.html#abe26fa310e973bf2b14750b9eae02124">CC1101::getFrequencyDeviation</a></div><div class="ttdeci">int16_t getFrequencyDeviation(float *freqDev)</div><div class="ttdoc">Gets frequency deviation.</div><div class="ttdef"><b>Definition:</b> CC1101.cpp:552</div></div>
<div class="ttc" id="aclass_c_c1101_html_ac1155543b27e46fa27aa4c9180da18bb"><div class="ttname"><a href="class_c_c1101.html#ac1155543b27e46fa27aa4c9180da18bb">CC1101::setPromiscuousMode</a></div><div class="ttdeci">int16_t setPromiscuousMode(bool enable=true, bool requireCarrierSense=false)</div><div class="ttdoc">Set modem in &quot;sniff&quot; mode: no packet filtering (e.g., no preamble, sync word, address,...</div><div class="ttdef"><b>Definition:</b> CC1101.cpp:876</div></div>
<div class="ttc" id="aclass_c_c1101_html_ac7a8b1fe7d08dc6db20cf1569b0d37b4"><div class="ttname"><a href="class_c_c1101.html#ac7a8b1fe7d08dc6db20cf1569b0d37b4">CC1101::clearGdo2Action</a></div><div class="ttdeci">void clearGdo2Action()</div><div class="ttdoc">Clears interrupt service routine to call when GDO0 activates.</div><div class="ttdef"><b>Definition:</b> CC1101.cpp:289</div></div>
@ -859,10 +859,10 @@ $(document).ready(function(){initNavTree('_c_c1101_8h_source.html',''); initResi
<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:66</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. Note: It is not recommended to use this c...</div><div class="ttdef"><b>Definition:</b> Module.h:75</div></div>
<div class="ttc" id="aclass_physical_layer_html"><div class="ttname"><a href="class_physical_layer.html">PhysicalLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:151</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:210</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:206</div></div>
<div class="ttc" id="aclass_physical_layer_html_a492b2d057dd803c3884fa1adc8e22534"><div class="ttname"><a href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">PhysicalLayer::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:53</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:150</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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:113</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:148</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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="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="ttdoc">Description of RF switch pin states for a single mode. See setRfSwitchTable for details.</div><div class="ttdef"><b>Definition:</b> Module.h:82</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->

21
_l_r1121_8h_source.html
View file

@ -101,18 +101,15 @@ $(document).ready(function(){initNavTree('_l_r1121_8h_source.html',''); initResi
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <a class="code" href="class_l_r1121.html#a0015ed8c0fde10a072b5f1317779f59a">LR1121</a>(<a class="code" href="class_module.html">Module</a>* mod); <span class="comment">// cppcheck-suppress noExplicitConstructor</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="comment">// TODO this is where overrides to disable GNSS+WiFi scanning methods on LR1121</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="comment">// will be put once those are implemented</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;};</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;};</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_l_r1120_html"><div class="ttname"><a href="class_l_r1120.html">LR1120</a></div><div class="ttdoc">Derived class for LR1120 modules.</div><div class="ttdef"><b>Definition:</b> LR1120.h:15</div></div>
<div class="ttc" id="aclass_l_r1121_html"><div class="ttname"><a href="class_l_r1121.html">LR1121</a></div><div class="ttdoc">Derived class for LR1121 modules.</div><div class="ttdef"><b>Definition:</b> LR1121.h:16</div></div>
<div class="ttc" id="aclass_l_r1121_html_a0015ed8c0fde10a072b5f1317779f59a"><div class="ttname"><a href="class_l_r1121.html#a0015ed8c0fde10a072b5f1317779f59a">LR1121::LR1121</a></div><div class="ttdeci">LR1121(Module *mod)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> LR1121.cpp:4</div></div>

42
_l_r11x0_8h_source.html
View file

@ -1298,7 +1298,7 @@ $(document).ready(function(){initNavTree('_l_r11x0_8h_source.html',''); initResi
<div class="ttc" id="aclass_l_r11x0_html_a0309154558a0d88e2e8957e4dbf6a2f8"><div class="ttname"><a href="class_l_r11x0.html#a0309154558a0d88e2e8957e4dbf6a2f8">LR11x0::getIrqStatus</a></div><div class="ttdeci">uint32_t getIrqStatus()</div><div class="ttdoc">Reads the current IRQ status.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:534</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a056e65c58ff8fb18bd84917512790ee6"><div class="ttname"><a href="class_l_r11x0.html#a056e65c58ff8fb18bd84917512790ee6">LR11x0::setDataRate</a></div><div class="ttdeci">int16_t setDataRate(DataRate_t dr) override</div><div class="ttdoc">Set data.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1054</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a1981f0dfceca2b6175a69530ea13d643"><div class="ttname"><a href="class_l_r11x0.html#a1981f0dfceca2b6175a69530ea13d643">LR11x0::setRfSwitchTable</a></div><div class="ttdeci">void setRfSwitchTable(const uint32_t(&amp;pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])</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> LR11x0.cpp:1444</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a19a4b4a138dbd0e5c8f980de0f6419e4"><div class="ttname"><a href="class_l_r11x0.html#a19a4b4a138dbd0e5c8f980de0f6419e4">LR11x0::getGnssPosition</a></div><div class="ttdeci">int16_t getGnssPosition(LR11x0GnssPosition_t *pos, bool filtered=true)</div><div class="ttdoc">Get GNSS position. Called after gnssScan to retrieve the position calculated by the internal solver.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1971</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a19a4b4a138dbd0e5c8f980de0f6419e4"><div class="ttname"><a href="class_l_r11x0.html#a19a4b4a138dbd0e5c8f980de0f6419e4">LR11x0::getGnssPosition</a></div><div class="ttdeci">int16_t getGnssPosition(LR11x0GnssPosition_t *pos, bool filtered=true)</div><div class="ttdoc">Get GNSS position. Called after gnssScan to retrieve the position calculated by the internal solver.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1962</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a1ad485f14a333f06b642f2d60aacf76c"><div class="ttname"><a href="class_l_r11x0.html#a1ad485f14a333f06b642f2d60aacf76c">LR11x0::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> LR11x0.cpp:1435</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a1ae2cddeb7671d9b71e9c83bf020820f"><div class="ttname"><a href="class_l_r11x0.html#a1ae2cddeb7671d9b71e9c83bf020820f">LR11x0::getChannelScanResult</a></div><div class="ttdeci">int16_t getChannelScanResult() override</div><div class="ttdoc">Read the channel scan result.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:634</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a1ec81f3625fdc8a3ef6c54a3804c3aa9"><div class="ttname"><a href="class_l_r11x0.html#a1ec81f3625fdc8a3ef6c54a3804c3aa9">LR11x0::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> LR11x0.cpp:1427</div></div>
@ -1317,10 +1317,10 @@ $(document).ready(function(){initNavTree('_l_r11x0_8h_source.html',''); initResi
<div class="ttc" id="aclass_l_r11x0_html_a2985d66f47882ab46291a4d89f686ca7ab223e6d6104d722d61e1d2aa22231012"><div class="ttname"><a href="class_l_r11x0.html#a2985d66f47882ab46291a4d89f686ca7ab223e6d6104d722d61e1d2aa22231012">LR11x0::MODE_STBY</a></div><div class="ttdeci">@ MODE_STBY</div><div class="ttdef"><b>Definition:</b> LR11x0.h:893</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a2985d66f47882ab46291a4d89f686ca7acbbc5768e10e22bfdf776faffbfced46"><div class="ttname"><a href="class_l_r11x0.html#a2985d66f47882ab46291a4d89f686ca7acbbc5768e10e22bfdf776faffbfced46">LR11x0::MODE_TX_HF</a></div><div class="ttdeci">@ MODE_TX_HF</div><div class="ttdef"><b>Definition:</b> LR11x0.h:901</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a3498e0e621f341e415145879989e0948"><div class="ttname"><a href="class_l_r11x0.html#a3498e0e621f341e415145879989e0948">LR11x0::startWifiScan</a></div><div class="ttdeci">int16_t startWifiScan(char wifiType, uint8_t mode=RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON, uint16_t chanMask=RADIOLIB_LR11X0_WIFI_ALL_CHANNELS, uint8_t numScans=16, uint16_t timeout=100)</div><div class="ttdoc">Start passive WiFi scan. BUSY pin will be de-activated when the scan is finished.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1514</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_l_r11x0.html#a3563453988a83d22dd07d4691543a300">LR11x0::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:210</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_l_r11x0.html#a3563453988a83d22dd07d4691543a300">LR11x0::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:206</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a3693359e5d106d6f57c23247c528cdd5"><div class="ttname"><a href="class_l_r11x0.html#a3693359e5d106d6f57c23247c528cdd5">LR11x0::explicitHeader</a></div><div class="ttdeci">int16_t explicitHeader()</div><div class="ttdoc">Set explicit header mode for future reception/transmission.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1423</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a3ccfd35d26960457214d2a0192d6b312"><div class="ttname"><a href="class_l_r11x0.html#a3ccfd35d26960457214d2a0192d6b312">LR11x0::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> LR11x0.h:911</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a457f5dfe25385a329127f07abc4631a6"><div class="ttname"><a href="class_l_r11x0.html#a457f5dfe25385a329127f07abc4631a6">LR11x0::getWifiScanResult</a></div><div class="ttdeci">int16_t getWifiScanResult(LR11x0WifiResult_t *result, uint8_t index, bool brief=false)</div><div class="ttdoc">Retrieve passive WiFi scan result.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1573</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a457f5dfe25385a329127f07abc4631a6"><div class="ttname"><a href="class_l_r11x0.html#a457f5dfe25385a329127f07abc4631a6">LR11x0::getWifiScanResult</a></div><div class="ttdeci">int16_t getWifiScanResult(LR11x0WifiResult_t *result, uint8_t index, bool brief=false)</div><div class="ttdoc">Retrieve passive WiFi scan result.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1578</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a49116d006b60128fe6f73a6a868a6d18"><div class="ttname"><a href="class_l_r11x0.html#a49116d006b60128fe6f73a6a868a6d18">LR11x0::setIrqAction</a></div><div class="ttdeci">void setIrqAction(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when IRQ1 activates.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:391</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a492b2d057dd803c3884fa1adc8e22534"><div class="ttname"><a href="class_l_r11x0.html#a492b2d057dd803c3884fa1adc8e22534">LR11x0::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:53</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a4d18ad719be79c083f2b0ce77bbaa448"><div class="ttname"><a href="class_l_r11x0.html#a4d18ad719be79c083f2b0ce77bbaa448">LR11x0::checkDataRate</a></div><div class="ttdeci">int16_t checkDataRate(DataRate_t dr) override</div><div class="ttdoc">Check the data rate can be configured by this module.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1088</div></div>
@ -1330,28 +1330,28 @@ $(document).ready(function(){initNavTree('_l_r11x0_8h_source.html',''); initResi
<div class="ttc" id="aclass_l_r11x0_html_a583f2d5ed601a98c609dbf0d57f2f541"><div class="ttname"><a href="class_l_r11x0.html#a583f2d5ed601a98c609dbf0d57f2f541">LR11x0::setCodingRate</a></div><div class="ttdeci">int16_t setCodingRate(uint8_t cr, bool longInterleave=false)</div><div class="ttdoc">Sets LoRa coding rate denominator. Allowed values range from 5 to 8.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:728</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a5a33df702da3f5b010e07d5e6fac7aa6"><div class="ttname"><a href="class_l_r11x0.html#a5a33df702da3f5b010e07d5e6fac7aa6">LR11x0::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> LR11x0.cpp:983</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a5df4c1ed45bf59aa25bc400bcb5dc1ba"><div class="ttname"><a href="class_l_r11x0.html#a5df4c1ed45bf59aa25bc400bcb5dc1ba">LR11x0::fixedPacketLengthMode</a></div><div class="ttdeci">int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_LR11X0_MAX_PACKET_LENGTH)</div><div class="ttdoc">Set modem in fixed packet length mode. Available in GFSK mode only.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1021</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a5ef83caa291e2d310d260a8ea140bc8e"><div class="ttname"><a href="class_l_r11x0.html#a5ef83caa291e2d310d260a8ea140bc8e">LR11x0::getWifiScanResultsCount</a></div><div class="ttdeci">int16_t getWifiScanResultsCount(uint8_t *count)</div><div class="ttdoc">Get number of WiFi scan results after the scan is finished.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1559</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a5ef83caa291e2d310d260a8ea140bc8e"><div class="ttname"><a href="class_l_r11x0.html#a5ef83caa291e2d310d260a8ea140bc8e">LR11x0::getWifiScanResultsCount</a></div><div class="ttdeci">int16_t getWifiScanResultsCount(uint8_t *count)</div><div class="ttdoc">Get number of WiFi scan results after the scan is finished.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1564</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a605f5c74ce523abad256866abe133d2e"><div class="ttname"><a href="class_l_r11x0.html#a605f5c74ce523abad256866abe133d2e">LR11x0::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> LR11x0.cpp:932</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a62c715ab18ea8a2e08a2791d3e764ee9"><div class="ttname"><a href="class_l_r11x0.html#a62c715ab18ea8a2e08a2791d3e764ee9">LR11x0::setIrqFlags</a></div><div class="ttdeci">int16_t setIrqFlags(uint32_t irq) override</div><div class="ttdoc">Set interrupt on IRQ pin to be sent on a specific IRQ bit (e.g. RxTimeout, CadDone).</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1405</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a6501ef362df1a5b71927cfe4e43c202d"><div class="ttname"><a href="class_l_r11x0.html#a6501ef362df1a5b71927cfe4e43c202d">LR11x0::setSyncBits</a></div><div class="ttdeci">int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen)</div><div class="ttdoc">Sets GFSK sync word in the form of array of up to 8 bytes.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:911</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a6a3034c91f5bce70c853ab1620725b3c"><div class="ttname"><a href="class_l_r11x0.html#a6a3034c91f5bce70c853ab1620725b3c">LR11x0::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> LR11x0.cpp:318</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a6cd2b2363501b2de064c9d1f32fabaa3"><div class="ttname"><a href="class_l_r11x0.html#a6cd2b2363501b2de064c9d1f32fabaa3">LR11x0::getRSSI</a></div><div class="ttdeci">float getRSSI() override</div><div class="ttdoc">Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. Only available for LoRa o...</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1243</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a70d9849eb8e5ce2090e4e332252753d7"><div class="ttname"><a href="class_l_r11x0.html#a70d9849eb8e5ce2090e4e332252753d7">LR11x0::setBandwidth</a></div><div class="ttdeci">int16_t setBandwidth(float bw, bool high=false)</div><div class="ttdoc">Sets LoRa bandwidth. Allowed values are 62.5, 125.0, 250.0 and 500.0 kHz. (default,...</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:657</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a748d30cb7a0b419066f6361a966b306f"><div class="ttname"><a href="class_l_r11x0.html#a748d30cb7a0b419066f6361a966b306f">LR11x0::getGnssAlmanacStatus</a></div><div class="ttdeci">int16_t getGnssAlmanacStatus(LR11x0GnssAlmanacStatus_t *stat)</div><div class="ttdoc">Read information about the almanac.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1874</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a748d30cb7a0b419066f6361a966b306f"><div class="ttname"><a href="class_l_r11x0.html#a748d30cb7a0b419066f6361a966b306f">LR11x0::getGnssAlmanacStatus</a></div><div class="ttdeci">int16_t getGnssAlmanacStatus(LR11x0GnssAlmanacStatus_t *stat)</div><div class="ttdoc">Read information about the almanac.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1869</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a74c3f3f8409f1fd0f41347b7d3c7dc24"><div class="ttname"><a href="class_l_r11x0.html#a74c3f3f8409f1fd0f41347b7d3c7dc24">LR11x0::standby</a></div><div class="ttdeci">int16_t standby() override</div><div class="ttdoc">Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:347</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a79818dae19d69d33a5a1facbb91c3774"><div class="ttname"><a href="class_l_r11x0.html#a79818dae19d69d33a5a1facbb91c3774">LR11x0::isGnssScanCapable</a></div><div class="ttdeci">int16_t isGnssScanCapable()</div><div class="ttdoc">Method to check whether the device is capable of performing a GNSS scan.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1758</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a79818dae19d69d33a5a1facbb91c3774"><div class="ttname"><a href="class_l_r11x0.html#a79818dae19d69d33a5a1facbb91c3774">LR11x0::isGnssScanCapable</a></div><div class="ttdeci">int16_t isGnssScanCapable()</div><div class="ttdoc">Method to check whether the device is capable of performing a GNSS scan.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1755</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a7ffa48f1b6aaaa3f48e4b51f8ada59d8"><div class="ttname"><a href="class_l_r11x0.html#a7ffa48f1b6aaaa3f48e4b51f8ada59d8">LR11x0::setSyncWord</a></div><div class="ttdeci">int16_t setSyncWord(uint32_t syncWord)</div><div class="ttdoc">Sets LoRa or LR-FHSS sync word.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:761</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a89b16d2231f588b67dc3aab0c0a467f4"><div class="ttname"><a href="class_l_r11x0.html#a89b16d2231f588b67dc3aab0c0a467f4">LR11x0::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> LR11x0.cpp:1413</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a8ae178a17f6e41b545b79cfffd3e2864"><div class="ttname"><a href="class_l_r11x0.html#a8ae178a17f6e41b545b79cfffd3e2864">LR11x0::setEncoding</a></div><div class="ttdeci">int16_t setEncoding(uint8_t encoding) override</div><div class="ttdoc">Sets transmission encoding. Available in GFSK mode only. Serves only as alias for PhysicalLayer compa...</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1017</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a8c1def9a01021a52f5bb82c119a9ad35"><div class="ttname"><a href="class_l_r11x0.html#a8c1def9a01021a52f5bb82c119a9ad35">LR11x0::setLrFhssConfig</a></div><div class="ttdeci">int16_t setLrFhssConfig(uint8_t bw, uint8_t cr, uint8_t hdrCount=3, uint16_t hopSeed=0x13A)</div><div class="ttdoc">Sets LR-FHSS configuration.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1493</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a92299e41f839590008b4e344776838a1"><div class="ttname"><a href="class_l_r11x0.html#a92299e41f839590008b4e344776838a1">LR11x0::setPacketSentAction</a></div><div class="ttdeci">void setPacketSentAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:407</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_l_r11x0.html#a923654706eff5118ef6e84214e837f27">LR11x0::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:150</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_l_r11x0.html#a923654706eff5118ef6e84214e837f27">LR11x0::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:148</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a92ae10630cc327f441809ac1406737fd"><div class="ttname"><a href="class_l_r11x0.html#a92ae10630cc327f441809ac1406737fd">LR11x0::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> LR11x0.cpp:1431</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a95ddec84ae2fb19989c333d42d4dc5fa"><div class="ttname"><a href="class_l_r11x0.html#a95ddec84ae2fb19989c333d42d4dc5fa">LR11x0::clearPacketSentAction</a></div><div class="ttdeci">void clearPacketSentAction() override</div><div class="ttdoc">Clears interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:411</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a96aa9566399e46fc03f2b73b44058e3f"><div class="ttname"><a href="class_l_r11x0.html#a96aa9566399e46fc03f2b73b44058e3f">LR11x0::updateGnssAlmanac</a></div><div class="ttdeci">int16_t updateGnssAlmanac(uint8_t constellation)</div><div class="ttdoc">Perform almanac update. Must be called immediately after gnssDelayUntilSubframe.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1941</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a96aa9566399e46fc03f2b73b44058e3f"><div class="ttname"><a href="class_l_r11x0.html#a96aa9566399e46fc03f2b73b44058e3f">LR11x0::updateGnssAlmanac</a></div><div class="ttdeci">int16_t updateGnssAlmanac(uint8_t constellation)</div><div class="ttdoc">Perform almanac update. Must be called immediately after gnssDelayUntilSubframe.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1932</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a96e4a220bbd3487423acfd217b479fe3"><div class="ttname"><a href="class_l_r11x0.html#a96e4a220bbd3487423acfd217b479fe3">LR11x0::clearPacketReceivedAction</a></div><div class="ttdeci">void clearPacketReceivedAction() override</div><div class="ttdoc">Clears interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:403</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a971b4ccd1d5479e9d72aa9649e8fef55"><div class="ttname"><a href="class_l_r11x0.html#a971b4ccd1d5479e9d72aa9649e8fef55">LR11x0::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> LR11x0.cpp:1131</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a97a3f23b796257135a9afd33c28e8ed5"><div class="ttname"><a href="class_l_r11x0.html#a97a3f23b796257135a9afd33c28e8ed5">LR11x0::getGnssSatellites</a></div><div class="ttdeci">int16_t getGnssSatellites(LR11x0GnssSatellite_t *sats, uint8_t numSats)</div><div class="ttdoc">Get GNSS satellites found during the last scan.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1993</div></div>
<div class="ttc" id="aclass_l_r11x0_html_a97a3f23b796257135a9afd33c28e8ed5"><div class="ttname"><a href="class_l_r11x0.html#a97a3f23b796257135a9afd33c28e8ed5">LR11x0::getGnssSatellites</a></div><div class="ttdeci">int16_t getGnssSatellites(LR11x0GnssSatellite_t *sats, uint8_t numSats)</div><div class="ttdoc">Get GNSS satellites found during the last scan.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1982</div></div>
<div class="ttc" id="aclass_l_r11x0_html_aa2b69f68ff6171b11a1141c8615240fd"><div class="ttname"><a href="class_l_r11x0.html#aa2b69f68ff6171b11a1141c8615240fd">LR11x0::begin</a></div><div class="ttdeci">int16_t begin(float bw, uint8_t sf, uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage, bool high=false)</div><div class="ttdoc">Initialization method for LoRa modem.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:26</div></div>
<div class="ttc" id="aclass_l_r11x0_html_aa524b0be7b8d125c24319072d6178e74"><div class="ttname"><a href="class_l_r11x0.html#aa524b0be7b8d125c24319072d6178e74">LR11x0::clearIrqFlags</a></div><div class="ttdeci">int16_t clearIrqFlags(uint32_t irq) override</div><div class="ttdoc">Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone).</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1409</div></div>
<div class="ttc" id="aclass_l_r11x0_html_aa5d7ae65666f8f9abcb7e9b169884a4a"><div class="ttname"><a href="class_l_r11x0.html#aa5d7ae65666f8f9abcb7e9b169884a4a">LR11x0::setPreambleLength</a></div><div class="ttdeci">int16_t setPreambleLength(size_t preambleLength) override</div><div class="ttdoc">Sets preamble length for LoRa or GFSK modem. Allowed values range from 1 to 65535.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1110</div></div>
@ -1361,24 +1361,24 @@ $(document).ready(function(){initNavTree('_l_r11x0_8h_source.html',''); initResi
<div class="ttc" id="aclass_l_r11x0_html_ab0cf34cc0b67484fbf0f258bff7e9a9a"><div class="ttname"><a href="class_l_r11x0.html#ab0cf34cc0b67484fbf0f258bff7e9a9a">LR11x0::setRxBoostedGainMode</a></div><div class="ttdeci">int16_t setRxBoostedGainMode(bool en)</div><div class="ttdoc">Enables or disables Rx Boosted Gain mode (additional Rx gain for increased power consumption).</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1439</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ab167c4dc14e80d19f8b33d68c3f90d98"><div class="ttname"><a href="class_l_r11x0.html#ab167c4dc14e80d19f8b33d68c3f90d98">LR11x0::clearIrqAction</a></div><div class="ttdeci">void clearIrqAction()</div><div class="ttdoc">Clears interrupt service routine to call when IRQ1 activates.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:395</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ab1954e4733a7fbea4129d9a2de2285d9"><div class="ttname"><a href="class_l_r11x0.html#ab1954e4733a7fbea4129d9a2de2285d9">LR11x0::setBitRate</a></div><div class="ttdeci">int16_t setBitRate(float br) override</div><div class="ttdoc">Sets GFSK bit rate. Allowed values range from 0.6 to 300.0 kbps.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:777</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ab2820cc2b740d6d42a079bbd8bd45b85"><div class="ttname"><a href="class_l_r11x0.html#ab2820cc2b740d6d42a079bbd8bd45b85">LR11x0::updateFirmware</a></div><div class="ttdeci">int16_t updateFirmware(const uint32_t *image, size_t size, bool nonvolatile=true)</div><div class="ttdoc">Method to upload new firmware image to the device. The device will be automatically erased,...</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1698</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ab2dbab0fe3433e914c19a8d03fe32358"><div class="ttname"><a href="class_l_r11x0.html#ab2dbab0fe3433e914c19a8d03fe32358">LR11x0::gnssDelayUntilSubframe</a></div><div class="ttdeci">int16_t gnssDelayUntilSubframe(LR11x0GnssAlmanacStatus_t *stat, uint8_t constellation)</div><div class="ttdoc">Blocking wait until the next subframe with almanac data is available. Used to control timing during a...</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1915</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_l_r11x0.html#ab82617fa3fa9f21d4cd427314ecc4af8">LR11x0::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:113</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ab2820cc2b740d6d42a079bbd8bd45b85"><div class="ttname"><a href="class_l_r11x0.html#ab2820cc2b740d6d42a079bbd8bd45b85">LR11x0::updateFirmware</a></div><div class="ttdeci">int16_t updateFirmware(const uint32_t *image, size_t size, bool nonvolatile=true)</div><div class="ttdoc">Method to upload new firmware image to the device. The device will be automatically erased,...</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1697</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ab2dbab0fe3433e914c19a8d03fe32358"><div class="ttname"><a href="class_l_r11x0.html#ab2dbab0fe3433e914c19a8d03fe32358">LR11x0::gnssDelayUntilSubframe</a></div><div class="ttdeci">int16_t gnssDelayUntilSubframe(LR11x0GnssAlmanacStatus_t *stat, uint8_t constellation)</div><div class="ttdoc">Blocking wait until the next subframe with almanac data is available. Used to control timing during a...</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1908</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_l_r11x0.html#ab82617fa3fa9f21d4cd427314ecc4af8">LR11x0::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_l_r11x0_html_aba13921d2cf29cc1bc8a648e1f330aa9"><div class="ttname"><a href="class_l_r11x0.html#aba13921d2cf29cc1bc8a648e1f330aa9">LR11x0::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> LR11x0.cpp:1419</div></div>
<div class="ttc" id="aclass_l_r11x0_html_abcc4c776d1a09bb002226ac95574766d"><div class="ttname"><a href="class_l_r11x0.html#abcc4c776d1a09bb002226ac95574766d">LR11x0::beginGFSK</a></div><div class="ttdeci">int16_t beginGFSK(float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage)</div><div class="ttdoc">Initialization method for FSK modem.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:60</div></div>
<div class="ttc" id="aclass_l_r11x0_html_abccf5dc80aab71090a5f19bfffa0201d"><div class="ttname"><a href="class_l_r11x0.html#abccf5dc80aab71090a5f19bfffa0201d">LR11x0::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> LR11x0.cpp:1297</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ac003cfe3a4dbd9bad1f01fd0147031d1"><div class="ttname"><a href="class_l_r11x0.html#ac003cfe3a4dbd9bad1f01fd0147031d1">LR11x0::setFrequencyDeviation</a></div><div class="ttdeci">int16_t setFrequencyDeviation(float freqDev) override</div><div class="ttdoc">Sets GFSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:794</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ac1f541bdee1d983126ceae47940b8f9d"><div class="ttname"><a href="class_l_r11x0.html#ac1f541bdee1d983126ceae47940b8f9d">LR11x0::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> LR11x0.cpp:1278</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ac2a8ece736198c966e3870dac09f4e87"><div class="ttname"><a href="class_l_r11x0.html#ac2a8ece736198c966e3870dac09f4e87">LR11x0::setPacketReceivedAction</a></div><div class="ttdeci">void setPacketReceivedAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:399</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ac6b6b460ba12cd92a08df16e1fe33779"><div class="ttname"><a href="class_l_r11x0.html#ac6b6b460ba12cd92a08df16e1fe33779">LR11x0::getVersionInfo</a></div><div class="ttdeci">int16_t getVersionInfo(LR11x0VersionInfo_t *info)</div><div class="ttdoc">Retrieve LR11x0 hardware, device and firmware version information.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1676</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ad5876b44020a0bd59f73186a912dbb60"><div class="ttname"><a href="class_l_r11x0.html#ad5876b44020a0bd59f73186a912dbb60">LR11x0::clearWiFiScanAction</a></div><div class="ttdeci">void clearWiFiScanAction()</div><div class="ttdoc">Clears interrupt service routine to call when a WiFi scan is completed.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1555</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ac6b6b460ba12cd92a08df16e1fe33779"><div class="ttname"><a href="class_l_r11x0.html#ac6b6b460ba12cd92a08df16e1fe33779">LR11x0::getVersionInfo</a></div><div class="ttdeci">int16_t getVersionInfo(LR11x0VersionInfo_t *info)</div><div class="ttdoc">Retrieve LR11x0 hardware, device and firmware version information.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1677</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ad5876b44020a0bd59f73186a912dbb60"><div class="ttname"><a href="class_l_r11x0.html#ad5876b44020a0bd59f73186a912dbb60">LR11x0::clearWiFiScanAction</a></div><div class="ttdeci">void clearWiFiScanAction()</div><div class="ttdoc">Clears interrupt service routine to call when a WiFi scan is completed.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1560</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ad5dde79f751bbd7ea277872e237f2a69"><div class="ttname"><a href="class_l_r11x0.html#ad5dde79f751bbd7ea277872e237f2a69">LR11x0::sleep</a></div><div class="ttdeci">int16_t sleep() override</div><div class="ttdoc">Sets the module to sleep mode. To wake the device up, call standby(). Overload with warm start enable...</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:366</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ad7f31060cbab41ad53ee6fa7126cd17b"><div class="ttname"><a href="class_l_r11x0.html#ad7f31060cbab41ad53ee6fa7126cd17b">LR11x0::beginGNSS</a></div><div class="ttdeci">int16_t beginGNSS(uint8_t constellations=RADIOLIB_LR11X0_GNSS_CONSTELLATION_GPS|RADIOLIB_LR11X0_GNSS_CONSTELLATION_BEIDOU, float tcxoVoltage=1.6)</div><div class="ttdoc">Initialization method for GNSS scanning.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:123</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ad9046bccdb4ef60718e2e8ed2bd7f036"><div class="ttname"><a href="class_l_r11x0.html#ad9046bccdb4ef60718e2e8ed2bd7f036">LR11x0::getFrequencyError</a></div><div class="ttdeci">float getFrequencyError()</div><div class="ttdoc">Gets frequency error of the latest received packet.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1273</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ad9bfaf0bdd7045f5d41f18f3f953c294"><div class="ttname"><a href="class_l_r11x0.html#ad9bfaf0bdd7045f5d41f18f3f953c294">LR11x0::gnssScan</a></div><div class="ttdeci">int16_t gnssScan(LR11x0GnssResult_t *res=NULL)</div><div class="ttdoc">Performs GNSS scan.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1804</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ad9bfaf0bdd7045f5d41f18f3f953c294"><div class="ttname"><a href="class_l_r11x0.html#ad9bfaf0bdd7045f5d41f18f3f953c294">LR11x0::gnssScan</a></div><div class="ttdeci">int16_t gnssScan(LR11x0GnssResult_t *res=NULL)</div><div class="ttdoc">Performs GNSS scan.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1801</div></div>
<div class="ttc" id="aclass_l_r11x0_html_adcd56cf63e91449b6cd03782a69c3451"><div class="ttname"><a href="class_l_r11x0.html#adcd56cf63e91449b6cd03782a69c3451">LR11x0::variablePacketLengthMode</a></div><div class="ttdeci">int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_LR11X0_MAX_PACKET_LENGTH)</div><div class="ttdoc">Set modem in variable packet length mode. Available in GFSK mode only.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1025</div></div>
<div class="ttc" id="aclass_l_r11x0_html_adcde55b8660c24cf5783942a4132786d"><div class="ttname"><a href="class_l_r11x0.html#adcde55b8660c24cf5783942a4132786d">LR11x0::setWhitening</a></div><div class="ttdeci">int16_t setWhitening(bool enabled, uint16_t initial=0x01FF)</div><div class="ttdoc">Sets GFSK whitening parameters.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1029</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ade5478296ebc7e02281c95609d5d75ab"><div class="ttname"><a href="class_l_r11x0.html#ade5478296ebc7e02281c95609d5d75ab">LR11x0::wifiScan</a></div><div class="ttdeci">int16_t wifiScan(uint8_t wifiType, uint8_t *count, uint8_t mode=RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON, uint16_t chanMask=RADIOLIB_LR11X0_WIFI_ALL_CHANNELS, uint8_t numScans=16, uint16_t timeout=100)</div><div class="ttdoc">Blocking WiFi scan method. Performs a full passive WiFi scan. This method may block for several secon...</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1649</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ade5478296ebc7e02281c95609d5d75ab"><div class="ttname"><a href="class_l_r11x0.html#ade5478296ebc7e02281c95609d5d75ab">LR11x0::wifiScan</a></div><div class="ttdeci">int16_t wifiScan(uint8_t wifiType, uint8_t *count, uint8_t mode=RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON, uint16_t chanMask=RADIOLIB_LR11X0_WIFI_ALL_CHANNELS, uint8_t numScans=16, uint16_t timeout=100)</div><div class="ttdoc">Blocking WiFi scan method. Performs a full passive WiFi scan. This method may block for several secon...</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1652</div></div>
<div class="ttc" id="aclass_l_r11x0_html_adf6895cbf7af7e00ea06c5b2b5040cb4"><div class="ttname"><a href="class_l_r11x0.html#adf6895cbf7af7e00ea06c5b2b5040cb4">LR11x0::setSpreadingFactor</a></div><div class="ttdeci">int16_t setSpreadingFactor(uint8_t sf, bool legacy=false)</div><div class="ttdoc">Sets LoRa spreading factor. Allowed values range from 5 to 12.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:707</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ae077957969f6274a53f63b314b6f1359"><div class="ttname"><a href="class_l_r11x0.html#ae077957969f6274a53f63b314b6f1359">LR11x0::transmitDirect</a></div><div class="ttdeci">int16_t transmitDirect(uint32_t frf=0) override</div><div class="ttdoc">Starts direct mode transmission.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:295</div></div>
<div class="ttc" id="aclass_l_r11x0_html_ae0a47e772fe24c7b3f3d3288c4cd0941"><div class="ttname"><a href="class_l_r11x0.html#ae0a47e772fe24c7b3f3d3288c4cd0941">LR11x0::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> LR11x0.cpp:1466</div></div>
@ -1386,8 +1386,8 @@ $(document).ready(function(){initNavTree('_l_r11x0_8h_source.html',''); initResi
<div class="ttc" id="aclass_l_r11x0_html_ae565dc2423ca7df13bf7ae48cce9ac8b"><div class="ttname"><a href="class_l_r11x0.html#ae565dc2423ca7df13bf7ae48cce9ac8b">LR11x0::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> LR11x0.cpp:969</div></div>
<div class="ttc" id="aclass_l_r11x0_html_af24ba794f71c4e37cd13d2f4dbec5bf7"><div class="ttname"><a href="class_l_r11x0.html#af24ba794f71c4e37cd13d2f4dbec5bf7">LR11x0::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> LR11x0.cpp:951</div></div>
<div class="ttc" id="aclass_l_r11x0_html_af85c16956c2250dbf338a298c074d28c"><div class="ttname"><a href="class_l_r11x0.html#af85c16956c2250dbf338a298c074d28c">LR11x0::invertIQ</a></div><div class="ttdeci">int16_t invertIQ(bool enable) override</div><div class="ttdoc">Enable/disable inversion of the I and Q signals.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1230</div></div>
<div class="ttc" id="aclass_l_r11x0_html_afe8684b336a8137cde591283297a869c"><div class="ttname"><a href="class_l_r11x0.html#afe8684b336a8137cde591283297a869c">LR11x0::getModem</a></div><div class="ttdeci">int16_t getModem(ModemType_t *modem) override</div><div class="ttdoc">Get modem currently in use by the radio.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:2012</div></div>
<div class="ttc" id="aclass_l_r11x0_html_aff6060e116701c60e078d3d930723b4b"><div class="ttname"><a href="class_l_r11x0.html#aff6060e116701c60e078d3d930723b4b">LR11x0::setWiFiScanAction</a></div><div class="ttdeci">void setWiFiScanAction(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when a WiFi scan is completed.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1551</div></div>
<div class="ttc" id="aclass_l_r11x0_html_afe8684b336a8137cde591283297a869c"><div class="ttname"><a href="class_l_r11x0.html#afe8684b336a8137cde591283297a869c">LR11x0::getModem</a></div><div class="ttdeci">int16_t getModem(ModemType_t *modem) override</div><div class="ttdoc">Get modem currently in use by the radio.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:2002</div></div>
<div class="ttc" id="aclass_l_r11x0_html_aff6060e116701c60e078d3d930723b4b"><div class="ttname"><a href="class_l_r11x0.html#aff6060e116701c60e078d3d930723b4b">LR11x0::setWiFiScanAction</a></div><div class="ttdeci">void setWiFiScanAction(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when a WiFi scan is completed.</div><div class="ttdef"><b>Definition:</b> LR11x0.cpp:1556</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 methods to control the wireless module. Every module class contains o...</div><div class="ttdef"><b>Definition:</b> Module.h:66</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. Note: It is not recommended to use this c...</div><div class="ttdef"><b>Definition:</b> Module.h:75</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="ttdoc">Transmission mode.</div><div class="ttdef"><b>Definition:</b> Module.h:112</div></div>
@ -1395,10 +1395,10 @@ $(document).ready(function(){initNavTree('_l_r11x0_8h_source.html',''); initResi
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa7664838bb0818663f55b3354fec8a18f">Module::MODE_RX</a></div><div class="ttdeci">@ MODE_RX</div><div class="ttdoc">Receive mode.</div><div class="ttdef"><b>Definition:</b> Module.h:109</div></div>
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa81cdd8986054c2ae5657eb5dfd536770">Module::MODE_END_OF_TABLE</a></div><div class="ttdeci">@ MODE_END_OF_TABLE</div><div class="ttdoc">End of table marker, use END_OF_MODE_TABLE constant instead. Value is zero to ensure zero-initialized...</div><div class="ttdef"><b>Definition:</b> Module.h:103</div></div>
<div class="ttc" id="aclass_physical_layer_html"><div class="ttname"><a href="class_physical_layer.html">PhysicalLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:151</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:210</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:206</div></div>
<div class="ttc" id="aclass_physical_layer_html_a492b2d057dd803c3884fa1adc8e22534"><div class="ttname"><a href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">PhysicalLayer::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:53</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:150</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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:113</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:148</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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="agroup__typedefs_html_ga210f31dd2bff7fb80563275648a5bbbd"><div class="ttname"><a href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a></div><div class="ttdeci">unsigned long RadioLibTime_t</div><div class="ttdoc">Type used for durations in RadioLib.</div><div class="ttdef"><b>Definition:</b> TypeDef.h:642</div></div>
<div class="ttc" id="astruct_l_r11x0_gnss_almanac_status__t_html"><div class="ttname"><a href="struct_l_r11x0_gnss_almanac_status__t.html">LR11x0GnssAlmanacStatus_t</a></div><div class="ttdoc">Structure to save information about the GNSS almanac. This is not the actual almanac,...</div><div class="ttdef"><b>Definition:</b> LR11x0.h:849</div></div>
<div class="ttc" id="astruct_l_r11x0_gnss_almanac_status__t_html_a2228a69fda1002c027b7b487aa579afb"><div class="ttname"><a href="struct_l_r11x0_gnss_almanac_status__t.html#a2228a69fda1002c027b7b487aa579afb">LR11x0GnssAlmanacStatus_t::start</a></div><div class="ttdeci">RadioLibTime_t start</div><div class="ttdoc">Timestamp of when almanac status was retrieved - timeUntilSubframe is relative to this value.</div><div class="ttdef"><b>Definition:</b> LR11x0.h:863</div></div>

2
_pager_8h_source.html
View file

@ -212,7 +212,7 @@ $(document).ready(function(){initNavTree('_pager_8h_source.html',''); initResiza
<div class="ttc" id="aclass_pager_client_html_a8f9af4c0a5c2e9de7cdfa1a907479111"><div class="ttname"><a href="class_pager_client.html#a8f9af4c0a5c2e9de7cdfa1a907479111">PagerClient::sendTone</a></div><div class="ttdeci">int16_t sendTone(uint32_t addr)</div><div class="ttdoc">Method to send a tone-only alert to a destination pager.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:59</div></div>
<div class="ttc" id="aclass_pager_client_html_a9f978120467b13104fb356e9b7d855ec"><div class="ttname"><a href="class_pager_client.html#a9f978120467b13104fb356e9b7d855ec">PagerClient::PagerClient</a></div><div class="ttdeci">PagerClient(PhysicalLayer *phy)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:28</div></div>
<div class="ttc" id="aclass_pager_client_html_ac232570ac012ff315a1971ab0422fed3"><div class="ttname"><a href="class_pager_client.html#ac232570ac012ff315a1971ab0422fed3">PagerClient::startReceive</a></div><div class="ttdeci">int16_t startReceive(uint32_t pin, uint32_t addr, uint32_t mask=0xFFFFF)</div><div class="ttdoc">Start reception of POCSAG packets.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:245</div></div>
<div class="ttc" id="aclass_pager_client_html_ad2c6132819a84712b929c0bb22ba172b"><div class="ttname"><a href="class_pager_client.html#ad2c6132819a84712b929c0bb22ba172b">PagerClient::readData</a></div><div class="ttdeci">int16_t readData(uint8_t *data, size_t *len, uint32_t *addr=NULL)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:350</div></div>
<div class="ttc" id="aclass_pager_client_html_ad2c6132819a84712b929c0bb22ba172b"><div class="ttname"><a href="class_pager_client.html#ad2c6132819a84712b929c0bb22ba172b">PagerClient::readData</a></div><div class="ttdeci">int16_t readData(uint8_t *data, size_t *len, uint32_t *addr=NULL)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:348</div></div>
<div class="ttc" id="aclass_pager_client_html_adbab4e162a5719bd4407a42a85d26ff6"><div class="ttname"><a href="class_pager_client.html#adbab4e162a5719bd4407a42a85d26ff6">PagerClient::transmit</a></div><div class="ttdeci">int16_t transmit(const char *str, uint32_t addr, uint8_t encoding=RADIOLIB_PAGER_BCD, uint8_t function=RADIOLIB_PAGER_FUNC_AUTO)</div><div class="ttdoc">C-string transmit method.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:69</div></div>
<div class="ttc" id="aclass_pager_client_html_aec073fa9e5adcff9730482d9583715e9"><div class="ttname"><a href="class_pager_client.html#aec073fa9e5adcff9730482d9583715e9">PagerClient::available</a></div><div class="ttdeci">size_t available()</div><div class="ttdoc">Get the number of POCSAG batches available in buffer. Limited by the size of direct mode buffer!</div><div class="ttdef"><b>Definition:</b> Pager.cpp:299</div></div>
<div class="ttc" id="aclass_physical_layer_html"><div class="ttname"><a href="class_physical_layer.html">PhysicalLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:151</div></div>

110
_physical_layer_8h_source.html
View file

@ -395,63 +395,63 @@ $(document).ready(function(){initNavTree('_physical_layer_8h_source.html',''); i
<div class="ttc" id="aclass_morse_client_html"><div class="ttname"><a href="class_morse_client.html">MorseClient</a></div><div class="ttdoc">Client for Morse Code communication. The public interface is the same as Arduino Serial.</div><div class="ttdef"><b>Definition:</b> Morse.h:93</div></div>
<div class="ttc" id="aclass_pager_client_html"><div class="ttname"><a href="class_pager_client.html">PagerClient</a></div><div class="ttdoc">Client for Pager communication.</div><div class="ttdef"><b>Definition:</b> Pager.h:62</div></div>
<div class="ttc" id="aclass_physical_layer_html"><div class="ttname"><a href="class_physical_layer.html">PhysicalLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:151</div></div>
<div class="ttc" id="aclass_physical_layer_html_a11b4c6d0bf3ae7b9ca04e9434180feab"><div class="ttname"><a href="class_physical_layer.html#a11b4c6d0bf3ae7b9ca04e9434180feab">PhysicalLayer::invertIQ</a></div><div class="ttdeci">virtual int16_t invertIQ(bool enable)</div><div class="ttdoc">Set IQ inversion. Must be implemented in module class if the module supports it.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:250</div></div>
<div class="ttc" id="aclass_physical_layer_html_a169a4d04c5c50d3336e274d70930d9f6"><div class="ttname"><a href="class_physical_layer.html#a169a4d04c5c50d3336e274d70930d9f6">PhysicalLayer::clearChannelScanAction</a></div><div class="ttdeci">virtual void clearChannelScanAction()</div><div class="ttdoc">Clears interrupt service routine to call when a channel scan is finished.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:530</div></div>
<div class="ttc" id="aclass_physical_layer_html_a1784cb227d04b3f2846625fda6797536"><div class="ttname"><a href="class_physical_layer.html#a1784cb227d04b3f2846625fda6797536">PhysicalLayer::checkOutputPower</a></div><div class="ttdeci">virtual int16_t checkOutputPower(int8_t power, int8_t *clipped)</div><div class="ttdoc">Check if output power is configurable. Must be implemented in module class if the module supports it.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:260</div></div>
<div class="ttc" id="aclass_physical_layer_html_a18664ad615c5507ff1690baaca90b094"><div class="ttname"><a href="class_physical_layer.html#a18664ad615c5507ff1690baaca90b094">PhysicalLayer::startReceive</a></div><div class="ttdeci">virtual int16_t startReceive()</div><div class="ttdoc">Sets module to received mode using its default configuration.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:132</div></div>
<div class="ttc" id="aclass_physical_layer_html_a1a5985308904261dd431f373d47ddee4"><div class="ttname"><a href="class_physical_layer.html#a1a5985308904261dd431f373d47ddee4">PhysicalLayer::randomByte</a></div><div class="ttdeci">virtual uint8_t randomByte()</div><div class="ttdoc">Get one truly random byte from RSSI noise. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:405</div></div>
<div class="ttc" id="aclass_physical_layer_html_a1de26f68b939f5af79ec29cc34c7be18"><div class="ttname"><a href="class_physical_layer.html#a1de26f68b939f5af79ec29cc34c7be18">PhysicalLayer::finishTransmit</a></div><div class="ttdeci">virtual int16_t finishTransmit()</div><div class="ttdoc">Clean up after transmission is done.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:161</div></div>
<div class="ttc" id="aclass_physical_layer_html_a2c7dd4704e3df353265010710bd26e83"><div class="ttname"><a href="class_physical_layer.html#a2c7dd4704e3df353265010710bd26e83">PhysicalLayer::checkIrq</a></div><div class="ttdeci">int16_t checkIrq(RadioLibIrqType_t irq)</div><div class="ttdoc">Check whether a specific IRQ bit is set (e.g. RxTimeout, CadDone).</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:326</div></div>
<div class="ttc" id="aclass_physical_layer_html_a2f4f9b428d9ea9af886ca85e5088ed7b"><div class="ttname"><a href="class_physical_layer.html#a2f4f9b428d9ea9af886ca85e5088ed7b">PhysicalLayer::setFrequencyDeviation</a></div><div class="ttdeci">virtual int16_t setFrequencyDeviation(float freqDev)</div><div class="ttdoc">Sets FSK frequency deviation from carrier frequency. Only available in FSK mode. Must be implemented ...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:235</div></div>
<div class="ttc" id="aclass_physical_layer_html_a2fe95169b5cdc8cabe1f2af66cad6ef6"><div class="ttname"><a href="class_physical_layer.html#a2fe95169b5cdc8cabe1f2af66cad6ef6">PhysicalLayer::getPacketLength</a></div><div class="ttdeci">virtual size_t getPacketLength(bool update=true)</div><div class="ttdoc">Query modem for the packet length of received payload. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:291</div></div>
<div class="ttc" id="aclass_physical_layer_html_a32b512b34f6575b2109ae3c3f35d1369"><div class="ttname"><a href="class_physical_layer.html#a32b512b34f6575b2109ae3c3f35d1369">PhysicalLayer::setPacketSentAction</a></div><div class="ttdeci">virtual void setPacketSentAction(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:518</div></div>
<div class="ttc" id="aclass_physical_layer_html_a349e8a22cd28ad89d45460fdeeefc05c"><div class="ttname"><a href="class_physical_layer.html#a349e8a22cd28ad89d45460fdeeefc05c">PhysicalLayer::setDIOMapping</a></div><div class="ttdeci">virtual int16_t setDIOMapping(uint32_t pin, uint32_t value)</div><div class="ttdoc">Configure DIO pin mapping to get a given signal on a DIO pin (if available).</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:504</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:210</div></div>
<div class="ttc" id="aclass_physical_layer_html_a429796eb2e7ea86781a2e8ca42af43f3"><div class="ttname"><a href="class_physical_layer.html#a429796eb2e7ea86781a2e8ca42af43f3">PhysicalLayer::dropSync</a></div><div class="ttdeci">void dropSync()</div><div class="ttdoc">Forcefully drop synchronization.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:428</div></div>
<div class="ttc" id="aclass_physical_layer_html_a11b4c6d0bf3ae7b9ca04e9434180feab"><div class="ttname"><a href="class_physical_layer.html#a11b4c6d0bf3ae7b9ca04e9434180feab">PhysicalLayer::invertIQ</a></div><div class="ttdeci">virtual int16_t invertIQ(bool enable)</div><div class="ttdoc">Set IQ inversion. Must be implemented in module class if the module supports it.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:246</div></div>
<div class="ttc" id="aclass_physical_layer_html_a169a4d04c5c50d3336e274d70930d9f6"><div class="ttname"><a href="class_physical_layer.html#a169a4d04c5c50d3336e274d70930d9f6">PhysicalLayer::clearChannelScanAction</a></div><div class="ttdeci">virtual void clearChannelScanAction()</div><div class="ttdoc">Clears interrupt service routine to call when a channel scan is finished.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:526</div></div>
<div class="ttc" id="aclass_physical_layer_html_a1784cb227d04b3f2846625fda6797536"><div class="ttname"><a href="class_physical_layer.html#a1784cb227d04b3f2846625fda6797536">PhysicalLayer::checkOutputPower</a></div><div class="ttdeci">virtual int16_t checkOutputPower(int8_t power, int8_t *clipped)</div><div class="ttdoc">Check if output power is configurable. Must be implemented in module class if the module supports it.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:256</div></div>
<div class="ttc" id="aclass_physical_layer_html_a18664ad615c5507ff1690baaca90b094"><div class="ttname"><a href="class_physical_layer.html#a18664ad615c5507ff1690baaca90b094">PhysicalLayer::startReceive</a></div><div class="ttdeci">virtual int16_t startReceive()</div><div class="ttdoc">Sets module to received mode using its default configuration.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:130</div></div>
<div class="ttc" id="aclass_physical_layer_html_a1a5985308904261dd431f373d47ddee4"><div class="ttname"><a href="class_physical_layer.html#a1a5985308904261dd431f373d47ddee4">PhysicalLayer::randomByte</a></div><div class="ttdeci">virtual uint8_t randomByte()</div><div class="ttdoc">Get one truly random byte from RSSI noise. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:401</div></div>
<div class="ttc" id="aclass_physical_layer_html_a1de26f68b939f5af79ec29cc34c7be18"><div class="ttname"><a href="class_physical_layer.html#a1de26f68b939f5af79ec29cc34c7be18">PhysicalLayer::finishTransmit</a></div><div class="ttdeci">virtual int16_t finishTransmit()</div><div class="ttdoc">Clean up after transmission is done.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:159</div></div>
<div class="ttc" id="aclass_physical_layer_html_a2c7dd4704e3df353265010710bd26e83"><div class="ttname"><a href="class_physical_layer.html#a2c7dd4704e3df353265010710bd26e83">PhysicalLayer::checkIrq</a></div><div class="ttdeci">int16_t checkIrq(RadioLibIrqType_t irq)</div><div class="ttdoc">Check whether a specific IRQ bit is set (e.g. RxTimeout, CadDone).</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:322</div></div>
<div class="ttc" id="aclass_physical_layer_html_a2f4f9b428d9ea9af886ca85e5088ed7b"><div class="ttname"><a href="class_physical_layer.html#a2f4f9b428d9ea9af886ca85e5088ed7b">PhysicalLayer::setFrequencyDeviation</a></div><div class="ttdeci">virtual int16_t setFrequencyDeviation(float freqDev)</div><div class="ttdoc">Sets FSK frequency deviation from carrier frequency. Only available in FSK mode. Must be implemented ...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:231</div></div>
<div class="ttc" id="aclass_physical_layer_html_a2fe95169b5cdc8cabe1f2af66cad6ef6"><div class="ttname"><a href="class_physical_layer.html#a2fe95169b5cdc8cabe1f2af66cad6ef6">PhysicalLayer::getPacketLength</a></div><div class="ttdeci">virtual size_t getPacketLength(bool update=true)</div><div class="ttdoc">Query modem for the packet length of received payload. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:287</div></div>
<div class="ttc" id="aclass_physical_layer_html_a32b512b34f6575b2109ae3c3f35d1369"><div class="ttname"><a href="class_physical_layer.html#a32b512b34f6575b2109ae3c3f35d1369">PhysicalLayer::setPacketSentAction</a></div><div class="ttdeci">virtual void setPacketSentAction(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:514</div></div>
<div class="ttc" id="aclass_physical_layer_html_a349e8a22cd28ad89d45460fdeeefc05c"><div class="ttname"><a href="class_physical_layer.html#a349e8a22cd28ad89d45460fdeeefc05c">PhysicalLayer::setDIOMapping</a></div><div class="ttdeci">virtual int16_t setDIOMapping(uint32_t pin, uint32_t value)</div><div class="ttdoc">Configure DIO pin mapping to get a given signal on a DIO pin (if available).</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:500</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:206</div></div>
<div class="ttc" id="aclass_physical_layer_html_a429796eb2e7ea86781a2e8ca42af43f3"><div class="ttname"><a href="class_physical_layer.html#a429796eb2e7ea86781a2e8ca42af43f3">PhysicalLayer::dropSync</a></div><div class="ttdeci">void dropSync()</div><div class="ttdoc">Forcefully drop synchronization.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:424</div></div>
<div class="ttc" id="aclass_physical_layer_html_a492b2d057dd803c3884fa1adc8e22534"><div class="ttname"><a href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">PhysicalLayer::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:53</div></div>
<div class="ttc" id="aclass_physical_layer_html_a4d5b30493c8d7fcfb784e128362d596c"><div class="ttname"><a href="class_physical_layer.html#a4d5b30493c8d7fcfb784e128362d596c">PhysicalLayer::read</a></div><div class="ttdeci">uint8_t read(bool drop=true)</div><div class="ttdoc">Get data from direct mode buffer.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:435</div></div>
<div class="ttc" id="aclass_physical_layer_html_a50e730a894f60b58034507ad7730dd3c"><div class="ttname"><a href="class_physical_layer.html#a50e730a894f60b58034507ad7730dd3c">PhysicalLayer::getTimeOnAir</a></div><div class="ttdeci">virtual RadioLibTime_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> PhysicalLayer.cpp:304</div></div>
<div class="ttc" id="aclass_physical_layer_html_a58d54eeb40fb586013ba48e15318abba"><div class="ttname"><a href="class_physical_layer.html#a58d54eeb40fb586013ba48e15318abba">PhysicalLayer::checkDataRate</a></div><div class="ttdeci">virtual int16_t checkDataRate(DataRate_t dr)</div><div class="ttdoc">Check the data rate can be configured by this module. Must be implemented in module class if the modu...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:282</div></div>
<div class="ttc" id="aclass_physical_layer_html_a63979795a7b53557560bb95b65480906"><div class="ttname"><a href="class_physical_layer.html#a63979795a7b53557560bb95b65480906">PhysicalLayer::getChannelScanResult</a></div><div class="ttdeci">virtual int16_t getChannelScanResult()</div><div class="ttdoc">Read the channel scan result.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:365</div></div>
<div class="ttc" id="aclass_physical_layer_html_a67ee4ec36f352d06dda0102260f6bfce"><div class="ttname"><a href="class_physical_layer.html#a67ee4ec36f352d06dda0102260f6bfce">PhysicalLayer::clearPacketSentAction</a></div><div class="ttdeci">virtual void clearPacketSentAction()</div><div class="ttdoc">Clears interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:522</div></div>
<div class="ttc" id="aclass_physical_layer_html_a6c71cdc1238e1368274670758431a977"><div class="ttname"><a href="class_physical_layer.html#a6c71cdc1238e1368274670758431a977">PhysicalLayer::setSyncWord</a></div><div class="ttdeci">virtual int16_t setSyncWord(uint8_t *sync, size_t len)</div><div class="ttdoc">Set sync word. Must be implemented in module class if the module supports it.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:266</div></div>
<div class="ttc" id="aclass_physical_layer_html_a6ee1fed6bbb8d3571974153ac6f26751"><div class="ttname"><a href="class_physical_layer.html#a6ee1fed6bbb8d3571974153ac6f26751">PhysicalLayer::setDataRate</a></div><div class="ttdeci">virtual int16_t setDataRate(DataRate_t dr)</div><div class="ttdoc">Set data. Must be implemented in module class if the module supports it.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:277</div></div>
<div class="ttc" id="aclass_physical_layer_html_a77415bf4ed34be18c92c0cf4b2de7149"><div class="ttname"><a href="class_physical_layer.html#a77415bf4ed34be18c92c0cf4b2de7149">PhysicalLayer::setModem</a></div><div class="ttdeci">virtual int16_t setModem(ModemType_t modem)</div><div class="ttdoc">Set modem for the radio to use. Will perform full reset and reconfigure the radio using its default p...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:534</div></div>
<div class="ttc" id="aclass_physical_layer_html_a7edf27f03600b96f72f011fc82fa4ef9"><div class="ttname"><a href="class_physical_layer.html#a7edf27f03600b96f72f011fc82fa4ef9">PhysicalLayer::clearPacketReceivedAction</a></div><div class="ttdeci">virtual void clearPacketReceivedAction()</div><div class="ttdoc">Clears interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:514</div></div>
<div class="ttc" id="aclass_physical_layer_html_a7f8d12a90158864a8ebc471b0ec89dc9"><div class="ttname"><a href="class_physical_layer.html#a7f8d12a90158864a8ebc471b0ec89dc9">PhysicalLayer::calculateRxTimeout</a></div><div class="ttdeci">virtual RadioLibTime_t calculateRxTimeout(RadioLibTime_t timeoutUs)</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> PhysicalLayer.cpp:309</div></div>
<div class="ttc" id="aclass_physical_layer_html_a8564f9834a0247e93e7620c23559ceb8"><div class="ttname"><a href="class_physical_layer.html#a8564f9834a0247e93e7620c23559ceb8">PhysicalLayer::setIrq</a></div><div class="ttdeci">int16_t setIrq(RadioLibIrqFlags_t irq)</div><div class="ttdoc">Set interrupt on specific IRQ bit(s) (e.g. RxTimeout, CadDone). Keep in mind that not all radio modul...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:334</div></div>
<div class="ttc" id="aclass_physical_layer_html_a85db1ff64e6c56e054f276c511194633"><div class="ttname"><a href="class_physical_layer.html#a85db1ff64e6c56e054f276c511194633">PhysicalLayer::setPreambleLength</a></div><div class="ttdeci">virtual int16_t setPreambleLength(size_t len)</div><div class="ttdoc">Set preamble length. Must be implemented in module class if the module supports it.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:272</div></div>
<div class="ttc" id="aclass_physical_layer_html_a88a10657bd2215a11a2331f937414b55"><div class="ttname"><a href="class_physical_layer.html#a88a10657bd2215a11a2331f937414b55">PhysicalLayer::startDirect</a></div><div class="ttdeci">int16_t startDirect()</div><div class="ttdoc">Configure module parameters for direct modes. Must be called prior to &quot;ham&quot; modes like RTTY or AX....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:409</div></div>
<div class="ttc" id="aclass_physical_layer_html_a8a194b0fbb66b1a953288bf3b9478d6e"><div class="ttname"><a href="class_physical_layer.html#a8a194b0fbb66b1a953288bf3b9478d6e">PhysicalLayer::setFrequency</a></div><div class="ttdeci">virtual int16_t setFrequency(float freq)</div><div class="ttdoc">Sets carrier frequency. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:225</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:443</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:150</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:287</div></div>
<div class="ttc" id="aclass_physical_layer_html_aa4c99ac794ee653c2061be4201724b65"><div class="ttname"><a href="class_physical_layer.html#aa4c99ac794ee653c2061be4201724b65">PhysicalLayer::transmitDirect</a></div><div class="ttdeci">virtual int16_t transmitDirect(uint32_t frf=0)</div><div class="ttdoc">Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module ...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:216</div></div>
<div class="ttc" id="aclass_physical_layer_html_aabc94ab27a9ee6daaafa9b47dde5f75b"><div class="ttname"><a href="class_physical_layer.html#aabc94ab27a9ee6daaafa9b47dde5f75b">PhysicalLayer::getRSSI</a></div><div class="ttdeci">virtual float getRSSI()</div><div class="ttdoc">Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:296</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab57182d32646861ef0d865e2740d6b26"><div class="ttname"><a href="class_physical_layer.html#ab57182d32646861ef0d865e2740d6b26">PhysicalLayer::available</a></div><div class="ttdeci">int16_t available()</div><div class="ttdoc">Get the number of direct mode bytes currently available in buffer.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:424</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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:113</div></div>
<div class="ttc" id="aclass_physical_layer_html_abd9e39cc745acbf084cfa0d3f4d10718"><div class="ttname"><a href="class_physical_layer.html#abd9e39cc745acbf084cfa0d3f4d10718">PhysicalLayer::scanChannel</a></div><div class="ttdeci">virtual int16_t scanChannel()</div><div class="ttdoc">Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules,...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:369</div></div>
<div class="ttc" id="aclass_physical_layer_html_abf96cf4f3cb4c82d44be581dbe615966"><div class="ttname"><a href="class_physical_layer.html#abf96cf4f3cb4c82d44be581dbe615966">PhysicalLayer::setDirectAction</a></div><div class="ttdeci">virtual void setDirectAction(void(*func)(void))</div><div class="ttdoc">Set interrupt service routine function to call when data bit is received in direct mode....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:494</div></div>
<div class="ttc" id="aclass_physical_layer_html_ac282bb78da4f4da4661dce191cbd6d87"><div class="ttname"><a href="class_physical_layer.html#ac282bb78da4f4da4661dce191cbd6d87">PhysicalLayer::clearIrqFlags</a></div><div class="ttdeci">virtual int16_t clearIrqFlags(uint32_t irq)</div><div class="ttdoc">Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone). Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:351</div></div>
<div class="ttc" id="aclass_physical_layer_html_acb45b2342400a03a914a91d2ac7fb488"><div class="ttname"><a href="class_physical_layer.html#acb45b2342400a03a914a91d2ac7fb488">PhysicalLayer::setEncoding</a></div><div class="ttdeci">virtual int16_t setEncoding(uint8_t encoding)</div><div class="ttdoc">Sets FSK data encoding. Only available in FSK mode. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:245</div></div>
<div class="ttc" id="aclass_physical_layer_html_acbcaf6aefcb77a354797e66222fe5018"><div class="ttname"><a href="class_physical_layer.html#acbcaf6aefcb77a354797e66222fe5018">PhysicalLayer::standby</a></div><div class="ttdeci">virtual int16_t standby()</div><div class="ttdoc">Sets module to standby.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:123</div></div>
<div class="ttc" id="aclass_physical_layer_html_acd9171bd71aa80fb86113b612c42de53"><div class="ttname"><a href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">PhysicalLayer::random</a></div><div class="ttdeci">int32_t random(int32_t max)</div><div class="ttdoc">Get truly random number in range 0 - max.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:378</div></div>
<div class="ttc" id="aclass_physical_layer_html_acda61fc99cfa373153c50c78380ed885"><div class="ttname"><a href="class_physical_layer.html#acda61fc99cfa373153c50c78380ed885">PhysicalLayer::readBit</a></div><div class="ttdeci">virtual void readBit(uint32_t pin)</div><div class="ttdoc">Function to read and process data bit in direct reception mode. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:498</div></div>
<div class="ttc" id="aclass_physical_layer_html_ad2286dc78dbf8e3084f38e9159b99ae5"><div class="ttname"><a href="class_physical_layer.html#ad2286dc78dbf8e3084f38e9159b99ae5">PhysicalLayer::setOutputPower</a></div><div class="ttdeci">virtual int16_t setOutputPower(int8_t power)</div><div class="ttdoc">Set output power. Must be implemented in module class if the module supports it.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:255</div></div>
<div class="ttc" id="aclass_physical_layer_html_ad9d1dbb2041e87af5a80e12f125a60e6"><div class="ttname"><a href="class_physical_layer.html#ad9d1dbb2041e87af5a80e12f125a60e6">PhysicalLayer::receiveDirect</a></div><div class="ttdeci">virtual int16_t receiveDirect()</div><div class="ttdoc">Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module cla...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:221</div></div>
<div class="ttc" id="aclass_physical_layer_html_a4d5b30493c8d7fcfb784e128362d596c"><div class="ttname"><a href="class_physical_layer.html#a4d5b30493c8d7fcfb784e128362d596c">PhysicalLayer::read</a></div><div class="ttdeci">uint8_t read(bool drop=true)</div><div class="ttdoc">Get data from direct mode buffer.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:431</div></div>
<div class="ttc" id="aclass_physical_layer_html_a50e730a894f60b58034507ad7730dd3c"><div class="ttname"><a href="class_physical_layer.html#a50e730a894f60b58034507ad7730dd3c">PhysicalLayer::getTimeOnAir</a></div><div class="ttdeci">virtual RadioLibTime_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> PhysicalLayer.cpp:300</div></div>
<div class="ttc" id="aclass_physical_layer_html_a58d54eeb40fb586013ba48e15318abba"><div class="ttname"><a href="class_physical_layer.html#a58d54eeb40fb586013ba48e15318abba">PhysicalLayer::checkDataRate</a></div><div class="ttdeci">virtual int16_t checkDataRate(DataRate_t dr)</div><div class="ttdoc">Check the data rate can be configured by this module. Must be implemented in module class if the modu...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:278</div></div>
<div class="ttc" id="aclass_physical_layer_html_a63979795a7b53557560bb95b65480906"><div class="ttname"><a href="class_physical_layer.html#a63979795a7b53557560bb95b65480906">PhysicalLayer::getChannelScanResult</a></div><div class="ttdeci">virtual int16_t getChannelScanResult()</div><div class="ttdoc">Read the channel scan result.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:361</div></div>
<div class="ttc" id="aclass_physical_layer_html_a67ee4ec36f352d06dda0102260f6bfce"><div class="ttname"><a href="class_physical_layer.html#a67ee4ec36f352d06dda0102260f6bfce">PhysicalLayer::clearPacketSentAction</a></div><div class="ttdeci">virtual void clearPacketSentAction()</div><div class="ttdoc">Clears interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:518</div></div>
<div class="ttc" id="aclass_physical_layer_html_a6c71cdc1238e1368274670758431a977"><div class="ttname"><a href="class_physical_layer.html#a6c71cdc1238e1368274670758431a977">PhysicalLayer::setSyncWord</a></div><div class="ttdeci">virtual int16_t setSyncWord(uint8_t *sync, size_t len)</div><div class="ttdoc">Set sync word. Must be implemented in module class if the module supports it.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:262</div></div>
<div class="ttc" id="aclass_physical_layer_html_a6ee1fed6bbb8d3571974153ac6f26751"><div class="ttname"><a href="class_physical_layer.html#a6ee1fed6bbb8d3571974153ac6f26751">PhysicalLayer::setDataRate</a></div><div class="ttdeci">virtual int16_t setDataRate(DataRate_t dr)</div><div class="ttdoc">Set data. Must be implemented in module class if the module supports it.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:273</div></div>
<div class="ttc" id="aclass_physical_layer_html_a77415bf4ed34be18c92c0cf4b2de7149"><div class="ttname"><a href="class_physical_layer.html#a77415bf4ed34be18c92c0cf4b2de7149">PhysicalLayer::setModem</a></div><div class="ttdeci">virtual int16_t setModem(ModemType_t modem)</div><div class="ttdoc">Set modem for the radio to use. Will perform full reset and reconfigure the radio using its default p...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:530</div></div>
<div class="ttc" id="aclass_physical_layer_html_a7edf27f03600b96f72f011fc82fa4ef9"><div class="ttname"><a href="class_physical_layer.html#a7edf27f03600b96f72f011fc82fa4ef9">PhysicalLayer::clearPacketReceivedAction</a></div><div class="ttdeci">virtual void clearPacketReceivedAction()</div><div class="ttdoc">Clears interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:510</div></div>
<div class="ttc" id="aclass_physical_layer_html_a7f8d12a90158864a8ebc471b0ec89dc9"><div class="ttname"><a href="class_physical_layer.html#a7f8d12a90158864a8ebc471b0ec89dc9">PhysicalLayer::calculateRxTimeout</a></div><div class="ttdeci">virtual RadioLibTime_t calculateRxTimeout(RadioLibTime_t timeoutUs)</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> PhysicalLayer.cpp:305</div></div>
<div class="ttc" id="aclass_physical_layer_html_a8564f9834a0247e93e7620c23559ceb8"><div class="ttname"><a href="class_physical_layer.html#a8564f9834a0247e93e7620c23559ceb8">PhysicalLayer::setIrq</a></div><div class="ttdeci">int16_t setIrq(RadioLibIrqFlags_t irq)</div><div class="ttdoc">Set interrupt on specific IRQ bit(s) (e.g. RxTimeout, CadDone). Keep in mind that not all radio modul...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:330</div></div>
<div class="ttc" id="aclass_physical_layer_html_a85db1ff64e6c56e054f276c511194633"><div class="ttname"><a href="class_physical_layer.html#a85db1ff64e6c56e054f276c511194633">PhysicalLayer::setPreambleLength</a></div><div class="ttdeci">virtual int16_t setPreambleLength(size_t len)</div><div class="ttdoc">Set preamble length. Must be implemented in module class if the module supports it.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:268</div></div>
<div class="ttc" id="aclass_physical_layer_html_a88a10657bd2215a11a2331f937414b55"><div class="ttname"><a href="class_physical_layer.html#a88a10657bd2215a11a2331f937414b55">PhysicalLayer::startDirect</a></div><div class="ttdeci">int16_t startDirect()</div><div class="ttdoc">Configure module parameters for direct modes. Must be called prior to &quot;ham&quot; modes like RTTY or AX....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:405</div></div>
<div class="ttc" id="aclass_physical_layer_html_a8a194b0fbb66b1a953288bf3b9478d6e"><div class="ttname"><a href="class_physical_layer.html#a8a194b0fbb66b1a953288bf3b9478d6e">PhysicalLayer::setFrequency</a></div><div class="ttdeci">virtual int16_t setFrequency(float freq)</div><div class="ttdoc">Sets carrier frequency. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:221</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:439</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:148</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:283</div></div>
<div class="ttc" id="aclass_physical_layer_html_aa4c99ac794ee653c2061be4201724b65"><div class="ttname"><a href="class_physical_layer.html#aa4c99ac794ee653c2061be4201724b65">PhysicalLayer::transmitDirect</a></div><div class="ttdeci">virtual int16_t transmitDirect(uint32_t frf=0)</div><div class="ttdoc">Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module ...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:212</div></div>
<div class="ttc" id="aclass_physical_layer_html_aabc94ab27a9ee6daaafa9b47dde5f75b"><div class="ttname"><a href="class_physical_layer.html#aabc94ab27a9ee6daaafa9b47dde5f75b">PhysicalLayer::getRSSI</a></div><div class="ttdeci">virtual float getRSSI()</div><div class="ttdoc">Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:292</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab57182d32646861ef0d865e2740d6b26"><div class="ttname"><a href="class_physical_layer.html#ab57182d32646861ef0d865e2740d6b26">PhysicalLayer::available</a></div><div class="ttdeci">int16_t available()</div><div class="ttdoc">Get the number of direct mode bytes currently available in buffer.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:420</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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_physical_layer_html_abd9e39cc745acbf084cfa0d3f4d10718"><div class="ttname"><a href="class_physical_layer.html#abd9e39cc745acbf084cfa0d3f4d10718">PhysicalLayer::scanChannel</a></div><div class="ttdeci">virtual int16_t scanChannel()</div><div class="ttdoc">Check whether the current communication channel is free or occupied. Performs CAD for LoRa modules,...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:365</div></div>
<div class="ttc" id="aclass_physical_layer_html_abf96cf4f3cb4c82d44be581dbe615966"><div class="ttname"><a href="class_physical_layer.html#abf96cf4f3cb4c82d44be581dbe615966">PhysicalLayer::setDirectAction</a></div><div class="ttdeci">virtual void setDirectAction(void(*func)(void))</div><div class="ttdoc">Set interrupt service routine function to call when data bit is received in direct mode....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:490</div></div>
<div class="ttc" id="aclass_physical_layer_html_ac282bb78da4f4da4661dce191cbd6d87"><div class="ttname"><a href="class_physical_layer.html#ac282bb78da4f4da4661dce191cbd6d87">PhysicalLayer::clearIrqFlags</a></div><div class="ttdeci">virtual int16_t clearIrqFlags(uint32_t irq)</div><div class="ttdoc">Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone). Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:347</div></div>
<div class="ttc" id="aclass_physical_layer_html_acb45b2342400a03a914a91d2ac7fb488"><div class="ttname"><a href="class_physical_layer.html#acb45b2342400a03a914a91d2ac7fb488">PhysicalLayer::setEncoding</a></div><div class="ttdeci">virtual int16_t setEncoding(uint8_t encoding)</div><div class="ttdoc">Sets FSK data encoding. Only available in FSK mode. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:241</div></div>
<div class="ttc" id="aclass_physical_layer_html_acbcaf6aefcb77a354797e66222fe5018"><div class="ttname"><a href="class_physical_layer.html#acbcaf6aefcb77a354797e66222fe5018">PhysicalLayer::standby</a></div><div class="ttdeci">virtual int16_t standby()</div><div class="ttdoc">Sets module to standby.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:121</div></div>
<div class="ttc" id="aclass_physical_layer_html_acd9171bd71aa80fb86113b612c42de53"><div class="ttname"><a href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">PhysicalLayer::random</a></div><div class="ttdeci">int32_t random(int32_t max)</div><div class="ttdoc">Get truly random number in range 0 - max.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:374</div></div>
<div class="ttc" id="aclass_physical_layer_html_acda61fc99cfa373153c50c78380ed885"><div class="ttname"><a href="class_physical_layer.html#acda61fc99cfa373153c50c78380ed885">PhysicalLayer::readBit</a></div><div class="ttdeci">virtual void readBit(uint32_t pin)</div><div class="ttdoc">Function to read and process data bit in direct reception mode. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:494</div></div>
<div class="ttc" id="aclass_physical_layer_html_ad2286dc78dbf8e3084f38e9159b99ae5"><div class="ttname"><a href="class_physical_layer.html#ad2286dc78dbf8e3084f38e9159b99ae5">PhysicalLayer::setOutputPower</a></div><div class="ttdeci">virtual int16_t setOutputPower(int8_t power)</div><div class="ttdoc">Set output power. Must be implemented in module class if the module supports it.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:251</div></div>
<div class="ttc" id="aclass_physical_layer_html_ad9d1dbb2041e87af5a80e12f125a60e6"><div class="ttname"><a href="class_physical_layer.html#ad9d1dbb2041e87af5a80e12f125a60e6">PhysicalLayer::receiveDirect</a></div><div class="ttdeci">virtual int16_t receiveDirect()</div><div class="ttdoc">Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module cla...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:217</div></div>
<div class="ttc" id="aclass_physical_layer_html_add63d7d4fa8b14df5e185813794a49d5"><div class="ttname"><a href="class_physical_layer.html#add63d7d4fa8b14df5e185813794a49d5">PhysicalLayer::PhysicalLayer</a></div><div class="ttdeci">PhysicalLayer(float step, size_t maxLen)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:5</div></div>
<div class="ttc" id="aclass_physical_layer_html_ae11c191a7edf3116bf468b9153237260"><div class="ttname"><a href="class_physical_layer.html#ae11c191a7edf3116bf468b9153237260">PhysicalLayer::setChannelScanAction</a></div><div class="ttdeci">virtual void setChannelScanAction(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when a channel scan is finished.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:526</div></div>
<div class="ttc" id="aclass_physical_layer_html_ae30dfbb5445bb674898fc54f5f90b2f9"><div class="ttname"><a href="class_physical_layer.html#ae30dfbb5445bb674898fc54f5f90b2f9">PhysicalLayer::startChannelScan</a></div><div class="ttdeci">virtual int16_t startChannelScan()</div><div class="ttdoc">Interrupt-driven channel activity detection method. Interrupt will be activated when packet is detect...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:356</div></div>
<div class="ttc" id="aclass_physical_layer_html_ae602ebd46d60da8670c9f353cef695d9"><div class="ttname"><a href="class_physical_layer.html#ae602ebd46d60da8670c9f353cef695d9">PhysicalLayer::getIrqMapped</a></div><div class="ttdeci">uint32_t getIrqMapped(RadioLibIrqFlags_t irq)</div><div class="ttdoc">Convert from radio-agnostic IRQ flags to radio-specific flags.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:314</div></div>
<div class="ttc" id="aclass_physical_layer_html_aeba04366a0cf05ff3d8227c4f7c8e1e9"><div class="ttname"><a href="class_physical_layer.html#aeba04366a0cf05ff3d8227c4f7c8e1e9">PhysicalLayer::setDataShaping</a></div><div class="ttdeci">virtual int16_t setDataShaping(uint8_t sh)</div><div class="ttdoc">Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:240</div></div>
<div class="ttc" id="aclass_physical_layer_html_aec928bb26f65752aa20cd236fbabb95c"><div class="ttname"><a href="class_physical_layer.html#aec928bb26f65752aa20cd236fbabb95c">PhysicalLayer::setPacketReceivedAction</a></div><div class="ttdeci">virtual void setPacketReceivedAction(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:510</div></div>
<div class="ttc" id="aclass_physical_layer_html_aedd39ad84b45c6392087b12d59192d8c"><div class="ttname"><a href="class_physical_layer.html#aedd39ad84b45c6392087b12d59192d8c">PhysicalLayer::setBitRate</a></div><div class="ttdeci">virtual int16_t setBitRate(float br)</div><div class="ttdoc">Sets FSK bit rate. Only available in FSK mode. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:230</div></div>
<div class="ttc" id="aclass_physical_layer_html_aedddaf9460941b90e43e9005035faa0f"><div class="ttname"><a href="class_physical_layer.html#aedddaf9460941b90e43e9005035faa0f">PhysicalLayer::getSNR</a></div><div class="ttdeci">virtual 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> PhysicalLayer.cpp:300</div></div>
<div class="ttc" id="aclass_physical_layer_html_af061879bf694735297593c048d04a196"><div class="ttname"><a href="class_physical_layer.html#af061879bf694735297593c048d04a196">PhysicalLayer::getModem</a></div><div class="ttdeci">virtual int16_t getModem(ModemType_t *modem)</div><div class="ttdoc">Get modem currently in use by the radio.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:539</div></div>
<div class="ttc" id="aclass_physical_layer_html_af1bb9a5da26da8829795ebb72e9c666e"><div class="ttname"><a href="class_physical_layer.html#af1bb9a5da26da8829795ebb72e9c666e">PhysicalLayer::sleep</a></div><div class="ttdeci">virtual int16_t sleep()</div><div class="ttdoc">Sets module to sleep.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:119</div></div>
<div class="ttc" id="aclass_physical_layer_html_af1caeed34b2e2ff0355467507106a1a2"><div class="ttname"><a href="class_physical_layer.html#af1caeed34b2e2ff0355467507106a1a2">PhysicalLayer::getIrqFlags</a></div><div class="ttdeci">virtual uint32_t getIrqFlags()</div><div class="ttdoc">Read currently active IRQ flags. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:342</div></div>
<div class="ttc" id="aclass_physical_layer_html_af88dcb54dc8e9a1edaf9f1c3e5ee2b74"><div class="ttname"><a href="class_physical_layer.html#af88dcb54dc8e9a1edaf9f1c3e5ee2b74">PhysicalLayer::setIrqFlags</a></div><div class="ttdeci">virtual int16_t setIrqFlags(uint32_t irq)</div><div class="ttdoc">Set interrupt on DIO1 to be sent on a specific IRQ bit (e.g. RxTimeout, CadDone). Must be implemented...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:346</div></div>
<div class="ttc" id="aclass_physical_layer_html_af9a7e739e39705a72ffa8b63ec09bb15"><div class="ttname"><a href="class_physical_layer.html#af9a7e739e39705a72ffa8b63ec09bb15">PhysicalLayer::clearIrq</a></div><div class="ttdeci">int16_t clearIrq(RadioLibIrqFlags_t irq)</div><div class="ttdoc">Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone). Keep in mind that not all radio modu...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:338</div></div>
<div class="ttc" id="aclass_physical_layer_html_ae11c191a7edf3116bf468b9153237260"><div class="ttname"><a href="class_physical_layer.html#ae11c191a7edf3116bf468b9153237260">PhysicalLayer::setChannelScanAction</a></div><div class="ttdeci">virtual void setChannelScanAction(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when a channel scan is finished.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:522</div></div>
<div class="ttc" id="aclass_physical_layer_html_ae30dfbb5445bb674898fc54f5f90b2f9"><div class="ttname"><a href="class_physical_layer.html#ae30dfbb5445bb674898fc54f5f90b2f9">PhysicalLayer::startChannelScan</a></div><div class="ttdeci">virtual int16_t startChannelScan()</div><div class="ttdoc">Interrupt-driven channel activity detection method. Interrupt will be activated when packet is detect...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:352</div></div>
<div class="ttc" id="aclass_physical_layer_html_ae602ebd46d60da8670c9f353cef695d9"><div class="ttname"><a href="class_physical_layer.html#ae602ebd46d60da8670c9f353cef695d9">PhysicalLayer::getIrqMapped</a></div><div class="ttdeci">uint32_t getIrqMapped(RadioLibIrqFlags_t irq)</div><div class="ttdoc">Convert from radio-agnostic IRQ flags to radio-specific flags.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:310</div></div>
<div class="ttc" id="aclass_physical_layer_html_aeba04366a0cf05ff3d8227c4f7c8e1e9"><div class="ttname"><a href="class_physical_layer.html#aeba04366a0cf05ff3d8227c4f7c8e1e9">PhysicalLayer::setDataShaping</a></div><div class="ttdeci">virtual int16_t setDataShaping(uint8_t sh)</div><div class="ttdoc">Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:236</div></div>
<div class="ttc" id="aclass_physical_layer_html_aec928bb26f65752aa20cd236fbabb95c"><div class="ttname"><a href="class_physical_layer.html#aec928bb26f65752aa20cd236fbabb95c">PhysicalLayer::setPacketReceivedAction</a></div><div class="ttdeci">virtual void setPacketReceivedAction(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:506</div></div>
<div class="ttc" id="aclass_physical_layer_html_aedd39ad84b45c6392087b12d59192d8c"><div class="ttname"><a href="class_physical_layer.html#aedd39ad84b45c6392087b12d59192d8c">PhysicalLayer::setBitRate</a></div><div class="ttdeci">virtual int16_t setBitRate(float br)</div><div class="ttdoc">Sets FSK bit rate. Only available in FSK mode. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:226</div></div>
<div class="ttc" id="aclass_physical_layer_html_aedddaf9460941b90e43e9005035faa0f"><div class="ttname"><a href="class_physical_layer.html#aedddaf9460941b90e43e9005035faa0f">PhysicalLayer::getSNR</a></div><div class="ttdeci">virtual 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> PhysicalLayer.cpp:296</div></div>
<div class="ttc" id="aclass_physical_layer_html_af061879bf694735297593c048d04a196"><div class="ttname"><a href="class_physical_layer.html#af061879bf694735297593c048d04a196">PhysicalLayer::getModem</a></div><div class="ttdeci">virtual int16_t getModem(ModemType_t *modem)</div><div class="ttdoc">Get modem currently in use by the radio.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:535</div></div>
<div class="ttc" id="aclass_physical_layer_html_af1bb9a5da26da8829795ebb72e9c666e"><div class="ttname"><a href="class_physical_layer.html#af1bb9a5da26da8829795ebb72e9c666e">PhysicalLayer::sleep</a></div><div class="ttdeci">virtual int16_t sleep()</div><div class="ttdoc">Sets module to sleep.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:117</div></div>
<div class="ttc" id="aclass_physical_layer_html_af1caeed34b2e2ff0355467507106a1a2"><div class="ttname"><a href="class_physical_layer.html#af1caeed34b2e2ff0355467507106a1a2">PhysicalLayer::getIrqFlags</a></div><div class="ttdeci">virtual uint32_t getIrqFlags()</div><div class="ttdoc">Read currently active IRQ flags. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:338</div></div>
<div class="ttc" id="aclass_physical_layer_html_af88dcb54dc8e9a1edaf9f1c3e5ee2b74"><div class="ttname"><a href="class_physical_layer.html#af88dcb54dc8e9a1edaf9f1c3e5ee2b74">PhysicalLayer::setIrqFlags</a></div><div class="ttdeci">virtual int16_t setIrqFlags(uint32_t irq)</div><div class="ttdoc">Set interrupt on DIO1 to be sent on a specific IRQ bit (e.g. RxTimeout, CadDone). Must be implemented...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:342</div></div>
<div class="ttc" id="aclass_physical_layer_html_af9a7e739e39705a72ffa8b63ec09bb15"><div class="ttname"><a href="class_physical_layer.html#af9a7e739e39705a72ffa8b63ec09bb15">PhysicalLayer::clearIrq</a></div><div class="ttdeci">int16_t clearIrq(RadioLibIrqFlags_t irq)</div><div class="ttdoc">Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone). Keep in mind that not all radio modu...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:334</div></div>
<div class="ttc" id="aclass_r_t_t_y_client_html"><div class="ttname"><a href="class_r_t_t_y_client.html">RTTYClient</a></div><div class="ttdoc">Client for RTTY communication. The public interface is the same as Arduino Serial.</div><div class="ttdef"><b>Definition:</b> RTTY.h:17</div></div>
<div class="ttc" id="aclass_s_s_t_v_client_html"><div class="ttname"><a href="class_s_s_t_v_client.html">SSTVClient</a></div><div class="ttdoc">Client for SSTV transmissions.</div><div class="ttdef"><b>Definition:</b> SSTV.h:121</div></div>
<div class="ttc" id="agroup__typedefs_html_ga210f31dd2bff7fb80563275648a5bbbd"><div class="ttname"><a href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a></div><div class="ttdeci">unsigned long RadioLibTime_t</div><div class="ttdoc">Type used for durations in RadioLib.</div><div class="ttdef"><b>Definition:</b> TypeDef.h:642</div></div>

12
_r_f69_8h_source.html
View file

@ -776,10 +776,10 @@ $(document).ready(function(){initNavTree('_r_f69_8h_source.html',''); initResiza
<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:66</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. Note: It is not recommended to use this c...</div><div class="ttdef"><b>Definition:</b> Module.h:75</div></div>
<div class="ttc" id="aclass_physical_layer_html"><div class="ttname"><a href="class_physical_layer.html">PhysicalLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:151</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:210</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:206</div></div>
<div class="ttc" id="aclass_physical_layer_html_a492b2d057dd803c3884fa1adc8e22534"><div class="ttname"><a href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">PhysicalLayer::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:53</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:150</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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:113</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:148</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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_r_f69_html"><div class="ttname"><a href="class_r_f69.html">RF69</a></div><div class="ttdoc">Control class for RF69 module. Also serves as base class for SX1231.</div><div class="ttdef"><b>Definition:</b> RF69.h:479</div></div>
<div class="ttc" id="aclass_r_f69_html_a0526ce6ea3722fd258f96d9677a60853"><div class="ttname"><a href="class_r_f69.html#a0526ce6ea3722fd258f96d9677a60853">RF69::getTemperature</a></div><div class="ttdeci">int16_t getTemperature()</div><div class="ttdoc">Measures temperature.</div><div class="ttdef"><b>Definition:</b> RF69.cpp:764</div></div>
<div class="ttc" id="aclass_r_f69_html_a0c30202b2d52eb32f43066bc0f938638"><div class="ttname"><a href="class_r_f69.html#a0c30202b2d52eb32f43066bc0f938638">RF69::getChipVersion</a></div><div class="ttdeci">int16_t getChipVersion()</div><div class="ttdoc">Read version SPI register. Should return RF69_CHIP_VERSION (0x24) if SX127x is connected and working.</div><div class="ttdef"><b>Definition:</b> RF69.cpp:985</div></div>
@ -797,7 +797,7 @@ $(document).ready(function(){initNavTree('_r_f69_8h_source.html',''); initResiza
<div class="ttc" id="aclass_r_f69_html_a2bf0d5e045ccfecf9510773148cdd2c9"><div class="ttname"><a href="class_r_f69.html#a2bf0d5e045ccfecf9510773148cdd2c9">RF69::getFrequencyDeviation</a></div><div class="ttdeci">int16_t getFrequencyDeviation(float *freqDev)</div><div class="ttdoc">Gets frequency deviation.</div><div class="ttdef"><b>Definition:</b> RF69.cpp:629</div></div>
<div class="ttc" id="aclass_r_f69_html_a2f5852cf0757e38b56b6208760d9a459"><div class="ttname"><a href="class_r_f69.html#a2f5852cf0757e38b56b6208760d9a459">RF69::setOokFixedThreshold</a></div><div class="ttdeci">int16_t setOokFixedThreshold(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> RF69.cpp:512</div></div>
<div class="ttc" id="aclass_r_f69_html_a31390763956a50182b0b5b8a7e5ff4e3"><div class="ttname"><a href="class_r_f69.html#a31390763956a50182b0b5b8a7e5ff4e3">RF69::clearPacketReceivedAction</a></div><div class="ttdeci">void clearPacketReceivedAction() override</div><div class="ttdoc">Clears interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> RF69.cpp:297</div></div>
<div class="ttc" id="aclass_r_f69_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_r_f69.html#a3563453988a83d22dd07d4691543a300">RF69::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:210</div></div>
<div class="ttc" id="aclass_r_f69_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_r_f69.html#a3563453988a83d22dd07d4691543a300">RF69::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:206</div></div>
<div class="ttc" id="aclass_r_f69_html_a3bece228d369dcc1aab6a5b29d0685a8"><div class="ttname"><a href="class_r_f69.html#a3bece228d369dcc1aab6a5b29d0685a8">RF69::startReceive</a></div><div class="ttdeci">int16_t startReceive() override</div><div class="ttdoc">Interrupt-driven receive method. GDO0 will be activated when full packet is received.</div><div class="ttdef"><b>Definition:</b> RF69.cpp:234</div></div>
<div class="ttc" id="aclass_r_f69_html_a3e449fa06c9e76cf69585bfbeed1c46b"><div class="ttname"><a href="class_r_f69.html#a3e449fa06c9e76cf69585bfbeed1c46b">RF69::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> RF69.cpp:441</div></div>
<div class="ttc" id="aclass_r_f69_html_a400bb57d2353b57c29cf41a6d9497c80"><div class="ttname"><a href="class_r_f69.html#a400bb57d2353b57c29cf41a6d9497c80">RF69::disableSyncWordFiltering</a></div><div class="ttdeci">int16_t disableSyncWordFiltering()</div><div class="ttdoc">Disable preamble and sync word filtering and generation.</div><div class="ttdef"><b>Definition:</b> RF69.cpp:807</div></div>
@ -818,7 +818,7 @@ $(document).ready(function(){initNavTree('_r_f69_8h_source.html',''); initResiza
<div class="ttc" id="aclass_r_f69_html_a7c84b3f881cad6e05b0f4f68c24496d9"><div class="ttname"><a href="class_r_f69.html#a7c84b3f881cad6e05b0f4f68c24496d9">RF69::setPreambleLength</a></div><div class="ttdeci">int16_t setPreambleLength(uint8_t preambleLen)</div><div class="ttdoc">Sets preamble length.</div><div class="ttdef"><b>Definition:</b> RF69.cpp:717</div></div>
<div class="ttc" id="aclass_r_f69_html_a7e2201b5bc389a68765400b70439f3f0"><div class="ttname"><a href="class_r_f69.html#a7e2201b5bc389a68765400b70439f3f0">RF69::enableContinuousModeBitSync</a></div><div class="ttdeci">int16_t enableContinuousModeBitSync()</div><div class="ttdoc">Enable Bit synchronization in continuous mode.</div><div class="ttdef"><b>Definition:</b> RF69.cpp:812</div></div>
<div class="ttc" id="aclass_r_f69_html_a86a080086c0228d23e2cb77d2b1915c1"><div class="ttname"><a href="class_r_f69.html#a86a080086c0228d23e2cb77d2b1915c1">RF69::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> RF69.cpp:781</div></div>
<div class="ttc" id="aclass_r_f69_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_r_f69.html#a923654706eff5118ef6e84214e837f27">RF69::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:150</div></div>
<div class="ttc" id="aclass_r_f69_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_r_f69.html#a923654706eff5118ef6e84214e837f27">RF69::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:148</div></div>
<div class="ttc" id="aclass_r_f69_html_a9721d2a3ed9fa8dd878575d71d5a4942"><div class="ttname"><a href="class_r_f69.html#a9721d2a3ed9fa8dd878575d71d5a4942">RF69::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> RF69.cpp:274</div></div>
<div class="ttc" id="aclass_r_f69_html_a97603856caada65676ff4b11630c7f72"><div class="ttname"><a href="class_r_f69.html#a97603856caada65676ff4b11630c7f72">RF69::setPacketSentAction</a></div><div class="ttdeci">void setPacketSentAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> RF69.cpp:301</div></div>
<div class="ttc" id="aclass_r_f69_html_a97d3570f4f898dde47e3daf8043e7bad"><div class="ttname"><a href="class_r_f69.html#a97d3570f4f898dde47e3daf8043e7bad">RF69::disableContinuousModeBitSync</a></div><div class="ttdeci">int16_t disableContinuousModeBitSync()</div><div class="ttdoc">Disable Bit synchronization in continuous mode.</div><div class="ttdef"><b>Definition:</b> RF69.cpp:821</div></div>
@ -831,7 +831,7 @@ $(document).ready(function(){initNavTree('_r_f69_8h_source.html',''); initResiza
<div class="ttc" id="aclass_r_f69_html_aa7f47c37eec6c7e3ebf6e6d30ebd5532"><div class="ttname"><a href="class_r_f69.html#aa7f47c37eec6c7e3ebf6e6d30ebd5532">RF69::setFrequency</a></div><div class="ttdeci">int16_t setFrequency(float freq) override</div><div class="ttdoc">Sets carrier frequency. Allowed values are in bands 290.0 to 340.0 MHz, 431.0 to 510....</div><div class="ttdef"><b>Definition:</b> RF69.cpp:520</div></div>
<div class="ttc" id="aclass_r_f69_html_aae828ce8dda16da4e54d2f18b1fb8af2"><div class="ttname"><a href="class_r_f69.html#aae828ce8dda16da4e54d2f18b1fb8af2">RF69::setEncoding</a></div><div class="ttdeci">int16_t setEncoding(uint8_t encoding) override</div><div class="ttdoc">Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER an...</div><div class="ttdef"><b>Definition:</b> RF69.cpp:896</div></div>
<div class="ttc" id="aclass_r_f69_html_ab6d98f3f2d964d1833e20da246a5be89"><div class="ttname"><a href="class_r_f69.html#ab6d98f3f2d964d1833e20da246a5be89">RF69::fifoAdd</a></div><div class="ttdeci">bool fifoAdd(uint8_t *data, int totalLen, int *remLen)</div><div class="ttdoc">Set interrupt service routine function to call when FIFO is empty.</div><div class="ttdef"><b>Definition:</b> RF69.cpp:338</div></div>
<div class="ttc" id="aclass_r_f69_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_r_f69.html#ab82617fa3fa9f21d4cd427314ecc4af8">RF69::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:113</div></div>
<div class="ttc" id="aclass_r_f69_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_r_f69.html#ab82617fa3fa9f21d4cd427314ecc4af8">RF69::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_r_f69_html_ab9c217d5ece259950780a05c6e41f75c"><div class="ttname"><a href="class_r_f69.html#ab9c217d5ece259950780a05c6e41f75c">RF69::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> RF69.cpp:729</div></div>
<div class="ttc" id="aclass_r_f69_html_abd556b0f455f9510213b17588a4baf1b"><div class="ttname"><a href="class_r_f69.html#abd556b0f455f9510213b17588a4baf1b">RF69::receiveDirect</a></div><div class="ttdeci">int16_t receiveDirect() override</div><div class="ttdoc">Starts direct mode reception.</div><div class="ttdef"><b>Definition:</b> RF69.cpp:189</div></div>
<div class="ttc" id="aclass_r_f69_html_abe5b378d7cc274fd8b75881e7d604bf3"><div class="ttname"><a href="class_r_f69.html#abe5b378d7cc274fd8b75881e7d604bf3">RF69::setAESKey</a></div><div class="ttdeci">void setAESKey(uint8_t *key)</div><div class="ttdoc">Sets AES key.</div><div class="ttdef"><b>Definition:</b> RF69.cpp:222</div></div>

36
_s_x126x_8h_source.html
View file

@ -879,37 +879,37 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
<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. Note: It is not recommended to use this c...</div><div class="ttdef"><b>Definition:</b> Module.h:75</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="ttdoc">Transmission mode.</div><div class="ttdef"><b>Definition:</b> Module.h:112</div></div>
<div class="ttc" id="aclass_physical_layer_html"><div class="ttname"><a href="class_physical_layer.html">PhysicalLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:151</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:210</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:206</div></div>
<div class="ttc" id="aclass_physical_layer_html_a492b2d057dd803c3884fa1adc8e22534"><div class="ttname"><a href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">PhysicalLayer::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:53</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:150</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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:113</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:148</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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"><div class="ttname"><a href="class_s_x126x.html">SX126x</a></div><div class="ttdoc">Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from thi...</div><div class="ttdef"><b>Definition:</b> SX126x.h:474</div></div>
<div class="ttc" id="aclass_s_x126x_html_a001c4637f01ed6f0216cd6c4d7e10da3"><div class="ttname"><a href="class_s_x126x.html#a001c4637f01ed6f0216cd6c4d7e10da3">SX126x::startChannelScan</a></div><div class="ttdeci">int16_t startChannelScan() override</div><div class="ttdoc">Interrupt-driven channel activity detection method. DIO1 will be activated when LoRa preamble is dete...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:794</div></div>
<div class="ttc" id="aclass_s_x126x_html_a068d709ffb79ae66d718ffb76ffae997"><div class="ttname"><a href="class_s_x126x.html#a068d709ffb79ae66d718ffb76ffae997">SX126x::getFrequencyError</a></div><div class="ttdeci">float getFrequencyError()</div><div class="ttdoc">Gets frequency error of the latest received packet. WARNING: This functionality is based on SX128x im...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1420</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:1593</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:479</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:1907</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:1905</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:1481</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:1622</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:1552</div></div>
<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:1151</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:1581</div></div>
<div class="ttc" id="aclass_s_x126x_html_a269c8e4ae0d21af88e9422ccf9708c1e"><div class="ttname"><a href="class_s_x126x.html#a269c8e4ae0d21af88e9422ccf9708c1e">SX126x::invertIQ</a></div><div class="ttdeci">int16_t invertIQ(bool enable) override</div><div class="ttdoc">Enable/disable inversion of the I and Q signals.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1651</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:1696</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:1694</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:1589</div></div>
<div class="ttc" id="aclass_s_x126x_html_a2cb5ed645ebcc6f3f17d77e32c2ccdd7"><div class="ttname"><a href="class_s_x126x.html#a2cb5ed645ebcc6f3f17d77e32c2ccdd7">SX126x::setRfSwitchTable</a></div><div class="ttdeci">void setRfSwitchTable(const uint32_t(&amp;pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])</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:1597</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:68</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:854</div></div>
<div class="ttc" id="aclass_s_x126x_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_s_x126x.html#a3563453988a83d22dd07d4691543a300">SX126x::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:210</div></div>
<div class="ttc" id="aclass_s_x126x_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_s_x126x.html#a3563453988a83d22dd07d4691543a300">SX126x::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:206</div></div>
<div class="ttc" id="aclass_s_x126x_html_a3765f534418d4e0540c179621c019138"><div class="ttname"><a href="class_s_x126x.html#a3765f534418d4e0540c179621c019138">SX126x::explicitHeader</a></div><div class="ttdeci">int16_t explicitHeader()</div><div class="ttdoc">Set explicit header mode for future reception/transmission.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1577</div></div>
<div class="ttc" id="aclass_s_x126x_html_a37dab0ab3c4cab82e367971fc31588a6"><div class="ttname"><a href="class_s_x126x.html#a37dab0ab3c4cab82e367971fc31588a6">SX126x::clearChannelScanAction</a></div><div class="ttdeci">void clearChannelScanAction() override</div><div class="ttdoc">Clears interrupt service routine to call when a channel scan is finished.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:507</div></div>
<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:1601</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:53</div></div>
<div class="ttc" id="aclass_s_x126x_html_a4f514b341b8982650526c6d8e20fd1a4"><div class="ttname"><a href="class_s_x126x.html#a4f514b341b8982650526c6d8e20fd1a4">SX126x::setDirectAction</a></div><div class="ttdeci">void setDirectAction(void(*func)(void)) override</div><div class="ttdoc">Set interrupt service routine function to call when data bit is received in direct mode.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1687</div></div>
<div class="ttc" id="aclass_s_x126x_html_a4f514b341b8982650526c6d8e20fd1a4"><div class="ttname"><a href="class_s_x126x.html#a4f514b341b8982650526c6d8e20fd1a4">SX126x::setDirectAction</a></div><div class="ttdeci">void setDirectAction(void(*func)(void)) override</div><div class="ttdoc">Set interrupt service routine function to call when data bit is received in direct mode.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1685</div></div>
<div class="ttc" id="aclass_s_x126x_html_a50e757c2a63e5c7da5b0d0d6c00f91b5"><div class="ttname"><a href="class_s_x126x.html#a50e757c2a63e5c7da5b0d0d6c00f91b5">SX126x::setIrqFlags</a></div><div class="ttdeci">int16_t setIrqFlags(uint32_t irq) override</div><div class="ttdoc">Set interrupt on DIO1 to be sent on a specific IRQ bit (e.g. RxTimeout, CadDone).</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1565</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:1763</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:1761</div></div>
<div class="ttc" id="aclass_s_x126x_html_a56f88f6a2b88ae6dbd3ad04b1950e7b2"><div class="ttname"><a href="class_s_x126x.html#a56f88f6a2b88ae6dbd3ad04b1950e7b2">SX126x::clearPacketReceivedAction</a></div><div class="ttdeci">void clearPacketReceivedAction() override</div><div class="ttdoc">Clears interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:491</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:1783</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:1781</div></div>
<div class="ttc" id="aclass_s_x126x_html_a59b761a67d15cdbfdccd6a759f464d00"><div class="ttname"><a href="class_s_x126x.html#a59b761a67d15cdbfdccd6a759f464d00">SX126x::getSNR</a></div><div class="ttdeci">float getSNR() override</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:1404</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:1072</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:1585</div></div>
@ -920,28 +920,28 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
<div class="ttc" id="aclass_s_x126x_html_a782a2e4ab7779369c0dc0cb4779fda81"><div class="ttname"><a href="class_s_x126x.html#a782a2e4ab7779369c0dc0cb4779fda81">SX126x::getRSSI</a></div><div class="ttdeci">float getRSSI() override</div><div class="ttdoc">Gets recorded signal strength indicator. Overload with packet mode enabled for PhysicalLayer compatib...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1386</div></div>
<div class="ttc" id="aclass_s_x126x_html_a7a1579e2557c36a4a34b09039c0d0c71"><div class="ttname"><a href="class_s_x126x.html#a7a1579e2557c36a4a34b09039c0d0c71">SX126x::standby</a></div><div class="ttdeci">int16_t standby() override</div><div class="ttdoc">Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:462</div></div>
<div class="ttc" id="aclass_s_x126x_html_a7cd95a5f2e39ae8fb1a3040e77fa21a3"><div class="ttname"><a href="class_s_x126x.html#a7cd95a5f2e39ae8fb1a3040e77fa21a3">SX126x::setFrequencyDeviation</a></div><div class="ttdeci">int16_t setFrequencyDeviation(float freqDev) override</div><div class="ttdoc">Sets FSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:977</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:1759</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:1757</div></div>
<div class="ttc" id="aclass_s_x126x_html_a867b111d21308319e117695051e157ae"><div class="ttname"><a href="class_s_x126x.html#a867b111d21308319e117695051e157ae">SX126x::getModem</a></div><div class="ttdeci">int16_t getModem(ModemType_t *modem) override</div><div class="ttdoc">Get modem currently in use by the radio.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1665</div></div>
<div class="ttc" id="aclass_s_x126x_html_a882cec40d9aa98a0d536e6afb65b1719"><div class="ttname"><a href="class_s_x126x.html#a882cec40d9aa98a0d536e6afb65b1719">SX126x::sleep</a></div><div class="ttdeci">int16_t sleep() override</div><div class="ttdoc">Sets the module to sleep mode. To wake the device up, call standby(). Overload with warm start enable...</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:442</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:339</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:1743</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:1741</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:624</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:942</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:1135</div></div>
<div class="ttc" id="aclass_s_x126x_html_a921aa8afb8d33b2660731c1f8d67664b"><div class="ttname"><a href="class_s_x126x.html#a921aa8afb8d33b2660731c1f8d67664b">SX126x::transmitDirect</a></div><div class="ttdeci">int16_t transmitDirect(uint32_t frf=0) override</div><div class="ttdoc">Starts direct mode transmission.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:323</div></div>
<div class="ttc" id="aclass_s_x126x_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_s_x126x.html#a923654706eff5118ef6e84214e837f27">SX126x::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:150</div></div>
<div class="ttc" id="aclass_s_x126x_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_s_x126x.html#a923654706eff5118ef6e84214e837f27">SX126x::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:148</div></div>
<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:1477</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:22</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:1286</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:163</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:931</div></div>
<div class="ttc" id="aclass_s_x126x_html_aa1e7777fc8237e2c9d933cd4b6304e28"><div class="ttname"><a href="class_s_x126x.html#aa1e7777fc8237e2c9d933cd4b6304e28">SX126x::setLrFhssConfig</a></div><div class="ttdeci">int16_t setLrFhssConfig(uint8_t bw, uint8_t cr, uint8_t hdrCount=3, uint16_t hopSeqId=0x100)</div><div class="ttdoc">Sets LR-FHSS configuration.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:150</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:1954</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:1952</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:955</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_ab4c29619a38391805a11231c67424847"><div class="ttname"><a href="class_s_x126x.html#ab4c29619a38391805a11231c67424847">SX126x::clearIrqFlags</a></div><div class="ttdeci">int16_t clearIrqFlags(uint32_t irq) override</div><div class="ttdoc">Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone).</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1569</div></div>
<div class="ttc" id="aclass_s_x126x_html_ab4f9b0c6496a796211e9816bf92146a7"><div class="ttname"><a href="class_s_x126x.html#ab4f9b0c6496a796211e9816bf92146a7">SX126x::getIrqFlags</a></div><div class="ttdeci">uint32_t getIrqFlags() override</div><div class="ttdoc">Read currently active IRQ flags.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1559</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:113</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:1613</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:1473</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:1258</div></div>
@ -949,17 +949,17 @@ $(document).ready(function(){initNavTree('_s_x126x_8h_source.html',''); initResi
<div class="ttc" id="aclass_s_x126x_html_ac4ef8c8751a3c09d64e431684840c987"><div class="ttname"><a href="class_s_x126x.html#ac4ef8c8751a3c09d64e431684840c987">SX126x::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> SX126x.cpp:1453</div></div>
<div class="ttc" id="aclass_s_x126x_html_ac594fbb30c5010658c970a64654c7162"><div class="ttname"><a href="class_s_x126x.html#ac594fbb30c5010658c970a64654c7162">SX126x::setSyncBits</a></div><div class="ttdeci">int16_t setSyncBits(uint8_t *syncWord, uint8_t bitsLen)</div><div class="ttdoc">Sets FSK sync word in the form of array of up to 8 bytes.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1221</div></div>
<div class="ttc" id="aclass_s_x126x_html_ac79f7ebab97ae91fff6933be3207c873"><div class="ttname"><a href="class_s_x126x.html#ac79f7ebab97ae91fff6933be3207c873">SX126x::setPacketSentAction</a></div><div class="ttdeci">void setPacketSentAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:495</div></div>
<div class="ttc" id="aclass_s_x126x_html_acb1a1c51f207439880ae537f5ffeb17c"><div class="ttname"><a href="class_s_x126x.html#acb1a1c51f207439880ae537f5ffeb17c">SX126x::readBit</a></div><div class="ttdeci">void readBit(uint32_t pin) override</div><div class="ttdoc">Function to read and process data bit in direct reception mode.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1691</div></div>
<div class="ttc" id="aclass_s_x126x_html_acb1a1c51f207439880ae537f5ffeb17c"><div class="ttname"><a href="class_s_x126x.html#acb1a1c51f207439880ae537f5ffeb17c">SX126x::readBit</a></div><div class="ttdeci">void readBit(uint32_t pin) override</div><div class="ttdoc">Function to read and process data bit in direct reception mode.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1689</div></div>
<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:413</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:1382</div></div>
<div class="ttc" id="aclass_s_x126x_html_ad0f95b62ee987010b00f4be75bf9ab4e"><div class="ttname"><a href="class_s_x126x.html#ad0f95b62ee987010b00f4be75bf9ab4e">SX126x::startReceiveDutyCycleAuto</a></div><div class="ttdeci">int16_t startReceiveDutyCycleAuto(uint16_t senderPreambleLength=0, uint16_t minSymbols=8, RadioLibIrqFlags_t irqFlags=RADIOLIB_IRQ_RX_DEFAULT_FLAGS, RadioLibIrqFlags_t irqMask=RADIOLIB_IRQ_RX_DEFAULT_MASK)</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:684</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:964</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:1962</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:1960</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:491</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:1573</div></div>
<div class="ttc" id="aclass_s_x126x_html_adf54f7b83aa47ad0b803147622b3c580"><div class="ttname"><a href="class_s_x126x.html#adf54f7b83aa47ad0b803147622b3c580">SX126x::setNodeAddress</a></div><div class="ttdeci">int16_t setNodeAddress(uint8_t addr)</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:1240</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:1836</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:1771</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:1834</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:1769</div></div>
<div class="ttc" id="aclass_s_x126x_html_ae500bad45638a47264b7e5955a93107d"><div class="ttname"><a href="class_s_x126x.html#ae500bad45638a47264b7e5955a93107d">SX126x::setWhitening</a></div><div class="ttdeci">int16_t setWhitening(bool enabled, uint16_t initial=0x01FF)</div><div class="ttdoc">Sets FSK whitening parameters.</div><div class="ttdef"><b>Definition:</b> SX126x.cpp:1345</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:905</div></div>
<div class="ttc" id="aclass_s_x126x_html_ae731568798d03d9722a440fd6a23faf2"><div class="ttname"><a href="class_s_x126x.html#ae731568798d03d9722a440fd6a23faf2">SX126x::standbyXOSC</a></div><div class="ttdeci">bool standbyXOSC</div><div class="ttdoc">Whether to use XOSC (true) or RC (false) oscillator in standby mode. Defaults to false.</div><div class="ttdef"><b>Definition:</b> SX126x.h:496</div></div>

32
_s_x127x_8h_source.html
View file

@ -915,15 +915,15 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
<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:66</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. Note: It is not recommended to use this c...</div><div class="ttdef"><b>Definition:</b> Module.h:75</div></div>
<div class="ttc" id="aclass_physical_layer_html"><div class="ttname"><a href="class_physical_layer.html">PhysicalLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:151</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:210</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:206</div></div>
<div class="ttc" id="aclass_physical_layer_html_a492b2d057dd803c3884fa1adc8e22534"><div class="ttname"><a href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">PhysicalLayer::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:53</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:150</div></div>
<div class="ttc" id="aclass_physical_layer_html_aabc94ab27a9ee6daaafa9b47dde5f75b"><div class="ttname"><a href="class_physical_layer.html#aabc94ab27a9ee6daaafa9b47dde5f75b">PhysicalLayer::getRSSI</a></div><div class="ttdeci">virtual float getRSSI()</div><div class="ttdoc">Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:296</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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:113</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:148</div></div>
<div class="ttc" id="aclass_physical_layer_html_aabc94ab27a9ee6daaafa9b47dde5f75b"><div class="ttname"><a href="class_physical_layer.html#aabc94ab27a9ee6daaafa9b47dde5f75b">PhysicalLayer::getRSSI</a></div><div class="ttdeci">virtual float getRSSI()</div><div class="ttdoc">Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:292</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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_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:583</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:379</div></div>
<div class="ttc" id="aclass_s_x127x_html_a0ce9beca21406e3556b3518370947ee2"><div class="ttname"><a href="class_s_x127x.html#a0ce9beca21406e3556b3518370947ee2">SX127x::clearChannelScanAction</a></div><div class="ttdeci">void clearChannelScanAction() override</div><div class="ttdoc">Clears interrupt service routine to call when a channel scan is finished.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:494</div></div>
<div class="ttc" id="aclass_s_x127x_html_a0e149fac59b3accbc9550bf605d6bbf0"><div class="ttname"><a href="class_s_x127x.html#a0e149fac59b3accbc9550bf605d6bbf0">SX127x::readBit</a></div><div class="ttdeci">void readBit(uint32_t pin) override</div><div class="ttdoc">Function to read and process data bit in direct reception mode.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1780</div></div>
<div class="ttc" id="aclass_s_x127x_html_a0e149fac59b3accbc9550bf605d6bbf0"><div class="ttname"><a href="class_s_x127x.html#a0e149fac59b3accbc9550bf605d6bbf0">SX127x::readBit</a></div><div class="ttdeci">void readBit(uint32_t pin) override</div><div class="ttdoc">Function to read and process data bit in direct reception mode.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1778</div></div>
<div class="ttc" id="aclass_s_x127x_html_a0f041e91ab2fbb6f05eef56b5addac71"><div class="ttname"><a href="class_s_x127x.html#a0f041e91ab2fbb6f05eef56b5addac71">SX127x::clearFifoFullAction</a></div><div class="ttdeci">void clearFifoFullAction()</div><div class="ttdoc">Clears interrupt service routine to call when FIFO is full.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:516</div></div>
<div class="ttc" id="aclass_s_x127x_html_a13ae97e18744dc617bc9326cfbaad3a3"><div class="ttname"><a href="class_s_x127x.html#a13ae97e18744dc617bc9326cfbaad3a3">SX127x::scanChannel</a></div><div class="ttdeci">int16_t scanChannel() override</div><div class="ttdoc">Performs scan for valid LoRa preamble in the current channel.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:276</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:1134</div></div>
@ -940,11 +940,11 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
<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_a333a9004cc05ff8aba2e9610db31109d"><div class="ttname"><a href="class_s_x127x.html#a333a9004cc05ff8aba2e9610db31109d">SX127x::getModem</a></div><div class="ttdeci">int16_t getModem(ModemType_t *modem) override</div><div class="ttdoc">Get modem currently in use by the radio.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1757</div></div>
<div class="ttc" id="aclass_s_x127x_html_a3530e8e19cfe4d96fe49ca4e6386b099"><div class="ttname"><a href="class_s_x127x.html#a3530e8e19cfe4d96fe49ca4e6386b099">SX127x::setPacketSentAction</a></div><div class="ttdeci">void setPacketSentAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:482</div></div>
<div class="ttc" id="aclass_s_x127x_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_s_x127x.html#a3563453988a83d22dd07d4691543a300">SX127x::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:210</div></div>
<div class="ttc" id="aclass_s_x127x_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_s_x127x.html#a3563453988a83d22dd07d4691543a300">SX127x::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:206</div></div>
<div class="ttc" id="aclass_s_x127x_html_a363a436978ba990e1bf7d73f648ad7e9"><div class="ttname"><a href="class_s_x127x.html#a363a436978ba990e1bf7d73f648ad7e9">SX127x::invertIQ</a></div><div class="ttdeci">int16_t invertIQ(bool enable) override</div><div class="ttdoc">Enable/disable inversion of the I and Q signals.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1735</div></div>
<div class="ttc" id="aclass_s_x127x_html_a36dbd1697a415c6db3b47cd620c8c02e"><div class="ttname"><a href="class_s_x127x.html#a36dbd1697a415c6db3b47cd620c8c02e">SX127x::fifoAdd</a></div><div class="ttdeci">bool fifoAdd(uint8_t *data, int totalLen, int *remLen)</div><div class="ttdoc">Set interrupt service routine function to call when FIFO is empty.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:521</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:754</div></div>
<div class="ttc" id="aclass_s_x127x_html_a41089d9e5b45217d3e31ac22b5326b66"><div class="ttname"><a href="class_s_x127x.html#a41089d9e5b45217d3e31ac22b5326b66">SX127x::clearFHSSInt</a></div><div class="ttdeci">void clearFHSSInt(void)</div><div class="ttdoc">Clear the FHSS interrupt.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1797</div></div>
<div class="ttc" id="aclass_s_x127x_html_a41089d9e5b45217d3e31ac22b5326b66"><div class="ttname"><a href="class_s_x127x.html#a41089d9e5b45217d3e31ac22b5326b66">SX127x::clearFHSSInt</a></div><div class="ttdeci">void clearFHSSInt(void)</div><div class="ttdoc">Clear the FHSS interrupt.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1795</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:1020</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:946</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:1206</div></div>
@ -953,7 +953,7 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
<div class="ttc" id="aclass_s_x127x_html_a492b2d057dd803c3884fa1adc8e22534"><div class="ttname"><a href="class_s_x127x.html#a492b2d057dd803c3884fa1adc8e22534">SX127x::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:53</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:879</div></div>
<div class="ttc" id="aclass_s_x127x_html_a5094d0f471aaa428167816d1ac30bb76"><div class="ttname"><a href="class_s_x127x.html#a5094d0f471aaa428167816d1ac30bb76">SX127x::setRSSIThreshold</a></div><div class="ttdeci">int16_t setRSSIThreshold(float dbm)</div><div class="ttdoc">Sets the RSSI value above which the RSSI interrupt is signaled.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1444</div></div>
<div class="ttc" id="aclass_s_x127x_html_a56340d1bdc69b3efc64636be39445a9c"><div class="ttname"><a href="class_s_x127x.html#a56340d1bdc69b3efc64636be39445a9c">SX127x::getFHSSChannel</a></div><div class="ttdeci">uint8_t getFHSSChannel(void)</div><div class="ttdoc">Gets the FHSS channel in use.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1793</div></div>
<div class="ttc" id="aclass_s_x127x_html_a56340d1bdc69b3efc64636be39445a9c"><div class="ttname"><a href="class_s_x127x.html#a56340d1bdc69b3efc64636be39445a9c">SX127x::getFHSSChannel</a></div><div class="ttdeci">uint8_t getFHSSChannel(void)</div><div class="ttdoc">Gets the FHSS channel in use.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1791</div></div>
<div class="ttc" id="aclass_s_x127x_html_a5b79dae55315cdf25e530db77eeb140f"><div class="ttname"><a href="class_s_x127x.html#a5b79dae55315cdf25e530db77eeb140f">SX127x::invertPreamble</a></div><div class="ttdeci">int16_t invertPreamble(bool enable)</div><div class="ttdoc">Invert FSK preamble polarity. The default (non-inverted) is 0x55, the inverted is 0xAA.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:807</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:1004</div></div>
<div class="ttc" id="aclass_s_x127x_html_a6cbc4c256d37f9cdabf9e5f2ef16aa92"><div class="ttname"><a href="class_s_x127x.html#a6cbc4c256d37f9cdabf9e5f2ef16aa92">SX127x::clearPacketReceivedAction</a></div><div class="ttdeci">void clearPacketReceivedAction() override</div><div class="ttdoc">Clears interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:478</div></div>
@ -963,19 +963,19 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
<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:456</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:300</div></div>
<div class="ttc" id="aclass_s_x127x_html_a7b4bce81839b105c464ebf922602e58b"><div class="ttname"><a href="class_s_x127x.html#a7b4bce81839b105c464ebf922602e58b">SX127x::setDio1Action</a></div><div class="ttdeci">void setDio1Action(void(*func)(void), uint32_t dir)</div><div class="ttdoc">Set interrupt service routine function to call when DIO1 activates.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:460</div></div>
<div class="ttc" id="aclass_s_x127x_html_a7b85344084b800966a46ace59dcb5277"><div class="ttname"><a href="class_s_x127x.html#a7b85344084b800966a46ace59dcb5277">SX127x::setDIOPreambleDetect</a></div><div class="ttdeci">int16_t setDIOPreambleDetect(bool usePreambleDetect)</div><div class="ttdoc">Configure DIO mapping to use RSSI or Preamble Detect for pins that support it.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1816</div></div>
<div class="ttc" id="aclass_s_x127x_html_a7f04a7e883057908df18f06c7f74c7e1"><div class="ttname"><a href="class_s_x127x.html#a7f04a7e883057908df18f06c7f74c7e1">SX127x::setFHSSHoppingPeriod</a></div><div class="ttdeci">int16_t setFHSSHoppingPeriod(uint8_t freqHoppingPeriod)</div><div class="ttdoc">Sets the hopping period and enables FHSS.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1785</div></div>
<div class="ttc" id="aclass_s_x127x_html_a7b85344084b800966a46ace59dcb5277"><div class="ttname"><a href="class_s_x127x.html#a7b85344084b800966a46ace59dcb5277">SX127x::setDIOPreambleDetect</a></div><div class="ttdeci">int16_t setDIOPreambleDetect(bool usePreambleDetect)</div><div class="ttdoc">Configure DIO mapping to use RSSI or Preamble Detect for pins that support it.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1814</div></div>
<div class="ttc" id="aclass_s_x127x_html_a7f04a7e883057908df18f06c7f74c7e1"><div class="ttname"><a href="class_s_x127x.html#a7f04a7e883057908df18f06c7f74c7e1">SX127x::setFHSSHoppingPeriod</a></div><div class="ttdeci">int16_t setFHSSHoppingPeriod(uint8_t freqHoppingPeriod)</div><div class="ttdoc">Sets the hopping period and enables FHSS.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1783</div></div>
<div class="ttc" id="aclass_s_x127x_html_a7fd9cec52b7fbd0c69cbd861dc17549f"><div class="ttname"><a href="class_s_x127x.html#a7fd9cec52b7fbd0c69cbd861dc17549f">SX127x::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> SX127x.cpp:640</div></div>
<div class="ttc" id="aclass_s_x127x_html_a8025b05b8f4f2f2abb4cd803b06e2ebd"><div class="ttname"><a href="class_s_x127x.html#a8025b05b8f4f2f2abb4cd803b06e2ebd">SX127x::disableBitSync</a></div><div class="ttdeci">int16_t disableBitSync()</div><div class="ttdoc">Disable Bit synchronizer (not allowed in Packet mode).</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1162</div></div>
<div class="ttc" id="aclass_s_x127x_html_a81189ce77541d78fc8feb99c2a3f35b2"><div class="ttname"><a href="class_s_x127x.html#a81189ce77541d78fc8feb99c2a3f35b2">SX127x::getChannelScanResult</a></div><div class="ttdeci">int16_t getChannelScanResult() override</div><div class="ttdoc">Read the channel scan result.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:734</div></div>
<div class="ttc" id="aclass_s_x127x_html_a844499bace6ae001446d71bee2877656"><div class="ttname"><a href="class_s_x127x.html#a844499bace6ae001446d71bee2877656">SX127x::setPreambleLength</a></div><div class="ttdeci">int16_t setPreambleLength(size_t preambleLength) override</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:778</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:1126</div></div>
<div class="ttc" id="aclass_s_x127x_html_a8ca9edcae05060cce3ff7ee58faeb4e2"><div class="ttname"><a href="class_s_x127x.html#a8ca9edcae05060cce3ff7ee58faeb4e2">SX127x::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> SX127x.cpp:1523</div></div>
<div class="ttc" id="aclass_s_x127x_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_s_x127x.html#a923654706eff5118ef6e84214e837f27">SX127x::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:150</div></div>
<div class="ttc" id="aclass_s_x127x_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_s_x127x.html#a923654706eff5118ef6e84214e837f27">SX127x::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:148</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:1560</div></div>
<div class="ttc" id="aclass_s_x127x_html_a9877550ed7881be06d00ea190f230fb9"><div class="ttname"><a href="class_s_x127x.html#a9877550ed7881be06d00ea190f230fb9">SX127x::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> SX127x.cpp:1531</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:467</div></div>
<div class="ttc" id="aclass_s_x127x_html_a9ca9aa18e13e8390ec437e249e1d2472"><div class="ttname"><a href="class_s_x127x.html#a9ca9aa18e13e8390ec437e249e1d2472">SX127x::setLowBatteryThreshold</a></div><div class="ttdeci">int16_t setLowBatteryThreshold(int8_t level, uint32_t pin=RADIOLIB_NC)</div><div class="ttdoc">Set low battery indicator threshold.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1861</div></div>
<div class="ttc" id="aclass_s_x127x_html_a9ca9aa18e13e8390ec437e249e1d2472"><div class="ttname"><a href="class_s_x127x.html#a9ca9aa18e13e8390ec437e249e1d2472">SX127x::setLowBatteryThreshold</a></div><div class="ttdeci">int16_t setLowBatteryThreshold(int8_t level, uint32_t pin=RADIOLIB_NC)</div><div class="ttdoc">Set low battery indicator threshold.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1859</div></div>
<div class="ttc" id="aclass_s_x127x_html_a9e7ecbc92c9d70f93211d21399d237d0"><div class="ttname"><a href="class_s_x127x.html#a9e7ecbc92c9d70f93211d21399d237d0">SX127x::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> SX127x.cpp:1268</div></div>
<div class="ttc" id="aclass_s_x127x_html_aa3eae13a7f0558c1bc881abebd958242"><div class="ttname"><a href="class_s_x127x.html#aa3eae13a7f0558c1bc881abebd958242">SX127x::clearIrqFlags</a></div><div class="ttdeci">int16_t clearIrqFlags(uint32_t irq) override</div><div class="ttdoc">Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone).</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1419</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:342</div></div>
@ -984,7 +984,7 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
<div class="ttc" id="aclass_s_x127x_html_aae42b94ab2ecf729f29f101222e97666"><div class="ttname"><a href="class_s_x127x.html#aae42b94ab2ecf729f29f101222e97666">SX127x::setIrqFlags</a></div><div class="ttdeci">int16_t setIrqFlags(uint32_t irq) override</div><div class="ttdoc">Set interrupt on DIO1 to be sent on a specific IRQ bit (e.g. RxTimeout, CadDone). NOTE: Unlike other ...</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1317</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:1030</div></div>
<div class="ttc" id="aclass_s_x127x_html_ab531ad461b250a060e92d9c744e79070"><div class="ttname"><a href="class_s_x127x.html#ab531ad461b250a060e92d9c744e79070">SX127x::setCrcFiltering</a></div><div class="ttdeci">int16_t setCrcFiltering(bool enable=true)</div><div class="ttdoc">Enable CRC filtering and generation.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1434</div></div>
<div class="ttc" id="aclass_s_x127x_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_s_x127x.html#ab82617fa3fa9f21d4cd427314ecc4af8">SX127x::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:113</div></div>
<div class="ttc" id="aclass_s_x127x_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_s_x127x.html#ab82617fa3fa9f21d4cd427314ecc4af8">SX127x::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_x127x_html_ab9625a5246a45112267ce441ac2de254"><div class="ttname"><a href="class_s_x127x.html#ab9625a5246a45112267ce441ac2de254">SX127x::setRfSwitchTable</a></div><div class="ttdeci">void setRfSwitchTable(const uint32_t(&amp;pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])</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> SX127x.cpp:1527</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:1080</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:1479</div></div>
@ -996,17 +996,17 @@ $(document).ready(function(){initNavTree('_s_x127x_8h_source.html',''); initResi
<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:1498</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:5</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:1450</div></div>
<div class="ttc" id="aclass_s_x127x_html_ad7600b8b0aac4d8a5e962d631145b617"><div class="ttname"><a href="class_s_x127x.html#ad7600b8b0aac4d8a5e962d631145b617">SX127x::getFHSSHoppingPeriod</a></div><div class="ttdeci">uint8_t getFHSSHoppingPeriod(void)</div><div class="ttdoc">Gets FHSS hopping period.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1789</div></div>
<div class="ttc" id="aclass_s_x127x_html_ad7600b8b0aac4d8a5e962d631145b617"><div class="ttname"><a href="class_s_x127x.html#ad7600b8b0aac4d8a5e962d631145b617">SX127x::getFHSSHoppingPeriod</a></div><div class="ttdeci">uint8_t getFHSSHoppingPeriod(void)</div><div class="ttdoc">Gets FHSS hopping period.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1787</div></div>
<div class="ttc" id="aclass_s_x127x_html_adbc4021380dc557114625dc51262cf90"><div class="ttname"><a href="class_s_x127x.html#adbc4021380dc557114625dc51262cf90">SX127x::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> SX127x.cpp:1304</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:906</div></div>
<div class="ttc" id="aclass_s_x127x_html_ae236a467095fb5364d0fc4a98d85f96e"><div class="ttname"><a href="class_s_x127x.html#ae236a467095fb5364d0fc4a98d85f96e">SX127x::setPacketReceivedAction</a></div><div class="ttdeci">void setPacketReceivedAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:474</div></div>
<div class="ttc" id="aclass_s_x127x_html_ae4b99d1bc67ac2c81eeb11dd6793a8c5"><div class="ttname"><a href="class_s_x127x.html#ae4b99d1bc67ac2c81eeb11dd6793a8c5">SX127x::setDirectAction</a></div><div class="ttdeci">void setDirectAction(void(*func)(void)) override</div><div class="ttdoc">Set interrupt service routine function to call when data bit is received in direct mode.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1776</div></div>
<div class="ttc" id="aclass_s_x127x_html_ae4b99d1bc67ac2c81eeb11dd6793a8c5"><div class="ttname"><a href="class_s_x127x.html#ae4b99d1bc67ac2c81eeb11dd6793a8c5">SX127x::setDirectAction</a></div><div class="ttdeci">void setDirectAction(void(*func)(void)) override</div><div class="ttdoc">Set interrupt service routine function to call when data bit is received in direct mode.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1774</div></div>
<div class="ttc" id="aclass_s_x127x_html_ae75bc48cc74a407370cd9f4bf95e9e30"><div class="ttname"><a href="class_s_x127x.html#ae75bc48cc74a407370cd9f4bf95e9e30">SX127x::setDio0Action</a></div><div class="ttdeci">void setDio0Action(void(*func)(void), uint32_t dir)</div><div class="ttdoc">Set interrupt service routine function to call when DIO0 activates.</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:452</div></div>
<div class="ttc" id="aclass_s_x127x_html_aeac64ca102a143624993cb7cb5b9e17c"><div class="ttname"><a href="class_s_x127x.html#aeac64ca102a143624993cb7cb5b9e17c">SX127x::begin</a></div><div class="ttdeci">int16_t begin(uint8_t *chipVersions, uint8_t numVersions, 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:9</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:1556</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:313</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:826</div></div>
<div class="ttc" id="aclass_s_x127x_html_af7d373bc93e99790912cebe8d5ae6403"><div class="ttname"><a href="class_s_x127x.html#af7d373bc93e99790912cebe8d5ae6403">SX127x::setDIOMapping</a></div><div class="ttdeci">int16_t setDIOMapping(uint32_t pin, uint32_t value) override</div><div class="ttdoc">Configure DIO pin mapping to get a given signal on a DIO pin (if available).</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1806</div></div>
<div class="ttc" id="aclass_s_x127x_html_af7d373bc93e99790912cebe8d5ae6403"><div class="ttname"><a href="class_s_x127x.html#af7d373bc93e99790912cebe8d5ae6403">SX127x::setDIOMapping</a></div><div class="ttdeci">int16_t setDIOMapping(uint32_t pin, uint32_t value) override</div><div class="ttdoc">Configure DIO pin mapping to get a given signal on a DIO pin (if available).</div><div class="ttdef"><b>Definition:</b> SX127x.cpp:1804</div></div>
<div class="ttc" id="aclass_s_x127x_html_af8530e9d858b155eb5acb764a733bcd4"><div class="ttname"><a href="class_s_x127x.html#af8530e9d858b155eb5acb764a733bcd4">SX127x::beginFSK</a></div><div class="ttdeci">int16_t beginFSK(uint8_t *chipVersions, uint8_t numVersions, 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:72</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:1108</div></div>
<div class="ttc" id="agroup__typedefs_html_ga210f31dd2bff7fb80563275648a5bbbd"><div class="ttname"><a href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a></div><div class="ttdeci">unsigned long RadioLibTime_t</div><div class="ttdoc">Type used for durations in RadioLib.</div><div class="ttdef"><b>Definition:</b> TypeDef.h:642</div></div>

64
_s_x128x_8h_source.html
View file

@ -655,71 +655,71 @@ $(document).ready(function(){initNavTree('_s_x128x_8h_source.html',''); initResi
<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:66</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. Note: It is not recommended to use this c...</div><div class="ttdef"><b>Definition:</b> Module.h:75</div></div>
<div class="ttc" id="aclass_physical_layer_html"><div class="ttname"><a href="class_physical_layer.html">PhysicalLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:151</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:210</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:206</div></div>
<div class="ttc" id="aclass_physical_layer_html_a492b2d057dd803c3884fa1adc8e22534"><div class="ttname"><a href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">PhysicalLayer::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:53</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:150</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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:113</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:148</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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_x128x_html"><div class="ttname"><a href="class_s_x128x.html">SX128x</a></div><div class="ttdoc">Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from thi...</div><div class="ttdef"><b>Definition:</b> SX128x.h:351</div></div>
<div class="ttc" id="aclass_s_x128x_html_a0759fb31b3ce5bf1c832259c9c2245ed"><div class="ttname"><a href="class_s_x128x.html#a0759fb31b3ce5bf1c832259c9c2245ed">SX128x::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> SX128x.cpp:491</div></div>
<div class="ttc" id="aclass_s_x128x_html_a1984a405262f155f16a4759c5f6b0133"><div class="ttname"><a href="class_s_x128x.html#a1984a405262f155f16a4759c5f6b0133">SX128x::setPreambleLength</a></div><div class="ttdeci">int16_t setPreambleLength(uint32_t preambleLength)</div><div class="ttdoc">Sets preamble length for currently active modem. Allowed values range from 1 to 65535.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:890</div></div>
<div class="ttc" id="aclass_s_x128x_html_a1984a405262f155f16a4759c5f6b0133"><div class="ttname"><a href="class_s_x128x.html#a1984a405262f155f16a4759c5f6b0133">SX128x::setPreambleLength</a></div><div class="ttdeci">int16_t setPreambleLength(uint32_t preambleLength)</div><div class="ttdoc">Sets preamble length for currently active modem. Allowed values range from 1 to 65535.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:888</div></div>
<div class="ttc" id="aclass_s_x128x_html_a1bc3372c47a4e3c81ef15bee448ba6b6"><div class="ttname"><a href="class_s_x128x.html#a1bc3372c47a4e3c81ef15bee448ba6b6">SX128x::setOutputPower</a></div><div class="ttdeci">int16_t setOutputPower(int8_t pwr) override</div><div class="ttdoc">Sets output power. Allowed values are in range from -18 to 13 dBm.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:842</div></div>
<div class="ttc" id="aclass_s_x128x_html_a1e6f938ce715dad9a6609bf56626a50d"><div class="ttname"><a href="class_s_x128x.html#a1e6f938ce715dad9a6609bf56626a50d">SX128x::setPacketSentAction</a></div><div class="ttdeci">void setPacketSentAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:507</div></div>
<div class="ttc" id="aclass_s_x128x_html_a209d69e710a785da2c69474f94fdccf3"><div class="ttname"><a href="class_s_x128x.html#a209d69e710a785da2c69474f94fdccf3">SX128x::setModem</a></div><div class="ttdeci">int16_t setModem(ModemType_t modem) override</div><div class="ttdoc">Set modem for the radio to use. Will perform full reset and reconfigure the radio using its default p...</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:859</div></div>
<div class="ttc" id="aclass_s_x128x_html_a2326cf28c385b8dd709cb62c9f665000"><div class="ttname"><a href="class_s_x128x.html#a2326cf28c385b8dd709cb62c9f665000">SX128x::setDirectAction</a></div><div class="ttdeci">void setDirectAction(void(*func)(void)) override</div><div class="ttdoc">Dummy method, to ensure PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1494</div></div>
<div class="ttc" id="aclass_s_x128x_html_a260b99d8427e089546e33084803d955a"><div class="ttname"><a href="class_s_x128x.html#a260b99d8427e089546e33084803d955a">SX128x::getRSSI</a></div><div class="ttdeci">float getRSSI() override</div><div class="ttdoc">Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1281</div></div>
<div class="ttc" id="aclass_s_x128x_html_a2326cf28c385b8dd709cb62c9f665000"><div class="ttname"><a href="class_s_x128x.html#a2326cf28c385b8dd709cb62c9f665000">SX128x::setDirectAction</a></div><div class="ttdeci">void setDirectAction(void(*func)(void)) override</div><div class="ttdoc">Dummy method, to ensure PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1492</div></div>
<div class="ttc" id="aclass_s_x128x_html_a260b99d8427e089546e33084803d955a"><div class="ttname"><a href="class_s_x128x.html#a260b99d8427e089546e33084803d955a">SX128x::getRSSI</a></div><div class="ttdeci">float getRSSI() override</div><div class="ttdoc">Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1279</div></div>
<div class="ttc" id="aclass_s_x128x_html_a2643ce22176293631fea2169f5e68e66"><div class="ttname"><a href="class_s_x128x.html#a2643ce22176293631fea2169f5e68e66">SX128x::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> SX128x.cpp:281</div></div>
<div class="ttc" id="aclass_s_x128x_html_a26d0d02e5e53a3172df9208fa343a3f1"><div class="ttname"><a href="class_s_x128x.html#a26d0d02e5e53a3172df9208fa343a3f1">SX128x::setFrequencyDeviation</a></div><div class="ttdeci">int16_t setFrequencyDeviation(float freqDev) override</div><div class="ttdoc">Sets FSK frequency deviation. Allowed values range from 0.0 to 3200.0 kHz.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1011</div></div>
<div class="ttc" id="aclass_s_x128x_html_a26d0d02e5e53a3172df9208fa343a3f1"><div class="ttname"><a href="class_s_x128x.html#a26d0d02e5e53a3172df9208fa343a3f1">SX128x::setFrequencyDeviation</a></div><div class="ttdeci">int16_t setFrequencyDeviation(float freqDev) override</div><div class="ttdoc">Sets FSK frequency deviation. Allowed values range from 0.0 to 3200.0 kHz.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1009</div></div>
<div class="ttc" id="aclass_s_x128x_html_a275a9a86934124eab4982ad52bf91aea"><div class="ttname"><a href="class_s_x128x.html#a275a9a86934124eab4982ad52bf91aea">SX128x::begin</a></div><div class="ttdeci">int16_t begin(float freq=2400.0, float bw=812.5, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX128X_SYNC_WORD_PRIVATE, int8_t pwr=10, uint16_t preambleLength=12)</div><div class="ttdoc">Initialization method for LoRa modem.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:19</div></div>
<div class="ttc" id="aclass_s_x128x_html_a2b424000856a9dc212f571d0e8890635"><div class="ttname"><a href="class_s_x128x.html#a2b424000856a9dc212f571d0e8890635">SX128x::getFrequencyError</a></div><div class="ttdeci">float getFrequencyError()</div><div class="ttdoc">Gets frequency error of the latest received packet.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1336</div></div>
<div class="ttc" id="aclass_s_x128x_html_a2b424000856a9dc212f571d0e8890635"><div class="ttname"><a href="class_s_x128x.html#a2b424000856a9dc212f571d0e8890635">SX128x::getFrequencyError</a></div><div class="ttdeci">float getFrequencyError()</div><div class="ttdoc">Gets frequency error of the latest received packet.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1334</div></div>
<div class="ttc" id="aclass_s_x128x_html_a2be8cc6c3b61b59cb6a6ca4f6a030b45"><div class="ttname"><a href="class_s_x128x.html#a2be8cc6c3b61b59cb6a6ca4f6a030b45">SX128x::standby</a></div><div class="ttdeci">int16_t standby() override</div><div class="ttdoc">Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator)...</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:474</div></div>
<div class="ttc" id="aclass_s_x128x_html_a2c4a24623c5fd27b3cc937e55783d709"><div class="ttname"><a href="class_s_x128x.html#a2c4a24623c5fd27b3cc937e55783d709">SX128x::beginFLRC</a></div><div class="ttdeci">int16_t beginFLRC(float freq=2400.0, uint16_t br=650, uint8_t cr=3, int8_t pwr=10, uint16_t preambleLength=16, uint8_t dataShaping=RADIOLIB_SHAPING_0_5)</div><div class="ttdoc">Initialization method for FLRC modem.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:213</div></div>
<div class="ttc" id="aclass_s_x128x_html_a2f8427103d6609f3ac44b23fcca4f301"><div class="ttname"><a href="class_s_x128x.html#a2f8427103d6609f3ac44b23fcca4f301">SX128x::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> SX128x.cpp:423</div></div>
<div class="ttc" id="aclass_s_x128x_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_s_x128x.html#a3563453988a83d22dd07d4691543a300">SX128x::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:210</div></div>
<div class="ttc" id="aclass_s_x128x_html_a3837662441a9eb3f0a71f4f667db9e91"><div class="ttname"><a href="class_s_x128x.html#a3837662441a9eb3f0a71f4f667db9e91">SX128x::setGainControl</a></div><div class="ttdeci">int16_t setGainControl(uint8_t gain=0)</div><div class="ttdoc">Enables or disables receiver manual gain control.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1245</div></div>
<div class="ttc" id="aclass_s_x128x_html_a390fd0749b316eed67da7b54f4f24735"><div class="ttname"><a href="class_s_x128x.html#a390fd0749b316eed67da7b54f4f24735">SX128x::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> SX128x.cpp:1369</div></div>
<div class="ttc" id="aclass_s_x128x_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_s_x128x.html#a3563453988a83d22dd07d4691543a300">SX128x::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:206</div></div>
<div class="ttc" id="aclass_s_x128x_html_a3837662441a9eb3f0a71f4f667db9e91"><div class="ttname"><a href="class_s_x128x.html#a3837662441a9eb3f0a71f4f667db9e91">SX128x::setGainControl</a></div><div class="ttdeci">int16_t setGainControl(uint8_t gain=0)</div><div class="ttdoc">Enables or disables receiver manual gain control.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1243</div></div>
<div class="ttc" id="aclass_s_x128x_html_a390fd0749b316eed67da7b54f4f24735"><div class="ttname"><a href="class_s_x128x.html#a390fd0749b316eed67da7b54f4f24735">SX128x::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> SX128x.cpp:1367</div></div>
<div class="ttc" id="aclass_s_x128x_html_a4587409a9b96a0c496cf12b3acac20c4"><div class="ttname"><a href="class_s_x128x.html#a4587409a9b96a0c496cf12b3acac20c4">SX128x::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> SX128x.cpp:579</div></div>
<div class="ttc" id="aclass_s_x128x_html_a46e7979288205689ea97f1c26d1da07e"><div class="ttname"><a href="class_s_x128x.html#a46e7979288205689ea97f1c26d1da07e">SX128x::invertIQ</a></div><div class="ttdeci">int16_t invertIQ(bool enable) override</div><div class="ttdoc">Enable/disable inversion of the I and Q signals.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1479</div></div>
<div class="ttc" id="aclass_s_x128x_html_a46e7979288205689ea97f1c26d1da07e"><div class="ttname"><a href="class_s_x128x.html#a46e7979288205689ea97f1c26d1da07e">SX128x::invertIQ</a></div><div class="ttdeci">int16_t invertIQ(bool enable) override</div><div class="ttdoc">Enable/disable inversion of the I and Q signals.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1477</div></div>
<div class="ttc" id="aclass_s_x128x_html_a492b2d057dd803c3884fa1adc8e22534"><div class="ttname"><a href="class_s_x128x.html#a492b2d057dd803c3884fa1adc8e22534">SX128x::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:53</div></div>
<div class="ttc" id="aclass_s_x128x_html_a53892566b0259d348158efe3c3c3601a"><div class="ttname"><a href="class_s_x128x.html#a53892566b0259d348158efe3c3c3601a">SX128x::transmitDirect</a></div><div class="ttdeci">int16_t transmitDirect(uint32_t frf=0) override</div><div class="ttdoc">Starts direct mode transmission.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:400</div></div>
<div class="ttc" id="aclass_s_x128x_html_a5ba683fbc4a46418ce3736f224fb55f2"><div class="ttname"><a href="class_s_x128x.html#a5ba683fbc4a46418ce3736f224fb55f2">SX128x::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> SX128x.cpp:1465</div></div>
<div class="ttc" id="aclass_s_x128x_html_a5ba683fbc4a46418ce3736f224fb55f2"><div class="ttname"><a href="class_s_x128x.html#a5ba683fbc4a46418ce3736f224fb55f2">SX128x::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> SX128x.cpp:1463</div></div>
<div class="ttc" id="aclass_s_x128x_html_a5e876e02fd527390905004718225c25f"><div class="ttname"><a href="class_s_x128x.html#a5e876e02fd527390905004718225c25f">SX128x::checkOutputPower</a></div><div class="ttdeci">int16_t checkOutputPower(int8_t pwr, int8_t *clipped) override</div><div class="ttdoc">Check if output power is configurable.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:851</div></div>
<div class="ttc" id="aclass_s_x128x_html_a6a2ec5d316975f390f20b4e0a2e11e98"><div class="ttname"><a href="class_s_x128x.html#a6a2ec5d316975f390f20b4e0a2e11e98">SX128x::setIrqFlags</a></div><div class="ttdeci">int16_t setIrqFlags(uint32_t irq) override</div><div class="ttdoc">Set interrupt on DIO1 to be sent on a specific IRQ bit (e.g. RxTimeout, CadDone).</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:673</div></div>
<div class="ttc" id="aclass_s_x128x_html_a6e45fbfaec7063e52e188f47a3a585a5"><div class="ttname"><a href="class_s_x128x.html#a6e45fbfaec7063e52e188f47a3a585a5">SX128x::setHighSensitivityMode</a></div><div class="ttdeci">int16_t setHighSensitivityMode(bool enable)</div><div class="ttdoc">Enables or disables receiver high sensitivity mode.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1228</div></div>
<div class="ttc" id="aclass_s_x128x_html_a6e45fbfaec7063e52e188f47a3a585a5"><div class="ttname"><a href="class_s_x128x.html#a6e45fbfaec7063e52e188f47a3a585a5">SX128x::setHighSensitivityMode</a></div><div class="ttdeci">int16_t setHighSensitivityMode(bool enable)</div><div class="ttdoc">Enables or disables receiver high sensitivity mode.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1226</div></div>
<div class="ttc" id="aclass_s_x128x_html_a6ed60dfbd142315bb4e1abd2555a470a"><div class="ttname"><a href="class_s_x128x.html#a6ed60dfbd142315bb4e1abd2555a470a">SX128x::beginGFSK</a></div><div class="ttdeci">int16_t beginGFSK(float freq=2400.0, uint16_t br=800, float freqDev=400.0, int8_t pwr=10, uint16_t preambleLength=16)</div><div class="ttdoc">Initialization method for GFSK modem.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:83</div></div>
<div class="ttc" id="aclass_s_x128x_html_a803eaca8bb7fdfa3570cf4aa95f8e729"><div class="ttname"><a href="class_s_x128x.html#a803eaca8bb7fdfa3570cf4aa95f8e729">SX128x::startReceive</a></div><div class="ttdeci">int16_t startReceive() override</div><div class="ttdoc">Interrupt-driven receive method with default parameters. Implemented for compatibility with PhysicalL...</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:587</div></div>
<div class="ttc" id="aclass_s_x128x_html_a8720a388d2cd10fac3112b89f4a80947"><div class="ttname"><a href="class_s_x128x.html#a8720a388d2cd10fac3112b89f4a80947">SX128x::setEncoding</a></div><div class="ttdeci">int16_t setEncoding(uint8_t encoding) override</div><div class="ttdoc">Sets transmission encoding. Serves only as alias for PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1461</div></div>
<div class="ttc" id="aclass_s_x128x_html_a8b3eea268f21bf911b6eaf37c5eb0b5f"><div class="ttname"><a href="class_s_x128x.html#a8b3eea268f21bf911b6eaf37c5eb0b5f">SX128x::setWhitening</a></div><div class="ttdeci">int16_t setWhitening(bool enabled)</div><div class="ttdoc">Sets whitening parameters, not available for LoRa or FLRC modem.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1197</div></div>
<div class="ttc" id="aclass_s_x128x_html_a8d331080599e09ef0b11a77cffd6f13a"><div class="ttname"><a href="class_s_x128x.html#a8d331080599e09ef0b11a77cffd6f13a">SX128x::randomByte</a></div><div class="ttdeci">uint8_t randomByte() override</div><div class="ttdoc">Dummy random method, to ensure PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1473</div></div>
<div class="ttc" id="aclass_s_x128x_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_s_x128x.html#a923654706eff5118ef6e84214e837f27">SX128x::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:150</div></div>
<div class="ttc" id="aclass_s_x128x_html_a9346490a6c56edcff2e12ae0369a8df5"><div class="ttname"><a href="class_s_x128x.html#a9346490a6c56edcff2e12ae0369a8df5">SX128x::setAccessAddress</a></div><div class="ttdeci">int16_t setAccessAddress(uint32_t addr)</div><div class="ttdoc">Sets BLE access address.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1217</div></div>
<div class="ttc" id="aclass_s_x128x_html_a8720a388d2cd10fac3112b89f4a80947"><div class="ttname"><a href="class_s_x128x.html#a8720a388d2cd10fac3112b89f4a80947">SX128x::setEncoding</a></div><div class="ttdeci">int16_t setEncoding(uint8_t encoding) override</div><div class="ttdoc">Sets transmission encoding. Serves only as alias for PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1459</div></div>
<div class="ttc" id="aclass_s_x128x_html_a8b3eea268f21bf911b6eaf37c5eb0b5f"><div class="ttname"><a href="class_s_x128x.html#a8b3eea268f21bf911b6eaf37c5eb0b5f">SX128x::setWhitening</a></div><div class="ttdeci">int16_t setWhitening(bool enabled)</div><div class="ttdoc">Sets whitening parameters, not available for LoRa or FLRC modem.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1195</div></div>
<div class="ttc" id="aclass_s_x128x_html_a8d331080599e09ef0b11a77cffd6f13a"><div class="ttname"><a href="class_s_x128x.html#a8d331080599e09ef0b11a77cffd6f13a">SX128x::randomByte</a></div><div class="ttdeci">uint8_t randomByte() override</div><div class="ttdoc">Dummy random method, to ensure PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1471</div></div>
<div class="ttc" id="aclass_s_x128x_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_s_x128x.html#a923654706eff5118ef6e84214e837f27">SX128x::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:148</div></div>
<div class="ttc" id="aclass_s_x128x_html_a9346490a6c56edcff2e12ae0369a8df5"><div class="ttname"><a href="class_s_x128x.html#a9346490a6c56edcff2e12ae0369a8df5">SX128x::setAccessAddress</a></div><div class="ttdeci">int16_t setAccessAddress(uint32_t addr)</div><div class="ttdoc">Sets BLE access address.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1215</div></div>
<div class="ttc" id="aclass_s_x128x_html_a948156af6e886bc46a6c6c5fb10a087a"><div class="ttname"><a href="class_s_x128x.html#a948156af6e886bc46a6c6c5fb10a087a">SX128x::startChannelScan</a></div><div class="ttdeci">int16_t startChannelScan() override</div><div class="ttdoc">Interrupt-driven channel activity detection method. DIO1 will be activated when LoRa preamble is dete...</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:681</div></div>
<div class="ttc" id="aclass_s_x128x_html_a94b7fb26cc99385d30b0c98b76d8188d"><div class="ttname"><a href="class_s_x128x.html#a94b7fb26cc99385d30b0c98b76d8188d">SX128x::explicitHeader</a></div><div class="ttdeci">int16_t explicitHeader()</div><div class="ttdoc">Set explicit header mode for future reception/transmission.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1457</div></div>
<div class="ttc" id="aclass_s_x128x_html_a99491c705e88dddc820f884b778f1660"><div class="ttname"><a href="class_s_x128x.html#a99491c705e88dddc820f884b778f1660">SX128x::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> SX128x.cpp:1044</div></div>
<div class="ttc" id="aclass_s_x128x_html_a94b7fb26cc99385d30b0c98b76d8188d"><div class="ttname"><a href="class_s_x128x.html#a94b7fb26cc99385d30b0c98b76d8188d">SX128x::explicitHeader</a></div><div class="ttdeci">int16_t explicitHeader()</div><div class="ttdoc">Set explicit header mode for future reception/transmission.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1455</div></div>
<div class="ttc" id="aclass_s_x128x_html_a99491c705e88dddc820f884b778f1660"><div class="ttname"><a href="class_s_x128x.html#a99491c705e88dddc820f884b778f1660">SX128x::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> SX128x.cpp:1042</div></div>
<div class="ttc" id="aclass_s_x128x_html_a9ccbf51f8304f1041c8eef182be547a7"><div class="ttname"><a href="class_s_x128x.html#a9ccbf51f8304f1041c8eef182be547a7">SX128x::SX128x</a></div><div class="ttdeci">SX128x(Module *mod)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:5</div></div>
<div class="ttc" id="aclass_s_x128x_html_a9da544e4a6120f73a078b46c6138505a"><div class="ttname"><a href="class_s_x128x.html#a9da544e4a6120f73a078b46c6138505a">SX128x::setCodingRate</a></div><div class="ttdeci">int16_t setCodingRate(uint8_t cr, bool longInterleaving=false)</div><div class="ttdoc">Sets LoRa coding rate denominator. Allowed values range from 5 to 8.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:814</div></div>
<div class="ttc" id="aclass_s_x128x_html_aa17ffcb939f6b2eb0712e63b6ee7a71f"><div class="ttname"><a href="class_s_x128x.html#aa17ffcb939f6b2eb0712e63b6ee7a71f">SX128x::getIrqFlags</a></div><div class="ttdeci">uint32_t getIrqFlags() override</div><div class="ttdoc">Read currently active IRQ flags.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:669</div></div>
<div class="ttc" id="aclass_s_x128x_html_aa4b1e0b96347011522e053f30202c0fe"><div class="ttname"><a href="class_s_x128x.html#aa4b1e0b96347011522e053f30202c0fe">SX128x::setCRC</a></div><div class="ttdeci">int16_t setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)</div><div class="ttdoc">Sets CRC configuration.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1133</div></div>
<div class="ttc" id="aclass_s_x128x_html_aa4b1e0b96347011522e053f30202c0fe"><div class="ttname"><a href="class_s_x128x.html#aa4b1e0b96347011522e053f30202c0fe">SX128x::setCRC</a></div><div class="ttdeci">int16_t setCRC(uint8_t len, uint32_t initial=0x1D0F, uint16_t polynomial=0x1021)</div><div class="ttdoc">Sets CRC configuration.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1131</div></div>
<div class="ttc" id="aclass_s_x128x_html_ab0c26aebd432d36974b3066055df6b01"><div class="ttname"><a href="class_s_x128x.html#ab0c26aebd432d36974b3066055df6b01">SX128x::sleep</a></div><div class="ttdeci">int16_t sleep() override</div><div class="ttdoc">Sets the module to sleep mode. To wake the device up, call standby(). Overload for PhysicalLayer comp...</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:452</div></div>
<div class="ttc" id="aclass_s_x128x_html_ab2335d91c7899291312e3cd6576446e5"><div class="ttname"><a href="class_s_x128x.html#ab2335d91c7899291312e3cd6576446e5">SX128x::clearPacketSentAction</a></div><div class="ttdeci">void clearPacketSentAction() override</div><div class="ttdoc">Clears interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:511</div></div>
<div class="ttc" id="aclass_s_x128x_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_s_x128x.html#ab82617fa3fa9f21d4cd427314ecc4af8">SX128x::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:113</div></div>
<div class="ttc" id="aclass_s_x128x_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_s_x128x.html#ab82617fa3fa9f21d4cd427314ecc4af8">SX128x::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_x128x_html_ab8a3fe8e2843fa039ef369668f1a423f"><div class="ttname"><a href="class_s_x128x.html#ab8a3fe8e2843fa039ef369668f1a423f">SX128x::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> SX128x.cpp:495</div></div>
<div class="ttc" id="aclass_s_x128x_html_ab9e16231c2c6bd0e4b4c6c2900b5b332"><div class="ttname"><a href="class_s_x128x.html#ab9e16231c2c6bd0e4b4c6c2900b5b332">SX128x::setFrequency</a></div><div class="ttdeci">int16_t setFrequency(float freq) override</div><div class="ttdoc">Sets carrier frequency. Allowed values are in range from 2400.0 to 2500.0 MHz.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:742</div></div>
<div class="ttc" id="aclass_s_x128x_html_ac39f77b77a2e4124cc30aeae08b4c653"><div class="ttname"><a href="class_s_x128x.html#ac39f77b77a2e4124cc30aeae08b4c653">SX128x::getChannelScanResult</a></div><div class="ttdeci">int16_t getChannelScanResult() override</div><div class="ttdoc">Read the channel scan result.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:721</div></div>
<div class="ttc" id="aclass_s_x128x_html_ac69cc622020419cb3393eac5cc88915b"><div class="ttname"><a href="class_s_x128x.html#ac69cc622020419cb3393eac5cc88915b">SX128x::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> SX128x.cpp:1453</div></div>
<div class="ttc" id="aclass_s_x128x_html_ac69cc622020419cb3393eac5cc88915b"><div class="ttname"><a href="class_s_x128x.html#ac69cc622020419cb3393eac5cc88915b">SX128x::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> SX128x.cpp:1451</div></div>
<div class="ttc" id="aclass_s_x128x_html_ac79047a072a038194f3429a913e7aaee"><div class="ttname"><a href="class_s_x128x.html#ac79047a072a038194f3429a913e7aaee">SX128x::clearPacketReceivedAction</a></div><div class="ttdeci">void clearPacketReceivedAction() override</div><div class="ttdoc">Clears interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:503</div></div>
<div class="ttc" id="aclass_s_x128x_html_ace5ede905bf85aada0c61b9cfaaea127"><div class="ttname"><a href="class_s_x128x.html#ace5ede905bf85aada0c61b9cfaaea127">SX128x::beginBLE</a></div><div class="ttdeci">int16_t beginBLE(float freq=2400.0, uint16_t br=800, float freqDev=400.0, int8_t pwr=10, uint8_t dataShaping=RADIOLIB_SHAPING_0_5)</div><div class="ttdoc">Initialization method for BLE modem.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:155</div></div>
<div class="ttc" id="aclass_s_x128x_html_ad5789bd27d46b24f54aac9ca55ec9958"><div class="ttname"><a href="class_s_x128x.html#ad5789bd27d46b24f54aac9ca55ec9958">SX128x::setRfSwitchTable</a></div><div class="ttdeci">void setRfSwitchTable(const uint32_t(&amp;pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])</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> SX128x.cpp:1469</div></div>
<div class="ttc" id="aclass_s_x128x_html_ad6570f33bae09bc8b7617f9da39033ac"><div class="ttname"><a href="class_s_x128x.html#ad6570f33bae09bc8b7617f9da39033ac">SX128x::setBitRate</a></div><div class="ttdeci">int16_t setBitRate(float br) override</div><div class="ttdoc">Sets FSK or FLRC bit rate. Allowed values are 125, 250, 400, 500, 800, 1000, 1600 and 2000 kbps (for ...</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:954</div></div>
<div class="ttc" id="aclass_s_x128x_html_ad5789bd27d46b24f54aac9ca55ec9958"><div class="ttname"><a href="class_s_x128x.html#ad5789bd27d46b24f54aac9ca55ec9958">SX128x::setRfSwitchTable</a></div><div class="ttdeci">void setRfSwitchTable(const uint32_t(&amp;pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])</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> SX128x.cpp:1467</div></div>
<div class="ttc" id="aclass_s_x128x_html_ad6570f33bae09bc8b7617f9da39033ac"><div class="ttname"><a href="class_s_x128x.html#ad6570f33bae09bc8b7617f9da39033ac">SX128x::setBitRate</a></div><div class="ttdeci">int16_t setBitRate(float br) override</div><div class="ttdoc">Sets FSK or FLRC bit rate. Allowed values are 125, 250, 400, 500, 800, 1000, 1600 and 2000 kbps (for ...</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:952</div></div>
<div class="ttc" id="aclass_s_x128x_html_ad7bb0f4aa60a600d24d6268b430e719d"><div class="ttname"><a href="class_s_x128x.html#ad7bb0f4aa60a600d24d6268b430e719d">SX128x::getModem</a></div><div class="ttdeci">int16_t getModem(ModemType_t *modem) override</div><div class="ttdoc">Get modem currently in use by the radio.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:872</div></div>
<div class="ttc" id="aclass_s_x128x_html_ad9584464d2e4cc09686cf4e83e65d3e0"><div class="ttname"><a href="class_s_x128x.html#ad9584464d2e4cc09686cf4e83e65d3e0">SX128x::setSyncWord</a></div><div class="ttdeci">int16_t setSyncWord(const uint8_t *syncWord, uint8_t len)</div><div class="ttdoc">Sets FSK/FLRC sync word in the form of array of up to 5 bytes (FSK). For FLRC modem,...</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1074</div></div>
<div class="ttc" id="aclass_s_x128x_html_ad9584464d2e4cc09686cf4e83e65d3e0"><div class="ttname"><a href="class_s_x128x.html#ad9584464d2e4cc09686cf4e83e65d3e0">SX128x::setSyncWord</a></div><div class="ttdeci">int16_t setSyncWord(const uint8_t *syncWord, uint8_t len)</div><div class="ttdoc">Sets FSK/FLRC sync word in the form of array of up to 5 bytes (FSK). For FLRC modem,...</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1072</div></div>
<div class="ttc" id="aclass_s_x128x_html_ad98c4526ef971f9aadb30e351a37eaf9"><div class="ttname"><a href="class_s_x128x.html#ad98c4526ef971f9aadb30e351a37eaf9">SX128x::setPacketReceivedAction</a></div><div class="ttdeci">void setPacketReceivedAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:499</div></div>
<div class="ttc" id="aclass_s_x128x_html_adbf5a9ac62460efb1c709e51260dbe3d"><div class="ttname"><a href="class_s_x128x.html#adbf5a9ac62460efb1c709e51260dbe3d">SX128x::setDataRate</a></div><div class="ttdeci">int16_t setDataRate(DataRate_t dr) override</div><div class="ttdoc">Set data rate.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:938</div></div>
<div class="ttc" id="aclass_s_x128x_html_adce2e6c7215caa7c904b0d8f9cbd107d"><div class="ttname"><a href="class_s_x128x.html#adce2e6c7215caa7c904b0d8f9cbd107d">SX128x::getSNR</a></div><div class="ttdeci">float getSNR() override</div><div class="ttdoc">Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa or ranging mode...</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1316</div></div>
<div class="ttc" id="aclass_s_x128x_html_ae1f933f767161cc59fdaca816ab93e22"><div class="ttname"><a href="class_s_x128x.html#ae1f933f767161cc59fdaca816ab93e22">SX128x::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> SX128x.cpp:1609</div></div>
<div class="ttc" id="aclass_s_x128x_html_adbf5a9ac62460efb1c709e51260dbe3d"><div class="ttname"><a href="class_s_x128x.html#adbf5a9ac62460efb1c709e51260dbe3d">SX128x::setDataRate</a></div><div class="ttdeci">int16_t setDataRate(DataRate_t dr) override</div><div class="ttdoc">Set data rate.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:936</div></div>
<div class="ttc" id="aclass_s_x128x_html_adce2e6c7215caa7c904b0d8f9cbd107d"><div class="ttname"><a href="class_s_x128x.html#adce2e6c7215caa7c904b0d8f9cbd107d">SX128x::getSNR</a></div><div class="ttdeci">float getSNR() override</div><div class="ttdoc">Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa or ranging mode...</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1314</div></div>
<div class="ttc" id="aclass_s_x128x_html_ae1f933f767161cc59fdaca816ab93e22"><div class="ttname"><a href="class_s_x128x.html#ae1f933f767161cc59fdaca816ab93e22">SX128x::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> SX128x.cpp:1607</div></div>
<div class="ttc" id="aclass_s_x128x_html_ae435f57132f76f4283abb870176acf54"><div class="ttname"><a href="class_s_x128x.html#ae435f57132f76f4283abb870176acf54">SX128x::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> SX128x.cpp:780</div></div>
<div class="ttc" id="aclass_s_x128x_html_ae7d3676df8f28c79b9bee23df884fa55"><div class="ttname"><a href="class_s_x128x.html#ae7d3676df8f28c79b9bee23df884fa55">SX128x::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> SX128x.cpp:1389</div></div>
<div class="ttc" id="aclass_s_x128x_html_ae7d3676df8f28c79b9bee23df884fa55"><div class="ttname"><a href="class_s_x128x.html#ae7d3676df8f28c79b9bee23df884fa55">SX128x::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> SX128x.cpp:1387</div></div>
<div class="ttc" id="aclass_s_x128x_html_ae93c99c85deb950fe9bc7101142b5f6a"><div class="ttname"><a href="class_s_x128x.html#ae93c99c85deb950fe9bc7101142b5f6a">SX128x::setBandwidth</a></div><div class="ttdeci">int16_t setBandwidth(float bw)</div><div class="ttdoc">Sets LoRa bandwidth. Allowed values are 203.125, 406.25, 812.5 and 1625.0 kHz.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:750</div></div>
<div class="ttc" id="aclass_s_x128x_html_af2e1d173694a59082a22922a6f7d50a8"><div class="ttname"><a href="class_s_x128x.html#af2e1d173694a59082a22922a6f7d50a8">SX128x::readBit</a></div><div class="ttdeci">void readBit(uint32_t pin) override</div><div class="ttdoc">Dummy method, to ensure PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1500</div></div>
<div class="ttc" id="aclass_s_x128x_html_af2e1d173694a59082a22922a6f7d50a8"><div class="ttname"><a href="class_s_x128x.html#af2e1d173694a59082a22922a6f7d50a8">SX128x::readBit</a></div><div class="ttdeci">void readBit(uint32_t pin) override</div><div class="ttdoc">Dummy method, to ensure PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1498</div></div>
<div class="ttc" id="aclass_s_x128x_html_afb95ca5f2c8494042fbbe52802fc265d"><div class="ttname"><a href="class_s_x128x.html#afb95ca5f2c8494042fbbe52802fc265d">SX128x::clearIrqFlags</a></div><div class="ttdeci">int16_t clearIrqFlags(uint32_t irq) override</div><div class="ttdoc">Clear interrupt on a specific IRQ bit (e.g. RxTimeout, CadDone).</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:677</div></div>
<div class="ttc" id="aclass_s_x128x_html_aff7d86352c98771595375e17d19a2a97"><div class="ttname"><a href="class_s_x128x.html#aff7d86352c98771595375e17d19a2a97">SX128x::receiveDirect</a></div><div class="ttdeci">int16_t receiveDirect() override</div><div class="ttdoc">Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX128x series does...</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:415</div></div>
<div class="ttc" id="agroup__config__shaping_html_gaa778d14c29d21fe329137a28a3f54a5d"><div class="ttname"><a href="group__config__shaping.html#gaa778d14c29d21fe329137a28a3f54a5d">RADIOLIB_SHAPING_0_5</a></div><div class="ttdeci">#define RADIOLIB_SHAPING_0_5</div><div class="ttdoc">Gaussian shaping filter, BT = 0.5.</div><div class="ttdef"><b>Definition:</b> TypeDef.h:27</div></div>

12
_si443x_8h_source.html
View file

@ -765,10 +765,10 @@ $(document).ready(function(){initNavTree('_si443x_8h_source.html',''); initResiz
<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:66</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. Note: It is not recommended to use this c...</div><div class="ttdef"><b>Definition:</b> Module.h:75</div></div>
<div class="ttc" id="aclass_physical_layer_html"><div class="ttname"><a href="class_physical_layer.html">PhysicalLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:151</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:210</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:206</div></div>
<div class="ttc" id="aclass_physical_layer_html_a492b2d057dd803c3884fa1adc8e22534"><div class="ttname"><a href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">PhysicalLayer::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:53</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:150</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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:113</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:148</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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_si443x_html"><div class="ttname"><a href="class_si443x.html">Si443x</a></div><div class="ttdoc">Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from thi...</div><div class="ttdef"><b>Definition:</b> Si443x.h:553</div></div>
<div class="ttc" id="aclass_si443x_html_a0e098ea9aa3945f0c38f59efe43b147e"><div class="ttname"><a href="class_si443x.html#a0e098ea9aa3945f0c38f59efe43b147e">Si443x::setPacketReceivedAction</a></div><div class="ttdeci">void setPacketReceivedAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:213</div></div>
<div class="ttc" id="aclass_si443x_html_a1382fc3b68f447e381613e6670747128"><div class="ttname"><a href="class_si443x.html#a1382fc3b68f447e381613e6670747128">Si443x::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> Si443x.cpp:552</div></div>
@ -776,7 +776,7 @@ $(document).ready(function(){initNavTree('_si443x_8h_source.html',''); initResiz
<div class="ttc" id="aclass_si443x_html_a178b471527813a608c04db7d3c9648d6"><div class="ttname"><a href="class_si443x.html#a178b471527813a608c04db7d3c9648d6">Si443x::receiveDirect</a></div><div class="ttdeci">int16_t receiveDirect() override</div><div class="ttdoc">Enables direct reception mode. While in direct mode, the module will not be able to transmit or recei...</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:185</div></div>
<div class="ttc" id="aclass_si443x_html_a2bff9ba621ad00964bdfc72dd374a50b"><div class="ttname"><a href="class_si443x.html#a2bff9ba621ad00964bdfc72dd374a50b">Si443x::readBit</a></div><div class="ttdeci">void readBit(uint32_t pin) override</div><div class="ttdoc">Function to read and process data bit in direct reception mode.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:623</div></div>
<div class="ttc" id="aclass_si443x_html_a2d944669dc69ccd47f9e6c360f2ffd10"><div class="ttname"><a href="class_si443x.html#a2d944669dc69ccd47f9e6c360f2ffd10">Si443x::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> Si443x.cpp:539</div></div>
<div class="ttc" id="aclass_si443x_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_si443x.html#a3563453988a83d22dd07d4691543a300">Si443x::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:210</div></div>
<div class="ttc" id="aclass_si443x_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_si443x.html#a3563453988a83d22dd07d4691543a300">Si443x::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:206</div></div>
<div class="ttc" id="aclass_si443x_html_a43e7ceeff9114b35ab89f1d69916b375"><div class="ttname"><a href="class_si443x.html#a43e7ceeff9114b35ab89f1d69916b375">Si443x::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> Si443x.cpp:587</div></div>
<div class="ttc" id="aclass_si443x_html_a453eda5436dc4dfe0dad676dc3977752"><div class="ttname"><a href="class_si443x.html#a453eda5436dc4dfe0dad676dc3977752">Si443x::begin</a></div><div class="ttdeci">int16_t begin(float br, float freqDev, float rxBw, uint8_t preambleLen)</div><div class="ttdoc">Initialization method.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:9</div></div>
<div class="ttc" id="aclass_si443x_html_a4821a6141caf16141074615c976ecd91"><div class="ttname"><a href="class_si443x.html#a4821a6141caf16141074615c976ecd91">Si443x::setPreambleLength</a></div><div class="ttdeci">int16_t setPreambleLength(uint8_t preambleLen)</div><div class="ttdoc">Sets preamble length.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:523</div></div>
@ -792,9 +792,9 @@ $(document).ready(function(){initNavTree('_si443x_8h_source.html',''); initResiz
<div class="ttc" id="aclass_si443x_html_a801b51059e61f93d4e01ae6ba8eb0726"><div class="ttname"><a href="class_si443x.html#a801b51059e61f93d4e01ae6ba8eb0726">Si443x::setIrqAction</a></div><div class="ttdeci">void setIrqAction(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when IRQ activates.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:205</div></div>
<div class="ttc" id="aclass_si443x_html_a8898f11cf9dabd9a5ad717376fdbffa6"><div class="ttname"><a href="class_si443x.html#a8898f11cf9dabd9a5ad717376fdbffa6">Si443x::setRfSwitchTable</a></div><div class="ttdeci">void setRfSwitchTable(const uint32_t(&amp;pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])</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> Si443x.cpp:591</div></div>
<div class="ttc" id="aclass_si443x_html_a8d019f58551346c3f3bd8b72d2486109"><div class="ttname"><a href="class_si443x.html#a8d019f58551346c3f3bd8b72d2486109">Si443x::clearIrqAction</a></div><div class="ttdeci">void clearIrqAction()</div><div class="ttdoc">Clears interrupt service routine to call when IRQ activates.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:209</div></div>
<div class="ttc" id="aclass_si443x_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_si443x.html#a923654706eff5118ef6e84214e837f27">Si443x::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:150</div></div>
<div class="ttc" id="aclass_si443x_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_si443x.html#a923654706eff5118ef6e84214e837f27">Si443x::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:148</div></div>
<div class="ttc" id="aclass_si443x_html_ab0cc51d6b4264acf8e3e49a3a490dee9"><div class="ttname"><a href="class_si443x.html#ab0cc51d6b4264acf8e3e49a3a490dee9">Si443x::sleep</a></div><div class="ttdeci">int16_t sleep() override</div><div class="ttdoc">Sets the module to sleep to save power. Module will not be able to transmit or receive any data while...</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:117</div></div>
<div class="ttc" id="aclass_si443x_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_si443x.html#ab82617fa3fa9f21d4cd427314ecc4af8">Si443x::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:113</div></div>
<div class="ttc" id="aclass_si443x_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_si443x.html#ab82617fa3fa9f21d4cd427314ecc4af8">Si443x::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_si443x_html_abcca8ab4a1229efb5e7c6b09e564a48a"><div class="ttname"><a href="class_si443x.html#abcca8ab4a1229efb5e7c6b09e564a48a">Si443x::variablePacketLengthMode</a></div><div class="ttdeci">int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)</div><div class="ttdoc">Set modem in variable packet length mode.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:632</div></div>
<div class="ttc" id="aclass_si443x_html_ac45d2776df3ff338db154ead143fb7b8"><div class="ttname"><a href="class_si443x.html#ac45d2776df3ff338db154ead143fb7b8">Si443x::standby</a></div><div class="ttdeci">int16_t standby() override</div><div class="ttdoc">Sets the module to standby (with XTAL on).</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:133</div></div>
<div class="ttc" id="aclass_si443x_html_ad2b3a961a99d9e8f3a7ead6e8b69e858"><div class="ttname"><a href="class_si443x.html#ad2b3a961a99d9e8f3a7ead6e8b69e858">Si443x::fixedPacketLengthMode</a></div><div class="ttdeci">int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SI443X_MAX_PACKET_LENGTH)</div><div class="ttdoc">Set modem in fixed packet length mode.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:628</div></div>

12
n_r_f24_8h_source.html
View file

@ -383,10 +383,10 @@ $(document).ready(function(){initNavTree('n_r_f24_8h_source.html',''); initResiz
<div class="line"><a name="l00491"></a><span class="lineno"> 491</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:66</div></div>
<div class="ttc" id="aclass_physical_layer_html"><div class="ttname"><a href="class_physical_layer.html">PhysicalLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:151</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:210</div></div>
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:206</div></div>
<div class="ttc" id="aclass_physical_layer_html_a492b2d057dd803c3884fa1adc8e22534"><div class="ttname"><a href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">PhysicalLayer::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:53</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:150</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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:113</div></div>
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:148</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::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="aclassn_r_f24_html"><div class="ttname"><a href="classn_r_f24.html">nRF24</a></div><div class="ttdoc">Control class for nRF24 module.</div><div class="ttdef"><b>Definition:</b> nRF24.h:184</div></div>
<div class="ttc" id="aclassn_r_f24_html_a0429a9d6524005065e6fac21aaebdcbf"><div class="ttname"><a href="classn_r_f24.html#a0429a9d6524005065e6fac21aaebdcbf">nRF24::setEncoding</a></div><div class="ttdeci">int16_t setEncoding(uint8_t encoding) override</div><div class="ttdoc">Dummy encoding configuration method, to ensure PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:557</div></div>
<div class="ttc" id="aclassn_r_f24_html_a090bb64f65309efabfa1ffd86daa2303"><div class="ttname"><a href="classn_r_f24.html#a090bb64f65309efabfa1ffd86daa2303">nRF24::transmitDirect</a></div><div class="ttdeci">int16_t transmitDirect(uint32_t frf=0) override</div><div class="ttdoc">Starts direct mode transmission.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:133</div></div>
@ -396,7 +396,7 @@ $(document).ready(function(){initNavTree('n_r_f24_8h_source.html',''); initResiz
<div class="ttc" id="aclassn_r_f24_html_a23ea1749c21863ebc5bd3a2b08d64f3b"><div class="ttname"><a href="classn_r_f24.html#a23ea1749c21863ebc5bd3a2b08d64f3b">nRF24::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> nRF24.cpp:503</div></div>
<div class="ttc" id="aclassn_r_f24_html_a26b5f873db167733df143a0608eea3ac"><div class="ttname"><a href="classn_r_f24.html#a26b5f873db167733df143a0608eea3ac">nRF24::setPacketSentAction</a></div><div class="ttdeci">void setPacketSentAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is sent.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:170</div></div>
<div class="ttc" id="aclassn_r_f24_html_a31bcc5a8c3747bf08a273dbdadc5481a"><div class="ttname"><a href="classn_r_f24.html#a31bcc5a8c3747bf08a273dbdadc5481a">nRF24::setReceivePipe</a></div><div class="ttdeci">int16_t setReceivePipe(uint8_t pipeNum, uint8_t *addr)</div><div class="ttdoc">Sets address of receive pipes 0 or 1. The address width must be the same as the same as the configure...</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:405</div></div>
<div class="ttc" id="aclassn_r_f24_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="classn_r_f24.html#a3563453988a83d22dd07d4691543a300">nRF24::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:210</div></div>
<div class="ttc" id="aclassn_r_f24_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="classn_r_f24.html#a3563453988a83d22dd07d4691543a300">nRF24::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:206</div></div>
<div class="ttc" id="aclassn_r_f24_html_a3c6aa3622c887118fb8d8cb2689fdff2"><div class="ttname"><a href="classn_r_f24.html#a3c6aa3622c887118fb8d8cb2689fdff2">nRF24::startReceive</a></div><div class="ttdeci">int16_t startReceive() override</div><div class="ttdoc">Interrupt-driven receive method. IRQ will be activated when full packet is received.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:226</div></div>
<div class="ttc" id="aclassn_r_f24_html_a3eb45884a5730ac1c339c7ba4f7b5282"><div class="ttname"><a href="classn_r_f24.html#a3eb45884a5730ac1c339c7ba4f7b5282">nRF24::setCrcFiltering</a></div><div class="ttdeci">int16_t setCrcFiltering(bool crcOn=true)</div><div class="ttdoc">Enable CRC filtering and generation.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:510</div></div>
<div class="ttc" id="aclassn_r_f24_html_a3f0b08fd8e58db36f6c1926cc3eac6a9"><div class="ttname"><a href="classn_r_f24.html#a3f0b08fd8e58db36f6c1926cc3eac6a9">nRF24::getStatus</a></div><div class="ttdeci">int16_t getStatus(uint8_t mask=0xFF)</div><div class="ttdoc">Gets nRF24 status register.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:488</div></div>
@ -412,11 +412,11 @@ $(document).ready(function(){initNavTree('n_r_f24_8h_source.html',''); initResiz
<div class="ttc" id="aclassn_r_f24_html_a60df9afa489eabe3a3ca193ab7709165"><div class="ttname"><a href="classn_r_f24.html#a60df9afa489eabe3a3ca193ab7709165">nRF24::setPacketReceivedAction</a></div><div class="ttdeci">void setPacketReceivedAction(void(*func)(void)) override</div><div class="ttdoc">Sets interrupt service routine to call when a packet is received.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:162</div></div>
<div class="ttc" id="aclassn_r_f24_html_a69b75e0889c609099487a43c8c3b6721"><div class="ttname"><a href="classn_r_f24.html#a69b75e0889c609099487a43c8c3b6721">nRF24::sleep</a></div><div class="ttdeci">int16_t sleep() override</div><div class="ttdoc">Sets the module to sleep mode.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:67</div></div>
<div class="ttc" id="aclassn_r_f24_html_a760d3f47f58ddacdf41975447484a47c"><div class="ttname"><a href="classn_r_f24.html#a760d3f47f58ddacdf41975447484a47c">nRF24::setBitRate</a></div><div class="ttdeci">int16_t setBitRate(float br) override</div><div class="ttdoc">Sets bit rate. Allowed values are 2000, 1000 or 250 kbps.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:295</div></div>
<div class="ttc" id="aclassn_r_f24_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="classn_r_f24.html#a923654706eff5118ef6e84214e837f27">nRF24::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:150</div></div>
<div class="ttc" id="aclassn_r_f24_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="classn_r_f24.html#a923654706eff5118ef6e84214e837f27">nRF24::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *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:148</div></div>
<div class="ttc" id="aclassn_r_f24_html_aa0e1f2dddf810213410a420205bbd8af"><div class="ttname"><a href="classn_r_f24.html#aa0e1f2dddf810213410a420205bbd8af">nRF24::setTransmitPipe</a></div><div class="ttdeci">int16_t setTransmitPipe(uint8_t *addr)</div><div class="ttdoc">Sets address of transmit pipe. The address width must be the same as the same as the configured in se...</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:390</div></div>
<div class="ttc" id="aclassn_r_f24_html_aaf5887fe58c4d542cbed80482de1d42d"><div class="ttname"><a href="classn_r_f24.html#aaf5887fe58c4d542cbed80482de1d42d">nRF24::clearIrqAction</a></div><div class="ttdeci">void clearIrqAction()</div><div class="ttdoc">Clears interrupt service routine .</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:158</div></div>
<div class="ttc" id="aclassn_r_f24_html_ab12de8d953c2384c5fff09b4abf65d1e"><div class="ttname"><a href="classn_r_f24.html#ab12de8d953c2384c5fff09b4abf65d1e">nRF24::nRF24</a></div><div class="ttdeci">nRF24(Module *mod)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:5</div></div>
<div class="ttc" id="aclassn_r_f24_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="classn_r_f24.html#ab82617fa3fa9f21d4cd427314ecc4af8">nRF24::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:113</div></div>
<div class="ttc" id="aclassn_r_f24_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="classn_r_f24.html#ab82617fa3fa9f21d4cd427314ecc4af8">nRF24::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="aclassn_r_f24_html_abf9323748b1a850e6ddc6f6d48f4cfb3"><div class="ttname"><a href="classn_r_f24.html#abf9323748b1a850e6ddc6f6d48f4cfb3">nRF24::setIrqAction</a></div><div class="ttdeci">void setIrqAction(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when IRQ activates.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:154</div></div>
<div class="ttc" id="aclassn_r_f24_html_aca941c9235ba1212257288554eb4b7fe"><div class="ttname"><a href="classn_r_f24.html#aca941c9235ba1212257288554eb4b7fe">nRF24::setAutoAck</a></div><div class="ttdeci">int16_t setAutoAck(bool autoAckOn=true)</div><div class="ttdoc">Enable or disable auto-acknowledge packets on all pipes.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:521</div></div>
<div class="ttc" id="aclassn_r_f24_html_ad9204ee787b425e2c9e8422bb7939a37"><div class="ttname"><a href="classn_r_f24.html#ad9204ee787b425e2c9e8422bb7939a37">nRF24::isCarrierDetected</a></div><div class="ttdeci">bool isCarrierDetected()</div><div class="ttdoc">Checks if carrier was detected during last RX.</div><div class="ttdef"><b>Definition:</b> nRF24.cpp:492</div></div>