822 lines
46 KiB
HTML
822 lines
46 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 MSA301 Sensor Library: Adafruit_MSA301 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 MSA301 Sensor 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="#pub-attribs">Public Attributes</a> |
|
|
<a href="class_adafruit___m_s_a301-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Adafruit_MSA301 Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="_adafruit___m_s_a301_8h_source.html">Adafruit_MSA301.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for Adafruit_MSA301:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_adafruit___m_s_a301.png" usemap="#Adafruit_5FMSA301_map" alt=""/>
|
|
<map id="Adafruit_5FMSA301_map" name="Adafruit_5FMSA301_map">
|
|
<area href="class_adafruit___m_s_a311.html" alt="Adafruit_MSA311" shape="rect" coords="0,112,113,136"/>
|
|
</map>
|
|
</div></div>
|
|
<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:a7a425bd5715ed7b325f2cd4ce025b63b"><td class="memItemLeft" align="right" valign="top"><a id="a7a425bd5715ed7b325f2cd4ce025b63b"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#a7a425bd5715ed7b325f2cd4ce025b63b">Adafruit_MSA301</a> (void)</td></tr>
|
|
<tr class="memdesc:a7a425bd5715ed7b325f2cd4ce025b63b"><td class="mdescLeft"> </td><td class="mdescRight">Instantiates a new MSA301 class. <br /></td></tr>
|
|
<tr class="separator:a7a425bd5715ed7b325f2cd4ce025b63b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad5f7d858435bc0cfd53e43543de5e77"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#aad5f7d858435bc0cfd53e43543de5e77">begin</a> (uint8_t i2c_addr=<a class="el" href="_adafruit___m_s_a301_8h.html#a02705daafb136c6d255f81ba14f2f17a">MSA301_I2CADDR_DEFAULT</a>, TwoWire *wire=&Wire)</td></tr>
|
|
<tr class="memdesc:aad5f7d858435bc0cfd53e43543de5e77"><td class="mdescLeft"> </td><td class="mdescRight">Sets up the hardware and initializes I2C. <a href="#aad5f7d858435bc0cfd53e43543de5e77">More...</a><br /></td></tr>
|
|
<tr class="separator:aad5f7d858435bc0cfd53e43543de5e77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd07c6b2f9229b50015df486f05c32f0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#abd07c6b2f9229b50015df486f05c32f0">setDataRate</a> (<a class="el" href="_adafruit___m_s_a301_8h.html#a6157095eda79f17774c4c2f1317b9787">msa301_dataRate_t</a> dataRate)</td></tr>
|
|
<tr class="memdesc:abd07c6b2f9229b50015df486f05c32f0"><td class="mdescLeft"> </td><td class="mdescRight">Sets the data rate for the MSA301 (controls power consumption) from 1 Hz to 1000Hz. <a href="#abd07c6b2f9229b50015df486f05c32f0">More...</a><br /></td></tr>
|
|
<tr class="separator:abd07c6b2f9229b50015df486f05c32f0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0781e09becb172bf964135a4d9d0dd3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit___m_s_a301_8h.html#a6157095eda79f17774c4c2f1317b9787">msa301_dataRate_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#a0781e09becb172bf964135a4d9d0dd3f">getDataRate</a> (void)</td></tr>
|
|
<tr class="memdesc:a0781e09becb172bf964135a4d9d0dd3f"><td class="mdescLeft"> </td><td class="mdescRight">Gets the data rate for the MSA301 (controls power consumption) <a href="#a0781e09becb172bf964135a4d9d0dd3f">More...</a><br /></td></tr>
|
|
<tr class="separator:a0781e09becb172bf964135a4d9d0dd3f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a23af00e3b11e8ce2c079dadccd5bdfef"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#a23af00e3b11e8ce2c079dadccd5bdfef">enableAxes</a> (bool <a class="el" href="class_adafruit___m_s_a301.html#a6b2f5b6467137f9376c2e81c983128dd">x</a>, bool <a class="el" href="class_adafruit___m_s_a301.html#ac5dad4e6af2268f3322232c2f1bd15fd">y</a>, bool <a class="el" href="class_adafruit___m_s_a301.html#acfa3e71c67c222ab00fbd9937f6b452d">z</a>)</td></tr>
|
|
<tr class="memdesc:a23af00e3b11e8ce2c079dadccd5bdfef"><td class="mdescLeft"> </td><td class="mdescRight">What axes of the accelerometer we want enabled for reading. <a href="#a23af00e3b11e8ce2c079dadccd5bdfef">More...</a><br /></td></tr>
|
|
<tr class="separator:a23af00e3b11e8ce2c079dadccd5bdfef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc2a41b87af32e1dd5716dea0959f1ee"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#afc2a41b87af32e1dd5716dea0959f1ee">setPowerMode</a> (<a class="el" href="_adafruit___m_s_a301_8h.html#a378ad6a06ce1fb3dd4bffd46cd777db6">msa301_powermode_t</a> mode)</td></tr>
|
|
<tr class="memdesc:afc2a41b87af32e1dd5716dea0959f1ee"><td class="mdescLeft"> </td><td class="mdescRight">Set the power mode, MSA301_NORMALMODE, MSA301_LOWPOWERMODE or MSA301_SUSPENDMODE. <a href="#afc2a41b87af32e1dd5716dea0959f1ee">More...</a><br /></td></tr>
|
|
<tr class="separator:afc2a41b87af32e1dd5716dea0959f1ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afd44736492a4c71751d6769caa789e92"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit___m_s_a301_8h.html#a378ad6a06ce1fb3dd4bffd46cd777db6">msa301_powermode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#afd44736492a4c71751d6769caa789e92">getPowerMode</a> (void)</td></tr>
|
|
<tr class="memdesc:afd44736492a4c71751d6769caa789e92"><td class="mdescLeft"> </td><td class="mdescRight">Get the power mode. <a href="#afd44736492a4c71751d6769caa789e92">More...</a><br /></td></tr>
|
|
<tr class="separator:afd44736492a4c71751d6769caa789e92"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a97b147eda3a235ced4b274ef3a97880d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#a97b147eda3a235ced4b274ef3a97880d">setBandwidth</a> (<a class="el" href="_adafruit___m_s_a301_8h.html#aa2c734650d868a7644293205d75830c0">msa301_bandwidth_t</a> bandwidth)</td></tr>
|
|
<tr class="memdesc:a97b147eda3a235ced4b274ef3a97880d"><td class="mdescLeft"> </td><td class="mdescRight">Set the bandwidth, ranges from 1.95Hz to 500Hz. <a href="#a97b147eda3a235ced4b274ef3a97880d">More...</a><br /></td></tr>
|
|
<tr class="separator:a97b147eda3a235ced4b274ef3a97880d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a926d66adf881068590c401f00a18b0b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit___m_s_a301_8h.html#aa2c734650d868a7644293205d75830c0">msa301_bandwidth_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#a926d66adf881068590c401f00a18b0b3">getBandwidth</a> (void)</td></tr>
|
|
<tr class="memdesc:a926d66adf881068590c401f00a18b0b3"><td class="mdescLeft"> </td><td class="mdescRight">Get the bandwidth. <a href="#a926d66adf881068590c401f00a18b0b3">More...</a><br /></td></tr>
|
|
<tr class="separator:a926d66adf881068590c401f00a18b0b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36d5cc7e86bdebebcff5e6c23f4d8c73"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#a36d5cc7e86bdebebcff5e6c23f4d8c73">setRange</a> (<a class="el" href="_adafruit___m_s_a301_8h.html#a1b3d6cc9fd621b2d85fae2e6aeb2619a">msa301_range_t</a> range)</td></tr>
|
|
<tr class="memdesc:a36d5cc7e86bdebebcff5e6c23f4d8c73"><td class="mdescLeft"> </td><td class="mdescRight">Set the resolution range: +-2g, 4g, 8g, or 16g. <a href="#a36d5cc7e86bdebebcff5e6c23f4d8c73">More...</a><br /></td></tr>
|
|
<tr class="separator:a36d5cc7e86bdebebcff5e6c23f4d8c73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1deca0c8ff66457ae37f6b2e4aaffb2c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit___m_s_a301_8h.html#a1b3d6cc9fd621b2d85fae2e6aeb2619a">msa301_range_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#a1deca0c8ff66457ae37f6b2e4aaffb2c">getRange</a> (void)</td></tr>
|
|
<tr class="memdesc:a1deca0c8ff66457ae37f6b2e4aaffb2c"><td class="mdescLeft"> </td><td class="mdescRight">Read the resolution range: +-2g, 4g, 8g, or 16g. <a href="#a1deca0c8ff66457ae37f6b2e4aaffb2c">More...</a><br /></td></tr>
|
|
<tr class="separator:a1deca0c8ff66457ae37f6b2e4aaffb2c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a992066f83e0cf502bde3487068809e61"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#a992066f83e0cf502bde3487068809e61">setResolution</a> (<a class="el" href="_adafruit___m_s_a301_8h.html#af2868ca3325a48160428cf7cf66e472c">msa301_resolution_t</a> resolution)</td></tr>
|
|
<tr class="memdesc:a992066f83e0cf502bde3487068809e61"><td class="mdescLeft"> </td><td class="mdescRight">Set the resolution - 8, 10, 12, or 14bits. <a href="#a992066f83e0cf502bde3487068809e61">More...</a><br /></td></tr>
|
|
<tr class="separator:a992066f83e0cf502bde3487068809e61"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a71c1a3e5634e699c82b8286e8f85c7ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_adafruit___m_s_a301_8h.html#af2868ca3325a48160428cf7cf66e472c">msa301_resolution_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#a71c1a3e5634e699c82b8286e8f85c7ad">getResolution</a> (void)</td></tr>
|
|
<tr class="memdesc:a71c1a3e5634e699c82b8286e8f85c7ad"><td class="mdescLeft"> </td><td class="mdescRight">Read the resolution - 8, 10, 12, or 14bits. <a href="#a71c1a3e5634e699c82b8286e8f85c7ad">More...</a><br /></td></tr>
|
|
<tr class="separator:a71c1a3e5634e699c82b8286e8f85c7ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba55fbccbf173d7fe57a3c77725da0b6"><td class="memItemLeft" align="right" valign="top"><a id="aba55fbccbf173d7fe57a3c77725da0b6"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#aba55fbccbf173d7fe57a3c77725da0b6">read</a> ()</td></tr>
|
|
<tr class="memdesc:aba55fbccbf173d7fe57a3c77725da0b6"><td class="mdescLeft"> </td><td class="mdescRight">Read the XYZ data from the accelerometer and store in the internal x, y and z (and x_g, y_g, z_g) member variables. <br /></td></tr>
|
|
<tr class="separator:aba55fbccbf173d7fe57a3c77725da0b6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16526d972220840724da02971fdaa737"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#a16526d972220840724da02971fdaa737">getEvent</a> (sensors_event_t *event)</td></tr>
|
|
<tr class="memdesc:a16526d972220840724da02971fdaa737"><td class="mdescLeft"> </td><td class="mdescRight">Gets the most recent sensor event, Adafruit Unified Sensor format. <a href="#a16526d972220840724da02971fdaa737">More...</a><br /></td></tr>
|
|
<tr class="separator:a16526d972220840724da02971fdaa737"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a29740b295c91a63b88927a160ff7ac6d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#a29740b295c91a63b88927a160ff7ac6d">getSensor</a> (sensor_t *sensor)</td></tr>
|
|
<tr class="memdesc:a29740b295c91a63b88927a160ff7ac6d"><td class="mdescLeft"> </td><td class="mdescRight">Gets the sensor_t device data, Adafruit Unified Sensor format. <a href="#a29740b295c91a63b88927a160ff7ac6d">More...</a><br /></td></tr>
|
|
<tr class="separator:a29740b295c91a63b88927a160ff7ac6d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acb0f914a65e394190d23748e3288b2c8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#acb0f914a65e394190d23748e3288b2c8">enableInterrupts</a> (bool singletap=false, bool doubletap=false, bool activeX=false, bool activeY=false, bool activeZ=false, bool newData=false, bool freefall=false, bool orient=false)</td></tr>
|
|
<tr class="memdesc:acb0f914a65e394190d23748e3288b2c8"><td class="mdescLeft"> </td><td class="mdescRight">Set which interrupts are enabled. <a href="#acb0f914a65e394190d23748e3288b2c8">More...</a><br /></td></tr>
|
|
<tr class="separator:acb0f914a65e394190d23748e3288b2c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe250bae308fa2e97d0989396afe047b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#abe250bae308fa2e97d0989396afe047b">mapInterruptPin</a> (bool singletap=false, bool doubletap=false, bool activity=false, bool newData=false, bool freefall=false, bool orient=false)</td></tr>
|
|
<tr class="memdesc:abe250bae308fa2e97d0989396afe047b"><td class="mdescLeft"> </td><td class="mdescRight">Set which interrupts are mapped to the INT pin. <a href="#abe250bae308fa2e97d0989396afe047b">More...</a><br /></td></tr>
|
|
<tr class="separator:abe250bae308fa2e97d0989396afe047b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae337ae7943e940fec12d509f1d07e5b"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#aae337ae7943e940fec12d509f1d07e5b">getClick</a> (void)</td></tr>
|
|
<tr class="memdesc:aae337ae7943e940fec12d509f1d07e5b"><td class="mdescLeft"> </td><td class="mdescRight">Gets the most recent click detect status register value. <a href="#aae337ae7943e940fec12d509f1d07e5b">More...</a><br /></td></tr>
|
|
<tr class="separator:aae337ae7943e940fec12d509f1d07e5b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6fd8c7ea812cfa3187d8880fafdaa812"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#a6fd8c7ea812cfa3187d8880fafdaa812">getMotionInterruptStatus</a> (void)</td></tr>
|
|
<tr class="memdesc:a6fd8c7ea812cfa3187d8880fafdaa812"><td class="mdescLeft"> </td><td class="mdescRight">Gets the most recent motion interrupt status register value. <a href="#a6fd8c7ea812cfa3187d8880fafdaa812">More...</a><br /></td></tr>
|
|
<tr class="separator:a6fd8c7ea812cfa3187d8880fafdaa812"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfe2d9e960b0437324409df13e841039"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#adfe2d9e960b0437324409df13e841039">getDataInterruptStatus</a> (void)</td></tr>
|
|
<tr class="memdesc:adfe2d9e960b0437324409df13e841039"><td class="mdescLeft"> </td><td class="mdescRight">Gets the most recent data interrupt status register value. <a href="#adfe2d9e960b0437324409df13e841039">More...</a><br /></td></tr>
|
|
<tr class="separator:adfe2d9e960b0437324409df13e841039"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ace0b16d072e2a7efcb300cd0d1073beb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#ace0b16d072e2a7efcb300cd0d1073beb">setClick</a> (bool tap_quiet, bool tap_shock, <a class="el" href="_adafruit___m_s_a301_8h.html#ad3222eb550403305b115ac3e37541397">msa301_tapduration_t</a> tapduration, uint8_t tapthresh)</td></tr>
|
|
<tr class="memdesc:ace0b16d072e2a7efcb300cd0d1073beb"><td class="mdescLeft"> </td><td class="mdescRight">Set the click detection register thresholds. <a href="#ace0b16d072e2a7efcb300cd0d1073beb">More...</a><br /></td></tr>
|
|
<tr class="separator:ace0b16d072e2a7efcb300cd0d1073beb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a6b2f5b6467137f9376c2e81c983128dd"><td class="memItemLeft" align="right" valign="top"><a id="a6b2f5b6467137f9376c2e81c983128dd"></a>
|
|
int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#a6b2f5b6467137f9376c2e81c983128dd">x</a></td></tr>
|
|
<tr class="memdesc:a6b2f5b6467137f9376c2e81c983128dd"><td class="mdescLeft"> </td><td class="mdescRight">The last read X acceleration in raw units. <br /></td></tr>
|
|
<tr class="separator:a6b2f5b6467137f9376c2e81c983128dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac5dad4e6af2268f3322232c2f1bd15fd"><td class="memItemLeft" align="right" valign="top"><a id="ac5dad4e6af2268f3322232c2f1bd15fd"></a>
|
|
int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#ac5dad4e6af2268f3322232c2f1bd15fd">y</a></td></tr>
|
|
<tr class="memdesc:ac5dad4e6af2268f3322232c2f1bd15fd"><td class="mdescLeft"> </td><td class="mdescRight">The last read Y acceleration in raw units. <br /></td></tr>
|
|
<tr class="separator:ac5dad4e6af2268f3322232c2f1bd15fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acfa3e71c67c222ab00fbd9937f6b452d"><td class="memItemLeft" align="right" valign="top"><a id="acfa3e71c67c222ab00fbd9937f6b452d"></a>
|
|
int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#acfa3e71c67c222ab00fbd9937f6b452d">z</a></td></tr>
|
|
<tr class="memdesc:acfa3e71c67c222ab00fbd9937f6b452d"><td class="mdescLeft"> </td><td class="mdescRight">The last read Z acceleration in raw units. <br /></td></tr>
|
|
<tr class="separator:acfa3e71c67c222ab00fbd9937f6b452d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:affd00ffa3e42f54781aabe78e4d74d27"><td class="memItemLeft" align="right" valign="top"><a id="affd00ffa3e42f54781aabe78e4d74d27"></a>
|
|
float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#affd00ffa3e42f54781aabe78e4d74d27">x_g</a></td></tr>
|
|
<tr class="memdesc:affd00ffa3e42f54781aabe78e4d74d27"><td class="mdescLeft"> </td><td class="mdescRight">The last read X acceleration in 'g'. <br /></td></tr>
|
|
<tr class="separator:affd00ffa3e42f54781aabe78e4d74d27"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48ba58d6e4d2853a4232237bd5976bee"><td class="memItemLeft" align="right" valign="top"><a id="a48ba58d6e4d2853a4232237bd5976bee"></a>
|
|
float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#a48ba58d6e4d2853a4232237bd5976bee">y_g</a></td></tr>
|
|
<tr class="memdesc:a48ba58d6e4d2853a4232237bd5976bee"><td class="mdescLeft"> </td><td class="mdescRight">The last read Y acceleration in 'g'. <br /></td></tr>
|
|
<tr class="separator:a48ba58d6e4d2853a4232237bd5976bee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d660c9b4240d651677782b6f04d89a2"><td class="memItemLeft" align="right" valign="top"><a id="a4d660c9b4240d651677782b6f04d89a2"></a>
|
|
float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_adafruit___m_s_a301.html#a4d660c9b4240d651677782b6f04d89a2">z_g</a></td></tr>
|
|
<tr class="memdesc:a4d660c9b4240d651677782b6f04d89a2"><td class="mdescLeft"> </td><td class="mdescRight">The last read X acceleration in 'g'. <br /></td></tr>
|
|
<tr class="separator:a4d660c9b4240d651677782b6f04d89a2"><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 an MSA301 accelerometer </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aad5f7d858435bc0cfd53e43543de5e77"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aad5f7d858435bc0cfd53e43543de5e77">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_MSA301::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>i2c_address</em> = <code><a class="el" href="_adafruit___m_s_a301_8h.html#a02705daafb136c6d255f81ba14f2f17a">MSA301_I2CADDR_DEFAULT</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_address</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="abd07c6b2f9229b50015df486f05c32f0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd07c6b2f9229b50015df486f05c32f0">◆ </a></span>setDataRate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_MSA301::setDataRate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_adafruit___m_s_a301_8h.html#a6157095eda79f17774c4c2f1317b9787">msa301_dataRate_t</a> </td>
|
|
<td class="paramname"><em>dataRate</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the data rate for the MSA301 (controls power consumption) from 1 Hz to 1000Hz. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dataRate</td><td>Enumerated msa301_dataRate_t </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0781e09becb172bf964135a4d9d0dd3f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0781e09becb172bf964135a4d9d0dd3f">◆ </a></span>getDataRate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_adafruit___m_s_a301_8h.html#a6157095eda79f17774c4c2f1317b9787">msa301_dataRate_t</a> Adafruit_MSA301::getDataRate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the data rate for the MSA301 (controls power consumption) </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Enumerated msa301_dataRate_t from 1 Hz to 1000Hz </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a23af00e3b11e8ce2c079dadccd5bdfef"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a23af00e3b11e8ce2c079dadccd5bdfef">◆ </a></span>enableAxes()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_MSA301::enableAxes </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enableX</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enableY</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enableZ</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>What axes of the accelerometer we want enabled for reading. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enableX</td><td>True to enable X axis </td></tr>
|
|
<tr><td class="paramname">enableY</td><td>True to enable Y axis </td></tr>
|
|
<tr><td class="paramname">enableZ</td><td>True to enable Z axis </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afc2a41b87af32e1dd5716dea0959f1ee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afc2a41b87af32e1dd5716dea0959f1ee">◆ </a></span>setPowerMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_MSA301::setPowerMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_adafruit___m_s_a301_8h.html#a378ad6a06ce1fb3dd4bffd46cd777db6">msa301_powermode_t</a> </td>
|
|
<td class="paramname"><em>mode</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the power mode, MSA301_NORMALMODE, MSA301_LOWPOWERMODE or MSA301_SUSPENDMODE. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mode</td><td>Enumerated msa301_powermode_t </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afd44736492a4c71751d6769caa789e92"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afd44736492a4c71751d6769caa789e92">◆ </a></span>getPowerMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_adafruit___m_s_a301_8h.html#a378ad6a06ce1fb3dd4bffd46cd777db6">msa301_powermode_t</a> Adafruit_MSA301::getPowerMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the power mode. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Enumerated msa301_powermode_t, MSA301_NORMALMODE, MSA301_LOWPOWERMODE or MSA301_SUSPENDMODE </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a97b147eda3a235ced4b274ef3a97880d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a97b147eda3a235ced4b274ef3a97880d">◆ </a></span>setBandwidth()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_MSA301::setBandwidth </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_adafruit___m_s_a301_8h.html#aa2c734650d868a7644293205d75830c0">msa301_bandwidth_t</a> </td>
|
|
<td class="paramname"><em>bandwidth</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the bandwidth, ranges from 1.95Hz to 500Hz. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">bandwidth</td><td>Enumerated msa301_range_t </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a926d66adf881068590c401f00a18b0b3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a926d66adf881068590c401f00a18b0b3">◆ </a></span>getBandwidth()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_adafruit___m_s_a301_8h.html#aa2c734650d868a7644293205d75830c0">msa301_bandwidth_t</a> Adafruit_MSA301::getBandwidth </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the bandwidth. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Enumerated msa301_bandwidth_t, ranges from 1.95Hz to 500Hz </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a36d5cc7e86bdebebcff5e6c23f4d8c73"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a36d5cc7e86bdebebcff5e6c23f4d8c73">◆ </a></span>setRange()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_MSA301::setRange </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_adafruit___m_s_a301_8h.html#a1b3d6cc9fd621b2d85fae2e6aeb2619a">msa301_range_t</a> </td>
|
|
<td class="paramname"><em>range</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the resolution range: +-2g, 4g, 8g, or 16g. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">range</td><td>Enumerated msa301_range_t </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1deca0c8ff66457ae37f6b2e4aaffb2c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1deca0c8ff66457ae37f6b2e4aaffb2c">◆ </a></span>getRange()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_adafruit___m_s_a301_8h.html#a1b3d6cc9fd621b2d85fae2e6aeb2619a">msa301_range_t</a> Adafruit_MSA301::getRange </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read the resolution range: +-2g, 4g, 8g, or 16g. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Enumerated msa301_range_t </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a992066f83e0cf502bde3487068809e61"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a992066f83e0cf502bde3487068809e61">◆ </a></span>setResolution()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_MSA301::setResolution </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_adafruit___m_s_a301_8h.html#af2868ca3325a48160428cf7cf66e472c">msa301_resolution_t</a> </td>
|
|
<td class="paramname"><em>resolution</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the resolution - 8, 10, 12, or 14bits. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">resolution</td><td>Enumerated msa301_resolution_t </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a71c1a3e5634e699c82b8286e8f85c7ad"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a71c1a3e5634e699c82b8286e8f85c7ad">◆ </a></span>getResolution()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_adafruit___m_s_a301_8h.html#af2868ca3325a48160428cf7cf66e472c">msa301_resolution_t</a> Adafruit_MSA301::getResolution </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read the resolution - 8, 10, 12, or 14bits. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Enumerated msa301_resolution_t </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a16526d972220840724da02971fdaa737"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a16526d972220840724da02971fdaa737">◆ </a></span>getEvent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Adafruit_MSA301::getEvent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">sensors_event_t * </td>
|
|
<td class="paramname"><em>event</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the most recent sensor event, Adafruit Unified Sensor format. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">event</td><td>Pointer to an Adafruit Unified sensor_event_t object that we'll fill in </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True on successful read </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a29740b295c91a63b88927a160ff7ac6d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a29740b295c91a63b88927a160ff7ac6d">◆ </a></span>getSensor()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_MSA301::getSensor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">sensor_t * </td>
|
|
<td class="paramname"><em>sensor</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the sensor_t device data, Adafruit Unified Sensor format. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sensor</td><td>Pointer to an Adafruit Unified sensor_t object that we'll fill in </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acb0f914a65e394190d23748e3288b2c8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acb0f914a65e394190d23748e3288b2c8">◆ </a></span>enableInterrupts()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_MSA301::enableInterrupts </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>singletap</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>doubletap</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>activeX</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>activeY</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>activeZ</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>newData</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>freefall</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>orient</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set which interrupts are enabled. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">singletap</td><td>Whether to trigger INT on single tap interrupt </td></tr>
|
|
<tr><td class="paramname">doubletap</td><td>Whether to trigger INT on double tap interrupt </td></tr>
|
|
<tr><td class="paramname">activeX</td><td>Whether to trigger INT on X axis activity interrupt </td></tr>
|
|
<tr><td class="paramname">activeY</td><td>Whether to trigger INT on Y axis activity interrupt </td></tr>
|
|
<tr><td class="paramname">activeZ</td><td>Whether to trigger INT on Z axis activity interrupt </td></tr>
|
|
<tr><td class="paramname">newData</td><td>Whether to trigger INT on new data available interrupt </td></tr>
|
|
<tr><td class="paramname">freefall</td><td>Whether to trigger INT on freefall interrupt </td></tr>
|
|
<tr><td class="paramname">orient</td><td>Whether to trigger INT on orientation interrupt </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abe250bae308fa2e97d0989396afe047b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abe250bae308fa2e97d0989396afe047b">◆ </a></span>mapInterruptPin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_MSA301::mapInterruptPin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>singletap</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>doubletap</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>activity</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>newData</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>freefall</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>orient</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set which interrupts are mapped to the INT pin. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">singletap</td><td>Whether to trigger INT on single tap interrupt </td></tr>
|
|
<tr><td class="paramname">doubletap</td><td>Whether to trigger INT on double tap interrupt </td></tr>
|
|
<tr><td class="paramname">activity</td><td>Whether to trigger INT on activity interrupt </td></tr>
|
|
<tr><td class="paramname">newData</td><td>Whether to trigger INT on new data available interrupt </td></tr>
|
|
<tr><td class="paramname">freefall</td><td>Whether to trigger INT on freefall interrupt </td></tr>
|
|
<tr><td class="paramname">orient</td><td>Whether to trigger INT on orientation interrupt </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aae337ae7943e940fec12d509f1d07e5b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aae337ae7943e940fec12d509f1d07e5b">◆ </a></span>getClick()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t Adafruit_MSA301::getClick </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the most recent click detect status register value. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>8 bits of interrupt status, check datasheet for what CLICKSTATUS bits are </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6fd8c7ea812cfa3187d8880fafdaa812"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6fd8c7ea812cfa3187d8880fafdaa812">◆ </a></span>getMotionInterruptStatus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t Adafruit_MSA301::getMotionInterruptStatus </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the most recent motion interrupt status register value. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>8 bits of interrupt status, check datasheet for what MOTION bits are </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adfe2d9e960b0437324409df13e841039"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adfe2d9e960b0437324409df13e841039">◆ </a></span>getDataInterruptStatus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t Adafruit_MSA301::getDataInterruptStatus </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the most recent data interrupt status register value. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>8 bits of interrupt status, check datasheet for what DATAINT bits are </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ace0b16d072e2a7efcb300cd0d1073beb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ace0b16d072e2a7efcb300cd0d1073beb">◆ </a></span>setClick()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Adafruit_MSA301::setClick </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>tap_quiet</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>tap_shock</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_adafruit___m_s_a301_8h.html#ad3222eb550403305b115ac3e37541397">msa301_tapduration_t</a> </td>
|
|
<td class="paramname"><em>tapduration</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>tapthresh</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the click detection register thresholds. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">tap_quiet</td><td>TAP_QUIET flag (check datasheet for details) </td></tr>
|
|
<tr><td class="paramname">tap_shock</td><td>TAP_SHOCK flag (check datasheet for details) </td></tr>
|
|
<tr><td class="paramname">tapduration</td><td>How long to listen for a second tap (check datasheet for details) </td></tr>
|
|
<tr><td class="paramname">tapthresh</td><td>How strong the tap signal has to be (check datasheet for details) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="_adafruit___m_s_a301_8h_source.html">Adafruit_MSA301.h</a></li>
|
|
<li><a class="el" href="_adafruit___m_s_a301_8cpp.html">Adafruit_MSA301.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>
|