esp32_BNO08x/documentation/html/structbno08x__config__t.html

400 lines
21 KiB
HTML
Raw Normal View History

2024-07-24 00:25:04 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>esp32_BNO08x: bno08x_config_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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">esp32_BNO08x<span id="projectnumber">&#160;1.1</span>
</div>
<div id="projectbrief">C++ BNO08x IMU driver component for esp-idf.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('structbno08x__config__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">
<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> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structbno08x__config__t-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">bno08x_config_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>IMU configuration settings passed into constructor.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_b_n_o08x_8hpp_source.html">BNO08x.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:abf8805292192f4c30c5000423175a2e1" id="r_abf8805292192f4c30c5000423175a2e1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abf8805292192f4c30c5000423175a2e1">bno08x_config_t</a> ()</td></tr>
<tr class="memdesc:abf8805292192f4c30c5000423175a2e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default IMU configuration settings constructor. To modify default GPIO pins, run "idf.py menuconfig" esp32_BNO08x-&gt;GPIO Configuration. Alternatively, edit the default values in "Kconfig.projbuild". <br /></td></tr>
<tr class="separator:abf8805292192f4c30c5000423175a2e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3b4bc522d30f9df7747ed46d0532c23" id="r_ae3b4bc522d30f9df7747ed46d0532c23"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae3b4bc522d30f9df7747ed46d0532c23">bno08x_config_t</a> (spi_host_device_t <a class="el" href="#a020d2343750bb7debc2a108ae038c9ec">spi_peripheral</a>, gpio_num_t <a class="el" href="#a79023fd80039e41a22b7f73ccd5fc861">io_mosi</a>, gpio_num_t <a class="el" href="#a9468180a773892977db39cc5ed9368e3">io_miso</a>, gpio_num_t <a class="el" href="#a639685b91ae3198909d722316495246a">io_sclk</a>, gpio_num_t <a class="el" href="#ab1b5351b63da0c172c942463d0dc2505">io_cs</a>, gpio_num_t <a class="el" href="#a3cfe965659cfbc6b0c5269bd0211975f">io_int</a>, gpio_num_t <a class="el" href="#a62745c761219139f66ecd173b51577fc">io_rst</a>, gpio_num_t <a class="el" href="#a90ad7f316dc443874d19dc7e723a0ce0">io_wake</a>, uint32_t <a class="el" href="#a231614c3b20888360def2ce9db83f52a">sclk_speed</a>)</td></tr>
<tr class="memdesc:ae3b4bc522d30f9df7747ed46d0532c23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overloaded IMU configuration settings constructor for custom pin settings. <br /></td></tr>
<tr class="separator:ae3b4bc522d30f9df7747ed46d0532c23"><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:a020d2343750bb7debc2a108ae038c9ec" id="r_a020d2343750bb7debc2a108ae038c9ec"><td class="memItemLeft" align="right" valign="top">spi_host_device_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a020d2343750bb7debc2a108ae038c9ec">spi_peripheral</a></td></tr>
<tr class="memdesc:a020d2343750bb7debc2a108ae038c9ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">SPI peripheral to be used. <br /></td></tr>
<tr class="separator:a020d2343750bb7debc2a108ae038c9ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79023fd80039e41a22b7f73ccd5fc861" id="r_a79023fd80039e41a22b7f73ccd5fc861"><td class="memItemLeft" align="right" valign="top">gpio_num_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a79023fd80039e41a22b7f73ccd5fc861">io_mosi</a></td></tr>
<tr class="memdesc:a79023fd80039e41a22b7f73ccd5fc861"><td class="mdescLeft">&#160;</td><td class="mdescRight">MOSI GPIO pin (connects to <a class="el" href="class_b_n_o08x.html">BNO08x</a> DI pin) <br /></td></tr>
<tr class="separator:a79023fd80039e41a22b7f73ccd5fc861"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9468180a773892977db39cc5ed9368e3" id="r_a9468180a773892977db39cc5ed9368e3"><td class="memItemLeft" align="right" valign="top">gpio_num_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9468180a773892977db39cc5ed9368e3">io_miso</a></td></tr>
<tr class="memdesc:a9468180a773892977db39cc5ed9368e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">MISO GPIO pin (connects to <a class="el" href="class_b_n_o08x.html">BNO08x</a> SDA pin) <br /></td></tr>
<tr class="separator:a9468180a773892977db39cc5ed9368e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a639685b91ae3198909d722316495246a" id="r_a639685b91ae3198909d722316495246a"><td class="memItemLeft" align="right" valign="top">gpio_num_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a639685b91ae3198909d722316495246a">io_sclk</a></td></tr>
<tr class="memdesc:a639685b91ae3198909d722316495246a"><td class="mdescLeft">&#160;</td><td class="mdescRight">SCLK pin (connects to <a class="el" href="class_b_n_o08x.html">BNO08x</a> SCL pin) <br /></td></tr>
<tr class="separator:a639685b91ae3198909d722316495246a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1b5351b63da0c172c942463d0dc2505" id="r_ab1b5351b63da0c172c942463d0dc2505"><td class="memItemLeft" align="right" valign="top">gpio_num_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab1b5351b63da0c172c942463d0dc2505">io_cs</a></td></tr>
<tr class="separator:ab1b5351b63da0c172c942463d0dc2505"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3cfe965659cfbc6b0c5269bd0211975f" id="r_a3cfe965659cfbc6b0c5269bd0211975f"><td class="memItemLeft" align="right" valign="top">gpio_num_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3cfe965659cfbc6b0c5269bd0211975f">io_int</a></td></tr>
<tr class="memdesc:a3cfe965659cfbc6b0c5269bd0211975f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Chip select pin (connects to <a class="el" href="class_b_n_o08x.html">BNO08x</a> CS pin) <br /></td></tr>
<tr class="separator:a3cfe965659cfbc6b0c5269bd0211975f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62745c761219139f66ecd173b51577fc" id="r_a62745c761219139f66ecd173b51577fc"><td class="memItemLeft" align="right" valign="top">gpio_num_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a62745c761219139f66ecd173b51577fc">io_rst</a></td></tr>
<tr class="memdesc:a62745c761219139f66ecd173b51577fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Host interrupt pin (connects to <a class="el" href="class_b_n_o08x.html">BNO08x</a> INT pin) <br /></td></tr>
<tr class="separator:a62745c761219139f66ecd173b51577fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90ad7f316dc443874d19dc7e723a0ce0" id="r_a90ad7f316dc443874d19dc7e723a0ce0"><td class="memItemLeft" align="right" valign="top">gpio_num_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a90ad7f316dc443874d19dc7e723a0ce0">io_wake</a></td></tr>
<tr class="memdesc:a90ad7f316dc443874d19dc7e723a0ce0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset pin (connects to <a class="el" href="class_b_n_o08x.html">BNO08x</a> RST pin) <br /></td></tr>
<tr class="separator:a90ad7f316dc443874d19dc7e723a0ce0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a231614c3b20888360def2ce9db83f52a" id="r_a231614c3b20888360def2ce9db83f52a"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a231614c3b20888360def2ce9db83f52a">sclk_speed</a></td></tr>
<tr class="memdesc:a231614c3b20888360def2ce9db83f52a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Desired SPI SCLK speed in Hz (max 3MHz) <br /></td></tr>
<tr class="separator:a231614c3b20888360def2ce9db83f52a"><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>IMU configuration settings passed into constructor. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="abf8805292192f4c30c5000423175a2e1" name="abf8805292192f4c30c5000423175a2e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf8805292192f4c30c5000423175a2e1">&#9670;&#160;</a></span>bno08x_config_t() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bno08x_config_t::bno08x_config_t </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></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">
<p>Default IMU configuration settings constructor. To modify default GPIO pins, run "idf.py menuconfig" esp32_BNO08x-&gt;GPIO Configuration. Alternatively, edit the default values in "Kconfig.projbuild". </p>
</div>
</div>
<a id="ae3b4bc522d30f9df7747ed46d0532c23" name="ae3b4bc522d30f9df7747ed46d0532c23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3b4bc522d30f9df7747ed46d0532c23">&#9670;&#160;</a></span>bno08x_config_t() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bno08x_config_t::bno08x_config_t </td>
<td>(</td>
<td class="paramtype">spi_host_device_t</td> <td class="paramname"><span class="paramname"><em>spi_peripheral</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gpio_num_t</td> <td class="paramname"><span class="paramname"><em>io_mosi</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gpio_num_t</td> <td class="paramname"><span class="paramname"><em>io_miso</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gpio_num_t</td> <td class="paramname"><span class="paramname"><em>io_sclk</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gpio_num_t</td> <td class="paramname"><span class="paramname"><em>io_cs</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gpio_num_t</td> <td class="paramname"><span class="paramname"><em>io_int</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gpio_num_t</td> <td class="paramname"><span class="paramname"><em>io_rst</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gpio_num_t</td> <td class="paramname"><span class="paramname"><em>io_wake</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>sclk_speed</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Overloaded IMU configuration settings constructor for custom pin settings. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ab1b5351b63da0c172c942463d0dc2505" name="ab1b5351b63da0c172c942463d0dc2505"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1b5351b63da0c172c942463d0dc2505">&#9670;&#160;</a></span>io_cs</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gpio_num_t bno08x_config_t::io_cs</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3cfe965659cfbc6b0c5269bd0211975f" name="a3cfe965659cfbc6b0c5269bd0211975f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cfe965659cfbc6b0c5269bd0211975f">&#9670;&#160;</a></span>io_int</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gpio_num_t bno08x_config_t::io_int</td>
</tr>
</table>
</div><div class="memdoc">
<p>Chip select pin (connects to <a class="el" href="class_b_n_o08x.html">BNO08x</a> CS pin) </p>
</div>
</div>
<a id="a9468180a773892977db39cc5ed9368e3" name="a9468180a773892977db39cc5ed9368e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9468180a773892977db39cc5ed9368e3">&#9670;&#160;</a></span>io_miso</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gpio_num_t bno08x_config_t::io_miso</td>
</tr>
</table>
</div><div class="memdoc">
<p>MISO GPIO pin (connects to <a class="el" href="class_b_n_o08x.html">BNO08x</a> SDA pin) </p>
</div>
</div>
<a id="a79023fd80039e41a22b7f73ccd5fc861" name="a79023fd80039e41a22b7f73ccd5fc861"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79023fd80039e41a22b7f73ccd5fc861">&#9670;&#160;</a></span>io_mosi</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gpio_num_t bno08x_config_t::io_mosi</td>
</tr>
</table>
</div><div class="memdoc">
<p>MOSI GPIO pin (connects to <a class="el" href="class_b_n_o08x.html">BNO08x</a> DI pin) </p>
</div>
</div>
<a id="a62745c761219139f66ecd173b51577fc" name="a62745c761219139f66ecd173b51577fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62745c761219139f66ecd173b51577fc">&#9670;&#160;</a></span>io_rst</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gpio_num_t bno08x_config_t::io_rst</td>
</tr>
</table>
</div><div class="memdoc">
<p>Host interrupt pin (connects to <a class="el" href="class_b_n_o08x.html">BNO08x</a> INT pin) </p>
</div>
</div>
<a id="a639685b91ae3198909d722316495246a" name="a639685b91ae3198909d722316495246a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a639685b91ae3198909d722316495246a">&#9670;&#160;</a></span>io_sclk</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gpio_num_t bno08x_config_t::io_sclk</td>
</tr>
</table>
</div><div class="memdoc">
<p>SCLK pin (connects to <a class="el" href="class_b_n_o08x.html">BNO08x</a> SCL pin) </p>
</div>
</div>
<a id="a90ad7f316dc443874d19dc7e723a0ce0" name="a90ad7f316dc443874d19dc7e723a0ce0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90ad7f316dc443874d19dc7e723a0ce0">&#9670;&#160;</a></span>io_wake</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gpio_num_t bno08x_config_t::io_wake</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset pin (connects to <a class="el" href="class_b_n_o08x.html">BNO08x</a> RST pin) </p>
<p>Wake pin (optional, connects to <a class="el" href="class_b_n_o08x.html">BNO08x</a> P0) </p>
</div>
</div>
<a id="a231614c3b20888360def2ce9db83f52a" name="a231614c3b20888360def2ce9db83f52a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a231614c3b20888360def2ce9db83f52a">&#9670;&#160;</a></span>sclk_speed</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t bno08x_config_t::sclk_speed</td>
</tr>
</table>
</div><div class="memdoc">
<p>Desired SPI SCLK speed in Hz (max 3MHz) </p>
</div>
</div>
<a id="a020d2343750bb7debc2a108ae038c9ec" name="a020d2343750bb7debc2a108ae038c9ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a020d2343750bb7debc2a108ae038c9ec">&#9670;&#160;</a></span>spi_peripheral</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">spi_host_device_t bno08x_config_t::spi_peripheral</td>
</tr>
</table>
</div><div class="memdoc">
<p>SPI peripheral to be used. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="_b_n_o08x_8hpp_source.html">BNO08x.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__config__t.html">bno08x_config_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.10.0 </li>
</ul>
</div>
</body>
</html>