443 lines
33 KiB
HTML
443 lines
33 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: BellClient Class Reference</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('class_bell_client.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="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="class_bell_client-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">BellClient Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Client for Bell modem communication. The public interface is the same as Arduino Serial.
|
|
<a href="class_bell_client.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_bell_modem_8h_source.html">BellModem.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for BellClient:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_bell_client.png" usemap="#BellClient_map" alt=""/>
|
|
<map id="BellClient_map" name="BellClient_map">
|
|
<area href="class_a_f_s_k_client.html" title="Client for audio-based transmissions. Requires Arduino tone() function, and a module capable of direc..." alt="AFSKClient" shape="rect" coords="0,0,87,24"/>
|
|
<area href="class_radio_lib_print.html" title="Printing class, based on Arduino Print class with additional encodings." alt="RadioLibPrint" shape="rect" coords="97,0,184,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a20fcf0322ef40c31b3bc329f7d89a177"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bell_client.html#a20fcf0322ef40c31b3bc329f7d89a177">BellClient</a> (<a class="el" href="class_physical_layer.html">PhysicalLayer</a> *phy, uint32_t pin)</td></tr>
|
|
<tr class="memdesc:a20fcf0322ef40c31b3bc329f7d89a177"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="class_bell_client.html#a20fcf0322ef40c31b3bc329f7d89a177">More...</a><br /></td></tr>
|
|
<tr class="separator:a20fcf0322ef40c31b3bc329f7d89a177"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9d0d76bb88fc8bdc995ab800063c149"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bell_client.html#ab9d0d76bb88fc8bdc995ab800063c149">BellClient</a> (<a class="el" href="class_a_f_s_k_client.html">AFSKClient</a> *aud)</td></tr>
|
|
<tr class="memdesc:ab9d0d76bb88fc8bdc995ab800063c149"><td class="mdescLeft"> </td><td class="mdescRight">Audio-client constructor. Can be used when <a class="el" href="class_a_f_s_k_client.html" title="Client for audio-based transmissions. Requires Arduino tone() function, and a module capable of direc...">AFSKClient</a> instance already exists. <a href="class_bell_client.html#ab9d0d76bb88fc8bdc995ab800063c149">More...</a><br /></td></tr>
|
|
<tr class="separator:ab9d0d76bb88fc8bdc995ab800063c149"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add9edc89cd6ff5c527ddbdabe79cb60f"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bell_client.html#add9edc89cd6ff5c527ddbdabe79cb60f">begin</a> (const <a class="el" href="struct_bell_modem__t.html">BellModem_t</a> &modem)</td></tr>
|
|
<tr class="memdesc:add9edc89cd6ff5c527ddbdabe79cb60f"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. <a href="class_bell_client.html#add9edc89cd6ff5c527ddbdabe79cb60f">More...</a><br /></td></tr>
|
|
<tr class="separator:add9edc89cd6ff5c527ddbdabe79cb60f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a163f65f3fcce87d9bea558b34c19bd47"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bell_client.html#a163f65f3fcce87d9bea558b34c19bd47">setModem</a> (const <a class="el" href="struct_bell_modem__t.html">BellModem_t</a> &modem)</td></tr>
|
|
<tr class="memdesc:a163f65f3fcce87d9bea558b34c19bd47"><td class="mdescLeft"> </td><td class="mdescRight">Set Bell modem. <a href="class_bell_client.html#a163f65f3fcce87d9bea558b34c19bd47">More...</a><br /></td></tr>
|
|
<tr class="separator:a163f65f3fcce87d9bea558b34c19bd47"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a90f3f33a09a4cf8d544ca1e9a23beae2"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bell_client.html#a90f3f33a09a4cf8d544ca1e9a23beae2">setCorrection</a> (float corr)</td></tr>
|
|
<tr class="memdesc:a90f3f33a09a4cf8d544ca1e9a23beae2"><td class="mdescLeft"> </td><td class="mdescRight">Set correction coefficient for tone length. <a href="class_bell_client.html#a90f3f33a09a4cf8d544ca1e9a23beae2">More...</a><br /></td></tr>
|
|
<tr class="separator:a90f3f33a09a4cf8d544ca1e9a23beae2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a69bd78bf3be2724b4f34c80c2bd3a6df"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bell_client.html#a69bd78bf3be2724b4f34c80c2bd3a6df">write</a> (uint8_t b) override</td></tr>
|
|
<tr class="memdesc:a69bd78bf3be2724b4f34c80c2bd3a6df"><td class="mdescLeft"> </td><td class="mdescRight">Write one byte. Implementation of interface of the RadioLibPrint/Print class. <a href="class_bell_client.html#a69bd78bf3be2724b4f34c80c2bd3a6df">More...</a><br /></td></tr>
|
|
<tr class="separator:a69bd78bf3be2724b4f34c80c2bd3a6df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aabd170def79cdbfd56a1d243e6227a75"><td class="memItemLeft" align="right" valign="top"><a id="aabd170def79cdbfd56a1d243e6227a75"></a>
|
|
int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bell_client.html#aabd170def79cdbfd56a1d243e6227a75">idle</a> ()</td></tr>
|
|
<tr class="memdesc:aabd170def79cdbfd56a1d243e6227a75"><td class="mdescLeft"> </td><td class="mdescRight">Set the modem to idle (ready to transmit). <br /></td></tr>
|
|
<tr class="separator:aabd170def79cdbfd56a1d243e6227a75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a57c19c733b0dfe80bd321f23b18c1e80"><td class="memItemLeft" align="right" valign="top"><a id="a57c19c733b0dfe80bd321f23b18c1e80"></a>
|
|
int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bell_client.html#a57c19c733b0dfe80bd321f23b18c1e80">standby</a> ()</td></tr>
|
|
<tr class="memdesc:a57c19c733b0dfe80bd321f23b18c1e80"><td class="mdescLeft"> </td><td class="mdescRight">Set the modem to standby (transmitter off). <br /></td></tr>
|
|
<tr class="separator:a57c19c733b0dfe80bd321f23b18c1e80"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_a_f_s_k_client"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_a_f_s_k_client')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_a_f_s_k_client.html">AFSKClient</a></td></tr>
|
|
<tr class="memitem:a89c7ab4759d37c9a032ac29fa9782eea inherit pub_methods_class_a_f_s_k_client"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_f_s_k_client.html#a89c7ab4759d37c9a032ac29fa9782eea">AFSKClient</a> (<a class="el" href="class_physical_layer.html">PhysicalLayer</a> *phy, uint32_t pin)</td></tr>
|
|
<tr class="memdesc:a89c7ab4759d37c9a032ac29fa9782eea inherit pub_methods_class_a_f_s_k_client"><td class="mdescLeft"> </td><td class="mdescRight">Default contructor. <a href="class_a_f_s_k_client.html#a89c7ab4759d37c9a032ac29fa9782eea">More...</a><br /></td></tr>
|
|
<tr class="separator:a89c7ab4759d37c9a032ac29fa9782eea inherit pub_methods_class_a_f_s_k_client"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac54633fe75157ce126e44e4e494266f2 inherit pub_methods_class_a_f_s_k_client"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_f_s_k_client.html#ac54633fe75157ce126e44e4e494266f2">AFSKClient</a> (<a class="el" href="class_a_f_s_k_client.html">AFSKClient</a> *aud)</td></tr>
|
|
<tr class="memdesc:ac54633fe75157ce126e44e4e494266f2 inherit pub_methods_class_a_f_s_k_client"><td class="mdescLeft"> </td><td class="mdescRight">Copy contructor. <a href="class_a_f_s_k_client.html#ac54633fe75157ce126e44e4e494266f2">More...</a><br /></td></tr>
|
|
<tr class="separator:ac54633fe75157ce126e44e4e494266f2 inherit pub_methods_class_a_f_s_k_client"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a30b86bb7cd087b3bc3c45a011ba266c3 inherit pub_methods_class_a_f_s_k_client"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_f_s_k_client.html#a30b86bb7cd087b3bc3c45a011ba266c3">begin</a> ()</td></tr>
|
|
<tr class="memdesc:a30b86bb7cd087b3bc3c45a011ba266c3 inherit pub_methods_class_a_f_s_k_client"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. <a href="class_a_f_s_k_client.html#a30b86bb7cd087b3bc3c45a011ba266c3">More...</a><br /></td></tr>
|
|
<tr class="separator:a30b86bb7cd087b3bc3c45a011ba266c3 inherit pub_methods_class_a_f_s_k_client"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6d2341901c83e45f853c077e60f1fa33 inherit pub_methods_class_a_f_s_k_client"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_f_s_k_client.html#a6d2341901c83e45f853c077e60f1fa33">tone</a> (uint16_t freq, bool autoStart=true)</td></tr>
|
|
<tr class="memdesc:a6d2341901c83e45f853c077e60f1fa33 inherit pub_methods_class_a_f_s_k_client"><td class="mdescLeft"> </td><td class="mdescRight">Start transmitting audio tone. <a href="class_a_f_s_k_client.html#a6d2341901c83e45f853c077e60f1fa33">More...</a><br /></td></tr>
|
|
<tr class="separator:a6d2341901c83e45f853c077e60f1fa33 inherit pub_methods_class_a_f_s_k_client"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a664c1de9b5cd792826a5a77ac5457bae inherit pub_methods_class_a_f_s_k_client"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_f_s_k_client.html#a664c1de9b5cd792826a5a77ac5457bae">noTone</a> (bool keepOn=false)</td></tr>
|
|
<tr class="memdesc:a664c1de9b5cd792826a5a77ac5457bae inherit pub_methods_class_a_f_s_k_client"><td class="mdescLeft"> </td><td class="mdescRight">Stops transmitting audio tone. <a href="class_a_f_s_k_client.html#a664c1de9b5cd792826a5a77ac5457bae">More...</a><br /></td></tr>
|
|
<tr class="separator:a664c1de9b5cd792826a5a77ac5457bae inherit pub_methods_class_a_f_s_k_client"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_radio_lib_print"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_radio_lib_print')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_radio_lib_print.html">RadioLibPrint</a></td></tr>
|
|
<tr class="memitem:a6e1803a39074e658e54931f13bd2d641 inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="a6e1803a39074e658e54931f13bd2d641"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (const char *str)</td></tr>
|
|
<tr class="separator:a6e1803a39074e658e54931f13bd2d641 inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1543d3565013e22448385a4d1799ada9 inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="a1543d3565013e22448385a4d1799ada9"></a>
|
|
virtual size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (const uint8_t *buffer, size_t size)</td></tr>
|
|
<tr class="separator:a1543d3565013e22448385a4d1799ada9 inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2c5435bea28e97f4893002f01549c80 inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="ad2c5435bea28e97f4893002f01549c80"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>write</b> (const char *buffer, size_t size)</td></tr>
|
|
<tr class="separator:ad2c5435bea28e97f4893002f01549c80 inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa2ac029ea08cf28ebcc3abd52e19164f inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="aa2ac029ea08cf28ebcc3abd52e19164f"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (<a class="el" href="class_i_t_a2_string.html">ITA2String</a> &ita2)</td></tr>
|
|
<tr class="separator:aa2ac029ea08cf28ebcc3abd52e19164f inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab1f386ce4a8fa5b10eb72f7d8854e292 inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="ab1f386ce4a8fa5b10eb72f7d8854e292"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (<a class="el" href="class_i_t_a2_string.html">ITA2String</a> &ita2)</td></tr>
|
|
<tr class="separator:ab1f386ce4a8fa5b10eb72f7d8854e292 inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9aa1fb490af4bd22aabc6687c4d082af inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="a9aa1fb490af4bd22aabc6687c4d082af"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (const char[])</td></tr>
|
|
<tr class="separator:a9aa1fb490af4bd22aabc6687c4d082af inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaecbc6db0a6312a186f5eef774be5ad2 inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="aaecbc6db0a6312a186f5eef774be5ad2"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (char)</td></tr>
|
|
<tr class="separator:aaecbc6db0a6312a186f5eef774be5ad2 inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a02b4c3892a70d7bc0868e74622e4a97e inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="a02b4c3892a70d7bc0868e74622e4a97e"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned char, int=DEC)</td></tr>
|
|
<tr class="separator:a02b4c3892a70d7bc0868e74622e4a97e inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af2211384921ec34cce7257f729fff60d inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="af2211384921ec34cce7257f729fff60d"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (int, int=DEC)</td></tr>
|
|
<tr class="separator:af2211384921ec34cce7257f729fff60d inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aecfc38ba379bc123ea7e07e47de801e9 inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="aecfc38ba379bc123ea7e07e47de801e9"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned int, int=DEC)</td></tr>
|
|
<tr class="separator:aecfc38ba379bc123ea7e07e47de801e9 inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a4c5fc3fbe7c78a2739dfd5b2648a11 inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="a7a4c5fc3fbe7c78a2739dfd5b2648a11"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (long, int=DEC)</td></tr>
|
|
<tr class="separator:a7a4c5fc3fbe7c78a2739dfd5b2648a11 inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2cbd376adf2d4fc949e02c955cf213c inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="ad2cbd376adf2d4fc949e02c955cf213c"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned long, int=DEC)</td></tr>
|
|
<tr class="separator:ad2cbd376adf2d4fc949e02c955cf213c inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2e6857e72af3ebca1607ccd5d8201c6c inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="a2e6857e72af3ebca1607ccd5d8201c6c"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>print</b> (double, int=2)</td></tr>
|
|
<tr class="separator:a2e6857e72af3ebca1607ccd5d8201c6c inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abcab0d059987ce8f72e8a99959f1605c inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="abcab0d059987ce8f72e8a99959f1605c"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (const char[])</td></tr>
|
|
<tr class="separator:abcab0d059987ce8f72e8a99959f1605c inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac62c6e144cc5f2ab3d2dfa69e304600d inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="ac62c6e144cc5f2ab3d2dfa69e304600d"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (char)</td></tr>
|
|
<tr class="separator:ac62c6e144cc5f2ab3d2dfa69e304600d inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab794539d4769bcf1f0f4d2984b767390 inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="ab794539d4769bcf1f0f4d2984b767390"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned char, int=DEC)</td></tr>
|
|
<tr class="separator:ab794539d4769bcf1f0f4d2984b767390 inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a21d43e8baa2efae0651f714b0f61a0ad inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="a21d43e8baa2efae0651f714b0f61a0ad"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (int, int=DEC)</td></tr>
|
|
<tr class="separator:a21d43e8baa2efae0651f714b0f61a0ad inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a361a76b2f27cb9398d201a4e5efe0358 inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="a361a76b2f27cb9398d201a4e5efe0358"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned int, int=DEC)</td></tr>
|
|
<tr class="separator:a361a76b2f27cb9398d201a4e5efe0358 inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a800f38287c6f292ab0110c6d396a88 inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="a9a800f38287c6f292ab0110c6d396a88"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (long, int=DEC)</td></tr>
|
|
<tr class="separator:a9a800f38287c6f292ab0110c6d396a88 inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c5d589d814403fb1be6351e1f93f8e8 inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="a0c5d589d814403fb1be6351e1f93f8e8"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned long, int=DEC)</td></tr>
|
|
<tr class="separator:a0c5d589d814403fb1be6351e1f93f8e8 inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00bbdff41954312512167cb2b799cb01 inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="a00bbdff41954312512167cb2b799cb01"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (double, int=2)</td></tr>
|
|
<tr class="separator:a00bbdff41954312512167cb2b799cb01 inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c055b364954957a48a798abe14cdff7 inherit pub_methods_class_radio_lib_print"><td class="memItemLeft" align="right" valign="top"><a id="a2c055b364954957a48a798abe14cdff7"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>println</b> (void)</td></tr>
|
|
<tr class="separator:a2c055b364954957a48a798abe14cdff7 inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a9233e10bc794af85e3e86b4ec2a8746d"><td class="memItemLeft" align="right" valign="top"><a id="a9233e10bc794af85e3e86b4ec2a8746d"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_bell_client.html#a9233e10bc794af85e3e86b4ec2a8746d">reply</a></td></tr>
|
|
<tr class="memdesc:a9233e10bc794af85e3e86b4ec2a8746d"><td class="mdescLeft"> </td><td class="mdescRight">Whether the modem is replying. On some modems, the replying station has different tone frequencies. <br /></td></tr>
|
|
<tr class="separator:a9233e10bc794af85e3e86b4ec2a8746d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Client for Bell modem communication. The public interface is the same as Arduino Serial. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a20fcf0322ef40c31b3bc329f7d89a177"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a20fcf0322ef40c31b3bc329f7d89a177">◆ </a></span>BellClient() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">BellClient::BellClient </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_physical_layer.html">PhysicalLayer</a> * </td>
|
|
<td class="paramname"><em>phy</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>pin</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">phy</td><td>Pointer to the wireless module providing <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a> communication. </td></tr>
|
|
<tr><td class="paramname">pin</td><td>The GPIO pin at which the tones will be generated. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab9d0d76bb88fc8bdc995ab800063c149"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab9d0d76bb88fc8bdc995ab800063c149">◆ </a></span>BellClient() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">BellClient::BellClient </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_a_f_s_k_client.html">AFSKClient</a> * </td>
|
|
<td class="paramname"><em>aud</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Audio-client constructor. Can be used when <a class="el" href="class_a_f_s_k_client.html" title="Client for audio-based transmissions. Requires Arduino tone() function, and a module capable of direc...">AFSKClient</a> instance already exists. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">aud</td><td>Audio client to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="add9edc89cd6ff5c527ddbdabe79cb60f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#add9edc89cd6ff5c527ddbdabe79cb60f">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t BellClient::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="struct_bell_modem__t.html">BellModem_t</a> & </td>
|
|
<td class="paramname"><em>modem</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialization method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">modem</td><td>Definition of the Bell modem to use for communication. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a90f3f33a09a4cf8d544ca1e9a23beae2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a90f3f33a09a4cf8d544ca1e9a23beae2">◆ </a></span>setCorrection()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t BellClient::setCorrection </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>corr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set correction coefficient for tone length. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">corr</td><td>Timing correction factor, used to adjust the length of tones. Less than 1.0 leads to shorter tones, defaults to 1.0 (no correction). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a163f65f3fcce87d9bea558b34c19bd47"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a163f65f3fcce87d9bea558b34c19bd47">◆ </a></span>setModem()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t BellClient::setModem </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="struct_bell_modem__t.html">BellModem_t</a> & </td>
|
|
<td class="paramname"><em>modem</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set Bell modem. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">modem</td><td>Definition of the Bell modem to use for communication. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a69bd78bf3be2724b4f34c80c2bd3a6df"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a69bd78bf3be2724b4f34c80c2bd3a6df">◆ </a></span>write()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t BellClient::write </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>b</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write one byte. Implementation of interface of the RadioLibPrint/Print class. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">b</td><td>Byte to write. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 if the byte was written, 0 otherwise. </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="class_radio_lib_print.html">RadioLibPrint</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/protocols/BellModem/<a class="el" href="_bell_modem_8h_source.html">BellModem.h</a></li>
|
|
<li>src/protocols/BellModem/BellModem.cpp</li>
|
|
</ul>
|
|
</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="class_bell_client.html">BellClient</a></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>
|