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

439 lines
21 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: AX25Client 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_a_x25_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="#friends">Friends</a> &#124;
<a href="class_a_x25_client-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">AX25Client Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Client for AX25 communication.
<a href="class_a_x25_client.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_a_x25_8h_source.html">AX25.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:ab074563d4d22a42d5ea9ad1693d6f373" id="r_ab074563d4d22a42d5ea9ad1693d6f373"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_client.html#ab074563d4d22a42d5ea9ad1693d6f373">AX25Client</a> (<a class="el" href="class_physical_layer.html">PhysicalLayer</a> *phy)</td></tr>
<tr class="memdesc:ab074563d4d22a42d5ea9ad1693d6f373"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for 2-FSK mode. <br /></td></tr>
<tr class="separator:ab074563d4d22a42d5ea9ad1693d6f373"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c9244abc270891638312745b301b791" id="r_a9c9244abc270891638312745b301b791"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_client.html#a9c9244abc270891638312745b301b791">AX25Client</a> (<a class="el" href="class_a_f_s_k_client.html">AFSKClient</a> *aud)</td></tr>
<tr class="memdesc:a9c9244abc270891638312745b301b791"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for AFSK mode. <br /></td></tr>
<tr class="separator:a9c9244abc270891638312745b301b791"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af82e0dd3b50d58584e4e4083a53a4419" id="r_af82e0dd3b50d58584e4e4083a53a4419"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_client.html#af82e0dd3b50d58584e4e4083a53a4419">AX25Client</a> (const <a class="el" href="class_a_x25_client.html">AX25Client</a> &amp;ax25)</td></tr>
<tr class="memdesc:af82e0dd3b50d58584e4e4083a53a4419"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <br /></td></tr>
<tr class="separator:af82e0dd3b50d58584e4e4083a53a4419"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad6b806d6f8601ec04d6b11bcde37733" id="r_aad6b806d6f8601ec04d6b11bcde37733"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_a_x25_client.html">AX25Client</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_client.html#aad6b806d6f8601ec04d6b11bcde37733">operator=</a> (const <a class="el" href="class_a_x25_client.html">AX25Client</a> &amp;ax25)</td></tr>
<tr class="memdesc:aad6b806d6f8601ec04d6b11bcde37733"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload for assignment operator. <br /></td></tr>
<tr class="separator:aad6b806d6f8601ec04d6b11bcde37733"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74a43c60c84e4150b9508c83e461d24e" id="r_a74a43c60c84e4150b9508c83e461d24e"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_client.html#a74a43c60c84e4150b9508c83e461d24e">setCorrection</a> (int16_t mark, int16_t space, float length=1.0f)</td></tr>
<tr class="memdesc:a74a43c60c84e4150b9508c83e461d24e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set AFSK tone correction offset. On some platforms, this is required to get the audio produced by the setup to match the expected 1200/2200 Hz tones. <br /></td></tr>
<tr class="separator:a74a43c60c84e4150b9508c83e461d24e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aadeefb210a0b5170d4e8d281c2257e73" id="r_aadeefb210a0b5170d4e8d281c2257e73"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_client.html#aadeefb210a0b5170d4e8d281c2257e73">begin</a> (const char *srcCallsign, uint8_t srcSSID=0x00, uint8_t preLen=8)</td></tr>
<tr class="memdesc:aadeefb210a0b5170d4e8d281c2257e73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialization method. <br /></td></tr>
<tr class="separator:aadeefb210a0b5170d4e8d281c2257e73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a985790943f3f3e06a2dfdd36977d0b98" id="r_a985790943f3f3e06a2dfdd36977d0b98"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_client.html#a985790943f3f3e06a2dfdd36977d0b98">transmit</a> (const char *str, const char *destCallsign, uint8_t destSSID=0x00)</td></tr>
<tr class="memdesc:a985790943f3f3e06a2dfdd36977d0b98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transmit unnumbered information (UI) frame. <br /></td></tr>
<tr class="separator:a985790943f3f3e06a2dfdd36977d0b98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a341db993853c6817a8f6c7087ead0ba6" id="r_a341db993853c6817a8f6c7087ead0ba6"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_client.html#a341db993853c6817a8f6c7087ead0ba6">sendFrame</a> (<a class="el" href="class_a_x25_frame.html">AX25Frame</a> *frame)</td></tr>
<tr class="memdesc:a341db993853c6817a8f6c7087ead0ba6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transmit arbitrary AX.25 frame. <br /></td></tr>
<tr class="separator:a341db993853c6817a8f6c7087ead0ba6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ac7d2ea7e69067b7b4c6492e198505289" id="r_ac7d2ea7e69067b7b4c6492e198505289"><td class="memItemLeft" align="right" valign="top"><a id="ac7d2ea7e69067b7b4c6492e198505289" name="ac7d2ea7e69067b7b4c6492e198505289"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>APRSClient</b></td></tr>
<tr class="separator:ac7d2ea7e69067b7b4c6492e198505289"><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 AX25 communication. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab074563d4d22a42d5ea9ad1693d6f373" name="ab074563d4d22a42d5ea9ad1693d6f373"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab074563d4d22a42d5ea9ad1693d6f373">&#9670;&#160;</a></span>AX25Client() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">AX25Client::AX25Client </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="a9c9244abc270891638312745b301b791" name="a9c9244abc270891638312745b301b791"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c9244abc270891638312745b301b791">&#9670;&#160;</a></span>AX25Client() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">AX25Client::AX25Client </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>aud</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for AFSK mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">aud</td><td>Pointer to the AFSK instance providing audio. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af82e0dd3b50d58584e4e4083a53a4419" name="af82e0dd3b50d58584e4e4083a53a4419"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af82e0dd3b50d58584e4e4083a53a4419">&#9670;&#160;</a></span>AX25Client() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AX25Client::AX25Client </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_a_x25_client.html">AX25Client</a> &amp;&#160;</td>
<td class="paramname"><em>ax25</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ax25</td><td><a class="el" href="class_a_x25_client.html" title="Client for AX25 communication.">AX25Client</a> instance to copy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aadeefb210a0b5170d4e8d281c2257e73" name="aadeefb210a0b5170d4e8d281c2257e73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aadeefb210a0b5170d4e8d281c2257e73">&#9670;&#160;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t AX25Client::begin </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>srcCallsign</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>srcSSID</em> = <code>0x00</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>preLen</em> = <code>8</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">srcCallsign</td><td>Callsign of the source station. </td></tr>
<tr><td class="paramname">srcSSID</td><td>4-bit SSID of the source station (in case there are more stations with the same callsign). Defaults to 0. </td></tr>
<tr><td class="paramname">preLen</td><td>Number of "preamble" bytes (RADIOLIB_AX25_FLAG) sent ahead of the actual AX.25 frame. Does not include the first RADIOLIB_AX25_FLAG byte, which is considered part of the frame. Defaults to 8. </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="aad6b806d6f8601ec04d6b11bcde37733" name="aad6b806d6f8601ec04d6b11bcde37733"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad6b806d6f8601ec04d6b11bcde37733">&#9670;&#160;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_a_x25_client.html">AX25Client</a> &amp; AX25Client::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_a_x25_client.html">AX25Client</a> &amp;&#160;</td>
<td class="paramname"><em>ax25</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Overload for assignment operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ax25</td><td>rvalue <a class="el" href="class_a_x25_client.html" title="Client for AX25 communication.">AX25Client</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a341db993853c6817a8f6c7087ead0ba6" name="a341db993853c6817a8f6c7087ead0ba6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a341db993853c6817a8f6c7087ead0ba6">&#9670;&#160;</a></span>sendFrame()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t AX25Client::sendFrame </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_a_x25_frame.html">AX25Frame</a> *&#160;</td>
<td class="paramname"><em>frame</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Transmit arbitrary AX.25 frame. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">frame</td><td>Frame to be sent. </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="a74a43c60c84e4150b9508c83e461d24e" name="a74a43c60c84e4150b9508c83e461d24e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74a43c60c84e4150b9508c83e461d24e">&#9670;&#160;</a></span>setCorrection()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t AX25Client::setCorrection </td>
<td>(</td>
<td class="paramtype">int16_t&#160;</td>
<td class="paramname"><em>mark</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int16_t&#160;</td>
<td class="paramname"><em>space</em>, </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 AFSK tone correction offset. On some platforms, this is required to get the audio produced by the setup to match the expected 1200/2200 Hz tones. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mark</td><td>Positive or negative correction offset for mark audio frequency in Hz. </td></tr>
<tr><td class="paramname">space</td><td>Positive or negative correction offset for space audio frequency in Hz. </td></tr>
<tr><td class="paramname">length</td><td>Audio 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="a985790943f3f3e06a2dfdd36977d0b98" name="a985790943f3f3e06a2dfdd36977d0b98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a985790943f3f3e06a2dfdd36977d0b98">&#9670;&#160;</a></span>transmit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t AX25Client::transmit </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>destCallsign</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>destSSID</em> = <code>0x00</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Transmit unnumbered information (UI) frame. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>Data to be sent. </td></tr>
<tr><td class="paramname">destCallsign</td><td>Callsign of the destination station. </td></tr>
<tr><td class="paramname">destSSID</td><td>4-bit SSID of the destination station (in case there are more stations with the same callsign). Defaults to 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>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/protocols/AX25/<a class="el" href="_a_x25_8h_source.html">AX25.h</a></li>
<li>src/protocols/AX25/<b>AX25.cpp</b></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_a_x25_client.html">AX25Client</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