Merge pull request #48 from utra-robosoccer/Update_documentation

Update documentation

Robot/Doc/html/_m_p_u6050_8h.html

@@ -124,7 +124,9 @@
 <div class="center"><img src="_m_p_u6050_8h__dep__incl.png" border="0" usemap="#_d_1_2_users_2_tyler_2_documents_2_s_t_m_2embedded_2soccer-embedded_2_robot_2_drivers_2_m_p_u6050_2_m_p_u6050_8hdep" alt=""/></div>
 <map name="_d_1_2_users_2_tyler_2_documents_2_s_t_m_2embedded_2soccer-embedded_2_robot_2_drivers_2_m_p_u6050_2_m_p_u6050_8hdep" id="_d_1_2_users_2_tyler_2_documents_2_s_t_m_2embedded_2soccer-embedded_2_robot_2_drivers_2_m_p_u6050_2_m_p_u6050_8hdep">
 <area shape="rect" id="node2" href="_m_p_u6050_8c.html" title="This. " alt="" coords="5,109,241,165"/>
-<area shape="rect" id="node3" href="freertos_8c.html" title="Code for freertos application. " alt="" coords="266,109,490,165"/>
+<area shape="rect" id="node3" href="_m_p_u_filter_8h.html" title="Header code for IMU filtering. " alt="" coords="266,109,503,165"/>
+<area shape="rect" id="node5" href="freertos_8c.html" title="Code for freertos application. " alt="" coords="429,213,653,269"/>
+<area shape="rect" id="node4" href="_m_p_u_filter_8c.html" title="Digital filtering data structures and functions, for IMU data. " alt="" coords="167,213,405,269"/>
 </map>
 </div>
 </div>

Robot/Doc/html/_m_p_u6050_8h__dep__incl.map

@@ -1,4 +1,6 @@
 <map id="D:/Users/Tyler/Documents/STM/embedded/soccer&#45;embedded/Robot/Drivers/MPU6050/MPU6050.h" name="D:/Users/Tyler/Documents/STM/embedded/soccer&#45;embedded/Robot/Drivers/MPU6050/MPU6050.h">
 <area shape="rect" id="node2" href="$_m_p_u6050_8c.html" title="This. " alt="" coords="5,109,241,165"/>
-<area shape="rect" id="node3" href="$freertos_8c.html" title="Code for freertos application. " alt="" coords="266,109,490,165"/>
+<area shape="rect" id="node3" href="$_m_p_u_filter_8h.html" title="Header code for IMU filtering. " alt="" coords="266,109,503,165"/>
+<area shape="rect" id="node5" href="$freertos_8c.html" title="Code for freertos application. " alt="" coords="429,213,653,269"/>
+<area shape="rect" id="node4" href="$_m_p_u_filter_8c.html" title="Digital filtering data structures and functions, for IMU data. " alt="" coords="167,213,405,269"/>
 </map>

Robot/Doc/html/_m_p_u6050_8h__dep__incl.md5

@@ -1 +1 @@
-f269a1a3e7d1554403db8da3bfa0afd0
+bcd259dc146b9bfc5b8f04f84694f5e7

Robot/Doc/html/_m_p_u_filter_8c.js

@@ -0,0 +1,15 @@
+var _m_p_u_filter_8c =
+[
+    [ "MPUFilter_FilterAngularVelocity", "group___i_m_u___filter___public___functions.html#ga6fe05d6ccad148fcc051d3e731fd8f78", null ],
+    [ "MPUFilter_InitAllFilters", "group___i_m_u___filter___public___functions.html#ga673920b95d4804093d1c53f3f48e8788", null ],
+    [ "MPUFilter_initVel", "group___i_m_u___filter___private___functions.html#ga1cd85aa20cefe82040d02b3652d422e2", null ],
+    [ "MPUFilter_readOutputVel", "group___i_m_u___filter___private___functions.html#ga82ea08aecf1ca8e3d37365769af957ba", null ],
+    [ "MPUFilter_resetVel", "group___i_m_u___filter___private___functions.html#ga2ef910506c16ade4a588ee02328c989a", null ],
+    [ "MPUFilter_writeInputVel", "group___i_m_u___filter___private___functions.html#ga432328c7370026e6c18835714c68d320", null ],
+    [ "MPUFilter_blockSizeVel", "group___i_m_u___filter.html#ga89b9b20cbcca5ad2eedb5f52e0bec122", null ],
+    [ "MPUFilter_coefficientsVel", "group___i_m_u___filter.html#ga1d48f9a230def2d0c1087635fad8390e", null ],
+    [ "MPUFilter_numTapsVel", "group___i_m_u___filter.html#ga58aa69cc5ded92c50f084564e1176ed9", null ],
+    [ "vxFilter", "group___i_m_u___filter.html#ga5af7d042b9c9afcc5d2087d4ace3f06d", null ],
+    [ "vyFilter", "group___i_m_u___filter.html#ga8a59105e0b6d72c21a503e4e10c9d990", null ],
+    [ "vzFilter", "group___i_m_u___filter.html#ga3f587bd44ec2d158db020a5fe6bff508", null ]
+];

