<!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.8.17"/>
<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.8.17 -->
<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');
/* @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 !defined(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="l00016"></a><span class="lineno"><a class="line" href="class_f_s_k4_client.html"> 16</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="l00017"></a><span class="lineno"> 17</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</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="l00024"></a><span class="lineno"> 24</span>  </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"> #if !defined(RADIOLIB_EXCLUDE_AFSK)</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</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="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"> #endif</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="comment">// basic methods</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</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="l00049"></a><span class="lineno"> 49</span>  </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</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="l00054"></a><span class="lineno"> 54</span>  </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">size_t</span> write(uint8_t* buff, <span class="keywordtype">size_t</span> len);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">size_t</span> write(uint8_t b);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="class_physical_layer.html">PhysicalLayer</a>* _phy;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor"> #if !defined(RADIOLIB_EXCLUDE_AFSK)</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="class_a_f_s_k_client.html">AFSKClient</a>* _audio;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor"> #endif</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  uint32_t _base = 0, _baseHz = 0;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  uint32_t _shift = 0, _shiftHz = 0;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  uint32_t _bitDuration = 0;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  uint32_t _tones[4];</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  uint32_t _tonesHz[4];</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="keywordtype">void</span> tone(uint8_t i);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  int16_t transmitDirect(uint32_t freq = 0, uint32_t freqHz = 0);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  int16_t standby();</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> };</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</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>  </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<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:18</div></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:17</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:59</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:14</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:16</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:4</div></div>
<!-- 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="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>