<!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: /home/famulus/Dokumente/b15f/control/src/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_56ea320f36428fc096e6ea8f45d8dae0.html">control</a></li><li class="navelem"><a class="el" href="dir_5e190edae4b019e7e1b870accd701baf.html">src</a></li><li class="navelem"><a class="el" href="dir_81b0a61688244456393c2abc7725ec59.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 <iostream></span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <chrono></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 <cstring></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <fcntl.h></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <sys/ioctl.h></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <termios.h></span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <cmath></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "usartexception.h"</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "timeoutexception.h"</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</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="l00029"></a><span class="lineno"> 29</span>  <span class="keywordtype">void</span> <a class="code" href="classUSART.html#a5f7e2abda2ec4a68a5fdb8ee2f8a940a">openDevice</a>(std::string device);</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</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="l00036"></a><span class="lineno"> 36</span>  </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</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="l00042"></a><span class="lineno"> 42</span>  </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</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="l00048"></a><span class="lineno"> 48</span>  </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</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="l00054"></a><span class="lineno"> 54</span>  </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">void</span> <a class="code" href="classUSART.html#a33559bb8f0eda33a489d47b9c9227b59">printStatistics</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> /*************************************************/</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> /*************************************</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * Methoden für die Datenübertragung *</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> *************************************/</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">void</span> <a class="code" href="classUSART.html#a60eadbe9956bab8144ee96d89eacd9f5">writeByte</a>(uint8_t b);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</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#a78b30d9aa863f38745e982860392599a">writeInt</a>(uint16_t d);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  uint8_t <a class="code" href="classUSART.html#a8f54b98b26bfe084359a5604bda82562">readByte</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  uint16_t <a class="code" href="classUSART.html#a1534c229db71a375e556cf1e7d0b8119">readInt</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">int</span> read_timeout(uint8_t* buffer, uint16_t offset, uint8_t len, uint32_t timeout);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">int</span> write_timeout(uint8_t* buffer, uint16_t offset, uint8_t len, uint32_t timeout);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">void</span> writeBlock(uint8_t* buffer, uint16_t offset, uint8_t len);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">bool</span> readBlock(uint8_t* buffer, uint16_t offset);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> /*************************************/</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>  </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> /***************************************</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * Methoden für einstellbare Parameter *</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> ***************************************/</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  uint32_t <a class="code" href="classUSART.html#a4918672d8069df205378a528b1892db3">getBaudrate</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  uint8_t <a class="code" href="classUSART.html#a19cf777956a038878fc2d2b58c3d2b41">getTimeout</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordtype">void</span> <a class="code" href="classUSART.html#aac63918a8b97ae63ee607cfa39e6d88d">setBaudrate</a>(uint32_t baudrate);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordtype">void</span> <a class="code" href="classUSART.html#ad7fe866cebe920784d2b17602824c7ff">setTimeout</a>(uint8_t timeout);</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> /***************************************/</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  constexpr <span class="keyword">static</span> uint8_t CRC7_POLY = 0x91;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  constexpr <span class="keyword">static</span> uint8_t MAX_BLOCK_SIZE = 64;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  constexpr <span class="keyword">static</span> uint8_t BLOCK_END = 0x80;</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="keyword">private</span>:</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>  <span class="keywordtype">int</span> file_desc = -1; <span class="comment">// Linux Dateideskriptor</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  uint32_t baudrate = 9600; <span class="comment">// Standard-Baudrate, sollte mit setBaudrate() überschrieben werden! </span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keywordtype">int</span> TEST = 0;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  uint8_t timeout = 10; <span class="comment">// in Dezisekunden</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  uint8_t block_buffer[MAX_BLOCK_SIZE + 3];</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="comment">// debug statistics</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  uint32_t n_blocks_total = 0;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  uint32_t n_blocks_failed = 0;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> };</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  </div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</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#l00306">usart.cpp:306</a></div></div>
<div class="ttc" id="aclassUSART_html_a8f54b98b26bfe084359a5604bda82562"><div class="ttname"><a href="classUSART.html#a8f54b98b26bfe084359a5604bda82562">USART::readByte</a></div><div class="ttdeci">uint8_t readByte(void)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00210">usart.cpp:210</a></div></div>
<div class="ttc" id="aclassUSART_html_a33559bb8f0eda33a489d47b9c9227b59"><div class="ttname"><a href="classUSART.html#a33559bb8f0eda33a489d47b9c9227b59">USART::printStatistics</a></div><div class="ttdeci">void printStatistics(void)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00060">usart.cpp:60</a></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#l00032">usart.cpp:32</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#l00039">usart.cpp:39</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#l00311">usart.cpp:311</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#l00046">usart.cpp:46</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#l00316">usart.cpp:316</a></div></div>
<div class="ttc" id="aclassUSART_html_a60eadbe9956bab8144ee96d89eacd9f5"><div class="ttname"><a href="classUSART.html#a60eadbe9956bab8144ee96d89eacd9f5">USART::writeByte</a></div><div class="ttdeci">void writeByte(uint8_t b)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00067">usart.cpp:67</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#l00003">usart.cpp:3</a></div></div>
<div class="ttc" id="aclassUSART_html_a1534c229db71a375e556cf1e7d0b8119"><div class="ttname"><a href="classUSART.html#a1534c229db71a375e556cf1e7d0b8119">USART::readInt</a></div><div class="ttdeci">uint16_t readInt(void)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00229">usart.cpp:229</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#l00321">usart.cpp:321</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#l00053">usart.cpp:53</a></div></div>
<div class="ttc" id="aclassUSART_html_a78b30d9aa863f38745e982860392599a"><div class="ttname"><a href="classUSART.html#a78b30d9aa863f38745e982860392599a">USART::writeInt</a></div><div class="ttdeci">void writeInt(uint16_t d)</div><div class="ttdef"><b>Definition:</b> <a href="usart_8cpp_source.html#l00081">usart.cpp:81</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated 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>