\doxysection{Me\+Line\+Follower Class Reference}
\hypertarget{class_me_line_follower}{}\label{class_me_line_follower}\index{MeLineFollower@{MeLineFollower}}


Driver for Me line follwer device.  




{\ttfamily \#include $<$src/\+Me\+Line\+Follower.\+h$>$}



Inheritance diagram for Me\+Line\+Follower\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=164pt]{class_me_line_follower__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for Me\+Line\+Follower\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=164pt]{class_me_line_follower__coll__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_me_line_follower_a0921a28658143998b3c9d794cbe44c9e}{Me\+Line\+Follower}} (void)
\item 
\mbox{\hyperlink{class_me_line_follower_a0e2dcb9e9af565ac9cfb2eb0c022ee34}{Me\+Line\+Follower}} (uint8\+\_\+t port)
\item 
void \mbox{\hyperlink{class_me_line_follower_aafb9c399cf49bd9877ba9d19d3f55922}{setpin}} (uint8\+\_\+t Sensor1, uint8\+\_\+t Sensor2)
\item 
uint8\+\_\+t \mbox{\hyperlink{class_me_line_follower_a88db0aaee6ffac54c106c2e8e9811f40}{read\+Sensors}} (void)
\item 
bool \mbox{\hyperlink{class_me_line_follower_aa0d1a6c71bde5d559db1dc82ba8960b7}{read\+Sensor1}} (void)
\item 
bool \mbox{\hyperlink{class_me_line_follower_a7cbd9125758887862416f2a4f65f58cd}{read\+Sensor2}} (void)
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \mbox{\hyperlink{class_me_port}{Me\+Port}}}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_me_port_ae4b9e8e718b626d0ce4017a430878210}{Me\+Port}} (void)
\item 
\mbox{\hyperlink{class_me_port_a7a1d7cdf061740148cd893ba481420a3}{Me\+Port}} (uint8\+\_\+t port)
\item 
\mbox{\hyperlink{class_me_port_a1458b606f98da409d7ab4fa7d09c6816}{Me\+Port}} (uint8\+\_\+t port, uint8\+\_\+t slot)
\item 
uint8\+\_\+t \mbox{\hyperlink{class_me_port_a8d9ca22e35477573b27c4165ac61def0}{get\+Port}} (void)
\item 
uint8\+\_\+t \mbox{\hyperlink{class_me_port_a4c73dec349340e958b9567b06fa6f27c}{get\+Slot}} (void)
\item 
bool \mbox{\hyperlink{class_me_port_a8b7b990f5fa85dfc28f7f3d0d7ba46b9}{d\+Read1}} (uint8\+\_\+t mode=INPUT)
\item 
bool \mbox{\hyperlink{class_me_port_ab4fd13565335bd781da8f44bae803031}{d\+Read2}} (uint8\+\_\+t mode=INPUT)
\item 
bool \mbox{\hyperlink{class_me_port_aabcb0e1dc89942cf302b8cbac2cbd0a5}{dp\+Read1}} (void)
\item 
bool \mbox{\hyperlink{class_me_port_a2e4b6faf3e9494e819ccee47dfb8010e}{dp\+Read2}} (void)
\item 
void \mbox{\hyperlink{class_me_port_a9d5f60427202c26bc8da4b1e6a66c5c2}{d\+Write1}} (bool value)
\item 
void \mbox{\hyperlink{class_me_port_a0d9ee041f8361f45bcc83bed9577415f}{d\+Write2}} (bool value)
\item 
int16\+\_\+t \mbox{\hyperlink{class_me_port_acfd28b1ab8cc6af5bf8223446022525c}{a\+Read1}} (void)
\item 
int16\+\_\+t \mbox{\hyperlink{class_me_port_a63709dcbe9850c0d3baec1fed72809bf}{a\+Read2}} (void)
\item 
void \mbox{\hyperlink{class_me_port_adb4d7959f2059bf9986a8e5a631988ae}{a\+Write1}} (int16\+\_\+t value)
\item 
void \mbox{\hyperlink{class_me_port_a3834f0f30618ec31789d524dd367e44f}{a\+Write2}} (int16\+\_\+t value)
\item 
void \mbox{\hyperlink{class_me_port_a7b82ce913d98ecff906569d795073892}{reset}} (uint8\+\_\+t port)
\item 
void \mbox{\hyperlink{class_me_port_a91e3cca62e5f8fffead56f8104488d4d}{reset}} (uint8\+\_\+t port, uint8\+\_\+t slot)
\item 
uint8\+\_\+t \mbox{\hyperlink{class_me_port_a1ed16a0f863a618cc9f32b27015107e7}{pin1}} (void)
\item 
uint8\+\_\+t \mbox{\hyperlink{class_me_port_a8a1b3cd06dffbb48d40c3adf25011803}{pin2}} (void)
\item 
uint8\+\_\+t \mbox{\hyperlink{class_me_port_aea7dad0142d940c0395b1782fe5adeae}{pin}} (void)
\item 
uint8\+\_\+t \mbox{\hyperlink{class_me_port_a637d42b5a62d655b8517bc8a363206f3}{pin}} (uint8\+\_\+t port, uint8\+\_\+t slot)
\end{DoxyCompactItemize}
\doxysubsubsection*{Additional Inherited Members}
\doxysubsection*{Protected Attributes inherited from \mbox{\hyperlink{class_me_port}{Me\+Port}}}
\begin{DoxyCompactItemize}
\item 
uint8\+\_\+t \mbox{\hyperlink{class_me_port_ab5295b9e84ecedf3f93ab47cf8f10284}{s1}}
\item 
uint8\+\_\+t \mbox{\hyperlink{class_me_port_a6c09cece23372a6ab340512a0db3e37d}{s2}}
\item 
uint8\+\_\+t \mbox{\hyperlink{class_me_port_adc9cdd4e574061d41244fc662974544f}{\+\_\+port}}
\item 
uint8\+\_\+t \mbox{\hyperlink{class_me_port_a4159543b593b047cd82fedab30b178b7}{\+\_\+slot}}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Driver for Me line follwer device. 

