133 lines
11 KiB
HTML
133 lines
11 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<title>RTOS_MSPM0: RTOS_Labs_common/IRDistance.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="projectlogo"><img alt="Logo" src="RobotSensors.png"/></td>
|
||
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">RTOS_MSPM0
|
||
|
|
 <span id="projectnumber">1.1</span>
|
||
|
|
</div>
|
||
|
|
<div id="projectbrief">ECE445M starter code</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||
|
|
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||
|
|
$(function() {
|
||
|
|
initMenu('',true,false,'search.php','Search');
|
||
|
|
$(document).ready(function() { init_search(); });
|
||
|
|
});
|
||
|
|
/* @license-end */</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 id="nav-path" class="navpath">
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><a class="el" href="dir_d9737668015ddda3d9b152d7c8d1103c.html">RTOS_Labs_common</a></li> </ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">IRDistance.h</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<a href="_i_r_distance_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>  </div>
|
||
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">/* This example accompanies the book</span></div>
|
||
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> "Embedded Systems: Introduction to Robotics,</span></div>
|
||
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> Jonathan W. Valvano, ISBN: 9781074544300, copyright (c) 2020</span></div>
|
||
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> For more information about my classes, my research, and my books, see</span></div>
|
||
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> http://users.ece.utexas.edu/~valvano/</span></div>
|
||
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span> </div>
|
||
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">Simplified BSD License (FreeBSD License)</span></div>
|
||
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">Copyright (c) 2020, Jonathan Valvano, All rights reserved.</span></div>
|
||
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span> </div>
|
||
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">Redistribution and use in source and binary forms, with or without modification,</span></div>
|
||
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">are permitted provided that the following conditions are met:</span></div>
|
||
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span> </div>
|
||
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">1. Redistributions of source code must retain the above copyright notice,</span></div>
|
||
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> this list of conditions and the following disclaimer.</span></div>
|
||
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">2. Redistributions in binary form must reproduce the above copyright notice,</span></div>
|
||
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> this list of conditions and the following disclaimer in the documentation</span></div>
|
||
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> and/or other materials provided with the distribution.</span></div>
|
||
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span> </div>
|
||
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"</span></div>
|
||
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div>
|
||
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div>
|
||
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</span></div>
|
||
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span></div>
|
||
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;</span></div>
|
||
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED</span></div>
|
||
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,</span></div>
|
||
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE</span></div>
|
||
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
|
||
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span> </div>
|
||
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">The views and conclusions contained in the software and documentation are</span></div>
|
||
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">those of the authors and should not be interpreted as representing official</span></div>
|
||
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">policies, either expressed or implied, of the FreeBSD Project.</span></div>
|
||
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">*/</span></div>
|
||
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
|
||
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// 5V connected to all GP2Y0A21YK0F Vcc's (+5V)</span></div>
|
||
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// 5V connected to positive side of 10 uF capacitors physically near the sensors</span></div>
|
||
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// ground connected to all GP2Y0A21YK0F grounds and microcontroller ground</span></div>
|
||
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// ground connected to negative side of all 10 uF capacitors</span></div>
|
||
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
||
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
||
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
||
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#ifndef IRDISTANCE_H_</span></div>
|
||
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#define IRDISTANCE_H_</span></div>
|
||
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#include <stdint.h></span></div>
|
||
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
||
|
|
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="_i_r_distance_8h.html#a60586073f932575a2fdffacfbd7aad8c"> 70</a></span> int32_t <a class="code" href="_i_r_distance_8h.html#a60586073f932575a2fdffacfbd7aad8c">IRDistance_Convert</a>(int32_t adcSample, uint32_t sensor);</div>
|
||
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  </div>
|
||
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
|
||
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#endif </span><span class="comment">/* IRDISTANCE_H_ */</span><span class="preprocessor"></span></div>
|
||
|
|
<div class="ttc" id="a_i_r_distance_8h_html_a60586073f932575a2fdffacfbd7aad8c"><div class="ttname"><a href="_i_r_distance_8h.html#a60586073f932575a2fdffacfbd7aad8c">IRDistance_Convert</a></div><div class="ttdeci">int32_t IRDistance_Convert(int32_t adcSample, uint32_t sensor)</div><div class="ttdoc">Convert infrared distance measurement.</div></div>
|
||
|
|
</div><!-- fragment --></div><!-- contents -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<hr class="footer"/><address class="footer"><small>
|
||
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
||
|
|
</small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|