162 lines
15 KiB
HTML
162 lines
15 KiB
HTML
<!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/protocols/ExternalRadio/ExternalRadio.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&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&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&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&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('_external_radio_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">ExternalRadio.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_EXTERNAL_RADIO_H)</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define _RADIOLIB_EXTERNAL_RADIO_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 "../../TypeDef.h"</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include "../../Module.h"</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include "../PhysicalLayer/PhysicalLayer.h"</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="class_external_radio.html"> 13</a></span><span class="keyword">class </span><a class="code hl_class" href="class_external_radio.html">ExternalRadio</a>: <span class="keyword">public</span> <a class="code hl_class" href="class_physical_layer.html">PhysicalLayer</a> {</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_class" href="class_external_radio.html">ExternalRadio</a>(uint32_t pin = RADIOLIB_NC); <span class="comment">// cppcheck-suppress noExplicitConstructor</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_class" href="class_external_radio.html">ExternalRadio</a>(<a class="code hl_class" href="class_radio_lib_hal.html">RadioLibHal</a> *hal, uint32_t pin = RADIOLIB_NC); <span class="comment">// cppcheck-suppress noExplicitConstructor</span></div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <a class="code hl_class" href="class_external_radio.html">ExternalRadio</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_external_radio.html">ExternalRadio</a>& ext);</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_class" href="class_external_radio.html">ExternalRadio</a>& <a class="code hl_function" href="class_external_radio.html#aee6ca3af0849aed193e96cb0691e89e0">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_external_radio.html">ExternalRadio</a>& ext);</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_function" href="class_external_radio.html#a46f76689b07d29a626faf917ad264ad0">~ExternalRadio</a>();</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <a class="code hl_class" href="class_module.html">Module</a>* <a class="code hl_function" href="class_external_radio.html#adfb1275ec53dbbd8fde2e8102e8f375d">getMod</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</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_external_radio.html#a02928a19eab0eab615c02180cedda3eb">setFrequencyDeviation</a>(<span class="keywordtype">float</span> freqDev) <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="l00065" name="l00065"></a><span class="lineno"> 65</span> int16_t <a class="code hl_function" href="class_external_radio.html#abe0bfb0f178783eff28bdc867e9324fd">setDataShaping</a>(uint8_t sh) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> int16_t <a class="code hl_function" href="class_external_radio.html#ae619f011daea49a97098d2897e5a3c2c">setEncoding</a>(uint8_t encoding) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> int16_t <a class="code hl_function" href="class_external_radio.html#a25be77aea48cfbdcae05ed32b660daef">transmitDirect</a>(uint32_t frf = 0) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <a class="code hl_class" href="class_module.html">Module</a>* mod;</div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> uint32_t prevFrf;</div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="aclass_external_radio_html"><div class="ttname"><a href="class_external_radio.html">ExternalRadio</a></div><div class="ttdoc">Class to interface with external radio hardware.</div><div class="ttdef"><b>Definition</b> ExternalRadio.h:13</div></div>
|
|
<div class="ttc" id="aclass_external_radio_html_a02928a19eab0eab615c02180cedda3eb"><div class="ttname"><a href="class_external_radio.html#a02928a19eab0eab615c02180cedda3eb">ExternalRadio::setFrequencyDeviation</a></div><div class="ttdeci">int16_t setFrequencyDeviation(float freqDev) override</div><div class="ttdoc">Dummy implementation overriding PhysicalLayer.</div><div class="ttdef"><b>Definition</b> ExternalRadio.cpp:45</div></div>
|
|
<div class="ttc" id="aclass_external_radio_html_a25be77aea48cfbdcae05ed32b660daef"><div class="ttname"><a href="class_external_radio.html#a25be77aea48cfbdcae05ed32b660daef">ExternalRadio::transmitDirect</a></div><div class="ttdeci">int16_t transmitDirect(uint32_t frf=0) override</div><div class="ttdoc">Direct transmission to drive external radio.</div><div class="ttdef"><b>Definition</b> ExternalRadio.cpp:60</div></div>
|
|
<div class="ttc" id="aclass_external_radio_html_a46f76689b07d29a626faf917ad264ad0"><div class="ttname"><a href="class_external_radio.html#a46f76689b07d29a626faf917ad264ad0">ExternalRadio::~ExternalRadio</a></div><div class="ttdeci">~ExternalRadio()</div><div class="ttdoc">Default destructor.</div><div class="ttdef"><b>Definition</b> ExternalRadio.cpp:37</div></div>
|
|
<div class="ttc" id="aclass_external_radio_html_abe0bfb0f178783eff28bdc867e9324fd"><div class="ttname"><a href="class_external_radio.html#abe0bfb0f178783eff28bdc867e9324fd">ExternalRadio::setDataShaping</a></div><div class="ttdeci">int16_t setDataShaping(uint8_t sh) override</div><div class="ttdoc">Dummy implementation overriding PhysicalLayer.</div><div class="ttdef"><b>Definition</b> ExternalRadio.cpp:50</div></div>
|
|
<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>
|
|
<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>
|
|
<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 & operator=(const ExternalRadio &ext)</div><div class="ttdoc">Overload for assignment operator.</div><div class="ttdef"><b>Definition</b> ExternalRadio.cpp:27</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_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:216</div></div>
|
|
<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:16</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_79690749eba542503bb1a9a3dbb495e1.html">protocols</a></li><li class="navelem"><a class="el" href="dir_19ff327ef62766d556984fbbdb5e6cc3.html">ExternalRadio</a></li><li class="navelem"><b>ExternalRadio.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>
|