Class\+: \doxylink{class_me_line_follower}{Me\+Line\+Follower} \begin{DoxyParagraph}{Description}
Declaration of Class \doxylink{class_me_line_follower}{Me\+Line\+Follower}.
\end{DoxyParagraph}
\begin{DoxyParagraph}{Copyright (C), 2012-\/2016, Make\+Block}

\end{DoxyParagraph}


\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{class_me_line_follower_a0921a28658143998b3c9d794cbe44c9e}\label{class_me_line_follower_a0921a28658143998b3c9d794cbe44c9e} 
\index{MeLineFollower@{MeLineFollower}!MeLineFollower@{MeLineFollower}}
\index{MeLineFollower@{MeLineFollower}!MeLineFollower@{MeLineFollower}}
\doxysubsubsection{\texorpdfstring{MeLineFollower()}{MeLineFollower()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily Me\+Line\+Follower\+::\+Me\+Line\+Follower (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}

Alternate Constructor which can call your own function to map the line follwer device to arduino port, no pins are used or initialized here. 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em None} & \\
\hline
\end{DoxyParams}
\Hypertarget{class_me_line_follower_a0e2dcb9e9af565ac9cfb2eb0c022ee34}\label{class_me_line_follower_a0e2dcb9e9af565ac9cfb2eb0c022ee34} 
\index{MeLineFollower@{MeLineFollower}!MeLineFollower@{MeLineFollower}}
\index{MeLineFollower@{MeLineFollower}!MeLineFollower@{MeLineFollower}}
\doxysubsubsection{\texorpdfstring{MeLineFollower()}{MeLineFollower()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily Me\+Line\+Follower\+::\+Me\+Line\+Follower (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{port }\end{DoxyParamCaption})}

Alternate Constructor which can call your own function to map the line follwer device to arduino port 
\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em port} & -\/ RJ25 port from PORT\+\_\+1 to M2 \\
\hline
\end{DoxyParams}


\doxysubsection{Member Function Documentation}
\Hypertarget{class_me_line_follower_aa0d1a6c71bde5d559db1dc82ba8960b7}\label{class_me_line_follower_aa0d1a6c71bde5d559db1dc82ba8960b7} 
\index{MeLineFollower@{MeLineFollower}!readSensor1@{readSensor1}}
\index{readSensor1@{readSensor1}!MeLineFollower@{MeLineFollower}}
\doxysubsubsection{\texorpdfstring{readSensor1()}{readSensor1()}}
{\footnotesize\ttfamily bool Me\+Line\+Follower\+::read\+Sensor1 (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}

\begin{DoxyParagraph}{Function}
read\+Sensor1 
\end{DoxyParagraph}
\begin{DoxyParagraph}{Description}
Get the sensors1(left sensors) state. 
\end{DoxyParagraph}
\begin{DoxyParagraph}{Output}
None 
\end{DoxyParagraph}
\begin{DoxyReturn}{Returns}
0\+: sensor1 is inside of black line ~\newline
 1\+: sensor1 is outside of black line 
\end{DoxyReturn}
\begin{DoxyParagraph}{Others}
None 
\end{DoxyParagraph}
\Hypertarget{class_me_line_follower_a7cbd9125758887862416f2a4f65f58cd}\label{class_me_line_follower_a7cbd9125758887862416f2a4f65f58cd} 
\index{MeLineFollower@{MeLineFollower}!readSensor2@{readSensor2}}
\index{readSensor2@{readSensor2}!MeLineFollower@{MeLineFollower}}
\doxysubsubsection{\texorpdfstring{readSensor2()}{readSensor2()}}
{\footnotesize\ttfamily bool Me\+Line\+Follower\+::read\+Sensor2 (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}

\begin{DoxyParagraph}{Function}
read\+Sensor2 
\end{DoxyParagraph}
\begin{DoxyParagraph}{Description}
Get the sensors2(right sensors) state. 
\end{DoxyParagraph}
\begin{DoxyParagraph}{Output}
None 
\end{DoxyParagraph}
\begin{DoxyReturn}{Returns}
0\+: sensor1 is inside of black line ~\newline
 1\+: sensor1 is outside of black line 
\end{DoxyReturn}
\begin{DoxyParagraph}{Others}
None 
\end{DoxyParagraph}
\Hypertarget{class_me_line_follower_a88db0aaee6ffac54c106c2e8e9811f40}\label{class_me_line_follower_a88db0aaee6ffac54c106c2e8e9811f40} 
\index{MeLineFollower@{MeLineFollower}!readSensors@{readSensors}}
\index{readSensors@{readSensors}!MeLineFollower@{MeLineFollower}}
\doxysubsubsection{\texorpdfstring{readSensors()}{readSensors()}}
{\footnotesize\ttfamily uint8\+\_\+t Me\+Line\+Follower\+::read\+Sensors (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}

\begin{DoxyParagraph}{Function}
read\+Sensors 
\end{DoxyParagraph}
\begin{DoxyParagraph}{Description}
Get the sensors state. 
\end{DoxyParagraph}
\begin{DoxyParagraph}{Output}
None 
\end{DoxyParagraph}
\begin{DoxyReturn}{Returns}
(0x00)-\/S1\+\_\+\+IN\+\_\+\+S2\+\_\+\+IN\+: sensor1 and sensor2 are both inside of black line ~\newline
 (0x01)-\/S1\+\_\+\+IN\+\_\+\+S2\+\_\+\+OUT\+: sensor1 is inside of black line and sensor2 is outside of black line ~\newline
 (0x02)-\/S1\+\_\+\+OUT\+\_\+\+S2\+\_\+\+IN\+: sensor1 is outside of black line and sensor2 is inside of black line ~\newline
 (0x03)-\/S1\+\_\+\+OUT\+\_\+\+S2\+\_\+\+OUT\+: sensor1 and sensor2 are both outside of black line 
\end{DoxyReturn}
\begin{DoxyParagraph}{Others}
None 
\end{DoxyParagraph}
\Hypertarget{class_me_line_follower_aafb9c399cf49bd9877ba9d19d3f55922}\label{class_me_line_follower_aafb9c399cf49bd9877ba9d19d3f55922} 
\index{MeLineFollower@{MeLineFollower}!setpin@{setpin}}
\index{setpin@{setpin}!MeLineFollower@{MeLineFollower}}
\doxysubsubsection{\texorpdfstring{setpin()}{setpin()}}
{\footnotesize\ttfamily void Me\+Line\+Follower\+::setpin (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{Sensor1,  }\item[{uint8\+\_\+t}]{Sensor2 }\end{DoxyParamCaption})}

\begin{DoxyParagraph}{Function}
setpin 
\end{DoxyParagraph}
\begin{DoxyParagraph}{Description}
Reset the line follwer device available PIN by its arduino port. 
\end{DoxyParagraph}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em Sensor1} & -\/ arduino port(should digital pin) \\
\hline
\mbox{\texttt{ in}}  & {\em Sensor2} & -\/ arduino port(should digital pin) \\
\hline
\end{DoxyParams}
\begin{DoxyParagraph}{Output}
None 
\end{DoxyParagraph}
\begin{DoxyReturn}{Returns}
None 
\end{DoxyReturn}
\begin{DoxyParagraph}{Others}
None 
\end{DoxyParagraph}


The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
src/\mbox{\hyperlink{_me_line_follower_8h}{Me\+Line\+Follower.\+h}}\item 
src/\mbox{\hyperlink{_me_line_follower_8cpp}{Me\+Line\+Follower.\+cpp}}\end{DoxyCompactItemize}
