esp32_BNO08x/documentation/html/_b_n_o08x_8hpp.html

216 lines
12 KiB
HTML
Raw Normal View 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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>esp32_BNO08x: 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>
<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.01</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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_f8bf4cf9c99e2cbdf74bcfc417d31962.html">esp32_BNO08x</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</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;driver/gpio.h&gt;</code><br />
<code>#include &lt;driver/spi_common.h&gt;</code><br />
<code>#include &lt;driver/spi_master.h&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/semphr.h&gt;</code><br />
<code>#include &lt;freertos/task.h&gt;</code><br />
<code>#include &lt;rom/ets_sys.h&gt;</code><br />
<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 />
</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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__config__t.html">bno08x_config_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">IMU configuration settings passed into constructor. <a href="structbno08x__config__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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x.html">BNO08x</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a648bbdbf22731476890dd8da977d7503" id="r_a648bbdbf22731476890dd8da977d7503"><td class="memItemLeft" align="right" valign="top">typedef struct bno08x_config_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a648bbdbf22731476890dd8da977d7503">bno08x_config_t</a></td></tr>
<tr class="memdesc:a648bbdbf22731476890dd8da977d7503"><td class="mdescLeft">&#160;</td><td class="mdescRight">IMU configuration settings passed into constructor. <br /></td></tr>
<tr class="separator:a648bbdbf22731476890dd8da977d7503"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:aac50a1392dd0aa905500c755148c556b" id="r_aac50a1392dd0aa905500c755148c556b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aac50a1392dd0aa905500c755148c556b">channels_t</a> { <br />
&#160;&#160;<a class="el" href="#aac50a1392dd0aa905500c755148c556ba1cb5955609063cff1ba49147e786e610">CHANNEL_COMMAND</a>
, <a class="el" href="#aac50a1392dd0aa905500c755148c556ba8a5de65712767758887f8fad9523bb72">CHANNEL_EXECUTABLE</a>
, <a class="el" href="#aac50a1392dd0aa905500c755148c556ba6c5ca5e5847c55b469afbb435e15b5f0">CHANNEL_CONTROL</a>
, <a class="el" href="#aac50a1392dd0aa905500c755148c556ba22f0b2ae6fcdc8618a078b0579d09e4a">CHANNEL_REPORTS</a>
, <br />
&#160;&#160;<a class="el" href="#aac50a1392dd0aa905500c755148c556bafbb907d12060466f58dd56d3e2430747">CHANNEL_WAKE_REPORTS</a>
, <a class="el" href="#aac50a1392dd0aa905500c755148c556bafd513a698e54122cec579d9450482832">CHANNEL_GYRO</a>
<br />
}</td></tr>
<tr class="memdesc:aac50a1392dd0aa905500c755148c556b"><td class="mdescLeft">&#160;</td><td class="mdescRight">SHTP protocol channels. <a href="#aac50a1392dd0aa905500c755148c556b">More...</a><br /></td></tr>
<tr class="separator:aac50a1392dd0aa905500c755148c556b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb7d85b4fa619c860031f469261c6279" id="r_adb7d85b4fa619c860031f469261c6279"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adb7d85b4fa619c860031f469261c6279">IMUAccuracy</a> { <a class="el" href="#adb7d85b4fa619c860031f469261c6279a41bc94cbd8eebea13ce0491b2ac11b88">LOW</a> = 1
, <a class="el" href="#adb7d85b4fa619c860031f469261c6279a2ad6d5975c45da2e711c796f3a1b029c">MED</a>
, <a class="el" href="#adb7d85b4fa619c860031f469261c6279ab89de3b4b81c4facfac906edf29aec8c">HIGH</a>
}</td></tr>
<tr class="memdesc:adb7d85b4fa619c860031f469261c6279"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sensor accuracy returned during sensor calibration. <a href="#adb7d85b4fa619c860031f469261c6279">More...</a><br /></td></tr>
<tr class="separator:adb7d85b4fa619c860031f469261c6279"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a648bbdbf22731476890dd8da977d7503" name="a648bbdbf22731476890dd8da977d7503"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a648bbdbf22731476890dd8da977d7503">&#9670;&#160;</a></span>bno08x_config_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct bno08x_config_t bno08x_config_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>IMU configuration settings passed into constructor. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="aac50a1392dd0aa905500c755148c556b" name="aac50a1392dd0aa905500c755148c556b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac50a1392dd0aa905500c755148c556b">&#9670;&#160;</a></span>channels_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="#aac50a1392dd0aa905500c755148c556b">channels_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>SHTP protocol channels. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aac50a1392dd0aa905500c755148c556ba1cb5955609063cff1ba49147e786e610" name="aac50a1392dd0aa905500c755148c556ba1cb5955609063cff1ba49147e786e610"></a>CHANNEL_COMMAND&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aac50a1392dd0aa905500c755148c556ba8a5de65712767758887f8fad9523bb72" name="aac50a1392dd0aa905500c755148c556ba8a5de65712767758887f8fad9523bb72"></a>CHANNEL_EXECUTABLE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aac50a1392dd0aa905500c755148c556ba6c5ca5e5847c55b469afbb435e15b5f0" name="aac50a1392dd0aa905500c755148c556ba6c5ca5e5847c55b469afbb435e15b5f0"></a>CHANNEL_CONTROL&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aac50a1392dd0aa905500c755148c556ba22f0b2ae6fcdc8618a078b0579d09e4a" name="aac50a1392dd0aa905500c755148c556ba22f0b2ae6fcdc8618a078b0579d09e4a"></a>CHANNEL_REPORTS&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aac50a1392dd0aa905500c755148c556bafbb907d12060466f58dd56d3e2430747" name="aac50a1392dd0aa905500c755148c556bafbb907d12060466f58dd56d3e2430747"></a>CHANNEL_WAKE_REPORTS&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aac50a1392dd0aa905500c755148c556bafd513a698e54122cec579d9450482832" name="aac50a1392dd0aa905500c755148c556bafd513a698e54122cec579d9450482832"></a>CHANNEL_GYRO&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<a id="adb7d85b4fa619c860031f469261c6279" name="adb7d85b4fa619c860031f469261c6279"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb7d85b4fa619c860031f469261c6279">&#9670;&#160;</a></span>IMUAccuracy</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum class <a class="el" href="#adb7d85b4fa619c860031f469261c6279">IMUAccuracy</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sensor accuracy returned during sensor calibration. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="adb7d85b4fa619c860031f469261c6279a41bc94cbd8eebea13ce0491b2ac11b88" name="adb7d85b4fa619c860031f469261c6279a41bc94cbd8eebea13ce0491b2ac11b88"></a>LOW&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="adb7d85b4fa619c860031f469261c6279a2ad6d5975c45da2e711c796f3a1b029c" name="adb7d85b4fa619c860031f469261c6279a2ad6d5975c45da2e711c796f3a1b029c"></a>MED&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="adb7d85b4fa619c860031f469261c6279ab89de3b4b81c4facfac906edf29aec8c" name="adb7d85b4fa619c860031f469261c6279ab89de3b4b81c4facfac906edf29aec8c"></a>HIGH&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>