forks/RadioLibSmol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
RadioLibSmol/class_f_s_k4_client.html
jgromes a7a571b91e Deploying to gh-pages from @ ff24e2b2ae 🚀
2025-01-18 16:56:37 +00:00

387 lines
18 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: FSK4Client 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&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>
</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('class_f_s_k4_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> &#124;
<a href="class_f_s_k4_client-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">FSK4Client Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Client for FSK-4 communication. The public interface is the same as Arduino Serial.
<a href="class_f_s_k4_client.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_f_s_k4_8h_source.html">FSK4.h</a>&gt;</code></p>
<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:a2cdcea538e5b58e99a23f98ef4a68617" id="r_a2cdcea538e5b58e99a23f98ef4a68617"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_s_k4_client.html#a2cdcea538e5b58e99a23f98ef4a68617">FSK4Client</a> (<a class="el" href="class_physical_layer.html">PhysicalLayer</a> *phy)</td></tr>
<tr class="memdesc:a2cdcea538e5b58e99a23f98ef4a68617"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for FSK-4 mode. <br /></td></tr>
<tr class="separator:a2cdcea538e5b58e99a23f98ef4a68617"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65105b2744c4721b75ca0894c654bf82" id="r_a65105b2744c4721b75ca0894c654bf82"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_s_k4_client.html#a65105b2744c4721b75ca0894c654bf82">FSK4Client</a> (<a class="el" href="class_a_f_s_k_client.html">AFSKClient</a> *audio)</td></tr>
<tr class="memdesc:a65105b2744c4721b75ca0894c654bf82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for AFSK mode. <br /></td></tr>
<tr class="separator:a65105b2744c4721b75ca0894c654bf82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b366b8f3c08f81431d8cc5f907652e9" id="r_a2b366b8f3c08f81431d8cc5f907652e9"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_s_k4_client.html#a2b366b8f3c08f81431d8cc5f907652e9">begin</a> (float base, uint32_t shift, uint16_t rate)</td></tr>
<tr class="memdesc:a2b366b8f3c08f81431d8cc5f907652e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialization method. <br /></td></tr>
<tr class="separator:a2b366b8f3c08f81431d8cc5f907652e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79ca465012acc9223d61d5b063ff8257" id="r_a79ca465012acc9223d61d5b063ff8257"><td class="memItemLeft" align="right" valign="top"><a id="a79ca465012acc9223d61d5b063ff8257" name="a79ca465012acc9223d61d5b063ff8257"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>idle</b> ()</td></tr>
<tr class="memdesc:a79ca465012acc9223d61d5b063ff8257"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send out idle condition (RF tone at mark frequency). <br /></td></tr>
<tr class="separator:a79ca465012acc9223d61d5b063ff8257"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab85cb6519e5448dc332bf17bd60f90a" id="r_aab85cb6519e5448dc332bf17bd60f90a"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_s_k4_client.html#aab85cb6519e5448dc332bf17bd60f90a">setCorrection</a> (int16_t offsets[4], float length=1.0f)</td></tr>
<tr class="memdesc:aab85cb6519e5448dc332bf17bd60f90a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set correction coefficients for frequencies and tone length. <br /></td></tr>
<tr class="separator:aab85cb6519e5448dc332bf17bd60f90a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78ead0e1e85706ae513edbceb2184925" id="r_a78ead0e1e85706ae513edbceb2184925"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_s_k4_client.html#a78ead0e1e85706ae513edbceb2184925">write</a> (const uint8_t *buff, size_t len)</td></tr>
<tr class="memdesc:a78ead0e1e85706ae513edbceb2184925"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transmit binary data. <br /></td></tr>
<tr class="separator:a78ead0e1e85706ae513edbceb2184925"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31218736d4f9a3412ee9009a4c4f5a22" id="r_a31218736d4f9a3412ee9009a4c4f5a22"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_s_k4_client.html#a31218736d4f9a3412ee9009a4c4f5a22">write</a> (uint8_t b)</td></tr>
<tr class="memdesc:a31218736d4f9a3412ee9009a4c4f5a22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transmit a single byte. <br /></td></tr>
<tr class="separator:a31218736d4f9a3412ee9009a4c4f5a22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b5765371ebbf68a21bc0bbfdf9f82ac" id="r_a8b5765371ebbf68a21bc0bbfdf9f82ac"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_s_k4_client.html#a8b5765371ebbf68a21bc0bbfdf9f82ac">standby</a> ()</td></tr>
<tr class="memdesc:a8b5765371ebbf68a21bc0bbfdf9f82ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop transmitting. <br /></td></tr>
<tr class="separator:a8b5765371ebbf68a21bc0bbfdf9f82ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Client for FSK-4 communication. The public interface is the same as Arduino Serial. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2cdcea538e5b58e99a23f98ef4a68617" name="a2cdcea538e5b58e99a23f98ef4a68617"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cdcea538e5b58e99a23f98ef4a68617">&#9670;&#160;</a></span>FSK4Client() <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">FSK4Client::FSK4Client </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_physical_layer.html">PhysicalLayer</a> *&#160;</td>
<td class="paramname"><em>phy</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>Constructor for FSK-4 mode. </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>
</table>
</dd>
</dl>
</div>
</div>
<a id="a65105b2744c4721b75ca0894c654bf82" name="a65105b2744c4721b75ca0894c654bf82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65105b2744c4721b75ca0894c654bf82">&#9670;&#160;</a></span>FSK4Client() <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">FSK4Client::FSK4Client </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_a_f_s_k_client.html">AFSKClient</a> *&#160;</td>
<td class="paramname"><em>audio</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>Constructor for AFSK mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">audio</td><td>Pointer to the AFSK instance providing audio. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2b366b8f3c08f81431d8cc5f907652e9" name="a2b366b8f3c08f81431d8cc5f907652e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b366b8f3c08f81431d8cc5f907652e9">&#9670;&#160;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t FSK4Client::begin </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>base</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>shift</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>rate</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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">base</td><td>Base (space) frequency to be used in MHz (in FSK-4 mode), or the space tone frequency in Hz (in AFSK mode) </td></tr>
<tr><td class="paramname">shift</td><td>Frequency shift between each tone in Hz. </td></tr>
<tr><td class="paramname">rate</td><td>Baud rate to be used during transmission. </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="aab85cb6519e5448dc332bf17bd60f90a" name="aab85cb6519e5448dc332bf17bd60f90a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab85cb6519e5448dc332bf17bd60f90a">&#9670;&#160;</a></span>setCorrection()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t FSK4Client::setCorrection </td>
<td>(</td>
<td class="paramtype">int16_t&#160;</td>
<td class="paramname"><em>offsets</em>[4], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>length</em> = <code>1.0f</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set correction coefficients for frequencies and tone length. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offsets</td><td>Four positive or negative correction offsets for audio frequencies in Hz. </td></tr>
<tr><td class="paramname">length</td><td>Tone length modifier, defaults to 1.0. </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="a8b5765371ebbf68a21bc0bbfdf9f82ac" name="a8b5765371ebbf68a21bc0bbfdf9f82ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b5765371ebbf68a21bc0bbfdf9f82ac">&#9670;&#160;</a></span>standby()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t FSK4Client::standby </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop transmitting. </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="a78ead0e1e85706ae513edbceb2184925" name="a78ead0e1e85706ae513edbceb2184925"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78ead0e1e85706ae513edbceb2184925">&#9670;&#160;</a></span>write() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t FSK4Client::write </td>
<td>(</td>
<td class="paramtype">const uint8_t *&#160;</td>
<td class="paramname"><em>buff</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Transmit binary data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buff</td><td>Buffer to transmit. </td></tr>
<tr><td class="paramname">len</td><td>Number of bytes to transmit. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of transmitted bytes. </dd></dl>
</div>
</div>
<a id="a31218736d4f9a3412ee9009a4c4f5a22" name="a31218736d4f9a3412ee9009a4c4f5a22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31218736d4f9a3412ee9009a4c4f5a22">&#9670;&#160;</a></span>write() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t FSK4Client::write </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>b</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Transmit a single byte. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">b</td><td>Byte to transmit. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of transmitted bytes. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/protocols/FSK4/<a class="el" href="_f_s_k4_8h_source.html">FSK4.h</a></li>
<li>src/protocols/FSK4/<b>FSK4.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_f_s_k4_client.html">FSK4Client</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>
Reference in a new issue View git blame Copy permalink