<!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: 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.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('_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"> 35</span> <span class="preprocessor">#define RADIOLIB_APRS_MIC_E_TYPE_OFF_DUTY 0b00000111</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#define RADIOLIB_APRS_MIC_E_TYPE_EN_ROUTE 0b00000110</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#define RADIOLIB_APRS_MIC_E_TYPE_IN_SERVICE 0b00000101</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#define RADIOLIB_APRS_MIC_E_TYPE_RETURNING 0b00000100</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#define RADIOLIB_APRS_MIC_E_TYPE_COMMITTED 0b00000011</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#define RADIOLIB_APRS_MIC_E_TYPE_SPECIAL 0b00000010</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#define RADIOLIB_APRS_MIC_E_TYPE_PRIORITY 0b00000001</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#define RADIOLIB_APRS_MIC_E_TYPE_EMERGENCY 0b00000000</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// magic offset applied to encode extra bits in the Mic-E destination field</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#define RADIOLIB_APRS_MIC_E_DEST_BIT_OFFSET 25</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// Mic-E data types</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#define RADIOLIB_APRS_MIC_E_GPS_DATA_CURRENT '`'</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#define RADIOLIB_APRS_MIC_E_GPS_DATA_OLD '\''</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// Mic-E telemetry flags</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#define RADIOLIB_APRS_MIC_E_TELEMETRY_LEN_2 '`'</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#define RADIOLIB_APRS_MIC_E_TELEMETRY_LEN_5 '\''</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">// alias for unused altitude in Mic-E</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#define RADIOLIB_APRS_MIC_E_ALTITUDE_UNUSED -1000000</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// special header applied for APRS over LoRa</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#define RADIOLIB_APRS_LORA_HEADER "<\xff\x01"</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#define RADIOLIB_APRS_LORA_HEADER_LEN (3)</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="class_a_p_r_s_client.html"> 69</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="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</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="l00076"></a><span class="lineno"> 76</span>  </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</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_physical_layer.html">PhysicalLayer</a>* phy);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">// basic methods</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  int16_t <a class="code" href="class_a_p_r_s_client.html#a4d1468be141940a12fd3964957f79c1a">begin</a>(<span class="keywordtype">char</span> sym, <span class="keywordtype">char</span>* callsign = NULL, uint8_t ssid = 0, <span class="keywordtype">bool</span> alt = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</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="l00106"></a><span class="lineno"> 106</span>  </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  int16_t <a class="code" href="class_a_p_r_s_client.html#af8f28eba026b0f0a25c8ba54a96f4743">sendMicE</a>(<span class="keywordtype">float</span> lat, <span class="keywordtype">float</span> lon, uint16_t heading, uint16_t speed, uint8_t type, uint8_t* telem = NULL, <span class="keywordtype">size_t</span> telemLen = 0, <span class="keywordtype">char</span>* grid = NULL, <span class="keywordtype">char</span>* status = NULL, int32_t alt = RADIOLIB_APRS_MIC_E_ALTITUDE_UNUSED);</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  </div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</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="l00130"></a><span class="lineno"> 130</span>  </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <a class="code" href="class_a_x25_client.html">AX25Client</a>* axClient;</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <a class="code" href="class_physical_layer.html">PhysicalLayer</a>* phyLayer;</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  </div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="comment">// default APRS symbol (car)</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keywordtype">char</span> symbol = <span class="charliteral">'>'</span>;</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keywordtype">char</span> table = <span class="charliteral">'/'</span>;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="comment">// source callsign when using APRS over LoRa</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keywordtype">char</span> src[RADIOLIB_AX25_MAX_CALLSIGN_LEN + 1] = { 0 };</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  uint8_t <span class="keywordtype">id</span> = 0;</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> };</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  </div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  </div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="preprocessor">#endif</span></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:69</div></div>
<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:240</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">Constructor for "classic" mode using AX.25/AFSK.</div><div class="ttdef"><b>Definition:</b> APRS.cpp:7</div></div>
<div class="ttc" id="aclass_a_p_r_s_client_html_a4d1468be141940a12fd3964957f79c1a"><div class="ttname"><a href="class_a_p_r_s_client.html#a4d1468be141940a12fd3964957f79c1a">APRSClient::begin</a></div><div class="ttdeci">int16_t begin(char sym, char *callsign=NULL, uint8_t ssid=0, bool alt=false)</div><div class="ttdoc">Initialization method.</div><div class="ttdef"><b>Definition:</b> APRS.cpp:17</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:37</div></div>
<div class="ttc" id="aclass_a_p_r_s_client_html_af8f28eba026b0f0a25c8ba54a96f4743"><div class="ttname"><a href="class_a_p_r_s_client.html#af8f28eba026b0f0a25c8ba54a96f4743">APRSClient::sendMicE</a></div><div class="ttdeci">int16_t sendMicE(float lat, float lon, uint16_t heading, uint16_t speed, uint8_t type, uint8_t *telem=NULL, size_t telemLen=0, char *grid=NULL, char *status=NULL, int32_t alt=RADIOLIB_APRS_MIC_E_ALTITUDE_UNUSED)</div><div class="ttdoc">Transmit position using Mic-E encoding.</div><div class="ttdef"><b>Definition:</b> APRS.cpp:75</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:238</div></div>
<div class="ttc" id="aclass_physical_layer_html"><div class="ttname"><a href="class_physical_layer.html">PhysicalLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:34</div></div>
</div><!-- fragment --></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="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="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>