forks/RadioLibSmol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
RadioLibSmol/_l_l_c_c68_8h_source.html
jgromes 5882ccec93 Deploying to gh-pages from @ 4deec953e8 🚀
2025-01-31 17:26:44 +00:00

170 lines
17 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>RadioLib: src/modules/LLCC68/LLCC68.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">RadioLib
</div>
<div id="projectbrief">Universal wireless communication library for Arduino</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('_l_l_c_c68_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">LLCC68.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#if !defined(_RADIOLIB_LLCC68_H)</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define _RADIOLIB_LLCC68_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &quot;../../TypeDef.h&quot;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#if !RADIOLIB_EXCLUDE_SX126X</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;../../Module.h&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;../SX126x/SX1262.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &quot;../SX126x/SX1261.h&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">//RADIOLIB_SX126X_REG_VERSION_STRING</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#define RADIOLIB_LLCC68_CHIP_TYPE &quot;LLCC68&quot;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="foldopen" id="foldopen00019" data-start="{" data-end="};">
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="class_l_l_c_c68.html"> 19</a></span><span class="keyword">class </span><a class="code hl_class" href="class_l_l_c_c68.html">LLCC68</a>: <span class="keyword">public</span> <a class="code hl_class" href="class_s_x1262.html">SX1262</a> {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <a class="code hl_class" href="class_l_l_c_c68.html">LLCC68</a>(<a class="code hl_class" href="class_module.html">Module</a>* mod); <span class="comment">// cppcheck-suppress noExplicitConstructor</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> int16_t <a class="code hl_function" href="class_l_l_c_c68.html#a76f46d146fc055b055346f87ff0b83d0">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 power = 10, uint16_t preambleLength = 8, <span class="keywordtype">float</span> tcxoVoltage = 0, <span class="keywordtype">bool</span> useRegulatorLDO = <span class="keyword">false</span>) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> int16_t <a class="code hl_function" href="class_l_l_c_c68.html#af89c37cdcc5cd4e44f1621391e1aaf91">beginFSK</a>(<span class="keywordtype">float</span> freq = 434.0, <span class="keywordtype">float</span> br = 4.8, <span class="keywordtype">float</span> freqDev = 5.0, <span class="keywordtype">float</span> rxBw = 156.2, int8_t power = 10, uint16_t preambleLength = 16, <span class="keywordtype">float</span> tcxoVoltage = 0, <span class="keywordtype">bool</span> useRegulatorLDO = <span class="keyword">false</span>) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> int16_t <a class="code hl_function" href="class_l_l_c_c68.html#a41b0de782f3407473050874a8ef7604a">beginLRFHSS</a>(<span class="keywordtype">float</span> freq = 434.0, uint8_t bw = RADIOLIB_SX126X_LR_FHSS_BW_722_66, uint8_t cr = RADIOLIB_SX126X_LR_FHSS_CR_2_3, <span class="keywordtype">bool</span> narrowGrid = <span class="keyword">true</span>, int8_t power = 10, <span class="keywordtype">float</span> tcxoVoltage = 0, <span class="keywordtype">bool</span> useRegulatorLDO = <span class="keyword">false</span>) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// configuration methods</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> int16_t <a class="code hl_function" href="class_l_l_c_c68.html#ae1badfd85c9f1c79bd6868c0528a5f17">setBandwidth</a>(<span class="keywordtype">float</span> bw) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> int16_t <a class="code hl_function" href="class_l_l_c_c68.html#aec65cb4a7a577c46573c9b0757dc52f4">setSpreadingFactor</a>(uint8_t sf) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> int16_t <a class="code hl_function" href="class_l_l_c_c68.html#ac630770441cadc547892173bde7504f9">setDataRate</a>(<a class="code hl_union" href="union_data_rate__t.html">DataRate_t</a> dr) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> int16_t <a class="code hl_function" href="class_l_l_c_c68.html#a708183645ec0b9fec54d6369e7b1345f">checkDataRate</a>(<a class="code hl_union" href="union_data_rate__t.html">DataRate_t</a> dr) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> int16_t <a class="code hl_function" href="class_l_l_c_c68.html#aee4457d48c708f05154e931eed05c691">setModem</a>(ModemType_t modem) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> </div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span><span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span>};</div>
</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span><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_a41b0de782f3407473050874a8ef7604a"><div class="ttname"><a href="class_l_l_c_c68.html#a41b0de782f3407473050874a8ef7604a">LLCC68::beginLRFHSS</a></div><div class="ttdeci">int16_t beginLRFHSS(float freq=434.0, uint8_t bw=RADIOLIB_SX126X_LR_FHSS_BW_722_66, uint8_t cr=RADIOLIB_SX126X_LR_FHSS_CR_2_3, bool narrowGrid=true, int8_t power=10, float tcxoVoltage=0, bool useRegulatorLDO=false) override</div><div class="ttdoc">Initialization method for LR-FHSS modem. This modem only supports transmission!</div><div class="ttdef"><b>Definition</b> LLCC68.cpp:65</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:142</div></div>
<div class="ttc" id="aclass_l_l_c_c68_html_a76f46d146fc055b055346f87ff0b83d0"><div class="ttname"><a href="class_l_l_c_c68.html#a76f46d146fc055b055346f87ff0b83d0">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 power=10, uint16_t preambleLength=8, float tcxoVoltage=0, bool useRegulatorLDO=false) override</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_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:113</div></div>
<div class="ttc" id="aclass_l_l_c_c68_html_ae1badfd85c9f1c79bd6868c0528a5f17"><div class="ttname"><a href="class_l_l_c_c68.html#ae1badfd85c9f1c79bd6868c0528a5f17">LLCC68::setBandwidth</a></div><div class="ttdeci">int16_t setBandwidth(float bw) override</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:90</div></div>
<div class="ttc" id="aclass_l_l_c_c68_html_aec65cb4a7a577c46573c9b0757dc52f4"><div class="ttname"><a href="class_l_l_c_c68.html#aec65cb4a7a577c46573c9b0757dc52f4">LLCC68::setSpreadingFactor</a></div><div class="ttdeci">int16_t setSpreadingFactor(uint8_t sf) override</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:95</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:176</div></div>
<div class="ttc" id="aclass_l_l_c_c68_html_af89c37cdcc5cd4e44f1621391e1aaf91"><div class="ttname"><a href="class_l_l_c_c68.html#af89c37cdcc5cd4e44f1621391e1aaf91">LLCC68::beginFSK</a></div><div class="ttdeci">int16_t beginFSK(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=156.2, int8_t power=10, uint16_t preambleLength=16, float tcxoVoltage=0, bool useRegulatorLDO=false) override</div><div class="ttdoc">Initialization method for FSK modem.</div><div class="ttdef"><b>Definition</b> LLCC68.cpp:40</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>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ddb4d7e95cc2d6c8e1ade10a20d7247d.html">modules</a></li><li class="navelem"><a class="el" href="dir_17a0c4358d096e2caf9f04fe2ab66c1d.html">LLCC68</a></li><li class="navelem"><b>LLCC68.h</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink