Skip to content

Commit 50d7cf5

Browse files
committed
Deploying to gh-pages from @ 10e7925 🚀
1 parent 0aa7d1c commit 50d7cf5

45 files changed

Lines changed: 311 additions & 306 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

_c_c1101_8h_source.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -892,16 +892,16 @@
892892
<div class="ttc" id="aclass_c_c1101_html_aef7c152858537a40e71cf133962cb893"><div class="ttname"><a href="class_c_c1101.html#aef7c152858537a40e71cf133962cb893">CC1101::transmitDirectAsync</a></div><div class="ttdeci">int16_t transmitDirectAsync(uint32_t frf=0)</div><div class="ttdoc">Starts asynchronous direct mode transmission.</div><div class="ttdef"><b>Definition</b> CC1101.cpp:154</div></div>
893893
<div class="ttc" id="aclass_c_c1101_html_af70ea860154cd6d2b2e2a6962e161c8f"><div class="ttname"><a href="class_c_c1101.html#af70ea860154cd6d2b2e2a6962e161c8f">CC1101::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> CC1101.cpp:354</div></div>
894894
<div class="ttc" id="aclass_c_c1101_html_afa64d1ad4789d3146b38d14437234756"><div class="ttname"><a href="class_c_c1101.html#afa64d1ad4789d3146b38d14437234756">CC1101::setOOK</a></div><div class="ttdeci">int16_t setOOK(bool enableOOK)</div><div class="ttdoc">Enables/disables OOK modulation instead of FSK.</div><div class="ttdef"><b>Definition</b> CC1101.cpp:810</div></div>
895-
<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:69</div></div>
896-
<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:78</div></div>
895+
<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:74</div></div>
896+
<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:83</div></div>
897897
<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:390</div></div>
898898
<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:225</div></div>
899899
<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>
900900
<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:156</div></div>
901901
<div class="ttc" id="aclass_physical_layer_html_ae608fabef91defa1e33e6a6787c68ce8"><div class="ttname"><a href="class_physical_layer.html#ae608fabef91defa1e33e6a6787c68ce8">PhysicalLayer::receive</a></div><div class="ttdeci">virtual int16_t receive(uint8_t *data, size_t len, RadioLibTime_t timeout=0)</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>
902902
<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:679</div></div>
903903
<div class="ttc" id="astruct_config_f_s_k__t_html"><div class="ttname"><a href="struct_config_f_s_k__t.html">ConfigFSK_t</a></div><div class="ttdef"><b>Definition</b> PhysicalLayer.h:298</div></div>
904-
<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:85</div></div>
904+
<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:90</div></div>
905905
</div><!-- fragment --></div><!-- contents -->
906906
</div><!-- doc-content -->
907907
<!-- start footer part -->

_external_radio_8h_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@
146146
<div class="ttc" id="aclass_external_radio_html_adfb1275ec53dbbd8fde2e8102e8f375d"><div class="ttname"><a href="class_external_radio.html#adfb1275ec53dbbd8fde2e8102e8f375d">ExternalRadio::getMod</a></div><div class="ttdeci">Module * getMod() override</div><div class="ttdoc">Method to retrieve pointer to the underlying Module instance.</div><div class="ttdef"><b>Definition</b> ExternalRadio.cpp:41</div></div>
147147
<div class="ttc" id="aclass_external_radio_html_ae619f011daea49a97098d2897e5a3c2c"><div class="ttname"><a href="class_external_radio.html#ae619f011daea49a97098d2897e5a3c2c">ExternalRadio::setEncoding</a></div><div class="ttdeci">int16_t setEncoding(uint8_t encoding) override</div><div class="ttdoc">Dummy implementation overriding PhysicalLayer.</div><div class="ttdef"><b>Definition</b> ExternalRadio.cpp:55</div></div>
148148
<div class="ttc" id="aclass_external_radio_html_aee6ca3af0849aed193e96cb0691e89e0"><div class="ttname"><a href="class_external_radio.html#aee6ca3af0849aed193e96cb0691e89e0">ExternalRadio::operator=</a></div><div class="ttdeci">ExternalRadio &amp; operator=(const ExternalRadio &amp;ext)</div><div class="ttdoc">Overload for assignment operator.</div><div class="ttdef"><b>Definition</b> ExternalRadio.cpp:27</div></div>
149-
<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:69</div></div>
149+
<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:74</div></div>
150150
<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:390</div></div>
151151
<div class="ttc" id="aclass_radio_lib_hal_html"><div class="ttname"><a href="class_radio_lib_hal.html">RadioLibHal</a></div><div class="ttdoc">Hardware abstraction library base interface.</div><div class="ttdef"><b>Definition</b> Hal.h:18</div></div>
152152
</div><!-- fragment --></div><!-- contents -->

