Deploying to gh-pages from @ 855a64c053 🚀

This commit is contained in:
jgromes 2024-11-26 18:47:22 +00:00
parent e36ffc59f0
commit 8e666d3210

View file

@ -95,45 +95,46 @@ $(document).ready(function(){initNavTree('_l_l_c_c68_8h_source.html',''); initRe
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;../../Module.h&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &quot;../SX126x/SX1262.h&quot;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">//RADIOLIB_SX126X_REG_VERSION_STRING</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#define RADIOLIB_LLCC68_CHIP_TYPE &quot;LLCC68&quot;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="class_l_l_c_c68.html"> 18</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_l_l_c_c68.html">LLCC68</a>: <span class="keyword">public</span> <a class="code" href="class_s_x1262.html">SX1262</a> {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <a class="code" href="class_l_l_c_c68.html#abf66e5649ac09e5997e29cf637803261">LLCC68</a>(<a class="code" href="class_module.html">Module</a>* mod); <span class="comment">// cppcheck-suppress noExplicitConstructor</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; int16_t <a class="code" href="class_l_l_c_c68.html#aa835ee301567f7dac079b42a2055c38c">begin</a>(<span class="keywordtype">float</span> freq = 434.0, <span class="keywordtype">float</span> bw = 125.0, uint8_t sf = 9, uint8_t cr = 7, uint8_t syncWord = RADIOLIB_SX126X_SYNC_WORD_PRIVATE, int8_t pwr = 10, uint16_t preambleLength = 8, <span class="keywordtype">float</span> tcxoVoltage = 0, <span class="keywordtype">bool</span> useRegulatorLDO = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="comment">// configuration methods</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; int16_t <a class="code" href="class_l_l_c_c68.html#a6f6c206657304809ee30bd9761ef79bf">setBandwidth</a>(<span class="keywordtype">float</span> bw);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; int16_t <a class="code" href="class_l_l_c_c68.html#ad59d1a1cb32c7c89c13ebf46051d26e4">setSpreadingFactor</a>(uint8_t sf);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; int16_t <a class="code" href="class_l_l_c_c68.html#ac630770441cadc547892173bde7504f9">setDataRate</a>(<a class="code" href="union_data_rate__t.html">DataRate_t</a> dr) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; int16_t <a class="code" href="class_l_l_c_c68.html#a708183645ec0b9fec54d6369e7b1345f">checkDataRate</a>(<a class="code" href="union_data_rate__t.html">DataRate_t</a> dr) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; int16_t <a class="code" href="class_l_l_c_c68.html#aee4457d48c708f05154e931eed05c691">setModem</a>(ModemType_t modem) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;};</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_l_l_c_c68_html"><div class="ttname"><a href="class_l_l_c_c68.html">LLCC68</a></div><div class="ttdoc">Derived class for LLCC68 modules.</div><div class="ttdef"><b>Definition:</b> LLCC68.h:18</div></div>
<div class="ttc" id="aclass_l_l_c_c68_html_a6f6c206657304809ee30bd9761ef79bf"><div class="ttname"><a href="class_l_l_c_c68.html#a6f6c206657304809ee30bd9761ef79bf">LLCC68::setBandwidth</a></div><div class="ttdeci">int16_t setBandwidth(float bw)</div><div class="ttdoc">Sets LoRa bandwidth. Allowed values are 125.0, 250.0 and 500.0 kHz.</div><div class="ttdef"><b>Definition:</b> LLCC68.cpp:33</div></div>
<div class="ttc" id="aclass_l_l_c_c68_html_a708183645ec0b9fec54d6369e7b1345f"><div class="ttname"><a href="class_l_l_c_c68.html#a708183645ec0b9fec54d6369e7b1345f">LLCC68::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> LLCC68.cpp:85</div></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &quot;../SX126x/SX1261.h&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">//RADIOLIB_SX126X_REG_VERSION_STRING</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#define RADIOLIB_LLCC68_CHIP_TYPE &quot;LLCC68&quot;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="class_l_l_c_c68.html"> 19</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_l_l_c_c68.html">LLCC68</a>: <span class="keyword">public</span> <a class="code" href="class_s_x1262.html">SX1262</a> {</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <a class="code" href="class_l_l_c_c68.html#abf66e5649ac09e5997e29cf637803261">LLCC68</a>(<a class="code" href="class_module.html">Module</a>* mod); <span class="comment">// cppcheck-suppress noExplicitConstructor</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; int16_t <a class="code" href="class_l_l_c_c68.html#aa835ee301567f7dac079b42a2055c38c">begin</a>(<span class="keywordtype">float</span> freq = 434.0, <span class="keywordtype">float</span> bw = 125.0, uint8_t sf = 9, uint8_t cr = 7, uint8_t syncWord = RADIOLIB_SX126X_SYNC_WORD_PRIVATE, int8_t pwr = 10, uint16_t preambleLength = 8, <span class="keywordtype">float</span> tcxoVoltage = 0, <span class="keywordtype">bool</span> useRegulatorLDO = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="comment">// configuration methods</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; int16_t <a class="code" href="class_l_l_c_c68.html#a6f6c206657304809ee30bd9761ef79bf">setBandwidth</a>(<span class="keywordtype">float</span> bw);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; int16_t <a class="code" href="class_l_l_c_c68.html#ad59d1a1cb32c7c89c13ebf46051d26e4">setSpreadingFactor</a>(uint8_t sf);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; int16_t <a class="code" href="class_l_l_c_c68.html#ac630770441cadc547892173bde7504f9">setDataRate</a>(<a class="code" href="union_data_rate__t.html">DataRate_t</a> dr) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; int16_t <a class="code" href="class_l_l_c_c68.html#a708183645ec0b9fec54d6369e7b1345f">checkDataRate</a>(<a class="code" href="union_data_rate__t.html">DataRate_t</a> dr) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; int16_t <a class="code" href="class_l_l_c_c68.html#aee4457d48c708f05154e931eed05c691">setModem</a>(ModemType_t modem) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;};</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_l_l_c_c68_html"><div class="ttname"><a href="class_l_l_c_c68.html">LLCC68</a></div><div class="ttdoc">Derived class for LLCC68 modules.</div><div class="ttdef"><b>Definition:</b> LLCC68.h:19</div></div>
<div class="ttc" id="aclass_l_l_c_c68_html_a6f6c206657304809ee30bd9761ef79bf"><div class="ttname"><a href="class_l_l_c_c68.html#a6f6c206657304809ee30bd9761ef79bf">LLCC68::setBandwidth</a></div><div class="ttdeci">int16_t setBandwidth(float bw)</div><div class="ttdoc">Sets LoRa bandwidth. Allowed values are 125.0, 250.0 and 500.0 kHz.</div><div class="ttdef"><b>Definition:</b> LLCC68.cpp:40</div></div>
<div class="ttc" id="aclass_l_l_c_c68_html_a708183645ec0b9fec54d6369e7b1345f"><div class="ttname"><a href="class_l_l_c_c68.html#a708183645ec0b9fec54d6369e7b1345f">LLCC68::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> LLCC68.cpp:92</div></div>
<div class="ttc" id="aclass_l_l_c_c68_html_aa835ee301567f7dac079b42a2055c38c"><div class="ttname"><a href="class_l_l_c_c68.html#aa835ee301567f7dac079b42a2055c38c">LLCC68::begin</a></div><div class="ttdeci">int16_t begin(float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX126X_SYNC_WORD_PRIVATE, int8_t pwr=10, uint16_t preambleLength=8, float tcxoVoltage=0, bool useRegulatorLDO=false)</div><div class="ttdoc">Initialization method for LoRa modem.</div><div class="ttdef"><b>Definition:</b> LLCC68.cpp:9</div></div>
<div class="ttc" id="aclass_l_l_c_c68_html_abf66e5649ac09e5997e29cf637803261"><div class="ttname"><a href="class_l_l_c_c68.html#abf66e5649ac09e5997e29cf637803261">LLCC68::LLCC68</a></div><div class="ttdeci">LLCC68(Module *mod)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> LLCC68.cpp:4</div></div>
<div class="ttc" id="aclass_l_l_c_c68_html_ac630770441cadc547892173bde7504f9"><div class="ttname"><a href="class_l_l_c_c68.html#ac630770441cadc547892173bde7504f9">LLCC68::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> LLCC68.cpp:56</div></div>
<div class="ttc" id="aclass_l_l_c_c68_html_ad59d1a1cb32c7c89c13ebf46051d26e4"><div class="ttname"><a href="class_l_l_c_c68.html#ad59d1a1cb32c7c89c13ebf46051d26e4">LLCC68::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 11, depending on currently set spreading f...</div><div class="ttdef"><b>Definition:</b> LLCC68.cpp:38</div></div>
<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:119</div></div>
<div class="ttc" id="aclass_l_l_c_c68_html_ac630770441cadc547892173bde7504f9"><div class="ttname"><a href="class_l_l_c_c68.html#ac630770441cadc547892173bde7504f9">LLCC68::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> LLCC68.cpp:63</div></div>
<div class="ttc" id="aclass_l_l_c_c68_html_ad59d1a1cb32c7c89c13ebf46051d26e4"><div class="ttname"><a href="class_l_l_c_c68.html#ad59d1a1cb32c7c89c13ebf46051d26e4">LLCC68::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 11, depending on currently set spreading f...</div><div class="ttdef"><b>Definition:</b> LLCC68.cpp:45</div></div>
<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:126</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:73</div></div>
<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>
<div class="ttc" id="aunion_data_rate__t_html"><div class="ttname"><a href="union_data_rate__t.html">DataRate_t</a></div><div class="ttdoc">Common data rate structure.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:74</div></div>