641 lines
34 KiB
HTML
641 lines
34 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Adafruit QMC5883P Arduino Library: Adafruit_QMC5883P 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="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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Adafruit QMC5883P Arduino Library
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_adafruit___q_m_c5883_p-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Adafruit_QMC5883P Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Class for hardware interfacing with the QMC5883P 3-axis magnetometer.
|
|
<a href="class_adafruit___q_m_c5883_p.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_adafruit___q_m_c5883_p_8h_source.html">Adafruit_QMC5883P.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ae16432637a2bee34824de129f41e0677"><td class="memItemLeft" align="right" valign="top"><a id="ae16432637a2bee34824de129f41e0677"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#ae16432637a2bee34824de129f41e0677">Adafruit_QMC5883P</a> (void)</td></tr>
|
|
<tr class="memdesc:ae16432637a2bee34824de129f41e0677"><td class="mdescLeft"> </td><td class="mdescRight">Instantiates a new QMC5883P class. <br /></td></tr>
|
|
<tr class="separator:ae16432637a2bee34824de129f41e0677"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa930bb7ce07e2b0b882de48e2f02a50a"><td class="memItemLeft" align="right" valign="top"><a id="aa930bb7ce07e2b0b882de48e2f02a50a"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#aa930bb7ce07e2b0b882de48e2f02a50a">~Adafruit_QMC5883P</a> (void)</td></tr>
|
|
<tr class="memdesc:aa930bb7ce07e2b0b882de48e2f02a50a"><td class="mdescLeft"> </td><td class="mdescRight">Cleans up the QMC5883P. <br /></td></tr>
|
|
<tr class="separator:aa930bb7ce07e2b0b882de48e2f02a50a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f9d5cf4bc69f4bd50469906a5c92dac"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#a4f9d5cf4bc69f4bd50469906a5c92dac">begin</a> (uint8_t i2c_addr=<a class="el" href="_adafruit___q_m_c5883_p_8h.html#a785f84d78ead519b54576c25b557e135">QMC5883P_DEFAULT_ADDR</a>, TwoWire *wire=&Wire)</td></tr>
|
|
<tr class="memdesc:a4f9d5cf4bc69f4bd50469906a5c92dac"><td class="mdescLeft"> </td><td class="mdescRight">Sets up the hardware and initializes I2C. <a href="#a4f9d5cf4bc69f4bd50469906a5c92dac">More...</a><br /></td></tr>
|
|
<tr class="separator:a4f9d5cf4bc69f4bd50469906a5c92dac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27020c4b3b4e3fd7fffae962f615e35d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#a27020c4b3b4e3fd7fffae962f615e35d">getRawMagnetic</a> (int16_t *x, int16_t *y, int16_t *z)</td></tr>
|
|
<tr class="memdesc:a27020c4b3b4e3fd7fffae962f615e35d"><td class="mdescLeft"> </td><td class="mdescRight">Reads raw magnetic field data from all three axes. <a href="#a27020c4b3b4e3fd7fffae962f615e35d">More...</a><br /></td></tr>
|
|
<tr class="separator:a27020c4b3b4e3fd7fffae962f615e35d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9dea6cb089e526259c973f700e811e10"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#a9dea6cb089e526259c973f700e811e10">getGaussField</a> (float *x, float *y, float *z)</td></tr>
|
|
<tr class="memdesc:a9dea6cb089e526259c973f700e811e10"><td class="mdescLeft"> </td><td class="mdescRight">Reads magnetic field data and converts to Gauss. <a href="#a9dea6cb089e526259c973f700e811e10">More...</a><br /></td></tr>
|
|
<tr class="separator:a9dea6cb089e526259c973f700e811e10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add22292006408f93d8ef49b245527253"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#add22292006408f93d8ef49b245527253">isDataReady</a> ()</td></tr>
|
|
<tr class="memdesc:add22292006408f93d8ef49b245527253"><td class="mdescLeft"> </td><td class="mdescRight">Checks if new magnetic data is ready. <a href="#add22292006408f93d8ef49b245527253">More...</a><br /></td></tr>
|
|
<tr class="separator:add22292006408f93d8ef49b245527253"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b5ef2a2179b0d48ad439f2c23735c1f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#a9b5ef2a2179b0d48ad439f2c23735c1f">isOverflow</a> ()</td></tr>
|
|
<tr class="memdesc:a9b5ef2a2179b0d48ad439f2c23735c1f"><td class="mdescLeft"> </td><td class="mdescRight">Checks if data overflow has occurred. <a href="#a9b5ef2a2179b0d48ad439f2c23735c1f">More...</a><br /></td></tr>
|
|
<tr class="separator:a9b5ef2a2179b0d48ad439f2c23735c1f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aecdb6ae59ca0a6d5ee971f9a2a75d33c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#aecdb6ae59ca0a6d5ee971f9a2a75d33c">setMode</a> (<a class="el" href="_adafruit___q_m_c5883_p_8h.html#a318c165da46645f1bf82624cb9af6ca9">qmc5883p_mode_t</a> mode)</td></tr>
|
|
<tr class="memdesc:aecdb6ae59ca0a6d5ee971f9a2a75d33c"><td class="mdescLeft"> </td><td class="mdescRight">Sets the operating mode. <a href="#aecdb6ae59ca0a6d5ee971f9a2a75d33c">More...</a><br /></td></tr>
|
|
<tr class="separator:aecdb6ae59ca0a6d5ee971f9a2a75d33c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9af30dc83c03baa840986002c9dbf591"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#a318c165da46645f1bf82624cb9af6ca9">qmc5883p_mode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#a9af30dc83c03baa840986002c9dbf591">getMode</a> ()</td></tr>
|
|
<tr class="memdesc:a9af30dc83c03baa840986002c9dbf591"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current operating mode. <a href="#a9af30dc83c03baa840986002c9dbf591">More...</a><br /></td></tr>
|
|
<tr class="separator:a9af30dc83c03baa840986002c9dbf591"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abbb6357735341a52b44355e91a3c2f13"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#abbb6357735341a52b44355e91a3c2f13">setODR</a> (<a class="el" href="_adafruit___q_m_c5883_p_8h.html#a6257619cc4ca9fc127587f2cdafd5b8b">qmc5883p_odr_t</a> odr)</td></tr>
|
|
<tr class="memdesc:abbb6357735341a52b44355e91a3c2f13"><td class="mdescLeft"> </td><td class="mdescRight">Sets the output data rate. <a href="#abbb6357735341a52b44355e91a3c2f13">More...</a><br /></td></tr>
|
|
<tr class="separator:abbb6357735341a52b44355e91a3c2f13"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ee91fb8806bdc0bd7f51b2428906c78"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#a6257619cc4ca9fc127587f2cdafd5b8b">qmc5883p_odr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#a4ee91fb8806bdc0bd7f51b2428906c78">getODR</a> ()</td></tr>
|
|
<tr class="memdesc:a4ee91fb8806bdc0bd7f51b2428906c78"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current output data rate. <a href="#a4ee91fb8806bdc0bd7f51b2428906c78">More...</a><br /></td></tr>
|
|
<tr class="separator:a4ee91fb8806bdc0bd7f51b2428906c78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8287414ee33c14cfd1c768e56a3e8a7c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#a8287414ee33c14cfd1c768e56a3e8a7c">setOSR</a> (<a class="el" href="_adafruit___q_m_c5883_p_8h.html#a5498701e11bc1b87bc1c0ac327d60cbc">qmc5883p_osr_t</a> osr)</td></tr>
|
|
<tr class="memdesc:a8287414ee33c14cfd1c768e56a3e8a7c"><td class="mdescLeft"> </td><td class="mdescRight">Sets the over sample ratio. <a href="#a8287414ee33c14cfd1c768e56a3e8a7c">More...</a><br /></td></tr>
|
|
<tr class="separator:a8287414ee33c14cfd1c768e56a3e8a7c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74b33888adbd46bba408b64968272939"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#a5498701e11bc1b87bc1c0ac327d60cbc">qmc5883p_osr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#a74b33888adbd46bba408b64968272939">getOSR</a> ()</td></tr>
|
|
<tr class="memdesc:a74b33888adbd46bba408b64968272939"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current over sample ratio. <a href="#a74b33888adbd46bba408b64968272939">More...</a><br /></td></tr>
|
|
<tr class="separator:a74b33888adbd46bba408b64968272939"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0657d2a45adc54e72f6f3c813254169b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#a0657d2a45adc54e72f6f3c813254169b">setDSR</a> (<a class="el" href="_adafruit___q_m_c5883_p_8h.html#a5b74562d9dd54dbe88e35a5a8ed087a3">qmc5883p_dsr_t</a> dsr)</td></tr>
|
|
<tr class="memdesc:a0657d2a45adc54e72f6f3c813254169b"><td class="mdescLeft"> </td><td class="mdescRight">Sets the downsample ratio. <a href="#a0657d2a45adc54e72f6f3c813254169b">More...</a><br /></td></tr>
|
|
<tr class="separator:a0657d2a45adc54e72f6f3c813254169b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac45db7553d44fce47604afbc06c6623d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#a5b74562d9dd54dbe88e35a5a8ed087a3">qmc5883p_dsr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#ac45db7553d44fce47604afbc06c6623d">getDSR</a> ()</td></tr>
|
|
<tr class="memdesc:ac45db7553d44fce47604afbc06c6623d"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current downsample ratio. <a href="#ac45db7553d44fce47604afbc06c6623d">More...</a><br /></td></tr>
|
|
<tr class="separator:ac45db7553d44fce47604afbc06c6623d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb5cab8bf180326b1b7e0dd53f4997a8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#aeb5cab8bf180326b1b7e0dd53f4997a8">softReset</a> ()</td></tr>
|
|
<tr class="memdesc:aeb5cab8bf180326b1b7e0dd53f4997a8"><td class="mdescLeft"> </td><td class="mdescRight">Performs a soft reset of the chip. <a href="#aeb5cab8bf180326b1b7e0dd53f4997a8">More...</a><br /></td></tr>
|
|
<tr class="separator:aeb5cab8bf180326b1b7e0dd53f4997a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8fae5c63299ebdc797ffec8d563ea1be"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#a8fae5c63299ebdc797ffec8d563ea1be">selfTest</a> ()</td></tr>
|
|
<tr class="memdesc:a8fae5c63299ebdc797ffec8d563ea1be"><td class="mdescLeft"> </td><td class="mdescRight">Performs self-test of the chip. <a href="#a8fae5c63299ebdc797ffec8d563ea1be">More...</a><br /></td></tr>
|
|
<tr class="separator:a8fae5c63299ebdc797ffec8d563ea1be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a35bcce90bab2809364e1188dee319091"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#a35bcce90bab2809364e1188dee319091">setRange</a> (<a class="el" href="_adafruit___q_m_c5883_p_8h.html#a2416d0c9b5a133222e3cc6405052a62d">qmc5883p_range_t</a> range)</td></tr>
|
|
<tr class="memdesc:a35bcce90bab2809364e1188dee319091"><td class="mdescLeft"> </td><td class="mdescRight">Sets the magnetic field range. <a href="#a35bcce90bab2809364e1188dee319091">More...</a><br /></td></tr>
|
|
<tr class="separator:a35bcce90bab2809364e1188dee319091"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8eb515486c1fad8d983645e36865774b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#a2416d0c9b5a133222e3cc6405052a62d">qmc5883p_range_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#a8eb515486c1fad8d983645e36865774b">getRange</a> ()</td></tr>
|
|
<tr class="memdesc:a8eb515486c1fad8d983645e36865774b"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current magnetic field range. <a href="#a8eb515486c1fad8d983645e36865774b">More...</a><br /></td></tr>
|
|
<tr class="separator:a8eb515486c1fad8d983645e36865774b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab224ab6bbc805c4d7d4c82d3a86c48a7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#ab224ab6bbc805c4d7d4c82d3a86c48a7">setSetResetMode</a> (<a class="el" href="_adafruit___q_m_c5883_p_8h.html#afa72dae2714eac647abba69e54d9588b">qmc5883p_setreset_t</a> mode)</td></tr>
|
|
<tr class="memdesc:ab224ab6bbc805c4d7d4c82d3a86c48a7"><td class="mdescLeft"> </td><td class="mdescRight">Sets the set/reset mode. <a href="#ab224ab6bbc805c4d7d4c82d3a86c48a7">More...</a><br /></td></tr>
|
|
<tr class="separator:ab224ab6bbc805c4d7d4c82d3a86c48a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab0a724ff1b4fca98f8a744f93d8c113a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#afa72dae2714eac647abba69e54d9588b">qmc5883p_setreset_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___q_m_c5883_p.html#ab0a724ff1b4fca98f8a744f93d8c113a">getSetResetMode</a> ()</td></tr>
|
|
<tr class="memdesc:ab0a724ff1b4fca98f8a744f93d8c113a"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current set/reset mode. <a href="#ab0a724ff1b4fca98f8a744f93d8c113a">More...</a><br /></td></tr>
|
|
<tr class="separator:ab0a724ff1b4fca98f8a744f93d8c113a"><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 for hardware interfacing with the QMC5883P 3-axis magnetometer. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a4f9d5cf4bc69f4bd50469906a5c92dac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4f9d5cf4bc69f4bd50469906a5c92dac">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_QMC5883P::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>i2c_addr</em> = <code><a class="el" href="_adafruit___q_m_c5883_p_8h.html#a785f84d78ead519b54576c25b557e135">QMC5883P_DEFAULT_ADDR</a></code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">TwoWire * </td>
|
|
<td class="paramname"><em>wire</em> = <code>&Wire</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets up the hardware and initializes I2C. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">i2c_addr</td><td>The I2C address to be used. </td></tr>
|
|
<tr><td class="paramname">wire</td><td>The Wire object to be used for I2C connections. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if initialization was successful, otherwise false. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a27020c4b3b4e3fd7fffae962f615e35d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a27020c4b3b4e3fd7fffae962f615e35d">◆ </a></span>getRawMagnetic()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_QMC5883P::getRawMagnetic </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int16_t * </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int16_t * </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int16_t * </td>
|
|
<td class="paramname"><em>z</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads raw magnetic field data from all three axes. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">x</td><td>Pointer to store X-axis raw data (2's complement) </td></tr>
|
|
<tr><td class="paramname">y</td><td>Pointer to store Y-axis raw data (2's complement) </td></tr>
|
|
<tr><td class="paramname">z</td><td>Pointer to store Z-axis raw data (2's complement) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if read was successful, otherwise false. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9dea6cb089e526259c973f700e811e10"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9dea6cb089e526259c973f700e811e10">◆ </a></span>getGaussField()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_QMC5883P::getGaussField </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>z</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads magnetic field data and converts to Gauss. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">x</td><td>Pointer to store X-axis field in Gauss </td></tr>
|
|
<tr><td class="paramname">y</td><td>Pointer to store Y-axis field in Gauss </td></tr>
|
|
<tr><td class="paramname">z</td><td>Pointer to store Z-axis field in Gauss </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if read was successful, otherwise false. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="add22292006408f93d8ef49b245527253"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#add22292006408f93d8ef49b245527253">◆ </a></span>isDataReady()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_QMC5883P::isDataReady </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks if new magnetic data is ready. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if new data is ready, false otherwise </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9b5ef2a2179b0d48ad439f2c23735c1f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9b5ef2a2179b0d48ad439f2c23735c1f">◆ </a></span>isOverflow()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_QMC5883P::isOverflow </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks if data overflow has occurred. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if overflow occurred, false otherwise </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aecdb6ae59ca0a6d5ee971f9a2a75d33c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aecdb6ae59ca0a6d5ee971f9a2a75d33c">◆ </a></span>setMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_QMC5883P::setMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#a318c165da46645f1bf82624cb9af6ca9">qmc5883p_mode_t</a> </td>
|
|
<td class="paramname"><em>mode</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the operating mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mode</td><td>The operating mode to set </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9af30dc83c03baa840986002c9dbf591"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9af30dc83c03baa840986002c9dbf591">◆ </a></span>getMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#a318c165da46645f1bf82624cb9af6ca9">qmc5883p_mode_t</a> Adafruit_QMC5883P::getMode </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current operating mode. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current operating mode </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abbb6357735341a52b44355e91a3c2f13"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abbb6357735341a52b44355e91a3c2f13">◆ </a></span>setODR()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_QMC5883P::setODR </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#a6257619cc4ca9fc127587f2cdafd5b8b">qmc5883p_odr_t</a> </td>
|
|
<td class="paramname"><em>odr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the output data rate. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">odr</td><td>The output data rate to set </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4ee91fb8806bdc0bd7f51b2428906c78"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ee91fb8806bdc0bd7f51b2428906c78">◆ </a></span>getODR()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#a6257619cc4ca9fc127587f2cdafd5b8b">qmc5883p_odr_t</a> Adafruit_QMC5883P::getODR </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current output data rate. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current output data rate </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8287414ee33c14cfd1c768e56a3e8a7c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8287414ee33c14cfd1c768e56a3e8a7c">◆ </a></span>setOSR()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_QMC5883P::setOSR </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#a5498701e11bc1b87bc1c0ac327d60cbc">qmc5883p_osr_t</a> </td>
|
|
<td class="paramname"><em>osr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the over sample ratio. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">osr</td><td>The over sample ratio to set </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a74b33888adbd46bba408b64968272939"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a74b33888adbd46bba408b64968272939">◆ </a></span>getOSR()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#a5498701e11bc1b87bc1c0ac327d60cbc">qmc5883p_osr_t</a> Adafruit_QMC5883P::getOSR </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current over sample ratio. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current over sample ratio </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0657d2a45adc54e72f6f3c813254169b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0657d2a45adc54e72f6f3c813254169b">◆ </a></span>setDSR()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_QMC5883P::setDSR </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#a5b74562d9dd54dbe88e35a5a8ed087a3">qmc5883p_dsr_t</a> </td>
|
|
<td class="paramname"><em>dsr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the downsample ratio. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dsr</td><td>The downsample ratio to set </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac45db7553d44fce47604afbc06c6623d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac45db7553d44fce47604afbc06c6623d">◆ </a></span>getDSR()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#a5b74562d9dd54dbe88e35a5a8ed087a3">qmc5883p_dsr_t</a> Adafruit_QMC5883P::getDSR </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current downsample ratio. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current downsample ratio </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeb5cab8bf180326b1b7e0dd53f4997a8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeb5cab8bf180326b1b7e0dd53f4997a8">◆ </a></span>softReset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_QMC5883P::softReset </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Performs a soft reset of the chip. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if reset was successful, false otherwise </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8fae5c63299ebdc797ffec8d563ea1be"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8fae5c63299ebdc797ffec8d563ea1be">◆ </a></span>selfTest()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_QMC5883P::selfTest </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Performs self-test of the chip. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if self-test passed, false otherwise </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a35bcce90bab2809364e1188dee319091"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a35bcce90bab2809364e1188dee319091">◆ </a></span>setRange()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_QMC5883P::setRange </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#a2416d0c9b5a133222e3cc6405052a62d">qmc5883p_range_t</a> </td>
|
|
<td class="paramname"><em>range</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the magnetic field range. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">range</td><td>The magnetic field range to set </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8eb515486c1fad8d983645e36865774b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8eb515486c1fad8d983645e36865774b">◆ </a></span>getRange()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#a2416d0c9b5a133222e3cc6405052a62d">qmc5883p_range_t</a> Adafruit_QMC5883P::getRange </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current magnetic field range. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current magnetic field range </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab224ab6bbc805c4d7d4c82d3a86c48a7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab224ab6bbc805c4d7d4c82d3a86c48a7">◆ </a></span>setSetResetMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_QMC5883P::setSetResetMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#afa72dae2714eac647abba69e54d9588b">qmc5883p_setreset_t</a> </td>
|
|
<td class="paramname"><em>mode</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the set/reset mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mode</td><td>The set/reset mode to set </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab0a724ff1b4fca98f8a744f93d8c113a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab0a724ff1b4fca98f8a744f93d8c113a">◆ </a></span>getSetResetMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_adafruit___q_m_c5883_p_8h.html#afa72dae2714eac647abba69e54d9588b">qmc5883p_setreset_t</a> Adafruit_QMC5883P::getSetResetMode </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current set/reset mode. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current set/reset mode </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="_adafruit___q_m_c5883_p_8h_source.html">Adafruit_QMC5883P.h</a></li>
|
|
<li><a class="el" href="_adafruit___q_m_c5883_p_8cpp.html">Adafruit_QMC5883P.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|