274 lines
13 KiB
TeX
274 lines
13 KiB
TeX
\hypertarget{classUSART}{}\doxysection{U\+S\+A\+RT Class Reference}
|
|
\label{classUSART}\index{USART@{USART}}
|
|
\doxysubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
void \mbox{\hyperlink{classUSART_a5f7e2abda2ec4a68a5fdb8ee2f8a940a}{open\+Device}} (std\+::string device)
|
|
\item
|
|
void \mbox{\hyperlink{classUSART_af80d6291ac1d2df04cfa1d8d27458cc5}{close\+Device}} (void)
|
|
\item
|
|
void \mbox{\hyperlink{classUSART_a28a2b4c5ed66b2c3a81196f76884f156}{clear\+Input\+Buffer}} (void)
|
|
\item
|
|
void \mbox{\hyperlink{classUSART_a756d268a8762c316f91ca3238972b0c1}{clear\+Output\+Buffer}} (void)
|
|
\item
|
|
void \mbox{\hyperlink{classUSART_adb6ff4d1cf1af79ca255c5a81780200d}{flush\+Output\+Buffer}} (void)
|
|
\item
|
|
void \mbox{\hyperlink{classUSART_a33559bb8f0eda33a489d47b9c9227b59}{print\+Statistics}} (void)
|
|
\item
|
|
void \mbox{\hyperlink{classUSART_a60eadbe9956bab8144ee96d89eacd9f5}{write\+Byte}} (uint8\+\_\+t b)
|
|
\item
|
|
void \mbox{\hyperlink{classUSART_a78b30d9aa863f38745e982860392599a}{write\+Int}} (uint16\+\_\+t d)
|
|
\item
|
|
uint8\+\_\+t \mbox{\hyperlink{classUSART_a8f54b98b26bfe084359a5604bda82562}{read\+Byte}} (void)
|
|
\item
|
|
uint16\+\_\+t \mbox{\hyperlink{classUSART_a1534c229db71a375e556cf1e7d0b8119}{read\+Int}} (void)
|
|
\item
|
|
\mbox{\Hypertarget{classUSART_a7d024eae412c26c8026a19c23152fb15}\label{classUSART_a7d024eae412c26c8026a19c23152fb15}}
|
|
int {\bfseries read\+\_\+timeout} (uint8\+\_\+t $\ast$buffer, uint16\+\_\+t offset, uint8\+\_\+t len, uint32\+\_\+t timeout)
|
|
\item
|
|
\mbox{\Hypertarget{classUSART_abc38663b1be6af13dd6bc295b34b1f91}\label{classUSART_abc38663b1be6af13dd6bc295b34b1f91}}
|
|
int {\bfseries write\+\_\+timeout} (uint8\+\_\+t $\ast$buffer, uint16\+\_\+t offset, uint8\+\_\+t len, uint32\+\_\+t timeout)
|
|
\item
|
|
\mbox{\Hypertarget{classUSART_aa5380551953f95293287d93a3291e6f9}\label{classUSART_aa5380551953f95293287d93a3291e6f9}}
|
|
void {\bfseries write\+Block} (uint8\+\_\+t $\ast$buffer, uint16\+\_\+t offset, uint8\+\_\+t len)
|
|
\item
|
|
\mbox{\Hypertarget{classUSART_a6301a60df27ab1506ce8d64e3b061eb2}\label{classUSART_a6301a60df27ab1506ce8d64e3b061eb2}}
|
|
bool {\bfseries read\+Block} (uint8\+\_\+t $\ast$buffer, uint16\+\_\+t offset)
|
|
\item
|
|
uint32\+\_\+t \mbox{\hyperlink{classUSART_a4918672d8069df205378a528b1892db3}{get\+Baudrate}} (void)
|
|
\item
|
|
uint8\+\_\+t \mbox{\hyperlink{classUSART_a19cf777956a038878fc2d2b58c3d2b41}{get\+Timeout}} (void)
|
|
\item
|
|
void \mbox{\hyperlink{classUSART_aac63918a8b97ae63ee607cfa39e6d88d}{set\+Baudrate}} (uint32\+\_\+t baudrate)
|
|
\item
|
|
void \mbox{\hyperlink{classUSART_ad7fe866cebe920784d2b17602824c7ff}{set\+Timeout}} (uint8\+\_\+t timeout)
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Static Public Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\Hypertarget{classUSART_a3401693a5b971f54a2bf177e9a8b55fd}\label{classUSART_a3401693a5b971f54a2bf177e9a8b55fd}}
|
|
constexpr static uint8\+\_\+t {\bfseries C\+R\+C7\+\_\+\+P\+O\+LY} = 0x91
|
|
\item
|
|
\mbox{\Hypertarget{classUSART_a43cc131e2611437ed3c6c0448ba5ade5}\label{classUSART_a43cc131e2611437ed3c6c0448ba5ade5}}
|
|
constexpr static uint8\+\_\+t {\bfseries M\+A\+X\+\_\+\+B\+L\+O\+C\+K\+\_\+\+S\+I\+ZE} = 64
|
|
\item
|
|
\mbox{\Hypertarget{classUSART_a19bfa88e843626b2d822361738cf0039}\label{classUSART_a19bfa88e843626b2d822361738cf0039}}
|
|
constexpr static uint8\+\_\+t {\bfseries B\+L\+O\+C\+K\+\_\+\+E\+ND} = 0x80
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
|
|
|
|
Definition at line 16 of file usart.\+h.
|
|
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{classUSART_a28a2b4c5ed66b2c3a81196f76884f156}\label{classUSART_a28a2b4c5ed66b2c3a81196f76884f156}}
|
|
\index{USART@{USART}!clearInputBuffer@{clearInputBuffer}}
|
|
\index{clearInputBuffer@{clearInputBuffer}!USART@{USART}}
|
|
\doxysubsubsection{\texorpdfstring{clearInputBuffer()}{clearInputBuffer()}}
|
|
{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::clear\+Input\+Buffer (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}
|
|
|
|
Verwirft Daten, die bereits im Puffer liegen, aber noch nicht gelesen wurden
|
|
\begin{DoxyExceptions}{Exceptions}
|
|
{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\
|
|
\hline
|
|
\end{DoxyExceptions}
|
|
|
|
|
|
Definition at line 39 of file usart.\+cpp.
|
|
|
|
\mbox{\Hypertarget{classUSART_a756d268a8762c316f91ca3238972b0c1}\label{classUSART_a756d268a8762c316f91ca3238972b0c1}}
|
|
\index{USART@{USART}!clearOutputBuffer@{clearOutputBuffer}}
|
|
\index{clearOutputBuffer@{clearOutputBuffer}!USART@{USART}}
|
|
\doxysubsubsection{\texorpdfstring{clearOutputBuffer()}{clearOutputBuffer()}}
|
|
{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::clear\+Output\+Buffer (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}
|
|
|
|
Verwirft Daten, die bereits im Puffer liegen, aber noch nicht gesendet wurden
|
|
\begin{DoxyExceptions}{Exceptions}
|
|
{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\
|
|
\hline
|
|
\end{DoxyExceptions}
|
|
|
|
|
|
Definition at line 46 of file usart.\+cpp.
|
|
|
|
\mbox{\Hypertarget{classUSART_af80d6291ac1d2df04cfa1d8d27458cc5}\label{classUSART_af80d6291ac1d2df04cfa1d8d27458cc5}}
|
|
\index{USART@{USART}!closeDevice@{closeDevice}}
|
|
\index{closeDevice@{closeDevice}!USART@{USART}}
|
|
\doxysubsubsection{\texorpdfstring{closeDevice()}{closeDevice()}}
|
|
{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::close\+Device (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}
|
|
|
|
Schließt die \mbox{\hyperlink{classUSART}{U\+S\+A\+RT}} Schnittstelle
|
|
\begin{DoxyExceptions}{Exceptions}
|
|
{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\
|
|
\hline
|
|
\end{DoxyExceptions}
|
|
|
|
|
|
Definition at line 32 of file usart.\+cpp.
|
|
|
|
\mbox{\Hypertarget{classUSART_adb6ff4d1cf1af79ca255c5a81780200d}\label{classUSART_adb6ff4d1cf1af79ca255c5a81780200d}}
|
|
\index{USART@{USART}!flushOutputBuffer@{flushOutputBuffer}}
|
|
\index{flushOutputBuffer@{flushOutputBuffer}!USART@{USART}}
|
|
\doxysubsubsection{\texorpdfstring{flushOutputBuffer()}{flushOutputBuffer()}}
|
|
{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::flush\+Output\+Buffer (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}
|
|
|
|
Schreibt Daten, die bereits im Puffer liegen, aber noch nicht gesendet wurden
|
|
\begin{DoxyExceptions}{Exceptions}
|
|
{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\
|
|
\hline
|
|
\end{DoxyExceptions}
|
|
|
|
|
|
Definition at line 53 of file usart.\+cpp.
|
|
|
|
\mbox{\Hypertarget{classUSART_a4918672d8069df205378a528b1892db3}\label{classUSART_a4918672d8069df205378a528b1892db3}}
|
|
\index{USART@{USART}!getBaudrate@{getBaudrate}}
|
|
\index{getBaudrate@{getBaudrate}!USART@{USART}}
|
|
\doxysubsubsection{\texorpdfstring{getBaudrate()}{getBaudrate()}}
|
|
{\footnotesize\ttfamily uint32\+\_\+t U\+S\+A\+R\+T\+::get\+Baudrate (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}
|
|
|
|
Liefert die eingestellte Baudrate {\bfseries{Änderungen werden erst nach einem open() wirksam}}
|
|
|
|
Definition at line 306 of file usart.\+cpp.
|
|
|
|
\mbox{\Hypertarget{classUSART_a19cf777956a038878fc2d2b58c3d2b41}\label{classUSART_a19cf777956a038878fc2d2b58c3d2b41}}
|
|
\index{USART@{USART}!getTimeout@{getTimeout}}
|
|
\index{getTimeout@{getTimeout}!USART@{USART}}
|
|
\doxysubsubsection{\texorpdfstring{getTimeout()}{getTimeout()}}
|
|
{\footnotesize\ttfamily uint8\+\_\+t U\+S\+A\+R\+T\+::get\+Timeout (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}
|
|
|
|
Liefert den eingestellten Timeout (in Dezisekunden) {\bfseries{Änderungen werden erst nach einem open() wirksam}}
|
|
|
|
Definition at line 311 of file usart.\+cpp.
|
|
|
|
\mbox{\Hypertarget{classUSART_a5f7e2abda2ec4a68a5fdb8ee2f8a940a}\label{classUSART_a5f7e2abda2ec4a68a5fdb8ee2f8a940a}}
|
|
\index{USART@{USART}!openDevice@{openDevice}}
|
|
\index{openDevice@{openDevice}!USART@{USART}}
|
|
\doxysubsubsection{\texorpdfstring{openDevice()}{openDevice()}}
|
|
{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::open\+Device (\begin{DoxyParamCaption}\item[{std\+::string}]{device }\end{DoxyParamCaption})}
|
|
|
|
Öffnet die \mbox{\hyperlink{classUSART}{U\+S\+A\+RT}} Schnittstelle
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em device} & Linux-\/\+Gerätepfad \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
\begin{DoxyExceptions}{Exceptions}
|
|
{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\
|
|
\hline
|
|
\end{DoxyExceptions}
|
|
|
|
|
|
Definition at line 3 of file usart.\+cpp.
|
|
|
|
\mbox{\Hypertarget{classUSART_a33559bb8f0eda33a489d47b9c9227b59}\label{classUSART_a33559bb8f0eda33a489d47b9c9227b59}}
|
|
\index{USART@{USART}!printStatistics@{printStatistics}}
|
|
\index{printStatistics@{printStatistics}!USART@{USART}}
|
|
\doxysubsubsection{\texorpdfstring{printStatistics()}{printStatistics()}}
|
|
{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::print\+Statistics (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}
|
|
|
|
Gibt Anzahl an erfolgreichen und fehlgeschlagenen Block-\/Übertragungen an
|
|
|
|
Definition at line 60 of file usart.\+cpp.
|
|
|
|
\mbox{\Hypertarget{classUSART_a8f54b98b26bfe084359a5604bda82562}\label{classUSART_a8f54b98b26bfe084359a5604bda82562}}
|
|
\index{USART@{USART}!readByte@{readByte}}
|
|
\index{readByte@{readByte}!USART@{USART}}
|
|
\doxysubsubsection{\texorpdfstring{readByte()}{readByte()}}
|
|
{\footnotesize\ttfamily uint8\+\_\+t U\+S\+A\+R\+T\+::read\+Byte (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}
|
|
|
|
Empfängt ein Byte über die \mbox{\hyperlink{classUSART}{U\+S\+A\+RT}} Schnittstelle
|
|
\begin{DoxyExceptions}{Exceptions}
|
|
{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\
|
|
\hline
|
|
\end{DoxyExceptions}
|
|
|
|
|
|
Definition at line 210 of file usart.\+cpp.
|
|
|
|
\mbox{\Hypertarget{classUSART_a1534c229db71a375e556cf1e7d0b8119}\label{classUSART_a1534c229db71a375e556cf1e7d0b8119}}
|
|
\index{USART@{USART}!readInt@{readInt}}
|
|
\index{readInt@{readInt}!USART@{USART}}
|
|
\doxysubsubsection{\texorpdfstring{readInt()}{readInt()}}
|
|
{\footnotesize\ttfamily uint16\+\_\+t U\+S\+A\+R\+T\+::read\+Int (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})}
|
|
|
|
Empfängt ein Integer über die \mbox{\hyperlink{classUSART}{U\+S\+A\+RT}} Schnittstelle
|
|
\begin{DoxyExceptions}{Exceptions}
|
|
{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\
|
|
\hline
|
|
\end{DoxyExceptions}
|
|
|
|
|
|
Definition at line 229 of file usart.\+cpp.
|
|
|
|
\mbox{\Hypertarget{classUSART_aac63918a8b97ae63ee607cfa39e6d88d}\label{classUSART_aac63918a8b97ae63ee607cfa39e6d88d}}
|
|
\index{USART@{USART}!setBaudrate@{setBaudrate}}
|
|
\index{setBaudrate@{setBaudrate}!USART@{USART}}
|
|
\doxysubsubsection{\texorpdfstring{setBaudrate()}{setBaudrate()}}
|
|
{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::set\+Baudrate (\begin{DoxyParamCaption}\item[{uint32\+\_\+t}]{baudrate }\end{DoxyParamCaption})}
|
|
|
|
Setzt die Baudrate {\bfseries{Änderungen werden erst nach einem open() wirksam}}
|
|
|
|
Definition at line 316 of file usart.\+cpp.
|
|
|
|
\mbox{\Hypertarget{classUSART_ad7fe866cebe920784d2b17602824c7ff}\label{classUSART_ad7fe866cebe920784d2b17602824c7ff}}
|
|
\index{USART@{USART}!setTimeout@{setTimeout}}
|
|
\index{setTimeout@{setTimeout}!USART@{USART}}
|
|
\doxysubsubsection{\texorpdfstring{setTimeout()}{setTimeout()}}
|
|
{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::set\+Timeout (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{timeout }\end{DoxyParamCaption})}
|
|
|
|
Setzt den Timeout (in Dezisekunden) {\bfseries{Änderungen werden erst nach einem open() wirksam}}
|
|
|
|
Definition at line 321 of file usart.\+cpp.
|
|
|
|
\mbox{\Hypertarget{classUSART_a60eadbe9956bab8144ee96d89eacd9f5}\label{classUSART_a60eadbe9956bab8144ee96d89eacd9f5}}
|
|
\index{USART@{USART}!writeByte@{writeByte}}
|
|
\index{writeByte@{writeByte}!USART@{USART}}
|
|
\doxysubsubsection{\texorpdfstring{writeByte()}{writeByte()}}
|
|
{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::write\+Byte (\begin{DoxyParamCaption}\item[{uint8\+\_\+t}]{b }\end{DoxyParamCaption})}
|
|
|
|
Sendet ein Byte über die \mbox{\hyperlink{classUSART}{U\+S\+A\+RT}} Schnittstelle
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em b} & das zu sendende Byte \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
\begin{DoxyExceptions}{Exceptions}
|
|
{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\
|
|
\hline
|
|
\end{DoxyExceptions}
|
|
|
|
|
|
Definition at line 67 of file usart.\+cpp.
|
|
|
|
\mbox{\Hypertarget{classUSART_a78b30d9aa863f38745e982860392599a}\label{classUSART_a78b30d9aa863f38745e982860392599a}}
|
|
\index{USART@{USART}!writeInt@{writeInt}}
|
|
\index{writeInt@{writeInt}!USART@{USART}}
|
|
\doxysubsubsection{\texorpdfstring{writeInt()}{writeInt()}}
|
|
{\footnotesize\ttfamily void U\+S\+A\+R\+T\+::write\+Int (\begin{DoxyParamCaption}\item[{uint16\+\_\+t}]{d }\end{DoxyParamCaption})}
|
|
|
|
Sendet ein Integer über die \mbox{\hyperlink{classUSART}{U\+S\+A\+RT}} Schnittstelle
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em b} & das zu sendende Byte \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
\begin{DoxyExceptions}{Exceptions}
|
|
{\em \mbox{\hyperlink{classUSARTException}{U\+S\+A\+R\+T\+Exception}}} & \\
|
|
\hline
|
|
\end{DoxyExceptions}
|
|
|
|
|
|
Definition at line 81 of file usart.\+cpp.
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
/home/famulus/\+Dokumente/b15f/control/src/drv/usart.\+h\item
|
|
/home/famulus/\+Dokumente/b15f/control/src/drv/usart.\+cpp\end{DoxyCompactItemize}
|