_l_l_c_c68_8h_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@
165165
<div class="ttc" id="aclass_l_l_c_c68_html_aee4457d48c708f05154e931eed05c691"><div class="ttname"><a href="class_l_l_c_c68.html#aee4457d48c708f05154e931eed05c691">LLCC68::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> LLCC68.cpp:267</div></div>
166166
<div class="ttc" id="aclass_l_l_c_c68_html_afb9817ac3f8470dc2a5ac5a73b501392"><div class="ttname"><a href="class_l_l_c_c68.html#afb9817ac3f8470dc2a5ac5a73b501392">LLCC68::beginLRFHSS</a></div><div class="ttdeci">int16_t beginLRFHSS(const ConfigLRFHSS_t &amp;config) override</div><div class="ttdoc">Initialization method for LR-FHSS modem.</div><div class="ttdef"><b>Definition</b> LLCC68.cpp:125</div></div>
167167
<div class="ttc" id="aclass_l_l_c_c68_html_afe0a7de2cfd46ccd78a0e7771d956189"><div class="ttname"><a href="class_l_l_c_c68.html#afe0a7de2cfd46ccd78a0e7771d956189">LLCC68::begin</a></div><div class="ttdeci">int16_t begin(const ConfigLoRa_t &amp;config) override</div><div class="ttdoc">Initialization method for LoRa modem.</div><div class="ttdef"><b>Definition</b> LLCC68.cpp:8</div></div>
168-
<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:69</div></div>
168+
<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:74</div></div>
169169
<div class="ttc" id="aclass_s_x1262_html"><div class="ttname"><a href="class_s_x1262.html">SX1262</a></div><div class="ttdoc">Derived class for SX1262 modules.</div><div class="ttdef"><b>Definition</b> SX1262.h:22</div></div>
170170
<div class="ttc" id="agroup__module__config__vars_html_ga383002c662713c23a00b32deaeb524d1"><div class="ttname"><a href="group__module__config__vars.html#ga383002c662713c23a00b32deaeb524d1">SX126x::useRegulatorLDO</a></div><div class="ttdeci">bool useRegulatorLDO</div><div class="ttdoc">Whether to use only LDO regulator (true) or DC-DC regulator (false). Defaults to false.</div><div class="ttdef"><b>Definition</b> SX126x.h:82</div></div>
171171
<div class="ttc" id="agroup__module__config__vars_html_ga8f778ea6a60a20470dd9a4c7be25817c"><div class="ttname"><a href="group__module__config__vars.html#ga8f778ea6a60a20470dd9a4c7be25817c">SX126x::tcxoVoltage</a></div><div class="ttdeci">float tcxoVoltage</div><div class="ttdoc">TCXO reference voltage to be set on DIO3. Defaults to 1.6 V. If you are seeing -706/-707 error codes,...</div><div class="ttdef"><b>Definition</b> SX126x.h:76</div></div>

