433 lines
40 KiB
HTML
433 lines
40 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: BNO08xRptUncalMagnetometer 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>
|
|
<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"> 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&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&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&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('class_b_n_o08x_rpt_uncal_magnetometer.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> |
|
|
<a href="class_b_n_o08x_rpt_uncal_magnetometer-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">BNO08xRptUncalMagnetometer Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Class to represent uncalibrated magnetometer reports. (See Ref. Manual 6.5.17)
|
|
<a href="class_b_n_o08x_rpt_uncal_magnetometer.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_b_n_o08x_rpt_uncal_magnetometer_8hpp_source.html">report/BNO08xRptUncalMagnetometer.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for BNO08xRptUncalMagnetometer:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_b_n_o08x_rpt_uncal_magnetometer__inherit__graph.png" border="0" usemap="#a_b_n_o08x_rpt_uncal_magnetometer_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="a_b_n_o08x_rpt_uncal_magnetometer_inherit__map" id="a_b_n_o08x_rpt_uncal_magnetometer_inherit__map">
|
|
<area shape="rect" title="Class to represent uncalibrated magnetometer reports. (See Ref. Manual 6.5.17)" alt="" coords="5,80,236,107"/>
|
|
<area shape="rect" href="class_b_n_o08x_rpt.html" title="Class to represent and manage reports returned from BNO08x." alt="" coords="72,5,169,32"/>
|
|
</map>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for BNO08xRptUncalMagnetometer:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_b_n_o08x_rpt_uncal_magnetometer__coll__graph.png" border="0" usemap="#a_b_n_o08x_rpt_uncal_magnetometer_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="a_b_n_o08x_rpt_uncal_magnetometer_coll__map" id="a_b_n_o08x_rpt_uncal_magnetometer_coll__map">
|
|
<area shape="rect" title="Class to represent uncalibrated magnetometer reports. (See Ref. Manual 6.5.17)" alt="" coords="5,185,236,212"/>
|
|
<area shape="rect" href="class_b_n_o08x_rpt.html" title="Class to represent and manage reports returned from BNO08x." alt="" coords="72,109,169,136"/>
|
|
<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="41,5,200,47"/>
|
|
</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:a8ac1f7e58879febd738b85a8035411a0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt_uncal_magnetometer.html#a8ac1f7e58879febd738b85a8035411a0">BNO08xRptUncalMagnetometer</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:a8ac1f7e58879febd738b85a8035411a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a80ae48107ca1cc27551fd799625f2867"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt_uncal_magnetometer.html#a80ae48107ca1cc27551fd799625f2867">enable</a> (uint32_t time_between_reports, sh2_SensorConfig_t sensor_cfg=BNO08xPrivateTypes::default_sensor_cfg) override</td></tr>
|
|
<tr class="memdesc:a80ae48107ca1cc27551fd799625f2867"><td class="mdescLeft"> </td><td class="mdescRight">Enables uncalibrated magnetometer reports such that the <a class="el" href="class_b_n_o08x.html" title="BNO08x IMU driver class.">BNO08x</a> begins sending them. <a href="class_b_n_o08x_rpt_uncal_magnetometer.html#a80ae48107ca1cc27551fd799625f2867">More...</a><br /></td></tr>
|
|
<tr class="separator:a80ae48107ca1cc27551fd799625f2867"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad4d5abc8875955b6236bbe526be1e8fb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt_uncal_magnetometer.html#ad4d5abc8875955b6236bbe526be1e8fb">get</a> (<a class="el" href="structbno08x__magf__t.html">bno08x_magf_t</a> &magf, <a class="el" href="structbno08x__magf__bias__t.html">bno08x_magf_bias_t</a> &bias)</td></tr>
|
|
<tr class="memdesc:ad4d5abc8875955b6236bbe526be1e8fb"><td class="mdescLeft"> </td><td class="mdescRight">Grabs most recent uncalibrated magnetometer data, units are in uTesla. <a href="class_b_n_o08x_rpt_uncal_magnetometer.html#ad4d5abc8875955b6236bbe526be1e8fb">More...</a><br /></td></tr>
|
|
<tr class="separator:ad4d5abc8875955b6236bbe526be1e8fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae5a99ef7523dcafc4638a538e141306b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbno08x__magf__t.html">bno08x_magf_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt_uncal_magnetometer.html#ae5a99ef7523dcafc4638a538e141306b">get_magf</a> ()</td></tr>
|
|
<tr class="memdesc:ae5a99ef7523dcafc4638a538e141306b"><td class="mdescLeft"> </td><td class="mdescRight">Grabs most recent uncalibrated magnetometer magnetic field data, units are in uTesla. <a href="class_b_n_o08x_rpt_uncal_magnetometer.html#ae5a99ef7523dcafc4638a538e141306b">More...</a><br /></td></tr>
|
|
<tr class="separator:ae5a99ef7523dcafc4638a538e141306b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa6818f72419eaebb55cba9ffec28c704"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbno08x__magf__bias__t.html">bno08x_magf_bias_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt_uncal_magnetometer.html#aa6818f72419eaebb55cba9ffec28c704">get_bias</a> ()</td></tr>
|
|
<tr class="memdesc:aa6818f72419eaebb55cba9ffec28c704"><td class="mdescLeft"> </td><td class="mdescRight">Grabs most recent uncalibrated magnetometer bias data, units are in uTesla. <a href="class_b_n_o08x_rpt_uncal_magnetometer.html#aa6818f72419eaebb55cba9ffec28c704">More...</a><br /></td></tr>
|
|
<tr class="separator:aa6818f72419eaebb55cba9ffec28c704"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_b_n_o08x_rpt"><td colspan="2" onclick="javascript: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:a7d147e7540a4c6aa19749844e14cdadc inherit pub_methods_class_b_n_o08x_rpt"><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=BNO08xPrivateTypes::default_sensor_cfg)</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. <a href="class_b_n_o08x_rpt.html#a7d147e7540a4c6aa19749844e14cdadc">More...</a><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"><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. <a href="class_b_n_o08x_rpt.html#a5b542b28c81fcd05cf2e3f3d2d437d46">More...</a><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"><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. <a href="class_b_n_o08x_rpt.html#a74f6037286b51382535bab61680297ed">More...</a><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"><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. <a href="class_b_n_o08x_rpt.html#ab3bb962696b135841ef7313bc631fc72">More...</a><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"><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) <a href="class_b_n_o08x_rpt.html#a7ce8e48cadf59f49068af7f1cb680b38">More...</a><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"><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) <a href="class_b_n_o08x_rpt.html#a1418be33824d3102dbc8f92558a402a6">More...</a><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"><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). <a href="class_b_n_o08x_rpt.html#ad5b054279b01204f61b4c0408acf51cf">More...</a><br /></td></tr>
|
|
<tr class="separator:ad5b054279b01204f61b4c0408acf51cf inherit pub_methods_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ee529725467412df396d5c610ff7bb4 inherit pub_methods_class_b_n_o08x_rpt"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a4ee529725467412df396d5c610ff7bb4">enable</a> (uint32_t time_between_reports, sh2_SensorConfig_t sensor_cfg=BNO08xPrivateTypes::default_sensor_cfg)=0</td></tr>
|
|
<tr class="separator:a4ee529725467412df396d5c610ff7bb4 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="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: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:aa0bed98a9a497d1f39e8245d05b02e9c inherit pro_methods_class_b_n_o08x_rpt"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#aa0bed98a9a497d1f39e8245d05b02e9c">rpt_enable</a> (uint32_t time_between_reports, sh2_SensorConfig_t sensor_cfg=BNO08xPrivateTypes::default_sensor_cfg)</td></tr>
|
|
<tr class="memdesc:aa0bed98a9a497d1f39e8245d05b02e9c inherit pro_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. <a href="class_b_n_o08x_rpt.html#aa0bed98a9a497d1f39e8245d05b02e9c">More...</a><br /></td></tr>
|
|
<tr class="separator:aa0bed98a9a497d1f39e8245d05b02e9c inherit pro_methods_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a970fb7e7d3745c62fec626f0ccf0759f inherit pro_methods_class_b_n_o08x_rpt"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_rpt.html#a970fb7e7d3745c62fec626f0ccf0759f">update_data</a> (sh2_SensorValue_t *sensor_val)=0</td></tr>
|
|
<tr class="separator:a970fb7e7d3745c62fec626f0ccf0759f inherit pro_methods_class_b_n_o08x_rpt"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a15e8eebe3fe90ac19837e3860c76374c inherit pro_methods_class_b_n_o08x_rpt"><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. <a href="class_b_n_o08x_rpt.html#a15e8eebe3fe90ac19837e3860c76374c">More...</a><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"><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. <a href="class_b_n_o08x_rpt.html#a61e3451e93806e1b7eaf5f1387726765">More...</a><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"><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. <a href="class_b_n_o08x_rpt.html#a7a5619a74c1237c5abde2e4bd6619d12">More...</a><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"><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. <a href="class_b_n_o08x_rpt.html#a26bacc572187119339ec248bb4e7d6f3">More...</a><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"><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. <a href="class_b_n_o08x_rpt.html#a48e7b1a2c2ebc6b1f2f292735c0832a0">More...</a><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"><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. <a href="class_b_n_o08x_rpt.html#a47a623eb0a1db51af76a03a103c32329">More...</a><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: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"><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. <a href="class_b_n_o08x_rpt.html#a63cd4ac9e96baa43eebe580f03307512">More...</a><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"><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. <a href="class_b_n_o08x_rpt.html#ae78feab5682a4697c5acad3ca6f12c2e">More...</a><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"><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. <a href="class_b_n_o08x_rpt.html#a1d4d6f4cc6f1eae503863eedf7fb9f52">More...</a><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"><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: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"><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. <a href="class_b_n_o08x_rpt.html#a201aeb71fefb0d9d485914176a82dd80">More...</a><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"><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 uncalibrated magnetometer reports. (See Ref. Manual 6.5.17) </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a8ac1f7e58879febd738b85a8035411a0" name="a8ac1f7e58879febd738b85a8035411a0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8ac1f7e58879febd738b85a8035411a0">◆ </a></span>BNO08xRptUncalMagnetometer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">BNO08xRptUncalMagnetometer::BNO08xRptUncalMagnetometer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>ID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">EventBits_t </td>
|
|
<td class="paramname"><em>rpt_bit</em>, </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"><em>sync_ctx</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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="a80ae48107ca1cc27551fd799625f2867" name="a80ae48107ca1cc27551fd799625f2867"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a80ae48107ca1cc27551fd799625f2867">◆ </a></span>enable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool BNO08xRptUncalMagnetometer::enable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>time_between_reports</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">sh2_SensorConfig_t </td>
|
|
<td class="paramname"><em>sensor_cfg</em> = <code>BNO08xPrivateTypes::default_sensor_cfg</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enables uncalibrated magnetometer reports such that the <a class="el" href="class_b_n_o08x.html" title="BNO08x IMU driver class.">BNO08x</a> begins sending them. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">report_period_us</td><td>The period/interval of the report in microseconds. </td></tr>
|
|
<tr><td class="paramname">sensor_cfg</td><td>Sensor special configuration (optional, see BNO08xPrivateTypes::default_sensor_cfg for defaults).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if report was successfully enabled. </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="class_b_n_o08x_rpt.html#a4ee529725467412df396d5c610ff7bb4">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_uncal_magnetometer_a80ae48107ca1cc27551fd799625f2867_cgraph.png" border="0" usemap="#aclass_b_n_o08x_rpt_uncal_magnetometer_a80ae48107ca1cc27551fd799625f2867_cgraph" alt=""/></div>
|
|
<map name="aclass_b_n_o08x_rpt_uncal_magnetometer_a80ae48107ca1cc27551fd799625f2867_cgraph" id="aclass_b_n_o08x_rpt_uncal_magnetometer_a80ae48107ca1cc27551fd799625f2867_cgraph">
|
|
<area shape="rect" title="Enables uncalibrated magnetometer reports such that the BNO08x begins sending them." alt="" coords="5,74,236,115"/>
|
|
<area shape="rect" href="class_b_n_o08x_rpt.html#aa0bed98a9a497d1f39e8245d05b02e9c" title="Enables a sensor report such that the BNO08x begins sending it." alt="" coords="284,81,459,108"/>
|
|
<area shape="rect" href="class_b_n_o08x_rpt.html#a7a5619a74c1237c5abde2e4bd6619d12" title="Locks sh2 HAL lib to only allow the calling task to call its APIs." alt="" coords="519,5,713,32"/>
|
|
<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="515,56,717,83"/>
|
|
<area shape="rect" href="class_b_n_o08x_rpt.html#a61e3451e93806e1b7eaf5f1387726765" title="Unlocks sh2 HAL lib to allow other tasks to call its APIs." alt="" coords="511,107,721,133"/>
|
|
<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="507,157,725,184"/>
|
|
</map>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad4d5abc8875955b6236bbe526be1e8fb" name="ad4d5abc8875955b6236bbe526be1e8fb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad4d5abc8875955b6236bbe526be1e8fb">◆ </a></span>get()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BNO08xRptUncalMagnetometer::get </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structbno08x__magf__t.html">bno08x_magf_t</a> & </td>
|
|
<td class="paramname"><em>magf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structbno08x__magf__bias__t.html">bno08x_magf_bias_t</a> & </td>
|
|
<td class="paramname"><em>bias</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Grabs most recent uncalibrated magnetometer data, units are in uTesla. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">magf</td><td>Struct to store requested magf data. </td></tr>
|
|
<tr><td class="paramname">bias</td><td>Struct to store requested bias data.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>void, nothing to return </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_uncal_magnetometer_ad4d5abc8875955b6236bbe526be1e8fb_cgraph.png" border="0" usemap="#aclass_b_n_o08x_rpt_uncal_magnetometer_ad4d5abc8875955b6236bbe526be1e8fb_cgraph" alt=""/></div>
|
|
<map name="aclass_b_n_o08x_rpt_uncal_magnetometer_ad4d5abc8875955b6236bbe526be1e8fb_cgraph" id="aclass_b_n_o08x_rpt_uncal_magnetometer_ad4d5abc8875955b6236bbe526be1e8fb_cgraph">
|
|
<area shape="rect" title="Grabs most recent uncalibrated magnetometer data, units are in uTesla." alt="" coords="5,31,264,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="320,5,523,32"/>
|
|
<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="312,56,531,83"/>
|
|
</map>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa6818f72419eaebb55cba9ffec28c704" name="aa6818f72419eaebb55cba9ffec28c704"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa6818f72419eaebb55cba9ffec28c704">◆ </a></span>get_bias()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structbno08x__magf__bias__t.html">bno08x_magf_bias_t</a> BNO08xRptUncalMagnetometer::get_bias </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Grabs most recent uncalibrated magnetometer bias data, units are in uTesla. </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_uncal_magnetometer_aa6818f72419eaebb55cba9ffec28c704_cgraph.png" border="0" usemap="#aclass_b_n_o08x_rpt_uncal_magnetometer_aa6818f72419eaebb55cba9ffec28c704_cgraph" alt=""/></div>
|
|
<map name="aclass_b_n_o08x_rpt_uncal_magnetometer_aa6818f72419eaebb55cba9ffec28c704_cgraph" id="aclass_b_n_o08x_rpt_uncal_magnetometer_aa6818f72419eaebb55cba9ffec28c704_cgraph">
|
|
<area shape="rect" title="Grabs most recent uncalibrated magnetometer bias data, units are in uTesla." alt="" coords="5,23,236,65"/>
|
|
<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="292,5,495,32"/>
|
|
<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="284,56,503,83"/>
|
|
</map>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae5a99ef7523dcafc4638a538e141306b" name="ae5a99ef7523dcafc4638a538e141306b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae5a99ef7523dcafc4638a538e141306b">◆ </a></span>get_magf()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structbno08x__magf__t.html">bno08x_magf_t</a> BNO08xRptUncalMagnetometer::get_magf </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Grabs most recent uncalibrated magnetometer magnetic field data, units are in uTesla. </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_uncal_magnetometer_ae5a99ef7523dcafc4638a538e141306b_cgraph.png" border="0" usemap="#aclass_b_n_o08x_rpt_uncal_magnetometer_ae5a99ef7523dcafc4638a538e141306b_cgraph" alt=""/></div>
|
|
<map name="aclass_b_n_o08x_rpt_uncal_magnetometer_ae5a99ef7523dcafc4638a538e141306b_cgraph" id="aclass_b_n_o08x_rpt_uncal_magnetometer_ae5a99ef7523dcafc4638a538e141306b_cgraph">
|
|
<area shape="rect" title="Grabs most recent uncalibrated magnetometer magnetic field data, units are in uTesla." alt="" coords="5,23,236,65"/>
|
|
<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="292,5,495,32"/>
|
|
<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="284,56,503,83"/>
|
|
</map>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>/media/develop/git/imu_pr_cleanup/components/esp32_BNO08x/include/report/<a class="el" href="_b_n_o08x_rpt_uncal_magnetometer_8hpp_source.html">BNO08xRptUncalMagnetometer.hpp</a></li>
|
|
<li>report/<a class="el" href="_b_n_o08x_rpt_uncal_magnetometer_8cpp.html">BNO08xRptUncalMagnetometer.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_uncal_magnetometer.html">BNO08xRptUncalMagnetometer</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>
|