esp32_BNO08x/docs/structbno08x__shake__detect...

243 lines
11 KiB
HTML

<!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=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>esp32_BNO08x: bno08x_shake_detector_t Struct 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="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 id="projectrow">
<td id="projectalign">
<div id="projectname">esp32_BNO08x<span id="projectnumber">&#160;1.4</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.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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');
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('structbno08x__shake__detector__t.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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structbno08x__shake__detector__t-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">bno08x_shake_detector_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Struct to represent shake detector data (flag meaning: 0 = no shake 1 = shake detected)
<a href="structbno08x__shake__detector__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_b_n_o08x_global_types_8hpp_source.html">BNO08xGlobalTypes.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a57df670bfdac6a4174c986a65a0340be"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__shake__detector__t.html#a57df670bfdac6a4174c986a65a0340be">bno08x_shake_detector_t</a> ()</td></tr>
<tr class="separator:a57df670bfdac6a4174c986a65a0340be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7fe349111b513b2cd042ad98112791b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbno08x__shake__detector__t.html">bno08x_shake_detector_t</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__shake__detector__t.html#a7fe349111b513b2cd042ad98112791b7">operator=</a> (const sh2_ShakeDetector_t &amp;source)</td></tr>
<tr class="separator:a7fe349111b513b2cd042ad98112791b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a24dc1df9bb8089c330865e26054a349e"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__shake__detector__t.html#a24dc1df9bb8089c330865e26054a349e">x_flag</a></td></tr>
<tr class="separator:a24dc1df9bb8089c330865e26054a349e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a814745b5a1dd7aa6bb4bfde4981d1caa"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__shake__detector__t.html#a814745b5a1dd7aa6bb4bfde4981d1caa">y_flag</a></td></tr>
<tr class="separator:a814745b5a1dd7aa6bb4bfde4981d1caa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b833f57fc85173adecf666ec6d5477e"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__shake__detector__t.html#a7b833f57fc85173adecf666ec6d5477e">z_flag</a></td></tr>
<tr class="separator:a7b833f57fc85173adecf666ec6d5477e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac643f6c9ac9144c37765b22912212860"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_b_n_o08x_global_types_8hpp.html#a6bdf6fea6d671c12413d95f36a3e7ba6">BNO08xAccuracy</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__shake__detector__t.html#ac643f6c9ac9144c37765b22912212860">accuracy</a></td></tr>
<tr class="separator:ac643f6c9ac9144c37765b22912212860"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Struct to represent shake detector data (flag meaning: 0 = no shake 1 = shake detected) </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a57df670bfdac6a4174c986a65a0340be" name="a57df670bfdac6a4174c986a65a0340be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57df670bfdac6a4174c986a65a0340be">&#9670;&nbsp;</a></span>bno08x_shake_detector_t()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bno08x_shake_detector_t::bno08x_shake_detector_t </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7fe349111b513b2cd042ad98112791b7" name="a7fe349111b513b2cd042ad98112791b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7fe349111b513b2cd042ad98112791b7">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structbno08x__shake__detector__t.html">bno08x_shake_detector_t</a> &amp; bno08x_shake_detector_t::operator= </td>
<td>(</td>
<td class="paramtype">const sh2_ShakeDetector_t &amp;&#160;</td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac643f6c9ac9144c37765b22912212860" name="ac643f6c9ac9144c37765b22912212860"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac643f6c9ac9144c37765b22912212860">&#9670;&nbsp;</a></span>accuracy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_b_n_o08x_global_types_8hpp.html#a6bdf6fea6d671c12413d95f36a3e7ba6">BNO08xAccuracy</a> bno08x_shake_detector_t::accuracy</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a24dc1df9bb8089c330865e26054a349e" name="a24dc1df9bb8089c330865e26054a349e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24dc1df9bb8089c330865e26054a349e">&#9670;&nbsp;</a></span>x_flag</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t bno08x_shake_detector_t::x_flag</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a814745b5a1dd7aa6bb4bfde4981d1caa" name="a814745b5a1dd7aa6bb4bfde4981d1caa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a814745b5a1dd7aa6bb4bfde4981d1caa">&#9670;&nbsp;</a></span>y_flag</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t bno08x_shake_detector_t::y_flag</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7b833f57fc85173adecf666ec6d5477e" name="a7b833f57fc85173adecf666ec6d5477e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b833f57fc85173adecf666ec6d5477e">&#9670;&nbsp;</a></span>z_flag</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t bno08x_shake_detector_t::z_flag</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/media/develop/git/imu_pr_cleanup/components/esp32_BNO08x/include/<a class="el" href="_b_n_o08x_global_types_8hpp_source.html">BNO08xGlobalTypes.hpp</a></li>
</ul>
</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="structbno08x__shake__detector__t.html">bno08x_shake_detector_t</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.9.4 </li>
</ul>
</div>
</body>
</html>