Robot/Doc/html/_m_p_u_filter_8c__incl.map

@@ -0,0 +1,9 @@
+<map id="D:/Users/Tyler/Documents/STM/embedded/soccer&#45;embedded/Robot/Drivers/MPU6050/MPUFilter.c" name="D:/Users/Tyler/Documents/STM/embedded/soccer&#45;embedded/Robot/Drivers/MPU6050/MPUFilter.c">
+<area shape="rect" id="node2" href="$_m_p_u_filter_8h.html" title="Header code for IMU filtering. " alt="" coords="307,109,398,136"/>
+<area shape="rect" id="node5" href="$_m_p_u6050_8h.html" title="Header code for the MPU6050 library, including the struct in which accelerometer and gyroscope data a..." alt="" coords="365,184,455,211"/>
+<area shape="rect" id="node6" href="$i2c_8h_source.html" title="i2c.h" alt="" coords="343,259,394,285"/>
+<area shape="rect" id="node10" href="$usart_8h_source.html" title="usart.h" alt="" coords="419,259,481,285"/>
+<area shape="rect" id="node11" href="$gpio_8h_source.html" title="gpio.h" alt="" coords="505,259,563,285"/>
+<area shape="rect" id="node14" href="$shared_macros_8h.html" title="This file defines macros used throughout various parts of the system that engage in non&#45;blocking I/O ..." alt="" coords="205,259,319,285"/>
+<area shape="rect" id="node8" href="$main_8h.html" title=": Header for main.c file. This file contains the common defines of the application. " alt="" coords="446,333,507,360"/>
+</map>

Robot/Doc/html/_m_p_u_filter_8c__incl.md5

@@ -0,0 +1 @@
+37c89f808c50785fc15ed401f3e837aa

Robot/Doc/html/_m_p_u_filter_8h.html

