\doxysection{Me\+Flame\+Sensor Class Reference}
\hypertarget{class_me_flame_sensor}{}\label{class_me_flame_sensor}\index{MeFlameSensor@{MeFlameSensor}}


Driver for Me flame snesor device.  




{\ttfamily \#include $<$src/\+Me\+Flame\+Sensor.\+h$>$}



Inheritance diagram for Me\+Flame\+Sensor\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=167pt]{class_me_flame_sensor__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for Me\+Flame\+Sensor\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=167pt]{class_me_flame_sensor__coll__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_me_flame_sensor_adc284c980be43010a9dc046ed9ecf03f}{Me\+Flame\+Sensor}} (void)
\item 
\mbox{\hyperlink{class_me_flame_sensor_a32ce1598a172c6ddd56b51713add39e3}{Me\+Flame\+Sensor}} (uint8\+\_\+t port)
\item 
void \mbox{\hyperlink{class_me_flame_sensor_a42b0282962ea9afea2d2b0d4bbdb1ce4}{setpin}} (uint8\+\_\+t digital\+\_\+pin, uint8\+\_\+t analog\+\_\+pin)
\item 
uint8\+\_\+t \mbox{\hyperlink{class_me_flame_sensor_a01b134562c8fff15c7f7f48e18839cd0}{read\+Digital}} (void)
\item 
int16\+\_\+t \mbox{\hyperlink{class_me_flame_sensor_a09baccd24c256f1ad1b59e148f43450a}{read\+Analog}} (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 flame snesor device. 

Class\+: \doxylink{class_me_flame_sensor}{Me\+Flame\+Sensor} \begin{DoxyParagraph}{Description}
Declaration of Class \doxylink{class_me_flame_sensor}{Me\+Flame\+Sensor}
\end{DoxyParagraph}
\begin{DoxyParagraph}{Copyright (C), 2012-\/2016, Make\+Block}

\end{DoxyParagraph}


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

Alternate Constructor which can call your own function to map the flame snesor 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_flame_sensor_a32ce1598a172c6ddd56b51713add39e3}\label{class_me_flame_sensor_a32ce1598a172c6ddd56b51713add39e3} 
\index{MeFlameSensor@{MeFlameSensor}!MeFlameSensor@{MeFlameSensor}}
\index{MeFlameSensor@{MeFlameSensor}!MeFlameSensor@{MeFlameSensor}}
\doxysubsubsection{\texorpdfstring{MeFlameSensor()}{MeFlameSensor()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily Me\+Flame\+Sensor\+::\+Me\+Flame\+Sensor (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{port }\end{DoxyParamCaption})}

Alternate Constructor which can call your own function to map the flame snesor 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_flame_sensor_a09baccd24c256f1ad1b59e148f43450a}\label{class_me_flame_sensor_a09baccd24c256f1ad1b59e148f43450a} 
\index{MeFlameSensor@{MeFlameSensor}!readAnalog@{readAnalog}}
\index{readAnalog@{readAnalog}!MeFlameSensor@{MeFlameSensor}}
\doxysubsubsection{\texorpdfstring{readAnalog()}{readAnalog()}}
{\footnotesize\ttfamily int16\+\_\+t Me\+Flame\+Sensor\+::read\+Analog (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}

\begin{DoxyParagraph}{Function}
read\+Analog 
\end{DoxyParagraph}
\begin{DoxyParagraph}{Description}
Read the analog signal of flame snesor. 
\end{DoxyParagraph}
\begin{DoxyParagraph}{Output}
None 
\end{DoxyParagraph}
\begin{DoxyReturn}{Returns}
The vlaue from flame snesor\textquotesingle{}s analog output 
\end{DoxyReturn}
\begin{DoxyParagraph}{Others}
None 
\end{DoxyParagraph}
\Hypertarget{class_me_flame_sensor_a01b134562c8fff15c7f7f48e18839cd0}\label{class_me_flame_sensor_a01b134562c8fff15c7f7f48e18839cd0} 
\index{MeFlameSensor@{MeFlameSensor}!readDigital@{readDigital}}
\index{readDigital@{readDigital}!MeFlameSensor@{MeFlameSensor}}
\doxysubsubsection{\texorpdfstring{readDigital()}{readDigital()}}
{\footnotesize\ttfamily uint8\+\_\+t Me\+Flame\+Sensor\+::read\+Digital (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}

\begin{DoxyParagraph}{Function}
read\+Digital 
\end{DoxyParagraph}
\begin{DoxyParagraph}{Description}
Read the digital signal of flame snesor, It is the result of comparison between the threshold value and the analog output. The threshold value can be adjusted using a rheostat 
\end{DoxyParagraph}
\begin{DoxyParagraph}{Output}
None 
\end{DoxyParagraph}
\begin{DoxyReturn}{Returns}
true -\/ The fire is detected ~\newline
 false -\/ No fire is detected 
\end{DoxyReturn}
\begin{DoxyParagraph}{Others}
None 
\end{DoxyParagraph}
\Hypertarget{class_me_flame_sensor_a42b0282962ea9afea2d2b0d4bbdb1ce4}\label{class_me_flame_sensor_a42b0282962ea9afea2d2b0d4bbdb1ce4} 
\index{MeFlameSensor@{MeFlameSensor}!setpin@{setpin}}
\index{setpin@{setpin}!MeFlameSensor@{MeFlameSensor}}
\doxysubsubsection{\texorpdfstring{setpin()}{setpin()}}
{\footnotesize\ttfamily void Me\+Flame\+Sensor\+::setpin (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{digital\+\_\+pin,  }\item[{uint8\+\_\+t}]{analog\+\_\+pin }\end{DoxyParamCaption})}

\begin{DoxyParagraph}{Function}
setpin 
\end{DoxyParagraph}
\begin{DoxyParagraph}{Description}
Reset the flame snesor available PIN by its arduino port. 
\end{DoxyParagraph}

\begin{DoxyParams}[1]{Parameters}
\mbox{\texttt{ in}}  & {\em digital\+\_\+pin} & -\/ arduino port for digital signal input \\
\hline
\mbox{\texttt{ in}}  & {\em analog\+\_\+pin} & -\/ arduino port for analog signal input \\
\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_flame_sensor_8h}{Me\+Flame\+Sensor.\+h}}\item 
src/\mbox{\hyperlink{_me_flame_sensor_8cpp}{Me\+Flame\+Sensor.\+cpp}}\end{DoxyCompactItemize}
