forked from adafruit/Adafruit_Sensor
82 lines
30 KiB
HTML
82 lines
30 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 Unified Sensor Library: Adafruit_Sensor.h Source File</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 Unified 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>
|
||
|
|
</div><!-- top -->
|
||
|
|
<!-- window showing the filter options -->
|
||
|
|
<div id="MSearchSelectWindow"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- iframe showing the search results (closed by default) -->
|
||
|
|
<div id="MSearchResultsWindow">
|
||
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
||
|
|
name="MSearchResults" id="MSearchResults">
|
||
|
|
</iframe>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="header">
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">Adafruit_Sensor.h</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 2008 The Android Open Source Project</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software< /span></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> */</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">/* Update by K. Townsend (Adafruit Industries) for lighter typedefs, and</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * extended sensor support to include color, voltage and current */</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef _ADAFRUIT_SENSOR_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define _ADAFRUIT_SENSOR_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef ARDUINO</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <stdint.h></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#elif ARDUINO >= 100</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "Arduino.h"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "Print.h"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#else</span></div><div
|
||
|
|
<div class="ttc" id="class_adafruit___sensor_html"><div class="ttname"><a href="class_adafruit___sensor.html">Adafruit_Sensor</a></div><div class="ttdoc">Common sensor interface to unify various sensors. Intentionally modeled after sensors.h in the Android API: https://github.com/android/platform_hardware_libhardware/blob/master/include/hardware/sensors.h. </div><div class="ttdef"><b>Definition:</b> Adafruit_Sensor.h:160</div></div>
|
||
|
|
<div class="ttc" id="class_adafruit___sensor_html_a0636562b9bc853b796ecc87b5d4b1bec"><div class="ttname"><a href="class_adafruit___sensor.html#a0636562b9bc853b796ecc87b5d4b1bec">Adafruit_Sensor::getEvent</a></div><div class="ttdeci">virtual bool getEvent(sensors_event_t *)=0</div><div class="ttdoc">Get the latest sensor event. </div></div>
|
||
|
|
<div class="ttc" id="class_adafruit___sensor_html_af994cc1147831134ad7bf7b2c99d7478"><div class="ttname"><a href="class_adafruit___sensor.html#af994cc1147831134ad7bf7b2c99d7478">Adafruit_Sensor::printSensorDetails</a></div><div class="ttdeci">void printSensorDetails(void)</div><div class="ttdoc">Prints sensor information to serial console. </div><div class="ttdef"><b>Definition:</b> Adafruit_Sensor.cpp:8</div></div>
|
||
|
|
<div class="ttc" id="structsensor__t_html"><div class="ttname"><a href="structsensor__t.html">sensor_t</a></div><div class="ttdef"><b>Definition:</b> Adafruit_Sensor.h:143</div></div>
|
||
|
|
<div class="ttc" id="structsensors__event__t_html"><div class="ttname"><a href="structsensors__event__t.html">sensors_event_t</a></div><div class="ttdef"><b>Definition:</b> Adafruit_Sensor.h:115</div></div>
|
||
|
|
<div class="ttc" id="class_adafruit___sensor_html_a19e844c1eb2dc37cb72705d5572c4676"><div class="ttname"><a href="class_adafruit___sensor.html#a19e844c1eb2dc37cb72705d5572c4676">Adafruit_Sensor::getSensor</a></div><div class="ttdeci">virtual void getSensor(sensor_t *)=0</div><div class="ttdoc">Get info about the sensor itself. </div></div>
|
||
|
|
<div class="ttc" id="structsensors__color__t_html"><div class="ttname"><a href="structsensors__color__t.html">sensors_color_t</a></div><div class="ttdef"><b>Definition:</b> Adafruit_Sensor.h:99</div></div>
|
||
|
|
<div class="ttc" id="class_adafruit___sensor_html_ace6c1f26eeb956f95801b9fc1841f3a0"><div class="ttname"><a href="class_adafruit___sensor.html#ace6c1f26eeb956f95801b9fc1841f3a0">Adafruit_Sensor::enableAutoRange</a></div><div class="ttdeci">virtual void enableAutoRange(bool enabled)</div><div class="ttdoc">Whether we should automatically change the range (if possible) for higher precision. </div><div class="ttdef"><b>Definition:</b> Adafruit_Sensor.h:171</div></div>
|
||
|
|
</div><!-- fragment --></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>
|