esp32_BNO08x/documentation/html/_b_n_o08x_8hpp.html

217 lines
13 KiB
HTML
Raw Normal View History

2024-11-18 01:49:14 +00:00
<!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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>esp32_BNO08x: BNO08x.hpp 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>
<script type="text/javascript" src="clipboard.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>
<script type="text/javascript" src="cookie.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">esp32_BNO08x<span id="projectnumber">&#160;1.2</span>
</div>
<div id="projectbrief">C++ BNO08x IMU driver component for esp-idf.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<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');
$(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 */
$(function(){initNavTree('_b_n_o08x_8hpp.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="#nested-classes">Classes</a> </div>
<div class="headertitle"><div class="title">BNO08x.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;inttypes.h&gt;</code><br />
<code>#include &lt;math.h&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;cstring&gt;</code><br />
<code>#include &lt;functional&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &lt;esp_log.h&gt;</code><br />
<code>#include &lt;esp_rom_gpio.h&gt;</code><br />
<code>#include &lt;esp_timer.h&gt;</code><br />
<code>#include &lt;freertos/FreeRTOS.h&gt;</code><br />
<code>#include &lt;freertos/task.h&gt;</code><br />
<code>#include &lt;freertos/event_groups.h&gt;</code><br />
<code>#include &lt;freertos/queue.h&gt;</code><br />
<code>#include &lt;freertos/semphr.h&gt;</code><br />
<code>#include &lt;rom/ets_sys.h&gt;</code><br />
<code>#include &quot;<a class="el" href="_b_n_o08x__global__types_8hpp_source.html">BNO08x_global_types.hpp</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for BNO08x.hpp:</div>
<div class="dyncontent">
<div class="center"><img src="_b_n_o08x_8hpp__incl.png" border="0" usemap="#a_b_n_o08x_8hpp" alt=""/></div>
<map name="a_b_n_o08x_8hpp" id="a_b_n_o08x_8hpp">
<area shape="rect" title=" " alt="" coords="714,5,810,32"/>
<area shape="rect" title=" " alt="" coords="5,80,84,107"/>
<area shape="poly" title=" " alt="" coords="714,25,455,41,280,58,99,82,99,77,280,53,455,36,714,19"/>
<area shape="rect" title=" " alt="" coords="107,80,169,107"/>
<area shape="poly" title=" " alt="" coords="714,25,488,41,339,58,184,82,183,77,338,53,488,36,713,20"/>
<area shape="rect" title=" " alt="" coords="193,80,253,107"/>
<area shape="poly" title=" " alt="" coords="714,26,523,44,398,60,269,82,268,77,397,55,522,38,714,21"/>
<area shape="rect" title=" " alt="" coords="277,80,337,107"/>
<area shape="poly" title=" " alt="" coords="714,27,557,47,353,82,352,77,556,42,713,22"/>
<area shape="rect" title=" " alt="" coords="361,80,437,107"/>
<area shape="poly" title=" " alt="" coords="714,31,453,82,452,77,713,26"/>
<area shape="rect" title=" " alt="" coords="461,80,516,107"/>
<area shape="poly" title=" " alt="" coords="715,34,532,82,530,77,713,29"/>
<area shape="rect" title=" " alt="" coords="541,80,618,107"/>
<area shape="poly" title=" " alt="" coords="731,35,626,76,624,71,729,30"/>
<area shape="rect" title=" " alt="" coords="643,80,756,107"/>
<area shape="poly" title=" " alt="" coords="753,34,722,70,718,66,749,31"/>
<area shape="rect" title=" " alt="" coords="780,80,869,107"/>
<area shape="poly" title=" " alt="" coords="775,31,806,66,802,70,771,34"/>
<area shape="rect" title=" " alt="" coords="893,80,1033,107"/>
<area shape="poly" title=" " alt="" coords="798,30,915,72,913,77,796,35"/>
<area shape="rect" title=" " alt="" coords="1058,80,1162,107"/>
<area shape="poly" title=" " alt="" coords="810,27,1043,75,1042,81,809,33"/>
<area shape="rect" title=" " alt="" coords="1186,80,1341,107"/>
<area shape="poly" title=" " alt="" coords="810,24,1171,76,1170,81,810,30"/>
<area shape="rect" title=" " alt="" coords="1365,80,1479,107"/>
<area shape="poly" title=" " alt="" coords="810,21,1038,41,1350,77,1349,82,1038,47,810,26"/>
<area shape="rect" title=" " alt="" coords="1503,80,1626,107"/>
<area shape="poly" title=" " alt="" coords="810,20,1093,39,1287,56,1488,77,1488,82,1286,61,1093,44,810,25"/>
<area shape="rect" title=" " alt="" coords="1650,80,1754,107"/>
<area shape="poly" title=" " alt="" coords="810,19,1150,34,1388,52,1635,77,1634,82,1388,57,1150,40,810,24"/>
<area shape="rect" href="_b_n_o08x__global__types_8hpp.html" title=" " alt="" coords="1778,80,1954,107"/>
<area shape="poly" title=" " alt="" coords="810,19,1199,38,1476,55,1763,77,1762,82,1475,60,1199,43,810,25"/>
<area shape="rect" title=" " alt="" coords="1681,155,1771,181"/>
<area shape="poly" title=" " alt="" coords="1843,110,1765,149,1763,145,1840,105"/>
<area shape="rect" title=" " alt="" coords="1796,155,1936,181"/>
<area shape="poly" title=" " alt="" coords="1869,107,1869,139,1863,139,1863,107"/>
<area shape="rect" title=" " alt="" coords="1961,155,2091,181"/>
<area shape="poly" title=" " alt="" coords="1895,105,1985,145,1983,150,1893,110"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="_b_n_o08x_8hpp__dep__incl.png" border="0" usemap="#a_b_n_o08x_8hppdep" alt=""/></div>
<map name="a_b_n_o08x_8hppdep" id="a_b_n_o08x_8hppdep">
<area shape="rect" title=" " alt="" coords="273,5,368,32"/>
<area shape="rect" href="_b_n_o08x_8cpp.html" title=" " alt="" coords="198,80,294,107"/>
<area shape="poly" title=" " alt="" coords="299,45,261,82,257,78,295,41"/>
<area shape="rect" href="_b_n_o08x_test_helper_8hpp.html" title=" " alt="" coords="318,80,475,107"/>
<area shape="poly" title=" " alt="" coords="346,41,385,78,382,82,343,45"/>
<area shape="rect" href="_b_n_o08x_test_suite_8hpp.html" title=" " alt="" coords="5,155,156,181"/>
<area shape="poly" title=" " alt="" coords="327,113,136,157,135,151,326,108"/>
<area shape="rect" href="_callback_tests_8cpp.html" title=" " alt="" coords="180,155,309,181"/>
<area shape="poly" title=" " alt="" coords="358,116,272,156,270,152,355,111"/>
<area shape="rect" href="_init_deinit_tests_8cpp.html" title=" " alt="" coords="332,155,461,181"/>
<area shape="poly" title=" " alt="" coords="399,122,399,154,394,154,394,122"/>
<area shape="rect" href="_multi_report_tests_8cpp.html" title=" " alt="" coords="484,155,629,181"/>
<area shape="poly" title=" " alt="" coords="439,111,530,152,527,156,437,116"/>
<area shape="rect" href="_single_report_tests_8cpp.html" title=" " alt="" coords="652,155,805,181"/>
<area shape="poly" title=" " alt="" coords="470,108,671,151,670,157,469,113"/>
</map>
</div>
</div>
<p><a href="_b_n_o08x_8hpp_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 id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x.html">BNO08x</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_b_n_o08x.html" title="BNO08x IMU driver class.">BNO08x</a> IMU driver class. <a href="class_b_n_o08x.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_b_n_o08x_1_1bno08x__rx__packet__t.html">BNO08x::bno08x_rx_packet_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds data that is received over spi. <a href="struct_b_n_o08x_1_1bno08x__rx__packet__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_b_n_o08x_1_1bno08x__tx__packet__t.html">BNO08x::bno08x_tx_packet_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds data that is sent over spi. <a href="struct_b_n_o08x_1_1bno08x__tx__packet__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_b_n_o08x_1_1bno08x__report__period__tracker__t.html">BNO08x::bno08x_report_period_tracker_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_b_n_o08x_1_1bno08x__init__status__t.html">BNO08x::bno08x_init_status_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds info about which functionality has been successfully initialized (used by deconstructor during cleanup). <a href="struct_b_n_o08x_1_1bno08x__init__status__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section author"><dt>Author</dt><dd>Myles Parfeniuk </dd></dl>
</div></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_85e9385bd83516731053aadc7da3c8af.html">imu_update</a></li><li class="navelem"><a class="el" href="dir_c60d9bf80716f90f729fd65c40ec81f7.html">bno08x_update</a></li><li class="navelem"><a class="el" href="dir_fd670e5d11b8bb731501003ff6578ae1.html">components</a></li><li class="navelem"><a class="el" href="dir_a6718ce9703adf4789a693642ffedf7f.html">esp32_BNO08x</a></li><li class="navelem"><a class="el" href="dir_9667f1a5b10a5222433e41df91e1bf5d.html">include</a></li><li class="navelem"><a class="el" href="_b_n_o08x_8hpp.html">BNO08x.hpp</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.10.0 </li>
</ul>
</div>
</body>
</html>