2012-05-02 00:40:56 -05:00
<!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" / >
2012-06-09 19:35:49 -05:00
< title > serial: Serial Library< / title >
2012-05-02 00:40:56 -05:00
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "search/search.js" > < / script >
< script type = "text/javascript" >
$(document).ready(function() { searchBox.OnSelectItem(0); });
< / script >
< / head >
< body >
< div id = "top" > <!-- do not remove this div! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
< td style = "padding-left: 0.5em;" >
< div id = "projectname" > serial
  < span id = "projectnumber" > 1.0< / span >
< / div >
2012-06-09 19:35:49 -05:00
< div id = "projectbrief" > Cross-platform serial port library written in C++< / div >
2012-05-02 00:40:56 -05:00
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- Generated by Doxygen 1.8.0 -->
< script type = "text/javascript" >
var searchBox = new SearchBox("searchBox", "search",false,'Search');
< / script >
< div id = "navrow1" class = "tabs" >
< ul class = "tablist" >
< li class = "current" > < a href = "index.html" > < span > Main  Page< / span > < / a > < / li >
< li > < a href = "namespaces.html" > < span > Namespaces< / span > < / a > < / li >
< li > < a href = "annotated.html" > < span > Data  Structures< / span > < / a > < / li >
< li > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< li >
< div id = "MSearchBox" class = "MSearchBoxInactive" >
< span class = "left" >
< img id = "MSearchSelect" src = "search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
< input type = "text" id = "MSearchField" value = "Search" accesskey = "S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
< / span > < span class = "right" >
< a id = "MSearchClose" href = "javascript:searchBox.CloseResultsWindow()" > < img id = "MSearchCloseImg" border = "0" src = "search/close.png" alt = "" / > < / a >
< / span >
< / div >
< / li >
< / ul >
< / div >
< / div >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(0)" > < span class = "SelectionMark" >   < / span > All< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(1)" > < span class = "SelectionMark" >   < / span > Data Structures< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(2)" > < span class = "SelectionMark" >   < / span > Namespaces< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(3)" > < span class = "SelectionMark" >   < / span > Files< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(4)" > < span class = "SelectionMark" >   < / span > Functions< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(5)" > < span class = "SelectionMark" >   < / span > Variables< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(6)" > < span class = "SelectionMark" >   < / span > Enumerations< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(7)" > < span class = "SelectionMark" >   < / span > Enumerator< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(8)" > < span class = "SelectionMark" >   < / span > Defines< / a > < / 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 class = "header" >
< div class = "headertitle" >
2012-06-09 19:35:49 -05:00
< div class = "title" > Serial Library < / div > < / div >
2012-05-02 00:40:56 -05:00
< / div > <!-- header -->
< div class = "contents" >
2012-06-09 19:35:49 -05:00
< div class = "textblock" > < dl class = "section author" > < dt > Author:< / dt > < dd > William Woodall < a href = "#" onclick = "location.href='mai'+'lto:'+'wjw'+'wo'+'od@'+'gm'+'ail'+'.c'+'om'; return false;" > wjwwo< span style = "display: none;" > .nosp@m.< / span > od@g< span style = "display: none;" > .nosp@m.< / span > mail.< span style = "display: none;" > .nosp@m.< / span > com< / a > , John Harrison < a href = "#" onclick = "location.href='mai'+'lto:'+'ash'+'@g'+'rea'+'te'+'rth'+'an'+'inf'+'in'+'ity'+'.c'+'om'; return false;" > ash@g< span style = "display: none;" > .nosp@m.< / span > reat< span style = "display: none;" > .nosp@m.< / span > ertha< span style = "display: none;" > .nosp@m.< / span > ninf< span style = "display: none;" > .nosp@m.< / span > inity< span style = "display: none;" > .nosp@m.< / span > .com< / a > < / dd > < / dl >
< h2 > < a class = "anchor" id = "what_is" > < / a >
What is serial?< / h2 >
< p > Serial is a cross-platform, simple to use library for using serial ports on computers. This library provides a C++, object oriented interface for interacting with RS-232 like devices on Linux and Windows.< / p >
< p > Want to use it with ROS(Robot Operating System)? No problem, it compiles as a unary stack.< / p >
< h2 > < a class = "anchor" id = "getting_started" > < / a >
Getting Started< / h2 >
< p > Ready to jump in?< / p >
< ul >
< li > Checkout our examples: < a class = "el" href = "serial__example_8cc.html" > serial_example.cc< / a > < / li >
< li > Look at the main class documentation: < a class = "el" href = "classserial_1_1_serial.html" > serial::Serial< / a > < / li >
< / ul >
< h2 > < a class = "anchor" id = "features" > < / a >
Features< / h2 >
< ul >
< li > Linux, Mac OS X, and Windows Support< / li >
< li > Easy to use interface (modeled after PySerial)< / li >
< li > Minimal dependencies (cmake)< / li >
< li > Complete timeout control < a class = "el" href = "classserial_1_1_serial.html#a4fc63af4b800a9f9e757414f38f3e8b3" > serial::Serial::setTimeout< / a > < / li >
< li > Check and set handshaking lines (CTS, DSR, RI, CD and RTS, DTR)< / li >
< li > Block for changes in handshaking lines (Linux and Windows)< / li >
< li > Flush I/O separately and block until all writing done< / li >
< / ul >
< h2 > < a class = "anchor" id = "install" > < / a >
Installation< / h2 >
< h3 > < a class = "anchor" id = "Dependencies" > < / a >
Dependencies< / h3 >
< ul >
< li > CMake:< ul >
< li > CMake is required for building the system and can be located here: < a href = "http://www.cmake.org/" > http://www.cmake.org/< / a > < / li >
< / ul >
< / li >
< / ul >
< h3 > < a class = "anchor" id = "building" > < / a >
Compiling< / h3 >
< p > Once you have gathered the dependencies, you need to checkout the software from github.com:< / p >
< pre >
git clone git://github.com/wjwwood/serial.git
< / pre > < p > Once you have checked out the source code from github.com you can enter the directory and build the software.< / p >
< pre >
cd serial
make
make test # (optional) builds the example and tests, and runs the tests.
make doc # (optional) builds _this_ documentation.
< / pre > < h3 > < a class = "anchor" id = "installing" > < / a >
Installing< / h3 >
< p > To install simply:< / p >
< pre >
sudo make install
< / pre > < p > To uninstall simply:< / p >
< pre >
sudo make uninstall
< / pre > < / div > < / div > <!-- contents -->
2012-05-02 00:40:56 -05:00
< hr class = "footer" / > < address class = "footer" > < small >
2012-06-09 19:35:49 -05:00
Generated on Sat Jun 9 2012 19:35:05 for serial by   < a href = "http://www.doxygen.org/index.html" >
2012-05-02 00:40:56 -05:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / >
< / a > 1.8.0
< / small > < / address >
< / body >
< / html >
