<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/> <title>simpletext library: serial.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="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="projectlogo"><img alt="Logo" src="ParallaxLogo.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">simpletext library  <span id="projectnumber">v0.99.1</span> </div> <div id="projectbrief">Compact variations of put/get write/read and print/scan for smaller program sizes</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.1.2 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">serial.h</div> </div> </div><!--header--> <div class="contents"> <a href="serial_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#ifndef __SERIAL_H</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span><span class="preprocessor">#define __SERIAL_H</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include "<a class="code" href="simpletext_8h.html" title="This library provides a collection of functions for communicating with text devices such as SimpleIDE...">simpletext.h</a>"</span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="serial_8h.html#a1f6901682bfd9a8d2d3ade66b1f77a49"> 45</a></span> <span class="preprocessor">#define SERIAL_MIN_PIN 0</span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="serial_8h.html#a3fb62732840f545f9a77f400497abfdf"> 50</a></span> <span class="preprocessor">#define SERIAL_MAX_PIN 31</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00055"></a><span class="lineno"><a class="code" href="structserial__info.html"> 55</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structserial__info.html" title="Defines serial interface structure of 9 contiguous int variables.">serial_info</a></div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> { <span class="keywordtype">int</span> <a class="code" href="structserial__info.html#a219fb0cecab94c438944338382716e4d">rx_pin</a>; <span class="keywordtype">int</span> <a class="code" href="structserial__info.html#a10401260df6ab61a4519575c27d3e5c7">tx_pin</a>; <span class="keywordtype">int</span> <a class="code" href="structserial__info.html#a1ea5d0cb93f22f7d0fdf804bd68c3326">mode</a>; <span class="keywordtype">int</span> <a class="code" href="structserial__info.html#a4858bb3109a37110e12bd7765d6f18ee">baud</a>; <span class="keywordtype">int</span> <a class="code" href="structserial__info.html#a8d0065299615176169ceac2c65f38365">ticks</a>;</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> } <a class="code" href="serial_8h.html#ae554d60fd6f9747c280657b31fc0c70f" title="Defines serial interface structure of 9 contiguous int variables.">Serial_t</a>;</div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div> <div class="line"><a name="l00068"></a><span class="lineno"><a class="code" href="serial_8h.html#ac7fcdbb56e46396f0cdff866387a0136"> 68</a></span> <span class="keyword">typedef</span> <a class="code" href="structtext__struct.html" title="Structure that contains data used by simple text device libraries.">text_t</a> <a class="code" href="serial_8h.html#ac7fcdbb56e46396f0cdff866387a0136" title="Makes declarations like serial lcd to stand in for text_t lcd. Spelling is choice of Parallax educati...">serial</a>;</div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> serial *<a class="code" href="serial_8h.html#a0b43532699509b3227d5deaa5dade7ba" title="Open a simple (half duplex) serial connection.">serial_open</a>(<span class="keywordtype">int</span> rxpin, <span class="keywordtype">int</span> txpin, <span class="keywordtype">int</span> mode, <span class="keywordtype">int</span> baudrate);</div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keywordtype">void</span> <a class="code" href="serial_8h.html#a6b0f49d4a358ad92f648e6d2a11bfa6a" title="Close serial connection.">serial_close</a>(serial *device);</div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keywordtype">int</span> <a class="code" href="serial_8h.html#a2d18567b35a0e4faef403aa7e87836d3" title="Receive a byte. Waits until next byte is received.">serial_rxChar</a>(serial *device);</div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div> <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="keywordtype">int</span> <a class="code" href="serial_8h.html#a2afebd34fb247ef5eb958296a582dbcb" title="Send a byte.">serial_txChar</a>(serial *device, <span class="keywordtype">int</span> txbyte);</div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor"></span>}</div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="preprocessor"></span><span class="comment">/* __SERIAL_H */</span></div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div> <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sat Oct 18 2014 19:16:38 for simpletext library by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.1.2 </small></address> </body> </html>