RadioLib/_bell_modem_8h_source.html

185 wiersze
21 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/BellModem/BellModem.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&amp;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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_bell_modem_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">BellModem.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#if !defined(_RADIOLIB_BELL_MODEM_H)</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define _RADIOLIB_BELL_MODEM_H</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;../../TypeDef.h&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &quot;../../Module.h&quot;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &quot;../../ArduinoHal.h&quot;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#if !RADIOLIB_EXCLUDE_BELL</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;../PhysicalLayer/PhysicalLayer.h&quot;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;../AFSK/AFSK.h&quot;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;../Print/Print.h&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &quot;../Print/ITA2String.h&quot;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="struct_bell_modem__t.html"> 21</a></span>&#160;<span class="keyword">struct </span><a class="code" href="struct_bell_modem__t.html">BellModem_t</a> {</div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="struct_bell_modem__t.html#ac57de3660aafb52bcf1b3197380c6ce5"> 25</a></span>&#160; int16_t <a class="code" href="struct_bell_modem__t.html#ac57de3660aafb52bcf1b3197380c6ce5">freqMark</a>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="struct_bell_modem__t.html#a27c1a411df3d887ca0ce246c3b5521f7"> 30</a></span>&#160; int16_t <a class="code" href="struct_bell_modem__t.html#a27c1a411df3d887ca0ce246c3b5521f7">freqSpace</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="struct_bell_modem__t.html#a8e16be8997a90db9a4b2482ec7e93171"> 35</a></span>&#160; int16_t <a class="code" href="struct_bell_modem__t.html#a8e16be8997a90db9a4b2482ec7e93171">baudRate</a>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="struct_bell_modem__t.html#aa26b8a2f2ae9722de9a69aab991ce229"> 40</a></span>&#160; int16_t <a class="code" href="struct_bell_modem__t.html#aa26b8a2f2ae9722de9a69aab991ce229">freqMarkReply</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="struct_bell_modem__t.html#a40fe8a17a9b4fae3f313fea34077eacc"> 45</a></span>&#160; int16_t <a class="code" href="struct_bell_modem__t.html#a40fe8a17a9b4fae3f313fea34077eacc">freqSpaceReply</a>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;};</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment">// currently implemented Bell modems</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="keyword">extern</span> <span class="keyword">const</span> <span class="keyword">struct </span><a class="code" href="struct_bell_modem__t.html">BellModem_t</a> Bell101;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword">extern</span> <span class="keyword">const</span> <span class="keyword">struct </span><a class="code" href="struct_bell_modem__t.html">BellModem_t</a> Bell103;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="keyword">extern</span> <span class="keyword">const</span> <span class="keyword">struct </span><a class="code" href="struct_bell_modem__t.html">BellModem_t</a> Bell202;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="class_bell_client.html"> 57</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_bell_client.html">BellClient</a>: <span class="keyword">public</span> <a class="code" href="class_a_f_s_k_client.html">AFSKClient</a>, <span class="keyword">public</span> <a class="code" href="class_radio_lib_print.html">RadioLibPrint</a> {</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="class_bell_client.html#a9233e10bc794af85e3e86b4ec2a8746d"> 65</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_bell_client.html#a9233e10bc794af85e3e86b4ec2a8746d">reply</a>;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keyword">explicit</span> <a class="code" href="class_bell_client.html">BellClient</a>(<a class="code" href="class_physical_layer.html">PhysicalLayer</a>* phy, uint32_t pin);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">explicit</span> <a class="code" href="class_bell_client.html">BellClient</a>(<a class="code" href="class_a_f_s_k_client.html">AFSKClient</a>* aud);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; int16_t <a class="code" href="class_a_f_s_k_client.html#a30b86bb7cd087b3bc3c45a011ba266c3">begin</a>(<span class="keyword">const</span> <a class="code" href="struct_bell_modem__t.html">BellModem_t</a>&amp; modem);</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; int16_t <a class="code" href="class_bell_client.html#a163f65f3fcce87d9bea558b34c19bd47">setModem</a>(<span class="keyword">const</span> <a class="code" href="struct_bell_modem__t.html">BellModem_t</a>&amp; modem);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; int16_t <a class="code" href="class_bell_client.html#a90f3f33a09a4cf8d544ca1e9a23beae2">setCorrection</a>(<span class="keywordtype">float</span> corr);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="class_bell_client.html#a69bd78bf3be2724b4f34c80c2bd3a6df">write</a>(uint8_t b) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; int16_t <a class="code" href="class_bell_client.html#aabd170def79cdbfd56a1d243e6227a75">idle</a>();</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; int16_t <a class="code" href="class_bell_client.html#a57c19c733b0dfe80bd321f23b18c1e80">standby</a>();</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; </div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <a class="code" href="struct_bell_modem__t.html">BellModem_t</a> modemType = Bell101;</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordtype">float</span> correction = 1.0;</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; uint16_t toneLen = 0;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="keywordtype">bool</span> autoStart = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; </div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;};</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; </div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<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_a_f_s_k_client_html_a30b86bb7cd087b3bc3c45a011ba266c3"><div class="ttname"><a href="class_a_f_s_k_client.html#a30b86bb7cd087b3bc3c45a011ba266c3">AFSKClient::begin</a></div><div class="ttdeci">int16_t begin()</div><div class="ttdoc">Initialization method.</div><div class="ttdef"><b>Definition:</b> AFSK.cpp:13</div></div>
<div class="ttc" id="aclass_bell_client_html"><div class="ttname"><a href="class_bell_client.html">BellClient</a></div><div class="ttdoc">Client for Bell modem communication. The public interface is the same as Arduino Serial.</div><div class="ttdef"><b>Definition:</b> BellModem.h:57</div></div>
<div class="ttc" id="aclass_bell_client_html_a163f65f3fcce87d9bea558b34c19bd47"><div class="ttname"><a href="class_bell_client.html#a163f65f3fcce87d9bea558b34c19bd47">BellClient::setModem</a></div><div class="ttdeci">int16_t setModem(const BellModem_t &amp;modem)</div><div class="ttdoc">Set Bell modem.</div><div class="ttdef"><b>Definition:</b> BellModem.cpp:44</div></div>
<div class="ttc" id="aclass_bell_client_html_a57c19c733b0dfe80bd321f23b18c1e80"><div class="ttname"><a href="class_bell_client.html#a57c19c733b0dfe80bd321f23b18c1e80">BellClient::standby</a></div><div class="ttdeci">int16_t standby()</div><div class="ttdoc">Set the modem to standby (transmitter off).</div><div class="ttdef"><b>Definition:</b> BellModem.cpp:93</div></div>
<div class="ttc" id="aclass_bell_client_html_a69bd78bf3be2724b4f34c80c2bd3a6df"><div class="ttname"><a href="class_bell_client.html#a69bd78bf3be2724b4f34c80c2bd3a6df">BellClient::write</a></div><div class="ttdeci">size_t write(uint8_t b) override</div><div class="ttdoc">Write one byte. Implementation of interface of the RadioLibPrint/Print class.</div><div class="ttdef"><b>Definition:</b> BellModem.cpp:55</div></div>
<div class="ttc" id="aclass_bell_client_html_a90f3f33a09a4cf8d544ca1e9a23beae2"><div class="ttname"><a href="class_bell_client.html#a90f3f33a09a4cf8d544ca1e9a23beae2">BellClient::setCorrection</a></div><div class="ttdeci">int16_t setCorrection(float corr)</div><div class="ttdoc">Set correction coefficient for tone length.</div><div class="ttdef"><b>Definition:</b> BellModem.cpp:50</div></div>
<div class="ttc" id="aclass_bell_client_html_a9233e10bc794af85e3e86b4ec2a8746d"><div class="ttname"><a href="class_bell_client.html#a9233e10bc794af85e3e86b4ec2a8746d">BellClient::reply</a></div><div class="ttdeci">bool reply</div><div class="ttdoc">Whether the modem is replying. On some modems, the replying station has different tone frequencies.</div><div class="ttdef"><b>Definition:</b> BellModem.h:65</div></div>
<div class="ttc" id="aclass_bell_client_html_aabd170def79cdbfd56a1d243e6227a75"><div class="ttname"><a href="class_bell_client.html#aabd170def79cdbfd56a1d243e6227a75">BellClient::idle</a></div><div class="ttdeci">int16_t idle()</div><div class="ttdoc">Set the modem to idle (ready to transmit).</div><div class="ttdef"><b>Definition:</b> BellModem.cpp:88</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_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 class="ttc" id="astruct_bell_modem__t_html"><div class="ttname"><a href="struct_bell_modem__t.html">BellModem_t</a></div><div class="ttdoc">Definition of the Bell-compatible modem.</div><div class="ttdef"><b>Definition:</b> BellModem.h:21</div></div>
<div class="ttc" id="astruct_bell_modem__t_html_a27c1a411df3d887ca0ce246c3b5521f7"><div class="ttname"><a href="struct_bell_modem__t.html#a27c1a411df3d887ca0ce246c3b5521f7">BellModem_t::freqSpace</a></div><div class="ttdeci">int16_t freqSpace</div><div class="ttdoc">Frequency of the space tone.</div><div class="ttdef"><b>Definition:</b> BellModem.h:30</div></div>
<div class="ttc" id="astruct_bell_modem__t_html_a40fe8a17a9b4fae3f313fea34077eacc"><div class="ttname"><a href="struct_bell_modem__t.html#a40fe8a17a9b4fae3f313fea34077eacc">BellModem_t::freqSpaceReply</a></div><div class="ttdeci">int16_t freqSpaceReply</div><div class="ttdoc">Frequency of the space tone when replying.</div><div class="ttdef"><b>Definition:</b> BellModem.h:45</div></div>
<div class="ttc" id="astruct_bell_modem__t_html_a8e16be8997a90db9a4b2482ec7e93171"><div class="ttname"><a href="struct_bell_modem__t.html#a8e16be8997a90db9a4b2482ec7e93171">BellModem_t::baudRate</a></div><div class="ttdeci">int16_t baudRate</div><div class="ttdoc">Baud rate.</div><div class="ttdef"><b>Definition:</b> BellModem.h:35</div></div>
<div class="ttc" id="astruct_bell_modem__t_html_aa26b8a2f2ae9722de9a69aab991ce229"><div class="ttname"><a href="struct_bell_modem__t.html#aa26b8a2f2ae9722de9a69aab991ce229">BellModem_t::freqMarkReply</a></div><div class="ttdeci">int16_t freqMarkReply</div><div class="ttdoc">Frequency of the mark tone when replying.</div><div class="ttdef"><b>Definition:</b> BellModem.h:40</div></div>
<div class="ttc" id="astruct_bell_modem__t_html_ac57de3660aafb52bcf1b3197380c6ce5"><div class="ttname"><a href="struct_bell_modem__t.html#ac57de3660aafb52bcf1b3197380c6ce5">BellModem_t::freqMark</a></div><div class="ttdeci">int16_t freqMark</div><div class="ttdoc">Frequency of the mark tone.</div><div class="ttdef"><b>Definition:</b> BellModem.h:25</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_7ce43430bd3dd6c604a08a4c1ed5ec76.html">BellModem</a></li><li class="navelem"><b>BellModem.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>