kopia lustrzana https://github.com/jgromes/RadioLib
165 wiersze
15 KiB
HTML
165 wiersze
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">
|
|
<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/FSK4/FSK4.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('_f_s_k4_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">FSK4.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_FSK4_H)</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_FSK4_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="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#if !RADIOLIB_EXCLUDE_FSK4</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  </div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "../PhysicalLayer/PhysicalLayer.h"</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "../AFSK/AFSK.h"</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="class_f_s_k4_client.html"> 15</a></span> <span class="keyword">class </span><a class="code" href="class_f_s_k4_client.html">FSK4Client</a> {</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keyword">explicit</span> <a class="code" href="class_f_s_k4_client.html#a2cdcea538e5b58e99a23f98ef4a68617">FSK4Client</a>(<a class="code" href="class_physical_layer.html">PhysicalLayer</a>* phy);</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"> #if !RADIOLIB_EXCLUDE_AFSK</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">explicit</span> <a class="code" href="class_f_s_k4_client.html#a2cdcea538e5b58e99a23f98ef4a68617">FSK4Client</a>(<a class="code" href="class_a_f_s_k_client.html">AFSKClient</a>* audio);</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="comment">// basic methods</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  int16_t <a class="code" href="class_f_s_k4_client.html#a2b366b8f3c08f81431d8cc5f907652e9">begin</a>(<span class="keywordtype">float</span> base, uint32_t shift, uint16_t rate);</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">void</span> <a class="code" href="class_f_s_k4_client.html#a79ca465012acc9223d61d5b063ff8257">idle</a>();</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  int16_t <a class="code" href="class_f_s_k4_client.html#aab85cb6519e5448dc332bf17bd60f90a">setCorrection</a>(int16_t offsets[4], <span class="keywordtype">float</span> length = 1.0f);</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">size_t</span> <a class="code" href="class_f_s_k4_client.html#aa59fb42d3eeafe5ab3f0437ef5567ec2">write</a>(uint8_t* buff, <span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">size_t</span> <a class="code" href="class_f_s_k4_client.html#aa59fb42d3eeafe5ab3f0437ef5567ec2">write</a>(uint8_t b);</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  int16_t <a class="code" href="class_f_s_k4_client.html#a8b5765371ebbf68a21bc0bbfdf9f82ac">standby</a>();</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="class_physical_layer.html">PhysicalLayer</a>* phyLayer;</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor"> #if !RADIOLIB_EXCLUDE_AFSK</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="class_a_f_s_k_client.html">AFSKClient</a>* audioClient;</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  uint32_t baseFreq = 0, baseFreqHz = 0;</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  uint32_t shiftFreq = 0, shiftFreqHz = 0;</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a> bitDuration = 0;</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  uint32_t tones[4];</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  uint32_t tonesHz[4];</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">void</span> tone(uint8_t i);</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  int16_t transmitDirect(uint32_t freq = 0, uint32_t freqHz = 0);</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  int32_t getRawShift(int32_t shift);</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> };</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  </div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="aclass_a_f_s_k_client_html"><div class="ttname"><a href="class_a_f_s_k_client.html">AFSKClient</a></div><div class="ttdoc">Client for audio-based transmissions. Requires Arduino tone() function, and a module capable of direc...</div><div class="ttdef"><b>Definition:</b> AFSK.h:16</div></div>
|
|
<div class="ttc" id="aclass_f_s_k4_client_html"><div class="ttname"><a href="class_f_s_k4_client.html">FSK4Client</a></div><div class="ttdoc">Client for FSK-4 communication. The public interface is the same as Arduino Serial.</div><div class="ttdef"><b>Definition:</b> FSK4.h:15</div></div>
|
|
<div class="ttc" id="aclass_f_s_k4_client_html_a2b366b8f3c08f81431d8cc5f907652e9"><div class="ttname"><a href="class_f_s_k4_client.html#a2b366b8f3c08f81431d8cc5f907652e9">FSK4Client::begin</a></div><div class="ttdeci">int16_t begin(float base, uint32_t shift, uint16_t rate)</div><div class="ttdoc">Initialization method.</div><div class="ttdef"><b>Definition:</b> FSK4.cpp:19</div></div>
|
|
<div class="ttc" id="aclass_f_s_k4_client_html_a2cdcea538e5b58e99a23f98ef4a68617"><div class="ttname"><a href="class_f_s_k4_client.html#a2cdcea538e5b58e99a23f98ef4a68617">FSK4Client::FSK4Client</a></div><div class="ttdeci">FSK4Client(PhysicalLayer *phy)</div><div class="ttdoc">Constructor for FSK-4 mode.</div><div class="ttdef"><b>Definition:</b> FSK4.cpp:5</div></div>
|
|
<div class="ttc" id="aclass_f_s_k4_client_html_a79ca465012acc9223d61d5b063ff8257"><div class="ttname"><a href="class_f_s_k4_client.html#a79ca465012acc9223d61d5b063ff8257">FSK4Client::idle</a></div><div class="ttdeci">void idle()</div><div class="ttdoc">Send out idle condition (RF tone at mark frequency).</div><div class="ttdef"><b>Definition:</b> FSK4.cpp:43</div></div>
|
|
<div class="ttc" id="aclass_f_s_k4_client_html_a8b5765371ebbf68a21bc0bbfdf9f82ac"><div class="ttname"><a href="class_f_s_k4_client.html#a8b5765371ebbf68a21bc0bbfdf9f82ac">FSK4Client::standby</a></div><div class="ttdeci">int16_t standby()</div><div class="ttdoc">Stop transmitting.</div><div class="ttdef"><b>Definition:</b> FSK4.cpp:98</div></div>
|
|
<div class="ttc" id="aclass_f_s_k4_client_html_aa59fb42d3eeafe5ab3f0437ef5567ec2"><div class="ttname"><a href="class_f_s_k4_client.html#aa59fb42d3eeafe5ab3f0437ef5567ec2">FSK4Client::write</a></div><div class="ttdeci">size_t write(uint8_t *buff, size_t len)</div><div class="ttdoc">Transmit binary data.</div><div class="ttdef"><b>Definition:</b> FSK4.cpp:57</div></div>
|
|
<div class="ttc" id="aclass_f_s_k4_client_html_aab85cb6519e5448dc332bf17bd60f90a"><div class="ttname"><a href="class_f_s_k4_client.html#aab85cb6519e5448dc332bf17bd60f90a">FSK4Client::setCorrection</a></div><div class="ttdeci">int16_t setCorrection(int16_t offsets[4], float length=1.0f)</div><div class="ttdoc">Set correction coefficients for frequencies and tone length.</div><div class="ttdef"><b>Definition:</b> FSK4.cpp:48</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="agroup__typedefs_html_ga210f31dd2bff7fb80563275648a5bbbd"><div class="ttname"><a href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a></div><div class="ttdeci">unsigned long RadioLibTime_t</div><div class="ttdoc">Type used for durations in RadioLib.</div><div class="ttdef"><b>Definition:</b> TypeDef.h:579</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_daa71c65dcbe444af3aedb7a2ef08741.html">FSK4</a></li><li class="navelem"><b>FSK4.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>
|