331 lines
18 KiB
HTML
331 lines
18 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" 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: AFSKClient 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 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&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&dn=expat.txt MIT */
|
|
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('class_a_f_s_k_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">
|
|
<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="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="class_a_f_s_k_client-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">AFSKClient Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Client for audio-based transmissions. Requires Arduino <a class="el" href="class_a_f_s_k_client.html#a6d2341901c83e45f853c077e60f1fa33" title="Start transmitting audio tone.">tone()</a> function, and a module capable of direct mode transmission using DIO pins.
|
|
<a href="class_a_f_s_k_client.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_a_f_s_k_8h_source.html">AFSK.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for AFSKClient:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_a_f_s_k_client.png" usemap="#AFSKClient_map" alt=""/>
|
|
<map id="AFSKClient_map" name="AFSKClient_map">
|
|
<area href="class_bell_client.html" title="Client for Bell modem communication. The public interface is the same as Arduino Serial." alt="BellClient" shape="rect" coords="0,56,77,80"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a89c7ab4759d37c9a032ac29fa9782eea" id="r_a89c7ab4759d37c9a032ac29fa9782eea"><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"><td class="mdescLeft"> </td><td class="mdescRight">Default contructor. <br /></td></tr>
|
|
<tr class="separator:a89c7ab4759d37c9a032ac29fa9782eea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac54633fe75157ce126e44e4e494266f2" id="r_ac54633fe75157ce126e44e4e494266f2"><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"><td class="mdescLeft"> </td><td class="mdescRight">Copy contructor. <br /></td></tr>
|
|
<tr class="separator:ac54633fe75157ce126e44e4e494266f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a30b86bb7cd087b3bc3c45a011ba266c3" id="r_a30b86bb7cd087b3bc3c45a011ba266c3"><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"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. <br /></td></tr>
|
|
<tr class="separator:a30b86bb7cd087b3bc3c45a011ba266c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6d2341901c83e45f853c077e60f1fa33" id="r_a6d2341901c83e45f853c077e60f1fa33"><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"><td class="mdescLeft"> </td><td class="mdescRight">Start transmitting audio tone. <br /></td></tr>
|
|
<tr class="separator:a6d2341901c83e45f853c077e60f1fa33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a664c1de9b5cd792826a5a77ac5457bae" id="r_a664c1de9b5cd792826a5a77ac5457bae"><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"><td class="mdescLeft"> </td><td class="mdescRight">Stops transmitting audio tone. <br /></td></tr>
|
|
<tr class="separator:a664c1de9b5cd792826a5a77ac5457bae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a018393f703a257e39cd263cccf4ffad5" id="r_a018393f703a257e39cd263cccf4ffad5"><td class="memItemLeft" align="right" valign="top"><a id="a018393f703a257e39cd263cccf4ffad5" name="a018393f703a257e39cd263cccf4ffad5"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>RTTYClient</b></td></tr>
|
|
<tr class="separator:a018393f703a257e39cd263cccf4ffad5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae5c5757c553100373984a416b6c3690a" id="r_ae5c5757c553100373984a416b6c3690a"><td class="memItemLeft" align="right" valign="top"><a id="ae5c5757c553100373984a416b6c3690a" name="ae5c5757c553100373984a416b6c3690a"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>MorseClient</b></td></tr>
|
|
<tr class="separator:ae5c5757c553100373984a416b6c3690a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afeb005bab389f137def61f1acc3714d3" id="r_afeb005bab389f137def61f1acc3714d3"><td class="memItemLeft" align="right" valign="top"><a id="afeb005bab389f137def61f1acc3714d3" name="afeb005bab389f137def61f1acc3714d3"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>HellClient</b></td></tr>
|
|
<tr class="separator:afeb005bab389f137def61f1acc3714d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8dd4f2f60ef4fd1fa1868a7a630ab20" id="r_ae8dd4f2f60ef4fd1fa1868a7a630ab20"><td class="memItemLeft" align="right" valign="top"><a id="ae8dd4f2f60ef4fd1fa1868a7a630ab20" name="ae8dd4f2f60ef4fd1fa1868a7a630ab20"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>SSTVClient</b></td></tr>
|
|
<tr class="separator:ae8dd4f2f60ef4fd1fa1868a7a630ab20"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0012621c1414f4c7573e961b57884a5b" id="r_a0012621c1414f4c7573e961b57884a5b"><td class="memItemLeft" align="right" valign="top"><a id="a0012621c1414f4c7573e961b57884a5b" name="a0012621c1414f4c7573e961b57884a5b"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>AX25Client</b></td></tr>
|
|
<tr class="separator:a0012621c1414f4c7573e961b57884a5b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac0313fe86041eb37d290019203e095d3" id="r_ac0313fe86041eb37d290019203e095d3"><td class="memItemLeft" align="right" valign="top"><a id="ac0313fe86041eb37d290019203e095d3" name="ac0313fe86041eb37d290019203e095d3"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>FSK4Client</b></td></tr>
|
|
<tr class="separator:ac0313fe86041eb37d290019203e095d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af9f435b28f04a142bdf136fc6fdc49b3" id="r_af9f435b28f04a142bdf136fc6fdc49b3"><td class="memItemLeft" align="right" valign="top"><a id="af9f435b28f04a142bdf136fc6fdc49b3" name="af9f435b28f04a142bdf136fc6fdc49b3"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>BellClient</b></td></tr>
|
|
<tr class="separator:af9f435b28f04a142bdf136fc6fdc49b3"><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 audio-based transmissions. Requires Arduino <a class="el" href="class_a_f_s_k_client.html#a6d2341901c83e45f853c077e60f1fa33" title="Start transmitting audio tone.">tone()</a> function, and a module capable of direct mode transmission using DIO pins. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a89c7ab4759d37c9a032ac29fa9782eea" name="a89c7ab4759d37c9a032ac29fa9782eea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a89c7ab4759d37c9a032ac29fa9782eea">◆ </a></span>AFSKClient() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">AFSKClient::AFSKClient </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>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default contructor. </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 pin that will be used for audio output. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac54633fe75157ce126e44e4e494266f2" name="ac54633fe75157ce126e44e4e494266f2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac54633fe75157ce126e44e4e494266f2">◆ </a></span>AFSKClient() <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">AFSKClient::AFSKClient </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>Copy contructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">aud</td><td>Pointer to the <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 to copy. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a30b86bb7cd087b3bc3c45a011ba266c3" name="a30b86bb7cd087b3bc3c45a011ba266c3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a30b86bb7cd087b3bc3c45a011ba266c3">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t AFSKClient::begin </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialization method. </p>
|
|
<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="a664c1de9b5cd792826a5a77ac5457bae" name="a664c1de9b5cd792826a5a77ac5457bae"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a664c1de9b5cd792826a5a77ac5457bae">◆ </a></span>noTone()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t AFSKClient::noTone </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>keepOn</em> = <code>false</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Stops transmitting audio tone. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">keepOn</td><td>Keep transmitter on - this may limit noise when switching transmitter on or off. </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="a6d2341901c83e45f853c077e60f1fa33" name="a6d2341901c83e45f853c077e60f1fa33"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6d2341901c83e45f853c077e60f1fa33">◆ </a></span>tone()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t AFSKClient::tone </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>freq</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>autoStart</em> = <code>true</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Start transmitting audio tone. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">freq</td><td>Frequency of the tone in Hz. </td></tr>
|
|
<tr><td class="paramname">autoStart</td><td>Whether to automatically enter transmission mode. Defaults to true. </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>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/protocols/AFSK/<a class="el" href="_a_f_s_k_8h_source.html">AFSK.h</a></li>
|
|
<li>src/protocols/AFSK/<b>AFSK.cpp</b></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_a_f_s_k_client.html">AFSKClient</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.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|