kopia lustrzana https://github.com/jgromes/RadioLib
482 wiersze
29 KiB
HTML
482 wiersze
29 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: MorseClient 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_morse_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-static-methods">Static Public Member Functions</a> |
|
|
<a href="class_morse_client-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">MorseClient Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Client for Morse Code communication. The public interface is the same as Arduino Serial.
|
|
<a href="class_morse_client.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_morse_8h_source.html">Morse.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for MorseClient:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_morse_client.png" usemap="#MorseClient_map" alt=""/>
|
|
<map id="MorseClient_map" name="MorseClient_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 name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aeade3a433da40e6a9f28688f2e6e3b5a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_morse_client.html#aeade3a433da40e6a9f28688f2e6e3b5a">MorseClient</a> (<a class="el" href="class_physical_layer.html">PhysicalLayer</a> *phy)</td></tr>
|
|
<tr class="memdesc:aeade3a433da40e6a9f28688f2e6e3b5a"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for 2-FSK mode. <a href="class_morse_client.html#aeade3a433da40e6a9f28688f2e6e3b5a">More...</a><br /></td></tr>
|
|
<tr class="separator:aeade3a433da40e6a9f28688f2e6e3b5a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa5c8ec6823388877b7acfa0deab689a2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_morse_client.html#aa5c8ec6823388877b7acfa0deab689a2">MorseClient</a> (<a class="el" href="class_a_f_s_k_client.html">AFSKClient</a> *audio)</td></tr>
|
|
<tr class="memdesc:aa5c8ec6823388877b7acfa0deab689a2"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for AFSK mode. <a href="class_morse_client.html#aa5c8ec6823388877b7acfa0deab689a2">More...</a><br /></td></tr>
|
|
<tr class="separator:aa5c8ec6823388877b7acfa0deab689a2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a516f19bb51b87ead7f7ed149f2ca92cf"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_morse_client.html#a516f19bb51b87ead7f7ed149f2ca92cf">begin</a> (float base, uint8_t speed=20)</td></tr>
|
|
<tr class="memdesc:a516f19bb51b87ead7f7ed149f2ca92cf"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. <a href="class_morse_client.html#a516f19bb51b87ead7f7ed149f2ca92cf">More...</a><br /></td></tr>
|
|
<tr class="separator:a516f19bb51b87ead7f7ed149f2ca92cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3c718208786f8fe55f30eee990ec28e3"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_morse_client.html#a3c718208786f8fe55f30eee990ec28e3">startSignal</a> ()</td></tr>
|
|
<tr class="memdesc:a3c718208786f8fe55f30eee990ec28e3"><td class="mdescLeft"> </td><td class="mdescRight">Send start signal. <a href="class_morse_client.html#a3c718208786f8fe55f30eee990ec28e3">More...</a><br /></td></tr>
|
|
<tr class="separator:a3c718208786f8fe55f30eee990ec28e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a77eab03be04ef2d693348d9580ee5d3c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_morse_client.html#a77eab03be04ef2d693348d9580ee5d3c">read</a> (uint8_t *symbol, uint8_t *len, float low=0.75f, float high=1.25f)</td></tr>
|
|
<tr class="memdesc:a77eab03be04ef2d693348d9580ee5d3c"><td class="mdescLeft"> </td><td class="mdescRight">Read Morse tone on input pin. <a href="class_morse_client.html#a77eab03be04ef2d693348d9580ee5d3c">More...</a><br /></td></tr>
|
|
<tr class="separator:a77eab03be04ef2d693348d9580ee5d3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd37869212f3338eb7c95c6f16dadbba"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_morse_client.html#abd37869212f3338eb7c95c6f16dadbba">write</a> (uint8_t b)</td></tr>
|
|
<tr class="memdesc:abd37869212f3338eb7c95c6f16dadbba"><td class="mdescLeft"> </td><td class="mdescRight">Write one byte. Implementation of interface of the RadioLibPrint/Print class. <a href="class_morse_client.html#abd37869212f3338eb7c95c6f16dadbba">More...</a><br /></td></tr>
|
|
<tr class="separator:abd37869212f3338eb7c95c6f16dadbba"><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-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:abd1515c8e6c3ddade280be53f612ece7"><td class="memItemLeft" align="right" valign="top">static char </td><td class="memItemRight" valign="bottom"><a class="el" href="class_morse_client.html#abd1515c8e6c3ddade280be53f612ece7">decode</a> (uint8_t symbol, uint8_t len)</td></tr>
|
|
<tr class="memdesc:abd1515c8e6c3ddade280be53f612ece7"><td class="mdescLeft"> </td><td class="mdescRight">Decode Morse symbol to ASCII. <a href="class_morse_client.html#abd1515c8e6c3ddade280be53f612ece7">More...</a><br /></td></tr>
|
|
<tr class="separator:abd1515c8e6c3ddade280be53f612ece7"><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 Morse Code communication. The public interface is the same as Arduino Serial. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="aeade3a433da40e6a9f28688f2e6e3b5a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeade3a433da40e6a9f28688f2e6e3b5a">◆ </a></span>MorseClient() <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">MorseClient::MorseClient </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_physical_layer.html">PhysicalLayer</a> * </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="aa5c8ec6823388877b7acfa0deab689a2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa5c8ec6823388877b7acfa0deab689a2">◆ </a></span>MorseClient() <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">MorseClient::MorseClient </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_a_f_s_k_client.html">AFSKClient</a> * </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="a516f19bb51b87ead7f7ed149f2ca92cf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a516f19bb51b87ead7f7ed149f2ca92cf">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t MorseClient::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>base</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>speed</em> = <code>20</code> </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">speed</td><td>Coding speed in words per minute. </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="abd1515c8e6c3ddade280be53f612ece7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd1515c8e6c3ddade280be53f612ece7">◆ </a></span>decode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char MorseClient::decode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>symbol</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>len</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">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Decode Morse symbol to ASCII. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">symbol</td><td>Morse code symbol, represented as outlined in MorseTable. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Symbol length (number of dots and dashes). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>ASCII character matching the symbol, or 0xFF if no match is found. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a77eab03be04ef2d693348d9580ee5d3c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a77eab03be04ef2d693348d9580ee5d3c">◆ </a></span>read()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int MorseClient::read </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>symbol</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>low</em> = <code>0.75f</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>high</em> = <code>1.25f</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read Morse tone on input pin. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">symbol</td><td>Pointer to the symbol buffer. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Pointer to the length counter. </td></tr>
|
|
<tr><td class="paramname">low</td><td>Low threshold for decision limit (dot length, pause length etc.), defaults to 0.75. </td></tr>
|
|
<tr><td class="paramname">high</td><td>High threshold for decision limit (dot length, pause length etc.), defaults to 1.25. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if not enough symbols were decoded, 1 if inter-character space was detected, 2 if inter-word space was detected. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3c718208786f8fe55f30eee990ec28e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3c718208786f8fe55f30eee990ec28e3">◆ </a></span>startSignal()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t MorseClient::startSignal </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send start signal. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes sent (always 0). </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abd37869212f3338eb7c95c6f16dadbba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd37869212f3338eb7c95c6f16dadbba">◆ </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 MorseClient::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">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/Morse/<a class="el" href="_morse_8h_source.html">Morse.h</a></li>
|
|
<li>src/protocols/Morse/Morse.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_morse_client.html">MorseClient</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>
|