_l_r1110_8h_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@
162162
<div class="ttc" id="aclass_l_r1110_html_af1f6dddd12805fdecb55ef5703d23ef1"><div class="ttname"><a href="class_l_r1110.html#af1f6dddd12805fdecb55ef5703d23ef1">LR1110::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> LR1110.cpp:127</div></div>
163163
<div class="ttc" id="aclass_l_r1110_html_afa41982c4f5f85d87b5d5241c5b07d83"><div class="ttname"><a href="class_l_r1110.html#afa41982c4f5f85d87b5d5241c5b07d83">LR1110::begin</a></div><div class="ttdeci">int16_t begin(const ConfigLoRa_t &amp;config)</div><div class="ttdoc">Initialization method for LoRa modem.</div><div class="ttdef"><b>Definition</b> LR1110.cpp:10</div></div>
164164
<div class="ttc" id="aclass_l_r11x0_html"><div class="ttname"><a href="class_l_r11x0.html">LR11x0</a></div><div class="ttdoc">Base class for LR11x0 series. All derived classes for LR11x0 (e.g. LR1110 or LR1120) inherit from thi...</div><div class="ttdef"><b>Definition</b> LR11x0.h:30</div></div>
165-
<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:69</div></div>
165+
<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:74</div></div>
166166
<div class="ttc" id="agroup__module__config__vars_html_ga8eff22b47287190493da17e534ce6771"><div class="ttname"><a href="group__module__config__vars.html#ga8eff22b47287190493da17e534ce6771">LR11x0::tcxoVoltage</a></div><div class="ttdeci">float tcxoVoltage</div><div class="ttdoc">TCXO reference voltage to be set on DIO3. Defaults to 1.6 V. If you are seeing -706/-707 error codes,...</div><div class="ttdef"><b>Definition</b> LR11x0.h:75</div></div>
167167
<div class="ttc" id="astruct_config_f_s_k__t_html"><div class="ttname"><a href="struct_config_f_s_k__t.html">ConfigFSK_t</a></div><div class="ttdef"><b>Definition</b> PhysicalLayer.h:298</div></div>
168168
<div class="ttc" id="astruct_config_l_r_f_h_s_s__t_html"><div class="ttname"><a href="struct_config_l_r_f_h_s_s__t.html">ConfigLRFHSS_t</a></div><div class="ttdef"><b>Definition</b> PhysicalLayer.h:335</div></div>

_l_r1120_8h_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@
165165
<div class="ttc" id="aclass_l_r1120_html_ac3f850fb266e5c0162fd486e3438c42f"><div class="ttname"><a href="class_l_r1120.html#ac3f850fb266e5c0162fd486e3438c42f">LR1120::beginGFSK</a></div><div class="ttdeci">int16_t beginGFSK(const ConfigFSK_t &amp;config)</div><div class="ttdoc">Initialization method for GFSK modem.</div><div class="ttdef"><b>Definition</b> LR1120.cpp:36</div></div>
166166
<div class="ttc" id="aclass_l_r1120_html_acf6ea475643c6eba63133641a8681a8f"><div class="ttname"><a href="class_l_r1120.html#acf6ea475643c6eba63133641a8681a8f">LR1120::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> LR1120.cpp:145</div></div>
167167
<div class="ttc" id="aclass_l_r11x0_html"><div class="ttname"><a href="class_l_r11x0.html">LR11x0</a></div><div class="ttdoc">Base class for LR11x0 series. All derived classes for LR11x0 (e.g. LR1110 or LR1120) inherit from thi...</div><div class="ttdef"><b>Definition</b> LR11x0.h:30</div></div>
168-
<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:69</div></div>
168+
<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:74</div></div>
169169
<div class="ttc" id="agroup__module__config__vars_html_ga8eff22b47287190493da17e534ce6771"><div class="ttname"><a href="group__module__config__vars.html#ga8eff22b47287190493da17e534ce6771">LR11x0::tcxoVoltage</a></div><div class="ttdeci">float tcxoVoltage</div><div class="ttdoc">TCXO reference voltage to be set on DIO3. Defaults to 1.6 V. If you are seeing -706/-707 error codes,...</div><div class="ttdef"><b>Definition</b> LR11x0.h:75</div></div>
170170
<div class="ttc" id="astruct_config_f_s_k__t_html"><div class="ttname"><a href="struct_config_f_s_k__t.html">ConfigFSK_t</a></div><div class="ttdef"><b>Definition</b> PhysicalLayer.h:298</div></div>
171171
<div class="ttc" id="astruct_config_l_r_f_h_s_s__t_html"><div class="ttname"><a href="struct_config_l_r_f_h_s_s__t.html">ConfigLRFHSS_t</a></div><div class="ttdef"><b>Definition</b> PhysicalLayer.h:335</div></div>

_l_r1121_8h_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@
126126
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#endif</span></div>
127127
<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>
128128
<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>
129-
<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:69</div></div>
129+
<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:74</div></div>
130130
</div><!-- fragment --></div><!-- contents -->
131131
</div><!-- doc-content -->
132132
<!-- start footer part -->

0 commit comments

Comments
 (0)