forks/RadioLibSmol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
RadioLibSmol/_bell_modem_8h_source.html
jgromes 8f3206099a Deploying to gh-pages from @ 2550fae4cb 🚀
2025-02-05 19:42:17 +00:00

197 lines
21 KiB
HTML
Raw Permalink Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<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 id="projectrow">
<td id="projectalign">
<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.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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 id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#if !defined(_RADIOLIB_BELL_MODEM_H)</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define _RADIOLIB_BELL_MODEM_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &quot;../../TypeDef.h&quot;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &quot;../../Module.h&quot;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#if !RADIOLIB_EXCLUDE_BELL</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;../PhysicalLayer/PhysicalLayer.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &quot;../AFSK/AFSK.h&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &quot;../Print/Print.h&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &quot;../Print/ITA2String.h&quot;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="foldopen" id="foldopen00018" data-start="{" data-end="};">
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="struct_bell_modem__t.html"> 18</a></span><span class="keyword">struct </span><a class="code hl_struct" href="struct_bell_modem__t.html">BellModem_t</a> {</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="struct_bell_modem__t.html#ac57de3660aafb52bcf1b3197380c6ce5"> 22</a></span> int16_t <a class="code hl_variable" href="struct_bell_modem__t.html#ac57de3660aafb52bcf1b3197380c6ce5">freqMark</a>;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="struct_bell_modem__t.html#a27c1a411df3d887ca0ce246c3b5521f7"> 27</a></span> int16_t <a class="code hl_variable" href="struct_bell_modem__t.html#a27c1a411df3d887ca0ce246c3b5521f7">freqSpace</a>;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="struct_bell_modem__t.html#a8e16be8997a90db9a4b2482ec7e93171"> 32</a></span> int16_t <a class="code hl_variable" href="struct_bell_modem__t.html#a8e16be8997a90db9a4b2482ec7e93171">baudRate</a>;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="struct_bell_modem__t.html#aa26b8a2f2ae9722de9a69aab991ce229"> 37</a></span> int16_t <a class="code hl_variable" href="struct_bell_modem__t.html#aa26b8a2f2ae9722de9a69aab991ce229">freqMarkReply</a>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="struct_bell_modem__t.html#a40fe8a17a9b4fae3f313fea34077eacc"> 42</a></span> int16_t <a class="code hl_variable" href="struct_bell_modem__t.html#a40fe8a17a9b4fae3f313fea34077eacc">freqSpaceReply</a>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span>};</div>
</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment">// currently implemented Bell modems</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="keyword">extern</span> <span class="keyword">const</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_bell_modem__t.html">BellModem_t</a> Bell101;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="keyword">extern</span> <span class="keyword">const</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_bell_modem__t.html">BellModem_t</a> Bell103;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="keyword">extern</span> <span class="keyword">const</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_bell_modem__t.html">BellModem_t</a> Bell202;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="foldopen" id="foldopen00054" data-start="{" data-end="};">
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="class_bell_client.html"> 54</a></span><span class="keyword">class </span><a class="code hl_class" href="class_bell_client.html">BellClient</a>: <span class="keyword">public</span> <a class="code hl_class" href="class_a_f_s_k_client.html">AFSKClient</a>, <span class="keyword">public</span> <a class="code hl_class" href="class_radio_lib_print.html">RadioLibPrint</a> {</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="class_bell_client.html#a9233e10bc794af85e3e86b4ec2a8746d"> 62</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="class_bell_client.html#a9233e10bc794af85e3e86b4ec2a8746d">reply</a>;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">explicit</span> <a class="code hl_class" href="class_bell_client.html">BellClient</a>(<a class="code hl_class" href="class_physical_layer.html">PhysicalLayer</a>* phy, uint32_t pin);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">explicit</span> <a class="code hl_class" href="class_bell_client.html">BellClient</a>(<a class="code hl_class" href="class_a_f_s_k_client.html">AFSKClient</a>* aud);</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> int16_t <a class="code hl_function" href="class_a_f_s_k_client.html#a30b86bb7cd087b3bc3c45a011ba266c3">begin</a>(<span class="keyword">const</span> <a class="code hl_struct" href="struct_bell_modem__t.html">BellModem_t</a>&amp; modem);</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> int16_t <a class="code hl_function" href="class_bell_client.html#a163f65f3fcce87d9bea558b34c19bd47">setModem</a>(<span class="keyword">const</span> <a class="code hl_struct" href="struct_bell_modem__t.html">BellModem_t</a>&amp; modem);</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> int16_t <a class="code hl_function" href="class_bell_client.html#a90f3f33a09a4cf8d544ca1e9a23beae2">setCorrection</a>(<span class="keywordtype">float</span> corr);</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="class_bell_client.html#a69bd78bf3be2724b4f34c80c2bd3a6df">write</a>(uint8_t b) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> int16_t <a class="code hl_function" href="class_bell_client.html#aabd170def79cdbfd56a1d243e6227a75">idle</a>();</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> int16_t <a class="code hl_function" href="class_bell_client.html#a57c19c733b0dfe80bd321f23b18c1e80">standby</a>();</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> </div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <a class="code hl_struct" href="struct_bell_modem__t.html">BellModem_t</a> modemType = Bell101;</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <span class="keywordtype">float</span> correction = 1.0;</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> uint16_t toneLen = 0;</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <span class="keywordtype">bool</span> autoStart = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> </div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span>};</div>
</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</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_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:54</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:62</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:216</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:18</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:27</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:42</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:32</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:37</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:22</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.8 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink