forks/RadioLibSmol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
RadioLibSmol/class_hell_client.html
jgromes 676ee7d2bc Deploying to gh-pages from @ 9c019a58e7 🚀
2023-04-10 15:26:40 +00:00

352 lines
20 KiB
HTML
Raw 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">
<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: HellClient 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&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('class_hell_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> &#124;
<a href="class_hell_client-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">HellClient Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Client for Hellschreiber transmissions.
<a href="class_hell_client.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_hellschreiber_8h_source.html">Hellschreiber.h</a>&gt;</code></p>
<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:a6e3ed5db1904f3f9602e20c3c0d0cbd0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_hell_client.html#a6e3ed5db1904f3f9602e20c3c0d0cbd0">HellClient</a> (<a class="el" href="class_physical_layer.html">PhysicalLayer</a> *phy)</td></tr>
<tr class="memdesc:a6e3ed5db1904f3f9602e20c3c0d0cbd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for 2-FSK mode. <a href="class_hell_client.html#a6e3ed5db1904f3f9602e20c3c0d0cbd0">More...</a><br /></td></tr>
<tr class="separator:a6e3ed5db1904f3f9602e20c3c0d0cbd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afeb347f04148700427ad40614fd057c3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_hell_client.html#afeb347f04148700427ad40614fd057c3">HellClient</a> (<a class="el" href="class_a_f_s_k_client.html">AFSKClient</a> *audio)</td></tr>
<tr class="memdesc:afeb347f04148700427ad40614fd057c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for AFSK mode. <a href="class_hell_client.html#afeb347f04148700427ad40614fd057c3">More...</a><br /></td></tr>
<tr class="separator:afeb347f04148700427ad40614fd057c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a225775fe87f9ed3c3a04142697641242"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_hell_client.html#a225775fe87f9ed3c3a04142697641242">begin</a> (float base, float rate=122.5)</td></tr>
<tr class="memdesc:a225775fe87f9ed3c3a04142697641242"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialization method. <a href="class_hell_client.html#a225775fe87f9ed3c3a04142697641242">More...</a><br /></td></tr>
<tr class="separator:a225775fe87f9ed3c3a04142697641242"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac527806ef871dc12555afe7c43a72ed9"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_hell_client.html#ac527806ef871dc12555afe7c43a72ed9">printGlyph</a> (uint8_t *buff)</td></tr>
<tr class="memdesc:ac527806ef871dc12555afe7c43a72ed9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Method to "print" a buffer of pixels, this is exposed to allow users to send custom characters. <a href="class_hell_client.html#ac527806ef871dc12555afe7c43a72ed9">More...</a><br /></td></tr>
<tr class="separator:ac527806ef871dc12555afe7c43a72ed9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1779f13c8052c2392a1f2f0e1164343e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_hell_client.html#a1779f13c8052c2392a1f2f0e1164343e">setInversion</a> (bool invert)</td></tr>
<tr class="memdesc:a1779f13c8052c2392a1f2f0e1164343e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invert text color. <a href="class_hell_client.html#a1779f13c8052c2392a1f2f0e1164343e">More...</a><br /></td></tr>
<tr class="separator:a1779f13c8052c2392a1f2f0e1164343e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad82abc52034fafdea84c15530039a6f5"><td class="memItemLeft" align="right" valign="top"><a id="ad82abc52034fafdea84c15530039a6f5"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>write</b> (const char *str)</td></tr>
<tr class="separator:ad82abc52034fafdea84c15530039a6f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a472555cea11854700db91843c335bded"><td class="memItemLeft" align="right" valign="top"><a id="a472555cea11854700db91843c335bded"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>write</b> (uint8_t *buff, size_t len)</td></tr>
<tr class="separator:a472555cea11854700db91843c335bded"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c5117dadbe33da1cda5fd4981b405eb"><td class="memItemLeft" align="right" valign="top"><a id="a5c5117dadbe33da1cda5fd4981b405eb"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>write</b> (uint8_t b)</td></tr>
<tr class="separator:a5c5117dadbe33da1cda5fd4981b405eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6a4e522a21ffd337de213f7f5ead190"><td class="memItemLeft" align="right" valign="top"><a id="aa6a4e522a21ffd337de213f7f5ead190"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>print</b> (const char[])</td></tr>
<tr class="separator:aa6a4e522a21ffd337de213f7f5ead190"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96110fc9b723c92455e0427d4fc7563f"><td class="memItemLeft" align="right" valign="top"><a id="a96110fc9b723c92455e0427d4fc7563f"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>print</b> (char)</td></tr>
<tr class="separator:a96110fc9b723c92455e0427d4fc7563f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dcf129b97dda7cd7f343344dabfa2ec"><td class="memItemLeft" align="right" valign="top"><a id="a0dcf129b97dda7cd7f343344dabfa2ec"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned char, int=DEC)</td></tr>
<tr class="separator:a0dcf129b97dda7cd7f343344dabfa2ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b47e81258fd838dc8c587daad9c75ef"><td class="memItemLeft" align="right" valign="top"><a id="a0b47e81258fd838dc8c587daad9c75ef"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>print</b> (int, int=DEC)</td></tr>
<tr class="separator:a0b47e81258fd838dc8c587daad9c75ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed7039049b21c0ae5acf650449f6d001"><td class="memItemLeft" align="right" valign="top"><a id="aed7039049b21c0ae5acf650449f6d001"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned int, int=DEC)</td></tr>
<tr class="separator:aed7039049b21c0ae5acf650449f6d001"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3fa4949b30186a215bcdc4eedb8ef7a"><td class="memItemLeft" align="right" valign="top"><a id="ac3fa4949b30186a215bcdc4eedb8ef7a"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>print</b> (long, int=DEC)</td></tr>
<tr class="separator:ac3fa4949b30186a215bcdc4eedb8ef7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a079475eb50465c6b9c8e5e568648925d"><td class="memItemLeft" align="right" valign="top"><a id="a079475eb50465c6b9c8e5e568648925d"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>print</b> (unsigned long, int=DEC)</td></tr>
<tr class="separator:a079475eb50465c6b9c8e5e568648925d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41acb11ec5afacce7217d94a038442b6"><td class="memItemLeft" align="right" valign="top"><a id="a41acb11ec5afacce7217d94a038442b6"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>print</b> (double, int=2)</td></tr>
<tr class="separator:a41acb11ec5afacce7217d94a038442b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeded114263fcd3c023a5a7b177041449"><td class="memItemLeft" align="right" valign="top"><a id="aeded114263fcd3c023a5a7b177041449"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>println</b> (void)</td></tr>
<tr class="separator:aeded114263fcd3c023a5a7b177041449"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c8af8fbfefda966f5400d06dfa10d76"><td class="memItemLeft" align="right" valign="top"><a id="a9c8af8fbfefda966f5400d06dfa10d76"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>println</b> (const char[])</td></tr>
<tr class="separator:a9c8af8fbfefda966f5400d06dfa10d76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f6a25662f28c525fb8ed727358890ea"><td class="memItemLeft" align="right" valign="top"><a id="a3f6a25662f28c525fb8ed727358890ea"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>println</b> (char)</td></tr>
<tr class="separator:a3f6a25662f28c525fb8ed727358890ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd39423e75134b2587983418a6a37682"><td class="memItemLeft" align="right" valign="top"><a id="afd39423e75134b2587983418a6a37682"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned char, int=DEC)</td></tr>
<tr class="separator:afd39423e75134b2587983418a6a37682"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5be90660b3fa491fcfa80609b8f29f56"><td class="memItemLeft" align="right" valign="top"><a id="a5be90660b3fa491fcfa80609b8f29f56"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>println</b> (int, int=DEC)</td></tr>
<tr class="separator:a5be90660b3fa491fcfa80609b8f29f56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7eab91507bf0413563c097cfca5196f"><td class="memItemLeft" align="right" valign="top"><a id="ac7eab91507bf0413563c097cfca5196f"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned int, int=DEC)</td></tr>
<tr class="separator:ac7eab91507bf0413563c097cfca5196f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a236dc21d338d36fd3b7130fe2c46e85e"><td class="memItemLeft" align="right" valign="top"><a id="a236dc21d338d36fd3b7130fe2c46e85e"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>println</b> (long, int=DEC)</td></tr>
<tr class="separator:a236dc21d338d36fd3b7130fe2c46e85e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72ee891123decbb2d883b8c120e30c18"><td class="memItemLeft" align="right" valign="top"><a id="a72ee891123decbb2d883b8c120e30c18"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>println</b> (unsigned long, int=DEC)</td></tr>
<tr class="separator:a72ee891123decbb2d883b8c120e30c18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad929fdea641afb17dd56cfcc6e47a438"><td class="memItemLeft" align="right" valign="top"><a id="ad929fdea641afb17dd56cfcc6e47a438"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>println</b> (double, int=2)</td></tr>
<tr class="separator:ad929fdea641afb17dd56cfcc6e47a438"><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 Hellschreiber transmissions. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a6e3ed5db1904f3f9602e20c3c0d0cbd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e3ed5db1904f3f9602e20c3c0d0cbd0">&#9670;&nbsp;</a></span>HellClient() <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">HellClient::HellClient </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 2-FSK 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="afeb347f04148700427ad40614fd057c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afeb347f04148700427ad40614fd057c3">&#9670;&nbsp;</a></span>HellClient() <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">HellClient::HellClient </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="a225775fe87f9ed3c3a04142697641242"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a225775fe87f9ed3c3a04142697641242">&#9670;&nbsp;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t HellClient::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">float&#160;</td>
<td class="paramname"><em>rate</em> = <code>122.5</code>&#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 RF frequency to be used in MHz (in 2-FSK mode), or the tone frequency in Hz (in AFSK mode).</td></tr>
<tr><td class="paramname">rate</td><td>Baud rate to be used during transmission. Defaults to 122.5 ("Feld Hell") </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac527806ef871dc12555afe7c43a72ed9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac527806ef871dc12555afe7c43a72ed9">&#9670;&nbsp;</a></span>printGlyph()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t HellClient::printGlyph </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>buff</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Method to "print" a buffer of pixels, this is exposed to allow users to send custom characters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buff</td><td>Buffer of pixels to send, in a 7x7 pixel array.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Always returns the number of printed glyphs (1). </dd></dl>
</div>
</div>
<a id="a1779f13c8052c2392a1f2f0e1164343e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1779f13c8052c2392a1f2f0e1164343e">&#9670;&nbsp;</a></span>setInversion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HellClient::setInversion </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>invert</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Invert text color. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">invert</td><td>Whether to enable color inversion (white text on black background), or not (black text on white background) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/protocols/Hellschreiber/<a class="el" href="_hellschreiber_8h_source.html">Hellschreiber.h</a></li>
<li>src/protocols/Hellschreiber/Hellschreiber.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_hell_client.html">HellClient</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>
Reference in a new issue View git blame Copy permalink