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

Deploying to gh-pages from @ 21f2ef6836 🚀

Browse source
This commit is contained in:
jgromes 2023-04-17 17:13:45 +00:00
parent 336dff3f0d
commit 01642d5c15
1 changed files with 21 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
_s_x128x_8h_source.html
View file

@ -601,24 +601,27 @@ $(document).ready(function(){initNavTree('_s_x128x_8h_source.html',''); initResi
<div class="line"><a name="l00905"></a><span class="lineno"> 905</span>&#160; <span class="comment">// common parameters</span></div>
<div class="line"><a name="l00906"></a><span class="lineno"> 906</span>&#160; uint8_t _pwr = 0;</div>
<div class="line"><a name="l00907"></a><span class="lineno"> 907</span>&#160; </div>
<div class="line"><a name="l00908"></a><span class="lineno"> 908</span>&#160; <span class="comment">// cached GFSK parameters</span></div>
<div class="line"><a name="l00909"></a><span class="lineno"> 909</span>&#160; <span class="keywordtype">float</span> _modIndexReal = 0;</div>
<div class="line"><a name="l00910"></a><span class="lineno"> 910</span>&#160; uint16_t _brKbps = 0;</div>
<div class="line"><a name="l00911"></a><span class="lineno"> 911</span>&#160; uint8_t _br = 0, _modIndex = 0, _shaping = 0;</div>
<div class="line"><a name="l00912"></a><span class="lineno"> 912</span>&#160; uint8_t _preambleLengthGFSK = 0, _syncWordLen = 0, _syncWordMatch = 0, _crcGFSK = 0, _whitening = 0;</div>
<div class="line"><a name="l00913"></a><span class="lineno"> 913</span>&#160; </div>
<div class="line"><a name="l00914"></a><span class="lineno"> 914</span>&#160; <span class="comment">// cached FLRC parameters</span></div>
<div class="line"><a name="l00915"></a><span class="lineno"> 915</span>&#160; uint8_t _crFLRC = 0;</div>
<div class="line"><a name="l00908"></a><span class="lineno"> 908</span>&#160; <span class="comment">// cached LoRa parameters</span></div>
<div class="line"><a name="l00909"></a><span class="lineno"> 909</span>&#160; uint8_t _invertIQ = RADIOLIB_SX128X_LORA_IQ_STANDARD;</div>
<div class="line"><a name="l00910"></a><span class="lineno"> 910</span>&#160; </div>
<div class="line"><a name="l00911"></a><span class="lineno"> 911</span>&#160; <span class="comment">// cached GFSK parameters</span></div>
<div class="line"><a name="l00912"></a><span class="lineno"> 912</span>&#160; <span class="keywordtype">float</span> _modIndexReal = 0;</div>
<div class="line"><a name="l00913"></a><span class="lineno"> 913</span>&#160; uint16_t _brKbps = 0;</div>
<div class="line"><a name="l00914"></a><span class="lineno"> 914</span>&#160; uint8_t _br = 0, _modIndex = 0, _shaping = 0;</div>
<div class="line"><a name="l00915"></a><span class="lineno"> 915</span>&#160; uint8_t _preambleLengthGFSK = 0, _syncWordLen = 0, _syncWordMatch = 0, _crcGFSK = 0, _whitening = 0;</div>
<div class="line"><a name="l00916"></a><span class="lineno"> 916</span>&#160; </div>
<div class="line"><a name="l00917"></a><span class="lineno"> 917</span>&#160; <span class="comment">// cached BLE parameters</span></div>
<div class="line"><a name="l00918"></a><span class="lineno"> 918</span>&#160; uint8_t _connectionState = 0, _crcBLE = 0, _bleTestPayload = 0;</div>
<div class="line"><a name="l00917"></a><span class="lineno"> 917</span>&#160; <span class="comment">// cached FLRC parameters</span></div>
<div class="line"><a name="l00918"></a><span class="lineno"> 918</span>&#160; uint8_t _crFLRC = 0;</div>
<div class="line"><a name="l00919"></a><span class="lineno"> 919</span>&#160; </div>
<div class="line"><a name="l00920"></a><span class="lineno"> 920</span>&#160; int16_t config(uint8_t modem);</div>
<div class="line"><a name="l00921"></a><span class="lineno"> 921</span>&#160;};</div>
<div class="line"><a name="l00920"></a><span class="lineno"> 920</span>&#160; <span class="comment">// cached BLE parameters</span></div>
<div class="line"><a name="l00921"></a><span class="lineno"> 921</span>&#160; uint8_t _connectionState = 0, _crcBLE = 0, _bleTestPayload = 0;</div>
<div class="line"><a name="l00922"></a><span class="lineno"> 922</span>&#160; </div>
<div class="line"><a name="l00923"></a><span class="lineno"> 923</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00924"></a><span class="lineno"> 924</span>&#160; </div>
<div class="line"><a name="l00925"></a><span class="lineno"> 925</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00923"></a><span class="lineno"> 923</span>&#160; int16_t config(uint8_t modem);</div>
<div class="line"><a name="l00924"></a><span class="lineno"> 924</span>&#160;};</div>
<div class="line"><a name="l00925"></a><span class="lineno"> 925</span>&#160; </div>
<div class="line"><a name="l00926"></a><span class="lineno"> 926</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00927"></a><span class="lineno"> 927</span>&#160; </div>
<div class="line"><a name="l00928"></a><span class="lineno"> 928</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level methods to control the wireless module. Every module class contains o...</div><div class="ttdef"><b>Definition:</b> Module.h:28</div></div>
<div class="ttc" id="aclass_module_html_a0c11551e12579bbabf57b19e12555b3c"><div class="ttname"><a href="class_module.html#a0c11551e12579bbabf57b19e12555b3c">Module::RFSWITCH_MAX_PINS</a></div><div class="ttdeci">static const size_t RFSWITCH_MAX_PINS</div><div class="ttdoc">The maximum number of pins supported by the RF switch code.</div><div class="ttdef"><b>Definition:</b> Module.h:39</div></div>
<div class="ttc" id="aclass_physical_layer_html"><div class="ttname"><a href="class_physical_layer.html">PhysicalLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:14</div></div>
@ -637,7 +640,7 @@ $(document).ready(function(){initNavTree('_s_x128x_8h_source.html',''); initResi
<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:832</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:1146</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:453</div></div>
<div class="ttc" id="aclass_s_x128x_html_a2dd0ecae9f54cf6943cf702ae15f5039"><div class="ttname"><a href="class_s_x128x.html#a2dd0ecae9f54cf6943cf702ae15f5039">SX128x::readBit</a></div><div class="ttdeci">void readBit(RADIOLIB_PIN_TYPE pin)</div><div class="ttdoc">Dummy method, to ensure PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1302</div></div>
<div class="ttc" id="aclass_s_x128x_html_a2dd0ecae9f54cf6943cf702ae15f5039"><div class="ttname"><a href="class_s_x128x.html#a2dd0ecae9f54cf6943cf702ae15f5039">SX128x::readBit</a></div><div class="ttdeci">void readBit(RADIOLIB_PIN_TYPE pin)</div><div class="ttdoc">Dummy method, to ensure PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1303</div></div>
<div class="ttc" id="aclass_s_x128x_html_a316340d7ba2a6e7cb5742e3ff21e728c"><div class="ttname"><a href="class_s_x128x.html#a316340d7ba2a6e7cb5742e3ff21e728c">SX128x::beginBLE</a></div><div class="ttdeci">int16_t beginBLE(float freq=2400.0, uint16_t br=800, float freqDev=400.0, int8_t power=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:142</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:204</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:1066</div></div>
@ -671,10 +674,10 @@ $(document).ready(function(){initNavTree('_s_x128x_8h_source.html',''); initResi
<div class="ttc" id="aclass_s_x128x_html_acbd0d1a48051ccd35f4a89c9b8d05bdf"><div class="ttname"><a href="class_s_x128x.html#acbd0d1a48051ccd35f4a89c9b8d05bdf">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 power=10, uint16_t preambleLength=12)</div><div class="ttdoc">Initialization method for LoRa modem.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:12</div></div>
<div class="ttc" id="aclass_s_x128x_html_ad6e2b46c317a8d8512cf0380025147a9"><div class="ttname"><a href="class_s_x128x.html#ad6e2b46c317a8d8512cf0380025147a9">SX128x::setOutputPower</a></div><div class="ttdeci">int16_t setOutputPower(int8_t power)</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:721</div></div>
<div class="ttc" id="aclass_s_x128x_html_ae14ea0c263fba51ec39d146c5877f0a3"><div class="ttname"><a href="class_s_x128x.html#ae14ea0c263fba51ec39d146c5877f0a3">SX128x::setRfSwitchTable</a></div><div class="ttdeci">void setRfSwitchTable(const RADIOLIB_PIN_TYPE(&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:1272</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:1402</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:1403</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:659</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:629</div></div>
<div class="ttc" id="aclass_s_x128x_html_aff1b549077b9d752f53bf9dfc6840236"><div class="ttname"><a href="class_s_x128x.html#aff1b549077b9d752f53bf9dfc6840236">SX128x::setDirectAction</a></div><div class="ttdeci">void setDirectAction(void(*func)(void))</div><div class="ttdoc">Dummy method, to ensure PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1296</div></div>
<div class="ttc" id="aclass_s_x128x_html_aff1b549077b9d752f53bf9dfc6840236"><div class="ttname"><a href="class_s_x128x.html#aff1b549077b9d752f53bf9dfc6840236">SX128x::setDirectAction</a></div><div class="ttdeci">void setDirectAction(void(*func)(void))</div><div class="ttdoc">Dummy method, to ensure PhysicalLayer compatibility.</div><div class="ttdef"><b>Definition:</b> SX128x.cpp:1297</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:384</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">Gaussin shaping filter, BT = 0.5.</div><div class="ttdef"><b>Definition:</b> TypeDef.h:27</div></div>
<div class="ttc" id="astruct_module_1_1_rf_switch_mode__t_html"><div class="ttname"><a href="struct_module_1_1_rf_switch_mode__t.html">Module::RfSwitchMode_t</a></div><div class="ttdef"><b>Definition:</b> Module.h:46</div></div>