@@ -0,0 +1,151 @@
+<!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.14"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Robot: D:/Users/Tyler/Documents/STM/embedded/soccer-embedded/Robot/Drivers/MPU6050/MPUFilter.h File 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="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtreedata.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+  $(document).ready(initResizable);
+/* @license-end */</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">Robot
+   </div>
+   <div id="projectbrief">The embedded systems for UTRA&#39;s autonomous humanoid soccer-playing robot</div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.14 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+/* @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&amp;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 -->
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+  <div id="nav-tree">
+    <div id="nav-tree-contents">
+      <div id="nav-sync" class="sync"></div>
+    </div>
+  </div>
+  <div id="splitbar" style="-moz-user-select:none;" 
+       class="ui-resizable-handle">
+  </div>
+</div>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(document).ready(function(){initNavTree('_m_p_u_filter_8h.html','');});
+/* @license-end */
+</script>
+<div id="doc-content">
+<!-- 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="#define-members">Macros</a> &#124;
+<a href="#func-members">Functions</a>  </div>
+  <div class="headertitle">
+<div class="title">MPUFilter.h File Reference<div class="ingroups"><a class="el" href="group___m_p_u6050.html">MPU6050</a> &raquo; <a class="el" href="group___i_m_u___filter.html">IMU Filter</a></div></div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p>Header code for IMU filtering.  
+<a href="#details">More...</a></p>
+<div class="textblock"><code>#include &quot;stm32f446xx.h&quot;</code><br />
+<code>#include &lt;arm_math.h&gt;</code><br />
+<code>#include &quot;<a class="el" href="_m_p_u6050_8h_source.html">MPU6050.h</a>&quot;</code><br />
+</div><div class="textblock"><div class="dynheader">
+Include dependency graph for MPUFilter.h:</div>
+<div class="dyncontent">
+<div class="center"><img src="_m_p_u_filter_8h__incl.png" border="0" usemap="#_d_1_2_users_2_tyler_2_documents_2_s_t_m_2embedded_2soccer-embedded_2_robot_2_drivers_2_m_p_u6050_2_m_p_u_filter_8h" alt=""/></div>
+<map name="_d_1_2_users_2_tyler_2_documents_2_s_t_m_2embedded_2soccer-embedded_2_robot_2_drivers_2_m_p_u6050_2_m_p_u_filter_8h" id="_d_1_2_users_2_tyler_2_documents_2_s_t_m_2embedded_2soccer-embedded_2_robot_2_drivers_2_m_p_u6050_2_m_p_u_filter_8h">
+<area shape="rect" id="node4" href="_m_p_u6050_8h.html" title="Header code for the MPU6050 library, including the struct in which accelerometer and gyroscope data a..." alt="" coords="251,109,341,136"/>
+<area shape="rect" id="node5" href="i2c_8h_source.html" title="i2c.h" alt="" coords="8,184,59,211"/>
+<area shape="rect" id="node9" href="usart_8h_source.html" title="usart.h" alt="" coords="83,184,146,211"/>
+<area shape="rect" id="node10" href="gpio_8h_source.html" title="gpio.h" alt="" coords="170,184,227,211"/>
+<area shape="rect" id="node13" href="shared_macros_8h.html" title="This file defines macros used throughout various parts of the system that engage in non&#45;blocking I/O ..." alt="" coords="539,184,653,211"/>
+<area shape="rect" id="node7" href="main_8h.html" title=": Header for main.c file. This file contains the common defines of the application. " alt="" coords="60,259,121,285"/>
+</map>
+</div>
+</div><div class="textblock"><div class="dynheader">
+This graph shows which files directly or indirectly include this file:</div>
+<div class="dyncontent">
+<div class="center"><img src="_m_p_u_filter_8h__dep__incl.png" border="0" usemap="#_d_1_2_users_2_tyler_2_documents_2_s_t_m_2embedded_2soccer-embedded_2_robot_2_drivers_2_m_p_u6050_2_m_p_u_filter_8hdep" alt=""/></div>
+<map name="_d_1_2_users_2_tyler_2_documents_2_s_t_m_2embedded_2soccer-embedded_2_robot_2_drivers_2_m_p_u6050_2_m_p_u_filter_8hdep" id="_d_1_2_users_2_tyler_2_documents_2_s_t_m_2embedded_2soccer-embedded_2_robot_2_drivers_2_m_p_u6050_2_m_p_u_filter_8hdep">
+<area shape="rect" id="node2" href="_m_p_u_filter_8c.html" title="Digital filtering data structures and functions, for IMU data. " alt="" coords="5,109,243,165"/>
+<area shape="rect" id="node3" href="freertos_8c.html" title="Code for freertos application. " alt="" coords="267,109,491,165"/>
+</map>
+</div>
+</div>
+<p><a href="_m_p_u_filter_8h_source.html">Go to the source code of this file.</a></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
+Functions</h2></td></tr>
+<tr class="memitem:ga673920b95d4804093d1c53f3f48e8788"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___i_m_u___filter___public___functions.html#ga673920b95d4804093d1c53f3f48e8788">MPUFilter_InitAllFilters</a> ()</td></tr>
+<tr class="memdesc:ga673920b95d4804093d1c53f3f48e8788"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize acceleration and angular velocity FIR filters for IMU data.  <a href="group___i_m_u___filter___public___functions.html#ga673920b95d4804093d1c53f3f48e8788">More...</a><br /></td></tr>
+<tr class="separator:ga673920b95d4804093d1c53f3f48e8788"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga6fe05d6ccad148fcc051d3e731fd8f78"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___i_m_u___filter___public___functions.html#ga6fe05d6ccad148fcc051d3e731fd8f78">MPUFilter_FilterAngularVelocity</a> (<a class="el" href="struct_m_p_u6050___handle_type_def.html">MPU6050_HandleTypeDef</a> *IMUdata)</td></tr>
+<tr class="memdesc:ga6fe05d6ccad148fcc051d3e731fd8f78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads Vz, Vy, and Vx from the IMU handle and writes them into their corresponding FIR filters. The output of each FIR filter is then read and stored in the IMU handle where it was previously read.  <a href="group___i_m_u___filter___public___functions.html#ga6fe05d6ccad148fcc051d3e731fd8f78">More...</a><br /></td></tr>
+<tr class="separator:ga6fe05d6ccad148fcc051d3e731fd8f78"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>Header code for IMU filtering. </p>
+<dl class="section author"><dt>Author</dt><dd>Tyler </dd></dl>
+</div></div><!-- contents -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="navelem"><a class="el" href="dir_60925fc218da8ca7908795bf5f624060.html">Drivers</a></li><li class="navelem"><a class="el" href="dir_fde61189d878a4cdffdbb052e15fb1d5.html">MPU6050</a></li><li class="navelem"><a class="el" href="_m_p_u_filter_8h.html">MPUFilter.h</a></li>
+    <li class="footer">Generated by
+    <a href="http://www.doxygen.org/index.html">
+    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
+  </ul>
+</div>
+</body>
+</html>

