all
This commit is contained in:
197
Documentation/html/group___l_d19.html
Normal file
197
Documentation/html/group___l_d19.html
Normal file
@@ -0,0 +1,197 @@
|
||||
<!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: LD19</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>
|
||||
</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="summary">
|
||||
<a href="#files">Files</a> |
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">LD19</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Asynchronous serial communication to LiDAR Sensor LD19 distance sensor.
|
||||
<a href="#details">More...</a></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
|
||||
Files</h2></td></tr>
|
||||
<tr class="memitem:_l_d19_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="_l_d19_8h.html">LD19.h</a></td></tr>
|
||||
<tr class="memdesc:_l_d19_8h"><td class="mdescLeft"> </td><td class="mdescRight">Initialize LD19, interrupt synchronization. <br /></td></tr>
|
||||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr class="memitem:gaee40342fe25b4deb8633e2193a6807ee"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___l_d19.html#gaee40342fe25b4deb8633e2193a6807ee">LD19_Init</a> (uint16_t *d)</td></tr>
|
||||
<tr class="memdesc:gaee40342fe25b4deb8633e2193a6807ee"><td class="mdescLeft"> </td><td class="mdescRight">Initialize LD19. <a href="group___l_d19.html#gaee40342fe25b4deb8633e2193a6807ee">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaee40342fe25b4deb8633e2193a6807ee"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaa2acd79f9efa689b4df3588a54e38948"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___l_d19.html#gaa2acd79f9efa689b4df3588a54e38948">LD19_InChar</a> (void)</td></tr>
|
||||
<tr class="separator:gaa2acd79f9efa689b4df3588a54e38948"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga517bd27e6c19463b8ea5b04f4c35fece"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___l_d19.html#ga517bd27e6c19463b8ea5b04f4c35fece">LD19_InStatus</a> (void)</td></tr>
|
||||
<tr class="separator:ga517bd27e6c19463b8ea5b04f4c35fece"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Asynchronous serial communication to LiDAR Sensor LD19 distance sensor. </p>
|
||||
<a class="anchor" id="LD19pins0"></a>
|
||||
<table class="doxtable">
|
||||
<caption>LiDAR Sensor LD19 distance sensor interface</caption>
|
||||
<tr>
|
||||
<th>Pin </th><th>LD19 </th><th>MSPM0 </th></tr>
|
||||
<tr>
|
||||
<td>1 </td><td>Tx </td><td>PB13 RxD: is UART3 Rx (LD19 to MSPM0) </td></tr>
|
||||
<tr>
|
||||
<td>2 </td><td>PWM </td><td>PB12 GPIO write a 0 to run fastest (MSPM0 to LD19) </td></tr>
|
||||
<tr>
|
||||
<td>3 </td><td>GND </td><td>ground </td></tr>
|
||||
<tr>
|
||||
<td>4 </td><td>P5V </td><td>5V </td></tr>
|
||||
</table>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a id="gaa2acd79f9efa689b4df3588a54e38948"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#gaa2acd79f9efa689b4df3588a54e38948">◆ </a></span>LD19_InChar()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint8_t LD19_InChar </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Wait for new serial port input<br />
|
||||
Uses interrupt synchronization<br />
|
||||
This function waits if the receive software FIFO is empty </p><dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">Input</td><td>none </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>8-bit code from TF Luna </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="gaee40342fe25b4deb8633e2193a6807ee"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#gaee40342fe25b4deb8633e2193a6807ee">◆ </a></span>LD19_Init()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void LD19_Init </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint16_t * </td>
|
||||
<td class="paramname"><em>d</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Initialize LD19. </p>
|
||||
<p>initializeLiDAR Sensor LD19 distance sensor 230400 bps baud rate.<br />
|
||||
interrupt synchronization </p><dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">d</td><td>0 for debug, pointer to array of 540 elements for read time </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ga517bd27e6c19463b8ea5b04f4c35fece"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ga517bd27e6c19463b8ea5b04f4c35fece">◆ </a></span>LD19_InStatus()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint32_t LD19_InStatus </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Returns how much data available for reading </p><dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">none</td><td></td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>number of elements in receive software FIFO </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</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>
|
||||
Reference in New Issue
Block a user