kopia lustrzana https://github.com/jgromes/RadioLib
145 wiersze
13 KiB
HTML
145 wiersze
13 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">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<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.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</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 name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#if !defined(_RADIOLIB_EXTERNAL_RADIO_H)</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_EXTERNAL_RADIO_H</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "../../TypeDef.h"</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include "../../Module.h"</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "../../ArduinoHal.h"</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "../PhysicalLayer/PhysicalLayer.h"</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="class_external_radio.html"> 16</a></span> <span class="keyword">class </span><a class="code" href="class_external_radio.html">ExternalRadio</a>: <span class="keyword">public</span> <a class="code" href="class_physical_layer.html">PhysicalLayer</a> {</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <a class="code" href="class_external_radio.html#a49f10e1b05e7463583ac05b3284b9dda">ExternalRadio</a>(uint32_t pin = RADIOLIB_NC);</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="class_external_radio.html#a49f10e1b05e7463583ac05b3284b9dda">ExternalRadio</a>(<a class="code" href="class_radio_lib_hal.html">RadioLibHal</a> *hal, uint32_t pin = RADIOLIB_NC);</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="class_module.html">Module</a>* <a class="code" href="class_external_radio.html#ae6f8473e407cfcba0e1f07c225b5cb50">getMod</a>();</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  int16_t <a class="code" href="class_external_radio.html#a02928a19eab0eab615c02180cedda3eb">setFrequencyDeviation</a>(<span class="keywordtype">float</span> freqDev) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  int16_t <a class="code" href="class_external_radio.html#abe0bfb0f178783eff28bdc867e9324fd">setDataShaping</a>(uint8_t sh) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  int16_t <a class="code" href="class_external_radio.html#ae619f011daea49a97098d2897e5a3c2c">setEncoding</a>(uint8_t encoding) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  int16_t <a class="code" href="class_external_radio.html#ae8c160da3b82f706b2526af2bac85d69">transmitDirect</a>(uint32_t frf = 0);</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="class_module.html">Module</a>* mod;</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  uint32_t prevFrf;</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> };</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</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:16</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:21</div></div>
|
|
<div class="ttc" id="aclass_external_radio_html_a49f10e1b05e7463583ac05b3284b9dda"><div class="ttname"><a href="class_external_radio.html#a49f10e1b05e7463583ac05b3284b9dda">ExternalRadio::ExternalRadio</a></div><div class="ttdeci">ExternalRadio(RadioLibHal *hal, uint32_t pin=RADIOLIB_NC)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> ExternalRadio.cpp:11</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:26</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:31</div></div>
|
|
<div class="ttc" id="aclass_external_radio_html_ae6f8473e407cfcba0e1f07c225b5cb50"><div class="ttname"><a href="class_external_radio.html#ae6f8473e407cfcba0e1f07c225b5cb50">ExternalRadio::getMod</a></div><div class="ttdeci">Module * getMod()</div><div class="ttdoc">Method to retrieve pointer to the underlying Module instance.</div><div class="ttdef"><b>Definition:</b> ExternalRadio.cpp:17</div></div>
|
|
<div class="ttc" id="aclass_external_radio_html_ae8c160da3b82f706b2526af2bac85d69"><div class="ttname"><a href="class_external_radio.html#ae8c160da3b82f706b2526af2bac85d69">ExternalRadio::transmitDirect</a></div><div class="ttdeci">int16_t transmitDirect(uint32_t frf=0)</div><div class="ttdoc">Direct transmission to drive external radio.</div><div class="ttdef"><b>Definition:</b> ExternalRadio.cpp:36</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:30</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:54</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:13</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.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|