147 lines
8.8 KiB
HTML
147 lines
8.8 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
<title>Adafruit uBlox Library: Adafruit_UBX.h File 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="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">Adafruit uBlox Library
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<!-- end header part -->
|
||
<!-- Generated by Doxygen 1.8.13 -->
|
||
<script type="text/javascript">
|
||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||
</script>
|
||
<script type="text/javascript" src="menudata.js"></script>
|
||
<script type="text/javascript" src="menu.js"></script>
|
||
<script type="text/javascript">
|
||
$(function() {
|
||
initMenu('',true,false,'search.php','Search');
|
||
$(document).ready(function() { init_search(); });
|
||
});
|
||
</script>
|
||
<div id="main-nav"></div>
|
||
<!-- 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><!-- top -->
|
||
<div class="header">
|
||
<div class="summary">
|
||
<a href="#nested-classes">Classes</a> |
|
||
<a href="#define-members">Macros</a> |
|
||
<a href="#typedef-members">Typedefs</a> </div>
|
||
<div class="headertitle">
|
||
<div class="title">Adafruit_UBX.h File Reference</div> </div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
<div class="textblock"><code>#include "<a class="el" href="_adafruit__u_blox___ubx___messages_8h_source.html">Adafruit_uBlox_Ubx_Messages.h</a>"</code><br />
|
||
<code>#include "<a class="el" href="_adafruit__u_blox__typedef_8h_source.html">Adafruit_uBlox_typedef.h</a>"</code><br />
|
||
<code>#include <Arduino.h></code><br />
|
||
<code>#include <Stream.h></code><br />
|
||
</div>
|
||
<p><a href="_adafruit___u_b_x_8h_source.html">Go to the source code of this file.</a></p>
|
||
<table class="memberdecls">
|
||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
||
Classes</h2></td></tr>
|
||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___u_b_x.html">Adafruit_UBX</a></td></tr>
|
||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class for parsing UBX protocol messages from u-blox GPS/RTK modules. <a href="class_adafruit___u_b_x.html#details">More...</a><br /></td></tr>
|
||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table><table class="memberdecls">
|
||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
||
Macros</h2></td></tr>
|
||
<tr class="memitem:ab9b7171ae257a615aa33d2510e484554"><td class="memItemLeft" align="right" valign="top"><a id="ab9b7171ae257a615aa33d2510e484554"></a>
|
||
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit___u_b_x_8h.html#ab9b7171ae257a615aa33d2510e484554">UBX_SYNC_CHAR_1</a>   0xB5</td></tr>
|
||
<tr class="memdesc:ab9b7171ae257a615aa33d2510e484554"><td class="mdescLeft"> </td><td class="mdescRight">First UBX protocol sync char (<28>) <br /></td></tr>
|
||
<tr class="separator:ab9b7171ae257a615aa33d2510e484554"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a18c4bdc24d4cbedd9214cfc352b6f16c"><td class="memItemLeft" align="right" valign="top"><a id="a18c4bdc24d4cbedd9214cfc352b6f16c"></a>
|
||
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit___u_b_x_8h.html#a18c4bdc24d4cbedd9214cfc352b6f16c">UBX_SYNC_CHAR_2</a>   0x62</td></tr>
|
||
<tr class="memdesc:a18c4bdc24d4cbedd9214cfc352b6f16c"><td class="mdescLeft"> </td><td class="mdescRight">Second UBX protocol sync char (b) <br /></td></tr>
|
||
<tr class="separator:a18c4bdc24d4cbedd9214cfc352b6f16c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a708b6ea6923c64a09c24502cdcac3a9b"><td class="memItemLeft" align="right" valign="top"><a id="a708b6ea6923c64a09c24502cdcac3a9b"></a>
|
||
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit___u_b_x_8h.html#a708b6ea6923c64a09c24502cdcac3a9b">UBX_ACK_NAK</a>   0x00</td></tr>
|
||
<tr class="memdesc:a708b6ea6923c64a09c24502cdcac3a9b"><td class="mdescLeft"> </td><td class="mdescRight">Message Not Acknowledged. <br /></td></tr>
|
||
<tr class="separator:a708b6ea6923c64a09c24502cdcac3a9b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:a9863f96e55b0bd012a94613a086515c7"><td class="memItemLeft" align="right" valign="top"><a id="a9863f96e55b0bd012a94613a086515c7"></a>
|
||
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit___u_b_x_8h.html#a9863f96e55b0bd012a94613a086515c7">UBX_ACK_ACK</a>   0x01</td></tr>
|
||
<tr class="memdesc:a9863f96e55b0bd012a94613a086515c7"><td class="mdescLeft"> </td><td class="mdescRight">Message Acknowledged. <br /></td></tr>
|
||
<tr class="separator:a9863f96e55b0bd012a94613a086515c7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table><table class="memberdecls">
|
||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
||
Typedefs</h2></td></tr>
|
||
<tr class="memitem:a0a0ecf74350f410cba0f0a0efd312d12"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="_adafruit___u_b_x_8h.html#a0a0ecf74350f410cba0f0a0efd312d12">UBXMessageCallback</a>) (uint8_t msgClass, uint8_t msgId, uint16_t payloadLen, uint8_t *payload)</td></tr>
|
||
<tr class="memdesc:a0a0ecf74350f410cba0f0a0efd312d12"><td class="mdescLeft"> </td><td class="mdescRight">Callback function type for UBX messages - defined at global scope so other classes can use it. <a href="#a0a0ecf74350f410cba0f0a0efd312d12">More...</a><br /></td></tr>
|
||
<tr class="separator:a0a0ecf74350f410cba0f0a0efd312d12"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
<div class="textblock"><p>Arduino library for parsing UBX protocol from u-blox GPS/RTK modules.</p>
|
||
<p>This library can use any Stream object as input (UART, DDC, or other).</p>
|
||
<p>Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!</p>
|
||
<p>Written by Limor Fried/Ladyada for Adafruit Industries.</p>
|
||
<p>MIT license, all text here must be included in any redistribution. </p>
|
||
</div><h2 class="groupheader">Typedef Documentation</h2>
|
||
<a id="a0a0ecf74350f410cba0f0a0efd312d12"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#a0a0ecf74350f410cba0f0a0efd312d12">◆ </a></span>UBXMessageCallback</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">typedef void(* UBXMessageCallback) (uint8_t msgClass, uint8_t msgId, uint16_t payloadLen, uint8_t *payload)</td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Callback function type for UBX messages - defined at global scope so other classes can use it. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">msgClass</td><td>Message class </td></tr>
|
||
<tr><td class="paramname">msgId</td><td>Message ID </td></tr>
|
||
<tr><td class="paramname">payloadLen</td><td>Length of payload data </td></tr>
|
||
<tr><td class="paramname">payload</td><td>Pointer to payload data </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
</div>
|
||
</div>
|
||
</div><!-- contents -->
|
||
<!-- start footer part -->
|
||
<hr class="footer"/><address class="footer"><small>
|
||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||
</a> 1.8.13
|
||
</small></address>
|
||
</body>
|
||
</html>
|