532 lines
24 KiB
HTML
532 lines
24 KiB
HTML
<!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: USART Class Reference</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><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classUSART-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">USART Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="usart_8h_source.html">usart.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a5daed20dc595c43d87c4c28bb08a7449"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUSART.html#a5daed20dc595c43d87c4c28bb08a7449">USART</a> ()=default</td></tr>
|
|
<tr class="separator:a5daed20dc595c43d87c4c28bb08a7449"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c8eb1a939ca00921e22f6cbcc7bb749"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classUSART.html#a0c8eb1a939ca00921e22f6cbcc7bb749">~USART</a> (void)</td></tr>
|
|
<tr class="separator:a0c8eb1a939ca00921e22f6cbcc7bb749"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f7e2abda2ec4a68a5fdb8ee2f8a940a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUSART.html#a5f7e2abda2ec4a68a5fdb8ee2f8a940a">openDevice</a> (std::string device)</td></tr>
|
|
<tr class="separator:a5f7e2abda2ec4a68a5fdb8ee2f8a940a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af80d6291ac1d2df04cfa1d8d27458cc5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUSART.html#af80d6291ac1d2df04cfa1d8d27458cc5">closeDevice</a> (void)</td></tr>
|
|
<tr class="separator:af80d6291ac1d2df04cfa1d8d27458cc5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a28a2b4c5ed66b2c3a81196f76884f156"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUSART.html#a28a2b4c5ed66b2c3a81196f76884f156">clearInputBuffer</a> (void)</td></tr>
|
|
<tr class="separator:a28a2b4c5ed66b2c3a81196f76884f156"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a756d268a8762c316f91ca3238972b0c1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUSART.html#a756d268a8762c316f91ca3238972b0c1">clearOutputBuffer</a> (void)</td></tr>
|
|
<tr class="separator:a756d268a8762c316f91ca3238972b0c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb6ff4d1cf1af79ca255c5a81780200d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUSART.html#adb6ff4d1cf1af79ca255c5a81780200d">flushOutputBuffer</a> (void)</td></tr>
|
|
<tr class="separator:adb6ff4d1cf1af79ca255c5a81780200d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41b19dd58f307015b73e154048cd74ca"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUSART.html#a41b19dd58f307015b73e154048cd74ca">transmit</a> (uint8_t *buffer, uint16_t offset, uint8_t len)</td></tr>
|
|
<tr class="separator:a41b19dd58f307015b73e154048cd74ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0fdc238203852f00bd750127602b2a6a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUSART.html#a0fdc238203852f00bd750127602b2a6a">receive</a> (uint8_t *buffer, uint16_t offset, uint8_t len)</td></tr>
|
|
<tr class="separator:a0fdc238203852f00bd750127602b2a6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a038d00c0b3d8c0c13c3e7eae5dad7813"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUSART.html#a038d00c0b3d8c0c13c3e7eae5dad7813">drop</a> (uint8_t len)</td></tr>
|
|
<tr class="separator:a038d00c0b3d8c0c13c3e7eae5dad7813"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4918672d8069df205378a528b1892db3"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classUSART.html#a4918672d8069df205378a528b1892db3">getBaudrate</a> (void)</td></tr>
|
|
<tr class="separator:a4918672d8069df205378a528b1892db3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a19cf777956a038878fc2d2b58c3d2b41"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classUSART.html#a19cf777956a038878fc2d2b58c3d2b41">getTimeout</a> (void)</td></tr>
|
|
<tr class="separator:a19cf777956a038878fc2d2b58c3d2b41"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac63918a8b97ae63ee607cfa39e6d88d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUSART.html#aac63918a8b97ae63ee607cfa39e6d88d">setBaudrate</a> (uint32_t baudrate)</td></tr>
|
|
<tr class="separator:aac63918a8b97ae63ee607cfa39e6d88d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7fe866cebe920784d2b17602824c7ff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUSART.html#ad7fe866cebe920784d2b17602824c7ff">setTimeout</a> (uint8_t timeout)</td></tr>
|
|
<tr class="separator:ad7fe866cebe920784d2b17602824c7ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>C++ Wrapper class for termios usart library. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="usart_8h_source.html#l00016">16</a> of file <a class="el" href="usart_8h_source.html">usart.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a5daed20dc595c43d87c4c28bb08a7449"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5daed20dc595c43d87c4c28bb08a7449">◆ </a></span>USART()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">USART::USART </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Standard-Konstruktor </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c8eb1a939ca00921e22f6cbcc7bb749"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c8eb1a939ca00921e22f6cbcc7bb749">◆ </a></span>~USART()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">USART::~USART </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Destructor, ruft automatisch <a class="el" href="classUSART.html#af80d6291ac1d2df04cfa1d8d27458cc5">closeDevice()</a> auf </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="usart_8cpp_source.html#l00004">4</a> of file <a class="el" href="usart_8cpp_source.html">usart.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a28a2b4c5ed66b2c3a81196f76884f156"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a28a2b4c5ed66b2c3a81196f76884f156">◆ </a></span>clearInputBuffer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void USART::clearInputBuffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Verwirft Daten, die bereits im Puffer liegen, aber noch nicht gelesen wurden </p><dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classUSARTException.html">USARTException</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="usart_8cpp_source.html#l00054">54</a> of file <a class="el" href="usart_8cpp_source.html">usart.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a756d268a8762c316f91ca3238972b0c1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a756d268a8762c316f91ca3238972b0c1">◆ </a></span>clearOutputBuffer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void USART::clearOutputBuffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Verwirft Daten, die bereits im Puffer liegen, aber noch nicht gesendet wurden </p><dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classUSARTException.html">USARTException</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="usart_8cpp_source.html#l00061">61</a> of file <a class="el" href="usart_8cpp_source.html">usart.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af80d6291ac1d2df04cfa1d8d27458cc5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af80d6291ac1d2df04cfa1d8d27458cc5">◆ </a></span>closeDevice()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void USART::closeDevice </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Schließt die <a class="el" href="classUSART.html">USART</a> Schnittstelle </p><dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classUSARTException.html">USARTException</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="usart_8cpp_source.html#l00043">43</a> of file <a class="el" href="usart_8cpp_source.html">usart.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a038d00c0b3d8c0c13c3e7eae5dad7813"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a038d00c0b3d8c0c13c3e7eae5dad7813">◆ </a></span>drop()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void USART::drop </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>len</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Receives n bytes but discards them </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">len</td><td>count of bytes to receive </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classUSARTException.html">USARTException</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="usart_8cpp_source.html#l00114">114</a> of file <a class="el" href="usart_8cpp_source.html">usart.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adb6ff4d1cf1af79ca255c5a81780200d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adb6ff4d1cf1af79ca255c5a81780200d">◆ </a></span>flushOutputBuffer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void USART::flushOutputBuffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Schreibt Daten, die bereits im Puffer liegen, aber noch nicht gesendet wurden </p><dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classUSARTException.html">USARTException</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="usart_8cpp_source.html#l00068">68</a> of file <a class="el" href="usart_8cpp_source.html">usart.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4918672d8069df205378a528b1892db3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4918672d8069df205378a528b1892db3">◆ </a></span>getBaudrate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t USART::getBaudrate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Liefert die eingestellte Baudrate <b>Änderungen werden erst nach einem open() wirksam</b> </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="usart_8cpp_source.html#l00121">121</a> of file <a class="el" href="usart_8cpp_source.html">usart.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a19cf777956a038878fc2d2b58c3d2b41"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a19cf777956a038878fc2d2b58c3d2b41">◆ </a></span>getTimeout()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t USART::getTimeout </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Liefert den eingestellten Timeout (in Dezisekunden) <b>Änderungen werden erst nach einem open() wirksam</b> </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="usart_8cpp_source.html#l00126">126</a> of file <a class="el" href="usart_8cpp_source.html">usart.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5f7e2abda2ec4a68a5fdb8ee2f8a940a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5f7e2abda2ec4a68a5fdb8ee2f8a940a">◆ </a></span>openDevice()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void USART::openDevice </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::string </td>
|
|
<td class="paramname"><em>device</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Öffnet die <a class="el" href="classUSART.html">USART</a> Schnittstelle </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">device</td><td>Linux-Gerätepfad </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classUSARTException.html">USARTException</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="usart_8cpp_source.html#l00009">9</a> of file <a class="el" href="usart_8cpp_source.html">usart.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0fdc238203852f00bd750127602b2a6a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0fdc238203852f00bd750127602b2a6a">◆ </a></span>receive()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void USART::receive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>offset</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Receives n bytes from <a class="el" href="classUSART.html">USART</a> and writes them into the buffer </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">buffer</td><td>target buffer </td></tr>
|
|
<tr><td class="paramname">offset</td><td>in buffer (mostly 0) </td></tr>
|
|
<tr><td class="paramname">len</td><td>count of bytes to receive </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classUSARTException.html">USARTException</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="usart_8cpp_source.html#l00084">84</a> of file <a class="el" href="usart_8cpp_source.html">usart.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aac63918a8b97ae63ee607cfa39e6d88d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aac63918a8b97ae63ee607cfa39e6d88d">◆ </a></span>setBaudrate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void USART::setBaudrate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>baudrate</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Setzt die Baudrate <b>Änderungen werden erst nach <a class="el" href="classUSART.html#a5f7e2abda2ec4a68a5fdb8ee2f8a940a">openDevice()</a> wirksam</b> </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="usart_8cpp_source.html#l00131">131</a> of file <a class="el" href="usart_8cpp_source.html">usart.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad7fe866cebe920784d2b17602824c7ff"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad7fe866cebe920784d2b17602824c7ff">◆ </a></span>setTimeout()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void USART::setTimeout </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>timeout</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Setzt den Timeout (in Dezisekunden) <b>Änderungen werden erst nach <a class="el" href="classUSART.html#a5f7e2abda2ec4a68a5fdb8ee2f8a940a">openDevice()</a> wirksam</b> </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="usart_8cpp_source.html#l00136">136</a> of file <a class="el" href="usart_8cpp_source.html">usart.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a41b19dd58f307015b73e154048cd74ca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a41b19dd58f307015b73e154048cd74ca">◆ </a></span>transmit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void USART::transmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>offset</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Sends n bytes from the buffer over <a class="el" href="classUSART.html">USART</a> </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">buffer</td><td>target buffer </td></tr>
|
|
<tr><td class="paramname">offset</td><td>in buffer (mostly 0) </td></tr>
|
|
<tr><td class="paramname">len</td><td>count of bytes to send </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classUSARTException.html">USARTException</a></td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="usart_8cpp_source.html#l00075">75</a> of file <a class="el" href="usart_8cpp_source.html">usart.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>drv/<a class="el" href="usart_8h_source.html">usart.h</a></li>
|
|
<li>drv/<a class="el" href="usart_8cpp_source.html">usart.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Tue Dec 3 2019 07:42:52 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>
|