<!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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>RadioLib: src/protocols/APRS/APRS.h Source File</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.8.17 -->
<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');
/* @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('_a_p_r_s_8h_source.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="headertitle">
<div class="title">APRS.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#if !defined(_RADIOLIB_RADIOLIB_APRS_H)</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_RADIOLIB_APRS_H</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "../../TypeDef.h"</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#if !defined(RADIOLIB_EXCLUDE_APRS)</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "../PhysicalLayer/PhysicalLayer.h"</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "../AX25/AX25.h"</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// APRS data type identifiers</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#define RADIOLIB_APRS_DATA_TYPE_POSITION_NO_TIME_NO_MSG "!"</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#define RADIOLIB_APRS_DATA_TYPE_GPS_RAW "$"</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define RADIOLIB_APRS_DATA_TYPE_ITEM ")"</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define RADIOLIB_APRS_DATA_TYPE_TEST ","</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define RADIOLIB_APRS_DATA_TYPE_POSITION_TIME_NO_MSG "/"</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#define RADIOLIB_APRS_DATA_TYPE_MSG ":"</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define RADIOLIB_APRS_DATA_TYPE_OBJECT ";"</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define RADIOLIB_APRS_DATA_TYPE_STATION_CAPABILITES "<"</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define RADIOLIB_APRS_DATA_TYPE_POSITION_NO_TIME_MSG "="</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RADIOLIB_APRS_DATA_TYPE_STATUS ">"</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define RADIOLIB_APRS_DATA_TYPE_QUERY "?"</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define RADIOLIB_APRS_DATA_TYPE_POSITION_TIME_MSG "@"</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define RADIOLIB_APRS_DATA_TYPE_TELEMETRY "T"</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define RADIOLIB_APRS_DATA_TYPE_MAIDENHEAD_BEACON "["</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define RADIOLIB_APRS_DATA_TYPE_WEATHER_REPORT "_"</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#define RADIOLIB_APRS_DATA_TYPE_USER_DEFINED "{"</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#define RADIOLIB_APRS_DATA_TYPE_THIRD_PARTY "}"</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="class_a_p_r_s_client.html"> 35</a></span> <span class="keyword">class </span><a class="code" href="class_a_p_r_s_client.html">APRSClient</a> {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">explicit</span> <a class="code" href="class_a_p_r_s_client.html#a08e166ed706d79c66c1d5b48f195724c">APRSClient</a>(<a class="code" href="class_a_x25_client.html">AX25Client</a>* ax);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="comment">// basic methods</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  int16_t <a class="code" href="class_a_p_r_s_client.html#a4befd17d1f753049f7ec08c48d8b8496">begin</a>(<span class="keywordtype">char</span> symbol, <span class="keywordtype">bool</span> alt = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  int16_t <a class="code" href="class_a_p_r_s_client.html#aebc95b926fb3d37f8489f895aa576d0e">sendPosition</a>(<span class="keywordtype">char</span>* destCallsign, uint8_t destSSID, <span class="keywordtype">char</span>* lat, <span class="keywordtype">char</span>* lon, <span class="keywordtype">char</span>* msg = NULL, <span class="keywordtype">char</span>* time = NULL);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  int16_t <a class="code" href="class_a_p_r_s_client.html#a05076f44e5708f1230894c11053707b1">sendFrame</a>(<span class="keywordtype">char</span>* destCallsign, uint8_t destSSID, <span class="keywordtype">char</span>* info);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="class_a_x25_client.html">AX25Client</a>* _ax;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="comment">// default APRS symbol (car)</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">char</span> _symbol = <span class="charliteral">'>'</span>;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">char</span> _table = <span class="charliteral">'/'</span>;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> };</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclass_a_p_r_s_client_html_a05076f44e5708f1230894c11053707b1"><div class="ttname"><a href="class_a_p_r_s_client.html#a05076f44e5708f1230894c11053707b1">APRSClient::sendFrame</a></div><div class="ttdeci">int16_t sendFrame(char *destCallsign, uint8_t destSSID, char *info)</div><div class="ttdoc">Transmit generic APRS frame.</div><div class="ttdef"><b>Definition:</b> APRS.cpp:57</div></div>
<div class="ttc" id="aclass_a_p_r_s_client_html_a08e166ed706d79c66c1d5b48f195724c"><div class="ttname"><a href="class_a_p_r_s_client.html#a08e166ed706d79c66c1d5b48f195724c">APRSClient::APRSClient</a></div><div class="ttdeci">APRSClient(AX25Client *ax)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> APRS.cpp:3</div></div>
<div class="ttc" id="aclass_a_x25_client_html"><div class="ttname"><a href="class_a_x25_client.html">AX25Client</a></div><div class="ttdoc">Client for AX25 communication.</div><div class="ttdef"><b>Definition:</b> AX25.h:279</div></div>
<div class="ttc" id="aclass_a_p_r_s_client_html_aebc95b926fb3d37f8489f895aa576d0e"><div class="ttname"><a href="class_a_p_r_s_client.html#aebc95b926fb3d37f8489f895aa576d0e">APRSClient::sendPosition</a></div><div class="ttdeci">int16_t sendPosition(char *destCallsign, uint8_t destSSID, char *lat, char *lon, char *msg=NULL, char *time=NULL)</div><div class="ttdoc">Transmit position.</div><div class="ttdef"><b>Definition:</b> APRS.cpp:20</div></div>
<div class="ttc" id="aclass_a_p_r_s_client_html_a4befd17d1f753049f7ec08c48d8b8496"><div class="ttname"><a href="class_a_p_r_s_client.html#a4befd17d1f753049f7ec08c48d8b8496">APRSClient::begin</a></div><div class="ttdeci">int16_t begin(char symbol, bool alt=false)</div><div class="ttdoc">Initialization method.</div><div class="ttdef"><b>Definition:</b> APRS.cpp:7</div></div>
<div class="ttc" id="aclass_a_p_r_s_client_html"><div class="ttname"><a href="class_a_p_r_s_client.html">APRSClient</a></div><div class="ttdoc">Client for APRS communication.</div><div class="ttdef"><b>Definition:</b> APRS.h:35</div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_79690749eba542503bb1a9a3dbb495e1.html">protocols</a></li><li class="navelem"><a class="el" href="dir_dc014d80157d44ffbeb680b891580471.html">APRS</a></li><li class="navelem"><b>APRS.h</b></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>