Commit 43e0c4d2 authored by Jens Noack's avatar Jens Noack

latest version of API

parent ef696ad1
......@@ -148,7 +148,7 @@ Functions</h2></td></tr>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -487,7 +487,7 @@ Functions</h2></td></tr>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -179,9 +179,11 @@ Functions</h2></td></tr>
<p>The speed is taken from the header file or set by one of the methods defined in the lower level drive methods section </p><dl class="section return"><dt>Returns</dt><dd>nothing </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d4/da7/_code_racer_8cpp_source.html#l00173">173</a> of file <a class="el" href="../../d4/da7/_code_racer_8cpp_source.html">CodeRacer.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;{</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; drive_forward(_drive_left_speed, _drive_right_speed);</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;}</div></div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="fragment"><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;{</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; drive_forward(_drive_left_speed, _drive_right_speed);</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;}</div></div><!-- fragment --><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="../../closed.png" alt="+"/> Here is the call graph for this function:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="../../d2/d40/group__higherlevelmeths_ga8be6a850099812153dcf5768d7fc8b8c_cgraph.png" border="0" usemap="#d2/d40/group__higherlevelmeths_ga8be6a850099812153dcf5768d7fc8b8c_cgraph" alt=""/></div>
</div>
......@@ -586,7 +588,7 @@ Here is the call graph for this function:</div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -101,7 +101,7 @@ Modules</h2></td></tr>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -92,7 +92,7 @@ $(document).ready(function(){initNavTree('d4/da7/_code_racer_8cpp_source.html','
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_a991eec27578c865874ede3d8ec657c2.html">Arduino</a></li><li class="navelem"><a class="el" href="../../dir_481cc946b8a81b8d9363a4aad6201160.html">libraries</a></li><li class="navelem"><a class="el" href="../../dir_11f10faf8e1af149a19b120728e5c8cd.html">CodeRacer</a></li><li class="navelem"><b>CodeRacer.cpp</b></li>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -173,7 +173,7 @@ Functions</h2></td></tr>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -101,7 +101,7 @@ Modules</h2></td></tr>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('d6/d9a/_code_racer_8h_source.html','..
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_a991eec27578c865874ede3d8ec657c2.html">Arduino</a></li><li class="navelem"><a class="el" href="../../dir_481cc946b8a81b8d9363a4aad6201160.html">libraries</a></li><li class="navelem"><a class="el" href="../../dir_11f10faf8e1af149a19b120728e5c8cd.html">CodeRacer</a></li><li class="navelem"><b>CodeRacer.h</b></li>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -326,7 +326,7 @@ Functions</h2></td></tr>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -99,7 +99,7 @@ Modules</h2></td></tr>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -273,7 +273,7 @@ Functions</h2></td></tr>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -148,7 +148,7 @@ Functions</h2></td></tr>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -101,7 +101,7 @@ Modules</h2></td></tr>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -101,7 +101,7 @@ Modules</h2></td></tr>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -326,7 +326,7 @@ Functions</h2></td></tr>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -212,7 +212,7 @@ Functions</h2></td></tr>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -237,7 +237,7 @@ Functions</h2></td></tr>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('dir_11f10faf8e1af149a19b120728e5c8cd.h
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_a991eec27578c865874ede3d8ec657c2.html">Arduino</a></li><li class="navelem"><a class="el" href="dir_481cc946b8a81b8d9363a4aad6201160.html">libraries</a></li><li class="navelem"><a class="el" href="dir_11f10faf8e1af149a19b120728e5c8cd.html">CodeRacer</a></li>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -95,7 +95,7 @@ Directories</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_a991eec27578c865874ede3d8ec657c2.html">Arduino</a></li><li class="navelem"><a class="el" href="dir_481cc946b8a81b8d9363a4aad6201160.html">libraries</a></li>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('dir_a991eec27578c865874ede3d8ec657c2.h
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_a991eec27578c865874ede3d8ec657c2.html">Arduino</a></li>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -119,7 +119,7 @@ A yellow dashed arrow denotes a relation between a template instance and the tem
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -90,7 +90,7 @@ $(document).ready(function(){initNavTree('index.html','');});
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
......@@ -109,7 +109,7 @@ $(document).ready(function(){initNavTree('modules.html','');});
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<li class="footer">Generated on Tue Nov 13 2018 11:13:48 for Arduino {code}racer API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
......
all: refman.pdf
pdf: refman.pdf
refman.pdf: clean refman.tex
pdflatex refman
makeindex refman.idx
pdflatex refman
latex_count=8 ; \
while egrep -s 'Rerun (LaTeX|to get cross-references right)' refman.log && [ $$latex_count -gt 0 ] ;\
do \
echo "Rerunning latex...." ;\
pdflatex refman ;\
latex_count=`expr $$latex_count - 1` ;\
done
makeindex refman.idx
pdflatex refman
clean:
rm -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out *.brf *.blg *.bbl refman.pdf
\hypertarget{group__lowerleveldrivesgetters}{}\section{Getters}
\label{group__lowerleveldrivesgetters}\index{Getters@{Getters}}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item
uint8\+\_\+t \hyperlink{group__lowerleveldrivesgetters_ga09359a792e3299b1c20f6b99939ea7b3}{Code\+Racer\+::drive\+\_\+right\+\_\+speed} ()
\begin{DoxyCompactList}\small\item\em Get the setting for the speed of the right side drive. \end{DoxyCompactList}\item
uint8\+\_\+t \hyperlink{group__lowerleveldrivesgetters_ga804a45724f3788fd2fdb9631c66d1377}{Code\+Racer\+::drive\+\_\+left\+\_\+speed} ()
\begin{DoxyCompactList}\small\item\em Get the setting for the speed of the left side drive. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection{Detailed Description}
\subsection{Function Documentation}
\mbox{\Hypertarget{group__lowerleveldrivesgetters_ga09359a792e3299b1c20f6b99939ea7b3}\label{group__lowerleveldrivesgetters_ga09359a792e3299b1c20f6b99939ea7b3}}
\index{Getters@{Getters}!drive\+\_\+right\+\_\+speed@{drive\+\_\+right\+\_\+speed}}
\index{drive\+\_\+right\+\_\+speed@{drive\+\_\+right\+\_\+speed}!Getters@{Getters}}
\subsubsection{\texorpdfstring{drive\+\_\+right\+\_\+speed()}{drive\_right\_speed()}}
{\footnotesize\ttfamily uint8\+\_\+t Code\+Racer\+::drive\+\_\+right\+\_\+speed (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Get the setting for the speed of the right side drive.
\begin{DoxyReturn}{Returns}
Speed of the right side drive
\end{DoxyReturn}
Definition at line 994 of file Code\+Racer.\+cpp.
\begin{DoxyCode}
994 \{
995 \textcolor{keywordflow}{return} \_drive\_right\_speed;
996 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__lowerleveldrivesgetters_ga804a45724f3788fd2fdb9631c66d1377}\label{group__lowerleveldrivesgetters_ga804a45724f3788fd2fdb9631c66d1377}}
\index{Getters@{Getters}!drive\+\_\+left\+\_\+speed@{drive\+\_\+left\+\_\+speed}}
\index{drive\+\_\+left\+\_\+speed@{drive\+\_\+left\+\_\+speed}!Getters@{Getters}}
\subsubsection{\texorpdfstring{drive\+\_\+left\+\_\+speed()}{drive\_left\_speed()}}
{\footnotesize\ttfamily uint8\+\_\+t Code\+Racer\+::drive\+\_\+left\+\_\+speed (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Get the setting for the speed of the left side drive.
\begin{DoxyReturn}{Returns}
Speed of the left side drive
\end{DoxyReturn}
Definition at line 1001 of file Code\+Racer.\+cpp.
\begin{DoxyCode}
1001 \{
1002 \textcolor{keywordflow}{return}(\_drive\_left\_speed);
1003 \}
\end{DoxyCode}
This diff is collapsed.
This diff is collapsed.
\hypertarget{group__lowerlevelservo}{}\section{Lower level servo drive methods and getters}
\label{group__lowerlevelservo}\index{Lower level servo drive methods and getters@{Lower level servo drive methods and getters}}
\subsection*{Modules}
\begin{DoxyCompactItemize}
\item
\hyperlink{group__lowerlevelservomeths}{Methods}
\item
\hyperlink{group__lowerlevelservogetters}{Getters}
\end{DoxyCompactItemize}
\subsection{Detailed Description}
\hypertarget{group__lowerlevelservogetters}{}\section{Getters}
\label{group__lowerlevelservogetters}\index{Getters@{Getters}}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item
uint8\+\_\+t \hyperlink{group__lowerlevelservogetters_ga451b3ecd272e9a11de4b221f8d771432}{Code\+Racer\+::servo\+\_\+position} ()
\begin{DoxyCompactList}\small\item\em Get the actual position of the servo. \end{DoxyCompactList}\item
unsigned long \hyperlink{group__lowerlevelservogetters_gaeed05a3d4e06adccebdfce207b734b2f}{Code\+Racer\+::servo\+\_\+position\+\_\+set\+\_\+at\+\_\+ms} ()
\begin{DoxyCompactList}\small\item\em Get the system time in ms the servo was set to the actual position. \end{DoxyCompactList}\item
unsigned long \hyperlink{group__lowerlevelservogetters_ga84ba256b9ccdf0e9f4280279da68a509}{Code\+Racer\+::servo\+\_\+position\+\_\+eta\+\_\+in\+\_\+ms} ()
\begin{DoxyCompactList}\small\item\em Get the system time in ms the servo will reach its position This is an estimated time. If this is a time in the future, the servo may still moving. If this is a time in the past , the servo should have reached its postion already. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection{Detailed Description}
\subsection{Function Documentation}
\mbox{\Hypertarget{group__lowerlevelservogetters_ga451b3ecd272e9a11de4b221f8d771432}\label{group__lowerlevelservogetters_ga451b3ecd272e9a11de4b221f8d771432}}
\index{Getters@{Getters}!servo\+\_\+position@{servo\+\_\+position}}
\index{servo\+\_\+position@{servo\+\_\+position}!Getters@{Getters}}
\subsubsection{\texorpdfstring{servo\+\_\+position()}{servo\_position()}}
{\footnotesize\ttfamily uint8\+\_\+t Code\+Racer\+::servo\+\_\+position (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Get the actual position of the servo.
\begin{DoxyReturn}{Returns}
Actual position of the servo
\end{DoxyReturn}
Definition at line 632 of file Code\+Racer.\+cpp.
\begin{DoxyCode}
632 \{
633 \textcolor{keywordflow}{return}(\_servo\_position);
634 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__lowerlevelservogetters_gaeed05a3d4e06adccebdfce207b734b2f}\label{group__lowerlevelservogetters_gaeed05a3d4e06adccebdfce207b734b2f}}
\index{Getters@{Getters}!servo\+\_\+position\+\_\+set\+\_\+at\+\_\+ms@{servo\+\_\+position\+\_\+set\+\_\+at\+\_\+ms}}
\index{servo\+\_\+position\+\_\+set\+\_\+at\+\_\+ms@{servo\+\_\+position\+\_\+set\+\_\+at\+\_\+ms}!Getters@{Getters}}
\subsubsection{\texorpdfstring{servo\+\_\+position\+\_\+set\+\_\+at\+\_\+ms()}{servo\_position\_set\_at\_ms()}}
{\footnotesize\ttfamily unsigned long Code\+Racer\+::servo\+\_\+position\+\_\+set\+\_\+at\+\_\+ms (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Get the system time in ms the servo was set to the actual position.
\begin{DoxyReturn}{Returns}
System time in ms the servo was set
\end{DoxyReturn}
Definition at line 639 of file Code\+Racer.\+cpp.
\begin{DoxyCode}
639 \{
640 \textcolor{keywordflow}{return}(\_servo\_position\_set\_at\_ms);
641 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__lowerlevelservogetters_ga84ba256b9ccdf0e9f4280279da68a509}\label{group__lowerlevelservogetters_ga84ba256b9ccdf0e9f4280279da68a509}}
\index{Getters@{Getters}!servo\+\_\+position\+\_\+eta\+\_\+in\+\_\+ms@{servo\+\_\+position\+\_\+eta\+\_\+in\+\_\+ms}}
\index{servo\+\_\+position\+\_\+eta\+\_\+in\+\_\+ms@{servo\+\_\+position\+\_\+eta\+\_\+in\+\_\+ms}!Getters@{Getters}}
\subsubsection{\texorpdfstring{servo\+\_\+position\+\_\+eta\+\_\+in\+\_\+ms()}{servo\_position\_eta\_in\_ms()}}
{\footnotesize\ttfamily unsigned long Code\+Racer\+::servo\+\_\+position\+\_\+eta\+\_\+in\+\_\+ms (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Get the system time in ms the servo will reach its position This is an estimated time. If this is a time in the future, the servo may still moving. If this is a time in the past , the servo should have reached its postion already.
\begin{DoxyReturn}{Returns}
System time in ms the servo will reach its position
\end{DoxyReturn}
Definition at line 649 of file Code\+Racer.\+cpp.
\begin{DoxyCode}
649 \{
650 \textcolor{keywordflow}{return}(\_servo\_position\_eta\_in\_ms);
651 \}
\end{DoxyCode}
\hypertarget{group__lowerleveldrives}{}\section{Lower level drives methods and getters}
\label{group__lowerleveldrives}\index{Lower level drives methods and getters@{Lower level drives methods and getters}}
\subsection*{Modules}
\begin{DoxyCompactItemize}
\item
\hyperlink{group__lowerleveldrivesmeths}{Methods}
\item
\hyperlink{group__lowerleveldrivesgetters}{Getters}
\end{DoxyCompactItemize}
\subsection{Detailed Description}
This diff is collapsed.
\hypertarget{group__lowerlevelled}{}\section{Lower level L\+ED methods}
\label{group__lowerlevelled}\index{Lower level L\+E\+D methods@{Lower level L\+E\+D methods}}
\subsection*{Modules}
\begin{DoxyCompactItemize}
\item
\hyperlink{group__lowerlevelledmeths}{Methods}
\end{DoxyCompactItemize}
\subsection{Detailed Description}
\hypertarget{group__higherlevelgetters}{}\section{Getters and setters}
\label{group__higherlevelgetters}\index{Getters and setters@{Getters and setters}}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item
bool \hyperlink{group__higherlevelgetters_gae8b8c0ab24ccb572281785aeca8541e1}{Code\+Racer\+::stopped\+\_\+at\+\_\+min\+\_\+distance} ()
\begin{DoxyCompactList}\small\item\em Returns true if the racer was stopped at minimum distance. This set to false each time start\+\_\+stop\+\_\+at\+\_\+min\+\_\+distance() is called. \end{DoxyCompactList}\item
bool \hyperlink{group__higherlevelgetters_ga33dcd96e9b12dec794c56be85ec1ee05}{Code\+Racer\+::is\+\_\+driving} ()
\begin{DoxyCompactList}\small\item\em Return true if the racer is driving -\/ forward or backward. \end{DoxyCompactList}\item
unsigned long \hyperlink{group__higherlevelgetters_gaf04fd16ca0e2ace656f9549c43d16459}{Code\+Racer\+::turn\+\_\+left\+\_\+for\+\_\+ms} ()
\begin{DoxyCompactList}\small\item\em Returns the duration of time that is internally stored and used for turning the racer left. \end{DoxyCompactList}\item
unsigned long \hyperlink{group__higherlevelgetters_gac0698f02f6a21d9d1f5b9cf2820306cf}{Code\+Racer\+::turn\+\_\+right\+\_\+for\+\_\+ms} ()
\begin{DoxyCompactList}\small\item\em Returns the duration of time that is internally stored and used for turning the racer left. \end{DoxyCompactList}\item
void \hyperlink{group__higherlevelgetters_ga62f1c0eea56e27d0853cb58f30eb140d}{Code\+Racer\+::set\+\_\+inactive} ()
\begin{DoxyCompactList}\small\item\em Sets the coderracer\+\_\+active state to inactive. If start\+\_\+stop() is used -\/ the inactive mode will be entered. \end{DoxyCompactList}\item
void \hyperlink{group__higherlevelgetters_ga415c69930f291d5e06b7211b31843310}{Code\+Racer\+::set\+\_\+active} ()
\begin{DoxyCompactList}\small\item\em Sets the coderracer\+\_\+active state to active. If start\+\_\+stop() is used -\/ the active mode will be entered. \end{DoxyCompactList}\item
bool \hyperlink{group__higherlevelgetters_gaa0ab4d6a754a23ea13664a553bcc8ff2}{Code\+Racer\+::is\+\_\+active} ()
\begin{DoxyCompactList}\small\item\em Checks if coderracer\+\_\+activ is set. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection{Detailed Description}
\subsection{Function Documentation}
\mbox{\Hypertarget{group__higherlevelgetters_gae8b8c0ab24ccb572281785aeca8541e1}\label{group__higherlevelgetters_gae8b8c0ab24ccb572281785aeca8541e1}}
\index{Getters and setters@{Getters and setters}!stopped\+\_\+at\+\_\+min\+\_\+distance@{stopped\+\_\+at\+\_\+min\+\_\+distance}}
\index{stopped\+\_\+at\+\_\+min\+\_\+distance@{stopped\+\_\+at\+\_\+min\+\_\+distance}!Getters and setters@{Getters and setters}}
\subsubsection{\texorpdfstring{stopped\+\_\+at\+\_\+min\+\_\+distance()}{stopped\_at\_min\_distance()}}
{\footnotesize\ttfamily bool Code\+Racer\+::stopped\+\_\+at\+\_\+min\+\_\+distance (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Returns true if the racer was stopped at minimum distance. This set to false each time start\+\_\+stop\+\_\+at\+\_\+min\+\_\+distance() is called.
\begin{DoxyReturn}{Returns}
True if stopped.
\end{DoxyReturn}
Definition at line 380 of file Code\+Racer.\+cpp.
\begin{DoxyCode}
380 \{
381 \textcolor{keywordflow}{return}(\_coderacer\_stopped\_at\_min\_distance);
382 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__higherlevelgetters_ga33dcd96e9b12dec794c56be85ec1ee05}\label{group__higherlevelgetters_ga33dcd96e9b12dec794c56be85ec1ee05}}
\index{Getters and setters@{Getters and setters}!is\+\_\+driving@{is\+\_\+driving}}
\index{is\+\_\+driving@{is\+\_\+driving}!Getters and setters@{Getters and setters}}
\subsubsection{\texorpdfstring{is\+\_\+driving()}{is\_driving()}}
{\footnotesize\ttfamily bool Code\+Racer\+::is\+\_\+driving (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Return true if the racer is driving -\/ forward or backward.
\begin{DoxyReturn}{Returns}
True if driving forward or backward
\end{DoxyReturn}
Definition at line 387 of file Code\+Racer.\+cpp.
\begin{DoxyCode}
387 \{
388 \textcolor{keywordflow}{return}(\_drive);
389 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__higherlevelgetters_gaf04fd16ca0e2ace656f9549c43d16459}\label{group__higherlevelgetters_gaf04fd16ca0e2ace656f9549c43d16459}}
\index{Getters and setters@{Getters and setters}!turn\+\_\+left\+\_\+for\+\_\+ms@{turn\+\_\+left\+\_\+for\+\_\+ms}}
\index{turn\+\_\+left\+\_\+for\+\_\+ms@{turn\+\_\+left\+\_\+for\+\_\+ms}!Getters and setters@{Getters and setters}}
\subsubsection{\texorpdfstring{turn\+\_\+left\+\_\+for\+\_\+ms()}{turn\_left\_for\_ms()}}
{\footnotesize\ttfamily unsigned long Code\+Racer\+::turn\+\_\+left\+\_\+for\+\_\+ms (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Returns the duration of time that is internally stored and used for turning the racer left.
\begin{DoxyReturn}{Returns}
Time to turn left in ms
\end{DoxyReturn}
Definition at line 394 of file Code\+Racer.\+cpp.
\begin{DoxyCode}
394 \{
395 \textcolor{keywordflow}{return}(\_turn\_left\_for\_ms);
396 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__higherlevelgetters_gac0698f02f6a21d9d1f5b9cf2820306cf}\label{group__higherlevelgetters_gac0698f02f6a21d9d1f5b9cf2820306cf}}
\index{Getters and setters@{Getters and setters}!turn\+\_\+right\+\_\+for\+\_\+ms@{turn\+\_\+right\+\_\+for\+\_\+ms}}
\index{turn\+\_\+right\+\_\+for\+\_\+ms@{turn\+\_\+right\+\_\+for\+\_\+ms}!Getters and setters@{Getters and setters}}
\subsubsection{\texorpdfstring{turn\+\_\+right\+\_\+for\+\_\+ms()}{turn\_right\_for\_ms()}}
{\footnotesize\ttfamily unsigned long Code\+Racer\+::turn\+\_\+right\+\_\+for\+\_\+ms (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Returns the duration of time that is internally stored and used for turning the racer left.
\begin{DoxyReturn}{Returns}
Time to turn left in ms
\end{DoxyReturn}
Definition at line 401 of file Code\+Racer.\+cpp.
\begin{DoxyCode}
401 \{
402 \textcolor{keywordflow}{return}(\_turn\_right\_for\_ms);
403 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__higherlevelgetters_ga62f1c0eea56e27d0853cb58f30eb140d}\label{group__higherlevelgetters_ga62f1c0eea56e27d0853cb58f30eb140d}}
\index{Getters and setters@{Getters and setters}!set\+\_\+inactive@{set\+\_\+inactive}}
\index{set\+\_\+inactive@{set\+\_\+inactive}!Getters and setters@{Getters and setters}}
\subsubsection{\texorpdfstring{set\+\_\+inactive()}{set\_inactive()}}
{\footnotesize\ttfamily void Code\+Racer\+::set\+\_\+inactive (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Sets the coderracer\+\_\+active state to inactive. If start\+\_\+stop() is used -\/ the inactive mode will be entered.
\begin{DoxyReturn}{Returns}
nothing
\end{DoxyReturn}
Definition at line 408 of file Code\+Racer.\+cpp.
\begin{DoxyCode}
408 \{
409 coderracer\_activ = \textcolor{keyword}{false};
410 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__higherlevelgetters_ga415c69930f291d5e06b7211b31843310}\label{group__higherlevelgetters_ga415c69930f291d5e06b7211b31843310}}
\index{Getters and setters@{Getters and setters}!set\+\_\+active@{set\+\_\+active}}
\index{set\+\_\+active@{set\+\_\+active}!Getters and setters@{Getters and setters}}
\subsubsection{\texorpdfstring{set\+\_\+active()}{set\_active()}}
{\footnotesize\ttfamily void Code\+Racer\+::set\+\_\+active (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Sets the coderracer\+\_\+active state to active. If start\+\_\+stop() is used -\/ the active mode will be entered.
\begin{DoxyReturn}{Returns}
nothing
\end{DoxyReturn}
Definition at line 415 of file Code\+Racer.\+cpp.
\begin{DoxyCode}
415 \{
416 coderracer\_activ = \textcolor{keyword}{true};
417 \}
\end{DoxyCode}
\mbox{\Hypertarget{group__higherlevelgetters_gaa0ab4d6a754a23ea13664a553bcc8ff2}\label{group__higherlevelgetters_gaa0ab4d6a754a23ea13664a553bcc8ff2}}
\index{Getters and setters@{Getters and setters}!is\+\_\+active@{is\+\_\+active}}
\index{is\+\_\+active@{is\+\_\+active}!Getters and setters@{Getters and setters}}
\subsubsection{\texorpdfstring{is\+\_\+active()}{is\_active()}}
{\footnotesize\ttfamily bool Code\+Racer\+::is\+\_\+active (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Checks if coderracer\+\_\+activ is set.
coderracer\+\_\+activ is toggled each time the button is pressed. After power on coderracer\+\_\+activ is set to False. \begin{DoxyReturn}{Returns}
True id coderracer\+\_\+activ is set -\/ False if not.
\end{DoxyReturn}
Definition at line 424 of file Code\+Racer.\+cpp.
\begin{DoxyCode}
424 \{
425 \textcolor{keywordflow}{return}(coderracer\_activ);
426 \}
\end{DoxyCode}
\hypertarget{group__lowerlevelfun}{}\section{Lower level fun stuff methods}
\label{group__lowerlevelfun}\index{Lower level fun stuff methods@{Lower level fun stuff methods}}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item
void \hyperlink{group__lowerlevelfun_ga04309a38252639a8eaa43809c04c11c8}{Code\+Racer\+::look\+\_\+around} ()
\begin{DoxyCompactList}\small\item\em Fun stuff -\/ will move the servo around after a random amount of time. \end{DoxyCompactList}\item
void \hyperlink{group__lowerlevelfun_ga3b6f819fb82d910888fbc87abff1470c}{Code\+Racer\+::kitt} ()
\begin{DoxyCompactList}\small\item\em Fun stuff -\/ you know Knightrider... \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection{Detailed Description}
\subsection{Function Documentation}
\mbox{\Hypertarget{group__lowerlevelfun_ga04309a38252639a8eaa43809c04c11c8}\label{group__lowerlevelfun_ga04309a38252639a8eaa43809c04c11c8}}
\index{Lower level fun stuff methods@{Lower level fun stuff methods}!look\+\_\+around@{look\+\_\+around}}
\index{look\+\_\+around@{look\+\_\+around}!Lower level fun stuff methods@{Lower level fun stuff methods}}
\subsubsection{\texorpdfstring{look\+\_\+around()}{look\_around()}}
{\footnotesize\ttfamily void Code\+Racer\+::look\+\_\+around (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Fun stuff -\/ will move the servo around after a random amount of time.
\begin{DoxyReturn}{Returns}
nothing
\end{DoxyReturn}