<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>B15F: drv/usart.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">B15F
</div>
<div id="projectbrief">Board 15 Famulus Edition</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_587c94d866dbb2f408f78cf41f9b2f8d.html">drv</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">usart.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef USART_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define USART_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <chrono></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <fcntl.h></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <unistd.h></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <termios.h></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <sys/ioctl.h></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <string.h></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "usartexception.h"</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "timeoutexception.h"</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classUSART.html"> 16</a></span> <span class="keyword">class </span><a class="code" href="classUSART.html">USART</a></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> /*************************************************</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * Methoden für die Verwaltung der Schnittstelle *</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> *************************************************/</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">explicit</span> <a class="code" href="classUSART.html#a5daed20dc595c43d87c4c28bb08a7449">USART</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">virtual</span> <a class="code" href="classUSART.html#a0c8eb1a939ca00921e22f6cbcc7bb749">~USART</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">void</span> <a class="code" href="classUSART.html#a5f7e2abda2ec4a68a5fdb8ee2f8a940a">openDevice</a>(std::string device);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">void</span> <a class="code" href="classUSART.html#af80d6291ac1d2df04cfa1d8d27458cc5">closeDevice</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">void</span> <a class="code" href="classUSART.html#a28a2b4c5ed66b2c3a81196f76884f156">clearInputBuffer</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">void</span> <a class="code" href="classUSART.html#a756d268a8762c316f91ca3238972b0c1">clearOutputBuffer</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">void</span> <a class="code" href="classUSART.html#adb6ff4d1cf1af79ca255c5a81780200d">flushOutputBuffer</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> /*************************************************/</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> /*************************************</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * Methoden für die Datenübertragung *</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> *************************************/</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">void</span> <a class="code" href="classUSART.html#a41b19dd58f307015b73e154048cd74ca">transmit</a>(uint8_t *buffer, uint16_t offset, uint8_t len);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">void</span> <a class="code" href="classUSART.html#a0fdc238203852f00bd750127602b2a6a">receive</a>(uint8_t *buffer, uint16_t offset, uint8_t len);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">void</span> <a class="code" href="classUSART.html#a038d00c0b3d8c0c13c3e7eae5dad7813">drop</a>(uint8_t len);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> /*************************************/</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> /***************************************</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * Methoden für einstellbare Parameter *</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> ***************************************/</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  uint32_t <a class="code" href="classUSART.html#a4918672d8069df205378a528b1892db3">getBaudrate</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  uint8_t <a class="code" href="classUSART.html#a19cf777956a038878fc2d2b58c3d2b41">getTimeout</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordtype">void</span> <a class="code" href="classUSART.html#aac63918a8b97ae63ee607cfa39e6d88d">setBaudrate</a>(uint32_t baudrate);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">void</span> <a class="code" href="classUSART.html#ad7fe866cebe920784d2b17602824c7ff">setTimeout</a>(uint8_t timeout);</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> /***************************************/</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordtype">int</span> file_desc = -1; </div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  uint32_t baudrate = 9600; </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  uint8_t timeout = 10; </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> };</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="preprocessor">#endif // USART_H</span></div></div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassUSART_html_a4918672d8069df205378a528b1892db3"><div class="ttname"><a href="classUSART.html#a4918672d8069df205378a528b1892db3">USART::getBaudrate</a></div><div class="ttdeci">uint32_t getBaudrate(void)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00121">usart.cpp:121</a></div></div>
<div class="ttc" id="aclassUSART_html_a5daed20dc595c43d87c4c28bb08a7449"><div class="ttname"><a href="classUSART.html#a5daed20dc595c43d87c4c28bb08a7449">USART::USART</a></div><div class="ttdeci">USART()=default</div></div>
<div class="ttc" id="aclassUSART_html_af80d6291ac1d2df04cfa1d8d27458cc5"><div class="ttname"><a href="classUSART.html#af80d6291ac1d2df04cfa1d8d27458cc5">USART::closeDevice</a></div><div class="ttdeci">void closeDevice(void)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00043">usart.cpp:43</a></div></div>
<div class="ttc" id="aclassUSART_html_a41b19dd58f307015b73e154048cd74ca"><div class="ttname"><a href="classUSART.html#a41b19dd58f307015b73e154048cd74ca">USART::transmit</a></div><div class="ttdeci">void transmit(uint8_t *buffer, uint16_t offset, uint8_t len)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00075">usart.cpp:75</a></div></div>
<div class="ttc" id="aclassUSART_html_a0fdc238203852f00bd750127602b2a6a"><div class="ttname"><a href="classUSART.html#a0fdc238203852f00bd750127602b2a6a">USART::receive</a></div><div class="ttdeci">void receive(uint8_t *buffer, uint16_t offset, uint8_t len)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00084">usart.cpp:84</a></div></div>
<div class="ttc" id="aclassUSART_html_a28a2b4c5ed66b2c3a81196f76884f156"><div class="ttname"><a href="classUSART.html#a28a2b4c5ed66b2c3a81196f76884f156">USART::clearInputBuffer</a></div><div class="ttdeci">void clearInputBuffer(void)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00054">usart.cpp:54</a></div></div>
<div class="ttc" id="aclassUSART_html_a19cf777956a038878fc2d2b58c3d2b41"><div class="ttname"><a href="classUSART.html#a19cf777956a038878fc2d2b58c3d2b41">USART::getTimeout</a></div><div class="ttdeci">uint8_t getTimeout(void)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00126">usart.cpp:126</a></div></div>
<div class="ttc" id="aclassUSART_html"><div class="ttname"><a href="classUSART.html">USART</a></div><div class="ttdef"><b>Definition:</b> <a href="usart_8h_source.html#l00016">usart.h:16</a></div></div>
<div class="ttc" id="aclassUSART_html_a756d268a8762c316f91ca3238972b0c1"><div class="ttname"><a href="classUSART.html#a756d268a8762c316f91ca3238972b0c1">USART::clearOutputBuffer</a></div><div class="ttdeci">void clearOutputBuffer(void)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00061">usart.cpp:61</a></div></div>
<div class="ttc" id="aclassUSART_html_aac63918a8b97ae63ee607cfa39e6d88d"><div class="ttname"><a href="classUSART.html#aac63918a8b97ae63ee607cfa39e6d88d">USART::setBaudrate</a></div><div class="ttdeci">void setBaudrate(uint32_t baudrate)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00131">usart.cpp:131</a></div></div>
<div class="ttc" id="aclassUSART_html_a0c8eb1a939ca00921e22f6cbcc7bb749"><div class="ttname"><a href="classUSART.html#a0c8eb1a939ca00921e22f6cbcc7bb749">USART::~USART</a></div><div class="ttdeci">virtual ~USART(void)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00004">usart.cpp:4</a></div></div>
<div class="ttc" id="aclassUSART_html_a5f7e2abda2ec4a68a5fdb8ee2f8a940a"><div class="ttname"><a href="classUSART.html#a5f7e2abda2ec4a68a5fdb8ee2f8a940a">USART::openDevice</a></div><div class="ttdeci">void openDevice(std::string device)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00009">usart.cpp:9</a></div></div>
<div class="ttc" id="aclassUSART_html_a038d00c0b3d8c0c13c3e7eae5dad7813"><div class="ttname"><a href="classUSART.html#a038d00c0b3d8c0c13c3e7eae5dad7813">USART::drop</a></div><div class="ttdeci">void drop(uint8_t len)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00114">usart.cpp:114</a></div></div>
<div class="ttc" id="aclassUSART_html_ad7fe866cebe920784d2b17602824c7ff"><div class="ttname"><a href="classUSART.html#ad7fe866cebe920784d2b17602824c7ff">USART::setTimeout</a></div><div class="ttdeci">void setTimeout(uint8_t timeout)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00136">usart.cpp:136</a></div></div>
<div class="ttc" id="aclassUSART_html_adb6ff4d1cf1af79ca255c5a81780200d"><div class="ttname"><a href="classUSART.html#adb6ff4d1cf1af79ca255c5a81780200d">USART::flushOutputBuffer</a></div><div class="ttdeci">void flushOutputBuffer(void)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00068">usart.cpp:68</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jun 12 2019 10:21:20 for B15F by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>
</body>
</html>