Robot/Doc/html/_m_p_u_filter_8h.js

@@ -0,0 +1,6 @@
+var _m_p_u_filter_8h =
+[
+    [ "ARM_MATH_CM4", "_m_p_u_filter_8h.html#a42e162ee7b8b8c2663d1dbd31c7b590b", null ],
+    [ "MPUFilter_FilterAngularVelocity", "group___i_m_u___filter___public___functions.html#ga6fe05d6ccad148fcc051d3e731fd8f78", null ],
+    [ "MPUFilter_InitAllFilters", "group___i_m_u___filter___public___functions.html#ga673920b95d4804093d1c53f3f48e8788", null ]
+];

Robot/Doc/html/_m_p_u_filter_8h__dep__incl.map

@@ -0,0 +1,4 @@
+<map id="D:/Users/Tyler/Documents/STM/embedded/soccer&#45;embedded/Robot/Drivers/MPU6050/MPUFilter.h" name="D:/Users/Tyler/Documents/STM/embedded/soccer&#45;embedded/Robot/Drivers/MPU6050/MPUFilter.h">
+<area shape="rect" id="node2" href="$_m_p_u_filter_8c.html" title="Digital filtering data structures and functions, for IMU data. " alt="" coords="5,109,243,165"/>
+<area shape="rect" id="node3" href="$freertos_8c.html" title="Code for freertos application. " alt="" coords="267,109,491,165"/>
+</map>

Robot/Doc/html/_m_p_u_filter_8h__dep__incl.md5

@@ -0,0 +1 @@
+5f6a73760edbb870401c86ace95d6be0

Robot/Doc/html/_m_p_u_filter_8h__incl.map

@@ -0,0 +1,8 @@
+<map id="D:/Users/Tyler/Documents/STM/embedded/soccer&#45;embedded/Robot/Drivers/MPU6050/MPUFilter.h" name="D:/Users/Tyler/Documents/STM/embedded/soccer&#45;embedded/Robot/Drivers/MPU6050/MPUFilter.h">
+<area shape="rect" id="node4" href="$_m_p_u6050_8h.html" title="Header code for the MPU6050 library, including the struct in which accelerometer and gyroscope data a..." alt="" coords="251,109,341,136"/>
+<area shape="rect" id="node5" href="$i2c_8h_source.html" title="i2c.h" alt="" coords="8,184,59,211"/>
+<area shape="rect" id="node9" href="$usart_8h_source.html" title="usart.h" alt="" coords="83,184,146,211"/>
+<area shape="rect" id="node10" href="$gpio_8h_source.html" title="gpio.h" alt="" coords="170,184,227,211"/>
+<area shape="rect" id="node13" href="$shared_macros_8h.html" title="This file defines macros used throughout various parts of the system that engage in non&#45;blocking I/O ..." alt="" coords="539,184,653,211"/>
+<area shape="rect" id="node7" href="$main_8h.html" title=": Header for main.c file. This file contains the common defines of the application. " alt="" coords="60,259,121,285"/>
+</map>

Robot/Doc/html/_m_p_u_filter_8h__incl.md5

@@ -0,0 +1 @@
+f79c3b6d5a7dda0309dd4382660a9855