<!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/RTTY/RTTY.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('_r_t_t_y_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">RTTY.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_RTTY_H)</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_RTTY_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_RTTY</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> <span class="preprocessor">#include "../Print/Print.h"</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "../Print/ITA2String.h"</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="class_r_t_t_y_client.html"> 17</a></span> <span class="keyword">class </span><a class="code" href="class_r_t_t_y_client.html">RTTYClient</a>: <span class="keyword">public</span> <a class="code" href="class_radio_lib_print.html">RadioLibPrint</a> {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</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_r_t_t_y_client.html#ae6bc08fa88457ee00a992448be1d63ea">RTTYClient</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 !RADIOLIB_EXCLUDE_AFSK</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">explicit</span> <a class="code" href="class_r_t_t_y_client.html#ae6bc08fa88457ee00a992448be1d63ea">RTTYClient</a>(<a class="code" href="class_a_f_s_k_client.html">AFSKClient</a>* audio);</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor"> #endif</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// basic methods</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  int16_t <a class="code" href="class_r_t_t_y_client.html#ae0b25083baf01469786b6242389298fa">begin</a>(<span class="keywordtype">float</span> base, uint32_t shift, uint16_t rate, uint8_t enc = RADIOLIB_ASCII, uint8_t stopBits = 1);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">void</span> <a class="code" href="class_r_t_t_y_client.html#ac477e65ea756e56bb9043d778a51b4bc">idle</a>();</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  int16_t <a class="code" href="class_r_t_t_y_client.html#a928dd206749d68b8ce450e14c24b9f22">standby</a>();</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</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_r_t_t_y_client.html#a077a21423deee0393cead0b3a239691f">write</a>(uint8_t b);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <a class="code" href="class_physical_layer.html">PhysicalLayer</a>* phyLayer;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor"> #if !RADIOLIB_EXCLUDE_AFSK</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="class_a_f_s_k_client.html">AFSKClient</a>* audioClient;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor"> #endif</span></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>  uint32_t baseFreq = 0, baseFreqHz = 0;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  uint32_t shiftFreq = 0, shiftFreqHz = 0;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  uint32_t bitDuration = 0;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  uint8_t stopBitsNum = 0;</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="keywordtype">void</span> mark();</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">void</span> space();</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  int16_t transmitDirect(uint32_t freq = 0, uint32_t freqHz = 0);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> };</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </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> <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_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_r_t_t_y_client_html"><div class="ttname"><a href="class_r_t_t_y_client.html">RTTYClient</a></div><div class="ttdoc">Client for RTTY communication. The public interface is the same as Arduino Serial.</div><div class="ttdef"><b>Definition:</b> RTTY.h:17</div></div>
<div class="ttc" id="aclass_r_t_t_y_client_html_a077a21423deee0393cead0b3a239691f"><div class="ttname"><a href="class_r_t_t_y_client.html#a077a21423deee0393cead0b3a239691f">RTTYClient::write</a></div><div class="ttdeci">size_t write(uint8_t b)</div><div class="ttdoc">Write one byte. Implementation of interface of the RadioLibPrint/Print class.</div><div class="ttdef"><b>Definition:</b> RTTY.cpp:59</div></div>
<div class="ttc" id="aclass_r_t_t_y_client_html_a928dd206749d68b8ce450e14c24b9f22"><div class="ttname"><a href="class_r_t_t_y_client.html#a928dd206749d68b8ce450e14c24b9f22">RTTYClient::standby</a></div><div class="ttdeci">int16_t standby()</div><div class="ttdoc">Stops transmitting.</div><div class="ttdef"><b>Definition:</b> RTTY.cpp:115</div></div>
<div class="ttc" id="aclass_r_t_t_y_client_html_ac477e65ea756e56bb9043d778a51b4bc"><div class="ttname"><a href="class_r_t_t_y_client.html#ac477e65ea756e56bb9043d778a51b4bc">RTTYClient::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> RTTY.cpp:55</div></div>
<div class="ttc" id="aclass_r_t_t_y_client_html_ae0b25083baf01469786b6242389298fa"><div class="ttname"><a href="class_r_t_t_y_client.html#ae0b25083baf01469786b6242389298fa">RTTYClient::begin</a></div><div class="ttdeci">int16_t begin(float base, uint32_t shift, uint16_t rate, uint8_t enc=RADIOLIB_ASCII, uint8_t stopBits=1)</div><div class="ttdoc">Initialization method.</div><div class="ttdef"><b>Definition:</b> RTTY.cpp:23</div></div>
<div class="ttc" id="aclass_r_t_t_y_client_html_ae6bc08fa88457ee00a992448be1d63ea"><div class="ttname"><a href="class_r_t_t_y_client.html#ae6bc08fa88457ee00a992448be1d63ea">RTTYClient::RTTYClient</a></div><div class="ttdeci">RTTYClient(PhysicalLayer *phy)</div><div class="ttdoc">Constructor for 2-FSK mode.</div><div class="ttdef"><b>Definition:</b> RTTY.cpp:7</div></div>
<div class="ttc" id="aclass_radio_lib_print_html"><div class="ttname"><a href="class_radio_lib_print.html">RadioLibPrint</a></div><div class="ttdoc">Printing class, based on Arduino Print class with additional encodings.</div><div class="ttdef"><b>Definition:</b> Print.h:17</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_620e20826520c01cf981aa9c981ff885.html">RTTY</a></li><li class="navelem"><b>RTTY.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>