419 lines
36 KiB
HTML
419 lines
36 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" 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: BNO08xRptGravity Class 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"> 1.3</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&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&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&dn=expat.txt MIT */
|
|
$(function(){initNavTree('class_b_n_o08x_rpt_gravity.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="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="#pri-static-attribs">Static Private Attributes</a> |
|
|
<a href="class_b_n_o08x_rpt_gravity-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">BNO08xRptGravity Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Class to represent gravity reports. (See Ref. Manual 6.5.11)
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_b_n_o08x_rpt_gravity_8hpp_source.html">BNO08xRptGravity.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for BNO08xRptGravity:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_b_n_o08x_rpt_gravity__inherit__graph.png" border="0" usemap="#a_b_n_o08x_rpt_gravity_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="a_b_n_o08x_rpt_gravity_inherit__map" id="a_b_n_o08x_rpt_gravity_inherit__map">
|
|
<area shape="rect" title="Class to represent gravity reports. (See Ref. Manual 6.5.11)" alt="" coords="5,80,136,107"/>
|
|
<area shape="rect" href="class_b_n_o08x_rpt.html" title="Class to represent and manage reports returned from BNO08x." alt="" coords="25,5,116,32"/>
|
|
<area shape="poly" title=" " alt="" coords="73,48,73,80,68,80,68,48"/>
|
|
</map>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for BNO08xRptGravity:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_b_n_o08x_rpt_gravity__coll__graph.png" border="0" usemap="#a_b_n_o08x_rpt_gravity_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="a_b_n_o08x_rpt_gravity_coll__map" id="a_b_n_o08x_rpt_gravity_coll__map">
|
|
<area shape="rect" title="Class to represent gravity reports. (See Ref. Manual 6.5.11)" alt="" coords="106,203,236,229"/>
|
|
<area shape="rect" href="class_b_n_o08x_rpt.html" title="Class to represent and manage reports returned from BNO08x." alt="" coords="32,112,123,139"/>
|
|
<area shape="poly" title=" " alt="" coords="103,147,159,200,156,204,100,151"/>
|
|
<area shape="rect" href="struct_b_n_o08x_private_types_1_1bno08x__sync__ctx__t.html" title="Holds context used to synchronize tasks and callback execution." alt="" coords="5,5,150,48"/>
|
|
<area shape="poly" title=" " alt="" coords="80,64,80,112,75,112,75,64"/>
|
|
<area shape="rect" href="structbno08x__accel__t.html" title="Struct to represent acceleration data from acceleration, linear acceleration, and gravity reports." alt="" coords="147,112,259,139"/>
|
|
<area shape="poly" title=" " alt="" coords="196,154,178,203,173,201,191,152"/>
|
|
</map>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<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:a472ced1c466461f64dda3d9132813dba" id="r_a472ced1c466461f64dda3d9132813dba"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a472ced1c466461f64dda3d9132813dba">BNO08xRptGravity</a> (uint8_t <a class="el" href="class_b_n_o08x_rpt.html#a63cd4ac9e96baa43eebe580f03307512">ID</a>, EventBits_t <a class="el" href="class_b_n_o08x_rpt.html#ae78feab5682a4697c5acad3ca6f12c2e">rpt_bit</a>, <a class="el" href="struct_b_n_o08x_private_types_1_1bno08x__sync__ctx__t.html">BNO08xPrivateTypes::bno08x_sync_ctx_t</a> *<a class="el" href="class_b_n_o08x_rpt.html#a5a1404a08918d66bb0f41f55220db6e5">sync_ctx</a>)</td></tr>
|
|
<tr class="separator:a472ced1c466461f64dda3d9132813dba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a18ebbe93997c3ea985290e5b8fc23115" id="r_a18ebbe93997c3ea985290e5b8fc23115"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbno08x__accel__t.html">bno08x_accel_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a18ebbe93997c3ea985290e5b8fc23115">get</a> ()</td></tr>
|
|
<tr class="memdesc:a18ebbe93997c3ea985290e5b8fc23115"><td class="mdescLeft"> </td><td class="mdescRight">Grabs most recent gravity data, units are in m/s^2. <br /></td></tr>
|
|
<tr class="separator:a18ebbe93997c3ea985290e5b8fc23115"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_b_n_o08x_rpt"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_b_n_o08x_rpt')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_b_n_o08x_rpt.html">BNO08xRpt</a></td></tr>
|
|
<tr class="memitem:a3012b77fd80f2c34e57d5a23299f1470 inherit pub_methods_class_b_n_o08x_rpt" id="r_a3012b77fd80f2c34e57d5a23299f1470"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a3012b77fd80f2c34e57d5a23299f1470">enable</a> (uint32_t time_between_reports, sh2_SensorConfig_t sensor_cfg=<a class="el" href="namespace_b_n_o08x_private_types.html#a4f68e627c3c54e471ec83756b97924da">BNO08xPrivateTypes::default_sensor_cfg</a>)</td></tr>
|
|
<tr class="memdesc:a3012b77fd80f2c34e57d5a23299f1470 inherit pub_methods_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight">Enables a sensor report such that the <a class="el" href="class_b_n_o08x.html" title="BNO08x IMU driver class.">BNO08x</a> begins sending it. <br /></td></tr>
|
|
<tr class="separator:a3012b77fd80f2c34e57d5a23299f1470 inherit pub_methods_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d147e7540a4c6aa19749844e14cdadc inherit pub_methods_class_b_n_o08x_rpt" id="r_a7d147e7540a4c6aa19749844e14cdadc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a7d147e7540a4c6aa19749844e14cdadc">disable</a> (sh2_SensorConfig_t sensor_cfg=<a class="el" href="namespace_b_n_o08x_private_types.html#a4f68e627c3c54e471ec83756b97924da">BNO08xPrivateTypes::default_sensor_cfg</a>)</td></tr>
|
|
<tr class="memdesc:a7d147e7540a4c6aa19749844e14cdadc inherit pub_methods_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight">Disables a sensor report by setting its period to 0us such that the <a class="el" href="class_b_n_o08x.html" title="BNO08x IMU driver class.">BNO08x</a> stops sending it. <br /></td></tr>
|
|
<tr class="separator:a7d147e7540a4c6aa19749844e14cdadc inherit pub_methods_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b542b28c81fcd05cf2e3f3d2d437d46 inherit pub_methods_class_b_n_o08x_rpt" id="r_a5b542b28c81fcd05cf2e3f3d2d437d46"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a5b542b28c81fcd05cf2e3f3d2d437d46">register_cb</a> (std::function< void(void)> cb_fxn)</td></tr>
|
|
<tr class="memdesc:a5b542b28c81fcd05cf2e3f3d2d437d46 inherit pub_methods_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight">Registers a callback to execute when new data from a specific report is received. <br /></td></tr>
|
|
<tr class="separator:a5b542b28c81fcd05cf2e3f3d2d437d46 inherit pub_methods_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74f6037286b51382535bab61680297ed inherit pub_methods_class_b_n_o08x_rpt" id="r_a74f6037286b51382535bab61680297ed"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a74f6037286b51382535bab61680297ed">has_new_data</a> ()</td></tr>
|
|
<tr class="memdesc:a74f6037286b51382535bab61680297ed inherit pub_methods_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a new report has been received since the last time this function was called. <br /></td></tr>
|
|
<tr class="separator:a74f6037286b51382535bab61680297ed inherit pub_methods_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab3bb962696b135841ef7313bc631fc72 inherit pub_methods_class_b_n_o08x_rpt" id="r_ab3bb962696b135841ef7313bc631fc72"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#ab3bb962696b135841ef7313bc631fc72">flush</a> ()</td></tr>
|
|
<tr class="memdesc:ab3bb962696b135841ef7313bc631fc72 inherit pub_methods_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight">Flush all buffered reports for this sensor/report module. <br /></td></tr>
|
|
<tr class="separator:ab3bb962696b135841ef7313bc631fc72 inherit pub_methods_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7ce8e48cadf59f49068af7f1cb680b38 inherit pub_methods_class_b_n_o08x_rpt" id="r_a7ce8e48cadf59f49068af7f1cb680b38"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a7ce8e48cadf59f49068af7f1cb680b38">get_sample_counts</a> (<a class="el" href="structbno08x__sample__counts__t.html">bno08x_sample_counts_t</a> &sample_counts)</td></tr>
|
|
<tr class="memdesc:a7ce8e48cadf59f49068af7f1cb680b38 inherit pub_methods_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight">Gets sample counts for this sensor (see SH-2 ref manual 6.4.3.1) <br /></td></tr>
|
|
<tr class="separator:a7ce8e48cadf59f49068af7f1cb680b38 inherit pub_methods_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1418be33824d3102dbc8f92558a402a6 inherit pub_methods_class_b_n_o08x_rpt" id="r_a1418be33824d3102dbc8f92558a402a6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a1418be33824d3102dbc8f92558a402a6">clear_sample_counts</a> ()</td></tr>
|
|
<tr class="memdesc:a1418be33824d3102dbc8f92558a402a6 inherit pub_methods_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight">Clears <a class="el" href="class_b_n_o08x.html" title="BNO08x IMU driver class.">BNO08x</a> internal sample counts for this sensor. (see SH-2 ref manual 6.4.3.1) <br /></td></tr>
|
|
<tr class="separator:a1418be33824d3102dbc8f92558a402a6 inherit pub_methods_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad5b054279b01204f61b4c0408acf51cf inherit pub_methods_class_b_n_o08x_rpt" id="r_ad5b054279b01204f61b4c0408acf51cf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#ad5b054279b01204f61b4c0408acf51cf">get_meta_data</a> (<a class="el" href="structbno08x__meta__data__t.html">bno08x_meta_data_t</a> &meta_data)</td></tr>
|
|
<tr class="memdesc:ad5b054279b01204f61b4c0408acf51cf inherit pub_methods_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves meta data for this sensor/report by reading respective record in FRS (flash record system). <br /></td></tr>
|
|
<tr class="separator:ad5b054279b01204f61b4c0408acf51cf inherit pub_methods_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
|
|
Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a47a5d1d8f89834662efaaae60a74b4c2" id="r_a47a5d1d8f89834662efaaae60a74b4c2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a47a5d1d8f89834662efaaae60a74b4c2">update_data</a> (sh2_SensorValue_t *sensor_val) override</td></tr>
|
|
<tr class="memdesc:a47a5d1d8f89834662efaaae60a74b4c2"><td class="mdescLeft"> </td><td class="mdescRight">Updates gravity data from decoded sensor event. <br /></td></tr>
|
|
<tr class="separator:a47a5d1d8f89834662efaaae60a74b4c2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:ab9fddb16529de63f82d04b29503e7dbe" id="r_ab9fddb16529de63f82d04b29503e7dbe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbno08x__accel__t.html">bno08x_accel_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab9fddb16529de63f82d04b29503e7dbe">data</a></td></tr>
|
|
<tr class="separator:ab9fddb16529de63f82d04b29503e7dbe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-static-attribs" name="pri-static-attribs"></a>
|
|
Static Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a03dfa109a427c7657a2a5bdd3b5af68c" id="r_a03dfa109a427c7657a2a5bdd3b5af68c"><td class="memItemLeft" align="right" valign="top">static const constexpr char * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a03dfa109a427c7657a2a5bdd3b5af68c">TAG</a> = "BNO08xRptGravity"</td></tr>
|
|
<tr class="separator:a03dfa109a427c7657a2a5bdd3b5af68c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pro_methods_class_b_n_o08x_rpt"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_methods_class_b_n_o08x_rpt')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_b_n_o08x_rpt.html">BNO08xRpt</a></td></tr>
|
|
<tr class="memitem:a15e8eebe3fe90ac19837e3860c76374c inherit pro_methods_class_b_n_o08x_rpt" id="r_a15e8eebe3fe90ac19837e3860c76374c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a15e8eebe3fe90ac19837e3860c76374c">BNO08xRpt</a> (uint8_t <a class="el" href="class_b_n_o08x_rpt.html#a63cd4ac9e96baa43eebe580f03307512">ID</a>, EventBits_t <a class="el" href="class_b_n_o08x_rpt.html#ae78feab5682a4697c5acad3ca6f12c2e">rpt_bit</a>, <a class="el" href="struct_b_n_o08x_private_types_1_1bno08x__sync__ctx__t.html">BNO08xPrivateTypes::bno08x_sync_ctx_t</a> *<a class="el" href="class_b_n_o08x_rpt.html#a5a1404a08918d66bb0f41f55220db6e5">sync_ctx</a>)</td></tr>
|
|
<tr class="memdesc:a15e8eebe3fe90ac19837e3860c76374c inherit pro_methods_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_b_n_o08x_rpt.html" title="Class to represent and manage reports returned from BNO08x.">BNO08xRpt</a> report constructor. <br /></td></tr>
|
|
<tr class="separator:a15e8eebe3fe90ac19837e3860c76374c inherit pro_methods_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a61e3451e93806e1b7eaf5f1387726765 inherit pro_methods_class_b_n_o08x_rpt" id="r_a61e3451e93806e1b7eaf5f1387726765"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a61e3451e93806e1b7eaf5f1387726765">unlock_sh2_HAL</a> ()</td></tr>
|
|
<tr class="memdesc:a61e3451e93806e1b7eaf5f1387726765 inherit pro_methods_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight">Unlocks sh2 HAL lib to allow other tasks to call its APIs. <br /></td></tr>
|
|
<tr class="separator:a61e3451e93806e1b7eaf5f1387726765 inherit pro_methods_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a5619a74c1237c5abde2e4bd6619d12 inherit pro_methods_class_b_n_o08x_rpt" id="r_a7a5619a74c1237c5abde2e4bd6619d12"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a7a5619a74c1237c5abde2e4bd6619d12">lock_sh2_HAL</a> ()</td></tr>
|
|
<tr class="memdesc:a7a5619a74c1237c5abde2e4bd6619d12 inherit pro_methods_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight">Locks sh2 HAL lib to only allow the calling task to call its APIs. <br /></td></tr>
|
|
<tr class="separator:a7a5619a74c1237c5abde2e4bd6619d12 inherit pro_methods_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a26bacc572187119339ec248bb4e7d6f3 inherit pro_methods_class_b_n_o08x_rpt" id="r_a26bacc572187119339ec248bb4e7d6f3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a26bacc572187119339ec248bb4e7d6f3">unlock_user_data</a> ()</td></tr>
|
|
<tr class="memdesc:a26bacc572187119339ec248bb4e7d6f3 inherit pro_methods_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight">Unlocks user data to allow other tasks to read/modify it. <br /></td></tr>
|
|
<tr class="separator:a26bacc572187119339ec248bb4e7d6f3 inherit pro_methods_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48e7b1a2c2ebc6b1f2f292735c0832a0 inherit pro_methods_class_b_n_o08x_rpt" id="r_a48e7b1a2c2ebc6b1f2f292735c0832a0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a48e7b1a2c2ebc6b1f2f292735c0832a0">lock_user_data</a> ()</td></tr>
|
|
<tr class="memdesc:a48e7b1a2c2ebc6b1f2f292735c0832a0 inherit pro_methods_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight">Locks locks user data to only allow the calling task to read/modify it. <br /></td></tr>
|
|
<tr class="separator:a48e7b1a2c2ebc6b1f2f292735c0832a0 inherit pro_methods_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47a623eb0a1db51af76a03a103c32329 inherit pro_methods_class_b_n_o08x_rpt" id="r_a47a623eb0a1db51af76a03a103c32329"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a47a623eb0a1db51af76a03a103c32329">signal_data_available</a> ()</td></tr>
|
|
<tr class="memdesc:a47a623eb0a1db51af76a03a103c32329 inherit pro_methods_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight">Signals to <a class="el" href="class_b_n_o08x.html#a367d525d1c0ba119b3dca3067bb5bccc" title="Polls for new data/report to become available.">BNO08x::data_available()</a> that a new report has arrived. <br /></td></tr>
|
|
<tr class="separator:a47a623eb0a1db51af76a03a103c32329 inherit pro_methods_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_attribs_class_b_n_o08x_rpt"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_class_b_n_o08x_rpt')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_b_n_o08x_rpt.html">BNO08xRpt</a></td></tr>
|
|
<tr class="memitem:a63cd4ac9e96baa43eebe580f03307512 inherit pro_attribs_class_b_n_o08x_rpt" id="r_a63cd4ac9e96baa43eebe580f03307512"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a63cd4ac9e96baa43eebe580f03307512">ID</a></td></tr>
|
|
<tr class="memdesc:a63cd4ac9e96baa43eebe580f03307512 inherit pro_attribs_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight">Report ID, ex. SH2_ACCELERATION. <br /></td></tr>
|
|
<tr class="separator:a63cd4ac9e96baa43eebe580f03307512 inherit pro_attribs_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae78feab5682a4697c5acad3ca6f12c2e inherit pro_attribs_class_b_n_o08x_rpt" id="r_ae78feab5682a4697c5acad3ca6f12c2e"><td class="memItemLeft" align="right" valign="top">EventBits_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#ae78feab5682a4697c5acad3ca6f12c2e">rpt_bit</a></td></tr>
|
|
<tr class="memdesc:ae78feab5682a4697c5acad3ca6f12c2e inherit pro_attribs_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight">Respective enable and data bit for report in evt_grp_rpt_en and evt_grp_rpt_data. <br /></td></tr>
|
|
<tr class="separator:ae78feab5682a4697c5acad3ca6f12c2e inherit pro_attribs_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d4d6f4cc6f1eae503863eedf7fb9f52 inherit pro_attribs_class_b_n_o08x_rpt" id="r_a1d4d6f4cc6f1eae503863eedf7fb9f52"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a1d4d6f4cc6f1eae503863eedf7fb9f52">period_us</a></td></tr>
|
|
<tr class="memdesc:a1d4d6f4cc6f1eae503863eedf7fb9f52 inherit pro_attribs_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight">The period/interval of the report in microseconds. <br /></td></tr>
|
|
<tr class="separator:a1d4d6f4cc6f1eae503863eedf7fb9f52 inherit pro_attribs_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a1404a08918d66bb0f41f55220db6e5 inherit pro_attribs_class_b_n_o08x_rpt" id="r_a5a1404a08918d66bb0f41f55220db6e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_b_n_o08x_private_types_1_1bno08x__sync__ctx__t.html">BNO08xPrivateTypes::bno08x_sync_ctx_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a5a1404a08918d66bb0f41f55220db6e5">sync_ctx</a></td></tr>
|
|
<tr class="separator:a5a1404a08918d66bb0f41f55220db6e5 inherit pro_attribs_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_static_attribs_class_b_n_o08x_rpt"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_static_attribs_class_b_n_o08x_rpt')"><img src="closed.png" alt="-"/> Static Protected Attributes inherited from <a class="el" href="class_b_n_o08x_rpt.html">BNO08xRpt</a></td></tr>
|
|
<tr class="memitem:a201aeb71fefb0d9d485914176a82dd80 inherit pro_static_attribs_class_b_n_o08x_rpt" id="r_a201aeb71fefb0d9d485914176a82dd80"><td class="memItemLeft" align="right" valign="top">static const constexpr float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a201aeb71fefb0d9d485914176a82dd80">RAD_2_DEG</a></td></tr>
|
|
<tr class="memdesc:a201aeb71fefb0d9d485914176a82dd80 inherit pro_static_attribs_class_b_n_o08x_rpt"><td class="mdescLeft"> </td><td class="mdescRight">Constant for radian to degree conversions, sed in quaternion to euler function conversions. <br /></td></tr>
|
|
<tr class="separator:a201aeb71fefb0d9d485914176a82dd80 inherit pro_static_attribs_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c57f370fb08b793bb10ec22d5acca45 inherit pro_static_attribs_class_b_n_o08x_rpt" id="r_a2c57f370fb08b793bb10ec22d5acca45"><td class="memItemLeft" align="right" valign="top">static const constexpr char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a2c57f370fb08b793bb10ec22d5acca45">TAG</a> = "BNO08xRpt"</td></tr>
|
|
<tr class="separator:a2c57f370fb08b793bb10ec22d5acca45 inherit pro_static_attribs_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Class to represent gravity reports. (See Ref. Manual 6.5.11) </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a472ced1c466461f64dda3d9132813dba" name="a472ced1c466461f64dda3d9132813dba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a472ced1c466461f64dda3d9132813dba">◆ </a></span>BNO08xRptGravity()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">BNO08xRptGravity::BNO08xRptGravity </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t</td> <td class="paramname"><span class="paramname"><em>ID</em>, </span></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">EventBits_t</td> <td class="paramname"><span class="paramname"><em>rpt_bit</em>, </span></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_b_n_o08x_private_types_1_1bno08x__sync__ctx__t.html">BNO08xPrivateTypes::bno08x_sync_ctx_t</a> *</td> <td class="paramname"><span class="paramname"><em>sync_ctx</em></span> )</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="a18ebbe93997c3ea985290e5b8fc23115" name="a18ebbe93997c3ea985290e5b8fc23115"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a18ebbe93997c3ea985290e5b8fc23115">◆ </a></span>get()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structbno08x__accel__t.html">bno08x_accel_t</a> BNO08xRptGravity::get </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Grabs most recent gravity data, units are in m/s^2. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Struct containing requested data. </dd></dl>
|
|
<div class="dynheader">
|
|
Here is the call graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_b_n_o08x_rpt_gravity_a18ebbe93997c3ea985290e5b8fc23115_cgraph.png" border="0" usemap="#aclass_b_n_o08x_rpt_gravity_a18ebbe93997c3ea985290e5b8fc23115_cgraph" alt=""/></div>
|
|
<map name="aclass_b_n_o08x_rpt_gravity_a18ebbe93997c3ea985290e5b8fc23115_cgraph" id="aclass_b_n_o08x_rpt_gravity_a18ebbe93997c3ea985290e5b8fc23115_cgraph">
|
|
<area shape="rect" title="Grabs most recent gravity data, units are in m/s^2." alt="" coords="5,31,162,57"/>
|
|
<area shape="rect" href="class_b_n_o08x_rpt.html#a48e7b1a2c2ebc6b1f2f292735c0832a0" title="Locks locks user data to only allow the calling task to read/modify it." alt="" coords="217,5,403,32"/>
|
|
<area shape="poly" title=" " alt="" coords="162,33,201,28,202,33,162,38"/>
|
|
<area shape="rect" href="class_b_n_o08x_rpt.html#a26bacc572187119339ec248bb4e7d6f3" title="Unlocks user data to allow other tasks to read/modify it." alt="" coords="210,56,410,83"/>
|
|
<area shape="poly" title=" " alt="" coords="162,50,195,54,194,59,162,55"/>
|
|
</map>
|
|
</div>
|
|
<div class="dynheader">
|
|
Here is the caller graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_b_n_o08x_rpt_gravity_a18ebbe93997c3ea985290e5b8fc23115_icgraph.png" border="0" usemap="#aclass_b_n_o08x_rpt_gravity_a18ebbe93997c3ea985290e5b8fc23115_icgraph" alt=""/></div>
|
|
<map name="aclass_b_n_o08x_rpt_gravity_a18ebbe93997c3ea985290e5b8fc23115_icgraph" id="aclass_b_n_o08x_rpt_gravity_a18ebbe93997c3ea985290e5b8fc23115_icgraph">
|
|
<area shape="rect" title="Grabs most recent gravity data, units are in m/s^2." alt="" coords="150,81,306,108"/>
|
|
<area shape="rect" href="_single_report_tests_8cpp.html#ab9b4ae43e33572d90c4c889452cd91ee" title=" " alt="" coords="5,5,102,32"/>
|
|
<area shape="poly" title=" " alt="" coords="180,77,85,35,87,30,182,72"/>
|
|
<area shape="rect" href="_multi_report_tests_8cpp.html#a3c5bb20df427689d78fceefd3dad0ddd" title=" " alt="" coords="5,56,102,83"/>
|
|
<area shape="poly" title=" " alt="" coords="134,84,102,79,103,74,135,78"/>
|
|
<area shape="rect" href="_multi_report_tests_8cpp.html#ac0f2ca513b0adc3db58d954b1fa381e9" title=" " alt="" coords="5,107,102,133"/>
|
|
<area shape="poly" title=" " alt="" coords="135,111,103,116,102,110,134,106"/>
|
|
<area shape="rect" href="_callback_tests_8cpp.html#adc348440748fec8fed1a66213f0be52f" title=" " alt="" coords="5,157,102,184"/>
|
|
<area shape="poly" title=" " alt="" coords="182,117,87,159,85,154,180,112"/>
|
|
</map>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a47a5d1d8f89834662efaaae60a74b4c2" name="a47a5d1d8f89834662efaaae60a74b4c2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a47a5d1d8f89834662efaaae60a74b4c2">◆ </a></span>update_data()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BNO08xRptGravity::update_data </td>
|
|
<td>(</td>
|
|
<td class="paramtype">sh2_SensorValue_t *</td> <td class="paramname"><span class="paramname"><em>sensor_val</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">private</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Updates gravity data from decoded sensor event. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sensor_val</td><td>The sh2_SensorValue_t struct used in sh2_decodeSensorEvent() call.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>void, nothing to return </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="class_b_n_o08x_rpt.html#a970fb7e7d3745c62fec626f0ccf0759f">BNO08xRpt</a>.</p>
|
|
<div class="dynheader">
|
|
Here is the call graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_b_n_o08x_rpt_gravity_a47a5d1d8f89834662efaaae60a74b4c2_cgraph.png" border="0" usemap="#aclass_b_n_o08x_rpt_gravity_a47a5d1d8f89834662efaaae60a74b4c2_cgraph" alt=""/></div>
|
|
<map name="aclass_b_n_o08x_rpt_gravity_a47a5d1d8f89834662efaaae60a74b4c2_cgraph" id="aclass_b_n_o08x_rpt_gravity_a47a5d1d8f89834662efaaae60a74b4c2_cgraph">
|
|
<area shape="rect" title="Updates gravity data from decoded sensor event." alt="" coords="5,64,215,91"/>
|
|
<area shape="rect" href="class_b_n_o08x_rpt.html#a48e7b1a2c2ebc6b1f2f292735c0832a0" title="Locks locks user data to only allow the calling task to read/modify it." alt="" coords="270,5,456,32"/>
|
|
<area shape="poly" title=" " alt="" coords="170,61,287,33,288,39,171,66"/>
|
|
<area shape="rect" href="class_b_n_o08x_rpt.html#a47a623eb0a1db51af76a03a103c32329" title="Signals to BNO08x::data_available() that a new report has arrived." alt="" coords="281,56,445,99"/>
|
|
<area shape="poly" title=" " alt="" coords="215,75,265,75,265,80,215,80"/>
|
|
<area shape="rect" href="class_b_n_o08x_rpt.html#a26bacc572187119339ec248bb4e7d6f3" title="Unlocks user data to allow other tasks to read/modify it." alt="" coords="263,123,463,149"/>
|
|
<area shape="poly" title=" " alt="" coords="171,89,288,116,287,121,170,94"/>
|
|
</map>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="ab9fddb16529de63f82d04b29503e7dbe" name="ab9fddb16529de63f82d04b29503e7dbe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab9fddb16529de63f82d04b29503e7dbe">◆ </a></span>data</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__accel__t.html">bno08x_accel_t</a> BNO08xRptGravity::data</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a03dfa109a427c7657a2a5bdd3b5af68c" name="a03dfa109a427c7657a2a5bdd3b5af68c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a03dfa109a427c7657a2a5bdd3b5af68c">◆ </a></span>TAG</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const constexpr char* BNO08xRptGravity::TAG = "BNO08xRptGravity"</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="_b_n_o08x_rpt_gravity_8hpp_source.html">BNO08xRptGravity.hpp</a></li>
|
|
<li><a class="el" href="_b_n_o08x_rpt_gravity_8cpp.html">BNO08xRptGravity.cpp</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="class_b_n_o08x_rpt_gravity.html">BNO08xRptGravity</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>
|