forks/RadioLibSmol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
RadioLibSmol/class_hell_client.html
jgromes ad720440ad Deploying to gh-pages from @ a5011914c5 🚀
2025-01-16 17:28:36 +00:00

415 lines
26 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: 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 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_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">
<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_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>
<div class="dynheader">
Inheritance diagram for HellClient:</div>
<div class="dyncontent">
<div class="center">
<img src="class_hell_client.png" usemap="#HellClient_map" alt=""/>
<map id="HellClient_map" name="HellClient_map">
<area href="class_radio_lib_print.html" title="Printing class, based on Arduino Print class with additional encodings." alt="RadioLibPrint" shape="rect" coords="0,0,87,24"/>
</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:a6e3ed5db1904f3f9602e20c3c0d0cbd0" id="r_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. <br /></td></tr>
<tr class="separator:a6e3ed5db1904f3f9602e20c3c0d0cbd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afeb347f04148700427ad40614fd057c3" id="r_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. <br /></td></tr>
<tr class="separator:afeb347f04148700427ad40614fd057c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a225775fe87f9ed3c3a04142697641242" id="r_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. <br /></td></tr>
<tr class="separator:a225775fe87f9ed3c3a04142697641242"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68c4a74910756ad251e626a0b4c8c267" id="r_a68c4a74910756ad251e626a0b4c8c267"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_hell_client.html#a68c4a74910756ad251e626a0b4c8c267">printGlyph</a> (const uint8_t *buff)</td></tr>
<tr class="memdesc:a68c4a74910756ad251e626a0b4c8c267"><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. <br /></td></tr>
<tr class="separator:a68c4a74910756ad251e626a0b4c8c267"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae43025b9d55ee21a322bb5d7ee1065b0" id="r_ae43025b9d55ee21a322bb5d7ee1065b0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_hell_client.html#ae43025b9d55ee21a322bb5d7ee1065b0">setInversion</a> (bool inv)</td></tr>
<tr class="memdesc:ae43025b9d55ee21a322bb5d7ee1065b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invert text color. <br /></td></tr>
<tr class="separator:ae43025b9d55ee21a322bb5d7ee1065b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af557774ad72c24a94faff8c2be30f0d1" id="r_af557774ad72c24a94faff8c2be30f0d1"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_hell_client.html#af557774ad72c24a94faff8c2be30f0d1">write</a> (uint8_t b) override</td></tr>
<tr class="memdesc:af557774ad72c24a94faff8c2be30f0d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write one byte. Implementation of interface of the RadioLibPrint/Print class. <br /></td></tr>
<tr class="separator:af557774ad72c24a94faff8c2be30f0d1"><td class="memSeparator" colspan="2">&#160;</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="-"/>&#160;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" id="r_a6e1803a39074e658e54931f13bd2d641"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:a1543d3565013e22448385a4d1799ada9 inherit pub_methods_class_radio_lib_print" id="r_a1543d3565013e22448385a4d1799ada9"><td class="memItemLeft" align="right" valign="top">
virtual size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:ad2c5435bea28e97f4893002f01549c80 inherit pub_methods_class_radio_lib_print" id="r_ad2c5435bea28e97f4893002f01549c80"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:aa2ac029ea08cf28ebcc3abd52e19164f inherit pub_methods_class_radio_lib_print" id="r_aa2ac029ea08cf28ebcc3abd52e19164f"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>print</b> (<a class="el" href="class_i_t_a2_string.html">ITA2String</a> &amp;ita2)</td></tr>
<tr class="separator:aa2ac029ea08cf28ebcc3abd52e19164f inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1f386ce4a8fa5b10eb72f7d8854e292 inherit pub_methods_class_radio_lib_print" id="r_ab1f386ce4a8fa5b10eb72f7d8854e292"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>println</b> (<a class="el" href="class_i_t_a2_string.html">ITA2String</a> &amp;ita2)</td></tr>
<tr class="separator:ab1f386ce4a8fa5b10eb72f7d8854e292 inherit pub_methods_class_radio_lib_print"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9aa1fb490af4bd22aabc6687c4d082af inherit pub_methods_class_radio_lib_print" id="r_a9aa1fb490af4bd22aabc6687c4d082af"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:aaecbc6db0a6312a186f5eef774be5ad2 inherit pub_methods_class_radio_lib_print" id="r_aaecbc6db0a6312a186f5eef774be5ad2"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:a02b4c3892a70d7bc0868e74622e4a97e inherit pub_methods_class_radio_lib_print" id="r_a02b4c3892a70d7bc0868e74622e4a97e"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:af2211384921ec34cce7257f729fff60d inherit pub_methods_class_radio_lib_print" id="r_af2211384921ec34cce7257f729fff60d"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:aecfc38ba379bc123ea7e07e47de801e9 inherit pub_methods_class_radio_lib_print" id="r_aecfc38ba379bc123ea7e07e47de801e9"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:a7a4c5fc3fbe7c78a2739dfd5b2648a11 inherit pub_methods_class_radio_lib_print" id="r_a7a4c5fc3fbe7c78a2739dfd5b2648a11"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:ad2cbd376adf2d4fc949e02c955cf213c inherit pub_methods_class_radio_lib_print" id="r_ad2cbd376adf2d4fc949e02c955cf213c"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:a2e6857e72af3ebca1607ccd5d8201c6c inherit pub_methods_class_radio_lib_print" id="r_a2e6857e72af3ebca1607ccd5d8201c6c"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:abcab0d059987ce8f72e8a99959f1605c inherit pub_methods_class_radio_lib_print" id="r_abcab0d059987ce8f72e8a99959f1605c"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:ac62c6e144cc5f2ab3d2dfa69e304600d inherit pub_methods_class_radio_lib_print" id="r_ac62c6e144cc5f2ab3d2dfa69e304600d"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:ab794539d4769bcf1f0f4d2984b767390 inherit pub_methods_class_radio_lib_print" id="r_ab794539d4769bcf1f0f4d2984b767390"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:a21d43e8baa2efae0651f714b0f61a0ad inherit pub_methods_class_radio_lib_print" id="r_a21d43e8baa2efae0651f714b0f61a0ad"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:a361a76b2f27cb9398d201a4e5efe0358 inherit pub_methods_class_radio_lib_print" id="r_a361a76b2f27cb9398d201a4e5efe0358"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:a9a800f38287c6f292ab0110c6d396a88 inherit pub_methods_class_radio_lib_print" id="r_a9a800f38287c6f292ab0110c6d396a88"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:a0c5d589d814403fb1be6351e1f93f8e8 inherit pub_methods_class_radio_lib_print" id="r_a0c5d589d814403fb1be6351e1f93f8e8"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:a00bbdff41954312512167cb2b799cb01 inherit pub_methods_class_radio_lib_print" id="r_a00bbdff41954312512167cb2b799cb01"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#160;</td></tr>
<tr class="memitem:a2c055b364954957a48a798abe14cdff7 inherit pub_methods_class_radio_lib_print" id="r_a2c055b364954957a48a798abe14cdff7"><td class="memItemLeft" align="right" valign="top">
size_t&#160;</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">&#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" name="a6e3ed5db1904f3f9602e20c3c0d0cbd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e3ed5db1904f3f9602e20c3c0d0cbd0">&#9670;&#160;</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" name="afeb347f04148700427ad40614fd057c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afeb347f04148700427ad40614fd057c3">&#9670;&#160;</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" name="a225775fe87f9ed3c3a04142697641242"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a225775fe87f9ed3c3a04142697641242">&#9670;&#160;</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="a68c4a74910756ad251e626a0b4c8c267" name="a68c4a74910756ad251e626a0b4c8c267"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68c4a74910756ad251e626a0b4c8c267">&#9670;&#160;</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">const 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="ae43025b9d55ee21a322bb5d7ee1065b0" name="ae43025b9d55ee21a322bb5d7ee1065b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae43025b9d55ee21a322bb5d7ee1065b0">&#9670;&#160;</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>inv</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">inv</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>
<a id="af557774ad72c24a94faff8c2be30f0d1" name="af557774ad72c24a94faff8c2be30f0d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af557774ad72c24a94faff8c2be30f0d1">&#9670;&#160;</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 HellClient::write </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</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/Hellschreiber/<a class="el" href="_hellschreiber_8h_source.html">Hellschreiber.h</a></li>
<li>src/protocols/Hellschreiber/<b>Hellschreiber.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_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.8 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink