Files
lighthub/docs/latex/class_input.tex
2020-11-21 20:01:02 +03:00

284 lines
17 KiB
TeX

\hypertarget{class_input}{}\doxysection{Input Class Reference}
\label{class_input}\index{Input@{Input}}
{\ttfamily \#include $<$inputs.\+h$>$}
Collaboration diagram for Input\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=129pt]{class_input__coll__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{class_input_a52d1d1d4eb7890e186fa0faa11636b82}{Input}} (a\+Json\+Object $\ast$obj, a\+Json\+Object $\ast$config\+Obj=N\+U\+LL)
\item
\mbox{\hyperlink{class_input_adae232acc9d1e127947a8b09f1665fb2}{Input}} (char $\ast$name)
\item
boolean \mbox{\hyperlink{class_input_a2e60007024a65b9529d8db1873bf8696}{is\+Valid}} ()
\item
void \mbox{\hyperlink{class_input_a2e0c2008fce8f2730ef3126ff1d8893e}{on\+Contact\+Changed}} (int new\+Value)
\item
void \mbox{\hyperlink{class_input_a121247eaf2f413135f0340df17015492}{on\+Analog\+Changed}} (float new\+Value)
\item
int \mbox{\hyperlink{class_input_a34b0da23df4e0c2be07e5358a974f6b3}{Poll}} (short cause)
\item
void \mbox{\hyperlink{class_input_af875dd162373e90e21f8213f928f8032}{setup}} ()
\end{DoxyCompactItemize}
\doxysubsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item
static void \mbox{\hyperlink{class_input_a2b60992464aa56f75c9d02b8b2084f8e}{on\+Counter\+Changed}} (int i)
\item
static void \mbox{\hyperlink{class_input_a85c108932af16f55722b8ccec2b72fb5}{on\+Counter\+Changed0}} ()
\item
static void \mbox{\hyperlink{class_input_a36b4ed46c94a5194e74c2106bb29deaa}{on\+Counter\+Changed1}} ()
\item
static void \mbox{\hyperlink{class_input_a8def9079b3f0774a05860a17a4b51b29}{on\+Counter\+Changed2}} ()
\item
static void \mbox{\hyperlink{class_input_adc8477b21452dd8b1f4bf1f3de35ecc4}{on\+Counter\+Changed3}} ()
\item
static void \mbox{\hyperlink{class_input_a6fcea89328a3bcf97dad383b7b615a5a}{on\+Counter\+Changed4}} ()
\item
static void \mbox{\hyperlink{class_input_a5611409d1de5bff2e6e59b9395809ecd}{on\+Counter\+Changed5}} ()
\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item
a\+Json\+Object $\ast$ \mbox{\hyperlink{class_input_a4dbfdd3e7da95a3d4873286da07733f2}{input\+Obj}}
\item
uint8\+\_\+t \mbox{\hyperlink{class_input_a0354094b474b7b9fa305bfc3500d3cee}{in\+Type}}
\item
uint8\+\_\+t \mbox{\hyperlink{class_input_a910d1942c02b2d155dbaa3c8a41876f5}{pin}}
\item
\mbox{\hyperlink{unionin_store}{in\+Store}} $\ast$ \mbox{\hyperlink{class_input_a2c8307bf192b3e07bbc7cd605efeeb81}{store}}
\end{DoxyCompactItemize}
\doxysubsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item
void \mbox{\hyperlink{class_input_aad974cff366f73924458d105b88130d4}{Parse}} (a\+Json\+Object $\ast$config\+Obj=N\+U\+LL)
\item
void \mbox{\hyperlink{class_input_a48dfeb886a0927b60d3200bbdea5765a}{contact\+Poll}} (short cause)
\item
void \mbox{\hyperlink{class_input_acb26235ba50553fa073a95096ebbbc69}{analog\+Poll}} (short cause)
\item
void \mbox{\hyperlink{class_input_a70568f40b1008c2f5fdf378ada26a5c4}{dht22\+Poll}} ()
\item
void \mbox{\hyperlink{class_input_a347f052d5de6b996d7e6cf4ac83485d9}{counter\+Poll}} ()
\item
void \mbox{\hyperlink{class_input_ab272ddf677bc7ebaa20c0a8677b49b80}{attach\+Interrupt\+Pin\+Irq}} (int real\+Pin, int irq)
\item
unsigned long \mbox{\hyperlink{class_input_ad7e0d37e4f0cca8117a1fad077e4d4a7}{next\+Poll\+Time}} () const
\item
void \mbox{\hyperlink{class_input_a8efca39cb91c24dc80a62d660fd9ea2a}{set\+Next\+Poll\+Time}} (unsigned long poll\+Time)
\item
void \mbox{\hyperlink{class_input_a3d224f0fd4da038390abaa8f84478d5c}{uptime\+Poll}} ()
\item
bool \mbox{\hyperlink{class_input_ab48ae5515b6a332b518a06e5bb10926a}{publish\+Data\+To\+Domoticz}} (int, a\+Json\+Object $\ast$, const char $\ast$format,...)
\item
char $\ast$ \mbox{\hyperlink{class_input_a0697613f4b723bdb63e8c5510f85b9c6}{get\+Idx\+Field}} ()
\item
bool \mbox{\hyperlink{class_input_a08323a44c2d4ca714e4e6a14ae73fc4f}{change\+State}} (uint8\+\_\+t new\+State, short cause)
\end{DoxyCompactItemize}
\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_input_a52d1d1d4eb7890e186fa0faa11636b82}\label{class_input_a52d1d1d4eb7890e186fa0faa11636b82}}
\index{Input@{Input}!Input@{Input}}
\index{Input@{Input}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{Input()}{Input()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily Input\+::\+Input (\begin{DoxyParamCaption}\item[{a\+Json\+Object $\ast$}]{obj, }\item[{a\+Json\+Object $\ast$}]{config\+Obj = {\ttfamily NULL} }\end{DoxyParamCaption})}
\mbox{\Hypertarget{class_input_adae232acc9d1e127947a8b09f1665fb2}\label{class_input_adae232acc9d1e127947a8b09f1665fb2}}
\index{Input@{Input}!Input@{Input}}
\index{Input@{Input}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{Input()}{Input()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily Input\+::\+Input (\begin{DoxyParamCaption}\item[{char $\ast$}]{name }\end{DoxyParamCaption})}
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_input_acb26235ba50553fa073a95096ebbbc69}\label{class_input_acb26235ba50553fa073a95096ebbbc69}}
\index{Input@{Input}!analogPoll@{analogPoll}}
\index{analogPoll@{analogPoll}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{analogPoll()}{analogPoll()}}
{\footnotesize\ttfamily void Input\+::analog\+Poll (\begin{DoxyParamCaption}\item[{short}]{cause }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
\mbox{\Hypertarget{class_input_ab272ddf677bc7ebaa20c0a8677b49b80}\label{class_input_ab272ddf677bc7ebaa20c0a8677b49b80}}
\index{Input@{Input}!attachInterruptPinIrq@{attachInterruptPinIrq}}
\index{attachInterruptPinIrq@{attachInterruptPinIrq}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{attachInterruptPinIrq()}{attachInterruptPinIrq()}}
{\footnotesize\ttfamily void Input\+::attach\+Interrupt\+Pin\+Irq (\begin{DoxyParamCaption}\item[{int}]{real\+Pin, }\item[{int}]{irq }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
\mbox{\Hypertarget{class_input_a08323a44c2d4ca714e4e6a14ae73fc4f}\label{class_input_a08323a44c2d4ca714e4e6a14ae73fc4f}}
\index{Input@{Input}!changeState@{changeState}}
\index{changeState@{changeState}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{changeState()}{changeState()}}
{\footnotesize\ttfamily bool Input\+::change\+State (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{new\+State, }\item[{short}]{cause }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
\mbox{\Hypertarget{class_input_a48dfeb886a0927b60d3200bbdea5765a}\label{class_input_a48dfeb886a0927b60d3200bbdea5765a}}
\index{Input@{Input}!contactPoll@{contactPoll}}
\index{contactPoll@{contactPoll}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{contactPoll()}{contactPoll()}}
{\footnotesize\ttfamily void Input\+::contact\+Poll (\begin{DoxyParamCaption}\item[{short}]{cause }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
\mbox{\Hypertarget{class_input_a347f052d5de6b996d7e6cf4ac83485d9}\label{class_input_a347f052d5de6b996d7e6cf4ac83485d9}}
\index{Input@{Input}!counterPoll@{counterPoll}}
\index{counterPoll@{counterPoll}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{counterPoll()}{counterPoll()}}
{\footnotesize\ttfamily void Input\+::counter\+Poll (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
\mbox{\Hypertarget{class_input_a70568f40b1008c2f5fdf378ada26a5c4}\label{class_input_a70568f40b1008c2f5fdf378ada26a5c4}}
\index{Input@{Input}!dht22Poll@{dht22Poll}}
\index{dht22Poll@{dht22Poll}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{dht22Poll()}{dht22Poll()}}
{\footnotesize\ttfamily void Input\+::dht22\+Poll (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
\mbox{\Hypertarget{class_input_a0697613f4b723bdb63e8c5510f85b9c6}\label{class_input_a0697613f4b723bdb63e8c5510f85b9c6}}
\index{Input@{Input}!getIdxField@{getIdxField}}
\index{getIdxField@{getIdxField}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{getIdxField()}{getIdxField()}}
{\footnotesize\ttfamily char $\ast$ Input\+::get\+Idx\+Field (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
\mbox{\Hypertarget{class_input_a2e60007024a65b9529d8db1873bf8696}\label{class_input_a2e60007024a65b9529d8db1873bf8696}}
\index{Input@{Input}!isValid@{isValid}}
\index{isValid@{isValid}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{isValid()}{isValid()}}
{\footnotesize\ttfamily boolean Input\+::is\+Valid (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
\mbox{\Hypertarget{class_input_ad7e0d37e4f0cca8117a1fad077e4d4a7}\label{class_input_ad7e0d37e4f0cca8117a1fad077e4d4a7}}
\index{Input@{Input}!nextPollTime@{nextPollTime}}
\index{nextPollTime@{nextPollTime}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{nextPollTime()}{nextPollTime()}}
{\footnotesize\ttfamily unsigned long Input\+::next\+Poll\+Time (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [protected]}}
\mbox{\Hypertarget{class_input_a121247eaf2f413135f0340df17015492}\label{class_input_a121247eaf2f413135f0340df17015492}}
\index{Input@{Input}!onAnalogChanged@{onAnalogChanged}}
\index{onAnalogChanged@{onAnalogChanged}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{onAnalogChanged()}{onAnalogChanged()}}
{\footnotesize\ttfamily void Input\+::on\+Analog\+Changed (\begin{DoxyParamCaption}\item[{float}]{new\+Value }\end{DoxyParamCaption})}
\mbox{\Hypertarget{class_input_a2e0c2008fce8f2730ef3126ff1d8893e}\label{class_input_a2e0c2008fce8f2730ef3126ff1d8893e}}
\index{Input@{Input}!onContactChanged@{onContactChanged}}
\index{onContactChanged@{onContactChanged}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{onContactChanged()}{onContactChanged()}}
{\footnotesize\ttfamily void Input\+::on\+Contact\+Changed (\begin{DoxyParamCaption}\item[{int}]{new\+Value }\end{DoxyParamCaption})}
\mbox{\Hypertarget{class_input_a2b60992464aa56f75c9d02b8b2084f8e}\label{class_input_a2b60992464aa56f75c9d02b8b2084f8e}}
\index{Input@{Input}!onCounterChanged@{onCounterChanged}}
\index{onCounterChanged@{onCounterChanged}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{onCounterChanged()}{onCounterChanged()}}
{\footnotesize\ttfamily void Input\+::on\+Counter\+Changed (\begin{DoxyParamCaption}\item[{int}]{i }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}}
\mbox{\Hypertarget{class_input_a85c108932af16f55722b8ccec2b72fb5}\label{class_input_a85c108932af16f55722b8ccec2b72fb5}}
\index{Input@{Input}!onCounterChanged0@{onCounterChanged0}}
\index{onCounterChanged0@{onCounterChanged0}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{onCounterChanged0()}{onCounterChanged0()}}
{\footnotesize\ttfamily void Input\+::on\+Counter\+Changed0 (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}
\mbox{\Hypertarget{class_input_a36b4ed46c94a5194e74c2106bb29deaa}\label{class_input_a36b4ed46c94a5194e74c2106bb29deaa}}
\index{Input@{Input}!onCounterChanged1@{onCounterChanged1}}
\index{onCounterChanged1@{onCounterChanged1}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{onCounterChanged1()}{onCounterChanged1()}}
{\footnotesize\ttfamily void Input\+::on\+Counter\+Changed1 (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}
\mbox{\Hypertarget{class_input_a8def9079b3f0774a05860a17a4b51b29}\label{class_input_a8def9079b3f0774a05860a17a4b51b29}}
\index{Input@{Input}!onCounterChanged2@{onCounterChanged2}}
\index{onCounterChanged2@{onCounterChanged2}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{onCounterChanged2()}{onCounterChanged2()}}
{\footnotesize\ttfamily void Input\+::on\+Counter\+Changed2 (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}
\mbox{\Hypertarget{class_input_adc8477b21452dd8b1f4bf1f3de35ecc4}\label{class_input_adc8477b21452dd8b1f4bf1f3de35ecc4}}
\index{Input@{Input}!onCounterChanged3@{onCounterChanged3}}
\index{onCounterChanged3@{onCounterChanged3}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{onCounterChanged3()}{onCounterChanged3()}}
{\footnotesize\ttfamily void Input\+::on\+Counter\+Changed3 (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}
\mbox{\Hypertarget{class_input_a6fcea89328a3bcf97dad383b7b615a5a}\label{class_input_a6fcea89328a3bcf97dad383b7b615a5a}}
\index{Input@{Input}!onCounterChanged4@{onCounterChanged4}}
\index{onCounterChanged4@{onCounterChanged4}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{onCounterChanged4()}{onCounterChanged4()}}
{\footnotesize\ttfamily void Input\+::on\+Counter\+Changed4 (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}
\mbox{\Hypertarget{class_input_a5611409d1de5bff2e6e59b9395809ecd}\label{class_input_a5611409d1de5bff2e6e59b9395809ecd}}
\index{Input@{Input}!onCounterChanged5@{onCounterChanged5}}
\index{onCounterChanged5@{onCounterChanged5}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{onCounterChanged5()}{onCounterChanged5()}}
{\footnotesize\ttfamily void Input\+::on\+Counter\+Changed5 (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}
\mbox{\Hypertarget{class_input_aad974cff366f73924458d105b88130d4}\label{class_input_aad974cff366f73924458d105b88130d4}}
\index{Input@{Input}!Parse@{Parse}}
\index{Parse@{Parse}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{Parse()}{Parse()}}
{\footnotesize\ttfamily void Input\+::\+Parse (\begin{DoxyParamCaption}\item[{a\+Json\+Object $\ast$}]{config\+Obj = {\ttfamily NULL} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
\mbox{\Hypertarget{class_input_a34b0da23df4e0c2be07e5358a974f6b3}\label{class_input_a34b0da23df4e0c2be07e5358a974f6b3}}
\index{Input@{Input}!Poll@{Poll}}
\index{Poll@{Poll}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{Poll()}{Poll()}}
{\footnotesize\ttfamily int Input\+::\+Poll (\begin{DoxyParamCaption}\item[{short}]{cause }\end{DoxyParamCaption})}
\mbox{\Hypertarget{class_input_ab48ae5515b6a332b518a06e5bb10926a}\label{class_input_ab48ae5515b6a332b518a06e5bb10926a}}
\index{Input@{Input}!publishDataToDomoticz@{publishDataToDomoticz}}
\index{publishDataToDomoticz@{publishDataToDomoticz}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{publishDataToDomoticz()}{publishDataToDomoticz()}}
{\footnotesize\ttfamily bool Input\+::publish\+Data\+To\+Domoticz (\begin{DoxyParamCaption}\item[{int}]{poll\+Time\+Increment, }\item[{a\+Json\+Object $\ast$}]{emit, }\item[{const char $\ast$}]{format, }\item[{}]{... }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
\mbox{\Hypertarget{class_input_a8efca39cb91c24dc80a62d660fd9ea2a}\label{class_input_a8efca39cb91c24dc80a62d660fd9ea2a}}
\index{Input@{Input}!setNextPollTime@{setNextPollTime}}
\index{setNextPollTime@{setNextPollTime}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{setNextPollTime()}{setNextPollTime()}}
{\footnotesize\ttfamily void Input\+::set\+Next\+Poll\+Time (\begin{DoxyParamCaption}\item[{unsigned long}]{poll\+Time }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
\mbox{\Hypertarget{class_input_af875dd162373e90e21f8213f928f8032}\label{class_input_af875dd162373e90e21f8213f928f8032}}
\index{Input@{Input}!setup@{setup}}
\index{setup@{setup}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{setup()}{setup()}}
{\footnotesize\ttfamily void Input\+::setup (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
\mbox{\Hypertarget{class_input_a3d224f0fd4da038390abaa8f84478d5c}\label{class_input_a3d224f0fd4da038390abaa8f84478d5c}}
\index{Input@{Input}!uptimePoll@{uptimePoll}}
\index{uptimePoll@{uptimePoll}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{uptimePoll()}{uptimePoll()}}
{\footnotesize\ttfamily void Input\+::uptime\+Poll (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{class_input_a4dbfdd3e7da95a3d4873286da07733f2}\label{class_input_a4dbfdd3e7da95a3d4873286da07733f2}}
\index{Input@{Input}!inputObj@{inputObj}}
\index{inputObj@{inputObj}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{inputObj}{inputObj}}
{\footnotesize\ttfamily a\+Json\+Object$\ast$ Input\+::input\+Obj}
\mbox{\Hypertarget{class_input_a0354094b474b7b9fa305bfc3500d3cee}\label{class_input_a0354094b474b7b9fa305bfc3500d3cee}}
\index{Input@{Input}!inType@{inType}}
\index{inType@{inType}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{inType}{inType}}
{\footnotesize\ttfamily uint8\+\_\+t Input\+::in\+Type}
\mbox{\Hypertarget{class_input_a910d1942c02b2d155dbaa3c8a41876f5}\label{class_input_a910d1942c02b2d155dbaa3c8a41876f5}}
\index{Input@{Input}!pin@{pin}}
\index{pin@{pin}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{pin}{pin}}
{\footnotesize\ttfamily uint8\+\_\+t Input\+::pin}
\mbox{\Hypertarget{class_input_a2c8307bf192b3e07bbc7cd605efeeb81}\label{class_input_a2c8307bf192b3e07bbc7cd605efeeb81}}
\index{Input@{Input}!store@{store}}
\index{store@{store}!Input@{Input}}
\doxysubsubsection{\texorpdfstring{store}{store}}
{\footnotesize\ttfamily \mbox{\hyperlink{unionin_store}{in\+Store}}$\ast$ Input\+::store}
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{inputs_8h}{inputs.\+h}}\item
\mbox{\hyperlink{inputs_8cpp}{inputs.\+cpp}}\end{DoxyCompactItemize}