137 lines
20 KiB
HTML
137 lines
20 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.11"/>
|
|
<title>RadioLib: src/protocols/PhysicalLayer/PhysicalLayer.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>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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.8.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</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">
|
|
$(document).ready(function(){initNavTree('_physical_layer_8h_source.html','');});
|
|
</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">PhysicalLayer.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">#ifndef _RADIOLIB_PHYSICAL_LAYER_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_PHYSICAL_LAYER_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> </div><div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="class_physical_layer.html"> 13</a></span> <span class="keyword">class </span><a class="code" href="class_physical_layer.html">PhysicalLayer</a> {</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="comment">// constructor</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <a class="code" href="class_physical_layer.html#a5e02457f1d519cf81b1590a182321c62">PhysicalLayer</a>(<span class="keywordtype">float</span> freqStep, <span class="keywordtype">size_t</span> maxPacketLength);</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="comment">// basic methods</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  int16_t <a class="code" href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">transmit</a>(__FlashStringHelper* fstr, uint8_t addr = 0);</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  int16_t <a class="code" href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">transmit</a>(String& str, uint8_t addr = 0);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  int16_t <a class="code" href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">transmit</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* str, uint8_t addr = 0);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">transmit</a>(uint8_t* data, <span class="keywordtype">size_t</span> len, uint8_t addr = 0) = 0;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  int16_t <a class="code" href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">receive</a>(String& str, <span class="keywordtype">size_t</span> len = 0);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a0e77da761a2cbb5c9535df0bdea993f9">standby</a>() = 0;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">receive</a>(uint8_t* data, <span class="keywordtype">size_t</span> len) = 0;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  int16_t <a class="code" href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">startTransmit</a>(String& str, uint8_t addr = 0);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  int16_t <a class="code" href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">startTransmit</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* str, uint8_t addr = 0);</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">startTransmit</a>(uint8_t* data, <span class="keywordtype">size_t</span> len, uint8_t addr = 0) = 0;</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  int16_t <a class="code" href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">readData</a>(String& str, <span class="keywordtype">size_t</span> len = 0);</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">readData</a>(uint8_t* data, <span class="keywordtype">size_t</span> len) = 0;</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a4b04eb6155b06d8ef400131c647d54e7">transmitDirect</a>(uint32_t frf = 0) = 0;</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a46b22145b33e97cf6065ed826799b6b4">receiveDirect</a>() = 0;</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="comment">// configuration methods</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#ab9060e8ab7a2da192b3bf53b3501553b">setFrequencyDeviation</a>(<span class="keywordtype">float</span> freqDev) = 0;</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> </div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#ab643a814dce48f71a13bf6ea23f44cbd">setDataShaping</a>(uint8_t sh) = 0;</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> </div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keyword">virtual</span> int16_t <a class="code" href="class_physical_layer.html#a7d3419227d201d6912b77784636d437d">setEncoding</a>(uint8_t encoding) = 0;</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> </div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  <span class="keywordtype">float</span> <a class="code" href="class_physical_layer.html#ac48339cc9fc93931379903ab0c195e40">getFreqStep</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> </div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="class_physical_layer.html#a0bd6046e068ef63e3f2b6bead48e02a7">getPacketLength</a>(<span class="keywordtype">bool</span> update = <span class="keyword">true</span>) = 0;</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> </div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="preprocessor">#ifndef RADIOLIB_GODMODE</span></div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  <span class="keywordtype">float</span> _freqStep;</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <span class="keywordtype">size_t</span> _maxPacketLength;</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> };</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> </div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_physical_layer_html_a7d3419227d201d6912b77784636d437d"><div class="ttname"><a href="class_physical_layer.html#a7d3419227d201d6912b77784636d437d">PhysicalLayer::setEncoding</a></div><div class="ttdeci">virtual int16_t setEncoding(uint8_t encoding)=0</div><div class="ttdoc">Sets FSK data encoding. Only available in FSK mode. Must be implemented in module class...</div></div>
|
|
<div class="ttc" id="class_physical_layer_html_ac48339cc9fc93931379903ab0c195e40"><div class="ttname"><a href="class_physical_layer.html#ac48339cc9fc93931379903ab0c195e40">PhysicalLayer::getFreqStep</a></div><div class="ttdeci">float getFreqStep() const </div><div class="ttdoc">Gets the module frequency step size that was set in constructor. </div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:143</div></div>
|
|
<div class="ttc" id="class_physical_layer_html_af068e6e862c99e39d0261a7971dd56db"><div class="ttname"><a href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(String &str, uint8_t addr=0)</div><div class="ttdoc">Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. </div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:49</div></div>
|
|
<div class="ttc" id="class_physical_layer_html_a0bd6046e068ef63e3f2b6bead48e02a7"><div class="ttname"><a href="class_physical_layer.html#a0bd6046e068ef63e3f2b6bead48e02a7">PhysicalLayer::getPacketLength</a></div><div class="ttdeci">virtual size_t getPacketLength(bool update=true)=0</div><div class="ttdoc">Query modem for the packet length of received payload. </div></div>
|
|
<div class="ttc" id="class_physical_layer_html_a4b04eb6155b06d8ef400131c647d54e7"><div class="ttname"><a href="class_physical_layer.html#a4b04eb6155b06d8ef400131c647d54e7">PhysicalLayer::transmitDirect</a></div><div class="ttdeci">virtual int16_t transmitDirect(uint32_t frf=0)=0</div><div class="ttdoc">Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module ...</div></div>
|
|
<div class="ttc" id="class_physical_layer_html_a46b22145b33e97cf6065ed826799b6b4"><div class="ttname"><a href="class_physical_layer.html#a46b22145b33e97cf6065ed826799b6b4">PhysicalLayer::receiveDirect</a></div><div class="ttdeci">virtual int16_t receiveDirect()=0</div><div class="ttdoc">Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module cla...</div></div>
|
|
<div class="ttc" id="class_physical_layer_html_a5e02457f1d519cf81b1590a182321c62"><div class="ttname"><a href="class_physical_layer.html#a5e02457f1d519cf81b1590a182321c62">PhysicalLayer::PhysicalLayer</a></div><div class="ttdeci">PhysicalLayer(float freqStep, size_t maxPacketLength)</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:3</div></div>
|
|
<div class="ttc" id="class_physical_layer_html_ab643a814dce48f71a13bf6ea23f44cbd"><div class="ttname"><a href="class_physical_layer.html#ab643a814dce48f71a13bf6ea23f44cbd">PhysicalLayer::setDataShaping</a></div><div class="ttdeci">virtual int16_t setDataShaping(uint8_t sh)=0</div><div class="ttdoc">Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class...</div></div>
|
|
<div class="ttc" id="class_physical_layer_html_a0e77da761a2cbb5c9535df0bdea993f9"><div class="ttname"><a href="class_physical_layer.html#a0e77da761a2cbb5c9535df0bdea993f9">PhysicalLayer::standby</a></div><div class="ttdeci">virtual int16_t standby()=0</div><div class="ttdoc">Sets module to standby. </div></div>
|
|
<div class="ttc" id="class_physical_layer_html_ab139a34e03a6fd5a781cd54da21d308f"><div class="ttname"><a href="class_physical_layer.html#ab139a34e03a6fd5a781cd54da21d308f">PhysicalLayer::transmit</a></div><div class="ttdeci">int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)</div><div class="ttdoc">Arduino Flash String transmit method. </div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:8</div></div>
|
|
<div class="ttc" id="class_physical_layer_html_afb1b090348d9091bfa3a0b5ba3d85b36"><div class="ttname"><a href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">PhysicalLayer::receive</a></div><div class="ttdeci">int16_t receive(String &str, size_t len=0)</div><div class="ttdoc">Arduino String receive method. </div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:98</div></div>
|
|
<div class="ttc" id="class_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:13</div></div>
|
|
<div class="ttc" id="class_physical_layer_html_ab9060e8ab7a2da192b3bf53b3501553b"><div class="ttname"><a href="class_physical_layer.html#ab9060e8ab7a2da192b3bf53b3501553b">PhysicalLayer::setFrequencyDeviation</a></div><div class="ttdeci">virtual int16_t setFrequencyDeviation(float freqDev)=0</div><div class="ttdoc">Sets FSK frequency deviation from carrier frequency. Allowed values depend on bit rate setting and mu...</div></div>
|
|
<div class="ttc" id="class_physical_layer_html_ae8eed0e888a7c8742e89d2b850977de2"><div class="ttname"><a href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">PhysicalLayer::readData</a></div><div class="ttdeci">int16_t readData(String &str, size_t len=0)</div><div class="ttdoc">Reads data that was received after calling startReceive method. </div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:57</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_2cdd3c47e80335731aa10f67042c391a.html">PhysicalLayer</a></li><li class="navelem"><b>PhysicalLayer.h</b></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|